com.sun.faces.renderkit.html_basic

Class BaseTableRenderer

java.lang.Object

jakarta.faces.render.Renderer

com.sun.faces.renderkit.html_basic.HtmlBasicRenderer

com.sun.faces.renderkit.html_basic.BaseTableRenderer

Direct Known Subclasses:

GridRenderer, TableRenderer

public abstract class BaseTableRenderer
extends HtmlBasicRenderer

Base class for concrete Grid and Table renderers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	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 and Description
BaseTableRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	clearMetaInfo(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table) Removes the cached TableMetaInfo from the specified component.
protected String	createKey(jakarta.faces.component.UIComponent table) Creates a unique key based on the provided UIComponent with which the TableMetaInfo can be looked up.
protected BaseTableRenderer.TableMetaInfo	getMetaInfo(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table) Returns a TableMetaInfo object containing details such as row and column classes, columns, and a mechanism for scrolling through the row/column classes.
protected void	renderCaption(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Renders the caption of the table applying the values of captionClass as the class and captionStyle as the style if either are present.
protected abstract void	renderFooter(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Called to render the opening/closing tfoot elements and any content nested between.
protected abstract void	renderHeader(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Called to render the opening/closing thead elements and any content nested between.
protected abstract void	renderRow(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.component.UIComponent row, jakarta.faces.context.ResponseWriter writer) Call to render the content that should be included between opening and closing tr elements.
protected void	renderRowEnd(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Renders the closing rt element.
protected void	renderRowStart(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Renders the starting tr element applying any values from the rowClasses attribute.
protected void	renderTableBodyEnd(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Renders the closing tbody element.
protected void	renderTableBodyStart(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Renders the starting tbody element.
protected void	renderTableEnd(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer) Renders the closing table element.
protected void	renderTableStart(jakarta.faces.context.FacesContext context, jakarta.faces.component.UIComponent table, jakarta.faces.context.ResponseWriter writer, Attribute[] attributes) Renders the start of a table and applies the value of styleClass if available and renders any pass through attributes that may be specified.

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

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

Methods inherited from class jakarta.faces.render.Renderer

encodeBegin, encodeChildren, getConvertedValue

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTableRenderer

public BaseTableRenderer()

Method Detail

renderHeader

protected abstract void renderHeader(jakarta.faces.context.FacesContext context,
                                     jakarta.faces.component.UIComponent table,
                                     jakarta.faces.context.ResponseWriter writer)
                              throws IOException

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

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

renderFooter

protected abstract void renderFooter(jakarta.faces.context.FacesContext context,
                                     jakarta.faces.component.UIComponent table,
                                     jakarta.faces.context.ResponseWriter writer)
                              throws IOException

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

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 abstract void renderRow(jakarta.faces.context.FacesContext context,
                                  jakarta.faces.component.UIComponent table,
                                  jakarta.faces.component.UIComponent row,
                                  jakarta.faces.context.ResponseWriter writer)
                           throws IOException

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

Parameters:

context - the FacesContext for the current request

table - the table that's being rendered

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

writer - the current writer

Throws:

IOException - if content cannot be written

renderTableStart

protected void renderTableStart(jakarta.faces.context.FacesContext context,
                                jakarta.faces.component.UIComponent table,
                                jakarta.faces.context.ResponseWriter writer,
                                Attribute[] attributes)
                         throws IOException

Renders the start of a table and applies the value of styleClass if available and renders any pass through attributes that may be specified.

Parameters:

context - the FacesContext for the current request

table - the table that's being rendered

writer - the current writer

attributes - pass-through attributes that the component supports

Throws:

IOException - if content cannot be written

renderTableEnd

protected void renderTableEnd(jakarta.faces.context.FacesContext context,
                              jakarta.faces.component.UIComponent table,
                              jakarta.faces.context.ResponseWriter writer)
                       throws IOException

Renders the closing table element.

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

renderCaption

protected void renderCaption(jakarta.faces.context.FacesContext context,
                             jakarta.faces.component.UIComponent table,
                             jakarta.faces.context.ResponseWriter writer)
                      throws IOException

Renders the caption of the table applying the values of captionClass as the class and captionStyle as the style if either are present.

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

renderTableBodyStart

protected void renderTableBodyStart(jakarta.faces.context.FacesContext context,
                                    jakarta.faces.component.UIComponent table,
                                    jakarta.faces.context.ResponseWriter writer)
                             throws IOException

Renders the starting tbody element.

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

renderTableBodyEnd

protected void renderTableBodyEnd(jakarta.faces.context.FacesContext context,
                                  jakarta.faces.component.UIComponent table,
                                  jakarta.faces.context.ResponseWriter writer)
                           throws IOException

Renders the closing tbody element.

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

renderRowStart

protected void renderRowStart(jakarta.faces.context.FacesContext context,
                              jakarta.faces.component.UIComponent table,
                              jakarta.faces.context.ResponseWriter writer)
                       throws IOException

Renders the starting tr element applying any values from the rowClasses attribute.

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

renderRowEnd

protected void renderRowEnd(jakarta.faces.context.FacesContext context,
                            jakarta.faces.component.UIComponent table,
                            jakarta.faces.context.ResponseWriter writer)
                     throws IOException

Renders the closing rt element.

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

getMetaInfo

protected BaseTableRenderer.TableMetaInfo getMetaInfo(jakarta.faces.context.FacesContext context,
                                                      jakarta.faces.component.UIComponent table)

Returns a TableMetaInfo object containing details such as row and column classes, columns, and a mechanism for scrolling through the row/column classes.

Parameters:

context - the FacesContext for the current request

table - the table that's being rendered

Returns:

the TableMetaInfo for provided table

clearMetaInfo

protected void clearMetaInfo(jakarta.faces.context.FacesContext context,
                             jakarta.faces.component.UIComponent table)

Removes the cached TableMetaInfo from the specified component.

Parameters:

context - the FacesContext for the current request

table - the table from which the TableMetaInfo will be removed

createKey

protected String createKey(jakarta.faces.component.UIComponent table)

Creates a unique key based on the provided UIComponent with which the TableMetaInfo can be looked up.

Parameters:

table - the table that's being rendered

Returns:

a unique key to store the metadata in the request and still have it associated with a specific component.