Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.myfaces.renderkit.html.ext
Class HtmlTableRenderer

java.lang.Object
  extended byjavax.faces.render.Renderer
      extended byorg.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer
          extended byorg.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase
              extended byorg.apache.myfaces.renderkit.html.ext.HtmlTableRenderer
public class HtmlTableRenderer
extends HtmlTableRendererBase

Renderer for the Tomahawk extended HtmlDataTable component.

Version:
$Revision: 491565 $ $Date: 2007-01-01 13:54:00 +0100 (Mo, 01 Jän 2007) $
Author:
Manfred Geiler (latest modification by $Author: paulsp $)

Nested Class Summary
 
Nested classes inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase
HtmlTableRendererBase.Styles
 
Field Summary
static java.lang.String DETAIL_STAMP_FACET_NAME
          DetailStamp facet name.
 
Fields inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase
FOOTER_FACET_NAME, HEADER_FACET_NAME
 
Constructor Summary
HtmlTableRenderer()
           
 
Method Summary
protected  void afterRow(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData)
          Perform any operations necessary immediately after each TR end tag is output.
protected  boolean amISpannedOver(java.lang.String prefix, javax.faces.component.UIComponent component)
          specify if the header, footer or is spanned over (not shown) because of a colspan in a cell in a previous column
protected  void beforeBody(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData)
          Perform any operations necessary after TABLE start tag is output but before the TBODY start tag.
protected  void beforeColumn(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData, int columnIndex)
          Perform any operations necessary immediately before each column child is rendered
protected  void beforeColumnHeaderOrFooter(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData, boolean header, int columnIndex)
          Perform any operations necessary immediately before each column child's header or footer is rendered
protected  int determineChildColSpan(javax.faces.component.UIComponent uiComponent)
          Return the number of columns spanned by the specified component.
protected  boolean determineRenderFacet(javax.faces.component.UIComponent component, boolean header)
          determine if the header or footer should be rendered.
 void encodeBegin(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
          Render the necessary bits that come before any actual rows in the table.
 void encodeChildren(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)
          Render the TBODY section of the html table.
protected  void encodeColumnChild(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, javax.faces.component.UIComponent component, HtmlTableRendererBase.Styles styles, int columnStyleIndex)
          Render the specified column object using the current row data.
 void encodeEnd(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
           
protected  int getNewspaperColumns(javax.faces.component.UIComponent component)
           
protected  javax.faces.component.UIComponent getNewspaperTableSpacer(javax.faces.component.UIComponent component)
           
protected  boolean hasFacet(boolean header, javax.faces.component.UIComponent uiComponent)
          Return true if the specified component has a facet that needs to be rendered in a THEAD or TFOOT section.
protected  boolean hasNewspaperTableSpacer(javax.faces.component.UIComponent component)
           
protected  void inBodyStart(javax.faces.context.FacesContext facesContext, javax.faces.component.UIData uiData)
          Perform any operations necessary in the TBODY start tag.
protected  boolean isNewspaperHorizontalOrientation(javax.faces.component.UIComponent component)
           
protected  void putSortedReqScopeParam(javax.faces.context.FacesContext facesContext, HtmlDataTable dataTable, int columnIndex)
           
protected  void renderColumnBody(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, javax.faces.component.UIComponent component, HtmlTableRendererBase.Styles styles, int columnStyleIndex)
          Renders the body of a given UIColumn (everything but the header and footer facets).
protected  void renderColumnChildHeaderOrFooterRow(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, java.lang.String styleClass, boolean header)
          Render the header or footer of the specified column object.
protected  void renderColumnFooterCell(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, javax.faces.component.UIComponent facet, java.lang.String footerStyleClass, int colspan)
          Renders the footer facet for the given UIColumn.
protected  void renderColumnFooterRow(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, java.lang.String footerStyleClass)
          Renders the column footer.
protected  void renderColumnHeaderCell(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, javax.faces.component.UIComponent facet, java.lang.String headerStyleClass, int colspan)
          Renders a TH cell within a TR within a THEAD section.
protected  void renderColumnHeaderRow(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent component, java.lang.String headerStyleClass)
          Renders the column header.
protected  void renderHtmlColumnAttributes(javax.faces.context.ResponseWriter writer, javax.faces.component.UIComponent uiComponent, java.lang.String prefix)
           
protected  void renderRowAttribute(javax.faces.context.ResponseWriter writer, java.lang.String htmlAttribute, java.lang.Object value)
           
protected  void renderRowStart(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, HtmlTableRendererBase.Styles styles, int rowStyleIndex)
          Renders the start of a new row of body content.
protected  void renderRowStyle(javax.faces.context.FacesContext facesContext, javax.faces.context.ResponseWriter writer, javax.faces.component.UIData uiData, HtmlTableRendererBase.Styles styles, int rowStyleIndex)
           
 
Methods inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase
afterBody, afterColumn, afterColumnHeaderOrFooter, afterTable, beforeRow, beforeTable, decode, encodeInnerHtml, getFooterClass, getHeaderClass, getRendersChildren, getStyles, renderColumnFooterCell, renderColumnHeaderCell, renderFacet, renderRowEnd, renderSpacerCell, renderTableFooterRow, renderTableHeaderRow
 
Methods inherited from class org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer
getActionUrl, getChildCount, getChildren, getClientId, renderId, shouldRenderId, toUri
 
Methods inherited from class javax.faces.render.Renderer
convertClientId, getConvertedValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DETAIL_STAMP_FACET_NAME

public static final java.lang.String DETAIL_STAMP_FACET_NAME
DetailStamp facet name.

See Also:
Constant Field Values
Constructor Detail

HtmlTableRenderer

public HtmlTableRenderer()
Method Detail

getNewspaperColumns

protected int getNewspaperColumns(javax.faces.component.UIComponent component)
Overrides:
getNewspaperColumns in class HtmlTableRendererBase
Parameters:
component - dataTable
Returns:
number of layout columns

getNewspaperTableSpacer

protected javax.faces.component.UIComponent getNewspaperTableSpacer(javax.faces.component.UIComponent component)
Overrides:
getNewspaperTableSpacer in class HtmlTableRendererBase
Parameters:
component - dataTable
Returns:
component to display between layout columns

hasNewspaperTableSpacer

protected boolean hasNewspaperTableSpacer(javax.faces.component.UIComponent component)
Overrides:
hasNewspaperTableSpacer in class HtmlTableRendererBase
Parameters:
component - dataTable
Returns:
whether dataTable has component to display between layout columns

isNewspaperHorizontalOrientation

protected boolean isNewspaperHorizontalOrientation(javax.faces.component.UIComponent component)
Overrides:
isNewspaperHorizontalOrientation in class HtmlTableRendererBase
Parameters:
component - dataTable
Returns:
if the orientation of the has newspaper columns is horizontal

afterRow

protected void afterRow(javax.faces.context.FacesContext facesContext,
                        javax.faces.component.UIData uiData)
                 throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Perform any operations necessary immediately after each TR end tag is output.

Overrides:
afterRow in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
uiData - the UIData being rendered.
Throws:
java.io.IOException

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext facesContext,
                        javax.faces.component.UIComponent uiComponent)
                 throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Render the necessary bits that come before any actual rows in the table.

Overrides:
encodeBegin in class HtmlTableRendererBase
Throws:
java.io.IOException
See Also:
HtmlTableRendererBase.encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext facesContext,
                           javax.faces.component.UIComponent component)
                    throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Render the TBODY section of the html table. See also method encodeInnerHtml.

