com.haulmont.cuba.gui.components

Interface Window

All Superinterfaces:

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

All Known Subinterfaces:

ListEditorWindowController, Window.Committable, Window.Editor, Window.Lookup, Window.MainWindow, Window.TopLevelWindow

All Known Implementing Classes:

AboutWindow, AbstractEditor, AbstractLookup, AbstractMainWindow, AbstractTopLevelWindow, AbstractWindow, AddConditionWindow, AdditionLoggerWindow, AppLoginWindow, AppMainWindow, AppPropertiesBrowse, AppPropertiesEdit, AppPropertiesExport, AttributeEditor, AttributeEditWindow, BackgroundWorkProgressWindow, BackgroundWorkWindow, BulkEditorWindow, CategoryBrowser, CategoryEditor, ChangePasswordDialog, CommonLookupController, ConstraintEditor, ConstraintLocalizationEdit, ControlLoggerWindow, CopySettings, CustomConditionEditor, DateIntervalEditor, DynamicAttributesConditionEditor, EntityCombinedScreen, EntityInspectorBrowse, EntityInspectorEditor, EntityLogBrowser, EntityRestore, FileBrowser, FileEditor, FileFrameController, FileUploadDialog, FilterEditor, FilterSelectWindow, GroupBrowser, GroupEditor, GroupLookup, JmxInstanceBrowser, JmxInstanceEditor, LayoutAnalyzerWindow, LicenseWindow, ListEditorPopupWindow, LocalizedEnumerationWindow, LockBrowser, LockEditor, LogDownloadOptionsWindow, MbeanInspectWindow, MbeansDisplayWindow, MultiUploader, NewPasswordsList, OperationResultWindow, ResetPasswordsDialog, RoleBrowser, RoleEditor, SaveFilterWindow, SaveSetWindow, ScheduledExecutionBrowser, ScheduledTaskBrowser, ScheduledTaskEditor, ScreenHistoryBrowse, ScreenProfilerWindow, SendingMessageAttachments, SendingMessageBrowser, ServerLogWindow, SessionAttributeEditor, SessionBrowser, SessionLogBrowser, SessionMessageWindow, SettingsWindow, StatisticsWindow, SystemInfoWindow, ThreadsMonitoringWindow, UserBrowser, UserEditor, UserLookup, UserSubstitutionEditor, WebWindow, WebWindow.Editor, WebWindow.Lookup

public interface Window
extends Frame, Component.HasCaption, Component.HasIcon

Represents an independent screen opened inside the main application window.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Window.BeforeCloseEvent
static class	Window.BeforeCloseWithCloseButtonEvent An event that is fired before a screen is closed with one of the following approaches: screen's close button, bread crumbs, TabSheet tabs' close actions (Close, Close All, Close Others).
static interface	Window.BeforeCloseWithCloseButtonListener Listener to be notified when a screen is closed with one of the following approaches: screen's close button, bread crumbs, TabSheet tabs' close actions (Close, Close All, Close Others).
static class	Window.BeforeCloseWithShortcutEvent An event that is fired before a screen is closed with ClientConfig.getCloseShortcut().
static interface	Window.BeforeCloseWithShortcutListener Listener to be notified when a screen is closed with ClientConfig.getCloseShortcut().
static interface	Window.CloseListener Listener to be notified when a screen is closed.
static interface	Window.CloseWithCommitListener Listener to be notified when a screen is closed with actionId COMMIT_ACTION_ID.
static interface	Window.Committable Represents a window that can be committed on close.
static class	Window.ContentSwitchMode Defines how the managed main TabSheet switches a tab with the given window: hides or unloads its content.
static interface	Window.Editor Represents an edit screen.
static interface	Window.HasFoldersPane
static interface	Window.HasUserIndicator
static interface	Window.HasWorkArea
static interface	Window.Lookup Represents a lookup screen.
static interface	Window.MainWindow
static interface	Window.TopLevelWindow Marker interface implemented by top-level windows of the application: login window and main window.
static interface	Window.Wrapper INTERNAL.

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

