org.apache.tapestry.contrib.table.components
Class TableValues

java.lang.Object
  extended by org.apache.hivemind.impl.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.BaseComponent
              extended by org.apache.tapestry.contrib.table.components.AbstractTableViewComponent
                  extended by org.apache.tapestry.contrib.table.components.AbstractTableRowComponent
                      extended by org.apache.tapestry.contrib.table.components.TableValues
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, org.apache.tapestry.IComponent, org.apache.tapestry.IRender, org.apache.tapestry.ITemplateComponent

public abstract class TableValues
extends AbstractTableRowComponent

A low level Table component that generates the columns in the current row in the table. This component must be wrapped by TableRows.

The component iterates over the columns in the table and automatically renders the column values for the current table row. The columns are wrapped in 'td' tags by default.
The column values are rendered using the renderer returned by the getValueRenderer() method in ITableColumn.

Please see the Component Reference for details on how to use this component. [ Component Reference ]

Author:
mindbridge

Field Summary
static java.lang.String TABLE_VALUE_CSS_CLASS_SUFFIX
           
 
Constructor Summary
TableValues()
           
 
Method Summary
protected  void cleanupAfterRender(org.apache.tapestry.IRequestCycle cycle)
           
abstract  java.lang.String getCellClass()
           
 ITableColumn getTableColumn()
          Returns the currently rendered table column.
 java.util.Iterator getTableColumnIterator()
          Get the list of all table columns to be displayed.
 org.apache.tapestry.IRender getTableValueRenderer()
          Returns the renderer to be used to generate the appearance of the current column
 java.lang.String getValueClass()
          Returns the CSS class of the generated table cell.
abstract  void setColumnParameter(ITableColumn column)
           
 void setTableColumn(ITableColumn tableColumn)
          Sets the currently rendered table column.
 
Methods inherited from class org.apache.tapestry.contrib.table.components.AbstractTableRowComponent
getTableRowSource
 
Methods inherited from class org.apache.tapestry.contrib.table.components.AbstractTableViewComponent
getTableModelSource
 
Methods inherited from class org.apache.tapestry.BaseComponent
addOuter, finishLoad, renderComponent
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, enterActiveState, finishLoad, format, format, format, format, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isInActiveState, isParameterBound, isRendering, pageEndRender, prepareForRender, render, renderBody, renderInformalParameters, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty, toString
 
Methods inherited from class org.apache.hivemind.impl.BaseLocatable
getLocation, setLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.tapestry.IComponent
addAsset, addBody, addComponent, enterActiveState, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getComponent, getComponents, getContainedComponent, getContainer, getExtendedId, getId, getIdPath, getListeners, getMessage, getMessages, getNamespace, getPage, getProperty, getSpecification, isRendering, renderBody, setBinding, setContainedComponent, setContainer, setId, setNamespace, setPage, setProperty
 
Methods inherited from interface org.apache.tapestry.IRender
render
 
Methods inherited from interface org.apache.hivemind.LocationHolder
setLocation
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Field Detail

TABLE_VALUE_CSS_CLASS_SUFFIX

public static final java.lang.String TABLE_VALUE_CSS_CLASS_SUFFIX
See Also:
Constant Field Values
Constructor Detail

TableValues

public TableValues()
Method Detail

getTableColumnIterator

public java.util.Iterator getTableColumnIterator()
Get the list of all table columns to be displayed.

Returns:
an iterator of all table columns

getTableColumn

public ITableColumn getTableColumn()
Returns the currently rendered table column. You can call this method to obtain the current column.

Returns:
ITableColumn the current table column

setTableColumn

public void setTableColumn(ITableColumn tableColumn)
Sets the currently rendered table column. This method is for internal use only.

Parameters:
tableColumn - The current table column

getTableValueRenderer

public org.apache.tapestry.IRender getTableValueRenderer()
Returns the renderer to be used to generate the appearance of the current column

Returns:
the value renderer of the current column

getValueClass

public java.lang.String getValueClass()
Returns the CSS class of the generated table cell. It uses the class parameter if it has been bound, or the default value of "[column name]ColumnValue" otherwise.

Returns:
the CSS class of the cell

cleanupAfterRender

protected void cleanupAfterRender(org.apache.tapestry.IRequestCycle cycle)
Overrides:
cleanupAfterRender in class org.apache.tapestry.AbstractComponent
Since:
4.0

setColumnParameter

public abstract void setColumnParameter(ITableColumn column)
Since:
4.0

getCellClass

public abstract java.lang.String getCellClass()
Since:
4.0