com.haulmont.cuba.gui.components

Interface Frame

All Superinterfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.Margin, Component.OrderedContainer, Component.Spacing, ExpandingLayout

All Known Subinterfaces:

DetachableFrame, ListEditorWindowController, 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, ControlLoggerWindow, CopySettings, CreditsFrame, CustomConditionEditor, CustomConditionFrame, DateIntervalEditor, 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, PropertyConditionFrame, ResetPasswordsDialog, RoleBrowser, RoleEditor, RuntimePropertiesFrame, SaveFilterWindow, SaveSetWindow, ScheduledExecutionBrowser, ScheduledTaskBrowser, ScheduledTaskEditor, ScreenHistoryBrowse, ScreenPermissionsFrame, ScreenProfilerWindow, SendingMessageAttachments, SendingMessageBrowser, ServerLogWindow, SessionAttributeEditor, SessionBrowser, SessionLogBrowser, SessionMessageWindow, SettingsWindow, SpecificPermissionsFrame, StatisticsWindow, SystemInfoWindow, ThreadsMonitoringWindow, UiPermissionsFrame, UserBrowser, UserEditor, UserLookup, UserSubstitutionEditor, WebWindow, WebWindow.Editor, WebWindow.Lookup

public interface Frame
extends ExpandingLayout, Component.OrderedContainer, Component.BelongToFrame, Component.Spacing, Component.Margin, Component.ActionsHolder, Component.HasIcon, Component.HasCaption

Represents a reusable part of a screen.
Has its own XML descriptor, but can be instantiated only inside a Window. Includes functionality for work with datasources and other windows.

Nested Class Summary

