changeset 5556:d5b97ee5ab05

[DOC ONLY] RT-33815: TableView: javadoc for fixedCellSize is ambiguous
author jgiles
date Tue, 29 Oct 2013 15:21:11 +1300
parents b5ee0d1951b6
children 584c05320426
files modules/controls/src/main/java/javafx/scene/control/ListView.java modules/controls/src/main/java/javafx/scene/control/TableView.java modules/controls/src/main/java/javafx/scene/control/TreeTableView.java modules/controls/src/main/java/javafx/scene/control/TreeView.java
diffstat 4 files changed, 39 insertions(+), 32 deletions(-) [+]
line wrap: on
line diff
--- a/modules/controls/src/main/java/javafx/scene/control/ListView.java	Mon Oct 28 21:27:07 2013 -0700
+++ b/modules/controls/src/main/java/javafx/scene/control/ListView.java	Tue Oct 29 15:21:11 2013 +1300
@@ -530,8 +530,8 @@
      * (or Region.USE_COMPUTED_SIZE) will be used to disabled fixed cell size
      * mode.
      *
-     * @param value The new fixed cell size value, or -1 (or Region.USE_COMPUTED_SIZE)
-     *                  to disable.
+     * @param value The new fixed cell size value, or a value less than or equal
+     *              to zero (or Region.USE_COMPUTED_SIZE) to disable.
      * @since JavaFX 8.0
      */
     public final void setFixedCellSize(double value) {
@@ -539,12 +539,12 @@
     }
 
     /**
-     * Returns the fixed cell size value, which may be -1 to represent fixed cell
-     * size mode is disabled, or a value greater than zero to represent the size
-     * of all cells in this control.
+     * Returns the fixed cell size value. A value less than or equal to zero is
+     * used to represent that fixed cell size mode is disabled, and a value
+     * greater than zero represents the size of all cells in this control.
      *
-     * @return A double representing the fixed cell size of this control, or -1
-     *      if fixed cell size mode is disabled.
+     * @return A double representing the fixed cell size of this control, or a
+     *      value less than or equal to zero if fixed cell size mode is disabled.
      * @since JavaFX 8.0
      */
     public final double getFixedCellSize() {
@@ -552,7 +552,7 @@
     }
     /**
      * Specifies whether this control has cells that are a fixed height (of the
-     * specified value). If this value is -1 (i.e. {@link Region#USE_COMPUTED_SIZE}),
+     * specified value). If this value is less than or equal to zero,
      * then all cells are individually sized and positioned. This is a slow
      * operation. Therefore, when performance matters and developers are not
      * dependent on variable cell sizes it is a good idea to set the fixed cell
@@ -568,6 +568,7 @@
      * performance gains from being possible). Therefore, when performance matters
      * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are
      * specified in CSS, -fx-fixed-cell-size takes precedence.</p>
+     *
      * @since JavaFX 8.0
      */
     public final DoubleProperty fixedCellSizeProperty() {
--- a/modules/controls/src/main/java/javafx/scene/control/TableView.java	Mon Oct 28 21:27:07 2013 -0700
+++ b/modules/controls/src/main/java/javafx/scene/control/TableView.java	Tue Oct 29 15:21:11 2013 +1300
@@ -908,8 +908,8 @@
      * (or Region.USE_COMPUTED_SIZE) will be used to disabled fixed cell size
      * mode.
      *
-     * @param value The new fixed cell size value, or -1 (or Region.USE_COMPUTED_SIZE)
-     *                  to disable.
+     * @param value The new fixed cell size value, or a value less than or equal
+     *              to zero (or Region.USE_COMPUTED_SIZE) to disable.
      * @since JavaFX 8.0
      */
     public final void setFixedCellSize(double value) {
@@ -917,12 +917,12 @@
     }
 
     /**
-     * Returns the fixed cell size value, which may be -1 to represent fixed cell
-     * size mode is disabled, or a value greater than zero to represent the size
-     * of all cells in this control.
+     * Returns the fixed cell size value. A value less than or equal to zero is
+     * used to represent that fixed cell size mode is disabled, and a value
+     * greater than zero represents the size of all cells in this control.
      *
-     * @return A double representing the fixed cell size of this control, or -1
-     *      if fixed cell size mode is disabled.
+     * @return A double representing the fixed cell size of this control, or a
+     *      value less than or equal to zero if fixed cell size mode is disabled.
      * @since JavaFX 8.0
      */
     public final double getFixedCellSize() {
@@ -930,7 +930,7 @@
     }
     /**
      * Specifies whether this control has cells that are a fixed height (of the
-     * specified value). If this value is -1 (i.e. {@link Region#USE_COMPUTED_SIZE}),
+     * specified value). If this value is less than or equal to zero,
      * then all cells are individually sized and positioned. This is a slow
      * operation. Therefore, when performance matters and developers are not
      * dependent on variable cell sizes it is a good idea to set the fixed cell
@@ -946,6 +946,7 @@
      * performance gains from being possible). Therefore, when performance matters
      * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are
      * specified in CSS, -fx-fixed-cell-size takes precedence.</p>
+     *
      * @since JavaFX 8.0
      */
     public final DoubleProperty fixedCellSizeProperty() {
--- a/modules/controls/src/main/java/javafx/scene/control/TreeTableView.java	Mon Oct 28 21:27:07 2013 -0700
+++ b/modules/controls/src/main/java/javafx/scene/control/TreeTableView.java	Tue Oct 29 15:21:11 2013 +1300
@@ -1080,27 +1080,29 @@
      * (or Region.USE_COMPUTED_SIZE) will be used to disabled fixed cell size
      * mode.
      *
-     * @param value The new fixed cell size value, or -1 (or Region.USE_COMPUTED_SIZE)
-     *                  to disable.
+     * @param value The new fixed cell size value, or a value less than or equal
+     *              to zero (or Region.USE_COMPUTED_SIZE) to disable.
+     * @since JavaFX 8.0
      */
     public final void setFixedCellSize(double value) {
         fixedCellSizeProperty().set(value);
     }
 
     /**
-     * Returns the fixed cell size value, which may be -1 to represent fixed cell
-     * size mode is disabled, or a value greater than zero to represent the size
-     * of all cells in this control.
+     * Returns the fixed cell size value. A value less than or equal to zero is
+     * used to represent that fixed cell size mode is disabled, and a value
+     * greater than zero represents the size of all cells in this control.
      *
-     * @return A double representing the fixed cell size of this control, or -1
-     *      if fixed cell size mode is disabled.
+     * @return A double representing the fixed cell size of this control, or a
+     *      value less than or equal to zero if fixed cell size mode is disabled.
+     * @since JavaFX 8.0
      */
     public final double getFixedCellSize() {
         return fixedCellSize == null ? Region.USE_COMPUTED_SIZE : fixedCellSize.get();
     }
     /**
      * Specifies whether this control has cells that are a fixed height (of the
-     * specified value). If this value is -1 (i.e. {@link Region#USE_COMPUTED_SIZE}),
+     * specified value). If this value is less than or equal to zero,
      * then all cells are individually sized and positioned. This is a slow
      * operation. Therefore, when performance matters and developers are not
      * dependent on variable cell sizes it is a good idea to set the fixed cell
@@ -1116,6 +1118,8 @@
      * performance gains from being possible). Therefore, when performance matters
      * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are
      * specified in CSS, -fx-fixed-cell-size takes precedence.</p>
+     *
+     * @since JavaFX 8.0
      */
     public final DoubleProperty fixedCellSizeProperty() {
         if (fixedCellSize == null) {
--- a/modules/controls/src/main/java/javafx/scene/control/TreeView.java	Mon Oct 28 21:27:07 2013 -0700
+++ b/modules/controls/src/main/java/javafx/scene/control/TreeView.java	Tue Oct 29 15:21:11 2013 +1300
@@ -537,8 +537,8 @@
      * (or Region.USE_COMPUTED_SIZE) will be used to disabled fixed cell size
      * mode.
      *
-     * @param value The new fixed cell size value, or -1 (or Region.USE_COMPUTED_SIZE)
-     *                  to disable.
+     * @param value The new fixed cell size value, or a value less than or equal
+     *              to zero (or Region.USE_COMPUTED_SIZE) to disable.
      * @since JavaFX 8.0
      */
     public final void setFixedCellSize(double value) {
@@ -546,12 +546,12 @@
     }
 
     /**
-     * Returns the fixed cell size value, which may be -1 to represent fixed cell
-     * size mode is disabled, or a value greater than zero to represent the size
-     * of all cells in this control.
+     * Returns the fixed cell size value. A value less than or equal to zero is
+     * used to represent that fixed cell size mode is disabled, and a value
+     * greater than zero represents the size of all cells in this control.
      *
-     * @return A double representing the fixed cell size of this control, or -1
-     *      if fixed cell size mode is disabled.
+     * @return A double representing the fixed cell size of this control, or a
+     *      value less than or equal to zero if fixed cell size mode is disabled.
      * @since JavaFX 8.0
      */
     public final double getFixedCellSize() {
@@ -559,7 +559,7 @@
     }
     /**
      * Specifies whether this control has cells that are a fixed height (of the
-     * specified value). If this value is -1 (i.e. {@link Region#USE_COMPUTED_SIZE}),
+     * specified value). If this value is less than or equal to zero,
      * then all cells are individually sized and positioned. This is a slow
      * operation. Therefore, when performance matters and developers are not
      * dependent on variable cell sizes it is a good idea to set the fixed cell
@@ -575,6 +575,7 @@
      * performance gains from being possible). Therefore, when performance matters
      * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are
      * specified in CSS, -fx-fixed-cell-size takes precedence.</p>
+     *
      * @since JavaFX 8.0
      */
     public final DoubleProperty fixedCellSizeProperty() {