net.awesomecontrols.subwindow

Class SubWindow

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractSingleComponentContainer

com.vaadin.ui.Panel

net.awesomecontrols.subwindow.SubWindow

All Implemented Interfaces:

com.vaadin.event.Action.Container, com.vaadin.event.Action.Notifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Scrollable, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.LegacyComponent, com.vaadin.ui.SingleComponentContainer, Serializable, Iterable<com.vaadin.ui.Component>, EventListener

public class SubWindow
extends com.vaadin.ui.Panel
implements com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.FieldEvents.BlurNotifier

A component that represents a floating popup window that can be added to a WindowsDesktopArea. A subwindow is added to a WindowsDesktopArea using WindowsDesktopArea.addSubWindow(SubWindow).

The subwindow component is build on the window component and have all it behaviors. The contents of a subwindow is set using AbstractSingleComponentContainer.setContent(Component) or by using the SubWindow(String, Component) constructor.

A subwindow can be positioned on the screen using relative coordinates (pixels) or set to be centered using center()

The caption is displayed in the window header.

Author:

Marcelo D. RE.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubWindow.CloseEvent
static interface	SubWindow.CloseListener An interface used for listening to Window close events.
static class	SubWindow.CloseShortcut A ShortcutListener specifically made to define a keyboard shortcut that closes the subwindow.
static class	SubWindow.MinimizeEvent
static interface	SubWindow.MinimizeListener
static class	SubWindow.ResizeEvent Resize events are fired whenever the client-side fires a resize-event (e.g. the browser subwindow is resized).
static interface	SubWindow.ResizeListener Listener for subwindow resize events.
static class	SubWindow.WindowModeChangeEvent Event which is fired when the mode of the Window changes.
static interface	SubWindow.WindowModeChangeListener An interface used for listening to Window maximize / restore events.
static class	SubWindow.WindowOrderChangeEvent Event which is fired when the subwindow order position is changed.
static interface	SubWindow.WindowOrderChangeListener An interface used for listening to Window order change events.

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Field Summary

Fields inherited from class com.vaadin.ui.Panel

actionManager

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
SubWindow() Creates a new, empty subwindow.
SubWindow(String caption) Creates a new, empty subwindow with a given title.
SubWindow(String caption, com.vaadin.ui.Component content) Creates a new, empty subwindow with the given content and title.

Method Summary

