|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.model.DataModel
org.apache.myfaces.trinidad.model.CollectionModel
org.apache.myfaces.trinidad.model.SortableModel
public class SortableModel
Creates a CollectionModel that is sortable. All properties that implement java.lang.Comparable are deemed sortable.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex |
---|
LocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy |
Constructor Summary | |
---|---|
SortableModel()
No arg constructor for use as a managed-bean. |
|
SortableModel(Object model)
Create a new SortableModel from the given instance. |
Method Summary | |
---|---|
void |
addDataModelListener(DataModelListener listener)
|
DataModelListener[] |
getDataModelListeners()
|
int |
getRowCount()
Gets the number of values in this collection |
Object |
getRowData()
Gets the current value identified by the current index or rowKey. |
int |
getRowIndex()
Gets the index of the current value. |
Object |
getRowKey()
Gets the row key of the current row |
List<SortCriterion> |
getSortCriteria()
Gets the criteria that this collection is sorted by. |
Object |
getWrappedData()
|
boolean |
isRowAvailable()
Checks to make sure a value exists for the current index or rowKey. |
boolean |
isSortable(String property)
Checks to see if the underlying collection is sortable by the given property. |
void |
removeDataModelListener(DataModelListener listener)
|
void |
setRowIndex(int rowIndex)
Sets up a value at a particular index to be the current value. |
void |
setRowKey(Object key)
Finds the row with the matching key and makes it current |
void |
setSortCriteria(List<SortCriterion> criteria)
Sorts this collection by the given criteria. |
void |
setWrappedData(Object data)
Sets the underlying data being managed by this instance. |
String |
toString()
|
Methods inherited from class org.apache.myfaces.trinidad.model.CollectionModel |
---|
addRowKeyChangeListener, areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, fireRowKeyChange, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowData, getRowData, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, removeRowKeyChangeListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SortableModel(Object model)
model
- This will be converted into a DataModel
setWrappedData(java.lang.Object)
public SortableModel()
Method Detail |
---|
public Object getRowData()
RowKeyIndex
getRowData
in interface RowKeyIndex
getRowData
in class DataModel
RowKeyIndex.getRowKey()
,
RowKeyIndex.getRowIndex()
public Object getWrappedData()
getWrappedData
in class DataModel
public boolean isRowAvailable()
RowKeyIndex
RowKeyIndex.getRowCount()
).
isRowAvailable
in interface RowKeyIndex
isRowAvailable
in class DataModel
RowKeyIndex.getRowKey()
,
RowKeyIndex.getRowIndex()
public void setWrappedData(Object data)
setWrappedData
in class DataModel
data
- This Object will be converted into a
DataModel
.ModelUtils.toDataModel(java.lang.Object)
public int getRowCount()
RowKeyIndex
getRowCount
in interface RowKeyIndex
getRowCount
in class DataModel
public void setRowIndex(int rowIndex)
RowKeyIndex
setRowIndex
in interface RowKeyIndex
setRowIndex
in class DataModel
rowIndex
- the zero-based index of the value to make current.
Use -1 to clear the current valuepublic int getRowIndex()
RowKeyIndex
getRowIndex
in interface RowKeyIndex
getRowIndex
in class DataModel
public Object getRowKey()
getRowKey
in interface RowKeyIndex
getRowKey
in class CollectionModel
CollectionModel.setRowKey(java.lang.Object)
public void setRowKey(Object key)
setRowKey
in interface RowKeyIndex
setRowKey
in class CollectionModel
key
- the rowKey, previously obtained from CollectionModel.getRowKey()
.public void addDataModelListener(DataModelListener listener)
addDataModelListener
in class DataModel
public DataModelListener[] getDataModelListeners()
getDataModelListeners
in class DataModel
public void removeDataModelListener(DataModelListener listener)
removeDataModelListener
in class DataModel
public boolean isSortable(String property)
isSortable
in class CollectionModel
property
- The name of the property to sort the underlying collection by.
public List<SortCriterion> getSortCriteria()
CollectionModel
getSortCriteria
in class CollectionModel
SortCriterion
public void setSortCriteria(List<SortCriterion> criteria)
CollectionModel
setSortCriteria
in class CollectionModel
criteria
- Each element in this List must be of type SortCriterion.
The empty list may be used to cancel any sort order. null should be treated
the same as an empty list.SortCriterion
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |