org.richfaces.cdk.model

Class ComponentModel

java.lang.Object

org.richfaces.cdk.model.DescriptionGroupBase

org.richfaces.cdk.model.BeanModelBase

org.richfaces.cdk.model.ModelElementBase

org.richfaces.cdk.model.ComponentModel

All Implemented Interfaces:

Serializable, Cacheable, DescriptionGroup, Extensible<ConfigExtension>, FacesComponent, GeneratedFacesComponent, Mergeable<ComponentModel>, ModelElement<ComponentModel>, ViewElement, Visitable

public final class ComponentModel
extends ModelElementBase
implements ModelElement<ComponentModel>, Cacheable

That class represents JSF component in the CDK. That is mapped to faces-config "component" element.

Author:

asmirnov@exadel.com

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.richfaces.cdk.model.FacesComponent

FacesComponent.ComponentPredicate

Nested classes/interfaces inherited from interface org.richfaces.cdk.model.DescriptionGroup

DescriptionGroup.Icon

Constructor Summary

Constructors

Constructor and Description
ComponentModel()
ComponentModel(FacesId key)

Method Summary

Methods

Modifier and Type	Method and Description
<R,D> R	accept(Visitor<R,D> visitor, D data)
EventModel	addEvent(ClassName className)
EventModel	addEvent(String className)
ModelCollection<EventModel>	getEvents()
FacetModel	getFacet(String name)
ModelCollection<FacetModel>	getFacets()
FacesId	getFamily() Reepresent a component family.
FacetModel	getOrCreateFacet(String name)
ComponentModel	getParent()
String	getRendererTemplate()
FacesId	getRendererType()
boolean	hasChanged() Says whenever this model has been changed after last call to Cacheable.markUnchanged().
void	markUnchanged() Marks the model unchanged, so further changes will make it changed.
void	merge(ComponentModel otherComponent) Merge values from other object.
boolean	same(ComponentModel other) Compare object with other.
void	setFamily(FacesId family)
void	setParent(ComponentModel parentComponent)
void	setRendererTemplate(String rendererTemplate)
void	setRendererType(FacesId renderer)
void	stopTrackingChanges() Stops tracking any changes, making the model available for merging without tracking changes.
String	toString()

Methods inherited from class org.richfaces.cdk.model.ModelElementBase

getBaseClass, getGenerate, getId, getInterfaces, getTags, getTargetClass, setBaseClass, setGenerate, setId, setTargetClass

Methods inherited from class org.richfaces.cdk.model.BeanModelBase

createAttribute, getAttribute, getAttributes, getOrCreateAttribute

Methods inherited from class org.richfaces.cdk.model.DescriptionGroupBase

getDescription, getDisplayName, getExtension, getIcon, setDescription, setDisplayName, setExtension, setIcon

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentModel

public ComponentModel(FacesId key)

ComponentModel

public ComponentModel()

Method Detail

accept

public <R,D> R accept(Visitor<R,D> visitor,
             D data)

Specified by:

accept in interface Visitable

merge

public void merge(ComponentModel otherComponent)

Description copied from interface: Mergeable

Merge values from other object.

Specified by:

merge in interface Mergeable<ComponentModel>

same

public boolean same(ComponentModel other)

Description copied from interface: Mergeable

Compare object with other. For example, JSF component with same type or class is the same component.

Specified by:

same in interface Mergeable<ComponentModel>

Returns:

getRendererType

public FacesId getRendererType()

Returns:

the rendererType

setRendererType

public void setRendererType(FacesId renderer)

Parameters:

renderer - the rendererType to set

getRendererTemplate

public String getRendererTemplate()

Returns:

the rendererTemplate

setRendererTemplate

public void setRendererTemplate(String rendererTemplate)

Parameters:

rendererTemplate - the rendererTemplate to set

getFamily

public FacesId getFamily()

Reepresent a component family. In the faces-config element that property encoded as ....

Returns:

the family

setFamily

public void setFamily(FacesId family)

Parameters:

family - the family to set

getFacets

public ModelCollection<FacetModel> getFacets()

Returns:

the facets

getFacet

public FacetModel getFacet(String name)

getOrCreateFacet

public FacetModel getOrCreateFacet(String name)

getEvents

public ModelCollection<EventModel> getEvents()

Returns:

the events

addEvent

public EventModel addEvent(ClassName className)

addEvent

public EventModel addEvent(String className)

toString

public String toString()

Overrides:

toString in class Object

setParent

public void setParent(ComponentModel parentComponent)

getParent

public ComponentModel getParent()

markUnchanged

public void markUnchanged()

Description copied from interface: Cacheable

Marks the model unchanged, so further changes will make it changed. You may do any changes which should not be tracked and then call this method to track further changes.

Specified by:

markUnchanged in interface Cacheable

hasChanged

public boolean hasChanged()

Description copied from interface: Cacheable

Says whenever this model has been changed after last call to Cacheable.markUnchanged().

Specified by:

hasChanged in interface Cacheable

stopTrackingChanges

public void stopTrackingChanges()

Description copied from interface: Cacheable

Stops tracking any changes, making the model available for merging without tracking changes.

Specified by:

stopTrackingChanges in interface Cacheable