Package org.teamapps.ux.component

Interface ClientObject

All Known Subinterfaces:
Component, MultiProgressDisplay
All Known Implementing Classes:
AbsoluteLayout, AbstractComboBox, AbstractComponent, AbstractDateTimeField, AbstractField, AbstractForm, AbstractInfiniteListComponent, AbstractTimeField, AbstractToolContainer, BootstrapishGridLayout, Button, Calendar, ChatDisplay, ChatInput, CheckBox, ColorPicker, ComboBox, ComponentField, CurrencyField, DefaultMultiProgressDisplay, Dialogue, DisplayField, Div, DocumentViewer, DummyComponent, ElegantPanel, FieldGroup, FileField, FlexContainer, FloatingComponent, ForceLayoutGraph, FormDialogue, Gauge, GenericForm, GroupingView, HorizontalLayout, HtmlView, IFrame, ImageCropper, ImageField, InfiniteItemView, InfiniteItemView2, InstantDateTimeField, ItemView, Label, LinkButton, ListTable, LocalDateField, LocalDateTimeField, LocalTimeField, MapView, MapView2, MediaPlayer, MediaSoupV3WebRtcClient, MediaTrackGraph, MobileLayout, MultiLineTextField, NavigationBar, Notification, NotificationBar, NumberField, PageView, Panel, PasswordField, PictureChooser, PieChart, Popup, ProgressDisplay, QrCodeScanner, ResponsiveForm, ResponsiveGridLayout, RichTextEditor, RootPanel, ShakaPlayer, SimpleCalendar, SimpleFileField, SimpleItemView, SimpleTree, SimpleWorkSpaceLayout, SplitPane, Table, TabPanel, TagComboBox, TemplateField, TextField, TimeGraph, ToolAccordion, Toolbar, ToolButton, Tree, TreeGraph, VerticalLayout, VideoPlayer, WebRtcPlayer, WebRtcPublisher, Window, WorkSpaceLayout
public interface ClientObject
A client object has a representation on the client. This representation is said to be rendered when the client holds a corresponding instance of it. The server and the client refer to the ClientObject using the id (a UUID).

  • Method Summary

    Modifier and Type Method Description
    org.teamapps.dto.UiClientObjectReference createUiReference()
    Creates a ui reference to a client object.
    java.lang.String getId()  
    default void handleUiEvent​(org.teamapps.dto.UiEvent event)  
    default java.util.concurrent.CompletableFuture<?> handleUiQuery​(org.teamapps.dto.UiQuery query)  
    boolean isRendered()  
    void render()  
    void unrender()  

  • Method Details

    • getId

      java.lang.String getId()

    • render

      void render()

    • unrender

      void unrender()

    • isRendered

      boolean isRendered()

    • createUiReference

      org.teamapps.dto.UiClientObjectReference createUiReference()
      Creates a ui reference to a client object. Ui references are just a simple way to reference objects on the client side.

    • handleUiEvent

      default void handleUiEvent​(org.teamapps.dto.UiEvent event)

    • handleUiQuery

      default java.util.concurrent.CompletableFuture<?> handleUiQuery​(org.teamapps.dto.UiQuery query)