changeset 1406:e26d0e3bfcb3

[DOC ONLY] RT-22874: CheckBoxTreeItem: javadoc is incomplete
author jgiles
date Tue, 03 Jul 2012 15:28:41 +1200
parents 587765f2009d
children ea0e80ad3933
files javafx-ui-controls/src/javafx/scene/control/CheckBoxTreeItem.java
diffstat 1 files changed, 10 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/javafx-ui-controls/src/javafx/scene/control/CheckBoxTreeItem.java	Tue Jul 03 12:22:43 2012 +1200
+++ b/javafx-ui-controls/src/javafx/scene/control/CheckBoxTreeItem.java	Tue Jul 03 15:28:41 2012 +1200
@@ -43,7 +43,16 @@
  * <p>A CheckBoxTreeItem can be {@link #independentProperty() independent} or 
  * dependent. By default, CheckBoxTreeItem instances are dependent, which means 
  * that any changes to the selection state of a TreeItem will have an impact on 
- * parent and children CheckBoxTreeItem instances. 
+ * parent and children CheckBoxTreeItem instances. If a CheckBoxTreeItem is
+ * set to be independent, this means that any changes to that CheckBoxTreeItem
+ * will not directly impact the state of parent and children CheckBoxTreeItem
+ * instances.
+ * 
+ * <p>The {@link #indeterminateProperty() indeterminate} property is used to
+ * represent the same concept as that in {@link CheckBox#indeterminateProperty()},
+ * namely, that the CheckBox is neither selected or unselected. This is commonly
+ * used inside a TreeView when some, but not all, of a branches children are
+ * selected.
  * 
  * <p>A simple example of using the CheckBoxTreeItem class, in conjunction with 
  * {@link CheckBoxCellFactory} or {@link CheckBoxTreeCell} classes is shown