com.haulmont.cuba.gui.components

Interface Component

All Known Subinterfaces:

Accordion, AppMenu, AppWorkArea, BoxLayout, BrowserFrame, BulkEditor, Button, ButtonsPanel, Calendar, CheckBox, ColorPicker, Component.ActionsHolder, Component.BelongToFrame, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Editable, Component.Focusable, Component.HasValue, Component.OrderedContainer, Component.SecuredActionsHolder, Component.Wrapper, CssLayout, CurrencyField, DataGrid<E>, DatasourceComponent, DateField, DatePicker, DesktopComponent, DesktopContainer, DetachableFrame, Embedded, EntityLinkField, ExpandingLayout, Field, FieldGroup, FileMultiUploadField, FileUploadField, Filter, FlowBoxLayout, FoldersPane, Frame, FtsField, GridLayout, GroupBoxLayout, GroupTable<E>, HBoxLayout, HtmlBoxLayout, Image, Label, Link, LinkButton, ListComponent<E>, ListEditor, ListEditorWindowController, LogoutButton, LookupComponent, LookupComponent.LookupSelectionChangeNotifier, LookupField, LookupPickerField, MaskedField, NewWindowButton, OptionsField, OptionsGroup, OptionsList, PasswordField, PickerField, PopupButton, PopupView, ProgressBar, RelatedEntities, ResizableTextArea, ResourceView, RichTextArea, RowsCount, ScrollBoxLayout, SearchField, SearchPickerField, SideMenu, SourceCodeEditor, SplitPanel, SuggestionField, SuggestionPickerField, Table<E>, TabSheet, TextArea, TextField, TextInputField, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressNotifier, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported, TimeField, Timer, TimeZoneIndicator, TokenList, Tree<E>, TreeTable<E>, TwinColumn, UploadField, UserIndicator, VBoxLayout, WidgetsTree<E>, Window, Window.Committable, Window.Editor, Window.Lookup, Window.MainWindow, Window.TopLevelWindow

All Known Implementing Classes:

AboutWindow, AbstractEditor, AbstractFrame, AbstractLookup, AbstractMainWindow, AbstractTopLevelWindow, AbstractWindow, AddConditionWindow, AdditionLoggerWindow, AppLoginWindow, AppMainWindow, AppPropertiesBrowse, AppPropertiesEdit, AppPropertiesExport, AttributeEditor, AttributeEditWindow, AttributePermissionsFrame, BackgroundWorkProgressWindow, BackgroundWorkWindow, BulkEditorWindow, CategoryAttrsFrame, CategoryBrowser, CategoryEditor, ChangePasswordDialog, CommonLookupController, ConditionFrame, ConstraintEditor, ConstraintLocalizationEdit, ContextMenuButton, ControlLoggerWindow, CopySettings, CreditsFrame, CustomConditionEditor, CustomConditionFrame, DateIntervalEditor, DesktopAbstractActionsHolderComponent, DesktopAbstractBox, DesktopAbstractComponent, DesktopAbstractField, DesktopAbstractOptionsField, DesktopAbstractTable, DesktopAbstractTextField, DesktopAbstractUploadComponent, DesktopAbstractUploadField, DesktopBulkEditor, DesktopButton, DesktopButtonsPanel, DesktopCheckBox, DesktopCurrencyField, DesktopDateField, DesktopEmbedded, DesktopFieldGroup, DesktopFileMultiUploadField, DesktopFileUploadField, DesktopFilter, DesktopFrame, DesktopGridLayout, DesktopGroupBox, DesktopGroupTable, DesktopHBox, DesktopLabel, DesktopLink, DesktopLinkButton, DesktopListEditor, DesktopLookupField, DesktopLookupPickerField, DesktopMaskedField, DesktopOptionsGroup, DesktopPasswordField, DesktopPickerField, DesktopPopupButton, DesktopProgressBar, DesktopRelatedEntities, DesktopResizableTextArea, DesktopRowsCount, DesktopScrollBoxLayout, DesktopSearchField, DesktopSearchPickerField, DesktopSourceCodeEditor, DesktopSplitPanel, DesktopSuggestionField, DesktopSuggestionPickerField, DesktopTable, DesktopTabSheet, DesktopTextArea, DesktopTextField, DesktopTimeField, DesktopTimer, DesktopTokenList, DesktopTokenList.TokenListImpl, DesktopTokenList.TokenListLabel, DesktopTree, DesktopTreeTable, DesktopVBox, DesktopWidgetsTree, DesktopWindow, DesktopWindow.Editor, DesktopWindow.Lookup, DynamicAttributesConditionEditor, DynamicAttributesConditionFrame, EntityCombinedScreen, EntityDiffViewer, EntityInspectorBrowse, EntityInspectorEditor, EntityLogBrowser, EntityOpenHistoryFrame, EntityPermissionsFrame, EntityRestore, FileBrowser, FileEditor, FileFrameController, FileUploadDialog, FilterEditor, FilterSelectWindow, FtsConditionFrame, GroupBrowser, GroupConditionFrame, GroupEditor, GroupLookup, JmxInstanceBrowser, JmxInstanceEditor, LayoutAnalyzerWindow, LicenseFrame, LicenseWindow, ListEditorPopupWindow, LocalizedEnumerationWindow, LocalizedNameFrame, LockBrowser, LockEditor, LogDownloadOptionsWindow, MbeanInspectWindow, MbeansDisplayWindow, MultiUploader, NewPasswordsList, OperationResultWindow, ParamWrapper, PropertyConditionFrame, ResetPasswordsDialog, RoleBrowser, RoleEditor, RuntimePropertiesFrame, SaveFilterWindow, SaveSetWindow, ScheduledExecutionBrowser, ScheduledTaskBrowser, ScheduledTaskEditor, ScreenHistoryBrowse, ScreenPermissionsFrame, ScreenProfilerWindow, SendingMessageAttachments, SendingMessageBrowser, ServerLogWindow, SessionAttributeEditor, SessionBrowser, SessionLogBrowser, SessionMessageWindow, SettingsWindow, SpecificPermissionsFrame, StatisticsWindow, SystemInfoWindow, Table.PlainTextCell, ThreadsMonitoringWindow, UiPermissionsFrame, UserBrowser, UserEditor, UserLookup, UserSubstitutionEditor, WebAbstractActionsHolderComponent, WebAbstractBox, WebAbstractComponent, WebAbstractField, WebAbstractList, WebAbstractOptionsBase, WebAbstractOptionsField, WebAbstractOrderedLayout, WebAbstractResourceView, WebAbstractTable, WebAbstractTextArea, WebAbstractTextField, WebAbstractTree, WebAbstractUploadComponent, WebAbstractUploadField, WebAccordion, WebAppMenu, WebAppWorkArea, WebBrowserFrame, WebBulkEditor, WebButton, WebButtonsPanel, WebCalendar, WebCheckBox, WebColorPicker, WebCssLayout, WebCurrencyField, WebDataGrid, WebDateField, WebDatePicker, WebEmbedded, WebEntityLinkField, WebFieldGroup, WebFileMultiUploadField, WebFileUploadField, WebFilter, WebFlowBoxLayout, WebFoldersPane, WebFrame, WebFtsField, WebGridLayout, WebGroupBox, WebGroupTable, WebHBoxLayout, WebHtmlBoxLayout, WebImage, WebLabel, WebLink, WebLinkButton, WebListEditor, WebLogoutButton, WebLookupField, WebLookupPickerField, WebMaskedField, WebNewWindowButton, WebOptionsGroup, WebOptionsList, WebPasswordField, WebPickerField, WebPopupButton, WebPopupView, WebProgressBar, WebRelatedEntities, WebResizableTextArea, WebRichTextArea, WebRowsCount, WebScrollBoxLayout, WebSearchField, WebSearchPickerField, WebSideMenu, WebSourceCodeEditor, WebSplitPanel, WebSuggestionField, WebSuggestionPickerField, WebTable, WebTabSheet, WebTextArea, WebTextField, WebTimeField, WebTimer, WebTimeZoneIndicator, WebTokenList, WebTree, WebTreeTable, WebTwinColumn, WebUserIndicator, WebVBoxLayout, WebWidgetsTree, WebWindow, WebWindow.Editor, WebWindow.Lookup

public interface Component

