com.vaadin.ui
Class UI

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractSingleComponentContainer
              com.vaadin.ui.UI

All Implemented Interfaces:

Action.Container, Action.Notifier, ConnectorEventListener, MethodEventSource, UIEvents.PollNotifier, ClientConnector, Sizeable, VariableOwner, com.vaadin.shared.Connector, Component, Component.Focusable, HasComponents, HasComponents.ComponentAttachDetachNotifier, LegacyComponent, SingleComponentContainer, java.io.Serializable, java.lang.Iterable<Component>, java.util.EventListener

Direct Known Subclasses:

LegacyWindow

public abstract class UI
extends AbstractSingleComponentContainer
implements Action.Container, Action.Notifier, UIEvents.PollNotifier, LegacyComponent, Component.Focusable

The topmost component in any component hierarchy. There is one UI for every Vaadin instance in a browser window. A UI may either represent an entire browser window (or tab) or some part of a html page where a Vaadin application is embedded.

The UI is the server side entry point for various client side features that are not represented as components added to a layout, e.g notifications, sub windows, and executing javascript in the browser.

When a new UI instance is needed, typically because the user opens a URL in a browser window which points to e.g. VaadinServlet, all UIProviders registered to the current VaadinSession are queried for the UI class that should be used. The selection is by default based on the UI init parameter from web.xml.

After a UI has been created by the application, it is initialized using init(VaadinRequest). This method is intended to be overridden by the developer to add components to the user interface and initialize non-component functionality. The component hierarchy must be initialized by passing a Component with the main layout or other content of the view to setContent(Component) or to the constructor of the UI.

Since:

7.0

See Also:

init(VaadinRequest), UIProvider, Serialized Form

Nested Class Summary

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

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

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

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

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

Sizeable.Unit

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

HasComponents.ComponentAttachDetachNotifier, HasComponents.ComponentAttachEvent, HasComponents.ComponentAttachListener, HasComponents.ComponentDetachEvent, HasComponents.ComponentDetachListener

Field Summary

protected ActionManager

actionManager Keeps track of the Actions added to this component, and manages the painting and handling as well.

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

UI()
Creates a new empty UI without a caption.

UI(Component content)
Creates a new UI with the given component (often a layout) as its content.

Method Summary

