com.liferay.faces.util.render

Class ClientComponentRendererBase

java.lang.Object

javax.faces.render.Renderer

com.liferay.faces.util.render.ClientComponentRendererBase

All Implemented Interfaces:

ClientComponentRenderer

Direct Known Subclasses:

DelegatingClientComponentRendererBase

@ProviderType
public abstract class ClientComponentRendererBase
extends javax.faces.render.Renderer
implements ClientComponentRenderer

This is an abstract class that provides base rendering functionality. It extends normal rendering with methods such as encodeMarkupBegin(FacesContext, UIComponent) and encodeMarkupEnd(FacesContext, UIComponent) that provide a more fine-grained rendering sequence.

Author:

Neil Griffin

Field Summary

Fields inherited from class javax.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor and Description
ClientComponentRendererBase()

Method Summary

Modifier and Type	Method and Description
void	decode(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
void	decodeClientState(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
void	encodeBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
protected void	encodeBooleanProperty(javax.faces.context.ResponseWriter responseWriter, String propertyName, Boolean propertyValue, boolean first)
protected void	encodeClientIdProperty(javax.faces.context.ResponseWriter responseWriter, String propertyName, String clientId, boolean first)
protected void	encodeClientIdProperty(javax.faces.context.ResponseWriter responseWriter, String propertyName, String clientId, javax.faces.component.UIComponent uiComponent, boolean first)
void	encodeClientState(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter responseWriter, javax.faces.component.UIComponent uiComponent)
void	encodeEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
protected void	encodeFunctionCall(javax.faces.context.ResponseWriter responseWriter, String functionName, Object... parameters)
protected void	encodeIntegerProperty(javax.faces.context.ResponseWriter responseWriter, String propertyName, Integer propertyValue, boolean first)
abstract void	encodeJavaScript(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
abstract void	encodeMarkupBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
abstract void	encodeMarkupEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
protected void	encodeNonEscapedObjectProperty(javax.faces.context.ResponseWriter responseWriter, String propertyName, Object propertyValue, boolean first)
protected void	encodeStringProperty(javax.faces.context.ResponseWriter responseWriter, String propertyName, Object propertyValue, boolean first)
protected String	getClientVarName(javax.faces.context.FacesContext facesContext, ClientComponent clientComponent)
protected void	renderScript(javax.faces.context.FacesContext facesContext, String bufferedScriptString, String[] modules, Script.ModulesType modulesType)

Methods inherited from class javax.faces.render.Renderer

convertClientId, encodeChildren, getConvertedValue, getRendersChildren

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientComponentRendererBase

public ClientComponentRendererBase()

Method Detail

encodeJavaScript

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

Specified by:

encodeJavaScript in interface ClientComponentRenderer

Throws:

IOException

See Also:

ClientComponentRenderer.encodeJavaScript(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

encodeMarkupBegin

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

Specified by:

encodeMarkupBegin in interface ClientComponentRenderer

Throws:

IOException

See Also:

ClientComponentRenderer.encodeMarkupBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

encodeMarkupEnd

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

Specified by:

encodeMarkupEnd in interface ClientComponentRenderer

Throws:

IOException

See Also:

ClientComponentRenderer.encodeMarkupEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

decode

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

Overrides:

decode in class javax.faces.render.Renderer

decodeClientState

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

Specified by:

decodeClientState in interface ClientComponentRenderer

See Also:

ClientComponentRenderer.decodeClientState(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

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

encodeClientState

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

Specified by:

encodeClientState in interface ClientComponentRenderer

Throws:

IOException

See Also:

ClientComponentRenderer.encodeClientState(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIComponent)

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

encodeBooleanProperty

protected void encodeBooleanProperty(javax.faces.context.ResponseWriter responseWriter,
                                     String propertyName,
                                     Boolean propertyValue,
                                     boolean first)
                              throws IOException

Throws:

IOException

encodeClientIdProperty

protected void encodeClientIdProperty(javax.faces.context.ResponseWriter responseWriter,
                                      String propertyName,
                                      String clientId,
                                      boolean first)
                               throws IOException

Throws:

IOException

encodeClientIdProperty

protected void encodeClientIdProperty(javax.faces.context.ResponseWriter responseWriter,
                                      String propertyName,
                                      String clientId,
                                      javax.faces.component.UIComponent uiComponent,
                                      boolean first)
                               throws IOException

Throws:

IOException

encodeFunctionCall

protected void encodeFunctionCall(javax.faces.context.ResponseWriter responseWriter,
                                  String functionName,
                                  Object... parameters)
                           throws IOException

Throws:

IOException

encodeIntegerProperty

protected void encodeIntegerProperty(javax.faces.context.ResponseWriter responseWriter,
                                     String propertyName,
                                     Integer propertyValue,
                                     boolean first)
                              throws IOException

Throws:

IOException

encodeNonEscapedObjectProperty

protected void encodeNonEscapedObjectProperty(javax.faces.context.ResponseWriter responseWriter,
                                              String propertyName,
                                              Object propertyValue,
                                              boolean first)
                                       throws IOException

Throws:

IOException

encodeStringProperty

protected void encodeStringProperty(javax.faces.context.ResponseWriter responseWriter,
                                    String propertyName,
                                    Object propertyValue,
                                    boolean first)
                             throws IOException

Throws:

IOException

getClientVarName

protected String getClientVarName(javax.faces.context.FacesContext facesContext,
                                  ClientComponent clientComponent)

renderScript

protected void renderScript(javax.faces.context.FacesContext facesContext,
                            String bufferedScriptString,
                            String[] modules,
                            Script.ModulesType modulesType)