com.whitestein.lsps.vaadin.ui.components

Interface UIComponent

All Superinterfaces:

Serializable

All Known Subinterfaces:

Pager.PagedComponent, UIComponentContainer, UIComponentListeningOnRefresh, UIComponentShowingRecords, UIComponentWithCustomScopes, UIComponentWithCustomVisibility, UIComponentWithHints2, UIComponentWithInputPrompt, UIComponentWithWrappers, UIDynamicComponentContainer, UIRefreshHandler

All Known Implementing Classes:

UIActionLink, UIBrowserFrame, UIButton, UIButtonRenderer, UICalendar, UICartesianChart, UICheckBox, UICheckBoxList, UIComboBox, UIConditional, UIContainer, UIDashboard, UIDashboardWidget, UIDateRenderer, UIDateTextBox, UIEnumerationRenderer, UIFileDownloadButton, UIFileUpload, UIFormLayout, UIGaugeChart, UIGenericChart, UIGeolocator, UIGrid, UIGridCellRenderer, UIGridColumn, UIGridLayout, UIGroupingTable, UIHorizontalLayout, UIHorizontalRepeater, UIHtmlRenderer, UIImage, UIImageRenderer, UILazyComboBox, UILazyTable, UILinkRenderer, UIMapDisplay, UIMessage, UIMultiSelectList, UINavigationLink, UINumberRenderer, UIOutputText, UIPagedTable, UIPanel, UIPieChart, UIPolarChart, UIPopup, UIProcessDiagram, UIRadioButtonList, UIRepeater, UIRichTextArea, UISimpleTable, UISingleSelectList, UITabbedLayout, UITableBase, UITableColumn, UITextArea, UITextBox, UITokenField, UITree2, UITreeTable2, UIVerticalLayout, UIVerticalRepeater, UIViewModel

public interface UIComponent
extends Serializable

Base interface for all LSPS Vaadin components. This defines minimal set of methods which needs to be implemented in order to provide functional integration with LSPS infrastructure.

Author:

mbj

Method Summary

Modifier and Type	Method and Description
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
void	refresh() This method is called from LSPS rendering engine.

Method Detail

getWidget

com.vaadin.ui.AbstractComponent getWidget()

Returns the Vaadin widget which implements the UI part of this component.

Returns:

the widget, not null.

refresh

void refresh()

This method is called from LSPS rendering engine. It should load all information needed from component definition record holder and apply them accordingly.

Note that this method should not attempt to apply any hints - hints are applied automatically after the component is refreshed. You however may read the hints value here - it is guaranteed that you will receive freshly updated hint value by reading UIComponentData.getHints().

getComponentData

UIComponentData getComponentData()

Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.

Returns:

component definition. The definition record instance must be present in root scope (screen context).