java.util.concurrent.Future<java.lang.Void>	access(java.lang.Runnable runnable) Provides exclusive access to this UI from outside a request handling thread.
void	accessSynchronously(java.lang.Runnable runnable) Locks the session of this UI and runs the provided Runnable right away.
<T extends Action & Action.Listener> void	addAction(T action)
void	addActionHandler(Action.Handler actionHandler) Registers a new action handler for this container
void	addClickListener(MouseEvents.ClickListener listener) Add a click listener to the UI.
void	addListener(MouseEvents.ClickListener listener) Deprecated. As of 7.0, replaced by #addClickListener(ClickListener)
void	addPollListener(UIEvents.PollListener listener) Add a poll listener.
void	addWindow(Window window) Adds a window as a subwindow inside this UI.
void	attach() Called after the UI is added to the session.
void	changeVariables(java.lang.Object source, java.util.Map<java.lang.String,java.lang.Object> variables) Called when one or more variables handled by the implementing class are changed.
void	close() Marks this UI to be detached from the session at the end of the current request, or the next request if there is no current request (if called from a background thread, for instance.)
void	detach() Called before the UI is removed from the session.
void	doInit(VaadinRequest request, int uiId, java.lang.String embedId) Internal initialization method, should not be overridden.
void	doRefresh(VaadinRequest request) Internal reinitialization method, should not be overridden.
void	focus() Sets the focus for this component if the component is Focusable.
protected ActionManager	getActionManager() Gets the ActionManager used to manage the ShortcutListeners added to this Field.
int	getComponentCount() Gets the number of children this SingleComponentContainer has.
ConnectorTracker	getConnectorTracker()
static UI	getCurrent() Gets the currently used UI.
java.lang.String	getEmbedId() Gets a string the uniquely distinguishes this UI instance based on where it is embedded.
long	getLastHeartbeatTimestamp() Returns the timestamp of the last received heartbeat for this UI.
LoadingIndicatorConfiguration	getLoadingIndicatorConfiguration() Retrieves the object used for configuring the loading indicator.
LocaleService	getLocaleService() Returns the locale service which handles transmission of Locale data to the client.
Navigator	getNavigator() Returns the navigator attached to this UI or null if there is no navigator.
NotificationConfiguration	getNotificationConfiguration() Retrieves the object used for configuring notifications.
java.lang.String	getOverlayContainerLabel() Get the label that is added to the container element, where tooltip, notification and dialogs are added to.
Page	getPage()
int	getPollInterval() Returns the interval with which the UI polls the server.
PushConfiguration	getPushConfiguration() Retrieves the object used for configuring the push channel.
PushConnection	getPushConnection() Returns the internal push connection object used by this UI.
int	getScrollLeft()
int	getScrollTop()
VaadinSession	getSession() Gets the application object to which the component is attached.
protected com.vaadin.shared.ui.ui.UIState	getState() Returns the shared state bean with information to be sent from the server to the client.
protected com.vaadin.shared.ui.ui.UIState	getState(boolean markAsDirty) Returns the shared state for this connector.
java.lang.Class<? extends com.vaadin.shared.ui.ui.UIState>	getStateType() Returns the type of the shared state for this connector
int	getTabIndex() Gets the tabulator index of the Focusable component.
java.lang.String	getTheme() Gets the theme that was used when the UI was initialized.
TooltipConfiguration	getTooltipConfiguration() Retrieves the object used for configuring tooltips.
UI	getUI() Overridden to return a value instead of referring to the parent.
int	getUIId() Gets the id of the UI, used to identify this UI within its application when processing requests.
java.util.Collection<Window>	getWindows() Gets all the windows added to this UI.
protected abstract void	init(VaadinRequest request) Initializes this UI.
boolean	isClosing() Returns whether this UI is marked as closed and is to be detached.
boolean	isConnectorEnabled() Checks if the communicator is enabled.
boolean	isResizeLazy() Checks whether lazy resize is enabled.
java.util.Iterator<Component>	iterator() Gets an iterator to the collection of contained components.
void	paintContent(PaintTarget target) Paints the Paintable into a UIDL stream.
void	push() Pushes the pending changes and client RPC invocations of this UI to the client-side.
protected void	refresh(VaadinRequest request) Reinitializes this UI after a browser refresh if the UI is set to be preserved on refresh, typically using the PreserveOnRefresh annotation.
<T extends Action & Action.Listener> void	removeAction(T action)
void	removeActionHandler(Action.Handler actionHandler) Removes a previously registered action handler for the contents of this container.
void	removeClickListener(MouseEvents.ClickListener listener) Remove a click listener from the UI.
void	removeListener(MouseEvents.ClickListener listener) Deprecated. As of 7.0, replaced by #removeClickListener(ClickListener)
void	removePollListener(UIEvents.PollListener listener) Remove a poll listener.
boolean	removeWindow(Window window) Remove the given subwindow from this UI.
void	scrollIntoView(Component component) Scrolls any component between the component and UI to a suitable position so the component is visible to the user.
void	setCaption(java.lang.String caption) Deprecated. As of 7.0, use Page.setTitle(String)
void	setContent(Component content) Sets the content of this container.
static void	setCurrent(UI ui) Sets the thread local for the current UI.
void	setFocusedComponent(Component.Focusable focusable) This method is used by Component.Focusable objects to request focus to themselves.
void	setLastHeartbeatTimestamp(long lastHeartbeat) Sets the last heartbeat request timestamp for this UI.
void	setNavigator(Navigator navigator) For internal use only.
void	setOverlayContainerLabel(java.lang.String overlayContainerLabel) Sets the label that is added to the container element, where tooltip, notifications and dialogs are added to.
void	setPollInterval(int intervalInMillis) Sets the interval with which the UI should poll the server to see if there are any changes.
void	setPushConnection(PushConnection pushConnection) Sets the internal push connection object used by this UI.
void	setResizeLazy(boolean resizeLazy) Should resize operations be lazy, i.e.
void	setScrollLeft(int scrollLeft) Set left offset to which the UI should scroll to.
void	setScrollTop(int scrollTop) Set top offset to which the UI should scroll to.
void	setSession(VaadinSession session) Sets the session to which this UI is assigned.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.
void	showNotification(Notification notification) Deprecated. As of 7.0, use Notification.show instead
void	showNotification(java.lang.String caption) Deprecated. As of 7.0, use Notification.show instead but be aware that Notification.show does not allow HTML.
void	showNotification(java.lang.String caption, Notification.Type type) Deprecated. As of 7.0, use Notification.show instead but be aware that Notification.show does not allow HTML.
void	showNotification(java.lang.String caption, java.lang.String description) Deprecated. As of 7.0, use new Notification(...).show(Page) instead but be aware that HTML by default not allowed.
void	showNotification(java.lang.String caption, java.lang.String description, Notification.Type type) Deprecated. As of 7.0, use new Notification(...).show(Page) instead but be aware that HTML by default not allowed.
void	showNotification(java.lang.String caption, java.lang.String description, Notification.Type type, boolean htmlContentAllowed) Deprecated. As of 7.0, use new Notification(...).show(Page).

