public class AbstractTableColumn extends java.lang.Object implements IAdvancedTableColumn, java.io.Serializable
ITableColumn
that allows renderers to be set via aggregation.ITableRendererSource
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
COLUMN_RENDERER_BLOCK_SUFFIX
The suffix of the name of the Block that will be used as the column renderer
for this column
|
static java.lang.String |
VALUE_RENDERER_BLOCK_SUFFIX
The suffix of the name of the Block that will be used as the value renderer
for this column
|
Constructor and Description |
---|
AbstractTableColumn() |
AbstractTableColumn(java.lang.String strColumnName,
boolean bSortable,
java.util.Comparator objComparator) |
AbstractTableColumn(java.lang.String strColumnName,
boolean bSortable,
java.util.Comparator objComparator,
ITableRendererSource objColumnRendererSource,
ITableRendererSource objValueRendererSource) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getColumnName()
Method getColumnName provides the name of the column.
|
org.apache.tapestry.IRender |
getColumnRenderer(org.apache.tapestry.IRequestCycle objCycle,
ITableModelSource objSource)
Method getColumnRenderer provides a renderer that takes care of rendering
the column in the table header.
|
ITableRendererSource |
getColumnRendererSource()
Returns the columnRendererSource.
|
java.util.Comparator |
getComparator()
Method getComparator returns the Comparator to be used to sort
the data in the table according to this column.
|
boolean |
getSortable()
Method getSortable declares whether the column allows sorting.
|
org.apache.tapestry.IRender |
getValueRenderer(org.apache.tapestry.IRequestCycle objCycle,
ITableModelSource objSource,
java.lang.Object objRow)
Method getValueRenderer provides a renderer for presenting the value of a
particular row in the current column.
|
ITableRendererSource |
getValueRendererSource()
Returns the valueRendererSource.
|
void |
loadSettings(org.apache.tapestry.IComponent objSettingsContainer)
Use the column name to get the column and value renderer sources
from the provided component.
|
void |
setColumnName(java.lang.String columnName)
Sets the columnName.
|
void |
setColumnRendererSource(ITableRendererSource columnRendererSource)
Sets the columnRendererSource.
|
void |
setComparator(java.util.Comparator comparator)
Sets the comparator.
|
void |
setSortable(boolean sortable)
Sets whether the column is sortable.
|
void |
setValueRendererSource(ITableRendererSource valueRendererSource)
Sets the valueRendererSource.
|
public static final java.lang.String COLUMN_RENDERER_BLOCK_SUFFIX
public static final java.lang.String VALUE_RENDERER_BLOCK_SUFFIX
public AbstractTableColumn()
public AbstractTableColumn(java.lang.String strColumnName, boolean bSortable, java.util.Comparator objComparator)
public AbstractTableColumn(java.lang.String strColumnName, boolean bSortable, java.util.Comparator objComparator, ITableRendererSource objColumnRendererSource, ITableRendererSource objValueRendererSource)
public java.lang.String getColumnName()
ITableColumn
getColumnName
in interface ITableColumn
ITableColumn.getColumnName()
public void setColumnName(java.lang.String columnName)
columnName
- The columnName to setpublic boolean getSortable()
ITableColumn
getSortable
in interface ITableColumn
ITableColumn.getSortable()
public void setSortable(boolean sortable)
sortable
- The sortable flag to setpublic java.util.Comparator getComparator()
ITableColumn
getComparator
in interface ITableColumn
ITableColumn.getComparator()
public void setComparator(java.util.Comparator comparator)
comparator
- The comparator to setpublic org.apache.tapestry.IRender getColumnRenderer(org.apache.tapestry.IRequestCycle objCycle, ITableModelSource objSource)
ITableColumn
getColumnRenderer
in interface ITableColumn
objCycle
- the current request cycleobjSource
- a component that can provide the table model (typically TableView)ITableColumn.getColumnRenderer(IRequestCycle, ITableModelSource)
public org.apache.tapestry.IRender getValueRenderer(org.apache.tapestry.IRequestCycle objCycle, ITableModelSource objSource, java.lang.Object objRow)
ITableColumn
getValueRenderer
in interface ITableColumn
objCycle
- the current request cycleobjSource
- a component that can provide the table model (typically TableView)objRow
- the row dataITableColumn.getValueRenderer(IRequestCycle, ITableModelSource, Object)
public ITableRendererSource getColumnRendererSource()
getColumnRendererSource
in interface IAdvancedTableColumn
public void setColumnRendererSource(ITableRendererSource columnRendererSource)
setColumnRendererSource
in interface IAdvancedTableColumn
columnRendererSource
- The columnRendererSource to setpublic ITableRendererSource getValueRendererSource()
getValueRendererSource
in interface IAdvancedTableColumn
public void setValueRendererSource(ITableRendererSource valueRendererSource)
setValueRendererSource
in interface IAdvancedTableColumn
valueRendererSource
- The valueRendererSource to setpublic void loadSettings(org.apache.tapestry.IComponent objSettingsContainer)
loadSettings
in interface IAdvancedTableColumn
objSettingsContainer
- the component from which to get the settings