Frame.MessageMode, Frame.MessageType, Frame.NotificationType, Frame.UiEventListenersHolder

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	BROWSE_WINDOW_SUFFIX
static java.lang.String	CLOSE_ACTION_ID Constant that should be passed to close(String) and close(String, boolean) methods when the screen is closed without commit.
static java.lang.String	COMMIT_ACTION_ID Constant that should be passed to close(String) and close(String, boolean) methods when the screen is closed after commit of changes.
static java.lang.String	CREATE_WINDOW_SUFFIX
static java.lang.String	EDITOR_WINDOW_SUFFIX
static java.lang.String	LOOKUP_WINDOW_SUFFIX
static java.lang.String	NAME Name that is used to register a client type specific screen implementation in ComponentsFactory
static java.lang.String	SELECT_ACTION_ID Constant that passed to close(String) and close(String, boolean) methods when the lookup screen is closed with selected items.

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
void	addBeforeCloseWithCloseButtonListener(Window.BeforeCloseWithCloseButtonListener listener) Register a new before close with close button listener.
void	addBeforeCloseWithShortcutListener(Window.BeforeCloseWithShortcutListener listener) Register a new before close with shortcut listener.
void	addCloseListener(Window.CloseListener listener) Add a listener that will be notified when this screen is closed.
void	addCloseWithCommitListener(Window.CloseWithCommitListener listener) Add a listener that will be notified when this screen is closed with actionId COMMIT_ACTION_ID.
void	addListener(Window.CloseListener listener) Deprecated. Use addCloseListener(CloseListener)
void	addTimer(Timer timer) Add a Timer component to this screen.
void	applySettings(Settings settings) This method is called by the framework after opening the screen to apply user settings to all components.
boolean	close(java.lang.String actionId) Close the screen.
boolean	close(java.lang.String actionId, boolean force) Close the screen.
void	closeAndRun(java.lang.String actionId, java.lang.Runnable runnable) INTERNAL.
void	deleteSettings() This method is called by the framework on reset to defaults action
Window.ContentSwitchMode	getContentSwitchMode() Returns how the managed main TabSheet switches a tab with this window: hides or unloads its content.
WindowContext	getContext()
DialogOptions	getDialogOptions()
java.lang.String	getFocusComponent()
Settings	getSettings()
Timer	getTimer(java.lang.String id) Returns a Timer added to this screen.
WindowManager	getWindowManager()
void	removeBeforeCloseWithCloseButtonListener(Window.BeforeCloseWithCloseButtonListener listener) Removes a previously registered before close with close button listener.
void	removeBeforeCloseWithShortcutListener(Window.BeforeCloseWithShortcutListener listener) Removes a previously registered before close with shortcut listener.
void	removeCloseListener(Window.CloseListener listener)
void	removeCloseWithCommitListener(Window.CloseWithCommitListener listener)
void	removeListener(Window.CloseListener listener) Deprecated.
void	saveSettings() This method is called by the framework when closing the screen to save user settings if they have been changed.
void	setContentSwitchMode(Window.ContentSwitchMode mode) Sets how the managed main TabSheet switches a tab with this window: hides or unloads its content.
void	setFocusComponent(java.lang.String componentId) Set a component to be focused after the screen is opened.
void	setWindowManager(WindowManager windowManager) INTERNAL.
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.Frame

getDialogParams, getDsContext, getMessagesPack, getRegisteredComponent, isValid, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, registerComponent, setContext, setDsContext, setMessagesPack, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage, unregisterComponent, validate

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

Name that is used to register a client type specific screen implementation in ComponentsFactory

See Also:

Constant Field Values

COMMIT_ACTION_ID

static final java.lang.String COMMIT_ACTION_ID

Constant that should be passed to close(String) and close(String, boolean) methods when the screen is closed after commit of changes. Propagated to Window.CloseListener.windowClosed(java.lang.String).

See Also:

Constant Field Values

CLOSE_ACTION_ID

static final java.lang.String CLOSE_ACTION_ID

Constant that should be passed to close(String) and close(String, boolean) methods when the screen is closed without commit. Propagated to Window.CloseListener.windowClosed(java.lang.String).

See Also:

Constant Field Values

SELECT_ACTION_ID

static final java.lang.String SELECT_ACTION_ID

Constant that passed to close(String) and close(String, boolean) methods when the lookup screen is closed with selected items. Propagated to Window.CloseListener.windowClosed(java.lang.String).

See Also:

Constant Field Values

BROWSE_WINDOW_SUFFIX

static final java.lang.String BROWSE_WINDOW_SUFFIX

See Also:

Constant Field Values

LOOKUP_WINDOW_SUFFIX

static final java.lang.String LOOKUP_WINDOW_SUFFIX

See Also:

Constant Field Values

EDITOR_WINDOW_SUFFIX

static final java.lang.String EDITOR_WINDOW_SUFFIX

See Also:

Constant Field Values

CREATE_WINDOW_SUFFIX

static final java.lang.String CREATE_WINDOW_SUFFIX

See Also:

Constant Field Values

Method Detail

getContext

WindowContext getContext()

Specified by:

getContext in interface Frame

Returns:

current window context

addListener

@Deprecated
void addListener(Window.CloseListener listener)

Deprecated. Use addCloseListener(CloseListener)

Add a listener that will be notified when this screen is closed.

Parameters:

listener - listener instance

removeListener

@Deprecated
void removeListener(Window.CloseListener listener)

Deprecated.

