Module jakarta.faces

Package jakarta.faces.render

Annotation Interface FacesBehaviorRenderer

@Retention(RUNTIME)
@Target(TYPE)
@Inherited
public @interface FacesBehaviorRenderer

The presence of this annotation on a class automatically registers the class with the runtime as a ClientBehaviorRenderer. 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 The implementation must guarantee that for each class annotated with FacesBehaviorRenderer, found with the algorithm in section 11.4 "Annotations that correspond to and may take the place of entries in the Application Configuration Resources" of the Jakarta Faces Specification Document, the following actions are taken.

• Obtain a reference to the RenderKitFactory for this application.

• See if a RenderKit exists for render-kit-id. If so, let that instance be renderKit for discussion. If not, the implementation must indicate a fatal error if such a RenderKit does not exist and the application must not be placed in service.

• Create an instance of this class using the public zero-argument constructor.

• Call RenderKit.addClientBehaviorRenderer(java.lang.String, jakarta.faces.render.ClientBehaviorRenderer) on renderKit, passing type as the first argument, and a ClientBehaviorRenderer instance as the second argument.

Since:

2.0

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	rendererType	Within the RenderKit, the value of this annotation attribute is taken to be the renderer-type

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
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.

Element Details

renderKitId

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:

the render-kit-id

Since:

2.0

Default:

"HTML_BASIC"

rendererType

String rendererType

Within the RenderKit, the value of this annotation attribute is taken to be the renderer-type

Returns:

the renderer-type