com.whitestein.lsps.vaadin.ui.components

Class UIConditional

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

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, UIRefreshHandler, UIComponentListeningOnRefresh, UIComponentWithCustomVisibility, Serializable, Iterable<com.vaadin.ui.Component>

Direct Known Subclasses:

UIPopup

public class UIConditional
extends com.vaadin.ui.CssLayout
implements UIComponentWithCustomVisibility, UIRefreshHandler, UIComponentListeningOnRefresh

Standard Vaadin component for "ui::Conditional".

Must extend from VerticalLayout (or wrap its children in VerticalLayout), otherwise error messages may not be displayed correctly for the children.

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 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
UIConditional(UIComponentData componentData) Full constructor.

Method Summary

Modifier and Type	Method and Description
protected void	attachContent(UIComponent content) Attaches the content component to the component tree.
protected RecordHolder	getChildDefinition()
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
Set<UIComponent>	getRefreshedComponents()
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
void	initChildren(boolean isFirstLoad) Should initialize all visible child components.
boolean	isShown() Returns true if the LSPS UI component represented by this Vaadin component is visible.
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	registerChildren() Should register all child components in the screen.
String	toString()
void	unregisterChildren() Should unregister all child components in the screen.
protected void	updateContentVisibility() Updates the visibility of the content component.

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, attach, detach, 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, setId, 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, markAsDirty, 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.vaadin.ui.ComponentContainer

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

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

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

Constructor Detail

UIConditional

public UIConditional(UIComponentData componentData)

Full constructor.

Parameters:

componentData -

Method Detail

attachContent

protected void attachContent(UIComponent content)

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 refresh() method.

Parameters:

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

getChildDefinition

protected RecordHolder getChildDefinition()

initChildren

public void initChildren(boolean isFirstLoad)

Description copied from interface: UIRefreshHandler

Should initialize all visible child components. See UIComponents.initChildren(java.util.List, boolean).

Specified by:

initChildren in interface UIRefreshHandler

Parameters:

isFirstLoad - value of field UIFieldNames.IS_FIRST_LOAD of the created init event

registerChildren

public void registerChildren()

Description copied from interface: UIRefreshHandler

Should register all child components in the screen. See UIScreen.registerUIComponent(UIComponent).

Specified by:

registerChildren in interface UIRefreshHandler

unregisterChildren

public void unregisterChildren()

Description copied from interface: UIRefreshHandler

Should unregister all child components in the screen. See UIScreen.unregisterUIComponent(UIComponent).

Specified by:

unregisterChildren in interface UIRefreshHandler

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

updateContentVisibility

protected void updateContentVisibility()

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

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

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

Returns:

true if component is marked as visible

getRefreshedComponents

public Set<UIComponent> getRefreshedComponents()

Specified by:

getRefreshedComponents in interface UIRefreshHandler

Returns:

set of components refreshed during last refresh call

getComponentData

public UIComponentData getComponentData()

Description copied from interface: UIComponent

Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.

Specified by:

getComponentData in interface UIComponent

Returns:

component definition. The definition record instance must be present in root scope (screen context).

toString

public String toString()

Overrides:

toString in class Object

getWidget

public com.vaadin.ui.AbstractComponent getWidget()

Description copied from interface: UIComponent

Returns the Vaadin widget which implements the UI part of this component.

Specified by:

getWidget in interface UIComponent

Returns:

the widget, not null.