org.pm4j.core.pm
Interface PmTableCol

All Superinterfaces:
java.lang.Comparable<PmObject>, PmObject
All Known Implementing Classes:
PmTableColImpl

public interface PmTableCol
extends PmObject

PM of a table column.

Author:
olaf boede

Nested Class Summary
static interface PmTableCol.Filter<T>
           
 
Field Summary
 
Fields inherited from interface org.pm4j.core.pm.PmObject
STYLE_CLASS_DISABLED, STYLE_CLASS_ERROR, STYLE_CLASS_INFO, STYLE_CLASS_REQUIRED, STYLE_CLASS_WARN
 
Method Summary
 PmCommand getCmdSort()
           
 PmAttrInteger getColPosAttr()
          Specification and visualization of the column position is supported by the PM attribute provided by this method.
 org.pm4j.core.util.table.ColSizeSpec getPmColSize()
           
 PmTableCol.Filter<?> getRowFilter()
           
 java.util.Comparator<?> getRowSortComparator()
          Provides the configured row sort comparator.
 PmAttrEnum<PmSortOrder> getSortOrderAttr()
          Specification and visualization of the column sort order is supported by the PM attribute provided by this method.
 
Methods inherited from interface org.pm4j.core.pm.PmObject
accept, canSetPmTitle, compareTo, getPmConversation, getPmIconPath, getPmName, getPmParent, getPmProperty, getPmRelativeName, getPmShortTitle, getPmStyleClasses, getPmTitle, getPmTooltip, isPmEnabled, isPmReadonly, isPmValid, isPmVisible, setPmEnabled, setPmParent, setPmProperty, setPmTitle, setPmVisible
 

Method Detail

getPmColSize

org.pm4j.core.util.table.ColSizeSpec getPmColSize()
Returns:
The column size specification.
May be null if there is no size specified for the column.

getSortOrderAttr

PmAttrEnum<PmSortOrder> getSortOrderAttr()
Specification and visualization of the column sort order is supported by the PM attribute provided by this method.

Returns:
The attribute that defines the column sort order.

getCmdSort

PmCommand getCmdSort()
Returns:
A command that allows to switch the sort order.

getColPosAttr

PmAttrInteger getColPosAttr()
Specification and visualization of the column position is supported by the PM attribute provided by this method.

Returns:
The position of the column within the table.

getRowSortComparator

java.util.Comparator<?> getRowSortComparator()
Provides the configured row sort comparator. It no specific comparator is configured, the default implementation simply compares the column specific cell-PMs.

The type of items to compare depends on the kind of PageableCollection container behind the table.

Returns:
The configured comparator or null.

getRowFilter

PmTableCol.Filter<?> getRowFilter()