Modifier and Type	Class and Description
protected static class	BaseTableRenderer.TableMetaInfo

Access	Constructor and Description
public	BaseTableRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	clearMetaInfo(FacesContext the `FacesContext` for the current request context, UIComponent the table from which the TableMetaInfo will be removed table) Removes the cached TableMetaInfo from the specified component.
protected String	Returns: a unique key to store the metadata in the request and still have it associated with a specific component. createKey(UIComponent the table that's being rendered table) Creates a unique key based on the provided `UIComponent` with which the TableMetaInfo can be looked up.
protected BaseTableRenderer.TableMetaInfo	Returns: the `TableMetaInfo` for provided table getMetaInfo(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered 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(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer 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(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer) Called to render the opening/closing `tfoot` elements and any content nested between.
protected abstract void	renderHeader(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer) Called to render the opening/closing `thead` elements and any content nested between.
protected abstract 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) row, ResponseWriter the current writer writer) Call to render the content that should be included between opening and closing `tr` elements.
protected void	renderRowEnd(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer) Renders the closing `rt` element.
protected void	renderRowStart(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer) Renders the starting `tr` element applying any values from the `rowClasses` attribute.
protected void	renderTableBodyEnd(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer) Renders the closing `tbody` element.
protected void	renderTableBodyStart(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer) Renders the starting `tbody` element.
protected void	renderTableEnd(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer) Renders the closing `table` element.
protected void	renderTableStart(FacesContext the `FacesContext` for the current request context, UIComponent the table that's being rendered table, ResponseWriter the current writer writer, Attribute[] pass-through attributes that the component supports 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.

Constructor Detail

BaseTableRenderer	back to summary
public BaseTableRenderer()

Method Detail

clearMetaInfo back to summary

clearMetaInfo	back to summary
protected void clearMetaInfo(FacesContext context, UIComponent table) Removes the cached TableMetaInfo from the specified component. Parameters context:FacesContext the `FacesContext` for the current request table:UIComponent the table from which the TableMetaInfo will be removed

protected void clearMetaInfo(FacesContext context, UIComponent table)

Removes the cached TableMetaInfo from the specified component.

Parameters

context:FacesContext: the FacesContext for the current request
table:UIComponent: the table from which the TableMetaInfo will be removed

createKey back to summary

createKey	back to summary
protected String createKey(UIComponent table) Creates a unique key based on the provided `UIComponent` with which the TableMetaInfo can be looked up. Parameters table:UIComponent the table that's being rendered Returns:String a unique key to store the metadata in the request and still have it associated with a specific component.

protected String createKey(UIComponent table)

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

Parameters

table:UIComponent: the table that's being rendered

Returns:String

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

getMetaInfo back to summary

getMetaInfo	back to summary
protected BaseTableRenderer.TableMetaInfo getMetaInfo(FacesContext context, 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:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered Returns:BaseTableRenderer.TableMetaInfo the `TableMetaInfo` for provided table

protected BaseTableRenderer.TableMetaInfo getMetaInfo(FacesContext context, 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:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered

Returns:BaseTableRenderer.TableMetaInfo

the TableMetaInfo for provided table

renderCaption back to summary

renderCaption	back to summary
protected void renderCaption(FacesContext context, UIComponent table, 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:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered writer:ResponseWriter the current writer Exceptions IOException: if content cannot be written

protected void renderCaption(FacesContext context, UIComponent table, 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:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
writer:ResponseWriter: the current writer

Exceptions

IOException:: if content cannot be written

renderFooter back to summary

renderFooter	back to summary
protected abstract void renderFooter(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException 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 Exceptions IOException: if content cannot be written

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

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

Exceptions

IOException:: if content cannot be written

renderHeader back to summary

renderHeader	back to summary
protected abstract void renderHeader(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException 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 Exceptions IOException: if content cannot be written

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

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

Exceptions

IOException:: if content cannot be written

renderRow back to summary

renderRow	back to summary
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 closing `tr` elements. Parameters context:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered row:UIComponent the current row (if any - an implmenetation may not need this) writer:ResponseWriter the current writer Exceptions IOException: if content cannot be written

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 closing tr elements.

Parameters

context:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
row:UIComponent: the current row (if any - an implmenetation may not need this)
writer:ResponseWriter: the current writer

Exceptions

IOException:: if content cannot be written

renderRowEnd back to summary

renderRowEnd	back to summary
protected void renderRowEnd(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException Renders the closing `rt` element. Parameters context:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered writer:ResponseWriter the current writer Annotations @SuppressWarnings:UnusedDeclaration Exceptions IOException: if content cannot be written

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

Renders the closing rt element.

Parameters

context:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
writer:ResponseWriter: the current writer

Annotations

@SuppressWarnings:UnusedDeclaration

Exceptions

IOException:: if content cannot be written

renderRowStart back to summary

renderRowStart	back to summary
protected void renderRowStart(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException Renders the starting `tr` element applying any values from the `rowClasses` attribute. Parameters context:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered writer:ResponseWriter the current writer Exceptions IOException: if content cannot be written

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

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

Parameters

context:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
writer:ResponseWriter: the current writer

Exceptions

IOException:: if content cannot be written

renderTableBodyEnd back to summary

renderTableBodyEnd	back to summary
protected void renderTableBodyEnd(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException Renders the closing `tbody` element. Parameters context:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered writer:ResponseWriter the current writer Annotations @SuppressWarnings:UnusedDeclaration Exceptions IOException: if content cannot be written

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

Renders the closing tbody element.

Parameters

context:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
writer:ResponseWriter: the current writer

Annotations

@SuppressWarnings:UnusedDeclaration

Exceptions

IOException:: if content cannot be written

renderTableBodyStart back to summary

renderTableBodyStart	back to summary
protected void renderTableBodyStart(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException Renders the starting `tbody` element. Parameters context:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered writer:ResponseWriter the current writer Annotations @SuppressWarnings:UnusedDeclaration Exceptions IOException: if content cannot be written

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

Renders the starting tbody element.

Parameters

context:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
writer:ResponseWriter: the current writer

Annotations

@SuppressWarnings:UnusedDeclaration

Exceptions

IOException:: if content cannot be written

renderTableEnd back to summary

renderTableEnd	back to summary
protected void renderTableEnd(FacesContext context, UIComponent table, ResponseWriter writer) throws IOException Renders the closing `table` element. Parameters context:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered writer:ResponseWriter the current writer Annotations @SuppressWarnings:UnusedDeclaration Exceptions IOException: if content cannot be written

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

Renders the closing table element.

Parameters

context:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
writer:ResponseWriter: the current writer

Annotations

@SuppressWarnings:UnusedDeclaration

Exceptions

IOException:: if content cannot be written

renderTableStart back to summary

renderTableStart	back to summary
protected void renderTableStart(FacesContext context, UIComponent table, 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:FacesContext the `FacesContext` for the current request table:UIComponent the table that's being rendered writer:ResponseWriter the current writer attributes:Attribute[] pass-through attributes that the component supports Exceptions IOException: if content cannot be written

protected void renderTableStart(FacesContext context, UIComponent table, 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:FacesContext: the FacesContext for the current request
table:UIComponent: the table that's being rendered
writer:ResponseWriter: the current writer
attributes:Attribute[]: pass-through attributes that the component supports

Exceptions

IOException:: if content cannot be written

com.sun.faces.renderkit.html_basic back to summary

protected Class BaseTableRenderer.TableMetaInfo

Class Inheritance

extends Object

java.lang.Object
com.sun.faces.renderkit.html_basic.BaseTableRenderer.TableMetaInfo

Field Summary

Modifier and Type	Field and Description
public final String[]	columnClasses
public final int	columnCount
public final List<UIColumn>	columns
public int	columnStyleCounter
private static final String[]	EMPTY_STRING_ARRAY
public final boolean	hasFooterFacets
public final boolean	hasHeaderFacets
public static final String	KEY
public final String[]	rowClasses
public int	rowStyleCounter

Constructor Summary

Access	Constructor and Description
public	TableMetaInfo(UIComponent table)

Method Summary

Modifier and Type	Method and Description
private static String[]	Returns: an array of column classes getColumnClasses(UIComponent `javax.faces.component.UIComponent` component being rendered table) Return an array of stylesheet classes to be applied to each column in the table in the order specified.
private static 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 String	Returns: the current style getCurrentColumnClass() Obtain the column class based on the current counter.
public String	Returns: the current style getCurrentRowClass() Obtain the row class based on the current counter.
private static String[]	Returns: an array of row classes getRowClasses(UIComponent `javax.faces.component.UIComponent` component being rendered table) Return an array of stylesheet classes to be applied to each row in the table, in the order specified.
private static boolean	Returns: the number of columns associated with the specified Facet name hasFacet(String Name of the facet being analyzed name, List<UIColumn> the columns to search columns) Return the number of child `UIColumn` components nested in the specified `UIData` that have a facet with the specified name.
public void	newRow() Reset the counter used to apply column styles.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

columnClasses	back to summary
public final String[] columnClasses

columnCount	back to summary
public final int columnCount

columns	back to summary
public final List<UIColumn> columns

columnStyleCounter	back to summary
public int columnStyleCounter

EMPTY_STRING_ARRAY	back to summary
private static final String[] EMPTY_STRING_ARRAY

hasFooterFacets	back to summary
public final boolean hasFooterFacets

hasHeaderFacets	back to summary
public final boolean hasHeaderFacets

KEY	back to summary
public static final String KEY

rowClasses	back to summary
public final String[] rowClasses

rowStyleCounter	back to summary
public int rowStyleCounter

Constructor Detail

TableMetaInfo	back to summary
public TableMetaInfo(UIComponent table)

Method Detail

getColumnClasses back to summary

getColumnClasses	back to summary
private static String[] getColumnClasses(UIComponent table) Return an array of stylesheet classes to be applied to each column in the table in the order specified. Every column may or may not have a stylesheet. Parameters table:UIComponent `javax.faces.component.UIComponent` component being rendered Returns:String[] an array of column classes

private static String[] getColumnClasses(UIComponent table)

Return an array of stylesheet classes to be applied to each column in the table in the order specified. Every column may or may not have a stylesheet.

Parameters

table:UIComponent: javax.faces.component.UIComponent component being rendered

Returns:String[]

an array of column classes

getColumns back to summary

getColumns	back to summary
private static 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

private static 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

getCurrentColumnClass	back to summary
public String getCurrentColumnClass() Obtain the column class based on the current counter. Calling this method automatically moves the pointer to the next style. If the counter is larger than the number of total classes, the counter will be reset. Returns:String the current style

getCurrentColumnClass

back to summary

public String getCurrentColumnClass()

Obtain the column class based on the current counter. Calling this method automatically moves the pointer to the next style. If the counter is larger than the number of total classes, the counter will be reset.

Returns:String: the current style

getCurrentRowClass	back to summary
public String getCurrentRowClass() Obtain the row class based on the current counter. Calling this method automatically moves the pointer to the next style. If the counter is larger than the number of total classes, the counter will be reset. Returns:String the current style

getCurrentRowClass

back to summary

public String getCurrentRowClass()

Obtain the row class based on the current counter. Calling this method automatically moves the pointer to the next style. If the counter is larger than the number of total classes, the counter will be reset.

Returns:String: the current style

getRowClasses back to summary

getRowClasses	back to summary
private static String[] getRowClasses(UIComponent table) Return an array of stylesheet classes to be applied to each row in the table, in the order specified. Every row may or may not have a stylesheet. Parameters table:UIComponent `javax.faces.component.UIComponent` component being rendered Returns:String[] an array of row classes

private static String[] getRowClasses(UIComponent table)

Return an array of stylesheet classes to be applied to each row in the table, in the order specified. Every row may or may not have a stylesheet.

Parameters

table:UIComponent: javax.faces.component.UIComponent component being rendered

Returns:String[]

an array of row classes

hasFacet back to summary

hasFacet	back to summary
private static boolean hasFacet(String name, List<UIColumn> columns) Return the number of child `UIColumn` components nested in the specified `UIData` that have a facet with the specified name. Parameters name:String Name of the facet being analyzed columns:List<UIColumn> the columns to search Returns:boolean the number of columns associated with the specified Facet name

private static boolean hasFacet(String name, List<UIColumn> columns)

Return the number of child UIColumn components nested in the specified UIData that have a facet with the specified name.

Parameters

name:String: Name of the facet being analyzed
columns:List<UIColumn>: the columns to search

Returns:boolean

the number of columns associated with the specified Facet name

newRow	back to summary
public void newRow() Reset the counter used to apply column styles.

public abstract Class BaseTableRenderer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

protected Class BaseTableRenderer.TableMetaInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail