com.sun.rave.web.ui.renderer
Class TableRenderer

java.lang.Object
  extended by javax.faces.render.Renderer
      extended by com.sun.rave.web.ui.renderer.TableRenderer

public class TableRenderer
extends javax.faces.render.Renderer

This class renders Table components.

The table component provides a layout mechanism for displaying table actions. UI guidelines describe specific behavior that can applied to the rows and columns of data such as sorting, filtering, pagination, selection, and custom user actions. In addition, UI guidelines also define sections of the table that can be used for titles, row group headers, and placement of pre-defined and user defined actions.

Note: Column headers and footers are rendered by TableRowGroupRenderer. Table column footers are rendered by TableRenderer.

Note: To see the messages logged by this class, set the following global defaults in your JDK's "jre/lib/logging.properties" file.

 java.util.logging.ConsoleHandler.level = FINE
 com.sun.rave.web.ui.renderer.TableRenderer.level = FINE
 

See TLD docs for more information.


Constructor Summary
TableRenderer()
           
 
Method Summary
 void encodeBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Render the beginning of the specified UIComponent to the output stream or writer associated with the response we are creating.
 void encodeChildren(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Render the children of the specified UIComponent to the output stream or writer associated with the response we are creating.
 void encodeEnd(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
          Render the ending of the specified UIComponent to the output stream or writer associated with the response we are creating.
 boolean getRendersChildren()
          Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render.
protected  void renderActionsBottom(javax.faces.context.FacesContext context, Table component, javax.faces.context.ResponseWriter writer)
          Render the bottom actions for Table components.
protected  void renderActionsTop(javax.faces.context.FacesContext context, Table component, javax.faces.context.ResponseWriter writer)
          Render the top actions for Table components.
protected  void renderEmbeddedPanels(javax.faces.context.FacesContext context, Table component, javax.faces.context.ResponseWriter writer)
          Render embedded panels for Table components.
protected  void renderEnclosingTagEnd(javax.faces.context.ResponseWriter writer)
          Render enclosing tag for Table components.
protected  void renderEnclosingTagStart(javax.faces.context.FacesContext context, Table component, javax.faces.context.ResponseWriter writer)
          Render enclosing tag for Table components.
protected  void renderTableFooter(javax.faces.context.FacesContext context, Table component, javax.faces.context.ResponseWriter writer)
          Render table footer for Table components.
protected  void renderTitle(javax.faces.context.FacesContext context, Table component, javax.faces.context.ResponseWriter writer)
          Render title for Table components.
 
Methods inherited from class javax.faces.render.Renderer
convertClientId, decode, getConvertedValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableRenderer

public TableRenderer()
Method Detail

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context,
                        javax.faces.component.UIComponent component)
                 throws java.io.IOException
Render the beginning of the specified UIComponent to the output stream or writer associated with the response we are creating.

Overrides:
encodeBegin in class javax.faces.render.Renderer
Parameters:
context - FacesContext for the current request.
component - UIComponent to be rendered.
Throws:
java.io.IOException - if an input/output error occurs.
java.lang.NullPointerException - if context or component is null.

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context,
                           javax.faces.component.UIComponent component)
                    throws java.io.IOException
Render the children of the specified UIComponent to the output stream or writer associated with the response we are creating.

Overrides:
encodeChildren in class javax.faces.render.Renderer
Parameters:
context - FacesContext for the current request.
component - UIComponent to be decoded.
Throws:
java.io.IOException - if an input/output error occurs.
java.lang.NullPointerException - if context or component is null.

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context,
                      javax.faces.component.UIComponent component)
               throws java.io.IOException
Render the ending of the specified UIComponent to the output stream or writer associated with the response we are creating.

Overrides:
encodeEnd in class javax.faces.render.Renderer
Parameters:
context - FacesContext for the current request.
component - UIComponent to be rendered.
Throws:
java.io.IOException - if an input/output error occurs.
java.lang.NullPointerException - if context or component is null.

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 javax.faces.render.Renderer

renderActionsBottom

protected void renderActionsBottom(javax.faces.context.FacesContext context,
                                   Table component,
                                   javax.faces.context.ResponseWriter writer)
                            throws java.io.IOException
Render the bottom actions for Table components.

Parameters:
context - FacesContext for the current request.
component - Table to be rendered.
writer - ResponseWriter to which the component should be rendered.
Throws:
java.io.IOException - if an input/output error occurs.

renderActionsTop

protected void renderActionsTop(javax.faces.context.FacesContext context,
                                Table component,
                                javax.faces.context.ResponseWriter writer)
                         throws java.io.IOException
Render the top actions for Table components.

Parameters:
context - FacesContext for the current request.
component - Table to be rendered.
writer - ResponseWriter to which the component should be rendered.
Throws:
java.io.IOException - if an input/output error occurs.

renderEmbeddedPanels

protected void renderEmbeddedPanels(javax.faces.context.FacesContext context,
                                    Table component,
                                    javax.faces.context.ResponseWriter writer)
                             throws java.io.IOException
Render embedded panels for Table components.

Parameters:
context - FacesContext for the current request.
component - Table to be rendered.
writer - ResponseWriter to which the component should be rendered.
Throws:
java.io.IOException - if an input/output error occurs.

renderTableFooter

protected void renderTableFooter(javax.faces.context.FacesContext context,
                                 Table component,
                                 javax.faces.context.ResponseWriter writer)
                          throws java.io.IOException
Render table footer for Table components.

Parameters:
context - FacesContext for the current request.
component - Table to be rendered.
writer - ResponseWriter to which the component should be rendered.
Throws:
java.io.IOException - if an input/output error occurs.

renderTitle

protected void renderTitle(javax.faces.context.FacesContext context,
                           Table component,
                           javax.faces.context.ResponseWriter writer)
                    throws java.io.IOException
Render title for Table components.

Parameters:
context - FacesContext for the current request.
component - Table to be rendered.
writer - ResponseWriter to which the component should be rendered.
Throws:
java.io.IOException - if an input/output error occurs.

renderEnclosingTagStart

protected void renderEnclosingTagStart(javax.faces.context.FacesContext context,
                                       Table component,
                                       javax.faces.context.ResponseWriter writer)
                                throws java.io.IOException
Render enclosing tag for Table components.

Parameters:
context - FacesContext for the current request.
component - Table to be rendered.
writer - ResponseWriter to which the component should be rendered.
Throws:
java.io.IOException - if an input/output error occurs.

renderEnclosingTagEnd

protected void renderEnclosingTagEnd(javax.faces.context.ResponseWriter writer)
                              throws java.io.IOException
Render enclosing tag for Table components.

Parameters:
writer - ResponseWriter to which the component should be rendered.
Throws:
java.io.IOException - if an input/output error occurs.