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

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

All Implemented Interfaces:

org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, ITableModelSource, IComponent, IDirectEvent, Component, IRender, ITemplateComponent

Direct Known Subclasses:

FormTable

public abstract class Table
extends BaseComponent
implements ITableModelSource

The facade component in the Table family. Table allows you to present a sortable and pagable table simply and easily by using only this one component. Please see the Component Reference for details on how to use this component. [ Component Reference ]

Author:

mindbridge

Field Summary

Fields inherited from class org.apache.tapestry.AbstractComponent

_body, _bodyCount

Fields inherited from interface org.apache.tapestry.contrib.table.model.ITableModelSource

TABLE_MODEL_SOURCE_ATTRIBUTE

Constructor Summary

Table()

Method Summary

void	fireObservedStateChange() Indicates that the table model has changed and it may need to saved.
boolean	getShowNormalPages()
ITableColumn	getTableColumn() Returns the currently rendered table column.
protected TableColumns	getTableColumnsComponent()
ITableModel	getTableModel() Returns the table model currently used.
Object	getTableRow() Returns the currently rendered table row or null if the rows are not rendered at the moment.
protected TableRows	getTableRowsComponent()
protected TableValues	getTableValuesComponent()
protected TableView	getTableViewComponent()
abstract boolean	getVolatile()
void	reset() Resets the state of the component and forces it to load a new TableModel from the tableModel binding the next time it renders.
void	storeTableAction(ITableAction action) Stores the provided table action.

Methods inherited from class org.apache.tapestry.BaseComponent

addOuter, finishLoad, getContainedRenderers, getInnerRenderers, renderComponent

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, finishLoad, 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

Constructor Detail

Table

public Table()

Method Detail

getVolatile

public abstract boolean getVolatile()

getTableModel

public ITableModel getTableModel()

Description copied from interface: ITableModelSource

Returns the table model currently used.

Specified by:

getTableModel in interface ITableModelSource

Returns:

ITableModel the current table model

See Also:

ITableModelSource.getTableModel()

fireObservedStateChange

public void fireObservedStateChange()

Indicates that the table model has changed and it may need to saved. This method has to be invoked if modifications are made to the model.

Specified by:

fireObservedStateChange in interface ITableModelSource

See Also:

ITableModelSource.fireObservedStateChange()

reset

public void reset()

Resets the state of the component and forces it to load a new TableModel from the tableModel binding the next time it renders.

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

getTableRow

public Object getTableRow()

Returns the currently rendered table row or null if the rows are not rendered at the moment. You can call this method to obtain the current row.

Returns:

Object the current table row

getTableViewComponent

protected TableView getTableViewComponent()

getTableColumnsComponent

protected TableColumns getTableColumnsComponent()

getTableRowsComponent

protected TableRows getTableRowsComponent()

getTableValuesComponent

protected TableValues getTableValuesComponent()

getShowNormalPages

public boolean getShowNormalPages()

storeTableAction

public void storeTableAction(ITableAction action)

Description copied from interface: ITableModelSource

Stores the provided table action.

Specified by:

storeTableAction in interface ITableModelSource

Parameters:

action - The action to store.