Modifier and Type	Method and Description
com.vaadin.shared.Registration	addBlurListener(com.vaadin.event.FieldEvents.BlurListener listener)
com.vaadin.shared.Registration	addCloseListener(SubWindow.CloseListener listener) Adds a CloseListener to the subwindow.
void	addCloseShortcut(int keyCode, int... modifiers) Adds a close shortcut - pressing this key while holding down all (if any) modifiers specified while this Window is in focus will close the Window.
com.vaadin.shared.Registration	addFocusListener(com.vaadin.event.FieldEvents.FocusListener listener)
com.vaadin.shared.Registration	addMinimizeListener(SubWindow.MinimizeListener listener) Adds a MinimizeListener to the subwindow.
com.vaadin.shared.Registration	addResizeListener(SubWindow.ResizeListener listener) Add a resize listener.
com.vaadin.shared.Registration	addWindowModeChangeListener(SubWindow.WindowModeChangeListener listener) Adds a WindowModeChangeListener to the subwindow.
com.vaadin.shared.Registration	addWindowOrderChangeListener(SubWindow.WindowOrderChangeListener listener) Adds a WindowOrderChangeListener to the subwindow.
void	bringToFront() If there are currently several subwindows visible, calling this method makes this subwindow topmost.
void	center() Sets this subwindow to be centered relative to its parent subwindow.
void	changeVariables(Object source, Map<String,Object> variables)
void	close() Method that handles subwindow closing (from UI).
protected void	fireClose()
protected void	fireMinimize()
protected void	fireResize() Fire the resize event.
protected void	fireWindowOrderChange(Integer order)
protected void	fireWindowWindowModeChange()
void	focus() Cause the subwindow to be brought on top of other subwindows and gain keyboard focus.
com.vaadin.ui.Component[]	getAssistiveDescription() Gets the components that are used as assistive description.
String	getAssistivePostfix() Gets the accessibility postfix for the subwindow caption.
String	getAssistivePrefix() Gets the accessibility prefix for the subwindow caption.
com.vaadin.shared.ui.window.WindowRole	getAssistiveRole() Gets the WAI-ARIA role the subwindow.
Collection<SubWindow.CloseShortcut>	getCloseShortcuts() Returns an unmodifiable collection of SubWindow.CloseShortcut objects currently registered with this SubWindow.
protected Collection<String>	getCustomAttributes()
int	getOrderPosition() Returns the position of this subwindow in the order of all open subwindows for this UI.
int	getPositionX() Gets the distance of Window left border in pixels from left border of the containing (main subwindow) when the subwindow is in SubWindowMode.NORMAL.
int	getPositionY() Gets the distance of Window top border in pixels from top border of the containing (main subwindow) when the subwindow is in SubWindowMode.NORMAL state, or when next set to that state.
protected SubWindowState	getState()
protected SubWindowState	getState(boolean markAsDirty)
String	getTabStopBottomAssistiveText() Gets the message that is provided to users of assistive devices when the user reaches the bottom of the subwindow when leaving a subwindow with the tab key is prevented.
String	getTabStopTopAssistiveText() Gets the message that is provided to users of assistive devices when the user reaches the top of the subwindow when leaving a subwindow with the tab key is prevented.
SubWindowMode	getWindowMode() Gets the current mode of the subwindow.
boolean	hasCloseShortcut(int keyCode, int... modifiers) Checks if a close subwindow shortcut key has already been registered.
boolean	isClosable() Returns the closable status of the subwindow.
boolean	isDraggable() Indicates whether a subwindow can be dragged or not.
boolean	isModal()
boolean	isResizable()
boolean	isResizeLazy()
boolean	isTabStopEnabled() Get if it is prevented to leave a subwindow with the tab key.
void	paintContent(com.vaadin.server.PaintTarget target)
void	readDesign(org.jsoup.nodes.Element design, com.vaadin.ui.declarative.DesignContext context)
protected void	readDesignChildren(org.jsoup.select.Elements children, com.vaadin.ui.declarative.DesignContext context) Reads the content and possible assistive descriptions from the list of child elements of a design.
void	removeAllCloseShortcuts() Removes all close shortcuts.
void	removeCloseListener(SubWindow.CloseListener listener) Deprecated.
void	removeCloseShortcut() Deprecated. Use removeCloseShortcut(int, int...) instead.
void	removeCloseShortcut(int keyCode, int... modifiers) Removes a close shortcut previously added with addCloseShortcut(int, int...).
void	removeMinimizeListener(SubWindow.MinimizeListener listener) Deprecated.
void	removeResizeListener(SubWindow.ResizeListener listener) Deprecated.
void	removeWindowModeChangeListener(SubWindow.WindowModeChangeListener listener) Deprecated.
void	setAssistiveDescription(com.vaadin.ui.Component... components) Allows to specify which components contain the description for the subwindow.
void	setAssistivePostfix(String assistivePostfix) Sets the accessibility postfix for the subwindow caption.
void	setAssistivePrefix(String prefix) Sets the accessibility prefix for the subwindow caption.
void	setAssistiveRole(com.vaadin.shared.ui.window.WindowRole role) Sets the WAI-ARIA role the subwindow.
void	setClosable(boolean closable) Sets the closable status for the subwindow.
void	setCloseShortcut(int keyCode, int... modifiers) Deprecated. Use addCloseShortcut(int, int...) instead.
void	setDraggable(boolean draggable) Enables or disables that a subwindow can be dragged (moved) by the user.
void	setModal(boolean modal) Sets subwindow modality.
void	setParent(com.vaadin.ui.HasComponents parent)
void	setPosition(int x, int y) Sets the position of the subwindow on the screen using setPositionX(int) and setPositionY(int).
void	setPositionX(int positionX) Sets the distance of Window left border in pixels from left border of the containing (main subwindow).
void	setPositionY(int positionY) Sets the distance of Window top border in pixels from top border of the containing (main subwindow).
void	setResizable(boolean resizable) Sets subwindow resizable.
void	setResizeLazy(boolean resizeLazy) Should resize operations be lazy, i.e. should there be a delay before layout sizes are recalculated.
void	setTabStopBottomAssistiveText(String bottomMessage) Sets the message that is provided to users of assistive devices when the user reaches the bottom of the subwindow when leaving a subwindow with the tab key is prevented.
void	setTabStopEnabled(boolean tabStop) Set if it should be prevented to set the focus to a component outside a non-modal subwindow with the tab key.
void	setTabStopTopAssistiveText(String topMessage) Sets the message that is provided to users of assistive devices when the user reaches the top of the subwindow when leaving a subwindow with the tab key is prevented.
void	setWindowMode(SubWindowMode windowMode) Sets the mode for the subwindow.
void	writeDesign(org.jsoup.nodes.Element design, com.vaadin.ui.declarative.DesignContext context)