addCloseListener

void addCloseListener(Window.CloseListener listener)

Add a listener that will be notified when this screen is closed.

Parameters:

listener - listener instance

removeCloseListener

void removeCloseListener(Window.CloseListener listener)

addCloseWithCommitListener

void addCloseWithCommitListener(Window.CloseWithCommitListener listener)

Add a listener that will be notified when this screen is closed with actionId COMMIT_ACTION_ID.

Parameters:

listener - listener instance

removeCloseWithCommitListener

void removeCloseWithCommitListener(Window.CloseWithCommitListener listener)

applySettings

void applySettings(Settings settings)

This method is called by the framework after opening the screen to apply user settings to all components.

saveSettings

void saveSettings()

This method is called by the framework when closing the screen to save user settings if they have been changed.

deleteSettings

void deleteSettings()

This method is called by the framework on reset to defaults action

setFocusComponent

void setFocusComponent(java.lang.String componentId)

Set a component to be focused after the screen is opened.

Parameters:

componentId - component's ID in XML. If null, then first focusable component will be focused

getFocusComponent

java.lang.String getFocusComponent()

Returns:

an ID of the component which is set to be focused after the screen is opened

getSettings

Settings getSettings()

Returns:

object encapsulating user settings for the current screen

close

boolean close(java.lang.String actionId)

Close the screen.
If the screen has uncommitted changes in its DsContext, the confirmation dialog will be shown.

Parameters:

actionId - action ID that will be propagated to attached Window.CloseListeners. Use COMMIT_ACTION_ID if some changes have just been committed, or CLOSE_ACTION_ID otherwise. These constants are recognized by various mechanisms of the framework.

close

boolean close(java.lang.String actionId,
              boolean force)

Close the screen.
If the window has uncommitted changes in its DsContext, and force=false, the confirmation dialog will be shown.

Parameters:

actionId - action ID that will be propagated to attached Window.CloseListeners. Use COMMIT_ACTION_ID if some changes have just been committed, or CLOSE_ACTION_ID otherwise. These constants are recognized by various mechanisms of the framework.

force - if true, no confirmation dialog will be shown even if the screen has uncommitted changes

closeAndRun

void closeAndRun(java.lang.String actionId,
                 java.lang.Runnable runnable)

INTERNAL. Don't call from application code.

addTimer

void addTimer(Timer timer)

Add a Timer component to this screen.
This method is called when a timer is created from XML descriptor. It should also be called from an application code if the timer is created programmatically by ComponentsFactory.createTimer() method.
The timer added to the window is stopped when the window is closed.

Parameters:

timer - Timer instance

getTimer

@Nullable
Timer getTimer(java.lang.String id)

Returns a Timer added to this screen.

Parameters:

id - timer ID

Returns:

timer instance or null if not found

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.

Specified by:

validate in interface Frame

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.

Specified by:

validateAll in interface Frame

Returns:

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

getWindowManager

WindowManager getWindowManager()

Returns:

window manager instance

setWindowManager

void setWindowManager(WindowManager windowManager)

INTERNAL. Don't call from application code.

getDialogOptions

DialogOptions getDialogOptions()

Returns:

dialog options of window. Options will be applied only if window opened with WindowManager.OpenMode.DIALOG.

getContentSwitchMode

Window.ContentSwitchMode getContentSwitchMode()

Returns how the managed main TabSheet switches a tab with this window: hides or unloads its content.

Returns:

one of the Window.ContentSwitchMode enum values

setContentSwitchMode

void setContentSwitchMode(Window.ContentSwitchMode mode)

Sets how the managed main TabSheet switches a tab with this window: hides or unloads its content.

Note that: a method invocation will take effect only if cuba.web.mainTabSheetMode property is set to 'MANAGED'.

Parameters:

mode - one of the Window.ContentSwitchMode enum values

addBeforeCloseWithShortcutListener

void addBeforeCloseWithShortcutListener(Window.BeforeCloseWithShortcutListener listener)

Register a new before close with shortcut listener.

Parameters:

listener - the listener to register

removeBeforeCloseWithShortcutListener

void removeBeforeCloseWithShortcutListener(Window.BeforeCloseWithShortcutListener listener)

Removes a previously registered before close with shortcut listener.

Parameters:

listener - the listener to remove

addBeforeCloseWithCloseButtonListener

void addBeforeCloseWithCloseButtonListener(Window.BeforeCloseWithCloseButtonListener listener)

Register a new before close with close button listener.

Parameters:

listener - the listener to register

removeBeforeCloseWithCloseButtonListener

void removeBeforeCloseWithCloseButtonListener(Window.BeforeCloseWithCloseButtonListener listener)

Removes a previously registered before close with close button listener.

Parameters:

listener - the listener to remove