Overrides:
encodeChildren in class HtmlTableRendererBase
Throws:
java.io.IOException
See Also:
HtmlTableRendererBase.encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

beforeBody

protected void beforeBody(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIData uiData)
                   throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Perform any operations necessary after TABLE start tag is output but before the TBODY start tag.

This method generates the THEAD/TFOOT sections of a table if there are any header or footer facets defined on the table or on any child UIColumn component.

Overrides:
beforeBody in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
uiData - the UIData being rendered.
Throws:
java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext facesContext,
                      javax.faces.component.UIComponent uiComponent)
               throws java.io.IOException
Overrides:
encodeEnd in class HtmlTableRendererBase
Throws:
java.io.IOException
See Also:
HtmlTableRendererBase.encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent)

renderRowStart

protected void renderRowStart(javax.faces.context.FacesContext facesContext,
                              javax.faces.context.ResponseWriter writer,
                              javax.faces.component.UIData uiData,
                              HtmlTableRendererBase.Styles styles,
                              int rowStyleIndex)
                       throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Renders the start of a new row of body content.

Overrides:
renderRowStart in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
writer - the ResponseWriter.
uiData - the UIData being rendered.
styles - the styleClasses of rows and columns
rowStyleIndex - the index of the row
Throws:
java.io.IOException - if an exceptoin occurs.

renderRowStyle

protected void renderRowStyle(javax.faces.context.FacesContext facesContext,
                              javax.faces.context.ResponseWriter writer,
                              javax.faces.component.UIData uiData,
                              HtmlTableRendererBase.Styles styles,
                              int rowStyleIndex)
                       throws java.io.IOException
Overrides:
renderRowStyle in class HtmlTableRendererBase
Throws:
java.io.IOException
See Also:
org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase#renderRowStyle(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIData, java.util.Iterator)

renderRowAttribute

protected void renderRowAttribute(javax.faces.context.ResponseWriter writer,
                                  java.lang.String htmlAttribute,
                                  java.lang.Object value)
                           throws java.io.IOException
Throws:
java.io.IOException