Methods inherited from class com.vaadin.ui.Panel

addAction, addActionHandler, addClickListener, getActionManager, getScrollLeft, getScrollTop, getTabIndex, removeAction, removeActionHandler, removeAllActionHandlers, removeClickListener, setCaption, setScrollLeft, setScrollTop, setTabIndex

Methods inherited from class com.vaadin.ui.AbstractSingleComponentContainer

addComponentAttachListener, addComponentDetachListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentCount, getContent, iterator, removeComponentAttachListener, removeComponentDetachListener, removeFromParent, setContent, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setLocale, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setEnabled, setIcon, setId, setPrimaryStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SubWindow

public SubWindow()

Creates a new, empty subwindow.

SubWindow

public SubWindow(String caption)

Creates a new, empty subwindow with a given title.

Parameters:

caption - the title of the subwindow.

SubWindow

public SubWindow(String caption,
                 com.vaadin.ui.Component content)

Creates a new, empty subwindow with the given content and title.

Parameters:

caption - the title of the subwindow.

content - the contents of the subwindow

Method Detail

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Overrides:

paintContent in class com.vaadin.ui.Panel

Throws:

com.vaadin.server.PaintException

setParent

public void setParent(com.vaadin.ui.HasComponents parent)

Specified by:

setParent in interface com.vaadin.ui.Component

Overrides:

setParent in class com.vaadin.ui.AbstractComponent

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Specified by:

changeVariables in interface com.vaadin.server.VariableOwner

Overrides:

changeVariables in class com.vaadin.ui.Panel

close

public void close()

Method that handles subwindow closing (from UI).

By default, subwindows are removed from their respective UIs and thus visually closed on browser-side.

To react to a subwindow being closed (after it is closed), register a SubWindow.CloseListener.

getPositionX

public int getPositionX()

Gets the distance of Window left border in pixels from left border of the containing (main subwindow) when the subwindow is in SubWindowMode.NORMAL.

Returns:

the Distance of Window left border in pixels from left border of the containing (main subwindow).or -1 if unspecified

Since:

4.0.0

setPosition

public void setPosition(int x,
                        int y)

Sets the position of the subwindow on the screen using setPositionX(int) and setPositionY(int).

Parameters:

x - The new x coordinate for the subwindow

y - The new y coordinate for the subwindow

Since:

7.5

setPositionX

public void setPositionX(int positionX)

Sets the distance of Window left border in pixels from left border of the containing (main subwindow). Has effect only if in SubWindowMode.NORMAL mode.

Parameters:

positionX - the Distance of Window left border in pixels from left border of the containing (main subwindow). or -1 if unspecified.

Since:

4.0.0

getPositionY

public int getPositionY()

Gets the distance of Window top border in pixels from top border of the containing (main subwindow) when the subwindow is in SubWindowMode.NORMAL state, or when next set to that state.

Returns:

Distance of Window top border in pixels from top border of the containing (main subwindow). or -1 if unspecified

Since:

4.0.0

getOrderPosition

public int getOrderPosition()

Returns the position of this subwindow in the order of all open subwindows for this UI.

