com.haulmont.cuba.gui.components

Interface ComponentContainer

All Superinterfaces:

Component

All Known Subinterfaces:

Accordion, BoxLayout, ButtonsPanel, CssLayout, DetachableFrame, DialogWindow, ExpandingLayout, FieldGroup, FlowBoxLayout, Form, Fragment, FragmentImplementation, Frame, GridLayout, GroupBoxLayout, HBoxLayout, HtmlBoxLayout, LegacyFrame, ListEditorWindowController, OrderedContainer, RootWindow, ScrollBoxLayout, SingleModeWindow, SplitPanel, TabSheet, TabWindow, VBoxLayout, Window, Window.Editor<T>, Window.Lookup<T>, WindowImplementation

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, ControlLoggerWindow, CopySettings, CreditsFrame, CustomConditionEditor, CustomConditionFrame, DateIntervalEditor, DynamicAttributesConditionEditor, DynamicAttributesConditionFrame, EntityCombinedScreen, EntityDiffViewer, EntityInspectorBrowse, EntityInspectorEditor, EntityLogBrowser, EntityOpenHistoryFrame, EntityPermissionsFrame, EntityRestore, FileBrowser, FileEditor, FileUploadDialog, FilterEditor, FilterSelectWindow, FtsConditionFrame, GroupBrowser, GroupConditionFrame, GroupEditor, GroupLookup, JmxInstanceBrowser, JmxInstanceEditor, LayoutAnalyzerWindow, LicenseFrame, LicenseWindow, ListEditorPopupWindow, LocalizedEnumerationWindow, LocalizedNameFrame, LockBrowser, LockEditor, LogDownloadOptionsWindow, MbeanInspectWindow, MbeansDisplayWindow, MultiUploader, NewPasswordsList, OperationResultWindow, PropertyConditionFrame, ResetPasswordsDialog, RoleBrowser, RoleEditor, RuntimePropertiesFrame, SaveFilterWindow, SaveSetWindow, ScheduledExecutionBrowser, ScheduledTaskBrowser, ScheduledTaskEditor, ScreenEditorWrapper, ScreenFragmentWrapper, ScreenHistoryBrowse, ScreenLookupWrapper, ScreenPermissionsFrame, ScreenWrapper, SendingMessageAttachments, SendingMessageBrowser, ServerLogWindow, SessionAttributeEditor, SessionBrowser, SessionLogBrowser, SessionMessageWindow, SettingsWindow, SpecificPermissionsFrame, StatisticsWindow, SystemInfoWindow, ThreadsMonitoringWindow, UiPermissionsFrame, UserBrowser, UserEditor, UserLookup, UserSubstitutionEditor, WebRootWindow, WebWindow

public interface ComponentContainer
extends Component

Component which can contain other components.

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Field Summary

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
default void	add(Component... childComponents) Sequentially adds components to this container.
void	add(Component childComponent) Adds a component to this container.
default void	focusFirstComponent() Focuses the first Focusable component, if present.
Component	getComponent(java.lang.String id) Get component belonging to the whole components tree below this container.
default Component	getComponentNN(java.lang.String id) Get component belonging to the whole components tree below this container.
java.util.Collection<Component>	getComponents() Get all components belonging to the whole components tree below this container
Component	getOwnComponent(java.lang.String id) Get component directly owned by this container.
java.util.Collection<Component>	getOwnComponents() Get all components directly owned by this container
java.util.stream.Stream<Component>	getOwnComponentsStream() Get stream of components directly owned by this container
default void	remove(Component... childComponents) Sequentially removes components from this container.
void	remove(Component childComponent) Removes a component from this container.
void	removeAll() Removes all components from this container.

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Method Detail

add

void add(Component childComponent)

Adds a component to this container.

Parameters:

childComponent - a component to add

add

default void add(Component... childComponents)

Sequentially adds components to this container.

Parameters:

childComponents - components to add

remove

void remove(Component childComponent)

Removes a component from this container.

Parameters:

childComponent - a component to remove

remove

default void remove(Component... childComponents)

Sequentially removes components from this container.

Parameters:

childComponents - components to remove

removeAll

void removeAll()

Removes all components from this container.

getOwnComponent

@Nullable
Component getOwnComponent(java.lang.String id)

Get component directly owned by this container.

Returns:

component or null if not found

getComponent

@Nullable
Component getComponent(java.lang.String id)

Get component belonging to the whole components tree below this container.

Returns:

component or null if not found

getComponentNN

@Nonnull
default Component getComponentNN(java.lang.String id)

Get component belonging to the whole components tree below this container.

Returns:

component. Throws exception if not found.

getOwnComponents

java.util.Collection<Component> getOwnComponents()

Get all components directly owned by this container

getOwnComponentsStream

java.util.stream.Stream<Component> getOwnComponentsStream()

Get stream of components directly owned by this container

getComponents

java.util.Collection<Component> getComponents()

Get all components belonging to the whole components tree below this container

focusFirstComponent

default void focusFirstComponent()

Focuses the first Focusable component, if present.