org.apache.myfaces.buildtools.maven2.plugin.faces.parse
Class ComponentBean

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.faces.parse.ObjectBean
      extended by org.apache.myfaces.buildtools.maven2.plugin.faces.parse.ComponentBean

public class ComponentBean
extends ObjectBean

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

ComponentBean

public ComponentBean()
Creates a new ComponentBean.

Method Detail

setLocalName

public void setLocalName(java.lang.String localName)
Deprecated. remove when "ui" package is gone

Sets the UIX2 local name for this component.

Parameters:
localName - the local name

getLocalName

public java.lang.String getLocalName()
Returns the UIX2 local name for this component.

Returns:
the local name

setNodeClass

public void setNodeClass(java.lang.String nodeClass)
Deprecated. remove when "ui" package is gone

Sets the UIX2 node class for this component.

Parameters:
nodeClass - the node class

getNodeClass

public java.lang.String getNodeClass()
Returns the UIX2 node class for this component.

Returns:
the node class

setComponentType

public void setComponentType(java.lang.String componentType)
Sets the component type for this component.

Parameters:
componentType - the component type

getComponentType

public java.lang.String getComponentType()
Returns the component type for this component.

Returns:
the component type

setComponentFamily

public void setComponentFamily(java.lang.String componentFamily)
Sets the component family for this component.

Parameters:
componentFamily - the component family

getComponentFamily

public java.lang.String getComponentFamily()
Returns the component family for this component.

Returns:
the component family

hasComponentFamily

public boolean hasComponentFamily()
Returns true if the component family exists for this component.

Returns:
true if the component family exists, false otherwise

setComponentClass

public void setComponentClass(java.lang.String componentClass)
Sets the component class for this component.

Parameters:
componentClass - the component class

getComponentClass

public java.lang.String getComponentClass()
Returns the component class for this component.

Returns:
the component class

setDescription

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

Parameters:
description - the property description

getDescription

public java.lang.String getDescription()
Returns the description of this property.

Returns:
the property description

setLongDescription

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

Parameters:
longDescription - the long property description

getLongDescription

public java.lang.String getLongDescription()
Returns the long description of this property.

Returns:
the long property description

setTagClass

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

Parameters:
tagClass - the JSP tag handler class

setUnsupportedAgents

public void setUnsupportedAgents(java.lang.String[] unsupportedAgents)
Sets the unsupported agents for this component.

Parameters:
unsupportedAgents - the unsupported agents

getUnsupportedAgents

public java.lang.String[] getUnsupportedAgents()
Returns unsupported agents for this component.

Returns:
the unsupported agents

getTagClass

public java.lang.String getTagClass()
Returns the JSP tag handler class for this component.

Returns:
the JSP tag handler class

setTagSuperclass

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

Parameters:
tagSuperclass - the JSP tag handler superclass

getTagSuperclass

public java.lang.String getTagSuperclass()
Returns the JSP tag handler superclass for this component.

Returns:
the JSP tag handler superclass

setTagHandler

public void setTagHandler(java.lang.String tagHandler)
Sets the Facelets tag handler (component handler) this component.

Parameters:
tagHandler - the Facelets tag handler class

getTagHandler

public java.lang.String getTagHandler()
Returns the Facelets tag handler for this component

Returns:
the Facelets tag handler

getTagName

public javax.xml.namespace.QName getTagName()
Returns the JSP tag name for this component.

Returns:
the JSP tag name

setTagName

public void setTagName(javax.xml.namespace.QName tagName)
Sets the JSP tag name for this component.

Parameters:
tagName - the JSP tag name

setNamingContainer

public void setNamingContainer(boolean namingContainer)
Sets the namingContainer flag of this property.

Parameters:
namingContainer - the component namingContainer flag

isNamingContainer

public boolean isNamingContainer()
Returns namingContainer flag of this component.

Returns:
the component namingContainer flag

setComponentSupertype

public void setComponentSupertype(java.lang.String componentSupertype)
Sets the component supertype for this component.

Parameters:
componentSupertype - the component super type

getComponentSupertype

public java.lang.String getComponentSupertype()
Returns the component supertype for this component.

Returns:
the component supertype

setComponentSuperclass

public void setComponentSuperclass(java.lang.String componentSuperclass)
Sets the component super class for this component.

Parameters:
componentSuperclass - the component super class

getComponentSuperclass

public java.lang.String getComponentSuperclass()
Returns the component super class for this component.

Returns:
the component super class

setRendererType

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

Parameters:
rendererType - the renderer type

getRendererType

public java.lang.String getRendererType()
Returns the renderer type for this component.

Returns:
the renderer type

getDefaultRendererType

public java.lang.String getDefaultRendererType()
Returns the default renderer type for this component.

Returns:
the default renderer type

getImplementationType

public java.lang.String getImplementationType()

setImplementationType

public void setImplementationType(java.lang.String implementationType)

addProperty

public void addProperty(PropertyBean property)
Adds a property to this component.

Parameters:
property - the property to add

findProperty

public PropertyBean findProperty(java.lang.String propertyName)
Returns the property for this property name.

Parameters:
propertyName - the property name to find

findProperty

public PropertyBean findProperty(java.lang.String propertyName,
                                 boolean flatten)
Returns the property for this property name.

Parameters:
propertyName - the property name to find

hasProperties

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

Returns:
true if this component has any properties, false otherwise

hasProperties

public boolean hasProperties(boolean flatten)
Returns true if this component or any component supertype has any properties.

Returns:
true if this component or any supertype has any properties, false otherwise

properties

public java.util.Iterator properties()
Returns an iterator for all properties on this component only.

Returns:
the property iterator

properties

public java.util.Iterator properties(boolean flatten)
Returns an iterator for properties on this component.