Methods inherited from class com.vaadin.ui.AbstractSingleComponentContainer

addComponentAttachListener, addComponentDetachListener, fireComponentAttachEvent, fireComponentDetachEvent, getContent, removeComponentAttachListener, removeComponentDetachListener, removeFromParent, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isVisible, removeListener, removeShortcutListener, removeStyleName, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth

Methods inherited from class com.vaadin.server.AbstractClientConnector

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, encodeState, getErrorHandler, getExtensions, getRpcManager, handleConnectorRequest, isAttached, 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, setSizeFull, setSizeUndefined, setWidth, setWidth

Field Detail

actionManager

protected ActionManager actionManager

Keeps track of the Actions added to this component, and manages the painting and handling as well.

Constructor Detail

UI

public UI()

Creates a new empty UI without a caption. The content of the UI must be set by calling setContent(Component) before using the UI.

UI

public UI(Component content)

Creates a new UI with the given component (often a layout) as its content.

Parameters:

content - the component to use as this UIs content.

See Also:

setContent(Component)

Method Detail

getState

protected com.vaadin.shared.ui.ui.UIState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Overrides:

getState in class AbstractComponent

Returns:

updated component shared state

getState

protected com.vaadin.shared.ui.ui.UIState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractComponent

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

getStateType

public java.lang.Class<? extends com.vaadin.shared.ui.ui.UIState> getStateType()

Description copied from interface: ClientConnector

Returns the type of the shared state for this connector

Specified by:

getStateType in interface ClientConnector

Overrides:

getStateType in class AbstractClientConnector

Returns:

The type of the state. Must never return null.

getUI

public UI getUI()

Overridden to return a value instead of referring to the parent.

Specified by:

getUI in interface ClientConnector

Specified by:

getUI in interface Component

Overrides:

getUI in class AbstractClientConnector

Returns:

this UI

See Also:

AbstractClientConnector.getUI()

getSession

public VaadinSession getSession()

Gets the application object to which the component is attached.

The method will return null if the component is not currently attached to an application.

Getting a null value is often a problem in constructors of regular components and in the initializers of custom composite components. A standard workaround is to use VaadinSession.getCurrent() to retrieve the application instance that the current request relates to. Another way is to move the problematic initialization to attach(), as described in the documentation of the method.

Overrides:

getSession in class AbstractClientConnector

Returns:

the parent application of the component or null.

See Also:

attach()

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Description copied from interface: LegacyComponent

Paints the Paintable into a UIDL stream. This method creates the UIDL sequence describing it and outputs it to the given UIDL stream.

It is called when the contents of the component should be painted in response to the component first being shown or having been altered so that its visual representation is changed.

Specified by:

paintContent in interface LegacyComponent

Parameters:

target - the target UIDL stream where the component should paint itself to.

Throws:

PaintException - if the paint operation failed.

changeVariables

public void changeVariables(java.lang.Object source,
                            java.util.Map<java.lang.String,java.lang.Object> variables)

Description copied from interface: VariableOwner

Called when one or more variables handled by the implementing class are changed.

Specified by:

changeVariables in interface VariableOwner

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - the Mapping from variable names to new variable values.

iterator

public java.util.Iterator<Component> iterator()

Description copied from interface: HasComponents

Gets an iterator to the collection of contained components. Using this iterator it is possible to step through all components contained in this container.

Specified by:

iterator in interface HasComponents

Specified by:

iterator in interface java.lang.Iterable<Component>

Overrides:

iterator in class AbstractSingleComponentContainer

Returns:

the component iterator.

getComponentCount

public int getComponentCount()

Description copied from interface: SingleComponentContainer

Gets the number of children this SingleComponentContainer has. This must be symmetric with what HasComponents.iterator() returns and thus typically return 1 if the content is set, 0 otherwise.

Specified by:

getComponentCount in interface SingleComponentContainer

Overrides:

getComponentCount in class AbstractSingleComponentContainer

Returns:

The number of child components this container has.

setSession

public void setSession(VaadinSession session)

Sets the session to which this UI is assigned.

This method is for internal use by the framework. To explicitly close a UI, see close().

Parameters:

