Package org.richfaces.cdk.annotations

Java annotations used by the CDK.

See:
Description

Class Summary

Event.DEFAULT
Event.DEFAULT_LISTENER
JsfConverter.NONE	Default value for JsfConverter.forClass() attribute.
Signature.NONE
TagLibrary.NONE

Enum Summary

TagType	VDL type for Tag annotation.
TestType	Types of automatically generated tests.

Annotation Types Summary

Alias	Attribute aliases.
Attribute	Used to define Java class field or bean property getter method as JSF attribute.
Description	Object or attribute description.
Event	This annotation tells CDK to generate event-related classes: Event listener interface Event source interface Listener tag handler and wrapper to bind listener to the EL-expression.
EventName	Description of client-side event that can be associated with ClientBehavior.
Facet	Describes facet of UIComponent.
Function	This annotation defines static method or all public static methods in the annotated class as EL functions.
JsfBehavior	This annotation defines concrete class as JSF ClientBehavior, or abstract class as the base for generated Behavior implementation.
JsfBehaviorRenderer	Defines annotated class as JSF ClientBehaviorRenderer, or, if used in the JsfBehavior annotation, defines renderer type for ClientBehavior.
JsfComponent	That annotation marks class as JSF component.
JsfConverter	This annotation defines concrete class as JSF Converter, or abstract class as the base for generated Converter implementation.
JsfRenderer	This annotation defines concrete class as JSF Renderer, or abstract class as the base for generated Renderer implementation.
JsfValidator	This annotation defines concrete class as JSF Validator, or abstract class as the base for generated Validator implementation.
RendererSpecificComponent	That annotation defines third lvel component, specific for the concrete renderer, that is generated from the concrete class defined in the JsfComponent
Signature	This annotation defines a Java method signature for attributes that hold EL MethodExpression values.
Tag	Defines Faces VDL ( Facelets,JSP )tag.
TagLibrary	This annotation defines taglib for which all tags for JSF components from that packages belong to.
Test	Mark component class or method for automated testing.

Package org.richfaces.cdk.annotations Description

Java annotations used by the CDK.

Package-level annotations

TagLibrary defines library-wide parameters

Class-level annotations:

• @JsfComponent("component.Type") or @FacesComponent("component.Type").
• @JsfRenderer Defines JSF Renderer or link renderer with component.
• @JsfConverter Defines JSF Converter.
• @JsfValidator Defines JSF Validator.
• @JsfBehavior Defines JSF ClientBehavior.
• @JsfBehaviorRenderer Defines JSF ClientBehaviorRenderer or links renderer with behavior.
• @Event Defines JSF FacesEvent or links event with component that fires it.

Annotations used to refine class top level definitions

@Test tells CDK to generate unit test for component.

@Description optional IDE-related parameters.

@Tag VDL tag description.

@RendererSpecificComponent defines renderer specific component for the family created from one base component

@Description optional IDE-related parameters.

Attribute level annotations ( for getter or field level ):

• @Attribute Defines Faces attribute, used on for attribute getter method or field.
• @Facet for facet getter. Also, used in JsfComponent facets property.
• @Function, Used for public static methods to define them as EL-functions.

Annotations used to refine method-level properties

• @Signature defines Java method signature for attributes that holds MethodExpression objects.
• @Alias defines alias for attribute.
• @EventName(value="click",defaultEvent=true) defines behavior event name for that attribute.
• @Description optional IDE-related description.

Facet annotations.

There are two methods to define component facet. At the class level, developer could use @JsfComponent.facets() property. It is also possible to define facet getter/setter methods for facet and mark one of them with @Facet annotation.