org.apache.myfaces.buildtools.maven2.plugin.builder.annotation
Annotation Type JSFFaceletTag
@Documented
@Target(value=TYPE)
@Retention(value=SOURCE)
public @interface JSFFaceletTag
Used to define a jsf facelet tag handler.
The intention of this annotation is use its information to generate a
facelet taglib xml file(optional), and create a specific
facelet documentation (generate alternate .tld files and use
maven-taglib-plugin on these files).
In order to do that, this annotation has multiple use cases:
- Define a component only available on facelets.
- When a component has additional properties only available on facelets.
In this case, we set componentClass/converterClass/validatorClass/tagClass attribute.
The effect is that all properties and descriptions are flattened to this class. In other
words, when the documentation of the annotated facelet tag handler is generated,
this information precedes the one pointed by the annotation. This only happens when
name attribute match.
- When a component does not have an specific tag handler, so we can create
a dummy tag handler, annotate it and set configExcluded=true, so we can
document it instead put this information on the base tld used to generate.
This is the case of h:outputScript or h:outputStylesheet
This annotation should only be used in jsf 2.0 libraries.
- Since:
- 1.0.4
- Version:
- $Revision: 941088 $ $Date: 2010-05-05 01:24:20 +0200 (Wed, 05 May 2010) $
- Author:
- Leonardo Uribe (latest modification by $Author: lu4242 $)
Optional Element Summary |
String |
behaviorClass
The name of the most near behavior class where all
attributes should be inherited from this class |
String |
bodyContent
Indicate if the element accept inner elements or not. |
String |
componentClass
The name of the most near component class where all
attributes should be inherited from this class |
boolean |
configExcluded
Indicate that this facelet tag handler should not be defined
on facelets taglib xml file. |
String |
converterClass
The name of the most near converter class where all
attributes should be inherited from this class |
String |
desc
Short description |
String |
longDescription
Long description. |
String |
name
The name of the component in a page (ex: x:mycomp). |
String |
tagClass
The name of the most near jsp tag class where all
attributes should be inherited from this class |
String |
validatorClass
The name of the most near validator class where all
attributes should be inherited from this class |
bodyContent
public abstract String bodyContent
- Indicate if the element accept inner elements or not. (JSP or empty)
- Since:
- 1.0.4
- Default:
- ""
desc
public abstract String desc
- Short description
- Since:
- 1.0.4
- Default:
- ""
longDescription
public abstract String longDescription
- Long description. By default, it takes what is inside comment area.
- Since:
- 1.0.4
- Default:
- ""
name
public abstract String name
- The name of the component in a page (ex: x:mycomp).
- Since:
- 1.0.4
- Default:
- ""
configExcluded
public abstract boolean configExcluded
- Indicate that this facelet tag handler should not be defined
on facelets taglib xml file.
Note that for some libraries a xml file is not generated
(like in core 2.0), instead a library class is defined,
so in those cases set this value has no effect.
- Since:
- 1.0.4
- Default:
- false
tagClass
public abstract String tagClass
- The name of the most near jsp tag class where all
attributes should be inherited from this class
- Since:
- 1.0.4
- Default:
- ""
componentClass
public abstract String componentClass
- The name of the most near component class where all
attributes should be inherited from this class
- Since:
- 1.0.4
- Default:
- ""
converterClass
public abstract String converterClass
- The name of the most near converter class where all
attributes should be inherited from this class
- Since:
- 1.0.4
- Default:
- ""
validatorClass
public abstract String validatorClass
- The name of the most near validator class where all
attributes should be inherited from this class
- Since:
- 1.0.4
- Default:
- ""
behaviorClass
public abstract String behaviorClass
- The name of the most near behavior class where all
attributes should be inherited from this class
- Since:
- 1.0.5
- Default:
- ""
Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.