com.haulmont.cuba.gui.components

Class AbstractWindow

java.lang.Object

com.haulmont.cuba.gui.components.AbstractFrame

com.haulmont.cuba.gui.components.AbstractWindow

All Implemented Interfaces:

Component, Component.ActionsHolder, Component.BelongToFrame, Component.Container, Component.HasCaption, Component.HasIcon, Component.HasXmlDescriptor, Component.Margin, Component.OrderedContainer, Component.SecuredActionsHolder, Component.Spacing, Component.Wrapper, ExpandingLayout, Frame, Frame.Wrapper, Window, Window.Wrapper

Direct Known Subclasses:

AboutWindow, AbstractEditor, AbstractLookup, AbstractTopLevelWindow, AddConditionWindow, AdditionLoggerWindow, AppLoginWindow, AppPropertiesBrowse, AppPropertiesEdit, AppPropertiesExport, BackgroundWorkProgressWindow, BackgroundWorkWindow, BulkEditorWindow, ChangePasswordDialog, ControlLoggerWindow, CopySettings, CustomConditionEditor, DateIntervalEditor, DynamicAttributesConditionEditor, EntityInspectorEditor, EntityLogBrowser, EntityRestore, FileFrameController, FileUploadDialog, FilterEditor, FilterSelectWindow, GroupBrowser, LayoutAnalyzerWindow, LicenseWindow, ListEditorPopupWindow, LocalizedEnumerationWindow, LockBrowser, LogDownloadOptionsWindow, MbeansDisplayWindow, MultiUploader, NewPasswordsList, OperationResultWindow, ResetPasswordsDialog, SaveFilterWindow, SaveSetWindow, ScheduledExecutionBrowser, ScheduledTaskBrowser, ScreenHistoryBrowse, ScreenProfilerWindow, SendingMessageBrowser, ServerLogWindow, SessionMessageWindow, SettingsWindow, StatisticsWindow, SystemInfoWindow, ThreadsMonitoringWindow

public class AbstractWindow
extends AbstractFrame
implements Window, Component.HasXmlDescriptor, Window.Wrapper, Component.SecuredActionsHolder

Base class for simple screen controllers.

Nested Class Summary

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

Window.BeforeCloseEvent, Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithCloseButtonListener, Window.BeforeCloseWithShortcutEvent, Window.BeforeCloseWithShortcutListener, Window.CloseListener, Window.CloseWithCommitListener, Window.Committable, Window.ContentSwitchMode, Window.Editor, Window.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.Lookup, Window.MainWindow, Window.TopLevelWindow, Window.Wrapper

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

Frame.MessageMode, Frame.MessageType, Frame.NotificationType

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 inherited from interface com.haulmont.cuba.gui.components.Window

BROWSE_WINDOW_SUFFIX, CLOSE_ACTION_ID, COMMIT_ACTION_ID, CREATE_WINDOW_SUFFIX, EDITOR_WINDOW_SUFFIX, LOOKUP_WINDOW_SUFFIX, NAME, SELECT_ACTION_ID

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
AbstractWindow()

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 Window.COMMIT_ACTION_ID.
void	addListener(Window.CloseListener listener) Deprecated. Use Window.addCloseListener(CloseListener)
void	addTimer(Timer timer) Add a Timer component to this screen.
void	applySettings(Settings settings) This method is called when the screen is opened to restore settings saved in the database for the current user.
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
ActionsPermissions	getActionsPermissions()
java.lang.String	getCaption()
Window.ContentSwitchMode	getContentSwitchMode() Returns how the managed main TabSheet switches a tab with this window: hides or unloads its content.
WindowContext	getContext()
java.lang.String	getDescription() Screen description is used by the framework to show some specified information, e.g.
DialogOptions	getDialogOptions()
DsContext	getDsContext()
java.lang.String	getFocusComponent()
java.lang.String	getIcon() Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
Settings	getSettings()
Timer	getTimer(java.lang.String id) Returns a Timer added to this screen.
WindowManager	getWindowManager()
Window	getWrappedWindow() INTERNAL.
org.dom4j.Element	getXmlDescriptor()
boolean	isAttributeAccessControlEnabled() Whether automatic applying of attribute access rules enabled.
void	ready() Hook to be implemented in subclasses.
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. Use Window.removeCloseListener(CloseListener)
void	saveSettings() This method is called when the screen is closed to save the screen settings to the database.
void	setCaption(java.lang.String caption) Set the screen caption.
void	setContentSwitchMode(Window.ContentSwitchMode mode) Sets how the managed main TabSheet switches a tab with this window: hides or unloads its content.
void	setDescription(java.lang.String description) Screen description is used by the framework to show some specified information, e.g.
void	setDsContext(DsContext dsContext) INTERNAL.
void	setFocusComponent(java.lang.String componentId) Set a component to be focused after the screen is opened.
void	setIcon(java.lang.String icon) Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
void	setIconFromSet(Icons.Icon icon) Set an icon from an icon set.
void	setWindowManager(WindowManager windowManager) INTERNAL.
void	setXmlDescriptor(org.dom4j.Element element)
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 class com.haulmont.cuba.gui.components.AbstractFrame

