- java.lang.Object
-
- javafx.scene.control.cell.TreeItemPropertyValueFactory<S,T>
-
- All Implemented Interfaces:
Callback<TreeTableColumn.CellDataFeatures<S,T>,ObservableValue<T>>
public class TreeItemPropertyValueFactory<S,T> extends Object implements Callback<TreeTableColumn.CellDataFeatures<S,T>,ObservableValue<T>>
A convenience implementation of the Callback interface, designed specifically for use within theTreeTableColumn
cell value factory
. An example of how to use this class is:
In this example, the "firstName" string is used as a reference to an assumedTreeTableColumn<Person,String> firstNameCol = new TreeTableColumn<Person,String>("First Name"); firstNameCol.setCellValueFactory(new TreeItemPropertyValueFactory<Person,String>("firstName"));
firstNameProperty()
method in thePerson
class type (which is the class type of the TreeTableView). Additionally, this method must return aProperty
instance. If a method meeting these requirements is found, then theTreeTableCell
is populated with this ObservableValue<T>. In addition, the TreeTableView will automatically add an observer to the returned value, such that any changes fired will be observed by the TreeTableView, resulting in the cell immediately updating.If no method matching this pattern exists, there is fall-through support for attempting to call get<property>() or is<property>() (that is,
getFirstName()
orisFirstName()
in the example above). If a method matching this pattern exists, the value returned from this method is wrapped in aReadOnlyObjectWrapper
and returned to the TreeTableCell. However, in this situation, this means that the TreeTableCell will not be able to observe the ObservableValue for changes (as is the case in the first approach above).For reference (and as noted in the TreeTableColumn
cell value factory
documentation), the long form of the code above would be the following:TreeTableColumn<Person,String> firstNameCol = new TreeTableColumn<Person,String>("First Name"); firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() { public ObservableValue<String> call(CellDataFeatures<Person, String> p) { // p.getValue() returns the TreeItem<Person> instance for a particular // TreeTableView row, and the second getValue() call returns the // Person instance contained within the TreeItem. return p.getValue().getValue().firstNameProperty(); } }); }
- Since:
- JavaFX 8.0
- See Also:
TreeTableColumn
,TreeTableView
,TreeTableCell
,PropertyValueFactory
,MapValueFactory
-
-
Constructor Summary
Constructors Constructor Description TreeItemPropertyValueFactory(String property)
Creates a default PropertyValueFactory to extract the value from a given TableView row item reflectively, using the given property name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ObservableValue<T>
call(TreeTableColumn.CellDataFeatures<S,T> param)
Thecall
method is called when required, and is given a single argument of type P, with a requirement that an object of type R is returned.String
getProperty()
Returns the property name provided in the constructor.
-
-
-
Constructor Detail
-
TreeItemPropertyValueFactory
public TreeItemPropertyValueFactory(String property)
Creates a default PropertyValueFactory to extract the value from a given TableView row item reflectively, using the given property name.- Parameters:
property
- The name of the property with which to attempt to reflectively extract a corresponding value for in a given object.
-
-
Method Detail
-
call
public ObservableValue<T> call(TreeTableColumn.CellDataFeatures<S,T> param)
Thecall
method is called when required, and is given a single argument of type P, with a requirement that an object of type R is returned.
-
getProperty
public final String getProperty()
Returns the property name provided in the constructor.- Returns:
- the property name provided in the constructor
-
-