org.pm4j.core.pm
Interface PmTable<T_ROW_OBJ>

Type Parameters:
T_ROW_OBJ - The type used for row objects.
All Superinterfaces:
java.lang.Comparable<PmObject>, PmDataInput, PmObject
All Known Subinterfaces:
PmTable.WithPager<T_ROW_ELEMENT>
All Known Implementing Classes:
PmTableImpl

public interface PmTable<T_ROW_OBJ>
extends PmObject, PmDataInput

PM for tables.
A table provides columns (@see getColumns()) and rows (see getTotalNumOfRows()).

Author:
OBOEDE

Nested Class Summary
static class PmTable.RowSelectMode
          The set of supported row selection modes.
static interface PmTable.WithPager<T_ROW_ELEMENT>
          PM for table with a pager.
 
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
 java.util.List<PmTableCol> getColumns()
           
 java.util.List<PmTableGenericRow<T_ROW_OBJ>> getGenericRows()
          Provides a row representation that may be used by generic a renderer.
 int getNumOfPageRows()
           
 java.util.List<T_ROW_OBJ> getRows()
          Provides only the visible rows.
The provided set may be influenced by filter criteria and paging logic.
 PmTable.RowSelectMode getRowSelectMode()
           
 java.util.List<T_ROW_OBJ> getRowsWithChanges()
           
 T_ROW_OBJ getSelectedRow()
          Supports PmTable.RowSelectMode.SINGLE.
 java.util.Collection<T_ROW_OBJ> getSelectedRows()
           
 int getTotalNumOfRows()
           
 boolean isMultiSelect()
          Deprecated. Please use getRowSelectMode()
 
Methods inherited from interface org.pm4j.core.pm.PmDataInput
commitBufferedPmChanges, isBufferedPmValueMode, isPmValueChanged, pmValidate, resetPmValues, rollbackBufferedPmChanges
 
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

getColumns

java.util.List<PmTableCol> getColumns()
Returns:
The set of columns.

getRows

java.util.List<T_ROW_OBJ> getRows()
Provides only the visible rows.
The provided set may be influenced by filter criteria and paging logic.

Returns:
The set of table rows to display.

getRowsWithChanges

java.util.List<T_ROW_OBJ> getRowsWithChanges()
Returns:
The set of rows that contains changed data.

getGenericRows

java.util.List<PmTableGenericRow<T_ROW_OBJ>> getGenericRows()
Provides a row representation that may be used by generic a renderer.

Returns:
The set of rows as provides by getRows().
Each row is encapsulated in a PmTableGenericRow instance.

getNumOfPageRows

int getNumOfPageRows()
Returns:
The number of rows per table page.

getTotalNumOfRows

int getTotalNumOfRows()
Returns:
The total size of the un-filtered row set.

getRowSelectMode

PmTable.RowSelectMode getRowSelectMode()
Returns:
The row selection mode for this table.

getSelectedRow

T_ROW_OBJ getSelectedRow()
Supports PmTable.RowSelectMode.SINGLE. For other select modes it just provides the first selected item.

Returns:
The selected row or null if none is selected.

getSelectedRows

java.util.Collection<T_ROW_OBJ> getSelectedRows()
Returns:
The set of all selected rows.

isMultiSelect

@Deprecated
boolean isMultiSelect()
Deprecated. Please use getRowSelectMode()

Returns:
true if the table supports the selection of multiple rows.