add, add, addAction, addAction, addStyleName, expand, expand, getAction, getActions, getAlignment, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getDebugId, getDialogParams, getExpandDirection, getFrame, getHeight, getHeightUnits, getId, getMargin, getMessagesPack, getOwnComponent, getOwnComponents, getParent, getRegisteredComponent, getSpacing, getStyleName, getUiEventListeners, getWidth, getWidthUnits, getWrappedFrame, indexOf, init, isEnabled, isEnabledItself, isExpanded, isResponsive, isValid, isVisible, isVisibleItself, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, registerComponent, remove, removeAction, removeAction, removeAll, removeAllActions, removeStyleName, requestFocus, resetExpanded, setAlignment, setCompanion, setContext, setDebugId, setEnabled, setFrame, setHeight, setId, setMargin, setMessagesPack, setParent, setResponsive, setSpacing, setStyleName, setUiEventListeners, setVisible, setWidth, setWrappedFrame, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showValidationErrors, showWebPage, unregisterComponent, unwrap, unwrapComposition, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDialogParams, getMessagesPack, getRegisteredComponent, isValid, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, registerComponent, setContext, 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

Constructor Detail

AbstractWindow

public AbstractWindow()

Method Detail

getXmlDescriptor

public org.dom4j.Element getXmlDescriptor()

Specified by:

getXmlDescriptor in interface Component.HasXmlDescriptor

setXmlDescriptor

public void setXmlDescriptor(org.dom4j.Element element)

Specified by:

setXmlDescriptor in interface Component.HasXmlDescriptor

getContext

public WindowContext getContext()

Specified by:

getContext in interface Frame

Specified by:

getContext in interface Window

Overrides:

getContext in class AbstractFrame

Returns:

current frame context

getDsContext

public DsContext getDsContext()

Specified by:

getDsContext in interface Frame

Overrides:

getDsContext in class AbstractFrame

Returns:

DsContext of the current frame or window

setDsContext

public void setDsContext(DsContext dsContext)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

setDsContext in interface Frame

Overrides:

setDsContext in class AbstractFrame

addListener

@Deprecated
public void addListener(Window.CloseListener listener)

Deprecated. Use Window.addCloseListener(CloseListener)

Description copied from interface: Window

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

Specified by:

addListener in interface Window

Parameters:

listener - listener instance

removeListener

@Deprecated
public void removeListener(Window.CloseListener listener)

Deprecated. Use Window.removeCloseListener(CloseListener)

Specified by:

removeListener in interface Window

addCloseListener

public void addCloseListener(Window.CloseListener listener)

Description copied from interface: Window

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

Specified by:

addCloseListener in interface Window

Parameters:

listener - listener instance

removeCloseListener

