changeset 6927:1c2d5be06d1c

[DOC ONLY] RT-36856: [TableView] onEditCommit is never called when using CheckBoxTableCell
author jgiles
date Thu, 01 May 2014 11:51:30 +1200
parents 60ec7824be54
children 0e9455df94b1
files modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxListCell.java modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTableCell.java modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeCell.java modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeTableCell.java
diffstat 4 files changed, 40 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxListCell.java	Thu May 01 11:37:32 2014 +1200
+++ b/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxListCell.java	Thu May 01 11:51:30 2014 +1200
@@ -54,6 +54,16 @@
  * that the CheckBox in the cell will set/unset this property based on user 
  * interactions, and the CheckBox will reflect the state of the 
  * ObservableValue<Boolean>, if it changes externally).
+ *
+ * <p>Note that the CheckBoxListCell renders the CheckBox 'live', meaning that
+ * the CheckBox is always interactive and can be directly toggled by the user.
+ * This means that it is not necessary that the cell enter its
+ * {@link #editingProperty() editing state} (usually by the user double-clicking
+ * on the cell). A side-effect of this is that the usual editing callbacks
+ * (such as {@link javafx.scene.control.ListView#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>
  * 
  * @see CheckBox
  * @see ListCell
--- a/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTableCell.java	Thu May 01 11:37:32 2014 +1200
+++ b/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTableCell.java	Thu May 01 11:51:30 2014 +1200
@@ -55,6 +55,16 @@
  * that the CheckBox in the cell will set/unset this property based on user 
  * interactions, and the CheckBox will reflect the state of the ObservableValue, 
  * if it changes externally).
+ *
+ * <p>Note that the CheckBoxTableCell renders the CheckBox 'live', meaning that
+ * the CheckBox is always interactive and can be directly toggled by the user.
+ * This means that it is not necessary that the cell enter its
+ * {@link #editingProperty() editing state} (usually by the user double-clicking
+ * on the cell). A side-effect of this is that the usual editing callbacks
+ * (such as {@link javafx.scene.control.TableColumn#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 <T> The type of the elements contained within the TableColumn.
  * @since JavaFX 2.2
--- a/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeCell.java	Thu May 01 11:37:32 2014 +1200
+++ b/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeCell.java	Thu May 01 11:51:30 2014 +1200
@@ -72,6 +72,16 @@
  * is provided that can return an {@code ObservableValue<Boolean>}
  * given a {@link TreeItem} instance. This {@code ObservableValue<Boolean>} 
  * should represent the boolean state of the given {@link TreeItem}.
+ *
+ * <p>Note that the CheckBoxTreeCell renders the CheckBox 'live', meaning that
+ * the CheckBox is always interactive and can be directly toggled by the user.
+ * This means that it is not necessary that the cell enter its
+ * {@link #editingProperty() editing state} (usually by the user double-clicking
+ * on the cell). A side-effect of this is that the usual editing callbacks
+ * (such as {@link javafx.scene.control.TreeView#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 <T> The type of the elements contained within the TreeView TreeItem 
  *      instances.
--- a/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeTableCell.java	Thu May 01 11:37:32 2014 +1200
+++ b/modules/controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeTableCell.java	Thu May 01 11:51:30 2014 +1200
@@ -55,6 +55,16 @@
  * that the CheckBox in the cell will set/unset this property based on user 
  * interactions, and the CheckBox will reflect the state of the ObservableValue, 
  * if it changes externally).
+ *
+ * <p>Note that the CheckBoxTreeTableCell renders the CheckBox 'live', meaning that
+ * the CheckBox is always interactive and can be directly toggled by the user.
+ * This means that it is not necessary that the cell enter its
+ * {@link #editingProperty() editing state} (usually by the user double-clicking
+ * on the cell). A side-effect of this is that the usual editing callbacks
+ * (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 <T> The type of the elements contained within the TreeTableColumn.
  * @since JavaFX 8.0