Package jakarta.faces.render
Class Renderer<T extends UIComponent>
java.lang.Object
jakarta.faces.render.Renderer<T>
- Direct Known Subclasses:
RendererWrapper
see Javadoc of Faces Specification
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionconvertClientId
(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) getConvertedValue
(FacesContext context, T component, Object submittedValue) boolean
Switch for deciding who renders the children.
-
Field Details
-
PASSTHROUGH_RENDERER_LOCALNAME_KEY
- Since:
- 2.2
- See Also:
-
-
Constructor Details
-
Renderer
public Renderer()
-
-
Method Details
-
decode
-
encodeBegin
- Throws:
IOException
- if an input/output error occurs while rendering
-
encodeChildren
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
- Throws:
IOException
- if an input/output error occurs while rendering
-
convertClientId
-
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, T component, Object submittedValue) throws ConverterException - Throws:
ConverterException
-