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

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.TableColumns
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 TableColumns
extends AbstractTableViewComponent

A low level Table component that renders the column headers in the table. This component must be wrapped by TableView.

The component iterates over all column objects in the ITableColumnModeland renders a header for each one of them using the renderer provided by the getColumnRender() method in ITableColumn. The headers are wrapped in 'th' tags by default.

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

Author:
mindbridge

Field Summary
static java.lang.String TABLE_COLUMN_ARROW_DOWN_ATTRIBUTE
           
static java.lang.String TABLE_COLUMN_ARROW_UP_ATTRIBUTE
           
static java.lang.String TABLE_COLUMN_CSS_CLASS_SUFFIX
           
 
Constructor Summary
TableColumns()
           
 
Method Summary
abstract  org.apache.tapestry.IAsset getArrowDownAsset()
           
abstract  org.apache.tapestry.IAsset getArrowUpAsset()
           
 java.lang.String getColumnClass()
          Returns the CSS class of the generated table cell.
abstract  java.lang.String getColumnClassParameter()
           
 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 getTableColumnRenderer()
          Returns the renderer to be used to generate the header of the current column
protected  void renderComponent(org.apache.tapestry.IMarkupWriter writer, org.apache.tapestry.IRequestCycle cycle)
           
abstract  void setColumn(ITableColumn column)
           
 void setTableColumn(ITableColumn tableColumn)
          Sets the currently rendered table column.
 
Methods inherited from class org.apache.tapestry.contrib.table.components.AbstractTableViewComponent
getTableModelSource
 
Methods inherited from class org.apache.tapestry.BaseComponent
addOuter, finishLoad
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, 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_COLUMN_ARROW_UP_ATTRIBUTE

public static final java.lang.String TABLE_COLUMN_ARROW_UP_ATTRIBUTE
See Also:
Constant Field Values

TABLE_COLUMN_ARROW_DOWN_ATTRIBUTE

public static final java.lang.String TABLE_COLUMN_ARROW_DOWN_ATTRIBUTE
See Also:
Constant Field Values

TABLE_COLUMN_CSS_CLASS_SUFFIX

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

TableColumns

public TableColumns()
Method Detail

getArrowDownAsset

public abstract org.apache.tapestry.IAsset getArrowDownAsset()

getArrowUpAsset

public abstract org.apache.tapestry.IAsset getArrowUpAsset()

setColumn

public abstract void setColumn(ITableColumn column)

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

getTableColumnIterator

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

Returns:
an iterator of all table columns

getTableColumnRenderer

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

Returns:
the header renderer of the current column

getColumnClassParameter

public abstract java.lang.String getColumnClassParameter()

getColumnClass

public java.lang.String getColumnClass()
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]ColumnHeader" otherwise.

Returns:
the CSS class of the cell

renderComponent

protected void renderComponent(org.apache.tapestry.IMarkupWriter writer,
                               org.apache.tapestry.IRequestCycle cycle)
Overrides:
renderComponent in class org.apache.tapestry.BaseComponent
See Also:
BaseComponent.renderComponent(IMarkupWriter, IRequestCycle)