public void removeCloseListener(Window.CloseListener listener)

Specified by:

removeCloseListener in interface Window

addCloseWithCommitListener

public void addCloseWithCommitListener(Window.CloseWithCommitListener listener)

Description copied from interface: Window

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

Specified by:

addCloseWithCommitListener in interface Window

Parameters:

listener - listener instance

removeCloseWithCommitListener

public void removeCloseWithCommitListener(Window.CloseWithCommitListener listener)

Specified by:

removeCloseWithCommitListener in interface Window

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Component.HasCaption

Overrides:

getCaption in class AbstractFrame

Returns:

screen caption which is set in XML or via setCaption(String)

setCaption

public void setCaption(java.lang.String caption)

Set the screen caption. If called in AbstractFrame.init(java.util.Map), overrides the value from XML.

Specified by:

setCaption in interface Component.HasCaption

Overrides:

setCaption in class AbstractFrame

Parameters:

caption - caption

getDescription

public java.lang.String getDescription()

Screen description is used by the framework to show some specified information, e.g. current filter or folder name. We don't recommend to use it in application code.

Specified by:

getDescription in interface Component.HasCaption

Overrides:

getDescription in class AbstractFrame

setDescription

public void setDescription(java.lang.String description)

Screen description is used by the framework to show some specified information, e.g. current filter or folder name. We don't recommend to use it in application code.

Specified by:

setDescription in interface Component.HasCaption

Overrides:

setDescription in class AbstractFrame

getWrappedWindow

public Window getWrappedWindow()

INTERNAL. Don't call from application code.

Specified by:

getWrappedWindow in interface Window.Wrapper

applySettings

public void applySettings(Settings settings)

This method is called when the screen is opened to restore settings saved in the database for the current user.

You can override it to restore custom settings.

For example:

 public void applySettings(Settings settings) {
     super.applySettings(settings);
     String visible = settings.get(hintBox.getId()).attributeValue("visible");
     if (visible != null)
         hintBox.setVisible(Boolean.valueOf(visible));
 }
 

Specified by:

applySettings in interface Window

Parameters:

settings - settings object loaded from the database for the current user

saveSettings

public void saveSettings()

This method is called when the screen is closed to save the screen settings to the database.

Specified by:

saveSettings in interface Window

deleteSettings

public void deleteSettings()

Description copied from interface: Window

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

Specified by:

deleteSettings in interface Window

setFocusComponent

public void setFocusComponent(java.lang.String componentId)

Description copied from interface: Window

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

Specified by:

setFocusComponent in interface Window

Parameters:

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

getFocusComponent

public java.lang.String getFocusComponent()

Specified by:

getFocusComponent in interface Window

Returns:

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

getSettings

public Settings getSettings()

Specified by:

getSettings in interface Window

Returns:

the screen settings interface. Never null.

addTimer

public void addTimer(Timer timer)

Description copied from interface: Window

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.

Specified by:

addTimer in interface Window

Parameters:

timer - Timer instance

getTimer

public Timer getTimer(java.lang.String id)

Description copied from interface: Window

Returns a Timer added to this screen.

Specified by:

getTimer in interface Window

Parameters:

id - timer ID

Returns:

timer instance or null if not found

validate

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

Description copied from interface: Frame

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

Specified by:

validate in interface Frame

Specified by:

validate in interface Window

Overrides:

validate in class AbstractFrame

Returns:

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

validateAll

public boolean validateAll()

Check validity by invoking validators on all components which support them and show validation result notification. This method also calls postValidate(ValidationErrors) hook to support additional validation.

You should override this method in subclasses ONLY if you want to completely replace the validation process, otherwise use postValidate(ValidationErrors).

Specified by:

validateAll in interface Frame

Specified by:

validateAll in interface Window

Overrides:

validateAll in class AbstractFrame

Returns:

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

getWindowManager

public WindowManager getWindowManager()

Specified by:

getWindowManager in interface Window

Returns:

window manager instance

setWindowManager

