|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.model.DataModel
javax.faces.model.ArrayDataModel
public class ArrayDataModel
ArrayDataModel is a convenience implementation of
DataModel that wraps an array of Java objects.
| Constructor Summary | |
|---|---|
ArrayDataModel()
Construct a new ArrayDataModel with no specified
wrapped data. |
|
ArrayDataModel(Object[] array)
Construct a new ArrayDataModel wrapping the specified
array. |
|
| Method Summary | |
|---|---|
int |
getRowCount()
If there is wrappedData available, return the
length of the array. |
Object |
getRowData()
If row data is available, return the array element at the index specified by rowIndex. |
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 greater
than or equal to zero, and less than the length of the array. |
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. |
| Methods inherited from class javax.faces.model.DataModel |
|---|
addDataModelListener, getDataModelListeners, removeDataModelListener |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ArrayDataModel()
Construct a new ArrayDataModel with no specified
wrapped data.
public ArrayDataModel(Object[] array)
Construct a new ArrayDataModel wrapping the specified
array.
array - Array to be wrapped (if any)| Method Detail |
|---|
public boolean isRowAvailable()
Return true if there is wrappedData
available, and the current value of rowIndex is greater
than or equal to zero, and less than the length of the array. Otherwise,
return false.
isRowAvailable in class DataModelFacesException - if an error occurs getting the row availabilitypublic int getRowCount()
If there is wrappedData available, return the
length of the array. If no wrappedData is available,
return -1.
getRowCount in class DataModelFacesException - if an error occurs getting the row countpublic Object getRowData()
If row data is available, return the array element at the index
specified by rowIndex. If no wrapped data is available,
return null.
getRowData in class DataModelFacesException - if an error occurs getting the row data
IllegalArgumentException - if now row data is available
at the currently specified row indexpublic int getRowIndex()
DataModelReturn 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 DataModelFacesException - if an error occurs getting the row indexpublic void setRowIndex(int rowIndex)
DataModelSet 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
DataModelListeners.
setRowIndex in class DataModelrowIndex - The new zero-relative index (must be non-negative)
FacesException - if an error occurs setting the row index
IllegalArgumentException - if rowIndex
is less than -1public Object getWrappedData()
DataModelReturn the object representing the data wrapped by this
DataModel, if any.
getWrappedData in class DataModelpublic void setWrappedData(Object data)
DataModelSet 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
DataModelListeners indicating that this row is now selected.
setWrappedData in class DataModeldata - Data collection to be wrapped, or null to
detach from any previous data collection
ClassCastException - if data is
non-null and is not an array of Java objects.
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.