< prev index next >
modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeTableCell.java
Print this page
@@ -63,10 +63,11 @@
* (such as {@link javafx.scene.control.TreeTableColumn#onEditCommitProperty() on edit commit})
* will <strong>not</strong> be called. If you want to be notified of changes,
* it is recommended to directly observe the boolean properties that are
* manipulated by the CheckBox.</p>
*
+ * @param <S> The type of the TableView generic type
* @param <T> The type of the elements contained within the TreeTableColumn.
* @since JavaFX 8.0
*/
public class CheckBoxTreeTableCell<S,T> extends TreeTableCell<S,T> {
@@ -87,10 +88,12 @@
* column will be bound bidirectionally. This means that the CheckBox in
* the cell will set/unset this property based on user interactions, and the
* CheckBox will reflect the state of the {@code ObservableValue<Boolean>},
* if it changes externally).
*
+ * @param <S> The type of the TableView generic type
+ * @param column the TreeTableColumn of type {@link Boolean}
* @return A {@link Callback} that will return a {@link TreeTableCell} that is
* able to work on the type of element contained within the TreeTableColumn.
*/
public static <S> Callback<TreeTableColumn<S,Boolean>, TreeTableCell<S,Boolean>> forTreeTableColumn(
final TreeTableColumn<S, Boolean> column) {
@@ -103,10 +106,11 @@
* {@code ObservableValue<Boolean>}.
*
* <p>When used in a TreeTableColumn, the CheckBoxCell is rendered with a
* CheckBox centered in the column.
*
+ * @param <S> The type of the TableView generic type
* @param <T> The type of the elements contained within the {@link TreeTableColumn}
* instance.
* @param getSelectedProperty A Callback that, given an object of
* type {@code TreeTableColumn<S,T>}, will return an
* {@code ObservableValue<Boolean>}
@@ -129,10 +133,11 @@
* {@code ObservableValue<Boolean>}.
*
* <p>When used in a TreeTableColumn, the CheckBoxCell is rendered with a
* CheckBox centered in the column.
*
+ * @param <S> The type of the TableView generic type
* @param <T> The type of the elements contained within the {@link TreeTableColumn}
* instance.
* @param getSelectedProperty A Callback that, given an object of
* type {@code TreeTableColumn<S,T>}, will return an
* {@code ObservableValue<Boolean>}
@@ -166,10 +171,11 @@
* {@code ObservableValue<Boolean>}.
*
* <p>When used in a TreeTableColumn, the CheckBoxCell is rendered with a
* CheckBox centered in the column.
*
+ * @param <S> The type of the TableView generic type
* @param <T> The type of the elements contained within the {@link TreeTableColumn}
* instance.
* @param getSelectedProperty A Callback that, given an object of type
* {@code TreeTableColumn<S,T>}, will return an
* {@code ObservableValue<Boolean>} that represents whether the given
@@ -279,24 +285,27 @@
}
};
/**
* The {@link StringConverter} property.
+ * @return the {@link StringConverter} property
*/
public final ObjectProperty<StringConverter<T>> converterProperty() {
return converter;
}
/**
* Sets the {@link StringConverter} to be used in this cell.
+ * @param value the {@link StringConverter} to be used in this cell
*/
public final void setConverter(StringConverter<T> value) {
converterProperty().set(value);
}
/**
* Returns the {@link StringConverter} used in this cell.
+ * @return the {@link StringConverter} used in this cell
*/
public final StringConverter<T> getConverter() {
return converterProperty().get();
}
@@ -309,24 +318,30 @@
this, "selectedStateCallback");
/**
* Property representing the {@link Callback} that is bound to by the
* CheckBox shown on screen.
+ * @return the property representing the {@link Callback} that is bound to
+ * by the CheckBox shown on screen
*/
public final ObjectProperty<Callback<Integer, ObservableValue<Boolean>>> selectedStateCallbackProperty() {
return selectedStateCallback;
}
/**
* Sets the {@link Callback} that is bound to by the CheckBox shown on screen.
+ * @param value the {@link Callback} that is bound to by the CheckBox shown
+ * on screen
*/
public final void setSelectedStateCallback(Callback<Integer, ObservableValue<Boolean>> value) {
selectedStateCallbackProperty().set(value);
}
/**
* Returns the {@link Callback} that is bound to by the CheckBox shown on screen.
+ * @return the {@link Callback} that is bound to by the CheckBox shown on
+ * screen
*/
public final Callback<Integer, ObservableValue<Boolean>> getSelectedStateCallback() {
return selectedStateCallbackProperty().get();
}
< prev index next >