Package org.richfaces.cdk.annotations

Java annotations used by the CDK.

See:
Description

Class Summary

JsfConverter.NONE
Signature.NONE
TagLibrary.NONE

Enum Summary

TagType
TestType	Types of automatically generated tests.

Annotation Types Summary

Alias	Attribute aliases.
Attribute
Description	Description used that would be used in IDE to display.
Event	This annotation tells CDK to generate event-related classes: Event listener interface Event source interface Event tag handler and binding wrapper.
EventName
Facet
Function	This annotation defines static method or all public static methods in the annotated class as EL functions.
JsfBehavior
JsfBehaviorRenderer
JsfComponent	That annotation marks class as JSF component.
JsfConverter
JsfRenderer	The presence of this annotation in the JSF component class associated particular renderer with component.
JsfValidator
RendererSpecificComponent	That annotation defines class 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
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.

Class-level annotations:

Mandatory:

@JsfComponent("component.Type") or @javax.faces.component.FacesComponent("component.Type").

Optional:

• @Family("component.Family") defines component family used in the generated class.
  
• @Generate("component.UIClass") tells CDK to generate concrete component class ( base UI... or renderer-specific ).
• @Test(testClass="component.Test",testMethod="testFoo",testType=TestType.DECODE) tells CDK to generate unit test for that component.
• @JsfRenderer("retnderer.Type") , @RendererTemplate("/renderer/template.xml") associate renderer with that component. The first one defines independently created renderer, while @RendererTemplate tells CDK to generate renderer class from that template. It is possible to define more than one template with component class using @{@link RendererTemplates}({@{@link RendererTemplate}("one.xml"),@{@link RendererTemplate}("two.xml").
  
• @{@link Attributes}({"base.xml","command.xml"}) defines fragments of faces-config.xml which contain standart attributes definitions. CDK also tries to read META-INF/cdk/attributes/[classname].xml file for all component superclasses and interfaces, therefore it is not necessary to explicit include definitions for UIComponent and any other standard JSF classes. CDK defines couple of its own "urn" namespaces: "urn:resource:" for classpath resources, "urn:config:" for for project configuration folder and "urn:attributes:" for META-INF/cdk/attributes/ in the annotations library.
  
• @{@link Fires}({MyEvent.class}) defines event classes that this component could fire.
• @{@link Description} , @{@link DisplayName} - optional IDE-related parameters.
  

Attribute level annotations ( for getter or setter level ):

• @{@link Attribute}(literal="false",hidden="false",readOnly="false",passTrough="true") markes attribute getter/setter.
• @{@link Signature}(returnType=boolean.class,parameters={Object.class,String.class}) defines Java method signature for attributes that holds MethodExpression objects.
• @{@link Generate} forces CDK to generate attribute getter/setter. Without that annotation CDK will generate implementation for abstract methods only.
• @{@link Alias}({"foo","bar"})
• @{@link EventName}(value="click",defaultEvent=true) defines behavior event name for that attribute. To define more than one event name they could be grouped as @{@link EventNames}({@{@link EventName}("foo),@{@link EventName}("bar")})
• @{@link DefaultValue}("12"), @{@link SuggestedValue}("12") ...
• @{@link Description} , @{@link DisplayName} - optional IDE-related parameters.

Facet annotations.

There are two methods to define component facet. At the class level, developer could use @{@link Facets annotations. It is also possible to define facet getter/setter methods for facet and mark one of them with @{@link Facet} annotation.