changeset 5557:584c05320426

[DOC ONLY] RT-32905: TableCell#selectedProperty does not update
author jgiles
date Tue, 29 Oct 2013 16:34:09 +1300
parents d5b97ee5ab05
children 17a35fcb4070
files modules/controls/src/main/java/javafx/scene/control/TableCell.java modules/controls/src/main/java/javafx/scene/control/TreeTableCell.java
diffstat 2 files changed, 22 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/modules/controls/src/main/java/javafx/scene/control/TableCell.java	Tue Oct 29 15:21:11 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/TableCell.java	Tue Oct 29 16:34:09 2013 +1300
@@ -51,6 +51,17 @@
  * {@link #indexProperty() index} property, as well as a 
  * {@link #tableColumnProperty() tableColumn} property. In addition, a TableCell
  * instance knows what {@link TableRow} it exists in.
+ *
+ * <p><strong>A note about selection:</strong> A TableCell visually shows it is
+ * selected when two conditions are met:
+ * <ol>
+ *   <li>The {@link TableSelectionModel#isSelected(int, TableColumnBase)} method
+ *   returns true for the row / column that this cell represents, and</li>
+ *   <li>The {@link javafx.scene.control.TableSelectionModel#cellSelectionEnabledProperty() cell selection mode}
+ *   property is set to true (to represent that it is allowable to select
+ *   individual cells (and not just rows of cells)).</li>
+ * </ol>
+ * </p>
  * 
  * @see TableView
  * @see TableColumn
--- a/modules/controls/src/main/java/javafx/scene/control/TreeTableCell.java	Tue Oct 29 15:21:11 2013 +1300
+++ b/modules/controls/src/main/java/javafx/scene/control/TreeTableCell.java	Tue Oct 29 16:34:09 2013 +1300
@@ -48,6 +48,17 @@
  * {@link #indexProperty() index} property, as well as a 
  * {@link #tableColumnProperty() tableColumn} property. In addition, a TreeTableCell
  * instance knows what {@link TreeTableRow} it exists in.
+ *
+ * <p><strong>A note about selection:</strong> A TreeTableCell visually shows it is
+ * selected when two conditions are met:
+ * <ol>
+ *   <li>The {@link TableSelectionModel#isSelected(int, TableColumnBase)} method
+ *   returns true for the row / column that this cell represents, and</li>
+ *   <li>The {@link javafx.scene.control.TableSelectionModel#cellSelectionEnabledProperty() cell selection mode}
+ *   property is set to true (to represent that it is allowable to select
+ *   individual cells (and not just rows of cells)).</li>
+ * </ol>
+ * </p>
  * 
  * @see TreeTableView
  * @see TreeTableColumn