encodeColumnChild

protected void encodeColumnChild(javax.faces.context.FacesContext facesContext,
                                 javax.faces.context.ResponseWriter writer,
                                 javax.faces.component.UIData uiData,
                                 javax.faces.component.UIComponent component,
                                 HtmlTableRendererBase.Styles styles,
                                 int columnStyleIndex)
                          throws java.io.IOException
Render the specified column object using the current row data.

When the component is a UIColumn object, the inherited method is invoked to render a single table cell.

In addition to the inherited functionality, support is implemented here for UIColumns children. When a UIColumns child is encountered: 

 For each dynamic column in that UIColumns child:
   * Select the column (which sets variable named by the var attribute
     to refer to the current column object) 
   * Call this.renderColumnBody passing the UIColumns object.
The renderColumnBody method eventually: If the children of the UIColumns access the variable named by the var attribute on the UIColumns object, then they end up rendering content that is extracted from the current column object.

Overrides:
encodeColumnChild in class HtmlTableRendererBase
Throws:
java.io.IOException
See Also:
org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase#encodeColumnChild(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIData, javax.faces.component.UIComponent, java.util.Iterator)

renderColumnBody

protected void renderColumnBody(javax.faces.context.FacesContext facesContext,
                                javax.faces.context.ResponseWriter writer,
                                javax.faces.component.UIData uiData,
                                javax.faces.component.UIComponent component,
                                HtmlTableRendererBase.Styles styles,
                                int columnStyleIndex)
                         throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Renders the body of a given UIColumn (everything but the header and footer facets). This emits a TD cell, whose contents are the result of calling encodeBegin, encodeChildren and encodeEnd methods on the component (or its associated renderer).

Overrides:
renderColumnBody in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
writer - the ResponseWriter.
uiData - the UIData being rendered.
component - the UIComponent to render.
styles - the styleClasses of rows and columns
columnStyleIndex - the index of the column
Throws:
java.io.IOException - if an exception occurs.
See Also:
org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlTableRendererBase#renderColumnBody(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIData, javax.faces.component.UIComponent, java.util.Iterator)

renderColumnChildHeaderOrFooterRow

protected void renderColumnChildHeaderOrFooterRow(javax.faces.context.FacesContext facesContext,
                                                  javax.faces.context.ResponseWriter writer,
                                                  javax.faces.component.UIComponent uiComponent,
                                                  java.lang.String styleClass,
                                                  boolean header)
                                           throws java.io.IOException
Render the header or footer of the specified column object.

When the component is a UIColumn object, the inherited method is invoked to render a single header cell.

In addition to the inherited functionality, support is implemented here for UIColumns children. When a UIColumns child is encountered: 

 For each dynamic column in that UIColumns child:
   * Select the column (which sets variable named by the var attribute
     to refer to the current column object) 
   * Call this.renderColumnHeaderCell or this.renderColumnFooterCell
     passing the header or footer facet of the UIColumns object.
If the facet of the UIColumns accesses the variable named by the var attribute on the UIColumns object, then it ends up rendering content that is extracted from the current column object.

Overrides:
renderColumnChildHeaderOrFooterRow in class HtmlTableRendererBase
Throws:
java.io.IOException
See Also:
HtmlTableRendererBase.renderColumnChildHeaderOrFooterRow(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIComponent, java.lang.String, boolean)

renderColumnHeaderCell

protected void renderColumnHeaderCell(javax.faces.context.FacesContext facesContext,
                                      javax.faces.context.ResponseWriter writer,
                                      javax.faces.component.UIComponent uiComponent,
                                      javax.faces.component.UIComponent facet,
                                      java.lang.String headerStyleClass,
                                      int colspan)
                               throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Renders a TH cell within a TR within a THEAD section. If the specified UIColumn object does have a header facet, then that facet is rendered within the cell, otherwise the cell is left blank (though any specified style class is still applied to empty cells).

Overrides:
renderColumnHeaderCell in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
writer - the ResponseWriter.
uiComponent - the UIComponent to render the facet for.
facet - the UIComponent to render as facet.
headerStyleClass - the styleClass of the header facet.
colspan - the colspan for the tableData element in which the header facet will be wrapped.
Throws:
java.io.IOException
See Also:
HtmlTableRendererBase.renderColumnHeaderCell(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIComponent, javax.faces.component.UIComponent, java.lang.String, int)

renderColumnFooterCell

protected void renderColumnFooterCell(javax.faces.context.FacesContext facesContext,
                                      javax.faces.context.ResponseWriter writer,
                                      javax.faces.component.UIComponent uiComponent,
                                      javax.faces.component.UIComponent facet,
                                      java.lang.String footerStyleClass,
                                      int colspan)
                               throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Renders the footer facet for the given UIColumn.

