|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.ObjectBean
org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.AbstractTagBean
org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.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. |
Iterator<EventRefBean> |
events()
Returns an iterator for all events on this component only. |
Iterator<EventRefBean> |
events(boolean flatten)
Returns an iterator for events on this component. |
Iterator<FacetBean> |
facets()
Returns an iterator for all facets on this component only. |
Iterator<FacetBean> |
facets(boolean flatten)
Returns an iterator for facets on this component. |
ComponentBean |
findBehavioralComponent()
Finds the behavioral component component inheritance hierarchy. |
protected String |
findComponentClass()
Finds the component class in the component inheritance hierarchy. |
String |
findComponentFamily()
Finds the component family in the component inheritance hierarchy. |
String |
findComponentSuperclass()
Finds the component superclass in the component inheritance hierarchy. |
EventRefBean |
findEvent(String eventName)
Returns the event for this event name. |
EventRefBean |
findEvent(String eventName,
boolean flatten)
|
FacetBean |
findFacet(String facetName)
Returns the facet for this facet name. |
FacetBean |
findFacet(String facetName,
boolean flatten)
|
protected String |
findJspTagClass()
Finds the tag class in the component inheritance hierarchy. |
String |
findJspTagSuperclass()
Finds the tag superclass in the component inheritance hierarchy. |
PropertyBean |
findProperty(String propertyName)
Returns the property for this property name. |
PropertyBean |
findProperty(String propertyName,
boolean flatten)
Returns the property for this property name. |
String |
findRendererType()
Finds the renderer type in the component inheritance hierarchy. |
String |
getComponentClass()
Returns the component class for this component. |
int |
getComponentClassModifiers()
Returns the Java Language class modifiers for the component class. |
String |
getComponentFamily()
Returns the component family for this component. |
String |
getComponentSuperclass()
Returns the component super class for this component. |
String |
getComponentSupertype()
Returns the component supertype for this component. |
String |
getComponentType()
Returns the component type for this component. |
String |
getDefaultEventName()
|
String |
getDefaultRendererType()
Returns the default renderer type for this component. |
String |
getDescription()
Returns the description of this property. |
String[] |
getEventNames()
|
protected Map |
getFlattenedFacets()
|
protected Map |
getFlattenedProperties()
|
String |
getImplementationType()
|
String |
getJsComponentClass()
Returns the JavaScript component class for this component. |
String |
getLocalName()
Returns the UIX2 local name for this component. |
String |
getLongDescription()
Returns the long description of this property. |
String |
getNodeClass()
Returns the UIX2 node class for this component. |
String |
getRendererType()
Returns the renderer type for this component. |
int |
getTagClassModifiers()
Returns the Java Language class modifiers for the tag class. |
String |
getTagHandler()
Returns the Facelets tag handler for this component |
String |
getTagSuperclass()
Returns the JSP tag handler superclass for this component. |
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 |
hasRequiredAncestorContracts()
Returns true if this component has any required ancestor contracts. |
boolean |
hasSatisfiedContracts()
Returns true if this component has any satisfied contracts. |
boolean |
isClientBehaviorHolder()
|
boolean |
isNamingContainer()
Returns namingContainer flag of this component. |
boolean |
isTrinidadComponent()
Checks if any of the component superclasses is UIXComponentBase |
void |
parseComponentClassModifier(String modifier)
|
void |
parseEventNames(String value)
|
void |
parseRequiredAncestorContracts(String requiredAncestorContracts)
Parses the string of required ancestor contracts into a String array using space as the separator between values. |
void |
parseSatisfiedContracts(String satisfiedContracts)
Parses the string of satisfied contracts into a String array using space as the separator between values. |
void |
parseTagClassModifier(String modifier)
|
void |
parseUnsupportedAgents(String unsupportedAgents)
Parses the unsupported agents for this component into a String array using space as the separator between values. |
Iterator<PropertyBean> |
properties()
Returns an iterator for all properties on this component only. |
Iterator<PropertyBean> |
properties(boolean flatten)
Returns an iterator for properties on this component. |
int |
propertiesSize()
Number of properties for this component |
Iterator<String> |
requiredAncestorContracts()
Returns the required ancestor contracts for this component. |
ComponentBean |
resolveSupertype()
Returns the component supertype instance. |
Iterator<String> |
satisfiedContracts()
Returns an iterator of the satisfied contracts for this component. |
void |
setChildren(boolean children)
Specifies if the component can have children. |
void |
setComponentClass(String componentClass)
Sets the component class for this component. |
void |
setComponentFamily(String componentFamily)
Sets the component family for this component. |
void |
setComponentSuperclass(String componentSuperclass)
Sets the component super class for this component. |
void |
setComponentSupertype(String componentSupertype)
Sets the component supertype for this component. |
void |
setComponentType(String componentType)
Sets the component type for this component. |
void |
setDefaultEventName(String defaultEventName)
|
void |
setDescription(String description)
Sets the description of this property. |
void |
setEventNames(String[] eventNames)
|
void |
setImplementationType(String implementationType)
|
void |
setJsComponentClass(String jsComponentClass)
Sets the Java Script component class for this component. |
void |
setLocalName(String localName)
Deprecated. remove when "ui" package is gone |
void |
setLongDescription(String longDescription)
Sets the long description of this property. |
void |
setNamingContainer(boolean namingContainer)
Sets the namingContainer flag of this property. |
void |
setNodeClass(String nodeClass)
Deprecated. remove when "ui" package is gone |
void |
setRendererType(String rendererType)
Sets the renderer type for this component. |
void |
setRequiredAncestorContracts(String[] requiredAncestorContracts)
Sets the possible values for this property. |
void |
setSatisfiedContracts(String[] satisfiedContracts)
Sets the possible values for this property. |
void |
setTagHandler(String tagHandler)
Sets the Facelets tag handler (component handler) this component. |
void |
setTagSuperclass(String tagSuperclass)
Sets the JSP tag handler superclass for this component. |
void |
setUnsupportedAgents(String[] unsupportedAgents)
Sets the unsupported agents for this component. |
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.AbstractTagBean |
---|
_parseModifier, accessibilityGuidelines, addAccessibilityGuideline, addExample, addScreenshot, examples, findExample, findScreenshot, getTagClass, getTagName, hasAccessibilityGuidelines, hasExamples, hasScreenshots, screenshots, setTagClass, setTagName |
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.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(String localName)
localName
- the local namepublic String getLocalName()
public void setNodeClass(String nodeClass)
nodeClass
- the node classpublic String getNodeClass()
public void setComponentType(String componentType)
componentType
- the component typepublic String getComponentType()
public void setComponentFamily(String componentFamily)
componentFamily
- the component familypublic String getComponentFamily()
public boolean hasComponentFamily()
public void setComponentClass(String componentClass)
componentClass
- the component classpublic String getComponentClass()
public void setJsComponentClass(String jsComponentClass)
jsComponentClass
- the JavaScript component classpublic String getJsComponentClass()
public void setDescription(String description)
setDescription
in class AbstractTagBean
description
- the property descriptionpublic String getDescription()
getDescription
in class AbstractTagBean
public void setLongDescription(String longDescription)
setLongDescription
in class AbstractTagBean
longDescription
- the long property descriptionpublic String getLongDescription()
getLongDescription
in class AbstractTagBean
public void setUnsupportedAgents(String[] unsupportedAgents)
unsupportedAgents
- the unsupported agentspublic String[] getUnsupportedAgents()
public void setTagSuperclass(String tagSuperclass)
tagSuperclass
- the JSP tag handler superclasspublic String getTagSuperclass()
public void setTagHandler(String tagHandler)
tagHandler
- the Facelets tag handler classpublic String getTagHandler()
public void setNamingContainer(boolean namingContainer)
namingContainer
- the component namingContainer flagpublic boolean isNamingContainer()
public boolean isClientBehaviorHolder()
public void setDefaultEventName(String defaultEventName)
public String getDefaultEventName()
public void setEventNames(String[] eventNames)
public String[] getEventNames()
public void parseEventNames(String value)
public void setComponentSupertype(String componentSupertype)
componentSupertype
- the component super typepublic String getComponentSupertype()
public void setComponentSuperclass(String componentSuperclass)
componentSuperclass
- the component super classpublic String getComponentSuperclass()
public void setRendererType(String rendererType)
rendererType
- the renderer typepublic String getRendererType()
public String getDefaultRendererType()
public String getImplementationType()
public void setImplementationType(String implementationType)
public void addProperty(PropertyBean property)
addProperty
in class AbstractTagBean
property
- the property to addpublic PropertyBean findProperty(String propertyName)
findProperty
in class AbstractTagBean
propertyName
- the property name to findpublic PropertyBean findProperty(String propertyName, boolean flatten)
propertyName
- the property name to findpublic boolean hasProperties()
hasProperties
in class AbstractTagBean
public boolean hasProperties(boolean flatten)
public Iterator<PropertyBean> properties()
properties
in class AbstractTagBean
public Iterator<PropertyBean> properties(boolean flatten)
flatten
- true if the iterator should be a combined list of
properties of this component and its supertype,
false otherwise
protected Map getFlattenedProperties()
public int propertiesSize()
propertiesSize
in class AbstractTagBean
public void addFacet(FacetBean facet)
facet
- the facet to addpublic FacetBean findFacet(String facetName)
facetName
- the facet name to findpublic FacetBean findFacet(String facetName, boolean flatten)
public boolean hasFacets()
public boolean hasFacets(boolean flatten)
public Iterator<FacetBean> facets()
public Iterator<FacetBean> facets(boolean flatten)
flatten
- true if the iterator should be a combined list of
facets of this component and its supertype,
false otherwise
protected Map getFlattenedFacets()
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(String modifier)
public void parseTagClassModifier(String modifier)
parseTagClassModifier
in class AbstractTagBean
public void parseUnsupportedAgents(String unsupportedAgents)
unsupportedAgents
- the unsupported agentspublic void parseSatisfiedContracts(String satisfiedContracts)
satisfiedContracts
- a space delimited string of satisifed contractspublic void setSatisfiedContracts(String[] satisfiedContracts)
satisfiedContracts
- a string array of the satisfied contractspublic Iterator<String> satisfiedContracts()
public boolean hasSatisfiedContracts()
public void parseRequiredAncestorContracts(String requiredAncestorContracts)
requiredAncestorContracts
- a space delimited string of required ancestor contractspublic void setRequiredAncestorContracts(String[] requiredAncestorContracts)
requiredAncestorContracts
- a string array of the required ancestor contractspublic Iterator<String> requiredAncestorContracts()
public boolean hasRequiredAncestorContracts()
public void addTagClassModifier(int modifier)
addTagClassModifier
in class AbstractTagBean
modifier
- the modifier to be addedpublic int getTagClassModifiers()
getTagClassModifiers
in class AbstractTagBean
public void addEvent(EventRefBean eventRef)
eventRef
- the event to addpublic boolean hasEvents()
public boolean hasEvents(boolean flatten)
public EventRefBean findEvent(String eventName)
eventName
- the event name to findpublic EventRefBean findEvent(String eventName, boolean flatten)
public Iterator<EventRefBean> events()
public Iterator<EventRefBean> events(boolean flatten)
flatten
- true if the iterator should be a combined list of
events of this component and its supertype,
false otherwise
public String findComponentFamily()
public ComponentBean findBehavioralComponent()
public String findRendererType()
public String findComponentSuperclass()
public String findJspTagSuperclass()
public ComponentBean resolveSupertype()
public boolean isTrinidadComponent()
protected String findComponentClass()
protected String findJspTagClass()
protected void attach(FacesConfigBean owner)
attach
in class ObjectBean
owner
- the faces config owner
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |