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 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 Description BaseTableRenderer()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
clearMetaInfo(FacesContext context, UIComponent table)
Removes the cached TableMetaInfo from the specified component.protected String
createKey(UIComponent table)
Creates a unique key based on the providedUIComponent
with which the TableMetaInfo can be looked up.protected BaseTableRenderer.TableMetaInfo
getMetaInfo(FacesContext context, UIComponent table)
Returns aTableMetaInfo
object containing details such as row and column classes, columns, and a mechanism for scrolling through the row/column classes.protected void
renderCaption(FacesContext context, UIComponent table, ResponseWriter writer)
Renders the caption of the table applying the values ofcaptionClass
as the class andcaptionStyle
as the style if either are present.protected abstract void
renderFooter(FacesContext context, UIComponent table, ResponseWriter writer)
Called to render the opening/closingtfoot
elements and any content nested between.protected abstract void
renderHeader(FacesContext context, UIComponent table, ResponseWriter writer)
Called to render the opening/closingthead
elements and any content nested between.protected abstract void
renderRow(FacesContext context, UIComponent table, UIComponent row, ResponseWriter writer)
Call to render the content that should be included between opening and closingtr
elements.protected void
renderRowEnd(FacesContext context, UIComponent table, ResponseWriter writer)
Renders the closingrt
element.protected void
renderRowStart(FacesContext context, UIComponent table, ResponseWriter writer)
Renders the startingtr
element applying any values from therowClasses
attribute.protected void
renderTableBodyEnd(FacesContext context, UIComponent table, ResponseWriter writer)
Renders the closingtbody
element.protected void
renderTableBodyStart(FacesContext context, UIComponent table, ResponseWriter writer)
Renders the startingtbody
element.protected void
renderTableEnd(FacesContext context, UIComponent table, ResponseWriter writer)
Renders the closingtable
element.protected void
renderTableStart(FacesContext context, UIComponent table, ResponseWriter writer, Attribute[] attributes)
Renders the start of a table and applies the value ofstyleClass
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
-
-
-
-
Method Detail
-
renderHeader
protected abstract void renderHeader(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Called to render the opening/closingthead
elements and any content nested between.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
renderFooter
protected abstract void renderFooter(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Called to render the opening/closingtfoot
elements and any content nested between.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
renderRow
protected abstract void renderRow(FacesContext context, UIComponent table, UIComponent row, ResponseWriter writer) throws IOException
Call to render the content that should be included between opening and closingtr
elements.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedrow
- 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(FacesContext context, UIComponent table, ResponseWriter writer, Attribute[] attributes) throws IOException
Renders the start of a table and applies the value ofstyleClass
if available and renders any pass through attributes that may be specified.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writerattributes
- pass-through attributes that the component supports- Throws:
IOException
- if content cannot be written
-
renderTableEnd
protected void renderTableEnd(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Renders the closingtable
element.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
renderCaption
protected void renderCaption(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Renders the caption of the table applying the values ofcaptionClass
as the class andcaptionStyle
as the style if either are present.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
renderTableBodyStart
protected void renderTableBodyStart(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Renders the startingtbody
element.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
renderTableBodyEnd
protected void renderTableBodyEnd(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Renders the closingtbody
element.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
renderRowStart
protected void renderRowStart(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Renders the startingtr
element applying any values from therowClasses
attribute.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
renderRowEnd
protected void renderRowEnd(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException
Renders the closingrt
element.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being renderedwriter
- the current writer- Throws:
IOException
- if content cannot be written
-
getMetaInfo
protected BaseTableRenderer.TableMetaInfo getMetaInfo(FacesContext context, UIComponent table)
Returns aTableMetaInfo
object containing details such as row and column classes, columns, and a mechanism for scrolling through the row/column classes.- Parameters:
context
- theFacesContext
for the current requesttable
- the table that's being rendered- Returns:
- the
TableMetaInfo
for provided table
-
clearMetaInfo
protected void clearMetaInfo(FacesContext context, UIComponent table)
Removes the cached TableMetaInfo from the specified component.- Parameters:
context
- theFacesContext
for the current requesttable
- the table from which the TableMetaInfo will be removed
-
createKey
protected String createKey(UIComponent table)
Creates a unique key based on the providedUIComponent
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.
-
-