Constructor and Description |
---|
ScalarDataModel()
Construct a new
ScalarDataModel with no specified
wrapped data. |
ScalarDataModel(Object scalar)
Construct a new
ScalarDataModel wrapping the specified
scalar object. |
Modifier and Type | Method and Description |
---|---|
int |
getRowCount()
If there is
wrappedData available, return 1. |
Object |
getRowData()
If wrapped data is available, return the wrapped data instance.
|
int |
getRowIndex()
Return the zero-relative index of the currently selected row.
|
Object |
getWrappedData()
Return the object representing the data wrapped by this
DataModel , if any. |
boolean |
isRowAvailable()
Return
true if there is wrappedData
available, and the current value of rowIndex is zero. |
void |
setRowIndex(int rowIndex)
Set the zero-relative index of the currently selected row, or -1
to indicate that we are not positioned on a row.
|
void |
setWrappedData(Object data)
Set the object representing the data collection wrapped by this
DataModel . |
addDataModelListener, getDataModelListeners, removeDataModelListener
public ScalarDataModel()
Construct a new ScalarDataModel
with no specified
wrapped data.
public ScalarDataModel(Object scalar)
Construct a new ScalarDataModel
wrapping the specified
scalar object.
scalar
- Scalar to be wrapped (if any)public boolean isRowAvailable()
Return true
if there is wrappedData
available, and the current value of rowIndex
is zero.
Otherwise, return false
.
isRowAvailable
in class DataModel
FacesException
- if an error occurs getting the row availabilitypublic int getRowCount()
If there is wrappedData
available, return 1.
If no wrappedData
is available, return -1.
getRowCount
in class DataModel
FacesException
- if an error occurs getting the row countpublic Object getRowData()
If wrapped data is available, return the wrapped data instance.
Otherwise, return null
.
getRowData
in class DataModel
FacesException
- if an error occurs getting the row dataIllegalArgumentException
- if now row data is available
at the currently specified row indexpublic int getRowIndex()
DataModel
Return the zero-relative index of the currently selected row. If
we are not currently positioned on a row, or no wrappedData
is available, return -1.
getRowIndex
in class DataModel
FacesException
- if an error occurs getting the row indexpublic void setRowIndex(int rowIndex)
DataModel
Set the zero-relative index of the currently selected row, or -1
to indicate that we are not positioned on a row. It is
possible to set the row index at a value for which the underlying data
collection does not contain any row data. Therefore, callers may
use the isRowAvailable()
method to detect whether row data
will be available for use by the getRowData()
method.
If there is no wrappedData
available when this method
is called, the specified rowIndex
is stored (and may be
retrieved by a subsequent call to getRowData()
), but no
event is sent. Otherwise, if the currently selected row index is
changed by this call, a DataModelEvent
will be sent to the
rowSelected()
method of all registered
DataModelListener
s.
setRowIndex
in class DataModel
rowIndex
- The new zero-relative index (must be non-negative)FacesException
- if an error occurs setting the row indexIllegalArgumentException
- if rowIndex
is less than -1public Object getWrappedData()
DataModel
Return the object representing the data wrapped by this
DataModel
, if any.
getWrappedData
in class DataModel
public void setWrappedData(Object data)
DataModel
Set the object representing the data collection wrapped by this
DataModel
. If the specified data
is
null
, detach this DataModel
from any previously
wrapped data collection instead.
If data
is non-null
, the currently selected
row index must be set to zero, and a DataModelEvent
must be sent
to the rowSelected()
method of all registered
DataModelListener
s indicating that this row is now selected.
setWrappedData
in class DataModel
data
- Data collection to be wrapped, or null
to
detach from any previous data collectionClassCastException
- if data
is not of the
appropriate type for this DataModel
implementationCopyright © 2018 JBoss by Red Hat. All rights reserved.