org.butterfaces.context

Class StringHtmlEncoder

java.lang.Object

org.butterfaces.context.StringHtmlEncoder

public class StringHtmlEncoder
extends Object

Util class to use FacesContexts ResponseWriter to create a html string.

Author:

Lars Michaelis

Constructor Summary

Constructors

Constructor and Description
StringHtmlEncoder()

Method Summary

Modifier and Type	Method and Description
static String	encodeComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Encodes complete component by calling UIComponent.encodeAll(FacesContext).
static String	encodeComponentWithSurroundingDiv(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Encodes complete component by calling UIComponent.encodeAll(FacesContext).
static String	encodeComponentWithSurroundingDiv(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String styleClass) Encodes complete component by calling UIComponent.encodeAll(FacesContext).
static String	encodeComponentWithSurroundingDivIfNecessary(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String styleClass) Encodes complete component by calling UIComponent.encodeAll(FacesContext).

Methods inherited from class java.lang.Object

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

Constructor Detail

StringHtmlEncoder

public StringHtmlEncoder()

Method Detail

encodeComponent

public static String encodeComponent(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component)
                              throws IOException

Encodes complete component by calling UIComponent.encodeAll(FacesContext).

Parameters:

component - component

context - FacesContext

Returns:

the rendered string.

Throws:

IOException - thrown by writer

encodeComponentWithSurroundingDiv

public static String encodeComponentWithSurroundingDiv(javax.faces.context.FacesContext context,
                                                       javax.faces.component.UIComponent component)
                                                throws IOException

Encodes complete component by calling UIComponent.encodeAll(FacesContext).

Parameters:

component - component

context - FacesContext

Returns:

the rendered string.

Throws:

IOException - thrown by writer

encodeComponentWithSurroundingDiv

public static String encodeComponentWithSurroundingDiv(javax.faces.context.FacesContext context,
                                                       javax.faces.component.UIComponent component,
                                                       String styleClass)
                                                throws IOException

Encodes complete component by calling UIComponent.encodeAll(FacesContext).

Parameters:

component - component

context - FacesContext

styleClass - a div wrapper style class

Returns:

the rendered string.

Throws:

IOException - thrown by writer

encodeComponentWithSurroundingDivIfNecessary

public static String encodeComponentWithSurroundingDivIfNecessary(javax.faces.context.FacesContext context,
                                                                  javax.faces.component.UIComponent component,
                                                                  String styleClass)
                                                           throws IOException

Encodes complete component by calling UIComponent.encodeAll(FacesContext). Surrounds template with given styleclass if template does not contains it.

Parameters:

component - component

context - FacesContext

styleClass - a div wrapper style class

Returns:

the rendered string.

Throws:

IOException - thrown by writer