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

java.lang.Object
  org.apache.hivemind.impl.BaseLocatable
      org.apache.tapestry.AbstractComponent
          org.apache.tapestry.BaseComponent
              org.apache.tapestry.contrib.table.components.AbstractTableViewComponent
                  org.apache.tapestry.contrib.table.components.TableColumns

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IComponent, IDirectEvent, Component, IRender, 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 String	TABLE_COLUMN_ARROW_DOWN_ATTRIBUTE
static String	TABLE_COLUMN_ARROW_UP_ATTRIBUTE
static String	TABLE_COLUMN_CSS_CLASS_SUFFIX

Fields inherited from class org.apache.tapestry.AbstractComponent

_body, _bodyCount

Constructor Summary

TableColumns()

Method Summary

abstract IAsset	getArrowDownAsset()
abstract IAsset	getArrowUpAsset()
String	getColumnClass() Returns the CSS class of the generated table cell.
abstract String	getColumnClassParameter()
ITableColumn	getTableColumn() Returns the currently rendered table column.
Iterator	getTableColumnIterator() Get the list of all table columns to be displayed.
IRender	getTableColumnRenderer() Returns the renderer to be used to generate the header of the current column.
protected void	renderComponent(IMarkupWriter writer, IRequestCycle cycle) Renders the top level components contained by the receiver.
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, getContainedRenderers, getInnerRenderers

Methods inherited from class org.apache.tapestry.AbstractComponent

addAsset, addBody, addComponent, checkActiveLock, cleanupAfterRender, enterActiveState, equals, finishLoad, generateClientId, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getBoundId, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, getSpecifiedId, getTemplateTagName, hasEvents, hashCode, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, peekClientId, prepareForRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setHasEvents, setId, setNamespace, setPage, setTemplateTagName, toString, triggerEvent

Methods inherited from class org.apache.hivemind.impl.BaseLocatable

getLocation, setLocation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tapestry.IComponent

addAsset, addBody, addComponent, enterActiveState, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getClientId, getComponent, getComponents, getContainedComponent, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getListeners, getMessages, getNamespace, getPage, getSpecification, getSpecifiedId, getTemplateTagName, isRendering, peekClientId, renderBody, setBinding, setClientId, setContainedComponent, setContainer, setId, setNamespace, setPage, setTemplateTagName

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 String TABLE_COLUMN_ARROW_UP_ATTRIBUTE

See Also:

Constant Field Values

TABLE_COLUMN_ARROW_DOWN_ATTRIBUTE

public static final String TABLE_COLUMN_ARROW_DOWN_ATTRIBUTE

See Also:

Constant Field Values

TABLE_COLUMN_CSS_CLASS_SUFFIX

public static final String TABLE_COLUMN_CSS_CLASS_SUFFIX

See Also:

Constant Field Values

Constructor Detail

TableColumns

public TableColumns()

Method Detail

getArrowDownAsset

public abstract IAsset getArrowDownAsset()

getArrowUpAsset

public abstract 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 Iterator getTableColumnIterator()

Get the list of all table columns to be displayed.

Returns:

an iterator of all table columns

getTableColumnRenderer

public 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 String getColumnClassParameter()

getColumnClass

public 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(IMarkupWriter writer,
                               IRequestCycle cycle)

Description copied from class: BaseComponent

Renders the top level components contained by the receiver.

Overrides:

renderComponent in class BaseComponent

See Also:

BaseComponent.renderComponent(IMarkupWriter, IRequestCycle)