org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse
Class AbstractTagBean

java.lang.Object
  extended by org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.ObjectBean
      extended by org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.AbstractTagBean
Direct Known Subclasses:
ComponentBean, ConverterBean, ValidatorBean

public class AbstractTagBean
extends ObjectBean


Field Summary
protected  Map<String,PropertyBean> _properties
           
 
Constructor Summary
AbstractTagBean()
           
AbstractTagBean(boolean isComponentBean)
           
 
Method Summary
protected  int _parseModifier(String text)
           
 Iterator<String> accessibilityGuidelines()
          Returns an iterator for all accessibility guidelines on this component only.
 void addAccessibilityGuideline(String accessibilityGuideline)
          Adds an Accessibility (e.g.
 void addExample(ExampleBean example)
          Adds a Example to this component.
 void addProperty(PropertyBean property)
          Adds a property to this component.
 void addScreenshot(ScreenshotBean screenshot)
          Adds a Screenshot to this component.
 void addTagClassModifier(int modifier)
          Adds a Java Language class modifier to the tag class.
 Iterator<ExampleBean> examples()
          Returns an iterator for all examples on this component only.
 ExampleBean findExample(String key)
          Returns the example for this example key.
 PropertyBean findProperty(String propertyName)
          Returns the property for this property name.
 ScreenshotBean findScreenshot(String key)
          Returns the screenshot for this screenshot key.
 String getDescription()
          Returns the description of this property.
 String getLongDescription()
          Returns the long description of this property.
 String getTagClass()
          Returns the JSP tag handler class for this component.
 int getTagClassModifiers()
          Returns the Java Language class modifiers for the tag class.
 QName getTagName()
          Returns the JSP tag name for this component.
 boolean hasAccessibilityGuidelines()
          Returns true if this component has any accessibility guidelines.
 boolean hasExamples()
          Returns true if this component has any examples.
 boolean hasProperties()
          Returns true if this component has any properties.
 boolean hasScreenshots()
          Returns true if this component has any screenshots.
 void parseTagClassModifier(String modifier)
           
 Iterator<PropertyBean> properties()
          Returns an iterator for all properties on this component only.
 int propertiesSize()
          Number of properties for this component
 Iterator<ScreenshotBean> screenshots()
          Returns an iterator for all screenshots on this component only.
 void setDescription(String description)
          Sets the description of this property.
 void setLongDescription(String longDescription)
          Sets the long description of this property.
 void setTagClass(String tagClass)
          Sets the JSP tag handler class for this component.
 void setTagName(QName tagName)
          Sets the JSP tag name for this component.
 
Methods inherited from class org.apache.myfaces.buildtools.maven2.plugin.builder.trinidad.parse.ObjectBean
attach, getOwner, isModifiedSince
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_properties

protected Map<String,PropertyBean> _properties
Constructor Detail

AbstractTagBean

public AbstractTagBean()

AbstractTagBean

public AbstractTagBean(boolean isComponentBean)
Method Detail

setDescription

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

Parameters:
description - the property description

getDescription

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

Returns:
the property description

setLongDescription

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

Parameters:
longDescription - the long property description

getLongDescription

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

Returns:
the long property description

setTagClass

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

Parameters:
tagClass - the JSP tag handler class

getTagClass

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

Returns:
the JSP tag handler class

setTagName

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

Parameters:
tagName - the JSP tag name

getTagName

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

Returns:
the JSP tag name

addProperty

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

Parameters:
property - the property to add

findProperty

public PropertyBean findProperty(String propertyName)
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

properties

public Iterator<PropertyBean> properties()
Returns an iterator for all properties on this component only.

Returns:
the property iterator

addExample

public void addExample(ExampleBean example)
Adds a Example to this component.

Parameters:
example - the example to add

hasExamples

public boolean hasExamples()
Returns true if this component has any examples.

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

findExample

public ExampleBean findExample(String key)
Returns the example for this example key.

Parameters:
key - the hashmap example key

examples

public Iterator<ExampleBean> examples()
Returns an iterator for all examples on this component only.

Returns:
the example iterator

addScreenshot

public void addScreenshot(ScreenshotBean screenshot)
Adds a Screenshot to this component.

Parameters:
screenshot - the screenshot to add

hasScreenshots

public boolean hasScreenshots()
Returns true if this component has any screenshots.

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

findScreenshot

public ScreenshotBean findScreenshot(String key)
Returns the screenshot for this screenshot key.

Parameters:
key - the hashmap screenshot key

screenshots

public Iterator<ScreenshotBean> screenshots()
Returns an iterator for all screenshots on this component only.

Returns:
the screenshot iterator

addAccessibilityGuideline

public void addAccessibilityGuideline(String accessibilityGuideline)
Adds an Accessibility (e.g. section 508 compliance) Guideline to this component. The accessibility guidelines are used during tag doc generation to give the application developer hints on how to configure the component to be accessibility-compliant.

Parameters:
accessibilityGuideline - the accessibility guideline to add

hasAccessibilityGuidelines

public boolean hasAccessibilityGuidelines()
Returns true if this component has any accessibility guidelines.

Returns:
true if this component has any accessibility guidelines, false otherwise

accessibilityGuidelines

public Iterator<String> accessibilityGuidelines()
Returns an iterator for all accessibility guidelines on this component only.

Returns:
the accessibility guidelines iterator

parseTagClassModifier

public void parseTagClassModifier(String modifier)

_parseModifier

protected int _parseModifier(String text)

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

propertiesSize

public int propertiesSize()
Number of properties for this component

Returns:
num of properties


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