Package ch.tocco.nice2.model.form.impl.form2.components

Class AbstractCompositeComponent

java.lang.Object

ch.tocco.nice2.model.form.impl.form2.components.AbstractComponent

ch.tocco.nice2.model.form.impl.form2.components.AbstractCompositeComponent

All Implemented Interfaces:

Component, CompositeComponent, Cloneable

Direct Known Subclasses:

AbstractAction, AbstractComponentContainer, ActionBarImpl, ActionGroupImpl, FormImpl, LayoutImpl

public abstract class AbstractCompositeComponent
extends AbstractComponent
implements CompositeComponent

Base class for composite components that contains a list of child components.

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

Component.Configuration

Constructor Summary

Constructors

Constructor	Description
AbstractCompositeComponent()

Method Summary

Modifier and Type	Method	Description
final void	accept(ComponentVisitor visitor)	Implement method (and add new method to ComponentVisitor), if during traversing the form something should happen with this specific component type
void	addComponent(AbstractComponent component)
void	addScope(FormScope scope)
void	addScopes(Collection<FormScope> scopes)
AbstractCompositeComponent	clone()
Optional<Component>	findById(String id)
List<Component>	getChildren()	Returns all child components.
Set<FormScope>	getScopes()	Returns the defined the scopes.
boolean	hasChildren()	Returns `true` if the list of children is not empty.
int	indexOf(String componentId)
void	insertComponent(int index, AbstractComponent component)
void	parseScopes(String scopes)
void	removeComponent(AbstractComponent component)
void	removeScope(FormScope scope)
void	removeScopes(Collection<FormScope> scopes)
void	replaceComponent(Component oldComponent, AbstractComponent newComponent)
void	validate()	Will be called when the form has been built completely.

Methods inherited from class ch.tocco.nice2.model.form.impl.form2.components.AbstractComponent

getDefaultFormLabel, getId, getLabel, getParent, getPosition, setId, setLabel, setParent, setPosition

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

getForm, getId, getLabel, getParent, getPosition

Constructor Details

AbstractCompositeComponent

public AbstractCompositeComponent()

Method Details

getScopes

public Set<FormScope> getScopes()

Description copied from interface: CompositeComponent

Returns the defined the scopes. If the set is empty, the component is meant for all scopes.

Specified by:

getScopes in interface CompositeComponent

addScope

public void addScope(FormScope scope)

addScopes

public void addScopes(Collection<FormScope> scopes)

removeScope

public void removeScope(FormScope scope)

removeScopes

public void removeScopes(Collection<FormScope> scopes)

parseScopes

public void parseScopes(String scopes)

hasChildren

public boolean hasChildren()

Description copied from interface: CompositeComponent

Returns `true` if the list of children is not empty.

Specified by:

hasChildren in interface CompositeComponent

getChildren

public List<Component> getChildren()

Description copied from interface: CompositeComponent

Returns all child components.

Specified by:

getChildren in interface CompositeComponent

findById

public Optional<Component> findById(String id)

Specified by:

findById in interface CompositeComponent

Returns:

the component with the passed `id` if it exists in the component tree. Otherwise Optional.empty() will be returned.

addComponent

public void addComponent(AbstractComponent component)

replaceComponent

public void replaceComponent(Component oldComponent,
 AbstractComponent newComponent)

insertComponent

public void insertComponent(int index,
 AbstractComponent component)

removeComponent

public void removeComponent(AbstractComponent component)

indexOf

public int indexOf(String componentId)

validate

public void validate()
              throws ModelBuildException

Description copied from interface: Component

Will be called when the form has been built completely. Can be used to validate values (and throw ModelBuildException) or the fill in default value.

Specified by:

validate in interface Component

Throws:

ModelBuildException

accept

public final void accept(ComponentVisitor visitor)

Description copied from interface: Component

Implement method (and add new method to ComponentVisitor), if during traversing the form something should happen with this specific component type

Specified by:

accept in interface Component

clone

public AbstractCompositeComponent clone()
                                 throws CloneNotSupportedException

Overrides:

clone in class AbstractComponent

Throws:

CloneNotSupportedException