|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.buildtools.maven2.plugin.faces.parse.ObjectBean
org.apache.myfaces.buildtools.maven2.plugin.faces.parse.ComponentBean
public class ComponentBean
ComponentBean is a Java representation of the faces-config component XML element.
Constructor Summary | |
---|---|
ComponentBean()
Creates a new ComponentBean. |
Method Summary | |
---|---|
void |
addComponentClassModifier(int modifier)
Adds a Java Language class modifier to the component class. |
void |
addEvent(EventRefBean eventRef)
Adds an event to this component. |
void |
addFacet(FacetBean facet)
Adds a facet to this component. |
void |
addProperty(PropertyBean property)
Adds a property to this component. |
void |
addTagClassModifier(int modifier)
Adds a Java Language class modifier to the tag class. |
protected void |
attach(FacesConfigBean owner)
Attaches the component and all event references. |
java.util.Iterator |
events()
Returns an iterator for all events on this component only. |
java.util.Iterator |
events(boolean flatten)
Returns an iterator for events on this component. |
java.util.Iterator |
facets()
Returns an iterator for all facets on this component only. |
java.util.Iterator |
facets(boolean flatten)
Returns an iterator for facets on this component. |
ComponentBean |
findBehavioralComponent()
Finds the behavioral component component inheritance hierarchy. |
protected java.lang.String |
findComponentClass()
Finds the component class in the component inheritance hierarchy. |
java.lang.String |
findComponentFamily()
Finds the component family in the component inheritance hierarchy. |
java.lang.String |
findComponentSuperclass()
Finds the component superclass in the component inheritance hierarchy. |
EventBean |
findEvent(java.lang.String eventName)
Returns the event for this event name. |
EventBean |
findEvent(java.lang.String eventName,
boolean flatten)
|
FacetBean |
findFacet(java.lang.String facetName)
Returns the facet for this facet name. |
FacetBean |
findFacet(java.lang.String facetName,
boolean flatten)
|
protected java.lang.String |
findJspTagClass()
Finds the tag class in the component inheritance hierarchy. |
java.lang.String |
findJspTagSuperclass()
Finds the tag superclass in the component inheritance hierarchy. |
PropertyBean |
findProperty(java.lang.String propertyName)
Returns the property for this property name. |
PropertyBean |
findProperty(java.lang.String propertyName,
boolean flatten)
Returns the property for this property name. |
java.lang.String |
findRendererType()
Finds the renderer type in the component inheritance hierarchy. |
java.lang.String |
getComponentClass()
Returns the component class for this component. |
int |
getComponentClassModifiers()
Returns the Java Language class modifiers for the component class. |
java.lang.String |
getComponentFamily()
Returns the component family for this component. |
java.lang.String |
getComponentImplements()
|
java.lang.String |
getComponentSerialUID()
|
java.lang.String |
getComponentSuperclass()
Returns the component super class for this component. |
java.lang.String |
getComponentSupertype()
Returns the component supertype for this component. |
java.lang.String |
getComponentType()
Returns the component type for this component. |
java.lang.String |
getDefaultRendererType()
Returns the default renderer type for this component. |
java.lang.String |
getDescription()
Returns the description of this property. |
java.lang.String |
getImplementationType()
|
java.lang.String |
getLocalName()
Returns the UIX2 local name for this component. |
java.lang.String |
getLongDescription()
Returns the long description of this property. |
java.lang.String |
getNodeClass()
Returns the UIX2 node class for this component. |
java.lang.String |
getRendererType()
Returns the renderer type for this component. |
java.lang.String |
getTagClass()
Returns the JSP tag handler class for this component. |
int |
getTagClassModifiers()
Returns the Java Language class modifiers for the tag class. |
java.lang.String |
getTagHandler()
Returns the Facelets tag handler for this component |
javax.xml.namespace.QName |
getTagName()
Returns the JSP tag name for this component. |
java.lang.String |
getTagSuperclass()
Returns the JSP tag handler superclass for this component. |
java.lang.String[] |
getUnsupportedAgents()
Returns unsupported agents for this component. |
boolean |
hasChildren()
Returns true if the component can have children. |
boolean |
hasComponentFamily()
Returns true if the component family exists for this component. |
boolean |
hasEvents()
Returns true if this component has any events. |
boolean |
hasEvents(boolean flatten)
Returns true if this component or any component supertype has any events. |
boolean |
hasFacets()
Returns true if this component has any facets. |
boolean |
hasFacets(boolean flatten)
Returns true if this component or any component supertype has any facets. |
boolean |
hasProperties()
Returns true if this component has any properties. |
boolean |
hasProperties(boolean flatten)
Returns true if this component or any component supertype has any properties. |
boolean |
isComponentClassExcluded()
|
boolean |
isNamingContainer()
Returns namingContainer flag of this component. |
boolean |
isTagClassExcluded()
|
boolean |
isTrinidadComponent()
Checks if any of the component superclasses is UIXComponentBase |
void |
parseComponentClassModifier(java.lang.String modifier)
|
void |
parseTagClassModifier(java.lang.String modifier)
|
void |
parseUnsupportedAgents(java.lang.String unsupportedAgents)
Parses the unsupported agents for this component into a String array using space as the separator between values. |
java.util.Iterator |
properties()
Returns an iterator for all properties on this component only. |
java.util.Iterator |
properties(boolean flatten)
Returns an iterator for properties on this component. |
int |
propertiesSize()
Number of properties for this component |
ComponentBean |
resolveSupertype()
Returns the component supertype instance. |
void |
setChildren(boolean children)
Specifies if the component can have children. |
void |
setComponentClass(java.lang.String componentClass)
Sets the component class for this component. |
void |
setComponentClassExcluded(boolean componentClassExcluded)
|
void |
setComponentFamily(java.lang.String componentFamily)
Sets the component family for this component. |
void |
setComponentImplements(java.lang.String _implements)
|
void |
setComponentSerialUID(java.lang.String _componentSerialUID)
|
void |
setComponentSuperclass(java.lang.String componentSuperclass)
Sets the component super class for this component. |
void |
setComponentSupertype(java.lang.String componentSupertype)
Sets the component supertype for this component. |
void |
setComponentType(java.lang.String componentType)
Sets the component type for this component. |
void |
setDescription(java.lang.String description)
Sets the description of this property. |
void |
setImplementationType(java.lang.String implementationType)
|
void |
setLocalName(java.lang.String localName)
Deprecated. remove when "ui" package is gone |
void |
setLongDescription(java.lang.String longDescription)
Sets the long description of this property. |
void |
setNamingContainer(boolean namingContainer)
Sets the namingContainer flag of this property. |
void |
setNodeClass(java.lang.String nodeClass)
Deprecated. remove when "ui" package is gone |
void |
setRendererType(java.lang.String rendererType)
Sets the renderer type for this component. |
void |
setTagClass(java.lang.String tagClass)
Sets the JSP tag handler class for this component. |
void |
setTagClassExcluded(boolean tagClassExcluded)
|
void |
setTagHandler(java.lang.String tagHandler)
Sets the Facelets tag handler (component handler) this component. |
void |
setTagName(javax.xml.namespace.QName tagName)
Sets the JSP tag name for this component. |
void |
setTagSuperclass(java.lang.String tagSuperclass)
Sets the JSP tag handler superclass for this component. |
void |
setUnsupportedAgents(java.lang.String[] unsupportedAgents)
Sets the unsupported agents for this component. |
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.faces.parse.ObjectBean |
---|
getOwner, isModifiedSince |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ComponentBean()
Method Detail |
---|
public void setLocalName(java.lang.String localName)
localName
- the local namepublic java.lang.String getLocalName()
public void setNodeClass(java.lang.String nodeClass)
nodeClass
- the node classpublic java.lang.String getNodeClass()
public void setComponentType(java.lang.String componentType)
componentType
- the component typepublic java.lang.String getComponentType()
public void setComponentFamily(java.lang.String componentFamily)
componentFamily
- the component familypublic java.lang.String getComponentFamily()
public boolean hasComponentFamily()
public void setComponentClass(java.lang.String componentClass)
componentClass
- the component classpublic java.lang.String getComponentClass()
public void setDescription(java.lang.String description)
description
- the property descriptionpublic java.lang.String getDescription()
public void setLongDescription(java.lang.String longDescription)
longDescription
- the long property descriptionpublic java.lang.String getLongDescription()
public void setTagClass(java.lang.String tagClass)
tagClass
- the JSP tag handler classpublic void setUnsupportedAgents(java.lang.String[] unsupportedAgents)
unsupportedAgents
- the unsupported agentspublic java.lang.String[] getUnsupportedAgents()
public java.lang.String getTagClass()
public void setTagSuperclass(java.lang.String tagSuperclass)
tagSuperclass
- the JSP tag handler superclasspublic java.lang.String getTagSuperclass()
public void setTagHandler(java.lang.String tagHandler)
tagHandler
- the Facelets tag handler classpublic java.lang.String getTagHandler()
public javax.xml.namespace.QName getTagName()
public void setTagName(javax.xml.namespace.QName tagName)
tagName
- the JSP tag namepublic void setNamingContainer(boolean namingContainer)
namingContainer
- the component namingContainer flagpublic boolean isNamingContainer()
public void setComponentSupertype(java.lang.String componentSupertype)
componentSupertype
- the component super typepublic java.lang.String getComponentSupertype()
public void setComponentSuperclass(java.lang.String componentSuperclass)
componentSuperclass
- the component super classpublic java.lang.String getComponentSuperclass()
public void setRendererType(java.lang.String rendererType)
rendererType
- the renderer typepublic java.lang.String getRendererType()
public java.lang.String getDefaultRendererType()
public java.lang.String getImplementationType()
public void setImplementationType(java.lang.String implementationType)
public void addProperty(PropertyBean property)
property
- the property to addpublic PropertyBean findProperty(java.lang.String propertyName)
propertyName
- the property name to findpublic PropertyBean findProperty(java.lang.String propertyName, boolean flatten)
propertyName
- the property name to findpublic boolean hasProperties()
public boolean hasProperties(boolean flatten)
public java.util.Iterator properties()
public java.util.Iterator properties(boolean flatten)
flatten
- true if the iterator should be a combined list of
properties of this component and its supertype,
false otherwise
public int propertiesSize()
public void addFacet(FacetBean facet)
facet
- the facet to addpublic FacetBean findFacet(java.lang.String facetName)
facetName
- the facet name to findpublic FacetBean findFacet(java.lang.String facetName, boolean flatten)
public boolean hasFacets()
public boolean hasFacets(boolean flatten)
public java.util.Iterator facets()
public java.util.Iterator facets(boolean flatten)
flatten
- true if the iterator should be a combined list of
facets of this component and its supertype,
false otherwise
public void setChildren(boolean children)
children
- true if the component can have children.
false otherwisepublic boolean hasChildren()
public void addComponentClassModifier(int modifier)
modifier
- the modifier to be addedpublic int getComponentClassModifiers()
public void parseComponentClassModifier(java.lang.String modifier)
public void parseTagClassModifier(java.lang.String modifier)
public void parseUnsupportedAgents(java.lang.String unsupportedAgents)
unsupportedAgents
- the unsupported agentspublic void addTagClassModifier(int modifier)
modifier
- the modifier to be addedpublic int getTagClassModifiers()
public void addEvent(EventRefBean eventRef)
eventRef
- the event to addpublic boolean hasEvents()
public boolean hasEvents(boolean flatten)
public EventBean findEvent(java.lang.String eventName)
eventName
- the event name to findpublic EventBean findEvent(java.lang.String eventName, boolean flatten)
public java.util.Iterator events()
public java.util.Iterator events(boolean flatten)
flatten
- true if the iterator should be a combined list of
events of this component and its supertype,
false otherwise
public java.lang.String findComponentFamily()
public ComponentBean findBehavioralComponent()
public java.lang.String findRendererType()
public java.lang.String findComponentSuperclass()
public java.lang.String findJspTagSuperclass()
public ComponentBean resolveSupertype()
public boolean isTrinidadComponent()
protected java.lang.String findComponentClass()
protected java.lang.String findJspTagClass()
protected void attach(FacesConfigBean owner)
attach
in class ObjectBean
owner
- the faces config ownerpublic void setComponentClassExcluded(boolean componentClassExcluded)
public boolean isComponentClassExcluded()
public void setTagClassExcluded(boolean tagClassExcluded)
public boolean isTagClassExcluded()
public void setComponentImplements(java.lang.String _implements)
public java.lang.String getComponentImplements()
public void setComponentSerialUID(java.lang.String _componentSerialUID)
public java.lang.String getComponentSerialUID()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |