public abstract class RendererWrapper extends Renderer implements FacesWrapper<Renderer>
Provides a simple implementation of
Renderer that can be subclassed by developers wishing to
provide specialized behavior to an existing Renderer
instance. The default implementation of all methods is to call
through to the wrapped Renderer instance.
Usage: extend this class and push the implementation being wrapped to the
constructor and use getWrapped() to access the instance being wrapped.
PASSTHROUGH_RENDERER_LOCALNAME_KEY| Constructor and Description |
|---|
RendererWrapper()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
RendererWrapper(Renderer wrapped)
If this renderer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
convertClientId(FacesContext context,
java.lang.String clientId)
Convert the component generated client id to a form suitable
for transmission to the client.
|
void |
decode(FacesContext context,
UIComponent component)
Decode any new state of the specified
UIComponent
from the request contained in the specified FacesContext,
and store that state on the UIComponent. |
void |
encodeBegin(FacesContext context,
UIComponent component)
Render the beginning specified
UIComponent to the
output stream or writer associated with the response we are creating. |
void |
encodeChildren(FacesContext context,
UIComponent component)
Render the child components of this
UIComponent, following
the rules described for encodeBegin() to acquire the
appropriate value to be rendered. |
void |
encodeEnd(FacesContext context,
UIComponent component)
Render the ending of the current state of the specified
UIComponent, following the rules described for
encodeBegin() to acquire the appropriate value
to be rendered. |
java.lang.Object |
getConvertedValue(FacesContext context,
UIComponent component,
java.lang.Object submittedValue)
Attempt to convert previously stored state information into an
object of the type required for this component (optionally using the
registered
Converter for this component,
if there is one). |
boolean |
getRendersChildren()
Return a flag indicating whether this
Renderer is responsible
for rendering the children the component it is asked to render. |
Renderer |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
@Deprecated public RendererWrapper()
public RendererWrapper(Renderer wrapped)
If this renderer has been decorated,
the implementation doing the decorating should push the implementation being wrapped to this constructor.
The getWrapped() will then return the implementation being wrapped.
wrapped - The implementation being wrapped.public Renderer getWrapped()
FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped in interface FacesWrapper<Renderer>public java.lang.String convertClientId(FacesContext context, java.lang.String clientId)
RendererConvert the component generated client id to a form suitable for transmission to the client.
The default implementation returns the argument
clientId unchanged.
convertClientId in class Renderercontext - FacesContext for the current requestclientId - the client identifier to be converted to client a
specific format.clientIdpublic java.lang.Object getConvertedValue(FacesContext context, UIComponent component, java.lang.Object submittedValue) throws ConverterException
RendererAttempt to convert previously stored state information into an
object of the type required for this component (optionally using the
registered Converter for this component,
if there is one). If conversion is successful, the new value
should be returned from this method; if not, a
ConverterException should be thrown.
getConvertedValue in class Renderercontext - FacesContext for the request we are processingcomponent - UIComponent to be decoded.submittedValue - a value stored on the component during
decode.ConverterException - if the submitted value
cannot be converted successfully.public void decode(FacesContext context, UIComponent component)
RendererDecode any new state of the specified UIComponent
from the request contained in the specified FacesContext,
and store that state on the UIComponent.
During decoding, events may be enqueued for later processing
(by event listeners that have registered an interest), by calling
queueEvent() on the associated UIComponent.
decode in class Renderercontext - FacesContext for the request we are processingcomponent - UIComponent to be decoded.public void encodeBegin(FacesContext context, UIComponent component) throws java.io.IOException
RendererRender the beginning specified UIComponent to the
output stream or writer associated with the response we are creating.
If the conversion attempted in a previous call to
getConvertedValue() for this component failed, the state
information saved during execution
of decode() should be used to reproduce the incorrect
input.
encodeBegin in class Renderercontext - FacesContext for the request we are processingcomponent - UIComponent to be renderedjava.io.IOException - if an input/output error occurs while renderingpublic void encodeChildren(FacesContext context, UIComponent component) throws java.io.IOException
RendererRender the child components of this UIComponent, following
the rules described for encodeBegin() to acquire the
appropriate value to be rendered. This method will only be called
if the rendersChildren property of this component
is true.
encodeChildren in class Renderercontext - FacesContext for the response we are creatingcomponent - UIComponent whose children are to be renderedjava.io.IOException - if an input/output error occurs while renderingpublic void encodeEnd(FacesContext context, UIComponent component) throws java.io.IOException
RendererRender the ending of the current state of the specified
UIComponent, following the rules described for
encodeBegin() to acquire the appropriate value
to be rendered.
encodeEnd in class Renderercontext - FacesContext for the response we are creatingcomponent - UIComponent to be renderedjava.io.IOException - if an input/output error occurs while renderingpublic boolean getRendersChildren()
RendererReturn a flag indicating whether this Renderer is responsible
for rendering the children the component it is asked to render.
The default implementation returns false.
getRendersChildren in class Renderer