Top Description Methods
javax.faces.render

public @Interface FacesRenderer

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
@Inherited
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target, .Inherited

The presence of this annotation on a class automatically registers the class with the runtime as a Renderer. The value of the renderKitId attribute is taken to be the render-kit-id to which an instance of this Renderer is to be added. There must be a public zero-argument constructor on any class where this annotation appears. The implementation must indicate a fatal error if such a constructor does not exist and the application must not be placed in service. Within that RenderKit, The value of the rendererType attribute is taken to be the renderer-type, and the value of the componentFamily attribute is to be taken as the component-family. The implementation must guarantee that for each class annotated with FacesRenderer, found with the algorithm in section JSF.11.5, the following actions are taken.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the component-family
componentFamily
()

The value of this annotation attribute is taken to be the component-family which, in combination with rendererType can be used to obtain a reference to an instance of this Renderer by calling javax.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String).

public String

Returns:

the renderer-type
rendererType
()

The value of this annotation attribute is taken to be the renderer-type which, in combination with componentFamily can be used to obtain a reference to an instance of this Renderer by calling javax.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String).

public String

Returns:

the render-kit-id
renderKitId
()

The value of this annotation attribute is taken to be the render-kit-id in which an instance of this class of Renderer must be installed.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

componentFamilyback to summary
public String componentFamily()

The value of this annotation attribute is taken to be the component-family which, in combination with rendererType can be used to obtain a reference to an instance of this Renderer by calling javax.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String).

Returns:String

the component-family

rendererTypeback to summary
public String rendererType()

The value of this annotation attribute is taken to be the renderer-type which, in combination with componentFamily can be used to obtain a reference to an instance of this Renderer by calling javax.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String).

Returns:String

the renderer-type

renderKitIdback to summary
public String renderKitId()

The value of this annotation attribute is taken to be the render-kit-id in which an instance of this class of Renderer must be installed.

Returns:String

the render-kit-id