com.liferay.faces.util.render

Interface DelegatingRenderer

All Known Subinterfaces:

DelegatingClientComponentRenderer

All Known Implementing Classes:

DelegatingClientComponentRendererBase, DelegatingRendererBase

public interface DelegatingRenderer

This interface defines a contract for a Renderer that has the ability to delegate to the corresponding methods of a different renderer, as well as utilize an alternate ResponseWriter in order to control/filter the encoding of elements and attributes.

Author:

Neil Griffin

Method Summary

Methods

Modifier and Type	Method and Description
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 DelegationResponseWriter.
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 DelegationResponseWriter.
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 DelegationResponseWriter.
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 DelegationResponseWriter.
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.
String	getDelegateRendererType() Returns the renderer-type associated with the delegate renderer.

Method Detail

encodeAll

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

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

Throws:

IOException

encodeAll

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

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 DelegationResponseWriter.

Throws:

IOException

encodeBegin

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

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

Throws:

IOException

encodeChildren

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

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

Throws:

IOException

encodeEnd

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

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

Throws:

IOException

getDelegateComponentFamily

String getDelegateComponentFamily()

Returns the component family associated with the delegate renderer.

getDelegateRenderer

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

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

getDelegateRendererType

String getDelegateRendererType()

Returns the renderer-type associated with the delegate renderer.