session - the session to set

Throws:

java.lang.IllegalStateException - if the session has already been set

See Also:

getSession()

getUIId

public int getUIId()

Gets the id of the UI, used to identify this UI within its application when processing requests. The UI id should be present in every request to the server that originates from this UI. VaadinService.findUI(VaadinRequest) uses this id to find the route to which the request belongs.

This method is not intended to be overridden. If it is overridden, care should be taken since this method might be called in situations where getCurrent() does not return this UI.

Returns:

the id of this UI

addWindow

public void addWindow(Window window)
               throws java.lang.IllegalArgumentException,
                      java.lang.NullPointerException

Adds a window as a subwindow inside this UI. To open a new browser window or tab, you should instead use a UIProvider.

Parameters:

window -

Throws:

java.lang.IllegalArgumentException - if the window is already added to an application

java.lang.NullPointerException - if the given Window is null.

removeWindow

public boolean removeWindow(Window window)

Remove the given subwindow from this UI. Since Vaadin 6.5, Window.CloseListeners are called also when explicitly removing a window by calling this method. Since Vaadin 6.5, returns a boolean indicating if the window was removed or not.

Parameters:

window - Window to be removed.

Returns:

true if the subwindow was removed, false otherwise

getWindows

public java.util.Collection<Window> getWindows()

Gets all the windows added to this UI.

Returns:

an unmodifiable collection of windows

focus

public void focus()

Description copied from class: AbstractComponent

Sets the focus for this component if the component is Focusable.

Specified by:

focus in interface Component.Focusable

Overrides:

focus in class AbstractComponent

See Also:

FieldEvents, FieldEvents.FocusEvent, FieldEvents.FocusListener, FieldEvents.BlurEvent, FieldEvents.BlurListener

setFocusedComponent

public void setFocusedComponent(Component.Focusable focusable)

