com.whitestein.lsps.vaadin.ui

Class ComponentsToProcess.Builder

java.lang.Object

com.whitestein.lsps.vaadin.ui.ComponentsToProcess.Builder

Enclosing class:

ComponentsToProcess

public static final class ComponentsToProcess.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder(LspsScreen screen) Creates the set builder.

Method Summary

Modifier and Type	Method and Description
ComponentsToProcess.Builder	add(UIComponent component)
ComponentsToProcess.Builder	add(UIComponentDefinitionId component) Adds given component and all of its descendants into the set.
ComponentsToProcess	build() Returns a set which contains all of given components and all of their descendants.
boolean	containsAll() Returns true if the topmost component has been registered into this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(LspsScreen screen)

Creates the set builder.

Parameters:

screen - the screen, not null.

Method Detail

containsAll

public boolean containsAll()

Returns true if the topmost component has been registered into this builder.

Returns:

true if the set will contain all screen components.

add

public ComponentsToProcess.Builder add(UIComponentDefinitionId component)

Adds given component and all of its descendants into the set.

If the screen root is added, containsAll() is flipped to true and the builder will always produce ComponentsToProcess.ALL.

Parameters:

component - the component, not null.

Returns:

the builder

add

public ComponentsToProcess.Builder add(UIComponent component)

build

public ComponentsToProcess build()

Returns a set which contains all of given components and all of their descendants.

Returns:

the set, never null.