Package jakarta.faces.render
Class RendererWrapper
- java.lang.Object
-
- jakarta.faces.render.Renderer
-
- jakarta.faces.render.RendererWrapper
-
- All Implemented Interfaces:
FacesWrapper<Renderer>
public abstract class RendererWrapper extends Renderer implements FacesWrapper<Renderer>
- Since:
- 2.2
-
-
Field Summary
-
Fields inherited from class jakarta.faces.render.Renderer
PASSTHROUGH_RENDERER_LOCALNAME_KEY
-
-
Constructor Summary
Constructors Constructor Description RendererWrapper()
Deprecated.RendererWrapper(Renderer delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
convertClientId(FacesContext context, String clientId)
void
decode(FacesContext context, UIComponent component)
void
encodeBegin(FacesContext context, UIComponent component)
void
encodeChildren(FacesContext context, UIComponent component)
Render all children if there are any.void
encodeEnd(FacesContext context, UIComponent component)
Object
getConvertedValue(FacesContext context, UIComponent component, Object submittedValue)
boolean
getRendersChildren()
Switch for deciding who renders the children.Renderer
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped.
-
-
-
Constructor Detail
-
RendererWrapper
@Deprecated public RendererWrapper()
Deprecated.
-
RendererWrapper
public RendererWrapper(Renderer delegate)
-
-
Method Detail
-
decode
public void decode(FacesContext context, UIComponent component)
-
encodeBegin
public void encodeBegin(FacesContext context, UIComponent component) throws IOException
- Overrides:
encodeBegin
in classRenderer
- Throws:
IOException
- if an input/output error occurs while rendering
-
encodeChildren
public void encodeChildren(FacesContext context, UIComponent component) throws IOException
Description copied from class:Renderer
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.- Overrides:
encodeChildren
in classRenderer
- Throws:
IOException
-
encodeEnd
public void encodeEnd(FacesContext context, UIComponent component) throws IOException
- Overrides:
encodeEnd
in classRenderer
- Throws:
IOException
- if an input/output error occurs while rendering
-
convertClientId
public String convertClientId(FacesContext context, String clientId)
- Overrides:
convertClientId
in classRenderer
-
getRendersChildren
public boolean getRendersChildren()
Description copied from class:Renderer
Switch for deciding who renders the children.- Overrides:
getRendersChildren
in classRenderer
- 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
- Overrides:
getConvertedValue
in classRenderer
- Throws:
ConverterException
-
getWrapped
public Renderer getWrapped()
Description copied from interface:FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.- Specified by:
getWrapped
in interfaceFacesWrapper<Renderer>
- Returns:
- the instance of the class being wrapped
-
-