Root of the GenericUI components hierarchy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Component.ActionOwner Component supporting an action
static interface	Component.ActionsHolder A component containing Actions
static class	Component.Alignment
static interface	Component.BelongToFrame Component belonging to a frame
static interface	Component.Buffered Data aware component that supports buffered write mode.
static interface	Component.ChildEditableController Component that manages editable property of child components.
static interface	Component.Collapsable Is able to collapse (folding)
static interface	Component.Container Component which can contain other components
static interface	Component.Disposable
static interface	Component.Editable Component supporting "editable" state.
static class	Component.EditableChangeEvent Event that is fired when "editable" property of Editable component has been changed.
static interface	Component.EditableChangeListener
static interface	Component.EditableChangeNotifier Component that fires EditableChangeEvent events.
static class	Component.ExpandedStateChangeEvent Describes expanded state change event of Component.Collapsable.
static interface	Component.ExpandedStateChangeListener Listener to expanded state change events.
static interface	Component.Focusable Component supporting "focusable" state.
static interface	Component.HasBorder Object having a border
static interface	Component.HasButtonsPanel Component having a buttons pancel.
static interface	Component.HasCaption Object having a caption
static interface	Component.HasFormatter Object having a formatter
static interface	Component.HasIcon Component having an icon.
static interface	Component.HasInputPrompt
static interface	Component.HasNamedComponents Component which can contain other components and provides access "by-name" to children.
static interface	Component.HasPresentations Component having presentations.
static interface	Component.HasRowsCount Component having a RowsCount component.
static interface	Component.HasSettings Object supporting save/restore of user settings.
static interface	Component.HasValue Object having a value.
static interface	Component.HasXmlDescriptor Object having an XML descriptor attached
static class	Component.LayoutClickEvent Describes layout click event.
static interface	Component.LayoutClickListener Listener fired when user clicks inside the layout at any place.
static interface	Component.LayoutClickNotifier Layout having a mouse click listener.
static interface	Component.Margin A class that implements this interface can have indentation between the outer borders and the container content.
static class	Component.MouseEventDetails Class to store mouse event details.
static interface	Component.OrderedContainer Component which can contain other components and provides indexed access to children.
static interface	Component.OuterMargin A class that implements this interface can have indentation outside the border.
static interface	Component.SecuredActionsHolder An Component.ActionsHolder component that loads and controls permissions on owned actions.
static class	Component.ShortcutAction The ShortcutAction is triggered when the user presses a given key combination.
static interface	Component.ShortcutNotifier Component having a shortcut listener.
static class	Component.ShortcutTriggeredEvent Describes shortcut triggered event.
static interface	Component.Spacing A class that implements this interface can have space between child components.
static interface	Component.UiPermissionAware State of subcomponents can be managed by UI permissions.
static interface	Component.Validatable A component which can be validated
static class	Component.ValueChangeEvent Describes value change event.
static interface	Component.ValueChangeListener Listener to value change events.
static interface	Component.Wrapper Component delegating work to some "wrapped" client-specific implementation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_SIZE
static int	AUTO_SIZE_PX
static int	UNITS_PERCENTAGE
static int	UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addStyleName(java.lang.String styleName) Adds one or more style names to this component.
Component.Alignment	getAlignment()
java.lang.String	getDebugId()
float	getHeight() Get component height in getHeightUnits()
int	getHeightUnits() Height units: UNITS_PIXELS, UNITS_PERCENTAGE
java.lang.String	getId() Component ID as defined in id attribute
Component	getParent()
java.lang.String	getStyleName() Styles implementation is client-type-specific.
float	getWidth() Get component width in getWidthUnits()
int	getWidthUnits() Width units: UNITS_PIXELS, UNITS_PERCENTAGE
boolean	isEnabled() Are the component and its parent enabled?
boolean	isEnabledItself() Is the component enabled regardless of the parent?
boolean	isResponsive() Is the component responsive?
boolean	isVisible() Are the component and its parent visible?
boolean	isVisibleItself() Is the component visible regardless of the parent?
void	removeStyleName(java.lang.String styleName) Removes one or more style names from component.
void	requestFocus() Set focus to this component
void	setAlignment(Component.Alignment alignment)
void	setDebugId(java.lang.String id) INTERNAL.
void	setEnabled(boolean enabled) Set component enabled state
void	setHeight(java.lang.String height) Set component height in getHeightUnits()
default void	setHeightAuto() Set component height to AUTO_SIZE
default void	setHeightFull() Set component height to 100%
void	setId(java.lang.String id) Set component ID
void	setParent(Component parent) INTERNAL. Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
void	setResponsive(boolean responsive) Set component to be responsive by width and height.
default void	setSizeAuto() Set component width and height to AUTO_SIZE
default void	setSizeFull() Set component width and height to 100%
void	setStyleName(java.lang.String styleName) Sets one or more style names of the component, replacing any previous styles.
void	setVisible(boolean visible) Set component visibility
void	setWidth(java.lang.String width) Set component width in getWidthUnits()
default void	setWidthAuto() Set component width to AUTO_SIZE
default void	setWidthFull() Set component width to 100%
<X> X	unwrap(java.lang.Class<X> internalComponentClass) Get client specific component instance.
<X> X	unwrapComposition(java.lang.Class<X> internalCompositionClass) Get the outmost external container of client specific component instance.

