Package jakarta.faces.render
Class Renderer<T extends UIComponent>
- java.lang.Object
- 
- jakarta.faces.render.Renderer<T>
 
- 
- Direct Known Subclasses:
- RendererWrapper
 
 public abstract class Renderer<T extends UIComponent> extends Object see Javadoc of Faces Specification
- 
- 
Field SummaryFields Modifier and Type Field Description static StringPASSTHROUGH_RENDERER_LOCALNAME_KEY
 - 
Constructor SummaryConstructors Constructor Description Renderer()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description StringconvertClientId(FacesContext context, String clientId)voiddecode(FacesContext context, T component)voidencodeBegin(FacesContext context, T component)voidencodeChildren(FacesContext context, T component)Render all children if there are any.voidencodeEnd(FacesContext context, T component)ObjectgetConvertedValue(FacesContext context, UIComponent component, Object submittedValue)booleangetRendersChildren()Switch for deciding who renders the children.
 
- 
- 
- 
Field Detail- 
PASSTHROUGH_RENDERER_LOCALNAME_KEYpublic static final String PASSTHROUGH_RENDERER_LOCALNAME_KEY - Since:
- 2.2
- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
decodepublic void decode(FacesContext context, T component) 
 - 
encodeBeginpublic void encodeBegin(FacesContext context, T component) throws IOException - Throws:
- IOException- if an input/output error occurs while rendering
 
 - 
encodeChildrenpublic void encodeChildren(FacesContext context, T component) throws IOException Render all children if there are any. Note: this will only be called if getRendersChildren() returns true. A component which has a renderer with getRendersChildren() set to true will typically contain the rendering logic for its children in this method.- Parameters:
- context-
- component-
- Throws:
- IOException
 
 - 
encodeEndpublic void encodeEnd(FacesContext context, T component) throws IOException - Throws:
- IOException- if an input/output error occurs while rendering
 
 - 
convertClientIdpublic String convertClientId(FacesContext context, String clientId) 
 - 
getRendersChildrenpublic boolean getRendersChildren() Switch for deciding who renders the children.- Returns:
- true - if the component takes care of rendering its children. In this case, encodeChildren() ought to be called by the rendering controller (e.g., the rendering controller could be the method encodeAll() in UIComponent). In the method encodeChildren(), the component should therefore provide all children encode logic. false - if the component does not take care of rendering its children. In this case, encodeChildren() should not be called by the rendering controller. Instead, the children-list should be retrieved and the children should directly be rendered by the rendering controller one by one.
 
 - 
getConvertedValuepublic Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue) throws ConverterException - Throws:
- ConverterException
 
 
- 
 
-