com.haulmont.cuba.web.gui

Class WebWindow

java.lang.Object

com.haulmont.cuba.web.gui.WebWindow

All Implemented Interfaces:

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

Direct Known Subclasses:

WebWindow.Editor, WebWindow.Lookup

public class WebWindow
extends java.lang.Object
implements Window, Component.Wrapper, Component.HasXmlDescriptor, WrappedWindow, Component.Disposable, Component.SecuredActionsHolder, Component.HasIcon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebWindow.Editor
static class	WebWindow.Lookup

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.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.MainWindow, Window.TopLevelWindow, Window.Wrapper

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 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
WebWindow()

Method Summary

Modifier and Type	Method and Description
void	add(Component childComponent)
void	add(Component childComponent, int index)
void	addAction(Action action) Add an action to the component
void	addAction(Action action, int index) Add an action to the component with index.
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) Add a listener that will be notified when this screen is closed.
void	addStyleName(java.lang.String styleName) Adds one or more style names to this component.
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
void	dispose()
void	expand(Component component)
void	expand(Component component, java.lang.String height, java.lang.String width)
boolean	findAndFocusChildComponent()
void	fireBeforeCloseWithCloseButton(Window.BeforeCloseWithCloseButtonEvent event)
void	fireBeforeCloseWithShortcut(Window.BeforeCloseWithShortcutEvent event)
Action	getAction(java.lang.String id)
java.util.Collection<Action>	getActions()
ActionsPermissions	getActionsPermissions()
Component.Alignment	getAlignment()
java.lang.String	getCaption()
com.vaadin.ui.Component	getComponent()
Component	getComponent(int index) Returns the component at the given position.
Component	getComponent(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
com.vaadin.ui.Component	getComposition()
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	getDebugId()
java.lang.String	getDescription()
DialogOptions	getDialogOptions()
DialogParams	getDialogParams() Deprecated.
DsContext	getDsContext()
ExpandingLayout.ExpandDirection	getExpandDirection()
java.lang.String	getFocusComponent()
Frame	getFrame()
float	getHeight() Get component height in Component.getHeightUnits()
int	getHeightUnits() Height units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE
java.lang.String	getIcon() Get icon source: "font-icon:ADD", "icons/myicon.png", "theme://createIcon", etc.
java.lang.String	getId() Component ID as defined in id attribute
MarginInfo	getMargin()
java.lang.String	getMessagesPack()
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
Component	getParent()
Component	getRegisteredComponent(java.lang.String id) INTERNAL.
Settings	getSettings()
boolean	getSpacing()
java.lang.String	getStyleName() Styles implementation is client-type-specific.
Timer	getTimer(java.lang.String id) Returns a Timer added to this screen.
float	getWidth() Get component width in Component.getWidthUnits()
int	getWidthUnits() Width units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE
WebWindowManager	getWindowManager()
Window	getWrapper()
org.dom4j.Element	getXmlDescriptor()
int	indexOf(Component component)
boolean	isDefaultScreenWindow()
boolean	isDisposed()
boolean	isEnabled() Are the component and its parent enabled?
boolean	isEnabledItself() Is the component enabled regardless of the parent?
boolean	isExpanded(Component component)
boolean	isModified()
boolean	isResponsive() Is the component responsive?
boolean	isValid() Check validity by invoking validators on all components which support them.
boolean	isVisible() Are the component and its parent visible?
boolean	isVisibleItself() Is the component visible regardless of the parent?
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	remove(Component childComponent)
void	removeAction(Action action) Remove the action from the component
void	removeAction(java.lang.String id) Remove the action by its ID.
void	removeAll()
void	removeAllActions() Remove all actions from the component
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)
void	removeStyleName(java.lang.String styleName) Removes one or more style names from component.
void	requestFocus() Set focus to this component
void	resetExpanded()
void	saveSettings() This method is called by the framework when closing the screen to save user settings if they have been changed.
void	setAlignment(Component.Alignment alignment)
void	setCaption(java.lang.String caption)
void	setContentSwitchMode(Window.ContentSwitchMode mode) Sets how the managed main TabSheet switches a tab with this window: hides or unloads its content.
void	setContext(FrameContext ctx) INTERNAL.
void	setDebugId(java.lang.String debugId) INTERNAL.
void	setDefaultScreenWindow(boolean defaultScreenWindow)
void	setDescription(java.lang.String description)
void	setDsContext(DsContext dsContext) INTERNAL.
void	setEnabled(boolean enabled) Set component enabled state
void	setFocusComponent(java.lang.String componentId) Set a component to be focused after the screen is opened.
void	setFrame(Frame frame)
void	setHeight(java.lang.String height) Set component height in Component.getHeightUnits()
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	setId(java.lang.String id) Set component ID
void	setMargin(MarginInfo marginInfo)
void	setMessagesPack(java.lang.String name) Set message pack for this frame.
void	setParent(Component parent) INTERNAL. Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.
void	setResponsive(boolean responsive) Set component to be responsive by width and height.
void	setSpacing(boolean enabled)
void	setStyleName(java.lang.String name) Sets one or more style names of the component, replacing any previous styles.
void	setVisible(boolean visible) Set component visibility
void	setWidth(java.lang.String width) Set component width in Component.getWidthUnits()
void	setWindowManager(WindowManager windowManager) INTERNAL.
void	setXmlDescriptor(org.dom4j.Element element)
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	stopTimers() Completely stop and remove timers of the window.
void	unregisterComponent(Component component) INTERNAL.
<X> X	unwrap(java.lang.Class<X> internalComponentClass) Get client specific component instance.
<X> X	unwrapComposition(java.lang.Class<X> internalCompositionClass) Get the outmost external container of client specific component instance.
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.
Window	wrapBy(java.lang.Class<?> wrapperClass)

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

getComponentNN

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

getComponentNN

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

setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

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

setMargin, setMargin

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

getActionNN

Constructor Detail

WebWindow

public WebWindow()

Method Detail

getMessagesPack

public java.lang.String getMessagesPack()

Specified by:

getMessagesPack in interface Frame

Returns:

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

setMessagesPack

public void setMessagesPack(java.lang.String name)

Description copied from interface: Frame

Set message pack for this frame.

Specified by:

setMessagesPack in interface Frame

Parameters:

name - message pack name

registerComponent

public void registerComponent(Component component)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

registerComponent in interface Frame

unregisterComponent

public void unregisterComponent(Component component)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

unregisterComponent in interface Frame

getRegisteredComponent

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

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

getRegisteredComponent in interface Frame

getStyleName

public java.lang.String getStyleName()

Description copied from interface: Component

Styles implementation is client-type-specific.

Specified by:

getStyleName in interface Component

Returns:

current style name.

setStyleName

public void setStyleName(java.lang.String name)

Description copied from interface: Component

Sets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.

Specified by:

setStyleName in interface Component

Parameters:

name - one or more style names separated by space.

addStyleName

public void addStyleName(java.lang.String styleName)

Description copied from interface: Component

Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names.

Specified by:

addStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

removeStyleName

public void removeStyleName(java.lang.String styleName)

Description copied from interface: Component

Removes one or more style names from component. Multiple styles can be specified as a space-separated list of style names.

Specified by:

removeStyleName in interface Component

Parameters:

styleName - one or more style names separated by space.

unwrap

public <X> X unwrap(java.lang.Class<X> internalComponentClass)

Description copied from interface: Component

Get client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.TextField vTextField = textField.unwrap(com.vaadin.ui.TextField.class);
 

Specified by:

unwrap in interface Component

Type Parameters:

X - type of internal class

Parameters:

internalComponentClass - class of underlying component implementation based on Vaadin or Swing

Returns:

internal client specific component

unwrapComposition

public <X> X unwrapComposition(java.lang.Class<X> internalCompositionClass)

Description copied from interface: Component

Get the outmost external container of client specific component instance. Can be used in client module to simplify invocation of underlying API.
Example:

 com.vaadin.ui.Layout vLayout = table.unwrapComposition(com.vaadin.ui.Layout.class);
 

Specified by:

unwrapComposition in interface Component

Type Parameters:

X - type of internal class

Parameters:

internalCompositionClass - class of underlying composition implementation based on Vaadin or Swing

Returns:

internal client specific component

setSpacing

public void setSpacing(boolean enabled)

Specified by:

setSpacing in interface Component.Spacing

getSpacing

public boolean getSpacing()

Specified by:

getSpacing in interface Component.Spacing

setMargin

public void setMargin(MarginInfo marginInfo)

Specified by:

setMargin in interface Component.Margin

getMargin

public MarginInfo getMargin()

Specified by:

getMargin in interface Component.Margin

addAction

public void addAction(Action action)

Description copied from interface: Component.ActionsHolder

Add an action to the component

Specified by:

addAction in interface Component.ActionsHolder

addAction

public void addAction(Action action,
                      int index)

Description copied from interface: Component.ActionsHolder

Add an action to the component with index.

Specified by:

addAction in interface Component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         Action action)

Description copied from interface: Component.ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface Component.ActionsHolder

removeAction

public void removeAction(@Nullable
                         java.lang.String id)

Description copied from interface: Component.ActionsHolder

Remove the action by its ID. If there is no action with that ID, nothing happens.

Specified by:

removeAction in interface Component.ActionsHolder

removeAllActions

public void removeAllActions()

Description copied from interface: Component.ActionsHolder

Remove all actions from the component

Specified by:

removeAllActions in interface Component.ActionsHolder

getActions

public java.util.Collection<Action> getActions()

Specified by:

getActions in interface Component.ActionsHolder

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(java.lang.String id)

Specified by:

getAction in interface Component.ActionsHolder

Returns:

an action by its ID, or null if not found

isValid

public boolean isValid()

Description copied from interface: Frame

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

Specified by:

isValid in interface Frame

Returns:

true if all components are in valid state

validate

public void validate()
              throws ValidationException

Description copied from interface: Frame

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

Specified by:

validate in interface Frame

Throws:

ValidationException - if some components are currently in invalid state

validate

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

Description copied from interface: Window

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

Returns:

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

validateAll

public boolean validateAll()

Description copied from interface: Window

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

Specified by:

validateAll in interface Frame

Specified by:

validateAll in interface Window

Returns:

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

getWindowManager

public WebWindowManager 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.

getDialogParams

@Deprecated
public DialogParams getDialogParams()

Deprecated.

Specified by:

getDialogParams in interface Frame

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

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

Description copied from interface: Frame

Open a simple screen.

Specified by:

openWindow in interface Frame

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

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

Description copied from interface: Frame

Open a simple screen.

Specified by:

openWindow in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

openType - how to open the screen

Returns:

created window

openEditor

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

Description copied from interface: Frame

Open an edit screen for entity instance.

Specified by:

openEditor in interface Frame

Parameters:

item - entity to edit

openType - how to open the screen

Returns:

created window

openEditor

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

Description copied from interface: Frame

Open an edit screen for entity instance.

Specified by:

openEditor in interface Frame

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

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

Description copied from interface: Frame

Open an edit screen for entity instance.

Specified by:

openEditor in interface Frame

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

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

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

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

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

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

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

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

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

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

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

Description copied from interface: Frame

Open an edit screen.

Specified by:

openEditor in interface Frame

Parameters:

windowAlias - screen ID as defined in screens.xml

item - entity to edit

openType - how to open the screen

Returns:

created window

openLookup

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

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

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

public 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)

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

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

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

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

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

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

Description copied from interface: Frame

Open a lookup screen.

Specified by:

openLookup in interface Frame

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

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

Description copied from interface: Frame

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

Specified by:

openFrame in interface 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

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

Description copied from interface: Frame

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

Specified by:

openFrame in interface 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

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

Description copied from interface: Frame

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

Specified by:

showMessageDialog in interface Frame

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

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

Description copied from interface: Frame

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

Specified by:

showOptionDialog in interface Frame

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

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

Description copied from interface: Frame

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

Specified by:

showOptionDialog in interface Frame

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

public void showNotification(java.lang.String caption)

Description copied from interface: Frame

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

Specified by:

showNotification in interface Frame

Parameters:

caption - notification text

showNotification

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

Description copied from interface: Frame

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

Specified by:

showNotification in interface Frame

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

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

Description copied from interface: Frame

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

Specified by:

showNotification in interface Frame

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

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

Description copied from interface: Frame

Open a web page in browser.

Specified by:

