changeset 10761:73966fd43b0d

8188314: Fix typos in FX API docs Reviewed-by: kcr
author jjg
date Thu, 21 Dec 2017 16:56:59 -0800
parents c56facad487c
children e3f05da72f19
files modules/javafx.base/src/main/java/javafx/collections/ListChangeListener.java modules/javafx.controls/src/main/java/javafx/scene/control/TableView.java modules/javafx.graphics/src/main/java/javafx/scene/Group.java modules/javafx.graphics/src/main/java/javafx/scene/layout/RowConstraints.java modules/javafx.graphics/src/main/java/javafx/scene/paint/Stop.java
diffstat 5 files changed, 25 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/modules/javafx.base/src/main/java/javafx/collections/ListChangeListener.java	Wed Dec 20 17:45:33 2017 -0800
+++ b/modules/javafx.base/src/main/java/javafx/collections/ListChangeListener.java	Thu Dec 21 16:56:59 2017 -0800
@@ -78,18 +78,17 @@
      *     public void onChanged(Change<Item> c) {
      *         while (c.next()) {
      *             if (c.wasPermutated()) {
-     *                     for (int i = c.getFrom(); i < c.getTo(); ++i) {
-     *                          //permutate
-     *                     }
-     *                 } else if (c.wasUpdated()) {
-     *                          //update item
-     *                 } else {
-     *                     for (Item remitem : c.getRemoved()) {
-     *                         remitem.remove(Outer.this);
-     *                     }
-     *                     for (Item additem : c.getAddedSubList()) {
-     *                         additem.add(Outer.this);
-     *                     }
+     *                 for (int i = c.getFrom(); i < c.getTo(); ++i) {
+     *                      //permutate
+     *                 }
+     *             } else if (c.wasUpdated()) {
+     *                      //update item
+     *             } else {
+     *                 for (Item remitem : c.getRemoved()) {
+     *                     remitem.remove(Outer.this);
+     *                 }
+     *                 for (Item additem : c.getAddedSubList()) {
+     *                     additem.add(Outer.this);
      *                 }
      *             }
      *         }
--- a/modules/javafx.controls/src/main/java/javafx/scene/control/TableView.java	Wed Dec 20 17:45:33 2017 -0800
+++ b/modules/javafx.controls/src/main/java/javafx/scene/control/TableView.java	Thu Dec 21 16:56:59 2017 -0800
@@ -116,11 +116,11 @@
  * <h2>Creating a TableView</h2>
  *
  * <p>
- * {@literal Creating a TableView is a multi-step process, and also depends on the
+ * Creating a TableView is a multi-step process, and also depends on the
  * underlying data model needing to be represented. For this example we'll use
- * an ObservableList<Person>, as it is the simplest way of showing data in a
- * TableView. The <code>Person</code> class will consist of a first
- * name and last name properties. That is:}
+ * an {@literal ObservableList<Person>}, as it is the simplest way of showing data in a
+ * TableView. The {@code Person} class will consist of a first
+ * name and last name properties. That is:
  *
  * <pre>
  * {@code
@@ -148,10 +148,9 @@
  * {@code
  * TableView<Person> table = new TableView<Person>();}</pre>
  *
- * {@literal
  * <p>With the basic table defined, we next focus on the data model. As mentioned,
- * for this example, we'll be using a ObservableList<Person>. We can immediately
- * set such a list directly in to the TableView, as such:}
+ * for this example, we'll be using a {@literal ObservableList<Person>}. We can immediately
+ * set such a list directly in to the TableView, as such:
  *
  * <pre>
  * {@code
@@ -207,7 +206,7 @@
  *         return p.getValue().firstNameProperty();
  *     }
  *  });
- * }}</pre>
+ * }</pre>
  *
  * <h3>TableView Selection / Focus APIs</h3>
  * <p>To track selection and focus, it is necessary to become familiar with the
--- a/modules/javafx.graphics/src/main/java/javafx/scene/Group.java	Wed Dec 20 17:45:33 2017 -0800
+++ b/modules/javafx.graphics/src/main/java/javafx/scene/Group.java	Thu Dec 21 16:56:59 2017 -0800
@@ -179,7 +179,7 @@
 
     /**
      * Group defines the preferred width as simply being the width of its layout bounds, which
-     * in turn is simply the sum of the positions and widths of all of its children. That is,
+     * in turn is simply the union of the layout bounds of all of its children. That is,
      * the preferred width is the one that it is at, because a Group cannot be resized.
      *
      * Note: as the layout bounds in autosize Group depend on the Group to be already laid-out,
@@ -199,7 +199,7 @@
 
     /**
      * Group defines the preferred height as simply being the height of its layout bounds, which
-     * in turn is simply the sum of the positions and heights of all of its children. That is,
+     * in turn is simply the union of the layout bounds of all of its children. That is,
      * the preferred height is the one that it is at, because a Group cannot be resized.
      *
      * Note: as the layout bounds in autosize Group depend on the Group to be already laid-out,
--- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/RowConstraints.java	Wed Dec 20 17:45:33 2017 -0800
+++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/RowConstraints.java	Thu Dec 21 16:56:59 2017 -0800
@@ -49,15 +49,15 @@
  *         gridpane.getRowConstraints().add(row);
  *     }
  * }</pre>
- * Or, to create a GridPane where rows take 25%, 50%, 25% of its width:
+ * Or, to create a GridPane where rows take 25%, 50%, 25% of its height:
  * <pre>{@code
  *     GridPane gridpane = new GridPane();
  *     RowConstraints row1 = new RowConstraints();
- *     row1.setPercentWidth(25);
+ *     row1.setPercentHeight(25);
  *     RowConstraints row2 = new RowConstraints();
- *     row2.setPercentWidth(50);
+ *     row2.setPercentHeight(50);
  *     RowConstraints row3 = new RowConstraints();
- *     row3.setPercentWidth(25);
+ *     row3.setPercentHeight(25);
  *     gridpane.getRowConstraints().addAll(row1,row2,row3);
  * }</pre>
  *
--- a/modules/javafx.graphics/src/main/java/javafx/scene/paint/Stop.java	Wed Dec 20 17:45:33 2017 -0800
+++ b/modules/javafx.graphics/src/main/java/javafx/scene/paint/Stop.java	Thu Dec 21 16:56:59 2017 -0800
@@ -41,7 +41,7 @@
  * <pre>{@code
  * // object bounding box relative (proportional:true, default)
  * Stop[] stops = { new Stop(0, Color.WHITE), new Stop(1, Color.BLACK)};
- * LinearGradient lg = new LinearGradient(0, 0, 1, 0, true, CycleMethod.No_CYCLE, stops);
+ * LinearGradient lg = new LinearGradient(0, 0, 1, 0, true, CycleMethod.NO_CYCLE, stops);
  * Rectangle r = new Rectangle();
  * r.setFill(lg);
  * }</pre>