com.vaadin.fluent.api

Interface FluentWindow<THIS extends FluentWindow<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.event.Action.Container, com.vaadin.event.Action.Notifier, com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, FluentAbstractComponent<THIS>, FluentAbstractSingleComponentContainer<THIS>, FluentAction.FluentContainer<THIS>, FluentAction.FluentNotifier<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponent.FluentFocusable<THIS>, FluentContextClickNotifier<THIS>, FluentFieldEvents.FluentBlurNotifier<THIS>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentHasComponents<THIS>, FluentHasComponents.FluentComponentAttachDetachNotifier<THIS>, FluentPanel<THIS>, FluentScrollable<THIS>, FluentSingleComponentContainer<THIS>, FluentSizeable<THIS>, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, Iterable<com.vaadin.ui.Component>, com.vaadin.server.Scrollable, Serializable, com.vaadin.ui.SingleComponentContainer, com.vaadin.server.Sizeable

All Known Implementing Classes:

FWindow

public interface FluentWindow<THIS extends FluentWindow<THIS>>
extends FluentPanel<THIS>, FluentFieldEvents.FluentFocusNotifier<THIS>, FluentFieldEvents.FluentBlurNotifier<THIS>

The base interface for fluent versions of Window

See Also:

Window

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentHasComponents

FluentHasComponents.FluentComponentAttachDetachNotifier<THIS extends FluentHasComponents<THIS>>

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

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

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

Field Summary

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

Method Summary

