-
@Retention(value=RUNTIME) @Target(value=TYPE) @Inherited public @interface FacesRenderer
The presence of this annotation on a class automatically registers the class with the runtime as a
Renderer
. The value of therenderKitId()
attribute is taken to be the render-kit-id to which an instance of thisRenderer
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 thatRenderKit
, The value of therendererType()
attribute is taken to be the renderer-type, and the value of thecomponentFamily()
attribute is to be taken as the component-family. The implementation must guarantee that for each class annotated withFacesRenderer
, found with the algorithm in section JSF.11.5, 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 aRenderKit
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.addRenderer(java.lang.String, java.lang.String, javax.faces.render.Renderer)
on renderKit, passing component-family as the first argument, renderer-type as the second, and the newly instantiatedRenderKit
instance as the third argument.
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description 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 thisRenderer
by callingRenderKit.getRenderer(java.lang.String, java.lang.String)
.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 thisRenderer
by callingRenderKit.getRenderer(java.lang.String, java.lang.String)
.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and 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 Detail
-
rendererType
public abstract 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 thisRenderer
by callingRenderKit.getRenderer(java.lang.String, java.lang.String)
.
-
-
-
componentFamily
public abstract 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 thisRenderer
by callingRenderKit.getRenderer(java.lang.String, java.lang.String)
.
-
-
-
renderKitId
public abstract 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.- Default:
- "HTML_BASIC"
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/faces/render/FacesRenderer.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.