com.whitestein.lsps.vaadin.ui.components

Class UIPopup

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.CssLayout

com.whitestein.lsps.vaadin.ui.components.UIConditional

com.whitestein.lsps.vaadin.ui.components.UIPopup

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, UIComponent, UIComponentWithWrappers, UIRefreshHandler, UIComponentListeningOnRefresh, UIComponentWithCustomVisibility, UIComponentWithHints2, Serializable, Iterable<com.vaadin.ui.Component>

public class UIPopup
extends UIConditional
implements UIComponentWithHints2, UIComponentListeningOnRefresh, UIComponentWithWrappers

Standard Vaadin component for "ui::Popup".

Author:

mbj

See Also:

Serialized Form

Nested Class Summary

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

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

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

Modifier and Type	Field and Description
boolean	forceVisible INTERNAL API, do not use.
protected com.vaadin.ui.Window	uiWindow Window instance associated with this popup

Fields inherited from class com.vaadin.ui.CssLayout

components

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
UIPopup(UIComponentData componentData)

Method Summary

Modifier and Type	Method and Description
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
void	attach()
protected void	attachContent(UIComponent content) Attaches the content component to the component tree.
protected com.vaadin.ui.Window	createWindow()
void	detach()
com.vaadin.ui.Window	getWindow() Gets the popup window.
com.vaadin.ui.Component	getWrapper() Returns the wrapper component.
protected boolean	isModal()
boolean	isShown() Returns true if the LSPS UI component represented by this Vaadin component is visible.
void	markAsDirty()
void	onChildRefresh(UIComponent child) Invoked when a child UI component is refreshed, or when this method is called on child.
void	refresh() This method is called from LSPS rendering engine.
void	removeWindow() Used by dynamic popups when they are being destroyed.
void	setId(String id)
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.
protected void	updateContentVisibility() Updates the visibility of the content component.

Methods inherited from class com.whitestein.lsps.vaadin.ui.components.UIConditional

getChildDefinition, getComponentData, getRefreshedComponents, getWidget, initChildren, registerChildren, toString, unregisterChildren

Methods inherited from class com.vaadin.ui.CssLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, addListener, beforeClientResponse, getComponent, getComponentCount, getComponentIndex, getCss, getState, iterator, readDesign, removeComponent, removeLayoutClickListener, removeListener, replaceComponent, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

readMargin, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, removeListener, removeListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getState, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, 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, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whitestein.lsps.vaadin.ui.components.UIComponent

getComponentData, getWidget

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, addListener, addListener, getComponentIterator, moveComponentsFrom, removeAllComponents, removeListener, removeListener

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, 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

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

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Field Detail

uiWindow

protected final com.vaadin.ui.Window uiWindow

Window instance associated with this popup

forceVisible

public boolean forceVisible

INTERNAL API, do not use. Used by dynamic popups.

Constructor Detail

UIPopup

public UIPopup(UIComponentData componentData)

Parameters:

componentData -

Method Detail

setId

public void setId(String id)

Specified by:

setId in interface com.vaadin.ui.Component

Overrides:

setId in class com.vaadin.ui.AbstractComponent

createWindow

protected com.vaadin.ui.Window createWindow()

attachContent

protected void attachContent(UIComponent content)

Description copied from class: UIConditional

Attaches the content component to the component tree. This method is called when the conditional contents was created and is made visible for the very first time, from the UIConditional.refresh() method.

Overrides:

attachContent in class UIConditional

Parameters:

content - the content. May be null if the conditional has no child modeled.

attach

public void attach()

Specified by:

attach in interface com.vaadin.server.ClientConnector

Specified by:

attach in interface com.vaadin.ui.Component

Overrides:

attach in class com.vaadin.ui.AbstractComponent

removeWindow

public void removeWindow()

Used by dynamic popups when they are being destroyed.

detach

public void detach()

Specified by:

detach in interface com.vaadin.server.ClientConnector

Overrides:

detach in class com.vaadin.ui.AbstractComponent

refresh

public void refresh()

Description copied from interface: UIComponent

This method is called from LSPS rendering engine. It should load all information needed from component definition record holder and apply them accordingly.

Note that this method should not attempt to apply any hints - hints are applied automatically after the component is refreshed. You however may read the hints value here - it is guaranteed that you will receive freshly updated hint value by reading UIComponentData.getHints().

Specified by:

refresh in interface UIComponent

Overrides:

refresh in class UIConditional

markAsDirty

public void markAsDirty()

Specified by:

markAsDirty in interface com.vaadin.server.ClientConnector

Overrides:

markAsDirty in class com.vaadin.server.AbstractClientConnector

updateContentVisibility

protected void updateContentVisibility()

Description copied from class: UIConditional

Updates the visibility of the content component. This method is called from UIConditional.refresh().

Overrides:

updateContentVisibility in class UIConditional

isModal

protected boolean isModal()

applyHint

public boolean applyHint(String hintName,
                         Variant<Object> newValue,
                         Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

Applies the given hint to this component.

Specified by:

applyHint in interface UIComponentWithHints2

Parameters:

hintName - the hint name, not null.

newValue - variant containing the new hint value, never null, may contain null value.

oldValue - variant containing the previous hint value, never null, may contain null value if the hint was missing or the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

unapplyHint

public boolean unapplyHint(String hintName,
                           Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

The hint has been removed from the hint map. Unapply from the component and revert the value to the default one.

Specified by:

unapplyHint in interface UIComponentWithHints2

Parameters:

hintName - the the hint name, not null.

oldValue - variant containing the previous hint value, never null, may contain null value if the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

onChildRefresh

public void onChildRefresh(UIComponent child)

Description copied from interface: UIComponentListeningOnRefresh

Invoked when a child UI component is refreshed, or when this method is called on child.

Specified by:

onChildRefresh in interface UIComponentListeningOnRefresh

Overrides:

onChildRefresh in class UIConditional

isShown

public boolean isShown()

Description copied from interface: UIComponentWithCustomVisibility

Returns true if the LSPS UI component represented by this Vaadin component is visible. Used by UIComponents.isShown(UIComponent).

Specified by:

isShown in interface UIComponentWithCustomVisibility

Overrides:

isShown in class UIConditional

Returns:

true if component is marked as visible

getWrapper

public com.vaadin.ui.Component getWrapper()

Description copied from interface: UIComponentWithWrappers

Returns the wrapper component. This component receives WIDTH and HEIGHT from this component hints.

Specified by:

getWrapper in interface UIComponentWithWrappers

Returns:

the wrapper component. If null, the popup is not visible, does not show any content and WIDTH/HEIGHT checks should be ignored.

getWindow

public com.vaadin.ui.Window getWindow()

Gets the popup window.

Returns:

the window