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

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.ClassMeta
      extended by org.apache.myfaces.buildtools.maven2.plugin.builder.model.FaceletTagMeta
All Implemented Interfaces:
AttributeHolder

public class FaceletTagMeta
extends ClassMeta
implements AttributeHolder

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

Since:
1.0.4
Version:
$Revision: 941092 $ $Date: 2010-05-04 18:29:42 -0500 (Tue, 04 May 2010) $
Author:
Leonardo Uribe (latest modification by $Author: lu4242 $)

Field Summary
protected  Map _attributes
           
 
Constructor Summary
FaceletTagMeta()
          Constructor.
 
Method Summary
 void addAttribute(AttributeMeta attribute)
          Adds a property to this component.
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 attributes()
          Returns an iterator for all properties
 int attributesSize()
          Number of properties for this component
 AttributeMeta getAttribute(String attributeName)
           
 Collection getAttributeList()
           
 String getBehaviorClass()
           
 String getBodyContent()
           
 String getComponentClass()
           
 String getConverterClass()
           
 String getDescription()
           
 String getLongDescription()
           
 String getName()
           
 String getTagClass()
           
 String getValidatorClass()
           
 boolean hasAttributes()
          Returns true if this component has any properties.
 Boolean isConfigExcluded()
           
 void merge(FaceletTagMeta other)
          Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.
 void setBehaviorClass(String behaviorClass)
           
 void setBodyContent(String bodyContent)
           
 void setComponentClass(String componentClass)
           
 void setConfigExcluded(Boolean configExcluded)
           
 void setConverterClass(String converterClass)
           
 void setDescription(String description)
          Sets the brief description of this property.
 void setLongDescription(String longDescription)
          Sets the long description of this property.
 void setName(String name)
          Sets the name that the user will refer to instances of this component by.
 void setTagClass(String tagClass)
           
 void setValidatorClass(String validatorClass)
           
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.ClassMeta
addInterfaceClassName, getClassName, getInterfaceClassNames, getModelId, getPackageName, getParentClassName, getSourceClassName, getSourceClassParentClassName, merge, setClassName, setInterfaceClassNames, setModelId, setParentClassName, setSourceClassName, setSourceClassParentClassName, writeXml, writeXmlComplex
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_attributes

protected Map _attributes
Constructor Detail

FaceletTagMeta

public FaceletTagMeta()
Constructor.

Method Detail

writeXmlSimple

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

Overrides:
writeXmlSimple in class ClassMeta

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(FaceletTagMeta other)
Merge the data in the specified other property into this one, throwing an exception if there is an incompatibility.


setDescription

public void setDescription(String description)
Sets the brief description of this property.

This description is used in tooltips, etc.


getDescription

public String getDescription()

setLongDescription

public void setLongDescription(String longDescription)
Sets the long description of this property.


getLongDescription

public String getLongDescription()

setBodyContent

public void setBodyContent(String bodyContent)

getBodyContent

public String getBodyContent()

setName

public void setName(String name)
Sets the name that the user will refer to instances of this component by.

In JSP tags, this value will be used as the JSP tag name.

This property is optional; if not set then this Model instance represents a base class that components can be derived from, but which cannot itself be instantiated as a component.


getName

public String getName()

getComponentClass

public String getComponentClass()

setComponentClass

public void setComponentClass(String componentClass)

getTagClass

public String getTagClass()

setTagClass

public void setTagClass(String tagClass)

getConverterClass

public String getConverterClass()

setConverterClass

public void setConverterClass(String converterClass)

getValidatorClass

public String getValidatorClass()

setValidatorClass

public void setValidatorClass(String validatorClass)

getBehaviorClass

public String getBehaviorClass()
Since:
1.0.6

setBehaviorClass

public void setBehaviorClass(String behaviorClass)
Since:
1.0.6

setConfigExcluded

public void setConfigExcluded(Boolean configExcluded)

isConfigExcluded

public Boolean isConfigExcluded()

addAttribute

public void addAttribute(AttributeMeta attribute)
Adds a property to this component.

Specified by:
addAttribute in interface AttributeHolder

getAttribute

public AttributeMeta getAttribute(String attributeName)
Specified by:
getAttribute in interface AttributeHolder

attributesSize

public int attributesSize()
Number of properties for this component


hasAttributes

public boolean hasAttributes()
Returns true if this component has any properties.


attributes

public Iterator attributes()
Returns an iterator for all properties

Specified by:
attributes in interface AttributeHolder

getAttributeList

public Collection getAttributeList()


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