Overrides:
renderColumnFooterCell in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
writer - the ResponseWriter.
uiComponent - the UIComponent to render the facet for.
facet - the UIComponent to render as facet.
footerStyleClass - the styleClass of the footer facet.
colspan - the colspan for the tableData element in which the footer facet will be wrapped.
Throws:
java.io.IOException
See Also:
HtmlTableRendererBase.renderColumnFooterCell(javax.faces.context.FacesContext, javax.faces.context.ResponseWriter, javax.faces.component.UIComponent, javax.faces.component.UIComponent, java.lang.String, int)

renderHtmlColumnAttributes

protected void renderHtmlColumnAttributes(javax.faces.context.ResponseWriter writer,
                                          javax.faces.component.UIComponent uiComponent,
                                          java.lang.String prefix)
                                   throws java.io.IOException
Throws:
java.io.IOException

determineChildColSpan

protected int determineChildColSpan(javax.faces.component.UIComponent uiComponent)
Return the number of columns spanned by the specified component.

For normal components, use the inherited implementation. For UIColumns children, return the number of dynamic columns rendered by that child.

Overrides:
determineChildColSpan in class HtmlTableRendererBase
See Also:
#determineChildColSpan(javax.faces.component.UIComponent)

hasFacet

protected boolean hasFacet(boolean header,
                           javax.faces.component.UIComponent uiComponent)
Return true if the specified component has a facet that needs to be rendered in a THEAD or TFOOT section.

Overrides:
hasFacet in class HtmlTableRendererBase
Parameters:
header -
uiComponent -
Returns:
boolean
See Also:
HtmlTableRendererBase.hasFacet(boolean, javax.faces.component.UIComponent)

renderColumnFooterRow

protected void renderColumnFooterRow(javax.faces.context.FacesContext facesContext,
                                     javax.faces.context.ResponseWriter writer,
                                     javax.faces.component.UIComponent component,
                                     java.lang.String footerStyleClass)
                              throws java.io.IOException
Renders the column footer. Rendering will be supressed if all of the facets have rendered="false"

Overrides:
renderColumnFooterRow in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
writer - the ResponseWriter.
component - the UIComponent for whom a table is being rendered.
footerStyleClass - the styleClass of the footerStyleClass
Throws:
java.io.IOException - if an exception occurs.

renderColumnHeaderRow

protected void renderColumnHeaderRow(javax.faces.context.FacesContext facesContext,
                                     javax.faces.context.ResponseWriter writer,
                                     javax.faces.component.UIComponent component,
                                     java.lang.String headerStyleClass)
                              throws java.io.IOException
Renders the column header. Rendering will be supressed if all of the facets have rendered="false"

Overrides:
renderColumnHeaderRow in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
writer - the ResponseWriter.
component - the UIData component for whom a table is being rendered.
headerStyleClass - the styleClass of the header
Throws:
java.io.IOException - if an exception occurs.

determineRenderFacet

protected boolean determineRenderFacet(javax.faces.component.UIComponent component,
                                       boolean header)
determine if the header or footer should be rendered.

beforeColumn

protected void beforeColumn(javax.faces.context.FacesContext facesContext,
                            javax.faces.component.UIData uiData,
                            int columnIndex)
                     throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Perform any operations necessary immediately before each column child is rendered

Overrides:
beforeColumn in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
uiData - the UIData being rendered.
columnIndex - the index of the currenly rendered column
Throws:
java.io.IOException

beforeColumnHeaderOrFooter

protected void beforeColumnHeaderOrFooter(javax.faces.context.FacesContext facesContext,
                                          javax.faces.component.UIData uiData,
                                          boolean header,
                                          int columnIndex)
                                   throws java.io.IOException
Description copied from class: HtmlTableRendererBase
Perform any operations necessary immediately before each column child's header or footer is rendered

Overrides:
beforeColumnHeaderOrFooter in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
uiData - the UIData being rendered.
header - true if the header of the column child is rendered
columnIndex - the index of the currenly rendered column
Throws:
java.io.IOException

putSortedReqScopeParam

protected void putSortedReqScopeParam(javax.faces.context.FacesContext facesContext,
                                      HtmlDataTable dataTable,
                                      int columnIndex)

amISpannedOver

protected boolean amISpannedOver(java.lang.String prefix,
                                 javax.faces.component.UIComponent component)
specify if the header, footer or is spanned over (not shown) because of a colspan in a cell in a previous column

Parameters:
prefix - header, footer or null

inBodyStart

protected void inBodyStart(javax.faces.context.FacesContext facesContext,
                           javax.faces.component.UIData uiData)
                    throws java.io.IOException
Perform any operations necessary in the TBODY start tag.

Overrides:
inBodyStart in class HtmlTableRendererBase
Parameters:
facesContext - the FacesContext.
uiData - the UIData being rendered.
Throws:
java.io.IOException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2007 Apache Software Foundation. All Rights Reserved.