org.apache.myfaces.buildtools.maven2.plugin.builder.model
Class ComponentMeta

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta
      extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ViewEntityMeta
          extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ComponentMeta
All Implemented Interfaces:
FacetHolder, ListenerHolder, PropertyHolder

public class ComponentMeta
extends ViewEntityMeta
implements PropertyHolder, FacetHolder, ListenerHolder

Store metadata about a JSF UIComponent, or some base class or interface that a UIComponent can be derived from.


Field Summary
protected  Map _facets
           
protected  List _implementedInterfaceClassNames
           
protected  Map _listeners
           
 
Constructor Summary
ComponentMeta()
          Constructor.
 
Method Summary
 void addFacet(FacetMeta prop)
           
 void addImplementedInterfaceClassName(String name)
           
 void addListener(ListenerMeta prop)
           
static void addXmlRules(org.apache.commons.digester.Digester digester, String prefix)
          Add digester rules to repopulate an instance of this type from an xml file.
 Iterator facets()
           
 String getBodyContent()
           
 String getCcLibraryName()
           
 String getCcResourceName()
           
 String getDefaultEventName()
           
 FacetMeta getFacet(String name)
           
 Collection getFacetList()
           
 String getFamily()
           
 List getImplementedInterfaceClassNames()
           
 String getImplements()
           
 ListenerMeta getListener(String name)
           
 Boolean getNamingContainer()
           
 Collection getPropertyComponentList()
           
 Collection getPropertyTagList()
           
 String getRendererType()
           
 String getSerialuid()
           
 String getTagClass()
           
 String getTagHandler()
           
 String getTagPackage()
          Returns the package part of the tag class
 String getTagSuperclass()
           
 String getType()
           
 Boolean hasChildren()
           
 Boolean isClientBehaviorHolder()
           
 Boolean isComposite()
           
 Boolean isConfigExcluded()
           
 Boolean isGeneratedComponentClass()
           
 Boolean isGeneratedTagClass()
           
 Boolean isOverrideDefaultEventName()
          Indicate if this component must override the method: public String getDefaultEventName() To return the value on defaultEventName
 Boolean isOverrideEventNames()
           
 Boolean isTemplate()
           
 Iterator listeners()
           
 void merge(ComponentMeta other)
          Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.
 void setBodyContent(String bodyContent)
           
 void setCcLibraryName(String ccLibraryName)
           
 void setCcResourceName(String ccResourceName)
           
 void setChildren(Boolean children)
          Specifies if the component supports child components.
 void setClientBehaviorHolder(Boolean clientBehaviorHolder)
           
 void setComposite(Boolean composite)
           
 void setConfigExcluded(Boolean configExcluded)
           
 void setDefaultEventName(String defaultEventName)
           
 void setFamily(String componentFamily)
          Sets the JSF component family for this component.
 void setGeneratedComponentClass(Boolean generatedComponentClass)
           
 void setGeneratedTagClass(Boolean generatedTagClass)
           
 void setImplementedInterfaceClassNames(List classNames)
           
 void setImplements(String implementsValue)
           
 void setNamingContainer(Boolean namingContainer)
          Specifies whether this component is a "naming container", ie whether it adds its own clientId as a prefix onto the clientId of its child components.
 void setOverrideDefaultEventName(Boolean overrideDefaultEventName)
           
 void setRendererType(String rendererType)
          Sets the renderer type for this component.
 void setSerialuid(String serialuid)
           
 void setTagClass(String tagClass)
          Sets the JSP tag handler class for this component.
 void setTagHandler(String tagHandler)
          Specifies the class of the Facelets tag handler (component handler) for this component.
 void setTagSuperclass(String tagSuperclass)
          Sets the JSP tag handler superclass for this component.
 void setTemplate(Boolean template)
           
 void setType(String componentType)
          Sets the JSF component type for this component.
protected  void writeXmlSimple(XmlWriter out)
          Write an instance of this class out as xml.
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.model.ViewEntityMeta
addProperty, getDescription, getLongDescription, getName, getProperties, getProperty, getPropertyList, hasProperties, merge, properties, propertiesSize, setDescription, setLongDescription, setName, writeXmlComplex
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta
addInterfaceClassName, getClassName, getInterfaceClassNames, getModelId, getPackageName, getParentClassName, getSourceClassName, getSourceClassParentClassName, merge, setClassName, setInterfaceClassNames, setModelId, setParentClassName, setSourceClassName, setSourceClassParentClassName, writeXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.myfaces.buildtools.maven2.plugin.builder.model.PropertyHolder
addProperty, getProperties, getProperty, properties
 

Field Detail

_facets

protected Map _facets

_listeners

protected Map _listeners

_implementedInterfaceClassNames

protected List _implementedInterfaceClassNames
Constructor Detail

ComponentMeta

public ComponentMeta()
Constructor.

Method Detail

writeXmlSimple

protected void writeXmlSimple(XmlWriter out)
Write an instance of this class out as xml.

