Package com.sun.faces.renderkit.html_basic

Class TableRenderer

java.lang.Object

jakarta.faces.render.Renderer

com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

com.sun.faces.renderkit.html_basic.BaseTableRenderer

com.sun.faces.renderkit.html_basic.TableRenderer

public class TableRenderer
extends BaseTableRenderer

Render a UIData component as a two-dimensional table.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.faces.renderkit.html_basic.BaseTableRenderer

BaseTableRenderer.TableMetaInfo

Nested classes/interfaces inherited from class com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

HtmlBasicRenderer.OptionComponentInfo, HtmlBasicRenderer.Param

Field Summary

Fields inherited from class com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

EMPTY_PARAMS, logger

Fields inherited from class jakarta.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor	Description
TableRenderer()

Method Summary

Modifier and Type	Method	Description
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.
boolean	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)
protected void	renderFooter(FacesContext context, UIComponent table, ResponseWriter writer)	Called to render the opening/closing tfoot elements and any content nested between.
protected void	renderHeader(FacesContext context, UIComponent table, ResponseWriter writer)	Called to render the opening/closing thead elements and any content nested between.
protected void	renderRow(FacesContext context, UIComponent table, UIComponent child, ResponseWriter writer)	Call to render the content that should be included between opening and closing tr elements.

Methods inherited from class com.sun.faces.renderkit.html_basic.BaseTableRenderer

clearMetaInfo, createKey, getMetaInfo, renderCaption, renderRowEnd, renderRowStart, renderTableBodyEnd, renderTableBodyStart, renderTableEnd, renderTableStart

Methods inherited from class com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

augmentIdReference, convertClientId, decode, decodeBehaviors, encodeRecursive, getBehaviorParameters, getChildren, getCurrentValue, getEndTextToRender, getFacet, getForComponent, getFormattedValue, getFormattedValue, getMessageIter, getParamList, getPassThruBehaviors, getValue, isBehaviorSource, rendererParamsNotNull, setSubmittedValue, shouldDecode, shouldEncode, shouldEncodeChildren, shouldWriteIdAttribute, writeIdAttributeIfNecessary

Methods inherited from class jakarta.faces.render.Renderer

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(FacesContext context,
                        UIComponent component)
                 throws IOException

Description copied from class: Renderer

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:

IOException - if an input/output error occurs while rendering

encodeChildren

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

Description copied from class: Renderer

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:

IOException - if an input/output error occurs while rendering

encodeEnd

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

Description copied from class: Renderer

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 HtmlBasicRenderer

Parameters:

context - FacesContext for the response we are creating

component - UIComponent to be rendered

Throws:

IOException - if an input/output error occurs while rendering

getRendersChildren

public boolean getRendersChildren()

Description copied from class: Renderer

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 HtmlBasicRenderer

Returns:

the current value of the flag

renderColumnGroups

protected void renderColumnGroups(FacesContext context,
                                  UIComponent table)
                           throws IOException

Throws:

IOException

renderFooter

protected void renderFooter(FacesContext context,
                            UIComponent table,
                            ResponseWriter writer)
                     throws IOException

Description copied from class: BaseTableRenderer

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

Specified by:

renderFooter in class BaseTableRenderer

Parameters:

context - the FacesContext for the current request

table - the table that's being rendered

writer - the current writer

Throws:

IOException - if content cannot be written

renderHeader

protected void renderHeader(FacesContext context,
                            UIComponent table,
                            ResponseWriter writer)
                     throws IOException

Description copied from class: BaseTableRenderer

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

Specified by:

renderHeader in class BaseTableRenderer

Parameters:

context - the FacesContext for the current request

table - the table that's being rendered

writer - the current writer

Throws:

IOException - if content cannot be written

renderRow

protected void renderRow(FacesContext context,
                         UIComponent table,
                         UIComponent child,
                         ResponseWriter writer)
                  throws IOException

Description copied from class: BaseTableRenderer

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

Specified by:

renderRow in class BaseTableRenderer

Parameters:

context - the FacesContext for the current request

table - the table that's being rendered

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

writer - the current writer

Throws:

IOException - if content cannot be written