Field Detail

UNITS_PIXELS

static final int UNITS_PIXELS

See Also:

Constant Field Values

UNITS_PERCENTAGE

static final int UNITS_PERCENTAGE

See Also:

Constant Field Values

AUTO_SIZE

static final java.lang.String AUTO_SIZE

See Also:

Constant Field Values

AUTO_SIZE_PX

static final int AUTO_SIZE_PX

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Component ID as defined in id attribute

setId

void setId(java.lang.String id)

Set component ID

getParent

Component getParent()

Returns:

Parent of component.

setParent

void setParent(Component parent)

INTERNAL.
Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.

Parameters:

parent - Parent component

getDebugId

java.lang.String getDebugId()

setDebugId

void setDebugId(java.lang.String id)

INTERNAL. Managed by debug Id system.

isEnabled

boolean isEnabled()

Are the component and its parent enabled?

setEnabled

void setEnabled(boolean enabled)

Set component enabled state

isResponsive

boolean isResponsive()

Is the component responsive?

setResponsive

void setResponsive(boolean responsive)

Set component to be responsive by width and height. If responsive flag is true then you can use conditional CSS rules that respond to size changes in the browser. You can set specific rules using "width-range" or "height-range" properties in CSS files.

isVisible

boolean isVisible()

Are the component and its parent visible?

setVisible

void setVisible(boolean visible)

Set component visibility

isVisibleItself

boolean isVisibleItself()

Is the component visible regardless of the parent?

isEnabledItself

boolean isEnabledItself()

Is the component enabled regardless of the parent?

requestFocus

void requestFocus()

Set focus to this component

getHeight

float getHeight()

Get component height in getHeightUnits()

getHeightUnits

int getHeightUnits()

Height units: UNITS_PIXELS, UNITS_PERCENTAGE

setHeight

void setHeight(java.lang.String height)

Set component height in getHeightUnits()

setHeightAuto

default void setHeightAuto()

Set component height to AUTO_SIZE

setHeightFull

default void setHeightFull()

Set component height to 100%

getWidth

float getWidth()

Get component width in getWidthUnits()

getWidthUnits

int getWidthUnits()

Width units: UNITS_PIXELS, UNITS_PERCENTAGE

setWidth

void setWidth(java.lang.String width)

Set component width in getWidthUnits()

setWidthAuto

default void setWidthAuto()

Set component width to AUTO_SIZE

setWidthFull

default void setWidthFull()

Set component width to 100%

setSizeFull

default void setSizeFull()

Set component width and height to 100%

setSizeAuto

default void setSizeAuto()

Set component width and height to AUTO_SIZE

getAlignment

Component.Alignment getAlignment()

setAlignment

void setAlignment(Component.Alignment alignment)

getStyleName

java.lang.String getStyleName()

Styles implementation is client-type-specific.

Returns:

current style name.

setStyleName

void setStyleName(java.lang.String styleName)

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Parameters:

styleName - one or more style names separated by space.

addStyleName

void addStyleName(java.lang.String styleName)

Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names.

Parameters:

styleName - one or more style names separated by space.

removeStyleName

void removeStyleName(java.lang.String styleName)

Removes one or more style names from component. Multiple styles can be specified as a space-separated list of style names.

Parameters:

styleName - one or more style names separated by space.

unwrap

<X> X unwrap(java.lang.Class<X> internalComponentClass)

Get client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.TextField vTextField = textField.unwrap(com.vaadin.ui.TextField.class);
 

Type Parameters:

X - type of internal class

Parameters:

internalComponentClass - class of underlying component implementation based on Vaadin or Swing

Returns:

internal client specific component

unwrapComposition

<X> X unwrapComposition(java.lang.Class<X> internalCompositionClass)

Get the outmost external container of client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.Layout vLayout = table.unwrapComposition(com.vaadin.ui.Layout.class);
 

Type Parameters:

X - type of internal class

Parameters:

internalCompositionClass - class of underlying composition implementation based on Vaadin or Swing

Returns:

internal client specific component