showWebPage in interface Frame

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.

getContext

public WindowContext getContext()

Specified by:

getContext in interface Frame

Specified by:

getContext in interface Window

Returns:

current window context

setContext

public void setContext(FrameContext ctx)

Description copied from interface: Frame

INTERNAL. Don't call from application code.

Specified by:

setContext in interface Frame

getDsContext

public DsContext getDsContext()

Specified by:

getDsContext in interface Frame

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

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

addListener

public void addListener(Window.CloseListener listener)

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

public void removeListener(Window.CloseListener listener)

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

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

fireBeforeCloseWithShortcut

public void fireBeforeCloseWithShortcut(Window.BeforeCloseWithShortcutEvent event)

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

fireBeforeCloseWithCloseButton

public void fireBeforeCloseWithCloseButton(Window.BeforeCloseWithCloseButtonEvent event)

applySettings

public void applySettings(Settings settings)

Description copied from interface: Window

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

Specified by:

applySettings in interface Window

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

stopTimers

public void stopTimers()

Completely stop and remove timers of the window.

getSettings

public Settings getSettings()

Specified by:

getSettings in interface Window

Returns:

object encapsulating user settings for the current screen

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

add

public void add(Component childComponent)

Specified by:

add in interface Component.Container

add

public void add(Component childComponent,
                int index)

Specified by:

add in interface Component.OrderedContainer

indexOf

public int indexOf(Component component)

Specified by:

indexOf in interface Component.OrderedContainer

getComponent

@Nullable
public Component getComponent(int index)

Description copied from interface: Component.OrderedContainer

Returns the component at the given position.

Specified by:

getComponent in interface Component.OrderedContainer

Parameters:

index - component index

Returns:

the component at the given index or null.

remove

public void remove(Component childComponent)

Specified by:

remove in interface Component.Container

removeAll

public void removeAll()

Specified by:

removeAll in interface Component.Container

getOwnComponents

public java.util.Collection<Component> getOwnComponents()

Description copied from interface: Component.Container

Get all components directly owned by this container

Specified by:

getOwnComponents in interface Component.Container

getComponents

public java.util.Collection<Component> getComponents()

Description copied from interface: Component.Container

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

Specified by:

getComponents in interface Component.Container

getId

public java.lang.String getId()

Description copied from interface: Component

Component ID as defined in id attribute

Specified by:

getId in interface Component

setId

public void setId(java.lang.String id)

Description copied from interface: Component

Set component ID

Specified by:

setId in interface Component

getParent

public Component getParent()

Specified by:

getParent in interface Component

Returns:

Parent of component.

setParent

public void setParent(Component parent)

Description copied from interface: Component

INTERNAL.
Component.Container.add(Component) is normally used for adding components to a parent and the used method will call this method implicitly.

Specified by:

setParent in interface Component

Parameters:

parent - Parent component

getDebugId

public java.lang.String getDebugId()

Specified by:

getDebugId in interface Component

setDebugId

public void setDebugId(java.lang.String debugId)

Description copied from interface: Component

INTERNAL. Managed by debug Id system.

Specified by:

setDebugId in interface Component

isEnabled

public boolean isEnabled()

Description copied from interface: Component

Are the component and its parent enabled?

Specified by:

isEnabled in interface Component

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: Component

Set component enabled state

Specified by:

setEnabled in interface Component

isResponsive

public boolean isResponsive()

Description copied from interface: Component

Is the component responsive?

Specified by:

isResponsive in interface Component

setResponsive

public void setResponsive(boolean responsive)

Description copied from interface: Component

Set component to be responsive by width and height. If responsive flag is true then you can use conditional CSS rules that respond to size changes in the browser. You can set specific rules using "width-range" or "height-range" properties in CSS files.

Specified by:

setResponsive in interface Component

isVisible

public boolean isVisible()

Description copied from interface: Component

Are the component and its parent visible?

Specified by:

isVisible in interface Component

setVisible

public void setVisible(boolean visible)

Description copied from interface: Component

Set component visibility

Specified by:

setVisible in interface Component

isVisibleItself

public boolean isVisibleItself()

Description copied from interface: Component

Is the component visible regardless of the parent?

Specified by:

isVisibleItself in interface Component

