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

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.FacetBean

public class FacetBean
extends ObjectBean

FacetBean is a Java representation of the faces-config component or renderer facet XML element.


Constructor Summary
FacetBean()
           
 
Method Summary
 Iterator<String> accessibilityGuidelines()
          Returns an iterator for all accessibility guidelines on this component only.
 void addAccessibilityGuideline(String accessibilityGuideline)
          Adds an Accessibility (e.g.
 Iterator<String> allowedChildComponents()
          Returns the allowed child components for this facet.
 String getDescription()
          Returns the description of this property.
 String getFacetName()
          Returns the facet name for this facet.
 boolean hasAccessibilityGuidelines()
          Returns true if this component has any accessibility guidelines.
 boolean hasAllowedChildComponents()
          Returns true if this component has any allowed child components.
 boolean isHidden()
          If the facet should be hidden from documentation
 boolean isRequired()
          Returns required flag of this facet.
 void parseAllowedChildComponents(String allowedChildComponents)
          Parses the string of allowed child class names into a String array using space as the separator between values.
 void setAllowedChildComponents(String[] allowedChildComponents)
          Sets the possible values for this property.
 void setDescription(String description)
          Sets the description of this property.
 void setFacetName(String facetName)
          Sets the facet name for this facet.
 void setHidden(boolean hidden)
          Set if this facet should be hidden from documentation
 void setRequired(boolean required)
          Sets the required flag of this facet.
 
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
 

Constructor Detail

FacetBean

public FacetBean()
Method Detail

setFacetName

public void setFacetName(String facetName)
Sets the facet name for this facet.

Parameters:
facetName - the facet name

getFacetName

public String getFacetName()
Returns the facet name for this facet.

Returns:
the facet name

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

setRequired

public void setRequired(boolean required)
Sets the required flag of this facet.

Parameters:
required - the facet required flag

isRequired

public boolean isRequired()
Returns required flag of this facet.

Returns:
the facet required flag

isHidden

public boolean isHidden()
If the facet should be hidden from documentation

Returns:
If the facet should be hidden

setHidden

public void setHidden(boolean hidden)
Set if this facet should be hidden from documentation

Parameters:
hidden - If the facet should be hidden

addAccessibilityGuideline

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

Parameters:
accGuidelines - 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

parseAllowedChildComponents

public void parseAllowedChildComponents(String allowedChildComponents)
Parses the string of allowed child class names into a String array using space as the separator between values. In the component metadata file, the allowed child components are denoted with allowed-child-components markup. As an example, oracle.adf.RichMenu is an allowed child component of af:panelCollection's (oracle.adf.view.rich.component.rich.output.RichPanelCollection) menu facet. The allowed child components of one component are matched with the component type attribute of other components to determine which child tags are allowed in the component hierarchy.

Parameters:
allowedChildComponents - a space delimited string of allowed child component class names

setAllowedChildComponents

public void setAllowedChildComponents(String[] allowedChildComponents)
Sets the possible values for this property. In the component metadata file, the allowed child components are denoted with allowed-child-components markup. As an example, oracle.adf.RichMenu is an allowed child component of af:panelCollection's (oracle.adf.view.rich.component.rich.output.RichPanelCollection) menu facet. The allowed child components of one component are matched with the component type attribute of other components to determine which child tags are allowed in the component hierarchy.

Parameters:
allowedChildComponents - a string array of the allowed child component class names

allowedChildComponents

public Iterator<String> allowedChildComponents()
Returns the allowed child components for this facet. In the component metadata file, the allowed child components are denoted with allowed-child-components markup. As an example, oracle.adf.RichMenu is an allowed child component of af:panelCollection's (oracle.adf.view.rich.component.rich.output.RichPanelCollection) menu facet. The allowed child components of one component are matched with the component type attribute of other components to determine which child tags are allowed in the component hierarchy.

Returns:
an iterator of allowed child component class name strings

hasAllowedChildComponents

public boolean hasAllowedChildComponents()
Returns true if this component has any allowed child components.

Returns:
true if this component has any allowed child components, false otherwise


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