Modifier and Type	Method and Description
default THIS	withAssistiveDescription(com.vaadin.ui.Component... components) Allows to specify which components contain the description for the window.
default THIS	withAssistivePostfix(String assistivePostfix) Sets the accessibility postfix for the window caption.
default THIS	withAssistivePrefix(String prefix) Sets the accessibility prefix for the window caption.
default THIS	withAssistiveRole(com.vaadin.shared.ui.window.WindowRole role) Sets the WAI-ARIA role the window.
default THIS	withClosable(boolean closable) Sets the closable status for the window.
default THIS	withCloseListener(com.vaadin.ui.Window.CloseListener listener) Adds a CloseListener to the window.
default THIS	withCloseShortcut(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.
default THIS	withDraggable(boolean draggable) Enables or disables that a window can be dragged (moved) by the user.
default THIS	withModal(boolean modal) Sets window modality.
default THIS	withPosition(int x, int y) Sets the position of the window on the screen using withPositionX(int) and withPositionY(int)
default THIS	withPositionX(int positionX) Sets the distance of Window left border in pixels from left border of the containing (main window).
default THIS	withPositionY(int positionY) Sets the distance of Window top border in pixels from top border of the containing (main window).
default THIS	withResizable(boolean resizable) Sets window resizable.
default THIS	withResizeLazy(boolean resizeLazy) Should resize operations be lazy, i.e. should there be a delay before layout sizes are recalculated.
default THIS	withResizeListener(com.vaadin.ui.Window.ResizeListener listener) Add a resize listener.
default THIS	withTabStopBottomAssistiveText(String bottomMessage) Sets the message that is provided to users of assistive devices when the user reaches the bottom of the window when leaving a window with the tab key is prevented.
default THIS	withTabStopEnabled(boolean tabStop) Set if it should be prevented to set the focus to a component outside a non-modal window with the tab key.
default THIS	withTabStopTopAssistiveText(String topMessage) Sets the message that is provided to users of assistive devices when the user reaches the top of the window when leaving a window with the tab key is prevented.
default THIS	withWindowMode(com.vaadin.shared.ui.window.WindowMode windowMode) Sets the mode for the window.
default THIS	withWindowModeChangeListener(com.vaadin.ui.Window.WindowModeChangeListener listener) Adds a WindowModeChangeListener to the window.
default THIS	withWindowOrderChangeListener(com.vaadin.ui.Window.WindowOrderChangeListener listener) Adds a WindowOrderChangeListener to the window.

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.fluent.api.FluentSingleComponentContainer

withContent

Methods inherited from interface com.vaadin.ui.SingleComponentContainer

getComponentCount, getContent, setContent

Methods inherited from interface com.vaadin.ui.HasComponents

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

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

Methods inherited from interface com.vaadin.fluent.api.FluentHasComponents.FluentComponentAttachDetachNotifier

withComponentAttachListener, withComponentDetachListener

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentScrollable

withScrollLeft, withScrollTop

Methods inherited from interface com.vaadin.server.Scrollable

getScrollLeft, getScrollTop, setScrollLeft, setScrollTop

Methods inherited from interface com.vaadin.fluent.api.FluentComponent.FluentFocusable

withTabIndex

Methods inherited from interface com.vaadin.ui.Component.Focusable

focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.fluent.api.FluentAction.FluentNotifier

withAction

Methods inherited from interface com.vaadin.event.Action.Notifier

addAction, removeAction

Methods inherited from interface com.vaadin.fluent.api.FluentAction.FluentContainer

withActionHandler

Methods inherited from interface com.vaadin.event.Action.Container

addActionHandler, removeActionHandler

Methods inherited from interface com.vaadin.fluent.api.FluentFieldEvents.FluentFocusNotifier

withFocusListener

Methods inherited from interface com.vaadin.event.FieldEvents.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.fluent.api.FluentFieldEvents.FluentBlurNotifier

withBlurListener

Methods inherited from interface com.vaadin.event.FieldEvents.BlurNotifier

addBlurListener

Method Detail

withCloseShortcut

default THIS withCloseShortcut(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.

Returns:

this for method chaining

See Also:

Window.addCloseShortcut(int, int...)

withCloseListener

default THIS withCloseListener(com.vaadin.ui.Window.CloseListener listener)

Adds a CloseListener to the window. For a window the CloseListener is fired when the user closes it (clicks on the close button). For a browser level window the CloseListener is fired when the browser level window is closed. Note that closing a browser level window 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 windows using UI.removeWindow(Window) does fire the CloseListener.

Parameters:

listener - the CloseListener to add, not null

Returns:

this for method chaining

See Also:

Window.addCloseListener(CloseListener)

withResizeListener

default THIS withResizeListener(com.vaadin.ui.Window.ResizeListener listener)

Add a resize listener.

Parameters:

listener - the listener to add, not null

Returns:

this for method chaining

See Also:

Window.addResizeListener(ResizeListener)

withWindowModeChangeListener

default THIS withWindowModeChangeListener(com.vaadin.ui.Window.WindowModeChangeListener listener)

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

Parameters:

listener - the WindowModeChangeListener to add.

Returns:

this for method chaining

See Also:

Window.addWindowModeChangeListener(WindowModeChangeListener)

withWindowOrderChangeListener

default THIS withWindowOrderChangeListener(com.vaadin.ui.Window.WindowOrderChangeListener listener)

Adds a WindowOrderChangeListener to the window.

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

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

Parameters:

listener - the WindowModeChangeListener to add.

Returns:

this for method chaining

See Also:

UI.addWindowOrderUpdateListener(com.vaadin.ui.UI.WindowOrderUpdateListener), Window.addWindowOrderChangeListener(WindowOrderChangeListener)

withAssistiveDescription

default THIS withAssistiveDescription(com.vaadin.ui.Component... components)

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

Parameters:

components - the components to use as description

Returns:

this for method chaining

See Also:

Window.setAssistiveDescription(Component...)

withAssistivePostfix

default THIS withAssistivePostfix(String assistivePostfix)

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

Parameters:

assistivePostfix - String that is placed after the window caption

Returns:

this for method chaining

See Also:

Window.setAssistivePostfix(String)

withAssistivePrefix

default THIS withAssistivePrefix(String prefix)

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

Parameters:

prefix - String that is placed before the window caption

Returns:

this for method chaining

See Also:

Window.setAssistivePrefix(String)

withAssistiveRole

default THIS withAssistiveRole(com.vaadin.shared.ui.window.WindowRole role)

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

Parameters:

role - WAI-ARIA role to set for the window

Returns:

this for method chaining

See Also:

Window.setAssistiveRole(WindowRole)

withClosable

default THIS withClosable(boolean closable)

Sets the closable status for the window. If a window 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 window and prevent the user from closing the window.

Parameters:

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

Returns:

this for method chaining

See Also:

Window.setClosable(boolean)

withDraggable

default THIS withDraggable(boolean draggable)

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

Parameters:

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

Returns:

this for method chaining

See Also:

Window.setDraggable(boolean)

withModal

default THIS withModal(boolean modal)

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

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

Parameters:

modal - true if modality is to be turned on

Returns:

this for method chaining

See Also:

Window.setDraggable(boolean)

withPosition

default THIS withPosition(int x,
                          int y)

Sets the position of the window on the screen using withPositionX(int) and withPositionY(int)

Parameters:

x - The new x coordinate for the window

y - The new y coordinate for the window

Returns:

this for method chaining

See Also:

Window.setPosition(int, int)

withPositionX

default THIS withPositionX(int positionX)

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

Parameters:

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

Returns:

this for method chaining

See Also:

Window.setPositionX(int)

withPositionY

default THIS withPositionY(int positionY)

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

Parameters:

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

Returns:

this for method chaining

See Also:

Window.setPositionY(int)

withResizable

default THIS withResizable(boolean resizable)

Sets window resizable.

Parameters:

resizable - true if resizability is to be turned on

Returns:

this for method chaining

See Also:

Window.setResizable(boolean)

withResizeLazy

default THIS withResizeLazy(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 window and are therefore always lazy.

Parameters:

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

Returns:

this for method chaining

See Also:

Window.setResizeLazy(boolean)

withTabStopBottomAssistiveText

default THIS withTabStopBottomAssistiveText(String bottomMessage)

Sets the message that is provided to users of assistive devices when the user reaches the bottom of the window when leaving a window 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 window

Returns:

this for method chaining

See Also:

Window.setTabStopBottomAssistiveText(String)

withTabStopEnabled

default THIS withTabStopEnabled(boolean tabStop)

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

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

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

Parameters:

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

Returns:

this for method chaining

See Also:

Window.setTabStopEnabled(boolean)

withTabStopTopAssistiveText

default THIS withTabStopTopAssistiveText(String topMessage)

Sets the message that is provided to users of assistive devices when the user reaches the top of the window when leaving a window 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 window

Returns:

this for method chaining

See Also:

Window.setTabStopTopAssistiveText(String)

withWindowMode

default THIS withWindowMode(com.vaadin.shared.ui.window.WindowMode windowMode)

Sets the mode for the window.

Parameters:

windowMode - The new mode

Returns:

this for method chaining

See Also:

WindowMode, Window.setWindowMode(WindowMode)