isEnabledItself

public boolean isEnabledItself()

Description copied from interface: Component

Is the component enabled regardless of the parent?

Specified by:

isEnabledItself in interface Component

requestFocus

public void requestFocus()

Description copied from interface: Component

Set focus to this component

Specified by:

requestFocus in interface Component

getHeight

public float getHeight()

Description copied from interface: Component

Get component height in Component.getHeightUnits()

Specified by:

getHeight in interface Component

getHeightUnits

public int getHeightUnits()

Description copied from interface: Component

Height units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE

Specified by:

getHeightUnits in interface Component

setHeight

public void setHeight(java.lang.String height)

Description copied from interface: Component

Set component height in Component.getHeightUnits()

Specified by:

setHeight in interface Component

getWidth

public float getWidth()

Description copied from interface: Component

Get component width in Component.getWidthUnits()

Specified by:

getWidth in interface Component

getWidthUnits

public int getWidthUnits()

Description copied from interface: Component

Width units: Component.UNITS_PIXELS, Component.UNITS_PERCENTAGE

Specified by:

getWidthUnits in interface Component

setWidth

public void setWidth(java.lang.String width)

Description copied from interface: Component

Set component width in Component.getWidthUnits()

Specified by:

setWidth in interface Component

getOwnComponent

public Component getOwnComponent(java.lang.String id)

Description copied from interface: Component.Container

Get component directly owned by this container.

Specified by:

getOwnComponent in interface Component.Container

Returns:

component or null if not found

getComponent

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

Description copied from interface: Component.Container

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

Specified by:

getComponent in interface Component.Container

Returns:

component or null if not found

getAlignment

public Component.Alignment getAlignment()

Specified by:

getAlignment in interface Component

setAlignment

public void setAlignment(Component.Alignment alignment)

Specified by:

setAlignment in interface Component

expand

public void expand(Component component,
                   java.lang.String height,
                   java.lang.String width)

Specified by:

expand in interface ExpandingLayout

expand

public void expand(Component component)

Specified by:

expand in interface ExpandingLayout

resetExpanded

public void resetExpanded()

Specified by:

resetExpanded in interface ExpandingLayout

isExpanded

public boolean isExpanded(Component component)

Specified by:

isExpanded in interface ExpandingLayout

getExpandDirection

public ExpandingLayout.ExpandDirection getExpandDirection()

Specified by:

getExpandDirection in interface ExpandingLayout

getComponent

public com.vaadin.ui.Component getComponent()

Specified by:

getComponent in interface Component.Wrapper

getComposition

public com.vaadin.ui.Component getComposition()

Specified by:

getComposition in interface Component.Wrapper

closeAndRun

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

Description copied from interface: Window

INTERNAL. Don't call from application code.

Specified by:

closeAndRun in interface Window

close

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

Description copied from interface: Window

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

Specified by:

close in interface Window

Parameters:

actionId - action ID that will be propagated to attached Window.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

close

public boolean close(java.lang.String actionId)

Description copied from interface: Window

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

Specified by:

close in interface Window

Parameters:

actionId - action ID that will be propagated to attached Window.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.

findAndFocusChildComponent

public boolean findAndFocusChildComponent()

isModified

public boolean isModified()

saveSettings

public void saveSettings()

Description copied from interface: Window

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

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

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface Component.HasCaption

setCaption

public void setCaption(java.lang.String caption)

Specified by:

setCaption in interface Component.HasCaption

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Component.HasCaption

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Component.HasCaption

getFrame

public Frame getFrame()

Specified by:

getFrame in interface Component.BelongToFrame

setFrame

public void setFrame(Frame frame)

Specified by:

setFrame in interface Component.BelongToFrame

wrapBy

public Window wrapBy(java.lang.Class<?> wrapperClass)

Specified by:

wrapBy in interface WrappedWindow

getWrapper

public Window getWrapper()

Specified by:

getWrapper in interface WrappedWindow

dispose

public void dispose()

Specified by:

dispose in interface Component.Disposable

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface Component.Disposable

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

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

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

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

isDefaultScreenWindow

public boolean isDefaultScreenWindow()

setDefaultScreenWindow

public void setDefaultScreenWindow(boolean defaultScreenWindow)