Overrides:
writeXmlSimple in class ViewEntityMeta

addXmlRules

public static void addXmlRules(org.apache.commons.digester.Digester digester,
                               String prefix)
Add digester rules to repopulate an instance of this type from an xml file.


merge

public void merge(ComponentMeta other)
Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.


setBodyContent

public void setBodyContent(String bodyContent)

getBodyContent

public String getBodyContent()

setType

public void setType(String componentType)
Sets the JSF component type for this component.


getType

public String getType()

setFamily

public void setFamily(String componentFamily)
Sets the JSF component family for this component.


getFamily

public String getFamily()

setRendererType

public void setRendererType(String rendererType)
Sets the renderer type for this component.


getRendererType

public String getRendererType()

setTagClass

public void setTagClass(String tagClass)
Sets the JSP tag handler class for this component.


getTagClass

public String getTagClass()

setTagSuperclass

public void setTagSuperclass(String tagSuperclass)
Sets the JSP tag handler superclass for this component.


getTagSuperclass

public String getTagSuperclass()

setTagHandler

public void setTagHandler(String tagHandler)
Specifies the class of the Facelets tag handler (component handler) for this component.

Note that a Facelets tag handler class is not needed for most components.


getTagHandler

public String getTagHandler()

setNamingContainer

public void setNamingContainer(Boolean namingContainer)
Specifies whether this component is a "naming container", ie whether it adds its own clientId as a prefix onto the clientId of its child components.


getNamingContainer

public Boolean getNamingContainer()

setConfigExcluded

public void setConfigExcluded(Boolean configExcluded)

isConfigExcluded

public Boolean isConfigExcluded()

setSerialuid

public void setSerialuid(String serialuid)

getSerialuid

public String getSerialuid()

setImplements

public void setImplements(String implementsValue)

getImplements

public String getImplements()

setGeneratedComponentClass

public void setGeneratedComponentClass(Boolean generatedComponentClass)

isGeneratedComponentClass

public Boolean isGeneratedComponentClass()

setGeneratedTagClass

public void setGeneratedTagClass(Boolean generatedTagClass)

isGeneratedTagClass

public Boolean isGeneratedTagClass()

setTemplate

public void setTemplate(Boolean template)

isTemplate

public Boolean isTemplate()

setChildren

public void setChildren(Boolean children)
Specifies if the component supports child components.


hasChildren

public Boolean hasChildren()

addFacet

public void addFacet(FacetMeta prop)
Specified by:
addFacet in interface FacetHolder

facets

public Iterator facets()
Specified by:
facets in interface FacetHolder

getFacet

public FacetMeta getFacet(String name)
Specified by:
getFacet in interface FacetHolder

addListener

public void addListener(ListenerMeta prop)
Specified by:
addListener in interface ListenerHolder
Since:
1.0.4

listeners

public Iterator listeners()
Specified by:
listeners in interface ListenerHolder
Since:
1.0.4

getListener

public ListenerMeta getListener(String name)
Specified by:
getListener in interface ListenerHolder
Since:
1.0.4

getDefaultEventName

public String getDefaultEventName()
Since:
1.0.4

setDefaultEventName

public void setDefaultEventName(String defaultEventName)
Since:
1.0.4

setOverrideDefaultEventName

public void setOverrideDefaultEventName(Boolean overrideDefaultEventName)
Since:
1.0.5

isOverrideDefaultEventName

public Boolean isOverrideDefaultEventName()
Indicate if this component must override the method: public String getDefaultEventName() To return the value on defaultEventName

Since:
1.0.5

setClientBehaviorHolder

public void setClientBehaviorHolder(Boolean clientBehaviorHolder)
Since:
1.0.5

isClientBehaviorHolder

public Boolean isClientBehaviorHolder()
Since:
1.0.5

getImplementedInterfaceClassNames

public List getImplementedInterfaceClassNames()
Since:
1.0.5

setImplementedInterfaceClassNames

public void setImplementedInterfaceClassNames(List classNames)
Since:
1.0.5

addImplementedInterfaceClassName

public void addImplementedInterfaceClassName(String name)
Since:
1.0.5

isComposite

public Boolean isComposite()
Since:
1.0.5

setComposite

public void setComposite(Boolean composite)
Since:
1.0.5

getCcLibraryName

public String getCcLibraryName()
Since:
1.0.9

setCcLibraryName

public void setCcLibraryName(String ccLibraryName)
Since:
1.0.9

getCcResourceName

public String getCcResourceName()
Since:
1.0.9

setCcResourceName

public void setCcResourceName(String ccResourceName)
Since:
1.0.9

getFacetList

public Collection getFacetList()

getPropertyTagList

public Collection getPropertyTagList()

getPropertyComponentList

public Collection getPropertyComponentList()

getTagPackage

public String getTagPackage()
Returns the package part of the tag class

Returns:

isOverrideEventNames

public Boolean isOverrideEventNames()
Since:
1.0.5


Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.