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 Summary
Fields Modifier and Type Field Description static String
PASSTHROUGH_RENDERER_LOCALNAME_KEY
-
Constructor Summary
Constructors Constructor Description Renderer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
convertClientId(FacesContext context, String clientId)
void
decode(FacesContext context, T component)
void
encodeBegin(FacesContext context, T component)
void
encodeChildren(FacesContext context, T component)
Render all children if there are any.void
encodeEnd(FacesContext context, T component)
Object
getConvertedValue(FacesContext context, UIComponent component, Object submittedValue)
boolean
getRendersChildren()
Switch for deciding who renders the children.
-
-
-
Field Detail
-
PASSTHROUGH_RENDERER_LOCALNAME_KEY
public static final String PASSTHROUGH_RENDERER_LOCALNAME_KEY
- Since:
- 2.2
- See Also:
- Constant Field Values
-
-
Method Detail
-
decode
public void decode(FacesContext context, T component)
-
encodeBegin
public void encodeBegin(FacesContext context, T component) throws IOException
- Throws:
IOException
- if an input/output error occurs while rendering
-
encodeChildren
public 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
-
encodeEnd
public void encodeEnd(FacesContext context, T component) throws IOException
- Throws:
IOException
- if an input/output error occurs while rendering
-
convertClientId
public String convertClientId(FacesContext context, String clientId)
-
getRendersChildren
public 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.
-
getConvertedValue
public Object getConvertedValue(FacesContext context, UIComponent component, Object submittedValue) throws ConverterException
- Throws:
ConverterException
-
-