Nested Classes

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

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.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME XML element name used to show a frame in an enclosing screen.

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
FrameContext	getContext()
DialogParams	getDialogParams() Deprecated. Use WindowManager.OpenType or Window.getDialogOptions() from screen controller
DsContext	getDsContext()
java.lang.String	getMessagesPack()
Component	getRegisteredComponent(java.lang.String id) INTERNAL.
boolean	isValid() Check validity by invoking validators on all components which support them.
Window.Editor	openEditor(Entity item, WindowManager.OpenType openType) Open an edit screen for entity instance.
Window.Editor	openEditor(Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open an edit screen for entity instance.
Window.Editor	openEditor(Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params, Datasource parentDs) Open an edit screen for entity instance.
Window.Editor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType) Open an edit screen.
Window.Editor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType, Datasource parentDs) Open an edit screen.
Window.Editor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open an edit screen.
Window.Editor	openEditor(java.lang.String windowAlias, Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params, Datasource parentDs) Open an edit screen.
Frame	openFrame(Component parent, java.lang.String windowAlias) Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.
Frame	openFrame(Component parent, java.lang.String windowAlias, java.util.Map<java.lang.String,java.lang.Object> params) Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.
Window.Lookup	openLookup(java.lang.Class<? extends Entity> entityClass, Window.Lookup.Handler handler, WindowManager.OpenType openType) Open a lookup screen.
Window.Lookup	openLookup(java.lang.Class<? extends Entity> entityClass, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open a lookup screen.
Window.Lookup	openLookup(java.lang.String windowAlias, Window.Lookup.Handler handler, WindowManager.OpenType openType) Open a lookup screen.
Window.Lookup	openLookup(java.lang.String windowAlias, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open a lookup screen.
Window	openWindow(java.lang.String windowAlias, WindowManager.OpenType openType) Open a simple screen.
Window	openWindow(java.lang.String windowAlias, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params) Open a simple screen.
void	registerComponent(Component component) INTERNAL.
void	setContext(FrameContext ctx) INTERNAL.
void	setDsContext(DsContext dsContext) INTERNAL.
void	setMessagesPack(java.lang.String name) Set message pack for this frame.
void	showMessageDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType) Show message dialog with title and message.
void	showNotification(java.lang.String caption) Show notification with Frame.NotificationType.HUMANIZED.
void	showNotification(java.lang.String caption, Frame.NotificationType type) Show notification.
void	showNotification(java.lang.String caption, java.lang.String description, Frame.NotificationType type) Show notification with caption and description.
void	showOptionDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType, Action[] actions) Show options dialog with title and message.
void	showOptionDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType, java.util.List<Action> actions) Show options dialog with title and message.
void	showWebPage(java.lang.String url, java.util.Map<java.lang.String,java.lang.Object> params) Open a web page in browser.
void	unregisterComponent(Component component) INTERNAL.
void	validate() Check validity by invoking validators on all components which support them.
boolean	validate(java.util.List<Component.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.Component.OrderedContainer

add, getComponent, getComponentNN, indexOf

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

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

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.Spacing

getSpacing, setSpacing

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

getMargin, setMargin, setMargin, setMargin

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

addAction, addAction, getAction, getActionNN, getActions, 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, getDescription, setCaption, setDescription

Field Detail

NAME

static final java.lang.String NAME

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

See Also:

Constant Field Values

Method Detail

getContext

FrameContext getContext()

Returns:

current frame context

setContext

void setContext(FrameContext ctx)

INTERNAL. Don't call from application code.

getDsContext

DsContext getDsContext()

Returns:

DsContext of the current frame or window

setDsContext

void setDsContext(DsContext dsContext)

INTERNAL. Don't call from application code.

getMessagesPack

java.lang.String getMessagesPack()

Returns:

the message pack associated with the frame, usually in XML descriptor

setMessagesPack

void setMessagesPack(java.lang.String name)

Set message pack for this frame.

Parameters:

name - message pack name

registerComponent

void registerComponent(Component component)

INTERNAL. Don't call from application code.

unregisterComponent

void unregisterComponent(Component component)

INTERNAL. Don't call from application code.

getRegisteredComponent

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

INTERNAL. Don't call from application code.

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<Component.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

getDialogParams

@Deprecated
DialogParams getDialogParams()

Deprecated. Use WindowManager.OpenType or Window.getDialogOptions() from screen controller

Returns:

DialogParams that will be used for opening next window in modal mode.
If called in init() method of a screen, which is being opened in WindowManager.OpenType#DIALOG mode, affects the current screen itself.

openWindow

Window openWindow(java.lang.String windowAlias,
                  WindowManager.OpenType openType,
                  java.util.Map<java.lang.String,java.lang.Object> params)

Open a simple screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openWindow

Window openWindow(java.lang.String windowAlias,
                  WindowManager.OpenType openType)

Open a simple screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

openType - how to open the screen

Returns:

created window

openEditor

Window.Editor openEditor(Entity item,
                         WindowManager.OpenType openType)

Open an edit screen for entity instance.

Parameters:

item - entity to edit

openType - how to open the screen

Returns:

created window

openEditor

Window.Editor openEditor(Entity item,
                         WindowManager.OpenType openType,
                         java.util.Map<java.lang.String,java.lang.Object> params)

Open an edit screen for entity instance.

Parameters:

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openEditor

Window.Editor openEditor(Entity item,
                         WindowManager.OpenType openType,
                         java.util.Map<java.lang.String,java.lang.Object> params,
                         Datasource parentDs)

Open an edit screen for entity instance.

Parameters:

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

parentDs - if this parameter is not null, the editor will commit edited instance into this datasource instead of directly to database

Returns:

created window

openEditor

Window.Editor openEditor(java.lang.String windowAlias,
                         Entity item,
                         WindowManager.OpenType openType,
                         java.util.Map<java.lang.String,java.lang.Object> params,
                         Datasource parentDs)

Open an edit screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

parentDs - if this parameter is not null, the editor will commit edited instance into this datasource instead of directly to database

Returns:

created window

openEditor

Window.Editor openEditor(java.lang.String windowAlias,
                         Entity item,
                         WindowManager.OpenType openType,
                         java.util.Map<java.lang.String,java.lang.Object> params)

Open an edit screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openEditor

Window.Editor openEditor(java.lang.String windowAlias,
                         Entity item,
                         WindowManager.OpenType openType,
                         Datasource parentDs)

Open an edit screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

parentDs - if this parameter is not null, the editor will commit edited instance into this datasource instead of directly to database

Returns:

created window

openEditor

Window.Editor openEditor(java.lang.String windowAlias,
                         Entity item,
                         WindowManager.OpenType openType)

Open an edit screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

Returns:

created window

openLookup

Window.Lookup openLookup(java.lang.Class<? extends Entity> entityClass,
                         Window.Lookup.Handler handler,
                         WindowManager.OpenType openType)

Open a lookup screen.

Parameters:

entityClass - required class of entity

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

Returns:

created window

openLookup

Window.Lookup openLookup(java.lang.Class<? extends Entity> entityClass,
                         Window.Lookup.Handler handler,
                         WindowManager.OpenType openType,
                         java.util.Map<java.lang.String,java.lang.Object> params)

Open a lookup screen.

Parameters:

entityClass - required class of entity

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openLookup

Window.Lookup openLookup(java.lang.String windowAlias,
                         Window.Lookup.Handler handler,
                         WindowManager.OpenType openType,
                         java.util.Map<java.lang.String,java.lang.Object> params)

Open a lookup screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

params - parameters to pass to init() method of the screen's controller

Returns:

created window

openLookup

Window.Lookup openLookup(java.lang.String windowAlias,
                         Window.Lookup.Handler handler,
                         WindowManager.OpenType openType)

Open a lookup screen.

Parameters:

windowAlias - screen ID as defined in screens.xml

handler - is invoked when selection confirmed and the lookup screen closes

openType - how to open the screen

Returns:

created window

openFrame

Frame openFrame(@Nullable
                Component parent,
                java.lang.String windowAlias)

Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.

Parameters:

parent - if specified, all parent's subcomponents will be removed and the frame will be added

windowAlias - frame ID as defined in screens.xml

Returns:

frame's controller instance

openFrame

Frame openFrame(@Nullable
                Component parent,
                java.lang.String windowAlias,
                java.util.Map<java.lang.String,java.lang.Object> params)

Load a frame registered in screens.xml and optionally show it inside a parent component of this frame.

Parameters:

parent - if specified, all parent's subcomponents will be removed and the frame will be added

windowAlias - frame ID as defined in screens.xml

params - parameters to be passed into the frame's controller init method

Returns:

frame's controller instance

showMessageDialog

void showMessageDialog(java.lang.String title,
                       java.lang.String message,
                       Frame.MessageType messageType)

Show message dialog with title and message.
Message supports line breaks (\n).

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

showOptionDialog

void showOptionDialog(java.lang.String title,
                      java.lang.String message,
                      Frame.MessageType messageType,
                      Action[] actions)

Show options dialog with title and message.
Message supports line breaks (\n).

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

actions - array of actions that represent options. For standard options consider use of DialogAction instances.

showOptionDialog

void showOptionDialog(java.lang.String title,
                      java.lang.String message,
                      Frame.MessageType messageType,
                      java.util.List<Action> actions)

Show options dialog with title and message.
Message supports line breaks (\n).

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

actions - list of actions that represent options. For standard options consider use of DialogAction instances.

showNotification

void showNotification(java.lang.String caption)

Show notification with Frame.NotificationType.HUMANIZED.
Supports line breaks (\n).

Parameters:

caption - notification text

showNotification

void showNotification(java.lang.String caption,
                      Frame.NotificationType type)

Show notification.
Supports line breaks (\n) for non HTML type.

Parameters:

caption - notification text

type - defines how to display the notification. Don't forget to escape data from the database in case of *_HTML types!

showNotification

void showNotification(java.lang.String caption,
                      java.lang.String description,
                      Frame.NotificationType type)

Show notification with caption and description.
Supports line breaks (\n) for non HTML type.

Parameters:

caption - notification text

description - notification description

type - defines how to display the notification. Don't forget to escape data from the database in case of *_HTML types!

showWebPage

void showWebPage(java.lang.String url,
                 @Nullable
                 java.util.Map<java.lang.String,java.lang.Object> params)

Open a web page in browser.

Parameters:

url - URL of the page

params - optional parameters.
The following parameters are recognized by Web client: - target - String value used as the target name in a window.open call in the client. This means that special values such as "_blank", "_self", "_top", "_parent" have special meaning. If not specified, "_blank" is used.
- width - Integer value specifying the width of the browser window in pixels
- height - Integer value specifying the height of the browser window in pixels
- border - String value specifying the border style of the window of the browser window. Possible values are "DEFAULT", "MINIMAL", "NONE".

Desktop client doesn't support any parameters and just ignores them.