org.richfaces.cdk.annotations
Annotation Type JsfComponent

@Retention(value=SOURCE)
@Target(value=TYPE)
public @interface JsfComponent

That annotation marks class as JSF component. The difference with JSF 2.0 @ FacesComponent annotation is what this one could marks abstract class from which a real UI-component implementation will be generated.

Author:

asmirnov@exadel.com

Optional Element Summary

String[]	attributes Defines file names for fragment of faces-config.xml that contain standard attribute definitions.
RendererSpecificComponent[]	components Defines third-level renderer specific components.
Description	description Component description to include into generated faces-config and taglib.
Facet[]	facets Component facets.
String	family Component family.
Event[]	fires
String	generate Name of the generated component implementation class.
Class<?>[]	interfaces Interfaces that should be implemented by the generated component class.
JsfRenderer	renderer JsfRenderer associated with this component.
Tag[]	tag Tag description.
Test	test Junit test description.
String	type Type of the JSF component.

type

public abstract String type

Type of the JSF component.

if this value is an empty, component type would be inferred from class name.

Returns:

component type.

Default:

""

family

public abstract String family

Component family. For default value, it could be got from the COMPONENT_FAMILY constant or by inferred naming conventions.

Returns:

Default:

""

generate

public abstract String generate

Name of the generated component implementation class. Default value means nothing to genrate from concrete class, or infer name by convention for abstract class.

Returns:

Default:

""

description

public abstract Description description

Component description to include into generated faces-config and taglib.

Returns:

Default:

@org.richfaces.cdk.annotations.Description

test

public abstract Test test

Junit test description. Isn't used in RichFaces 4.0, reserved for future releases.

Returns:

Default:

@org.richfaces.cdk.annotations.Test(testClass="")

renderer

public abstract JsfRenderer renderer

JsfRenderer associated with this component.

Returns:

Default:

@org.richfaces.cdk.annotations.JsfRenderer

tag

public abstract Tag[] tag

Tag description. If generated tags require special handlers, provide separate description for every type of tag, JSP and Facelets. Otherwise, the only one tag tag description with name and type TagType.All.

Returns:

Default:

{}

fires

public abstract Event[] fires

Returns:

Default:

{}

facets

public abstract Facet[] facets

Component facets.

Returns:

Default:

{}

attributes

public abstract String[] attributes

Defines file names for fragment of faces-config.xml that contain standard attribute definitions. All names relative to the META-INF/cdk/attributes/ folder in classpath. CDK also tries to read META-INF/cdk/attributes/[classname].xml file for all component superclasses and interfaces. Therefore, it is not necessary to explicitly include definitions for UIComponent and any other standard JSF classes.

Returns:

Default:

{}

interfaces

public abstract Class<?>[] interfaces

Interfaces that should be implemented by the generated component class. CDK processes all Attribute and Facet annotations in these interfaces

Returns:

Default:

{}

components

public abstract RendererSpecificComponent[] components

Defines third-level renderer specific components. Used to generate a whole family of similar components. For example, UIComponentBase provides UICommand subclass for all command components, and javax.faces.component.html.HtmlCommandLink with javax.faces.component.HtmlCommandButton are renderer-specific components for links and buttons.

Returns:

Default:

{}