Top Description Fields Constructors Methods
com.sun.faces.renderkit.html_basic

public Class TableRenderer

extends BaseTableRenderer
Class Inheritance
Imports
com.sun.faces.renderkit.Attribute, .AttributeManager, com.sun.faces.util.Util, java.io.IOException, java.util.ArrayList, .Collections, .Iterator, .List, .Map, javax.faces.component.UIColumn, .UIComponent, .UIData, javax.faces.context.FacesContext, .ResponseWriter

Render a UIData component as a two-dimensional table.

Field Summary

Modifier and TypeField and Description
private static final Attribute[]
ATTRIBUTES

Constructor Summary

AccessConstructor and Description
public
TableRenderer()

Method Summary

Modifier and TypeMethod and Description
public void
encodeBegin(FacesContext
FacesContext for the request we are processing
context, UIComponent
UIComponent to be rendered
component)

Overrides javax.faces.render.Renderer.encodeBegin.

Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating.

public void
encodeChildren(FacesContext
FacesContext for the response we are creating
context, UIComponent
UIComponent whose children are to be rendered
component)

Overrides javax.faces.render.Renderer.encodeChildren.

Render the child components of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered.

public void
encodeEnd(FacesContext
FacesContext for the response we are creating
context, UIComponent
UIComponent to be rendered
component)

Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.encodeEnd.

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.

private List<Integer>
getBodyRows(Map<String, Object> appMap, UIData data)

private List<UIColumn>

Returns:

the List of all UIColumn children
getColumns(UIComponent
the table from which to extract children
table)

Return an Iterator over the UIColumn children of the specified UIData that have a rendered property of true.

public boolean
getRendersChildren()

Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.getRendersChildren.

Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render.

protected void
renderColumnGroups(FacesContext context, UIComponent table)

private void
renderEmptyTableBody(final ResponseWriter writer, final UIComponent component)

private void
renderEmptyTableRow(final ResponseWriter writer, final UIComponent component)

protected void
renderFooter(FacesContext
the FacesContext for the current request
context, UIComponent
the table that's being rendered
table, ResponseWriter
the current writer
writer)

Implements abstract com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderFooter.

Called to render the opening/closing tfoot elements and any content nested between.
protected void
renderHeader(FacesContext
the FacesContext for the current request
context, UIComponent
the table that's being rendered
table, ResponseWriter
the current writer
writer)

Implements abstract com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderHeader.

Called to render the opening/closing thead elements and any content nested between.
protected void
renderRow(FacesContext
the FacesContext for the current request
context, UIComponent
the table that's being rendered
table, UIComponent
the current row (if any - an implmenetation may not need this)
child, ResponseWriter
the current writer
writer)

Implements abstract com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderRow.

Call to render the content that should be included between opening and closing tr elements.
Inherited from com.sun.faces.renderkit.html_basic.BaseTableRenderer:
clearMetaInfocreateKeygetMetaInforenderCaptionrenderRowEndrenderRowStartrenderTableBodyEndrenderTableBodyStartrenderTableEndrenderTableStart

Field Detail

ATTRIBUTESback to summary
private static final Attribute[] ATTRIBUTES

Constructor Detail

TableRendererback to summary
public TableRenderer()

Method Detail

encodeBeginback to summary
public void encodeBegin(FacesContext context, UIComponent component) throws IOException

Overrides javax.faces.render.Renderer.encodeBegin.

Doc from javax.faces.render.Renderer.encodeBegin.

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.

Parameters
context:FacesContext

FacesContext for the request we are processing

component:UIComponent

UIComponent to be rendered

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs while rendering
encodeChildrenback to summary
public void encodeChildren(FacesContext context, UIComponent component) throws IOException

Overrides javax.faces.render.Renderer.encodeChildren.

Doc from javax.faces.render.Renderer.encodeChildren.

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.

Parameters
context:FacesContext

FacesContext for the response we are creating

component:UIComponent

UIComponent whose children are to be rendered

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs while rendering
encodeEndback to summary
public void encodeEnd(FacesContext context, UIComponent component) throws IOException

Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.encodeEnd.

Doc from javax.faces.render.Renderer.encodeEnd.

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.

Parameters
context:FacesContext

FacesContext for the response we are creating

component:UIComponent

UIComponent to be rendered

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs while rendering
getBodyRowsback to summary
private List<Integer> getBodyRows(Map<String, Object> appMap, UIData data)
getColumnsback to summary
private List<UIColumn> getColumns(UIComponent table)

Return an Iterator over the UIColumn children of the specified UIData that have a rendered property of true.

Parameters
table:UIComponent

the table from which to extract children

Returns:List<UIColumn>

the List of all UIColumn children

getRendersChildrenback to summary
public boolean getRendersChildren()

Overrides com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.getRendersChildren.

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

Returns:boolean

the current value of the flag

Annotations
@Override
renderColumnGroupsback to summary
protected void renderColumnGroups(FacesContext context, UIComponent table) throws IOException
renderEmptyTableBodyback to summary
private void renderEmptyTableBody(final ResponseWriter writer, final UIComponent component) throws IOException
renderEmptyTableRowback to summary
private void renderEmptyTableRow(final ResponseWriter writer, final UIComponent component) throws IOException
renderFooterback to summary
protected void renderFooter(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException

Implements abstract com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderFooter.

Doc from com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderFooter.

Called to render the opening/closing tfoot elements and any content nested between.

Parameters
context:FacesContext

the FacesContext for the current request

table:UIComponent

the table that's being rendered

writer:ResponseWriter

the current writer

Annotations
@Override
Exceptions
IOException:
if content cannot be written
renderHeaderback to summary
protected void renderHeader(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException

Implements abstract com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderHeader.

Doc from com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderHeader.

Called to render the opening/closing thead elements and any content nested between.

Parameters
context:FacesContext

the FacesContext for the current request

table:UIComponent

the table that's being rendered

writer:ResponseWriter

the current writer

Annotations
@Override
Exceptions
IOException:
if content cannot be written
renderRowback to summary
protected void renderRow(FacesContext context, UIComponent table, UIComponent child, ResponseWriter writer) throws IOException

Implements abstract com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderRow.

Doc from com.sun.faces.renderkit.html_basic.BaseTableRenderer.renderRow.

Call to render the content that should be included between opening and closing tr elements.

Parameters
context:FacesContext

the FacesContext for the current request

table:UIComponent

the table that's being rendered

child:UIComponent

the current row (if any - an implmenetation may not need this)

writer:ResponseWriter

the current writer

Annotations
@Override
Exceptions
IOException:
if content cannot be written