com.liferay.faces.util.render

Class DelegatingRendererBase

java.lang.Object

javax.faces.render.Renderer

com.liferay.faces.util.render.DelegatingRendererBase

All Implemented Interfaces:

DelegatingRenderer

@ProviderType
public abstract class DelegatingRendererBase
extends javax.faces.render.Renderer
implements DelegatingRenderer

This is an abstract class that implements the DelegatingRenderer interface in order to provide base functionality for delegating the responsibility of rendering a UIComponent to a different renderer.

Author:

Neil Griffin

Field Summary

Fields inherited from class javax.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor and Description
DelegatingRendererBase()

Method Summary

Modifier and Type	Method and Description
String	convertClientId(javax.faces.context.FacesContext facesContext, String clientId)
void	decode(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
void	encodeAll(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent) Convenience method that calls the delegate renderer's Renderer.encodeBegin(FacesContext, UIComponent), Renderer.encodeChildren(FacesContext, UIComponent), and Renderer.encodeEnd(FacesContext, UIComponent) methods.
void	encodeAll(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, javax.faces.context.ResponseWriter delegationResponseWriter) Convenience method that calls the delegate renderer's Renderer.encodeBegin(FacesContext, UIComponent), Renderer.encodeChildren(FacesContext, UIComponent), and Renderer.encodeEnd(FacesContext, UIComponent) methods using the specified ResponseWriter.
void	encodeBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
void	encodeBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, javax.faces.context.ResponseWriter delegationResponseWriter) Calls the delegate renderer's Renderer.encodeBegin(FacesContext, UIComponent) method using the specified ResponseWriter.
void	encodeChildren(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
void	encodeChildren(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, javax.faces.context.ResponseWriter delegationResponseWriter) Calls the delegate renderer's Renderer.encodeChildren(FacesContext, UIComponent) method using the specified ResponseWriter.
void	encodeEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
void	encodeEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, javax.faces.context.ResponseWriter delegationResponseWriter) Calls the delegate renderer's Renderer.encodeEnd(FacesContext, UIComponent) method using the specified ResponseWriter.
Object	getConvertedValue(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, Object submittedValue)
abstract String	getDelegateComponentFamily() Returns the component family associated with the delegate renderer.
javax.faces.render.Renderer	getDelegateRenderer(javax.faces.context.FacesContext facesContext) Returns the delegate renderer from the RenderKit associated with the specified FacesContext.
abstract String	getDelegateRendererType() Returns the renderer-type associated with the delegate renderer.
boolean	getRendersChildren()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DelegatingRendererBase

public DelegatingRendererBase()

Method Detail

getDelegateComponentFamily

public abstract String getDelegateComponentFamily()

Description copied from interface: DelegatingRenderer

Returns the component family associated with the delegate renderer.

Specified by:

getDelegateComponentFamily in interface DelegatingRenderer

See Also:

DelegatingRenderer.getDelegateComponentFamily()

getDelegateRendererType

public abstract String getDelegateRendererType()

Description copied from interface: DelegatingRenderer

Returns the renderer-type associated with the delegate renderer.

Specified by:

getDelegateRendererType in interface DelegatingRenderer

See Also:

DelegatingRenderer.getDelegateRendererType()

convertClientId

public String convertClientId(javax.faces.context.FacesContext facesContext,
                              String clientId)

Overrides:

convertClientId in class javax.faces.render.Renderer

decode

public void decode(javax.faces.context.FacesContext facesContext,
                   javax.faces.component.UIComponent uiComponent)

Overrides:

decode in class javax.faces.render.Renderer

encodeAll

public void encodeAll(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent uiComponent)
               throws IOException

Description copied from interface: DelegatingRenderer

Convenience method that calls the delegate renderer's Renderer.encodeBegin(FacesContext, UIComponent), Renderer.encodeChildren(FacesContext, UIComponent), and Renderer.encodeEnd(FacesContext, UIComponent) methods.

Specified by:

encodeAll in interface DelegatingRenderer

Throws:

IOException

See Also:

DelegatingRenderer.encodeAll(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

encodeAll

public void encodeAll(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent uiComponent,
                      javax.faces.context.ResponseWriter delegationResponseWriter)
               throws IOException

Description copied from interface: DelegatingRenderer

Convenience method that calls the delegate renderer's Renderer.encodeBegin(FacesContext, UIComponent), Renderer.encodeChildren(FacesContext, UIComponent), and Renderer.encodeEnd(FacesContext, UIComponent) methods using the specified ResponseWriter.

Specified by:

encodeAll in interface DelegatingRenderer

Throws:

IOException

See Also:

DelegatingRenderer.encodeAll(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.context.ResponseWriter)

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext facesContext,
                        javax.faces.component.UIComponent uiComponent)
                 throws IOException

Overrides:

encodeBegin in class javax.faces.render.Renderer

Throws:

IOException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext facesContext,
                        javax.faces.component.UIComponent uiComponent,
                        javax.faces.context.ResponseWriter delegationResponseWriter)
                 throws IOException

Description copied from interface: DelegatingRenderer

Calls the delegate renderer's Renderer.encodeBegin(FacesContext, UIComponent) method using the specified ResponseWriter.

Specified by:

encodeBegin in interface DelegatingRenderer

Throws:

IOException

See Also:

DelegatingRenderer.encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.context.ResponseWriter)

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext facesContext,
                           javax.faces.component.UIComponent uiComponent)
                    throws IOException

Overrides:

encodeChildren in class javax.faces.render.Renderer

Throws:

IOException

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext facesContext,
                           javax.faces.component.UIComponent uiComponent,
                           javax.faces.context.ResponseWriter delegationResponseWriter)
                    throws IOException

Description copied from interface: DelegatingRenderer

Calls the delegate renderer's Renderer.encodeChildren(FacesContext, UIComponent) method using the specified ResponseWriter.

Specified by:

encodeChildren in interface DelegatingRenderer

Throws:

IOException

See Also:

DelegatingRenderer.encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.context.ResponseWriter)

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent uiComponent)
               throws IOException

Overrides:

encodeEnd in class javax.faces.render.Renderer

Throws:

IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent uiComponent,
                      javax.faces.context.ResponseWriter delegationResponseWriter)
               throws IOException

Description copied from interface: DelegatingRenderer

Calls the delegate renderer's Renderer.encodeEnd(FacesContext, UIComponent) method using the specified ResponseWriter.

Specified by:

encodeEnd in interface DelegatingRenderer

Throws:

IOException

See Also:

DelegatingRenderer.encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.context.ResponseWriter)

getConvertedValue

public Object getConvertedValue(javax.faces.context.FacesContext facesContext,
                                javax.faces.component.UIComponent uiComponent,
                                Object submittedValue)
                         throws javax.faces.convert.ConverterException

Overrides:

getConvertedValue in class javax.faces.render.Renderer

Throws:

javax.faces.convert.ConverterException

getDelegateRenderer

public javax.faces.render.Renderer getDelegateRenderer(javax.faces.context.FacesContext facesContext)

Description copied from interface: DelegatingRenderer

Returns the delegate renderer from the RenderKit associated with the specified FacesContext.

Specified by:

getDelegateRenderer in interface DelegatingRenderer

See Also:

DelegatingRenderer.getDelegateRenderer(javax.faces.context.FacesContext)

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class javax.faces.render.Renderer