ScalarDataModel (Java EE 5)

java.lang.Object
  javax.faces.model.DataModel
      javax.faces.model.ScalarDataModel

ScalarDataModel 是 DataModel 的便捷实现，它包装了一个单独的 Java 对象。

英文文档：

ScalarDataModel is a convenience implementation of DataModel that wraps an individual Java object.

---

Constructor Summary
ScalarDataModel()           Construct a new ScalarDataModel with no specified wrapped data.
ScalarDataModel(Object scalar)           Construct a new ScalarDataModel wrapping the specified scalar object.

 

Method Summary
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.

 

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 ScalarDataModel()

构造不带指定包装数据的新 ScalarDataModel。

英文文档：

ScalarDataModel

public ScalarDataModel()

Construct a new ScalarDataModel with no specified wrapped data.

---

public ScalarDataModel(Object scalar)

构造包装指定标量对象的新 ScalarDataModel。

scalar

要包装的标量（如果有）

英文文档：

ScalarDataModel

public ScalarDataModel(Object scalar)

Construct a new ScalarDataModel wrapping the specified scalar object.

Parameters:

scalar - Scalar to be wrapped (if any)

Method Detail

public boolean isRowAvailable()

如果有可用的 wrappedData，并且 rowIndex 的当前值为 0，则返回 true。否则返回 false。

Throws

FacesException: 如果检测行可用性时发生错误

英文文档：

isRowAvailable

public boolean isRowAvailable()

Return true if there is wrappedData available, and the current value of rowIndex is zero. Otherwise, return false.

Specified by:

isRowAvailable in class DataModel

Throws:

FacesException - if an error occurs getting the row availability

---

public int getRowCount()

如果有可用的 wrappedData，则返回 1。如果没有可用的 wrappedData，则返回 -1。

Throws

FacesException: 如果获取行数时发生错误

英文文档：

getRowCount

public int getRowCount()

If there is wrappedData available, return 1. If no wrappedData is available, return -1.

Specified by:

getRowCount in class DataModel

Throws:

FacesException - if an error occurs getting the row count

---

public Object getRowData()

如果有可用的包装数据，则返回包装的数据实例。否则返回 null。

Throws	FacesException: 如果获取行数据时发生错误
Throws	IllegalArgumentException: 如果当前指定行索引处的行数据目前可用

英文文档：

getRowData

public Object getRowData()

If wrapped data is available, return the wrapped data instance. Otherwise, return null.

Specified by:

getRowData in class DataModel

Throws:

FacesException - if an error occurs getting the row data

IllegalArgumentException - if now row data is available at the currently specified row index

---

public int getRowIndex()

Throws

FacesException: NullPointerException 如果获取行索引时发生错误

英文文档：

getRowIndex

public int getRowIndex()

Description copied from class: 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.

Specified by:

getRowIndex in class DataModel

Throws:

FacesException - if an error occurs getting the row index

---

public void setRowIndex(int rowIndex)

Throws	FacesException: NullPointerException 如果设置行索引时发生错误
Throws	IllegalArgumentException: NullPointerException 如果 rowIndex 小于 -1

英文文档：

setRowIndex

public void setRowIndex(int rowIndex)

Description copied from class: 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 DataModelListeners.

Specified by:

setRowIndex in class DataModel

Parameters:

rowIndex - The new zero-relative index (must be non-negative)

Throws:

FacesException - if an error occurs setting the row index

IllegalArgumentException - if rowIndex is less than -1

---

public Object getWrappedData()

英文文档：

getWrappedData

public Object getWrappedData()

Description copied from class: DataModel

Return the object representing the data wrapped by this DataModel, if any.

Specified by:

getWrappedData in class DataModel

---

public void setWrappedData(Object data)

Throws

ClassCastException: NullPointerException 如果 data 的类型不适合此 DataModel 实现

英文文档：

setWrappedData

public void setWrappedData(Object data)

Description copied from class: 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 DataModelListeners indicating that this row is now selected.

Specified by:

setWrappedData in class DataModel

Parameters:

data - Data collection to be wrapped, or null to detach from any previous data collection

Throws:

ClassCastException - if data is not of the appropriate type for this DataModel implementation

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.