Parameters:
flatten - true if the iterator should be a combined list of properties of this component and its supertype, false otherwise
Returns:
the property iterator

propertiesSize

public int propertiesSize()
Number of properties for this component

Returns:
num of properties

addFacet

public void addFacet(FacetBean facet)
Adds a facet to this component.

Parameters:
facet - the facet to add

findFacet

public FacetBean findFacet(java.lang.String facetName)
Returns the facet for this facet name.

Parameters:
facetName - the facet name to find

findFacet

public FacetBean findFacet(java.lang.String facetName,
                           boolean flatten)

hasFacets

public boolean hasFacets()
Returns true if this component has any facets.

Returns:
true if this component has any facets, false otherwise

hasFacets

public boolean hasFacets(boolean flatten)
Returns true if this component or any component supertype has any facets.

Returns:
true if this component or any supertype has any facets, false otherwise

facets

public java.util.Iterator facets()
Returns an iterator for all facets on this component only.

Returns:
the facet iterator

facets

public java.util.Iterator facets(boolean flatten)
Returns an iterator for facets on this component.

Parameters:
flatten - true if the iterator should be a combined list of facets of this component and its supertype, false otherwise
Returns:
the facet iterator

setChildren

public void setChildren(boolean children)
Specifies if the component can have children.

Parameters:
children - true if the component can have children. false otherwise

hasChildren

public boolean hasChildren()
Returns true if the component can have children.

Returns:
true if the component can have children. false otherwise

addComponentClassModifier

public void addComponentClassModifier(int modifier)
Adds a Java Language class modifier to the component class.

Parameters:
modifier - the modifier to be added

getComponentClassModifiers

public int getComponentClassModifiers()
Returns the Java Language class modifiers for the component class. By default, these modifiers include Modifier.PUBLIC.

Returns:
the Java Language class modifiers for the component class

parseComponentClassModifier

public void parseComponentClassModifier(java.lang.String modifier)

parseTagClassModifier

public void parseTagClassModifier(java.lang.String modifier)

parseUnsupportedAgents

public void parseUnsupportedAgents(java.lang.String unsupportedAgents)
Parses the unsupported agents for this component into a String array using space as the separator between values.

Parameters:
unsupportedAgents - the unsupported agents

addTagClassModifier

public void addTagClassModifier(int modifier)
Adds a Java Language class modifier to the tag class.

Parameters:
modifier - the modifier to be added

getTagClassModifiers

public int getTagClassModifiers()
Returns the Java Language class modifiers for the tag class. By default, these modifiers include Modifier.PUBLIC.

Returns:
the Java Language class modifiers for the tag class

addEvent

public void addEvent(EventRefBean eventRef)
Adds an event to this component.

Parameters:
eventRef - the event to add

hasEvents

public boolean hasEvents()
Returns true if this component has any events.

Returns:
true if this component has any events, false otherwise

hasEvents

public boolean hasEvents(boolean flatten)
Returns true if this component or any component supertype has any events.

Returns:
true if this component or any supertype has any events, false otherwise

findEvent

public EventBean findEvent(java.lang.String eventName)
Returns the event for this event name.

Parameters:
eventName - the event name to find

findEvent

public EventBean findEvent(java.lang.String eventName,
                           boolean flatten)

events

public java.util.Iterator events()
Returns an iterator for all events on this component only.

Returns:
the event iterator

events

public java.util.Iterator events(boolean flatten)
Returns an iterator for events on this component.

Parameters:
flatten - true if the iterator should be a combined list of events of this component and its supertype, false otherwise
Returns:
the event iterator

findComponentFamily

public java.lang.String findComponentFamily()
Finds the component family in the component inheritance hierarchy.

Returns:
the component family

findBehavioralComponent

public ComponentBean findBehavioralComponent()
Finds the behavioral component component inheritance hierarchy.

Returns:
the behavioral component

findRendererType

public java.lang.String findRendererType()
Finds the renderer type in the component inheritance hierarchy.

Returns:
the renderer type

findComponentSuperclass

public java.lang.String findComponentSuperclass()
Finds the component superclass in the component inheritance hierarchy.

Returns:
the component superclass

findJspTagSuperclass

public java.lang.String findJspTagSuperclass()
Finds the tag superclass in the component inheritance hierarchy.

Returns:
the tag superclass

resolveSupertype

public ComponentBean resolveSupertype()
Returns the component supertype instance.

Returns:
the component supertype instance

isTrinidadComponent

public boolean isTrinidadComponent()
Checks if any of the component superclasses is UIXComponentBase


findComponentClass

protected java.lang.String findComponentClass()
Finds the component class in the component inheritance hierarchy.

Returns:
the component class

findJspTagClass

protected java.lang.String findJspTagClass()
Finds the tag class in the component inheritance hierarchy.

Returns:
the tag class

attach

protected void attach(FacesConfigBean owner)
Attaches the component and all event references.

Overrides:
attach in class ObjectBean
Parameters:
owner - the faces config owner

setComponentClassExcluded

public void setComponentClassExcluded(boolean componentClassExcluded)

isComponentClassExcluded

public boolean isComponentClassExcluded()

setTagClassExcluded

public void setTagClassExcluded(boolean tagClassExcluded)

isTagClassExcluded

public boolean isTagClassExcluded()

setComponentImplements

public void setComponentImplements(java.lang.String _implements)

getComponentImplements

public java.lang.String getComponentImplements()

setComponentSerialUID

public void setComponentSerialUID(java.lang.String _componentSerialUID)

getComponentSerialUID

public java.lang.String getComponentSerialUID()


Copyright © 2001-2009 Apache Software Foundation. All Rights Reserved.