com.haulmont.cuba.gui.components

Interface Frame

All Superinterfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, ComponentContainer, ExpandingLayout, HasMargin, HasSpacing, HasSubParts, HasWindowManager, OrderedContainer, SupportsExpandRatio

All Known Subinterfaces:

DialogWindow, Fragment, FragmentImplementation, ListEditorWindowController, RootWindow, SingleModeWindow, TabWindow, Window, Window.Editor<T>, Window.Lookup<T>, WindowImplementation

All Known Implementing Classes:

AboutWindow, AbstractEditor, AbstractFrame, AbstractLocalizedTextFieldsFrame, AbstractLookup, AbstractMainWindow, AbstractTopLevelWindow, AbstractWindow, AddConditionWindow, AdditionLoggerWindow, AppLoginWindow, AppMainWindow, AppPropertiesBrowse, AppPropertiesEdit, AppPropertiesExport, AttributeEditor, AttributeEditWindow, AttributePermissionsFrame, AttributesLocationFrame, 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, LicenseWindow, ListEditorPopupWindow, LocalizedEnumerationWindow, LocalizedNameAndDescriptionFrame, 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 Frame
extends ExpandingLayout, OrderedContainer, Component.BelongToFrame, HasSpacing, HasMargin, ActionsHolder, Component.HasIcon, Component.HasCaption, HasWindowManager, SupportsExpandRatio

Root class of UI components having controller.

See Also:

Window, Fragment

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Frame.MessageMode Message dialog type.
static class	Frame.MessageType Message dialog type.
static class	Frame.NotificationType Popup notification type.
static interface	Frame.Wrapper Deprecated.

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

ExpandingLayout.ExpandDirection

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME Deprecated.

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
void	addFacet(Facet facet) Registers the passed non-visual component in the frame.
FrameContext	getContext()
Facet	getFacet(java.lang.String id) Finds registered facet by ID.
default Facet	getFacetNN(java.lang.String id) Finds registered facet by ID.
java.util.stream.Stream<Facet>	getFacets()
FrameOwner	getFrameOwner()
boolean	isValid() Check validity by invoking validators on all components which support them.
void	removeFacet(Facet facet) Removes the non-visual component from the frame.
void	validate() Check validity by invoking validators on all components which support them.
boolean	validate(java.util.List<Validatable> fields) Check validity by invoking validators on specified components which support them and show validation result notification.
boolean	validateAll() Check validity by invoking validators on all components which support them and show validation result notification.

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

expand, expand, getExpandDirection, isExpanded, resetExpanded

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

add, getComponent, getComponentNN, indexOf

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

add, add, focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream, remove, remove, removeAll

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

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

getFrame, setFrame

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

getSpacing, setSpacing

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

getMargin, setMargin, setMargin, setMargin

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

addAction, addAction, getAction, getActionNN, getActions, getSubPart, removeAction, removeAction, removeAllActions

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

getIcon, setIcon, setIconFromSet

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

getCaption, setCaption

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

getDescription, setDescription

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

getWindowManager, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage

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

getExpandRatio, setExpandRatio

Field Detail

NAME

@Deprecated
static final java.lang.String NAME

Deprecated.

XML element name used to show a frame in an enclosing screen.

See Also:

Constant Field Values

Method Detail

getFrameOwner

FrameOwner getFrameOwner()

Returns:

UI controller of the frame

See Also:

Screen, ScreenFragment

getContext

FrameContext getContext()

Returns:

current frame context

isValid

boolean isValid()

Check validity by invoking validators on all components which support them.

Returns:

true if all components are in valid state

validate

void validate()
       throws ValidationException

Check validity by invoking validators on all components which support them.

Throws:

ValidationException - if some components are currently in invalid state

validate

boolean validate(java.util.List<Validatable> fields)

Check validity by invoking validators on specified components which support them and show validation result notification.

Returns:

true if the validation was successful, false if there were any problems

validateAll

boolean validateAll()

Check validity by invoking validators on all components which support them and show validation result notification.

Returns:

true if the validation was successful, false if there were any problems

addFacet

void addFacet(Facet facet)

Registers the passed non-visual component in the frame.

Parameters:

facet - facet

getFacet

@Nullable
Facet getFacet(java.lang.String id)

Finds registered facet by ID.

Parameters:

id - facet ID

Returns:

facet instance or null

getFacetNN

@Nonnull
default Facet getFacetNN(java.lang.String id)

Finds registered facet by ID. Throws IllegalArgumentException if not found.

Parameters:

id - facet ID

Returns:

facet instance

removeFacet

void removeFacet(Facet facet)

Removes the non-visual component from the frame.

Parameters:

facet - facet

getFacets

java.util.stream.Stream<Facet> getFacets()

Returns:

stream of registered non-visual components