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:

This annotation should only be used in jsf 2.0 libraries.

Since:
1.0.4
Version:
$Revision: 941088 $ $Date: 2010-05-04 18:24:20 -0500 (Tue, 04 May 2010) $
Author:
Leonardo Uribe (latest modification by $Author: lu4242 $)

Optional Element Summary
 java.lang.String behaviorClass
          The name of the most near behavior class where all attributes should be inherited from this class
 java.lang.String bodyContent
          Indicate if the element accept inner elements or not.
 java.lang.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.
 java.lang.String converterClass
          The name of the most near converter class where all attributes should be inherited from this class
 java.lang.String desc
          Short description
 java.lang.String longDescription
          Long description.
 java.lang.String name
          The name of the component in a page (ex: x:mycomp).
 java.lang.String tagClass
          The name of the most near jsp tag class where all attributes should be inherited from this class
 java.lang.String validatorClass
          The name of the most near validator class where all attributes should be inherited from this class
 

bodyContent

public abstract java.lang.String bodyContent
Indicate if the element accept inner elements or not. (JSP or empty)

Since:
1.0.4
Default:
""

desc

public abstract java.lang.String desc
Short description

Since:
1.0.4
Default:
""

longDescription

public abstract java.lang.String longDescription
Long description. By default, it takes what is inside comment area.

Since:
1.0.4
Default:
""

name

public abstract java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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-2011 The Apache Software Foundation. All Rights Reserved.