Window with position 0 is on the bottom, and subwindow with greatest position is at the top. If subwindow has no position (it's not yet attached or hidden) then position is -1.

Returns:

subwindow order position.

Since:

8.0

See Also:

UI.addWindowOrderUpdateListener(com.vaadin.ui.UI.WindowOrderUpdateListener)

setPositionY

public void setPositionY(int positionY)

Sets the distance of Window top border in pixels from top border of the containing (main subwindow). Has effect only if in SubWindowMode.NORMAL mode.

Parameters:

positionY - the Distance of Window top border in pixels from top border of the containing (main subwindow). or -1 if unspecified

Since:

4.0.0

addWindowOrderChangeListener

public com.vaadin.shared.Registration addWindowOrderChangeListener(SubWindow.WindowOrderChangeListener listener)

Adds a WindowOrderChangeListener to the subwindow.

The WindowOrderChangeEvent is fired when the order position is changed. It can happen when some subwindow (this or other) is brought to front or detached.

The other way to listen positions of all subwindows in UI is UI.addWindowOrderUpdateListener(com.vaadin.ui.UI.WindowOrderUpdateListener)

Parameters:

listener - the WindowModeChangeListener to add.

Returns:

registration

Since:

8.0

See Also:

UI.addWindowOrderUpdateListener(com.vaadin.ui.UI.WindowOrderUpdateListener)

fireWindowOrderChange

protected void fireWindowOrderChange(Integer order)

Parameters:

order - order

addCloseListener

public com.vaadin.shared.Registration addCloseListener(SubWindow.CloseListener listener)

Adds a CloseListener to the subwindow. For a subwindow the CloseListener is fired when the user closes it (clicks on the close button). For a browser level subwindow the CloseListener is fired when the browser level subwindow is closed. Note that closing a browser level subwindow does not mean it will be destroyed. Also note that Opera does not send events like all other browsers and therefore the close listener might not be called if Opera is used.

Since Vaadin 6.5, removing subwindows using #removeWindow(SubWindow) does fire the CloseListener.

Parameters:

listener - the CloseListener to add, not null

Returns:

Registration

Since:

8.0

removeCloseListener

@Deprecated
public void removeCloseListener(SubWindow.CloseListener listener)

Deprecated.

Removes the CloseListener from the subwindow.

For more information on CloseListeners see SubWindow.CloseListener.

Parameters:

listener - the CloseListener to remove.

fireClose

protected void fireClose()

addMinimizeListener

public com.vaadin.shared.Registration addMinimizeListener(SubWindow.MinimizeListener listener)

Adds a MinimizeListener to the subwindow. For a subwindow the CloseListener is fired when the user closes it (clicks on the close button). For a browser level subwindow the CloseListener is fired when the browser level subwindow is closed. Note that closing a browser level subwindow does not mean it will be destroyed. Also note that Opera does not send events like all other browsers and therefore the close listener might not be called if Opera is used.

Since Vaadin 6.5, removing subwindows using #removeWindow(SubWindow) does fire the CloseListener.

Parameters:

listener - the CloseListener to add, not null

Returns:

Registration

Since:

8.0

removeMinimizeListener

@Deprecated
public void removeMinimizeListener(SubWindow.MinimizeListener listener)

Deprecated.

Removes the MinimizeListener from the subwindow.

For more information on MinimizeListeners see SubWindow.MinimizeListener.

Parameters:

listener - the MinimizeListener to remove.

fireMinimize

protected void fireMinimize()

addWindowModeChangeListener

public com.vaadin.shared.Registration addWindowModeChangeListener(SubWindow.WindowModeChangeListener listener)

Adds a WindowModeChangeListener to the subwindow. The WindowModeChangeEvent is fired when the user changed the display state by clicking the maximize/restore button or by double clicking on the subwindow header. The event is also fired if the state is changed using #setWindowMode(WindowMode).

Parameters:

listener - the WindowModeChangeListener to add.

Returns:

Registration

Since:

8.0

removeWindowModeChangeListener

@Deprecated
public void removeWindowModeChangeListener(SubWindow.WindowModeChangeListener listener)

Deprecated.

Removes the WindowModeChangeListener from the subwindow.

Parameters:

listener - the WindowModeChangeListener to remove.

fireWindowWindowModeChange

protected void fireWindowWindowModeChange()

addResizeListener

public com.vaadin.shared.Registration addResizeListener(SubWindow.ResizeListener listener)

Add a resize listener.

Parameters:

listener - the listener to add, not null

Returns:

a registration object for removing the listener

Since:

8.0

See Also:

Registration

removeResizeListener

@Deprecated
public void removeResizeListener(SubWindow.ResizeListener listener)

Deprecated.

Remove a resize listener.

Parameters:

listener - listener

fireResize

protected void fireResize()

Fire the resize event.

bringToFront

public void bringToFront()

If there are currently several subwindows visible, calling this method makes this subwindow topmost. This method can only be called if this subwindow connected a UI. Else an illegal state exception is thrown. Also if there are modal subwindows and this subwindow is not modal, and illegal state exception is thrown.

setModal

public void setModal(boolean modal)

Sets subwindow modality. When a modal subwindow is open, components outside that subwindow cannot be accessed.

Keyboard navigation is restricted by blocking the tab key at the top and bottom of the subwindow by activating the tab stop function internally.

Parameters:

modal - true if modality is to be turned on

isModal

public boolean isModal()

Returns:

true if this subwindow is modal.

setResizable

public void setResizable(boolean resizable)

Sets subwindow resizable.

Parameters:

resizable - true if resizability is to be turned on

isResizable

public boolean isResizable()

Returns:

true if subwindow is resizable by the end-user, otherwise false.

isResizeLazy

public boolean isResizeLazy()

Returns:

true if a delay is used before recalculating sizes, false if sizes are recalculated immediately.

setResizeLazy

public void setResizeLazy(boolean resizeLazy)

Should resize operations be lazy, i.e. should there be a delay before layout sizes are recalculated. Speeds up resize operations in slow UIs with the penalty of slightly decreased usability. Note, some browser send false resize events for the browser subwindow and are therefore always lazy.

Parameters:

resizeLazy - true to use a delay before recalculating sizes, false to calculate immediately.

center

public void center()

Sets this subwindow to be centered relative to its parent subwindow. Affects subwindows only. If the subwindow is resized as a result of the size of its content changing, it will keep itself centered as long as its position is not explicitly changed programmatically or by the user.

NOTE: This method has several issues as currently implemented. Please refer to http://dev.vaadin.com/ticket/8971 for details.

isClosable

public boolean isClosable()

Returns the closable status of the subwindow. If a subwindow is closable, it typically shows an X in the upper right corner. Clicking on the X sends a close event to the server. Setting closable to false will remove the X from the subwindow and prevent the user from closing the subwindow.

Returns:

true if the subwindow can be closed by the user.

setClosable

public void setClosable(boolean closable)

Sets the closable status for the subwindow. If a subwindow is closable it typically shows an X in the upper right corner. Clicking on the X sends a close event to the server. Setting closable to false will remove the X from the subwindow and prevent the user from closing the subwindow.

Parameters:

closable - determines if the subwindow can be closed by the user.

isDraggable

public boolean isDraggable()

Indicates whether a subwindow can be dragged or not. By default a subwindow is draggable.

Returns:

true if subwindow is draggable; false if not

setDraggable

public void setDraggable(boolean draggable)

Enables or disables that a subwindow can be dragged (moved) by the user. By default a subwindow is draggable.

Parameters:

draggable - true if the subwindow can be dragged by the user

getWindowMode

public SubWindowMode getWindowMode()

Gets the current mode of the subwindow.

Returns:

the mode of the subwindow.

See Also:

SubWindowMode

setWindowMode

public void setWindowMode(SubWindowMode windowMode)

Sets the mode for the subwindow.

Parameters:

windowMode - windowMode

See Also:

SubWindowMode

setCloseShortcut

@Deprecated
public void setCloseShortcut(int keyCode,
                                         int... modifiers)

Deprecated. Use addCloseShortcut(int, int...) instead.

This is the old way of adding a keyboard shortcut to close a SubWindow - to preserve compatibility with existing code under the new functionality, this method now first removes all registered close shortcuts, then adds the default ESCAPE shortcut key, and then attempts to add the shortcut provided as parameters to this method. This method, and its companion removeCloseShortcut(), are now considered deprecated, as their main function is to preserve exact backwards compatibility with old code. For all new code, use the new keyboard shortcuts API: addCloseShortcut(int,int...), removeCloseShortcut(int,int...), removeAllCloseShortcuts(), hasCloseShortcut(int,int...) and getCloseShortcuts().

Original description: Makes it possible to close the subwindow by pressing the given ShortcutAction.KeyCode and (optional) ShortcutAction.ModifierKeys. Note that this shortcut only reacts while the subwindow has focus, closing itself - if you want to close a subwindow from a UI, use UI.addAction(com.vaadin.event.Action) of the UI instead.

Parameters:

keyCode - the keycode for invoking the shortcut

modifiers - the (optional) modifiers for invoking the shortcut. Can be set to null to be explicit about not having modifiers.

removeCloseShortcut

@Deprecated
public void removeCloseShortcut()

Deprecated. Use removeCloseShortcut(int, int...) instead.

Removes all keyboard shortcuts previously set with setCloseShortcut(int, int...) and addCloseShortcut(int, int...), then adds the default ShortcutAction.KeyCode.ESCAPE shortcut.

This is the old way of removing the (single) keyboard close shortcut, and is retained only for exact backwards compatibility. For all new code, use the new keyboard shortcuts API: addCloseShortcut(int,int...), removeCloseShortcut(int,int...), removeAllCloseShortcuts(), hasCloseShortcut(int,int...) and getCloseShortcuts().

addCloseShortcut

public void addCloseShortcut(int keyCode,
                             int... modifiers)

Adds a close shortcut - pressing this key while holding down all (if any) modifiers specified while this Window is in focus will close the Window.

Parameters:

keyCode - the keycode for invoking the shortcut

modifiers - the (optional) modifiers for invoking the shortcut. Can be set to null to be explicit about not having modifiers.

Since:

7.6

removeCloseShortcut

public void removeCloseShortcut(int keyCode,
                                int... modifiers)

Removes a close shortcut previously added with addCloseShortcut(int, int...).

Parameters:

keyCode - the keycode for invoking the shortcut

modifiers - the (optional) modifiers for invoking the shortcut. Can be set to null to be explicit about not having modifiers.

Since:

7.6

removeAllCloseShortcuts

public void removeAllCloseShortcuts()

Removes all close shortcuts. This includes the default ESCAPE shortcut. It is up to the user to add back any and all keyboard close shortcuts they may require. For more fine-grained control over shortcuts, use removeCloseShortcut(int, int...).

Since:

7.6

hasCloseShortcut

public boolean hasCloseShortcut(int keyCode,
                                int... modifiers)

Checks if a close subwindow shortcut key has already been registered.

Parameters:

keyCode - the keycode for invoking the shortcut

modifiers - the (optional) modifiers for invoking the shortcut. Can be set to null to be explicit about not having modifiers.

Returns:

true, if an exactly matching shortcut has been registered.

Since:

7.6

getCloseShortcuts

public Collection<SubWindow.CloseShortcut> getCloseShortcuts()

Returns an unmodifiable collection of SubWindow.CloseShortcut objects currently registered with this SubWindow. This method is provided mainly so that users can implement their own serialization routines. To check if a certain combination of keys has been registered as a close shortcut, use the hasCloseShortcut(int, int...) method instead.

Returns:

an unmodifiable Collection of CloseShortcut objects.

Since:

7.6

addFocusListener

public com.vaadin.shared.Registration addFocusListener(com.vaadin.event.FieldEvents.FocusListener listener)

Specified by:

addFocusListener in interface com.vaadin.event.FieldEvents.FocusNotifier

addBlurListener

public com.vaadin.shared.Registration addBlurListener(com.vaadin.event.FieldEvents.BlurListener listener)

Specified by:

addBlurListener in interface com.vaadin.event.FieldEvents.BlurNotifier

focus

public void focus()

Cause the subwindow to be brought on top of other subwindows and gain keyboard focus.

Specified by:

focus in interface com.vaadin.ui.Component.Focusable

Overrides:

focus in class com.vaadin.ui.Panel

getState

protected SubWindowState getState()

Overrides:

getState in class com.vaadin.ui.Panel

getState

protected SubWindowState getState(boolean markAsDirty)

Overrides:

getState in class com.vaadin.ui.Panel

setAssistiveDescription

public void setAssistiveDescription(com.vaadin.ui.Component... components)

Allows to specify which components contain the description for the subwindow. Text contained in these components will be read by assistive devices when it is opened.

Parameters:

components - the components to use as description

getAssistiveDescription

public com.vaadin.ui.Component[] getAssistiveDescription()

Gets the components that are used as assistive description. Text contained in these components will be read by assistive devices when the subwindow is opened.

Returns:

array of previously set components

setAssistivePrefix

public void setAssistivePrefix(String prefix)

Sets the accessibility prefix for the subwindow caption. This prefix is read to assistive device users before the subwindow caption, but not visible on the page.

Parameters:

prefix - String that is placed before the subwindow caption

getAssistivePrefix

public String getAssistivePrefix()

Gets the accessibility prefix for the subwindow caption. This prefix is read to assistive device users before the subwindow caption, but not visible on the page.

Returns:

The accessibility prefix

setAssistivePostfix

public void setAssistivePostfix(String assistivePostfix)

Sets the accessibility postfix for the subwindow caption. This postfix is read to assistive device users after the subwindow caption, but not visible on the page.

Parameters:

assistivePostfix - String that is placed after the subwindow caption

getAssistivePostfix

public String getAssistivePostfix()

Gets the accessibility postfix for the subwindow caption. This postfix is read to assistive device users after the subwindow caption, but not visible on the page.

Returns:

The accessibility postfix

setAssistiveRole

public void setAssistiveRole(com.vaadin.shared.ui.window.WindowRole role)

Sets the WAI-ARIA role the subwindow. This role defines how an assistive device handles a subwindow. Available roles are alertdialog and dialog (@see Roles Model). The default role is dialog.

Parameters:

role - WAI-ARIA role to set for the subwindow

getAssistiveRole

public com.vaadin.shared.ui.window.WindowRole getAssistiveRole()

Gets the WAI-ARIA role the subwindow. This role defines how an assistive device handles a subwindow. Available roles are alertdialog and dialog (@see Roles Model).

Returns:

WAI-ARIA role set for the subwindow

setTabStopEnabled

public void setTabStopEnabled(boolean tabStop)

Set if it should be prevented to set the focus to a component outside a non-modal subwindow with the tab key.

This is meant to help users of assistive devices to not leaving the subwindow unintentionally.

For modal subwindows, this function is activated automatically, while preserving the stored value of tabStop.

Parameters:

tabStop - true to keep the focus inside the subwindow when reaching the top or bottom, false (default) to allow leaving the subwindow

isTabStopEnabled

public boolean isTabStopEnabled()

Get if it is prevented to leave a subwindow with the tab key.

Returns:

true when the focus is limited to inside the subwindow, false when focus can leave the subwindow

setTabStopTopAssistiveText

public void setTabStopTopAssistiveText(String topMessage)

Sets the message that is provided to users of assistive devices when the user reaches the top of the subwindow when leaving a subwindow with the tab key is prevented.

This message is not visible on the screen.

Parameters:

topMessage - String provided when the user navigates with Shift-Tab keys to the top of the subwindow

setTabStopBottomAssistiveText

public void setTabStopBottomAssistiveText(String bottomMessage)

Sets the message that is provided to users of assistive devices when the user reaches the bottom of the subwindow when leaving a subwindow with the tab key is prevented.

This message is not visible on the screen.

Parameters:

bottomMessage - String provided when the user navigates with the Tab key to the bottom of the subwindow

getTabStopTopAssistiveText

public String getTabStopTopAssistiveText()

Gets the message that is provided to users of assistive devices when the user reaches the top of the subwindow when leaving a subwindow with the tab key is prevented.

Returns:

the top message

getTabStopBottomAssistiveText

public String getTabStopBottomAssistiveText()

Gets the message that is provided to users of assistive devices when the user reaches the bottom of the subwindow when leaving a subwindow with the tab key is prevented.

Returns:

the bottom message

readDesign

public void readDesign(org.jsoup.nodes.Element design,
                       com.vaadin.ui.declarative.DesignContext context)

Specified by:

readDesign in interface com.vaadin.ui.Component

Overrides:

readDesign in class com.vaadin.ui.Panel

readDesignChildren

protected void readDesignChildren(org.jsoup.select.Elements children,
                                  com.vaadin.ui.declarative.DesignContext context)

Reads the content and possible assistive descriptions from the list of child elements of a design. If an element has an :assistive-description attribute, adds the parsed component to the list of components used as the assistive description of this Window. Otherwise, sets the component as the content of this Window. If there are multiple non-description elements, throws a DesignException.

Overrides:

readDesignChildren in class com.vaadin.ui.AbstractSingleComponentContainer

Parameters:

children - child elements in a design

context - the DesignContext instance used to parse the design

Throws:

com.vaadin.ui.declarative.DesignException - if there are multiple non-description child elements

com.vaadin.ui.declarative.DesignException - if a child element could not be parsed as a Component

See Also:

AbstractSingleComponentContainer.setContent(Component), setAssistiveDescription(Component...)

writeDesign

public void writeDesign(org.jsoup.nodes.Element design,
                        com.vaadin.ui.declarative.DesignContext context)

Specified by:

writeDesign in interface com.vaadin.ui.Component

Overrides:

writeDesign in class com.vaadin.ui.Panel

getCustomAttributes

protected Collection<String> getCustomAttributes()

Overrides:

getCustomAttributes in class com.vaadin.ui.Panel