public void setWindowManager(WindowManager windowManager)

Description copied from interface: Window

INTERNAL. Don't call from application code.

Specified by:

setWindowManager in interface Window

getDialogOptions

public DialogOptions getDialogOptions()

Specified by:

getDialogOptions in interface Window

Returns:

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

isAttributeAccessControlEnabled

public boolean isAttributeAccessControlEnabled()

Whether automatic applying of attribute access rules enabled. If you don't want to apply attribute access rules to a screen, override this method and return false.

ready

public void ready()

Hook to be implemented in subclasses.
Called by the framework after the screen is fully initialized and opened.
Override this method and put custom initialization logic here.

close

public boolean close(java.lang.String actionId)

Close the screen.
If the screen has uncommitted changes in its DsContext, the confirmation dialog will be shown.
Don't override this method in subclasses, use hook preClose(String)

Specified by:

close in interface Window

Parameters:

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

close

public 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.
Don't override this method in subclasses, use hook preClose(String)

Specified by:

close in interface Window

Parameters:

actionId - action ID that will be propagated to attached CloseListeners. Use Window.COMMIT_ACTION_ID if some changes have just been committed, or Window.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

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

INTERNAL. Don't call or override in application code.

Specified by:

closeAndRun in interface Window

getActionsPermissions

public ActionsPermissions getActionsPermissions()

Specified by:

getActionsPermissions in interface Component.SecuredActionsHolder

Returns:

permissions container

getIcon

public java.lang.String getIcon()

Description copied from interface: Component.HasIcon

Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

getIcon in interface Component.HasIcon

Overrides:

getIcon in class AbstractFrame

setIcon

public void setIcon(java.lang.String icon)

Description copied from interface: Component.HasIcon

Set an icon by its source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.

Specified by:

setIcon in interface Component.HasIcon

Overrides:

setIcon in class AbstractFrame

setIconFromSet

public void setIconFromSet(Icons.Icon icon)

Description copied from interface: Component.HasIcon

Set an icon from an icon set.

Specified by:

setIconFromSet in interface Component.HasIcon

Overrides:

setIconFromSet in class AbstractFrame

getContentSwitchMode

public Window.ContentSwitchMode getContentSwitchMode()

Description copied from interface: Window

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

Specified by:

getContentSwitchMode in interface Window

Returns:

one of the Window.ContentSwitchMode enum values

setContentSwitchMode

public void setContentSwitchMode(Window.ContentSwitchMode mode)

Description copied from interface: Window

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

Specified by:

setContentSwitchMode in interface Window

Parameters:

mode - one of the Window.ContentSwitchMode enum values

addBeforeCloseWithShortcutListener

public void addBeforeCloseWithShortcutListener(Window.BeforeCloseWithShortcutListener listener)

Description copied from interface: Window

Register a new before close with shortcut listener.

Specified by:

addBeforeCloseWithShortcutListener in interface Window

Parameters:

listener - the listener to register

removeBeforeCloseWithShortcutListener

public void removeBeforeCloseWithShortcutListener(Window.BeforeCloseWithShortcutListener listener)

Description copied from interface: Window

Removes a previously registered before close with shortcut listener.

Specified by:

removeBeforeCloseWithShortcutListener in interface Window

Parameters:

listener - the listener to remove

addBeforeCloseWithCloseButtonListener

public void addBeforeCloseWithCloseButtonListener(Window.BeforeCloseWithCloseButtonListener listener)

Description copied from interface: Window

Register a new before close with close button listener.

Specified by:

addBeforeCloseWithCloseButtonListener in interface Window

Parameters:

listener - the listener to register

removeBeforeCloseWithCloseButtonListener

public void removeBeforeCloseWithCloseButtonListener(Window.BeforeCloseWithCloseButtonListener listener)

Description copied from interface: Window

Removes a previously registered before close with close button listener.

Specified by:

removeBeforeCloseWithCloseButtonListener in interface Window

Parameters:

listener - the listener to remove