com.whitestein.lsps.vaadin.ui

Class UIComponentScope

java.lang.Object

com.whitestein.lsps.vaadin.ui.UIComponentScope

All Implemented Interfaces:

Serializable

public class UIComponentScope
extends Object
implements Serializable

Object representing a custom scope. Simple forms have one single root scope, however UIComponentWithCustomScopes subclasses define custom scopes (e.g. UIRepeater creates a separate scope for each row).

Generally, scope maps component definition record to one or many Java Vaadin component instances.

UIScreen references a root scope, which may have multiple child scopes. Root scope sees all UI components, child scopes may see only a subset of UI components.

Author:

mhi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UIComponentScope(UIComponentWithCustomScopes component) Full constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<UIComponent>	getComponentsForDefinition(UIComponentDefinitionId definitionId) Returns all components created from the given component definition, that were registered in this scope directly, in any of its sub-scopes or in a different branch within a super-scope (note that this should NOT return any components registered in any other super-scope from the same branch).
Set<UIComponent>	getRegisteredComponents() Returns a collection of all components registered in this scope.
List<UIComponent>	getRegisteredComponentsChildrenFirst(UIComponent root) Similar to getRegisteredComponents() but orders the result so that child appears in the list before a parent.
int	hashCode()
boolean	hasRegisteredComponent(UIComponent component) Answer whether a component is registered in this scope.
static UIComponentScope	newRoot() Creates root scope.
void	registerComponent(UIComponent component) Register the given UI component within this scope.
String	toString()
void	unregisterComponent(UIComponent component) Unregister the given UI component from this scope.
void	updateContext() Updates context dependent variables for this scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

UIComponentScope

public UIComponentScope(UIComponentWithCustomScopes component)

Full constructor.

Parameters:

component - component which creates custom scopes for all of its children. Not present in this scope. Null for root scope.

Method Detail

newRoot

public static UIComponentScope newRoot()

Creates root scope.

Returns:

the root scope, never null.

getRegisteredComponents

public Set<UIComponent> getRegisteredComponents()

Returns a collection of all components registered in this scope.

Returns:

registered components, never null, never contain null values. Immutable.

hasRegisteredComponent

public boolean hasRegisteredComponent(UIComponent component)

Answer whether a component is registered in this scope.

Parameters:

component -

Returns:

true if the given component is registered in this scope

registerComponent

public void registerComponent(UIComponent component)

Register the given UI component within this scope. Only the LspsScreen implementor may call this method, all other clients should call LspsScreen.registerUIComponent(com.whitestein.lsps.vaadin.ui.components.UIComponent).

Parameters:

component - the component, not null.

unregisterComponent

public void unregisterComponent(UIComponent component)

Unregister the given UI component from this scope.

Parameters:

component - not null

getComponentsForDefinition

public Set<UIComponent> getComponentsForDefinition(UIComponentDefinitionId definitionId)

Returns all components created from the given component definition, that were registered in this scope directly, in any of its sub-scopes or in a different branch within a super-scope (note that this should NOT return any components registered in any other super-scope from the same branch).

Parameters:

definitionId - not null.

Returns:

UIComponent-s within this scope created from the given component definition. Never null, never contains nulls. Unmodifiable.

updateContext

public void updateContext()

Updates context dependent variables for this scope. This method will iterate through all parent scopes and invoke (starting from the root scope) UIComponentWithCustomScopes.updateContextFor(UIComponentScope) on the owning components.

Used for example to update values of Table/Repeater iterators.

getRegisteredComponentsChildrenFirst

public List<UIComponent> getRegisteredComponentsChildrenFirst(UIComponent root)

Similar to getRegisteredComponents() but orders the result so that child appears in the list before a parent.

Parameters:

root - start at this root. Not null.

Returns:

ordered list of components, each component will appear in the list at most once. Never null, never empty - ends with given root component.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object