javafx.scene.control.cell.PropertyValueFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openjfx-78-backport Show documentation
Show all versions of openjfx-78-backport Show documentation
This is a backport of OpenJFX 8 to run on Java 7.
The newest version!
/*
* Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.scene.control.cell;
import javafx.beans.property.Property;
import javafx.beans.property.ReadOnlyObjectWrapper;
import javafx.beans.value.ObservableValue;
import javafx.scene.control.TableCell;
import javafx.scene.control.TableColumn;
import javafx.scene.control.TableColumn.CellDataFeatures;
import javafx.scene.control.TableView;
import javafx.util.Callback;
import sun.util.logging.PlatformLogger;
import com.sun.javafx.property.PropertyReference;
import com.sun.javafx.scene.control.Logging;
/**
* A convenience implementation of the Callback interface, designed specifically
* for use within the {@link TableColumn}
* {@link TableColumn#cellValueFactoryProperty() cell value factory}. An example
* of how to use this class is:
*
*
* TableColumn<Person,String> firstNameCol = new TableColumn<Person,String>("First Name");
* firstNameCol.setCellValueFactory(new PropertyValueFactory<Person,String>("firstName"));
*
*
* In this example, the "firstName" string is used as a reference to an assumed
* firstNameProperty() method in the Person class type
* (which is the class type of the TableView
* {@link TableView#itemsProperty() items} list). Additionally, this method must
* return a {@link Property} instance. If a method meeting these requirements
* is found, then the {@link TableCell} is populated with this ObservableValue.
* In addition, the TableView will automatically add an observer to the
* returned value, such that any changes fired will be observed by the TableView,
* 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() or isFirstName() in the example
* above). If a method matching this pattern exists, the value returned from this method
* is wrapped in a {@link ReadOnlyObjectWrapper} and returned to the TableCell.
* However, in this situation, this means that the TableCell 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 TableColumn
* {@link TableColumn#cellValueFactory cell value factory} documentation), the
* long form of the code above would be the following:
*
*
* TableColumn<Person,String> firstNameCol = new TableColumn<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 Person instance for a particular TableView row
* return p.getValue().firstNameProperty();
* }
* });
* }
*
*
* @see TableColumn
* @see TableView
* @see TableCell
* @see TreeItemPropertyValueFactory
* @see MapValueFactory
* @param The type of the class contained within the TableView.items list.
* @param The type of the class contained within the TableColumn cells.
* @since JavaFX 2.0
*/
public class PropertyValueFactory implements Callback, ObservableValue> {
private final String property;
private Class columnClass;
private String previousProperty;
private PropertyReference propertyRef;
/**
* Creates a default PropertyValueFactory to extract the value from a given
* TableView row item reflectively, using the given property name.
*
* @param property The name of the property with which to attempt to
* reflectively extract a corresponding value for in a given object.
*/
public PropertyValueFactory(String property) {
this.property = property;
}
/** {@inheritDoc} */
@Override public ObservableValue call(CellDataFeatures param) {
return getCellDataReflectively((T)param.getValue());
}
/**
* Returns the property name provided in the constructor.
*/
public final String getProperty() { return property; }
private ObservableValue getCellDataReflectively(T rowData) {
if (getProperty() == null || getProperty().isEmpty() || rowData == null) return null;
try {
// we attempt to cache the property reference here, as otherwise
// performance suffers when working in large data models. For
// a bit of reference, refer to RT-13937.
if (columnClass == null || previousProperty == null ||
! columnClass.equals(rowData.getClass()) ||
! previousProperty.equals(getProperty())) {
// create a new PropertyReference
this.columnClass = rowData.getClass();
this.previousProperty = getProperty();
this.propertyRef = new PropertyReference(rowData.getClass(), getProperty());
}
if (propertyRef.hasProperty()) {
return propertyRef.getProperty(rowData);
} else {
T value = propertyRef.get(rowData);
return new ReadOnlyObjectWrapper(value);
}
} catch (IllegalStateException e) {
// log the warning and move on
final PlatformLogger logger = Logging.getControlsLogger();
if (logger.isLoggable(PlatformLogger.WARNING)) {
logger.finest("Can not retrieve property '" + getProperty() +
"' in PropertyValueFactory: " + this +
" with provided class type: " + rowData.getClass(), e);
}
}
return null;
}
}