This method is used by Component.Focusable objects to request focus to themselves. Focus renders must be handled at window level (instead of Component.Focusable) due we want the last focused component to be focused in client too. Not the one that is rendered last (the case we'd get if implemented in Focusable only). To focus component from Vaadin application, use Focusable.focus(). See Component.Focusable.

Parameters:

focusable - to be focused on next paint

scrollIntoView

public void scrollIntoView(Component component)
                    throws java.lang.IllegalArgumentException

Scrolls any component between the component and UI to a suitable position so the component is visible to the user. The given component must belong to this UI.

Parameters:

component - the component to be scrolled into view

Throws:

java.lang.IllegalArgumentException - if component does not belong to this UI

doInit

public void doInit(VaadinRequest request,
                   int uiId,
                   java.lang.String embedId)

Internal initialization method, should not be overridden. This method is not declared as final because that would break compatibility with e.g. CDI.

Parameters:

request - the initialization request

uiId - the id of the new ui

embedId - the embed id of this UI, or null if no id is known

See Also:

getUIId(), getEmbedId()

init

protected abstract void init(VaadinRequest request)

Initializes this UI. This method is intended to be overridden by subclasses to build the view and configure non-component functionality. Performing the initialization in a constructor is not suggested as the state of the UI is not properly set up when the constructor is invoked.

The VaadinRequest can be used to get information about the request that caused this UI to be created.

Parameters:

request - the Vaadin request that caused this UI to be created

doRefresh

public void doRefresh(VaadinRequest request)

Internal reinitialization method, should not be overridden.

Parameters:

request - the request that caused this UI to be reloaded

Since:

7.2

refresh

protected void refresh(VaadinRequest request)

Reinitializes this UI after a browser refresh if the UI is set to be preserved on refresh, typically using the PreserveOnRefresh annotation. This method is intended to be overridden by subclasses if needed; the default implementation is empty.

The VaadinRequest can be used to get information about the request that caused this UI to be reloaded.

Parameters:

request - the request that caused this UI to be reloaded

Since:

7.2

setCurrent

public static void setCurrent(UI ui)

Sets the thread local for the current UI. This method is used by the framework to set the current application whenever a new request is processed and it is cleared when the request has been processed.

The application developer can also use this method to define the current UI outside the normal request handling, e.g. when initiating custom background threads.

Parameters:

uI - the UI to register as the current UI

See Also:

getCurrent(), ThreadLocal

getCurrent

public static UI getCurrent()

Gets the currently used UI. The current UI is automatically defined when processing requests to the server. In other cases, (e.g. from background threads), the current UI is not automatically defined.

Returns:

the current UI instance if available, otherwise null

See Also:

setCurrent(UI)

setScrollTop

public void setScrollTop(int scrollTop)

Set top offset to which the UI should scroll to.

Parameters:

scrollTop -

getScrollTop

public int getScrollTop()

setScrollLeft

public void setScrollLeft(int scrollLeft)

Set left offset to which the UI should scroll to.

Parameters:

scrollLeft -

getScrollLeft

public int getScrollLeft()

getActionManager

protected ActionManager getActionManager()

Description copied from class: AbstractComponent

Gets the ActionManager used to manage the ShortcutListeners added to this Field.

Overrides:

getActionManager in class AbstractComponent

Returns:

the ActionManager in use

addAction

public <T extends Action & Action.Listener> void addAction(T action)

Specified by:

addAction in interface Action.Notifier

removeAction

public <T extends Action & Action.Listener> void removeAction(T action)

Specified by:

removeAction in interface Action.Notifier

addActionHandler

public void addActionHandler(Action.Handler actionHandler)

Description copied from interface: Action.Container

Registers a new action handler for this container

Specified by:

addActionHandler in interface Action.Container

Parameters:

actionHandler - the new handler to be added.

removeActionHandler

public void removeActionHandler(Action.Handler actionHandler)

Description copied from interface: Action.Container

Removes a previously registered action handler for the contents of this container.

Specified by:

removeActionHandler in interface Action.Container

Parameters:

actionHandler - the handler to be removed.

setResizeLazy

public void setResizeLazy(boolean resizeLazy)

Should resize operations be lazy, i.e. should there be a delay before layout sizes are recalculated and resize events are sent to the server. Speeds up resize operations in slow UIs with the penalty of slightly decreased usability.

Default value: false

When there are active window resize listeners, lazy resize mode should be used to avoid a large number of events during resize.

Parameters:

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

isResizeLazy

public boolean isResizeLazy()

Checks whether lazy resize is enabled.

Returns:

true if lazy resize is enabled, false if lazy resize is not enabled

addClickListener

public void addClickListener(MouseEvents.ClickListener listener)

Add a click listener to the UI. The listener is called whenever the user clicks inside the UI. Also when the click targets a component inside the UI, provided the targeted component does not prevent the click event from propagating. Use #removeListener(ClickListener) to remove the listener.

Parameters:

listener - The listener to add

addListener

@Deprecated
public void addListener(MouseEvents.ClickListener listener)

Deprecated. As of 7.0, replaced by #addClickListener(ClickListener)

removeClickListener

public void removeClickListener(MouseEvents.ClickListener listener)

Remove a click listener from the UI. The listener should earlier have been added using #addListener(ClickListener).

Parameters:

listener - The listener to remove

removeListener

@Deprecated
public void removeListener(MouseEvents.ClickListener listener)

Deprecated. As of 7.0, replaced by #removeClickListener(ClickListener)

isConnectorEnabled

public boolean isConnectorEnabled()

Description copied from interface: ClientConnector

Checks if the communicator is enabled. An enabled communicator is allowed to receive messages from its counter-part.

Specified by:

isConnectorEnabled in interface ClientConnector

Overrides:

isConnectorEnabled in class AbstractComponent

Returns:

true if the connector can receive messages, false otherwise

getConnectorTracker

public ConnectorTracker getConnectorTracker()

getPage

public Page getPage()

getNavigator

public Navigator getNavigator()

Returns the navigator attached to this UI or null if there is no navigator.

Returns:

setNavigator

public void setNavigator(Navigator navigator)

For internal use only.

Parameters:

navigator -

setCaption

@Deprecated
public void setCaption(java.lang.String caption)

Deprecated. As of 7.0, use Page.setTitle(String)

Setting the caption of a UI is not supported. To set the title of the HTML page, use Page.setTitle

Specified by:

setCaption in interface Component

Overrides:

setCaption in class AbstractComponent

Parameters:

caption - the new caption String for the component.

showNotification

@Deprecated
public void showNotification(java.lang.String caption)

Deprecated. As of 7.0, use Notification.show instead but be aware that Notification.show does not allow HTML.

Shows a notification message on the middle of the UI. The message automatically disappears ("humanized message"). Care should be taken to to avoid XSS vulnerabilities as the caption is rendered as html.

Parameters:

caption - The message

See Also:

showNotification(Notification), Notification

showNotification

@Deprecated
public void showNotification(java.lang.String caption,
                                        Notification.Type type)

Deprecated. As of 7.0, use Notification.show instead but be aware that Notification.show does not allow HTML.

Shows a notification message the UI. The position and behavior of the message depends on the type, which is one of the basic types defined in Notification, for instance Notification.TYPE_WARNING_MESSAGE. Care should be taken to to avoid XSS vulnerabilities as the caption is rendered as html.

Parameters:

caption - The message

type - The message type

See Also:

showNotification(Notification), Notification

showNotification

@Deprecated
public void showNotification(java.lang.String caption,
                                        java.lang.String description)

Deprecated. As of 7.0, use new Notification(...).show(Page) instead but be aware that HTML by default not allowed.

Shows a notification consisting of a bigger caption and a smaller description on the middle of the UI. The message automatically disappears ("humanized message"). Care should be taken to to avoid XSS vulnerabilities as the caption and description are rendered as html.

Parameters:

caption - The caption of the message

description - The message description

See Also:

showNotification(Notification), Notification

showNotification

@Deprecated
public void showNotification(java.lang.String caption,
                                        java.lang.String description,
                                        Notification.Type type)

Deprecated. As of 7.0, use new Notification(...).show(Page) instead but be aware that HTML by default not allowed.

Shows a notification consisting of a bigger caption and a smaller description. The position and behavior of the message depends on the type, which is one of the basic types defined in Notification , for instance Notification.TYPE_WARNING_MESSAGE. Care should be taken to to avoid XSS vulnerabilities as the caption and description are rendered as html.

Parameters:

caption - The caption of the message

description - The message description

type - The message type

See Also:

showNotification(Notification), Notification

showNotification

@Deprecated
public void showNotification(java.lang.String caption,
                                        java.lang.String description,
                                        Notification.Type type,
                                        boolean htmlContentAllowed)

Deprecated. As of 7.0, use new Notification(...).show(Page).

Shows a notification consisting of a bigger caption and a smaller description. The position and behavior of the message depends on the type, which is one of the basic types defined in Notification , for instance Notification.TYPE_WARNING_MESSAGE. Care should be taken to avoid XSS vulnerabilities if html content is allowed.

Parameters:

caption - The message caption

description - The message description

type - The type of message

htmlContentAllowed - Whether html in the caption and description should be displayed as html or as plain text

See Also:

showNotification(Notification), Notification

showNotification

@Deprecated
public void showNotification(Notification notification)

Deprecated. As of 7.0, use Notification.show instead

Shows a notification message.

Parameters:

notification - The notification message to show

See Also:

Notification, showNotification(String), #showNotification(String, int), showNotification(String, String), #showNotification(String, String, int)

getLastHeartbeatTimestamp

public long getLastHeartbeatTimestamp()

Returns the timestamp of the last received heartbeat for this UI.

This method is not intended to be overridden. If it is overridden, care should be taken since this method might be called in situations where getCurrent() does not return this UI.

Returns:

The time the last heartbeat request occurred, in milliseconds since the epoch.

See Also:

VaadinService.closeInactiveUIs(VaadinSession)

setLastHeartbeatTimestamp

public void setLastHeartbeatTimestamp(long lastHeartbeat)

Sets the last heartbeat request timestamp for this UI. Called by the framework whenever the application receives a valid heartbeat request for this UI.

This method is not intended to be overridden. If it is overridden, care should be taken since this method might be called in situations where getCurrent() does not return this UI.

Parameters:

lastHeartbeat - The time the last heartbeat request occurred, in milliseconds since the epoch.

getTheme

public java.lang.String getTheme()

Gets the theme that was used when the UI was initialized.

Returns:

the theme name

close

public void close()

Marks this UI to be detached from the session at the end of the current request, or the next request if there is no current request (if called from a background thread, for instance.)

The UI is detached after the response is sent, so in the current request it can still update the client side normally. However, after the response any new requests from the client side to this UI will cause an error, so usually the client should be asked, for instance, to reload the page (serving a fresh UI instance), to close the page, or to navigate somewhere else.

Note that this method is strictly for users to explicitly signal the framework that the UI should be detached. Overriding it is not a reliable way to catch UIs that are to be detached. Instead, UI.detach() should be overridden or a DetachListener used.

isClosing

public boolean isClosing()

Returns whether this UI is marked as closed and is to be detached.

This method is not intended to be overridden. If it is overridden, care should be taken since this method might be called in situations where getCurrent() does not return this UI.

Returns:

whether this UI is closing.

See Also:

close()

attach

public void attach()

Called after the UI is added to the session. A UI instance is attached exactly once, before its init method is called.

Specified by:

attach in interface ClientConnector

Specified by:

attach in interface Component

Overrides:

attach in class AbstractComponent

See Also:

Component.attach()

detach

public void detach()

Called before the UI is removed from the session. A UI instance is detached exactly once, either:

• after it is explicitly closed.
• when its session is closed or expires
• after three missed heartbeat requests.

Note that when a UI is detached, any changes made in the detach methods of any children or DetachListeners that would be communicated to the client are silently ignored.

Specified by:

detach in interface ClientConnector

Overrides:

detach in class AbstractComponent

setContent

public void setContent(Component content)

Description copied from class: AbstractSingleComponentContainer

Sets the content of this container. The content is a component that serves as the outermost item of the visual contents. The content must always be set, either with a constructor parameter or by calling this method. Previous versions of Vaadin used a VerticalLayout with margins enabled as the default content but that is no longer the case.

Specified by:

setContent in interface SingleComponentContainer

Overrides:

setContent in class AbstractSingleComponentContainer

Parameters:

content - a component (typically a layout) to use as content

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

 Form loginBox = new Form();
 loginBox.setCaption("Login");
 layout.addComponent(loginBox);
 
 // Create the first field which will be focused
 TextField username = new TextField("User name");
 loginBox.addField("username", username);
 
 // Set focus to the user name
 username.focus();
 
 TextField password = new TextField("Password");
 loginBox.addField("password", password);
 
 Button login = new Button("Login");
 loginBox.getFooter().addComponent(login);
 
 // An additional component which natural focus order would
 // be after the button.
 CheckBox remember = new CheckBox("Remember me");
 loginBox.getFooter().addComponent(remember);
 
 username.setTabIndex(1);
 password.setTabIndex(2);
 remember.setTabIndex(3); // Different than natural place
 login.setTabIndex(4);
 

After all focusable user interface components are done, the browser can begin again from the component with the smallest tab index, or it can take the focus out of the page, for example, to the location bar.

If the tab index is not set (is set to zero), the default tab order is used. The order is somewhat browser-dependent, but generally follows the HTML structure of the page.

A negative value means that the component is completely removed from the tabulation order and can not be reached by pressing the Tab key at all.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - the tab order of this component. Indexes usually start from 1. Zero means that default tab order should be used. A negative value means that the field should not be included in the tabbing sequence.

See Also:

Component.Focusable.getTabIndex()

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the Focusable component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the Focusable component

See Also:

Component.Focusable.setTabIndex(int)

accessSynchronously

public void accessSynchronously(java.lang.Runnable runnable)
                         throws UIDetachedException

Locks the session of this UI and runs the provided Runnable right away.

It is generally recommended to use access(Runnable) instead of this method for accessing a session from a different thread as access(Runnable) can be used while holding the lock of another session. To avoid causing deadlocks, this methods throws an exception if it is detected than another session is also locked by the current thread.

This method behaves differently than access(Runnable) in some situations:

• If the current thread is currently holding the lock of the session, accessSynchronously(Runnable) runs the task right away whereas access(Runnable) defers the task to a later point in time.
• If some other thread is currently holding the lock for the session, accessSynchronously(Runnable) blocks while waiting for the lock to be available whereas access(Runnable) defers the task to a later point in time.

Parameters:

runnable - the runnable which accesses the UI

Throws:

UIDetachedException - if the UI is not attached to a session (and locking can therefore not be done)

java.lang.IllegalStateException - if the current thread holds the lock for another session

Since:

7.1

See Also:

access(Runnable), VaadinSession.accessSynchronously(Runnable)

access

public java.util.concurrent.Future<java.lang.Void> access(java.lang.Runnable runnable)

Provides exclusive access to this UI from outside a request handling thread.

The given runnable is executed while holding the session lock to ensure exclusive access to this UI. If the session is not locked, the lock will be acquired and the runnable is run right away. If the session is currently locked, the runnable will be run before that lock is released.

RPC handlers for components inside this UI do not need to use this method as the session is automatically locked by the framework during RPC handling.

Please note that the runnable might be invoked on a different thread or later on the current thread, which means that custom thread locals might not have the expected values when the runnable is executed. Inheritable values in CurrentInstance will have the same values as when this method was invoked. getCurrent(), VaadinSession.getCurrent() and VaadinService.getCurrent() are set according to this UI before executing the runnable. Non-inheritable CurrentInstance values including VaadinService.getCurrentRequest() and VaadinService.getCurrentResponse() will not be defined.

The returned future can be used to check for task completion and to cancel the task.

Parameters:

runnable - the runnable which accesses the UI

Returns:

a future that can be used to check for task completion and to cancel the task

Throws:

UIDetachedException - if the UI is not attached to a session (and locking can therefore not be done)

Since:

7.1

See Also:

getCurrent(), accessSynchronously(Runnable), VaadinSession.access(Runnable), VaadinSession.lock()

getTooltipConfiguration

public TooltipConfiguration getTooltipConfiguration()

Retrieves the object used for configuring tooltips.

Returns:

The instance used for tooltip configuration

getNotificationConfiguration

public NotificationConfiguration getNotificationConfiguration()

Retrieves the object used for configuring notifications.

Returns:

The instance used for notification configuration

getLoadingIndicatorConfiguration

public LoadingIndicatorConfiguration getLoadingIndicatorConfiguration()

Retrieves the object used for configuring the loading indicator.

Returns:

The instance used for configuring the loading indicator

push

public void push()

Pushes the pending changes and client RPC invocations of this UI to the client-side.

If push is enabled, but the push connection is not currently open, the push will be done when the connection is established.

As with all UI methods, the session must be locked when calling this method. It is also recommended that getCurrent() is set up to return this UI since writing the response may invoke logic in any attached component or extension. The recommended way of fulfilling these conditions is to use access(Runnable).

Throws:

java.lang.IllegalStateException - if push is disabled.

UIDetachedException - if this UI is not attached to a session.

Since:

7.1

See Also:

getPushConfiguration()

getPushConnection

public PushConnection getPushConnection()

Returns the internal push connection object used by this UI. This method should only be called by the framework.

This method is not intended to be overridden. If it is overridden, care should be taken since this method might be called in situations where getCurrent() does not return this UI.

Returns:

the push connection used by this UI, or null if push is not available.

setPushConnection

public void setPushConnection(PushConnection pushConnection)

Sets the internal push connection object used by this UI. This method should only be called by the framework.

The pushConnection argument must be non-null if and only if getPushConfiguration().getPushMode().isEnabled().

Parameters:

pushConnection - the push connection to use for this UI

setPollInterval

public void setPollInterval(int intervalInMillis)

Sets the interval with which the UI should poll the server to see if there are any changes. Polling is disabled by default.

Note that it is possible to enable push and polling at the same time but it should not be done to avoid excessive server traffic.

Add-on developers should note that this method is only meant for the application developer. An add-on should not set the poll interval directly, rather instruct the user to set it.

Parameters:

intervalInMillis - The interval (in ms) with which the UI should poll the server or -1 to disable polling

getPollInterval

public int getPollInterval()

Returns the interval with which the UI polls the server.

Returns:

The interval (in ms) with which the UI polls the server or -1 if polling is disabled

addPollListener

public void addPollListener(UIEvents.PollListener listener)

Description copied from interface: UIEvents.PollNotifier

Add a poll listener.

The listener is called whenever the client polls the server for asynchronous UI updates.

Specified by:

addPollListener in interface UIEvents.PollNotifier

Parameters:

listener - the UIEvents.PollListener to add

See Also:

setPollInterval(int), #removePollListener(PollListener)

removePollListener

public void removePollListener(UIEvents.PollListener listener)

Description copied from interface: UIEvents.PollNotifier

Remove a poll listener.

Specified by:

removePollListener in interface UIEvents.PollNotifier

Parameters:

listener - the listener to be removed

See Also:

#addPollListener(PollListener)

getPushConfiguration

public PushConfiguration getPushConfiguration()

Retrieves the object used for configuring the push channel.

Returns:

The instance used for push configuration

Since:

7.1

getOverlayContainerLabel

public java.lang.String getOverlayContainerLabel()

Get the label that is added to the container element, where tooltip, notification and dialogs are added to.

Returns:

the label of the container

setOverlayContainerLabel

public void setOverlayContainerLabel(java.lang.String overlayContainerLabel)

Sets the label that is added to the container element, where tooltip, notifications and dialogs are added to.

This is helpful for users of assistive devices, as this element is reachable for them.

Parameters:

overlayContainerLabel - label to use for the container

getLocaleService

public LocaleService getLocaleService()

Returns the locale service which handles transmission of Locale data to the client.

Returns:

The LocaleService for this UI

Since:

7.1

getEmbedId

public java.lang.String getEmbedId()

Gets a string the uniquely distinguishes this UI instance based on where it is embedded. The embed identifier is based on the window.name DOM attribute of the browser window where the UI is displayed and the id of the div element where the UI is embedded.

Returns:

the embed id for this UI, or null if no id known

Since:

7.2