de.mindmatters.faces.render.html
Class HtmlFormRenderer

java.lang.Object
  javax.faces.render.Renderer
      de.mindmatters.faces.render.html.AbstractRendererBase
          de.mindmatters.faces.render.html.HtmlFormRenderer

public final class HtmlFormRenderer
extends AbstractRendererBase

HtmlFormRenderer is a class that renders a UIForm as a HTML Form.

Author:

Andreas Kuhrwahl

Constructor Summary

HtmlFormRenderer()

Method Summary

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.

Methods inherited from class de.mindmatters.faces.render.html.AbstractRendererBase

getBooleanAttribute, writeBooleanPassThruAttributes, writePassThruAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlFormRenderer

public HtmlFormRenderer()

Method Detail

decode

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

During decoding, events may be enqueued for later processing (by event listeners that have registered an interest), by calling queueEvent() on the associated UIComponent.

Overrides:

decode in class Renderer

Parameters:

context - FacesContext for the request we are processing

component - UIComponent to be decoded.

encodeBegin

public void encodeBegin(FacesContext context,
                        UIComponent component)
                 throws java.io.IOException

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

Overrides:

encodeBegin in class Renderer

Parameters:

context - FacesContext for the request we are processing

component - UIComponent to be rendered

Throws:

java.io.IOException - if an input/output error occurs while rendering

encodeEnd

public void encodeEnd(FacesContext context,
                      UIComponent component)
               throws java.io.IOException

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.

Overrides:

encodeEnd in class Renderer

Parameters:

context - FacesContext for the response we are creating

component - UIComponent to be rendered

Throws:

java.io.IOException - if an input/output error occurs while rendering

convertClientId

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

The default implementation returns the argument clientId unchanged.

Overrides:

convertClientId in class Renderer

Parameters:

context - FacesContext for the current request

clientId - the client identifier to be converted to client a specific format.

encodeChildren

public void encodeChildren(FacesContext context,
                           UIComponent component)
                    throws java.io.IOException

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

Overrides:

encodeChildren in class Renderer

Parameters:

context - FacesContext for the response we are creating

component - UIComponent whose children are to be rendered

Throws:

java.io.IOException - if an input/output error occurs while rendering

getConvertedValue

public 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). If conversion is successful, the new value should be returned from this method; if not, a ConverterException should be thrown.

Overrides:

getConvertedValue in class Renderer

Parameters:

context - FacesContext for the request we are processing

component - UIComponent to be decoded.

submittedValue - a value stored on the component during decode.

getRendersChildren

public boolean getRendersChildren()

Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render. The default implementation returns false.

Overrides:

getRendersChildren in class Renderer