--- old/modules/javafx.controls/src/main/java/javafx/scene/chart/AreaChart.java 2017-03-09 14:44:08.938173401 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/AreaChart.java 2017-03-09 14:44:08.806173399 -0800 @@ -154,7 +154,7 @@ return (number == null) ? nullDefault : number.doubleValue(); } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void updateAxisRange() { final Axis xa = getXAxis(); final Axis ya = getYAxis(); @@ -330,7 +330,7 @@ //Note: better animation here, point should move from old position to new position at center point between prev and next symbols } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemChanged(Data item) { } @@ -415,7 +415,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutPlotChildren() { List constructedPath = new ArrayList<>(getDataSize()); for (int seriesIndex=0; seriesIndex < getDataSize(); seriesIndex++) { --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/BarChart.java 2017-03-09 14:44:09.334173408 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/BarChart.java 2017-03-09 14:44:09.234173407 -0800 @@ -243,7 +243,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemChanged(Data item) { double barVal; double currentVal; @@ -343,7 +343,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutPlotChildren() { double catSpace = categoryAxis.getCategorySpacing(); // calculate bar spacing --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/BubbleChart.java 2017-03-09 14:44:09.714173415 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/BubbleChart.java 2017-03-09 14:44:09.594173413 -0800 @@ -90,7 +90,7 @@ return !(number instanceof Number) ? nullDefault : ((Number)number).doubleValue(); } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutPlotChildren() { // update bubble positions for (int seriesIndex=0; seriesIndex < getDataSize(); seriesIndex++) { @@ -167,7 +167,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemChanged(Data item) { } --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/CategoryAxis.java 2017-03-09 14:44:10.074173422 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/CategoryAxis.java 2017-03-09 14:44:09.966173420 -0800 @@ -199,6 +199,7 @@ * based on the charts data if autoRanging is true. If the application sets the categories * then auto ranging is turned off. If there is an attempt to add duplicate entry into this list, * an {@link IllegalArgumentException} is thrown. + * @param value the ordered list of categories plotted on this axis */ public final void setCategories(ObservableList value) { categories.set(value); --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/Chart.java 2017-03-09 14:44:10.426173428 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/Chart.java 2017-03-09 14:44:10.322173426 -0800 @@ -128,7 +128,7 @@ /** * The side of the chart where the title is displayed - * @default Side.TOP + * @defaultValue Side.TOP */ private ObjectProperty titleSide = new StyleableObjectProperty(Side.TOP) { @Override protected void invalidated() { @@ -309,6 +309,7 @@ /** * This is used to check if any given animation should run. It returns true if animation is enabled and the node * is visible and in a scene. + * @return true if animation is enabled and the node is visible and in a scene */ protected final boolean shouldAnimate(){ return getAnimated() && NodeHelper.isTreeShowing(this); --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/LineChart.java 2017-03-09 14:44:10.782173434 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/LineChart.java 2017-03-09 14:44:10.678173432 -0800 @@ -187,7 +187,7 @@ // -------------- METHODS ------------------------------------------------------------------------------------------ - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void updateAxisRange() { final Axis xa = getXAxis(); final Axis ya = getYAxis(); @@ -369,7 +369,7 @@ //Note: better animation here, point should move from old position to new position at center point between prev and next symbols } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemChanged(Data item) { } @@ -447,7 +447,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutPlotChildren() { List constructedPath = new ArrayList<>(getDataSize()); for (int seriesIndex=0; seriesIndex < getDataSize(); seriesIndex++) { @@ -491,7 +491,7 @@ } } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override void dataBeingRemovedIsAdded(Data item, Series series) { if (fadeSymbolTransition != null) { fadeSymbolTransition.setOnFinished(null); @@ -515,7 +515,7 @@ } XYValueMap.clear(); } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override void seriesBeingRemovedIsAdded(Series series) { if (seriesRemoveTimeline != null) { seriesRemoveTimeline.setOnFinished(null); --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/PieChart.java 2017-03-09 14:44:11.158173441 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/PieChart.java 2017-03-09 14:44:11.038173439 -0800 @@ -521,7 +521,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutChartChildren(double top, double left, double contentWidth, double contentHeight) { double total = 0.0; for (Data item = begin; item != null; item = item.next) { @@ -972,6 +972,7 @@ /** * Returns the node that represents the pie slice. You can use this to * add mouse event listeners etc. + * @return the node that represents the pie slice */ public Node getNode() { return node.getValue(); --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/ScatterChart.java 2017-03-09 14:44:11.514173447 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/ScatterChart.java 2017-03-09 14:44:11.414173445 -0800 @@ -72,7 +72,7 @@ // -------------- METHODS ------------------------------------------------------------------------------------------ - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemAdded(Series series, int itemIndex, Data item) { Node symbol = item.getNode(); // check if symbol has already been created @@ -98,7 +98,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemRemoved(final Data item, final Series series) { final Node symbol = item.getNode(); @@ -122,11 +122,11 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemChanged(Data item) { } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void seriesAdded(Series series, int seriesIndex) { // handle any data already in series for (int j=0; j series) { // remove all symbol nodes if (shouldAnimate()) { @@ -163,7 +163,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutPlotChildren() { // update symbol positions for (int seriesIndex=0; seriesIndex < getDataSize(); seriesIndex++) { --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/StackedAreaChart.java 2017-03-09 14:44:11.870173453 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/StackedAreaChart.java 2017-03-09 14:44:11.766173452 -0800 @@ -314,7 +314,7 @@ //Note: better animation here, point should move from old position to new position at center point between prev and next symbols } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemChanged(Data item) { } @@ -396,7 +396,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void updateAxisRange() { // This override is necessary to update axis range based on cumulative Y value for the // Y axis instead of the normal way where max value in the data range is used. @@ -497,7 +497,7 @@ } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutPlotChildren() { ArrayList> currentSeriesData = new ArrayList<>(); // AggregateData hold the data points of both the current and the previous series. --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/StackedBarChart.java 2017-03-09 14:44:12.226173460 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/StackedBarChart.java 2017-03-09 14:44:12.122173458 -0800 @@ -233,7 +233,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void dataItemChanged(Data item) { double barVal; double currentVal; @@ -266,7 +266,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void seriesAdded(Series series, int seriesIndex) { // handle any data already in series // create entry in the map @@ -336,7 +336,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void updateAxisRange() { // This override is necessary to update axis range based on cumulative Y value for the // Y axis instead of the inherited way where the max value in the data range is used. @@ -377,7 +377,7 @@ } } - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected void layoutPlotChildren() { double catSpace = categoryAxis.getCategorySpacing(); // calculate bar spacing --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/XYChart.java 2017-03-09 14:44:12.582173466 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/XYChart.java 2017-03-09 14:44:12.482173464 -0800 @@ -172,11 +172,17 @@ // -------------- PUBLIC PROPERTIES -------------------------------------------------------------------------------- private final Axis xAxis; - /** Get the X axis, by default it is along the bottom of the plot */ + /** + * Get the X axis, by default it is along the bottom of the plot + * @return the X axis of the chart + */ public Axis getXAxis() { return xAxis; } private final Axis yAxis; - /** Get the Y axis, by default it is along the left of the plot */ + /** + * Get the Y axis, by default it is along the left of the plot + * @return the Y axis of this chart + */ public Axis getYAxis() { return yAxis; } /** XYCharts data */ @@ -612,7 +618,10 @@ */ protected abstract void seriesRemoved(Series series); - /** Called when each atomic change is made to the list of series for this chart */ + /** + * Called when each atomic change is made to the list of series for this chart + * @param c The series that has been changed + */ protected void seriesChanged(Change c) {} /** @@ -653,7 +662,7 @@ */ protected abstract void layoutPlotChildren(); - /** @inheritDoc */ + /** {@inheritDoc} */ @Override protected final void layoutChartChildren(double top, double left, double width, double height) { if(getData() == null) return; if (!rangeValid) { @@ -963,12 +972,15 @@ * used by XYChart to animate the xValue from the old value to the new value. This is what you should plot * in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this * to animate when data is added or removed. + * @param item The XYChart.Data item from which the current X axis data value is obtained + * @return The current displayed X data value */ protected final X getCurrentDisplayedXValue(Data item) { return item.getCurrentX(); } /** Set the current displayed data value plotted on X axis. * * @param item The XYChart.Data item from which the current X axis data value is obtained. + * @param value The X axis data value * @see #getCurrentDisplayedXValue */ protected final void setCurrentDisplayedXValue(Data item, X value) { item.setCurrentX(value); } @@ -986,6 +998,8 @@ * used by XYChart to animate the yValue from the old value to the new value. This is what you should plot * in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this * to animate when data is added or removed. + * @param item The XYChart.Data item from which the current Y axis data value is obtained + * @return The current displayed Y data value */ protected final Y getCurrentDisplayedYValue(Data item) { return item.getCurrentY(); } @@ -993,6 +1007,7 @@ * Set the current displayed data value plotted on Y axis. * * @param item The XYChart.Data item from which the current Y axis data value is obtained. + * @param value The Y axis data value * @see #getCurrentDisplayedYValue */ protected final void setCurrentDisplayedYValue(Data item, Y value) { item.setCurrentY(value); } @@ -1009,6 +1024,8 @@ * The current displayed data extra value. This may be the same as extraValue or different. It is * used by XYChart to animate the extraValue from the old value to the new value. This is what you should plot * in any custom XYChart implementations. + * @param item The XYChart.Data item from which the current extra value is obtained + * @return The current extra value */ protected final Object getCurrentDisplayedExtraValue(Data item) { return item.getCurrentExtraValue(); } @@ -1016,6 +1033,7 @@ * Set the current displayed data extra value. * * @param item The XYChart.Data item from which the current extra value is obtained. + * @param value The extra value * @see #getCurrentDisplayedExtraValue */ protected final void setCurrentDisplayedExtraValue(Data item, Object value) { item.setCurrentExtraValue(value); } @@ -1024,7 +1042,7 @@ * The current displayed extra value property. * * @param item The XYChart.Data item from which the current extra value property object is obtained. - * @return ObjectProperty The current extra value ObjectProperty + * @return {@literal ObjectProperty The current extra value ObjectProperty} * @see #getCurrentDisplayedExtraValue */ protected final ObjectProperty currentDisplayedExtraValueProperty(Data item) { return item.currentExtraValueProperty(); } --- old/modules/javafx.controls/src/main/java/javafx/scene/chart/package.html 2017-03-09 14:44:12.954173473 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/chart/package.html 2017-03-09 14:44:12.850173471 -0800 @@ -34,7 +34,7 @@

Below is a table listing the existing Chart types and a brief summary of their intended use.

- +

Chart

@@ -124,107 +124,99 @@ javafx.scene.chart.XYChart.Series} objects. Each series contains {@link javafx.scene.chart.XYChart.Data} objects.

-
    -
    // add data
    -XYChart.Series<String,Number> series1 = new XYChart.Series<String,Number>();
    -series1.setName("Data Series 1");
    -series1.getData().add(new XYChart.Data<String,Number>(“2007”, 567));
    -    
    -
+
{@code
+    // add data
+    XYChart.Series series1 = new XYChart.Series();
+    series1.setName("Data Series 1");
+    series1.getData().add(new XYChart.Data("2007", 567));
+}

We can define more series objects similarly. Following code snippet shows how to create a BarChart with 3 categories and its X and Y axis:

-
    -
    static String[] years = {"2007", "2008", "2009"};
    -final CategoryAxis xAxis = new CategoryAxis();
    -final NumberAxis yAxis = new NumberAxis();
    -final BarChart<String,Number> bc = new BarChart<String,Number>(xAxis,yAxis);
    -xAxis.setCategories(FXCollections.<String>observableArrayList(Arrays.asList(years)));
    -bc.getData().addAll(series1, series2, series3);
    -   
    -
+
{@code
+    static String[] years = {"2007", "2008", "2009"};
+    final CategoryAxis xAxis = new CategoryAxis();
+    final NumberAxis yAxis = new NumberAxis();
+    final BarChart bc = new BarChart(xAxis, yAxis);
+    xAxis.setCategories(FXCollections.observableArrayList(Arrays.asList(years)));
+    bc.getData().addAll(series1, series2, series3);
+}

JavaFX charts lends itself very well for real time or dynamic Charting (like online stocks, web traffic etc) from live data sets. Here is an example of a dynamic chart created with simulated data. A {@link javafx.animation.Timeline} is used to simulate dynamic data for stock price variations over time(hours).

-
    -
    private XYChart.Series<Number,Number> hourDataSeries; 
    -private NumberAxis xAxis;
    -private Timeline animation;
    -private double hours = 0; 
    -private double timeInHours = 0;
    -private double prevY = 10;
    -private double y = 10; 
    -
    -// timeline to add new data every 60th of a second
    -animation = new Timeline();
    -animation.getKeyFrames().add(new KeyFrame(Duration.millis(1000 / 60), new    EventHandler<ActionEvent>() {
    -    @Override public void handle(ActionEvent actionEvent) {
    -        // 6 minutes data per frame
    -
      -
        for(int count=0; count < 6; count++) {
      -
        -
        nextTime();
        -plotTime();
        -
      -
        }
      -}
      -
    -
    }));
    -animation.setCycleCount(Animation.INDEFINITE);
    -
    -xAxis = new NumberAxis(0,24,3);
    -
-
      final NumberAxis yAxis = new NumberAxis(0,100,10);
-      final LineChart<Number,Number> lc = new LineChart<Number,Number>(xAxis,yAxis);
-
-      lc.setCreateSymbols(false);
-      lc.setAnimated(false);
-      lc.setLegendVisible(false);
-      lc.setTitle("ACME Company Stock");
-
-      xAxis.setLabel("Time");
-      xAxis.setForceZeroInRange(false);
-      yAxis.setLabel("Share Price");
-      yAxis.setTickLabelFormatter(new NumberAxis.DefaultFormatter(yAxis,"$",null));
-
-      hourDataSeries = new XYChart.Series<Number,Number>();
-      hourDataSeries.setName("Hourly Data");
-      hourDataSeries.getData().add(new XYChart.Data<Number,Number>(timeInHours,prevY));
-      lc.getData().add(hourDataSeries);
-
-      private void nextTime() {
-          if (minutes == 59) {
-              hours ++;
-              minutes = 0;
-          } else {
-              minutes ++;
-          }
-          timeInHours = hours + ((1d/60d)*minutes);
-      }
-
-      private void plotTime() {
-          if ((timeInHours % 1) == 0) {
-              // change of hour
-              double oldY = y;
-              y = prevY - 10 + (Math.random()*20);
-              prevY = oldY;
-              while (y < 10 || y > 90) y = y - 10 + (Math.random()*20);
-              hourDataSeries.getData().add(new XYChart.Data<Number, Number>(timeInHours, prevY));
-              // after 25hours delete old data
-              if (timeInHours > 25) hourDataSeries.getData().remove(0);
-              // every hour after 24 move range 1 hour
-              if (timeInHours > 24) {
-                  xAxis.setLowerBound(xAxis.getLowerBound()+1);
-                  xAxis.setUpperBound(xAxis.getUpperBound()+1);
-              }
-          }
-      }

-
-

+

+    {@literal private XYChart.Series hourDataSeries;} 
+    private NumberAxis xAxis;
+    private Timeline animation;
+    private double hours = 0; 
+    private double timeInHours = 0;
+    private double prevY = 10;
+    private double y = 10; 
+
+    // timeline to add new data every 60th of a second
+    animation = new Timeline();
+    {@literal animation.getKeyFrames().add(new KeyFrame(Duration.millis(1000 / 60), new EventHandler()} {
+        {@literal @Override public void handle(ActionEvent actionEvent)} {
+            // 6 minutes data per frame
+            {@literal for(int count = 0; count < 6; count++)} {
+                nextTime();
+                plotTime();
+            }
+        }
+    }));
+    animation.setCycleCount(Animation.INDEFINITE);
+    xAxis = new NumberAxis(0, 24, 3);
+    final NumberAxis yAxis = new NumberAxis(0, 100, 10);
+    {@literal final LineChart lc = new LineChart(xAxis, yAxis)};
+
+    lc.setCreateSymbols(false);
+    lc.setAnimated(false);
+    lc.setLegendVisible(false);
+    lc.setTitle("ACME Company Stock");
+
+    xAxis.setLabel("Time");
+    xAxis.setForceZeroInRange(false);
+    yAxis.setLabel("Share Price");
+    yAxis.setTickLabelFormatter(new NumberAxis.DefaultFormatter(yAxis, "$", null));
+
+    {@literal hourDataSeries = new XYChart.Series();}
+    hourDataSeries.setName("Hourly Data");
+    {@literal hourDataSeries.getData().add(new XYChart.Data(timeInHours, prevY));}
+    lc.getData().add(hourDataSeries);
+
+    private void nextTime() {
+        if (minutes == 59) {
+            hours++;
+            minutes = 0;
+        } else {
+            minutes++;
+        }
+        timeInHours = hours + ((1d/60d) * minutes);
+    }
+
+    private void plotTime() {
+        if ((timeInHours % 1) == 0) {
+            // change of hour
+            double oldY = y;
+            y = prevY - 10 + (Math.random() * 20);
+            prevY = oldY;
+            {@literal while (y < 10 || y > 90) y = y - 10 + (Math.random() * 20);}
+            {@literal hourDataSeries.getData().add(new XYChart.Data(timeInHours, prevY));}
+            // after 25hours delete old data
+            {@literal if (timeInHours > 25) hourDataSeries.getData().remove(0)};
+            // every hour after 24 move range 1 hour
+            {@literal if (timeInHours > 24)} {
+                xAxis.setLowerBound(xAxis.getLowerBound() + 1);
+                xAxis.setUpperBound(xAxis.getUpperBound() + 1);
+            }
+        }
+    } 
+
+

The start method needs to call animation,.play() to start the simulated dynamic chart.

Please refer to javafx.scene.control package documentation on CSS @@ -235,8 +227,5 @@

.chart-series-line { -fx-stroke: green; -fx-stroke-width: 4px;}


-
    -
            
    -
--- old/modules/javafx.controls/src/main/java/javafx/scene/control/Accordion.java 2017-03-09 14:44:13.314173479 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Accordion.java 2017-03-09 14:44:13.210173477 -0800 @@ -171,6 +171,7 @@ * then expanded pane will be set to null, if possible. (This will not be possible * if you have manually bound the expanded pane to some value, for example). *

+ * @param value the expanded {@link TitledPane} */ public final void setExpandedPane(TitledPane value) { expandedPaneProperty().set(value); } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Alert.java 2017-03-09 14:44:13.666173485 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Alert.java 2017-03-09 14:44:13.558173483 -0800 @@ -214,6 +214,7 @@ * the developer may call {@code alert.getDialogPane().setContent(Node)} if * they want a more complex alert). If the contentText (or content) properties * are not set, there is no useful information presented to end users. + * @param alertType an alert with the given AlertType */ public Alert(@NamedArg("alertType") AlertType alertType) { this(alertType, ""); @@ -234,6 +235,9 @@ * and {@link #graphicProperty() graphic} properties are set. Once the Alert * is instantiated, developers are able to modify the values of the alert as * desired. + * @param alertType the alert type + * @param contentText the content text + * @param buttons the button types */ public Alert(@NamedArg("alertType") AlertType alertType, @NamedArg("contentText") String contentText, @@ -282,6 +286,7 @@ private final ObjectProperty alertType = new SimpleObjectProperty(null) { final String[] styleClasses = new String[] { "information", "warning", "error", "confirmation" }; + @Override protected void invalidated() { String newTitle = ""; String newHeader = ""; @@ -366,6 +371,8 @@ * but at a high level, each ButtonType instance is converted to * a Node (although most commonly a {@link Button}) via the (overridable) * {@link DialogPane#createButton(ButtonType)} method on {@link DialogPane}. + * @return an {@link ObservableList} of all {@link ButtonType} instances that + * are currently set inside this Alert instance */ // --- buttonTypes public final ObservableList getButtonTypes() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ButtonBar.java 2017-03-09 14:44:14.018173491 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ButtonBar.java 2017-03-09 14:44:13.914173490 -0800 @@ -69,9 +69,9 @@ * laid out on each of the three operating systems. * *

- * Windows:

- * Mac OS:

- * Linux:

+ * Windows:

+ * Mac OS:

+ * Linux:

* *

Code Samples

*

Instantiating and using the ButtonBar is simple, simply do the following: @@ -102,9 +102,9 @@ * strings that are shorthand representations for the button order. The built-in * orders for Windows, Mac OS and Linux are: * - * + *
* - * + * * * * @@ -317,6 +317,8 @@ * Returns the single character code used to represent the ButtonData * annotation in the {@link ButtonBar#buttonOrderProperty() button order} * string. + * @return the single character code used to represent the ButtonData + * annotation */ public String getTypeCode() { return typeCode; @@ -330,6 +332,7 @@ * *

ButtonData enumeration values that can be the cancel button have a * comment stating this in their javadoc. + * @return true if this is a 'cancel' button */ public final boolean isCancelButton() { return cancelButton; @@ -343,6 +346,7 @@ * *

ButtonData enumeration values that can be the default button have * a comment stating this in their javadoc. + * @return true if this is a 'default' button */ public final boolean isDefaultButton() { return defaultButton; @@ -374,6 +378,7 @@ * was never set, this method will return null. * * @param button The button to return the previously set ButtonData for. + * @return the previously set ButtonData property on the given button */ public static ButtonData getButtonData(Node button) { final Map properties = button.getProperties(); @@ -413,6 +418,8 @@ * Returns whether the given node is part of the uniform sizing calculations * or not. By default all nodes that have not opted out (via * {@link #setButtonUniformSize(Node, boolean)}) will return true here. + * @param button the button + * @return true if button is part of the uniform sizing calculations */ public static boolean isButtonUniformSize(Node button) { return (boolean) button.getProperties().getOrDefault(Properties.BUTTON_SIZE_INDEPENDENCE, true); @@ -519,6 +526,7 @@ * one letter per {@link ButtonData} enumeration value. Default button orders * for operating systems are also available: {@link #BUTTON_ORDER_WINDOWS}, * {@link #BUTTON_ORDER_MAC_OS}, and {@link #BUTTON_ORDER_LINUX}. + * @return the button order property */ public final StringProperty buttonOrderProperty() { return buttonOrderProperty; @@ -547,6 +555,7 @@ // --- button min width /** * Specifies the minimum width of all buttons placed in this button bar. + * @return the minimum width property */ public final DoubleProperty buttonMinWidthProperty() { return buttonMinWidthProperty; @@ -556,6 +565,7 @@ /** * Sets the minimum width of all buttons placed in this button bar. + * @param value the minimum width value */ public final void setButtonMinWidth(double value) { buttonMinWidthProperty.set(value); @@ -563,6 +573,7 @@ /** * Returns the minimum width of all buttons placed in this button bar. + * @return the minimum width value */ public final double getButtonMinWidth() { return buttonMinWidthProperty.get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ButtonBase.java 2017-03-09 14:44:14.386173498 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ButtonBase.java 2017-03-09 14:44:14.278173496 -0800 @@ -91,6 +91,7 @@ * pressed on a Node and has not yet been released. {@code arm} however * also takes into account whether the mouse is actually over the * button and pressed. + * @return the property to indicate that the button has been "armed" */ public final ReadOnlyBooleanProperty armedProperty() { return armed.getReadOnlyProperty(); } private void setArmed(boolean value) { armed.set(value); } @@ -116,6 +117,8 @@ * may be due to the user clicking on the button with the mouse, or by * a touch event, or by a key press, or if the developer programmatically * invokes the {@link #fire()} method. + * @return the property to represent the button's action, which is invoked + * whenever the button is fired */ public final ObjectProperty> onActionProperty() { return onAction; } public final void setOnAction(EventHandler value) { onActionProperty().set(value); } @@ -149,9 +152,9 @@ * {@link CheckBox} or some other behavior) on the next expected UI * gesture. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. */ public void arm() { setArmed(true); @@ -160,9 +163,9 @@ /** * Disarms the button. See {@link #arm()}. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. */ public void disarm() { setArmed(false); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ButtonType.java 2017-03-09 14:44:14.758173505 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ButtonType.java 2017-03-09 14:44:14.638173502 -0800 @@ -146,11 +146,13 @@ /** * Returns the ButtonData specified for this ButtonType in the constructor. + * @return the ButtonData specified for this ButtonType in the constructor */ public final ButtonData getButtonData() { return this.buttonData; } /** - * Returns the text specified for this ButtonType in the constructor; + * Returns the text specified for this ButtonType in the constructor. + * @return the text specified for this ButtonType in the constructor */ public final String getText() { if (text == null && key != null) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Cell.java 2017-03-09 14:44:15.110173511 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Cell.java 2017-03-09 14:44:15.006173509 -0800 @@ -139,7 +139,7 @@ * double value = item.doubleValue(); * setTextFill(isSelected() ? Color.WHITE : * value == 0 ? Color.BLACK : - * value < 0 ? Color.RED : Color.GREEN); + * value < 0 ? Color.RED : Color.GREEN); * } * } * } @@ -393,17 +393,20 @@ *

This value should only be set in subclasses of Cell by the virtualised * user interface controls that know how to properly work with the Cell * class. + * @return the data value associated with this cell */ public final ObjectProperty itemProperty() { return item; } /** * Sets the item to the given value - should not be called directly as the * item is managed by the virtualized control. + * @param value the data value to this item */ public final void setItem(T value) { item.set(value); } /** * Returns the data value associated with this Cell. + * @return the data value associated with this cell */ public final T getItem() { return item.get(); } @@ -437,6 +440,7 @@ * CSS pseudo class state. For example, it may not receive any * alternate row highlighting, or it may not receive hover background * fill when hovered. + * @return the representation of whether this cell has any contents */ public final ReadOnlyBooleanProperty emptyProperty() { return empty.getReadOnlyProperty(); } @@ -445,6 +449,7 @@ /** * Returns a boolean representing whether the cell is considered to be empty * or not. + * @return true if cell is empty, otherwise false */ public final boolean isEmpty() { return empty.get(); } @@ -470,6 +475,7 @@ /** * Indicates whether or not this cell has been selected. For example, a * ListView defines zero or more cells as being the "selected" cells. + * @return the representation of whether this cell has been selected */ public final ReadOnlyBooleanProperty selectedProperty() { return selected.getReadOnlyProperty(); } @@ -492,6 +498,8 @@ /** * Represents whether the cell is currently in its editing state or not. + * @return true if this cell is currently in its editing state, otherwise + * false */ public final boolean isEditing() { return editing == null ? false : editing.get(); @@ -499,6 +507,8 @@ /** * Property representing whether this cell is currently in its editing state. + * @return the representation of whether this cell is currently in its + * editing state */ public final ReadOnlyBooleanProperty editingProperty() { return editingPropertyImpl().getReadOnlyProperty(); @@ -532,6 +542,8 @@ /** * Returns whether this cell is allowed to be put into an editing state. + * @return true if this cell is allowed to be put into an editing state, + * otherwise false */ public final boolean isEditable() { return editable == null ? true : editable.get(); @@ -544,6 +556,8 @@ * to satisfy additional criteria. For example, ListCell requires that the * ListView {@link ListView#editableProperty() editable} property is also * true. + * @return the representation of whether this cell is allowed to be put into + * an editing state */ public final BooleanProperty editableProperty() { if (editable == null) { @@ -673,7 +687,6 @@ * @param empty whether or not this cell represents data from the list. If it * is empty, then it does not represent any domain data, but is a cell * being used to render an "empty" row. - * @expert */ protected void updateItem(T item, boolean empty) { setItem(item); @@ -685,7 +698,6 @@ /** * Updates whether this cell is in a selected state or not. - * @expert * @param selected whether or not to select this cell. */ public void updateSelected(boolean selected) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/CheckBoxTreeItem.java 2017-03-09 14:44:15.474173517 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/CheckBoxTreeItem.java 2017-03-09 14:44:15.366173515 -0800 @@ -74,6 +74,7 @@ * // set the cell factory * treeView.setCellFactory(CheckBoxTreeCell.<String>forTreeView()); * + * @param The type of the value contained within the TreeItem * @see CheckBoxTreeCell * @see TreeItem * @see CheckBox @@ -99,6 +100,8 @@ * * * @param The type of the value contained within the TreeItem. + * @return the EventType used when the CheckBoxTreeItem selection / indeterminate + * state changes */ @SuppressWarnings("unchecked") public static EventType> checkBoxSelectionChangedEvent() { @@ -203,11 +206,23 @@ fireEvent(CheckBoxTreeItem.this, true); } }; - /** Sets the selected state of this CheckBoxTreeItem. */ + + /** + * Sets the selected state of this CheckBoxTreeItem. + * @param value the selected state of this CheckBoxTreeItem + */ public final void setSelected(boolean value) { selectedProperty().setValue(value); } - /** Returns the selected state of this CheckBoxTreeItem. */ + + /** + * Returns the selected state of this CheckBoxTreeItem. + * @return true if CheckBoxTreeItem is selected + */ public final boolean isSelected() { return selected.getValue(); } - /** A {@link BooleanProperty} used to represent the selected state of this CheckBoxTreeItem. */ + + /** + * A {@link BooleanProperty} used to represent the selected state of this CheckBoxTreeItem. + * @return the selected state property of this CheckBoxTreeItem + */ public final BooleanProperty selectedProperty() { return selected; } @@ -218,11 +233,23 @@ fireEvent(CheckBoxTreeItem.this, false); } }; - /** Sets the indeterminate state of this CheckBoxTreeItem. */ + + /** + * Sets the indeterminate state of this CheckBoxTreeItem. + * @param value the indeterminate state of this CheckBoxTreeItem + */ public final void setIndeterminate(boolean value) { indeterminateProperty().setValue(value); } - /** Returns the indeterminate state of this CheckBoxTreeItem. */ + + /** + * Returns the indeterminate state of this CheckBoxTreeItem. + * @return true if CheckBoxTreeItem is indeterminate state + */ public final boolean isIndeterminate() { return indeterminate.getValue(); } - /** A {@link BooleanProperty} used to represent the indeterminate state of this CheckBoxTreeItem. */ + + /** + * A {@link BooleanProperty} used to represent the indeterminate state of this CheckBoxTreeItem. + * @return the indeterminate state property of this CheckBoxTreeItem + */ public final BooleanProperty indeterminateProperty() { return indeterminate; } @@ -237,6 +264,7 @@ * properties, the state of related CheckBoxTreeItems will possibly be changed. * If the independent property is set to true, the state of related CheckBoxTreeItems * will never change. + * @return the independent state property of this CheckBoxTreeItem */ public final BooleanProperty independentProperty() { return independent; } private final BooleanProperty independent = new SimpleBooleanProperty(this, "independent", false); @@ -340,6 +368,9 @@ * Creates a default TreeModificationEvent instance to represent the * change in selection/indeterminate states for the given CheckBoxTreeItem * instance. + * @param eventType the eventType + * @param treeItem the treeItem + * @param selectionChanged the selectioonChanged */ public TreeModificationEvent(EventType eventType, CheckBoxTreeItem treeItem, boolean selectionChanged) { super(eventType); @@ -356,17 +387,19 @@ } /** - * Indicates the the reason for this event is that the selection on the + * Indicates the reason for this event is that the selection on the * CheckBoxTreeItem changed (as opposed to it becoming indeterminate). + * @return has the CheckBoxTreeItem's selection changed */ public boolean wasSelectionChanged() { return selectionChanged; } /** - * Indicates the the reason for this event is that the indeterminate + * Indicates the reason for this event is that the indeterminate * state on the CheckBoxTreeItem changed (as opposed to it becoming * selected or unselected). + * @return has the CheckBoxTreeItem's indeterminate changed */ public boolean wasIndeterminateChanged() { return ! selectionChanged; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/CheckMenuItem.java 2017-03-09 14:44:15.810173523 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/CheckMenuItem.java 2017-03-09 14:44:15.702173521 -0800 @@ -99,6 +99,7 @@ /** * Constructs a CheckMenuItem and sets the display text with the specified text. + * @param text the display text */ public CheckMenuItem(String text) { this(text,null); @@ -107,6 +108,8 @@ /** * Constructs a CheckMenuItem and sets the display text with the specified text * and sets the graphic {@link Node} to the given node. + * @param text the display text + * @param graphic the graphic Node */ public CheckMenuItem(String text, Node graphic) { super(text,graphic); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ChoiceBox.java 2017-03-09 14:44:16.166173529 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ChoiceBox.java 2017-03-09 14:44:16.054173527 -0800 @@ -137,7 +137,7 @@ * Create a new ChoiceBox with the given set of items. Since it is observable, * the content of this list may change over time and the ChoiceBox will * be updated accordingly. - * @param items + * @param items the set of items */ public ChoiceBox(ObservableList items) { getStyleClass().setAll("choice-box"); @@ -308,6 +308,7 @@ * This is useful when using domain objects in a ChoiceBox as this property * allows for customization of the representation. Also, any of the pre-built * Converters available in the {@link javafx.util.converter} package can be set. + * @return the string converter property * @since JavaFX 2.1 */ public ObjectProperty> converterProperty() { return converter; } @@ -321,6 +322,7 @@ * selection model. The valueProperty is synchronized with the selectedItem. * This property allows for bi-directional binding of external properties to the * ChoiceBox and updates the selection model accordingly. + * @return the value property * @since JavaFX 2.1 */ public ObjectProperty valueProperty() { return value; } @@ -347,6 +349,7 @@ * may be due to the value property being programmatically changed or when the * user selects an item in a popup menu. * + * @return the on action property * @since JavaFX 8u60 */ public final ObjectProperty> onActionProperty() { return onAction; } @@ -372,6 +375,7 @@ // --- On Showing /** * Called just prior to the {@code ChoiceBox} popup being shown. + * @return the on showing property * @since JavaFX 8u60 */ public final ObjectProperty> onShowingProperty() { return onShowing; } @@ -395,6 +399,7 @@ // -- On Shown /** * Called just after the {@link ChoiceBox} popup is shown. + * @return the on shown property * @since JavaFX 8u60 */ public final ObjectProperty> onShownProperty() { return onShown; } @@ -418,6 +423,7 @@ // --- On Hiding /** * Called just prior to the {@link ChoiceBox} popup being hidden. + * @return the on hiding property * @since JavaFX 8u60 */ public final ObjectProperty> onHidingProperty() { return onHiding; } @@ -441,6 +447,7 @@ // --- On Hidden /** * Called just after the {@link ChoiceBox} popup has been hidden. + * @return the on hidden property * @since JavaFX 8u60 */ public final ObjectProperty> onHiddenProperty() { return onHidden; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ChoiceDialog.java 2017-03-09 14:44:16.534173536 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ChoiceDialog.java 2017-03-09 14:44:16.430173534 -0800 @@ -166,6 +166,7 @@ /** * Returns the currently selected item in the dialog. + * @return the currently selected item */ public final T getSelectedItem() { return comboBox.getSelectionModel().getSelectedItem(); @@ -173,6 +174,7 @@ /** * Returns the property representing the currently selected item in the dialog. + * @return the currently selected item property */ public final ReadOnlyObjectProperty selectedItemProperty() { return comboBox.getSelectionModel().selectedItemProperty(); @@ -190,6 +192,7 @@ * Returns the list of all items that will be displayed to users. This list * can be modified by the developer to add, remove, or reorder the items * to present to the user. + * @return the list of all items that will be displayed to users */ public final ObservableList getItems() { return comboBox.getItems(); @@ -197,6 +200,7 @@ /** * Returns the default choice that was specified in the constructor. + * @return the default choice */ public final T getDefaultChoice() { return defaultChoice; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ColorPicker.java 2017-03-09 14:44:16.902173542 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ColorPicker.java 2017-03-09 14:44:16.790173540 -0800 @@ -74,7 +74,7 @@ * or *


  * colorPicker.getStyleClass().add("split-button");
- * 
+ * * @since JavaFX 2.2 */ public class ColorPicker extends ComboBoxBase { @@ -95,6 +95,7 @@ private ObservableList customColors = FXCollections.observableArrayList(); /** * Gets the list of custom colors added to the Color Palette by the user. + * @return the list of custom colors */ public final ObservableList getCustomColors() { return customColors; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ComboBox.java 2017-03-09 14:44:17.262173549 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ComboBox.java 2017-03-09 14:44:17.150173547 -0800 @@ -183,6 +183,8 @@ *

Admittedly the above approach is far more verbose, but it offers the * required functionality without encountering the scenegraph constraints. * + * @param The type of the value that has been selected or otherwise entered + * in to this ComboBox * @see ComboBoxBase * @see Cell * @see ListCell @@ -229,6 +231,7 @@ /** * Creates a default ComboBox instance with the provided items list and * a default {@link #selectionModelProperty() selection model}. + * @param items the list of items */ public ComboBox(ObservableList items) { getStyleClass().add(DEFAULT_STYLE_CLASS); @@ -314,6 +317,7 @@ * Converts the user-typed input (when the ComboBox is * {@link #editableProperty() editable}) to an object of type T, such that * the input may be retrieved via the {@link #valueProperty() value} property. + * @return the converter property */ public ObjectProperty> converterProperty() { return converter; } private ObjectProperty> converter = @@ -341,6 +345,7 @@ * area. If a cell is set here, it does not change the rendering of the * ComboBox popup list - that rendering is controlled via the * {@link #cellFactoryProperty() cell factory} API. + * @return the button cell property * @since JavaFX 2.2 */ public ObjectProperty> buttonCellProperty() { return buttonCell; } @@ -413,6 +418,7 @@ * This Node is shown to the user when the ComboBox has no content to show. * The placeholder node is shown in the ComboBox popup area * when the items list is null or empty. + * @return the placeholder property * @since JavaFX 8.0 */ public final ObjectProperty placeholderProperty() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ComboBoxBase.java 2017-03-09 14:44:17.614173555 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ComboBoxBase.java 2017-03-09 14:44:17.510173553 -0800 @@ -143,6 +143,7 @@ * The value of this ComboBox is defined as the selected item if the input * is not editable, or if it is editable, the most recent user action: * either the value input by the user, or the last selected item. + * @return the value property */ public ObjectProperty valueProperty() { return value; } private ObjectProperty value = new SimpleObjectProperty(this, "value"); @@ -159,6 +160,7 @@ * *

Note that when the editable property changes, the value property is * reset, along with any other relevant state. + * @return the editable property */ public BooleanProperty editableProperty() { return editable; } public final void setEditable(boolean value) { editableProperty().set(value); } @@ -241,6 +243,7 @@ * pressed on a Node and has not yet been released. {@code arm} however * also takes into account whether the mouse is actually over the * ComboBox and pressed. + * @return the armed property */ public BooleanProperty armedProperty() { return armed; } private final void setArmed(boolean value) { armedProperty().set(value); } @@ -261,6 +264,7 @@ * {@link #editableProperty() editable} ComboBoxes, it may be when the user * provides their own input (be that via a {@link TextField} or some other * input mechanism. + * @return the on action property */ public final ObjectProperty> onActionProperty() { return onAction; } public final void setOnAction(EventHandler value) { onActionProperty().set(value); } @@ -405,9 +409,9 @@ * Arms the ComboBox. An armed ComboBox will show a popup list on the next * expected UI gesture. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. */ public void arm() { if (! armedProperty().isBound()) { @@ -418,9 +422,9 @@ /** * Disarms the ComboBox. See {@link #arm()}. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. */ public void disarm() { if (! armedProperty().isBound()) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ContextMenu.java 2017-03-09 14:44:17.978173562 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ContextMenu.java 2017-03-09 14:44:17.878173560 -0800 @@ -148,6 +148,7 @@ /** * Create a new ContextMenu initialized with the given items + * @param items the list of menu items */ public ContextMenu(MenuItem... items) { this(); @@ -217,6 +218,7 @@ /** * The menu items on the context menu. If this ObservableList is modified at * runtime, the ContextMenu will update as expected. + * @return the menu items on this context menu * @see MenuItem */ public final ObservableList getItems() { return items; } @@ -238,6 +240,10 @@ *

* This function is useful for finely tuning the position of a menu, * relative to the parent node to ensure close alignment. + * @param anchor the anchor node + * @param side the side + * @param dx the dx value for the x-axis + * @param dy the dy value for the y-axis */ // TODO provide more detail public void show(Node anchor, Side side, double dx, double dy) { @@ -264,7 +270,11 @@ * given its size requirements, the necessary adjustments are made to bring * the {@code ContextMenu} back back on screen. This also means that the * {@code ContextMenu} will not span multiple monitors. + * @param anchor the anchor node + * @param screenX the x position of the anchor in screen coordinates + * @param screenY the y position of the anchor in screen coordinates */ + @Override public void show(Node anchor, double screenX, double screenY) { if (anchor == null) return; if (getItems().size() == 0) return; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Control.java 2017-03-09 14:44:18.334173568 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Control.java 2017-03-09 14:44:18.230173566 -0800 @@ -223,6 +223,7 @@ * {@code Control} via the {@link Skin#getSkinnable()} method. *

* A skin may be null. + * @return the skin property for this control */ @Override public final ObjectProperty> skinProperty() { return skin; } @Override public final void setSkin(Skin value) { @@ -342,6 +343,7 @@ // --- tooltip /** * The ToolTip for this control. + * @return the tool tip for this control */ public final ObjectProperty tooltipProperty() { if (tooltip == null) { @@ -918,6 +920,7 @@ * UI controls are focus traversable, so this method is overridden in Control * to set the initial traversable state to true. * + * @return the initial focus traversable state of this control * @since 9 */ @Override protected Boolean getInitialFocusTraversable() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/DatePicker.java 2017-03-09 14:44:18.706173574 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/DatePicker.java 2017-03-09 14:44:18.586173572 -0800 @@ -231,6 +231,7 @@ * * Setting the value to null will restore the default * chronology. + * @return the calendar system */ public final ObjectProperty chronologyProperty() { return chronology; @@ -263,6 +264,8 @@ * *

The default value is specified in a resource bundle, and * depends on the country of the current locale. + * @return true if popup should display a column showing + * week numbers */ public final BooleanProperty showWeekNumbersProperty() { if (showWeekNumbers == null) { @@ -319,21 +322,21 @@ * datePicker.setPromptText(pattern.toLowerCase()); * } * - * @Override public String toString(LocalDate date) { + * {@literal @Override public String toString(LocalDate date) { * if (date != null) { * return dateFormatter.format(date); * } else { * return ""; * } - * } + * }} * - * @Override public LocalDate fromString(String string) { + * {@literal @Override public LocalDate fromString(String string) { * if (string != null && !string.isEmpty()) { * return LocalDate.parse(string, dateFormatter); * } else { * return null; * } - * } + * }} * }); * *

Example that wraps the default formatter and catches parse exceptions: @@ -361,7 +364,7 @@ * The following example modifies the converter's fromString() method to * allow a two digit year for birth dates up to 99 years in the past. *


-     *   @Override public LocalDate fromString(String text) {
+     *   {@literal @Override public LocalDate fromString(String text) {
      *       if (text != null && !text.isEmpty()) {
      *           Locale locale = Locale.getDefault(Locale.Category.FORMAT);
      *           Chronology chrono = datePicker.getChronology();
@@ -381,9 +384,10 @@
      *       } else {
      *           return null;
      *       }
-     *   }
+     *   }}
      * 
* + * @return the string converter of type LocalDate * @see javafx.scene.control.ComboBox#converterProperty */ public final ObjectProperty> converterProperty() { return converter; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Dialog.java 2017-03-09 14:44:19.054173581 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Dialog.java 2017-03-09 14:44:18.950173579 -0800 @@ -521,6 +521,7 @@ WeakReference dialogPaneRef = new WeakReference<>(null); + @Override protected void invalidated() { DialogPane oldDialogPane = dialogPaneRef.get(); if (oldDialogPane != null) { @@ -574,6 +575,7 @@ * is lower precedence than the {@link DialogPane#contentProperty() content node}, meaning * that if both the content node and the contentText properties are set, the * content text will not be displayed in a default DialogPane instance. + * @return the property representing the content text for the dialog pane */ public final StringProperty contentTextProperty() { return getDialogPane().contentTextProperty(); @@ -581,6 +583,7 @@ /** * Returns the currently-set content text for this DialogPane. + * @return the currently-set content text for this DialogPane */ public final String getContentText() { return getDialogPane().getContentText(); @@ -591,6 +594,7 @@ * is lower precedence than the {@link DialogPane#contentProperty() content node}, meaning * that if both the content node and the contentText properties are set, the * content text will not be displayed in a default DialogPane instance. + * @param contentText the string to show in the dialog content area */ public final void setContentText(String contentText) { getDialogPane().setContentText(contentText); @@ -603,6 +607,7 @@ * is lower precedence than the {@link DialogPane#headerProperty() header node}, meaning * that if both the header node and the headerText properties are set, the * header text will not be displayed in a default DialogPane instance. + * @return a property representing the header text for the dialog pane */ public final StringProperty headerTextProperty() { return getDialogPane().headerTextProperty(); @@ -610,6 +615,7 @@ /** * Returns the currently-set header text for this DialogPane. + * @return the currently-set header text for this DialogPane */ public final String getHeaderText() { return getDialogPane().getHeaderText(); @@ -620,6 +626,7 @@ * is lower precedence than the {@link DialogPane#headerProperty() header node}, meaning * that if both the header node and the headerText properties are set, the * header text will not be displayed in a default DialogPane instance. + * @param headerText the string to show in the dialog header area */ public final void setHeaderText(String headerText) { getDialogPane().setHeaderText(headerText); @@ -666,6 +673,7 @@ * which is intended to convert from the {@link ButtonType} that the user * clicked on into a value of type R. Refer to the {@link Dialog} class * JavaDoc for more details. + * @return a property representing what has been returned from the dialog */ public final ObjectProperty resultProperty() { return resultProperty; @@ -694,6 +702,7 @@ * subclass is ButtonType (which means that the result converter can be null), * but in some cases (where the result type, R, is not ButtonType or Void), * this callback must be specified. + * @return the API to convert the {@link ButtonType} that the user clicked on */ public final ObjectProperty> resultConverterProperty() { return resultConverterProperty; @@ -711,6 +720,7 @@ // --- showing /** * Represents whether the dialog is currently showing. + * @return the property representing whether the dialog is currently showing */ public final ReadOnlyBooleanProperty showingProperty() { return dialog.showingProperty(); @@ -729,6 +739,7 @@ // --- resizable /** * Represents whether the dialog is resizable. + * @return the property representing whether the dialog is resizable */ public final BooleanProperty resizableProperty() { return dialog.resizableProperty(); @@ -758,6 +769,7 @@ // --- width /** * Property representing the width of the dialog. + * @return the property representing the width of the dialog */ public final ReadOnlyDoubleProperty widthProperty() { return dialog.widthProperty(); @@ -765,6 +777,7 @@ /** * Returns the width of the dialog. + * @return the width of the dialog */ public final double getWidth() { return widthProperty().get(); @@ -772,6 +785,7 @@ /** * Sets the width of the dialog. + * @param width the width of the dialog */ public final void setWidth(double width) { dialog.setWidth(width); @@ -781,6 +795,7 @@ // --- height /** * Property representing the height of the dialog. + * @return the property representing the height of the dialog */ public final ReadOnlyDoubleProperty heightProperty() { return dialog.heightProperty(); @@ -788,6 +803,7 @@ /** * Returns the height of the dialog. + * @return the height of the dialog */ public final double getHeight() { return heightProperty().get(); @@ -795,6 +811,7 @@ /** * Sets the height of the dialog. + * @param height the height of the dialog */ public final void setHeight(double height) { dialog.setHeight(height); @@ -804,6 +821,7 @@ // --- title /** * Return the titleProperty of the dialog. + * @return the titleProperty of the dialog */ public final StringProperty titleProperty(){ return this.dialog.titleProperty(); @@ -811,13 +829,14 @@ /** * Return the title of the dialog. + * @return the title of the dialog */ public final String getTitle(){ return this.dialog.titleProperty().get(); } /** * Change the Title of the dialog. - * @param title + * @param title the Title of the dialog */ public final void setTitle(String title){ this.dialog.titleProperty().set(title); @@ -836,6 +855,7 @@ /** * The horizontal location of this {@code Dialog}. Changing this attribute * will move the {@code Dialog} horizontally. + * @return the horizontal location of this {@code Dialog} */ public final ReadOnlyDoubleProperty xProperty() { return dialog.xProperty(); @@ -853,6 +873,7 @@ /** * The vertical location of this {@code Dialog}. Changing this attribute * will move the {@code Dialog} vertically. + * @return the vertical location of this {@code Dialog} */ public final ReadOnlyDoubleProperty yProperty() { return dialog.yProperty(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/DialogEvent.java 2017-03-09 14:44:19.422173587 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/DialogEvent.java 2017-03-09 14:44:19.318173585 -0800 @@ -38,7 +38,7 @@ *
  • {@link Dialog#onShownProperty()} *
  • {@link Dialog#onHidingProperty()} *
  • {@link Dialog#onCloseRequestProperty()} - *
  • {@link Dialog#onHiddenProperty()()} + *
  • {@link Dialog#onHiddenProperty()} * * * @see Dialog --- old/modules/javafx.controls/src/main/java/javafx/scene/control/DialogPane.java 2017-03-09 14:44:19.798173594 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/DialogPane.java 2017-03-09 14:44:19.690173592 -0800 @@ -466,6 +466,7 @@ * area of the DialogPane. It will also result in the DialogPane switching its * layout to the 'header' layout - as outlined in the {@link DialogPane} class * javadoc. + * @return the property representing the header area of the dialog pane */ public final ObjectProperty headerProperty() { return header; @@ -490,6 +491,7 @@ *

    When headerText is set to a non-null value, this will result in the * DialogPane switching its layout to the 'header' layout - as outlined in * the {@link DialogPane} class javadoc.

    + * @param headerText the string to show in the dialog header area */ public final void setHeaderText(String headerText) { this.headerText.set(headerText); @@ -497,6 +499,7 @@ /** * Returns the currently-set header text for this DialogPane. + * @return the currently-set header text for this DialogPane */ public final String getHeaderText() { return headerText.get(); @@ -511,6 +514,7 @@ *

    When headerText is set to a non-null value, this will result in the * DialogPane switching its layout to the 'header' layout - as outlined in * the {@link DialogPane} class javadoc.

    + * @return the property representing the header text for the dialog pane */ public final StringProperty headerTextProperty() { return headerText; @@ -555,6 +559,7 @@ /** * Property representing the content area of the dialog. + * @return the property representing the content area of the dialog */ public final ObjectProperty contentProperty() { return content; @@ -574,6 +579,7 @@ * is lower precedence than the {@link #contentProperty() content node}, meaning * that if both the content node and the contentText properties are set, the * content text will not be displayed in a default DialogPane instance. + * @param contentText the string to show in the dialog content area */ public final void setContentText(String contentText) { this.contentText.set(contentText); @@ -581,6 +587,7 @@ /** * Returns the currently-set content text for this DialogPane. + * @return the currently-set content text for this DialogPane */ public final String getContentText() { return contentText.get(); @@ -591,6 +598,7 @@ * is lower precedence than the {@link #contentProperty() content node}, meaning * that if both the content node and the contentText properties are set, the * content text will not be displayed in a default DialogPane instance. + * @return the property representing the content text for the dialog pane */ public final StringProperty contentTextProperty() { return contentText; @@ -626,6 +634,7 @@ * can be placed in this area, but it will only be shown when the user * clicks the 'Show Details' expandable button. This button will be added * automatically when the expandable content property is non-null. + * @return the property that represents the dialog expandable content area */ public final ObjectProperty expandableContentProperty() { return expandableContentProperty; @@ -634,6 +643,7 @@ /** * Returns the dialog expandable content node, if one is set, or null * otherwise. + * @return the dialog expandable content node */ public final Node getExpandableContent() { return expandableContentProperty.get(); @@ -642,6 +652,7 @@ /** * Sets the dialog expandable content node, or null if no expandable content * needs to be shown. + * @param content the dialog expandable content node */ public final void setExpandableContent(Node content) { this.expandableContentProperty.set(content); @@ -663,6 +674,7 @@ /** * Represents whether the dialogPane is expanded. + * @return the property representing whether the dialogPane is expanded */ public final BooleanProperty expandedProperty() { return expandedProperty; @@ -743,6 +755,7 @@ * *

    The default implementation of this method creates and returns a new * {@link ButtonBar} instance. + * @return the created button bar */ protected Node createButtonBar() { ButtonBar buttonBar = new ButtonBar(); @@ -794,6 +807,7 @@ * {@link #expandedProperty() expanded} property, so that you may update * the button visuals. * + * @return the created details button */ protected Node createDetailsButton() { final Hyperlink detailsButton = new Hyperlink(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/FocusModel.java 2017-03-09 14:44:20.170173600 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/FocusModel.java 2017-03-09 14:44:20.066173598 -0800 @@ -101,6 +101,7 @@ * An example would be that a ListView focus model would likely return * listView.getItems().size(). The valid range of focusable * indices is between 0 and whatever is returned by this method. + * @return the number of items in the data model that underpins the control */ protected abstract int getItemCount(); @@ -134,7 +135,7 @@ * Causes the item at the given index to receive the focus. This does not * cause the current selection to change. Updates the focusedItem and * focusedIndex properties such that focusedIndex = -1 unless - * 0 <= index < model size. + * 0 <= index < model size. * * @param index The index of the item to get focus. */ --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Hyperlink.java 2017-03-09 14:44:20.522173607 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Hyperlink.java 2017-03-09 14:44:20.418173605 -0800 @@ -105,6 +105,7 @@ **************************************************************************/ /** * Indicates whether this link has already been "visited". + * @return true if this link has already been "visited" */ public final BooleanProperty visitedProperty() { if (visited == null) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/IndexRange.java 2017-03-09 14:44:20.886173613 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/IndexRange.java 2017-03-09 14:44:20.766173611 -0800 @@ -71,6 +71,7 @@ /** * Returns the start position of the range. + * @return the start position of the range */ public int getStart() { return start; @@ -78,6 +79,7 @@ /** * Returns the end position of the range (exclusive). + * @return the end position of the range (exclusive) */ public int getEnd() { return end; @@ -85,6 +87,7 @@ /** * Returns the length of the range. + * @return the length of the range */ public int getLength() { return end - start; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/IndexedCell.java 2017-03-09 14:44:21.246173619 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/IndexedCell.java 2017-03-09 14:44:21.134173617 -0800 @@ -84,6 +84,8 @@ /** * Returns the index that this cell represents in the underlying control * data model. + * @return the index that this cell represents in the underlying control + * data model */ public final int getIndex() { return index.get(); } @@ -94,6 +96,7 @@ * property. For example, * in the case of a {@link ListView}, this means the following: * cell.item == listView.getItems().get(cell.getIndex()) + * @return the location of this cell in the virtualized control */ public final ReadOnlyIntegerProperty indexProperty() { return index.getReadOnlyProperty(); } @@ -106,9 +109,10 @@ /** * Updates the index associated with this IndexedCell. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param i the index associated with this indexed cell */ public void updateIndex(int i) { final int oldIndex = index.get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Label.java 2017-03-09 14:44:21.606173626 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Label.java 2017-03-09 14:44:21.498173624 -0800 @@ -109,6 +109,7 @@ * A Label can act as a label for a different Control or * Node. This is used for Mnemonics and Accelerator parsing. * This allows setting of the target Node. + * @return the label for this node */ public ObjectProperty labelForProperty() { if (labelFor == null) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Labeled.java 2017-03-09 14:44:21.974173632 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Labeled.java 2017-03-09 14:44:21.862173630 -0800 @@ -135,6 +135,7 @@ **************************************************************************/ /** * The text to display in the label. The text may be null. + * @return the text to display in the label */ public final StringProperty textProperty() { if (text == null) { @@ -149,6 +150,7 @@ /** * Specifies how the text and graphic within the Labeled should be * aligned when there is empty space within the Labeled. + * @return the alignment within this labeled */ public final ObjectProperty alignmentProperty() { if (alignment == null) { @@ -180,6 +182,7 @@ * Specifies the behavior for lines of text when text is multiline * Unlike {@link #contentDisplayProperty} which affects the graphic and text, this setting * only affects multiple lines of text relative to the text bounds. + * @return the alignment of lines of text within this labeled */ public final ObjectProperty textAlignmentProperty() { if (textAlignment == null) { @@ -210,6 +213,7 @@ /** * Specifies the behavior to use if the text of the {@code Labeled} * exceeds the available space for rendering the text. + * @return the overrun behavior if the text exceeds the available space */ public final ObjectProperty textOverrunProperty() { if (textOverrun == null) { @@ -240,7 +244,7 @@ /** * Specifies the string to display for the ellipsis when text is truncated. * - *

  • Windows:Windows:L_E+U+FBXI_YNOCAH_R
    + *
    Examples
    * * * @@ -250,6 +254,8 @@ * *

    Note that not all fonts support all Unicode characters. * + * @return the ellipsis property on the string to display for the ellipsis + * when text is truncated * @see Wikipedia:ellipsis * @since JavaFX 2.2 */ @@ -279,6 +285,7 @@ /** * If a run of text exceeds the width of the Labeled, then this variable * indicates whether the text should wrap onto another line. + * @return the wrap property if a run of text exceeds the width of the Labeled */ public final BooleanProperty wrapTextProperty() { if (wrapText == null) { @@ -319,6 +326,7 @@ * rich text then this font may or may not be used depending on the font * information embedded in the rich text, but in any case where a default * font is required, this font will be used. + * @return the default font to use for text in this labeled */ public final ObjectProperty fontProperty() { @@ -394,6 +402,7 @@ * variable cannot appear elsewhere in the scene graph, otherwise * the {@code IllegalArgumentException} is thrown. See the class * description of {@link javafx.scene.Node Node} for more detail. + * @return the optional icon for this labeled */ public final ObjectProperty graphicProperty() { if (graphic == null) { @@ -551,6 +560,7 @@ /** * Whether all text should be underlined. + * @return the underline property of all text in this labeled */ public final BooleanProperty underlineProperty() { if (underline == null) { @@ -580,6 +590,7 @@ /** * Specifies the space in pixel between lines. + * @return the line spacing property between lines in this labeled * @since JavaFX 8.0 */ public final DoubleProperty lineSpacingProperty() { @@ -610,6 +621,7 @@ /** * Specifies the positioning of the graphic relative to the text. + * @return content display property of this labeled */ public final ObjectProperty contentDisplayProperty() { if (contentDisplay == null) { @@ -643,6 +655,7 @@ * Subclasses may add nodes outside this padding and inside the Labeled's padding. * * This property can only be set from CSS. + * @return the label padding property of this labeled */ public final ReadOnlyObjectProperty labelPaddingProperty() { return labelPaddingPropertyImpl(); @@ -687,6 +700,7 @@ /** * The amount of space between the graphic and text + * @return the graphics text gap property of this labeled */ public final DoubleProperty graphicTextGapProperty() { if (graphicTextGap == null) { @@ -808,6 +822,7 @@ * by the JavaFX CSS engine to correctly set its initial value. This method * is overridden to use Pos.CENTER_LEFT initially. * + * @return the initial alignment state of this control * @since 9 */ protected Pos getInitialAlignment() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ListCell.java 2017-03-09 14:44:22.354173639 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ListCell.java 2017-03-09 14:44:22.242173637 -0800 @@ -493,9 +493,10 @@ /** * Updates the ListView associated with this Cell. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param listView the ListView associated with this cell */ public final void updateListView(ListView listView) { setListView(listView); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ListView.java 2017-03-09 14:44:22.730173646 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ListView.java 2017-03-09 14:44:22.626173644 -0800 @@ -240,6 +240,8 @@ * An EventType that indicates some edit event has occurred. It is the parent * type of all other edit events: {@link #EDIT_START_EVENT}, * {@link #EDIT_COMMIT_EVENT} and {@link #EDIT_CANCEL_EVENT}. + * @param the type of the objects stored in this ListView + * @return the event type */ @SuppressWarnings("unchecked") public static EventType> editAnyEvent() { @@ -251,6 +253,8 @@ /** * An EventType used to indicate that an edit event has started within the * ListView upon which the event was fired. + * @param the type of the objects stored in this ListView + * @return the event type */ @SuppressWarnings("unchecked") public static EventType> editStartEvent() { @@ -262,6 +266,8 @@ /** * An EventType used to indicate that an edit event has just been canceled * within the ListView upon which the event was fired. + * @param the type of the objects stored in this ListView + * @return the event type */ @SuppressWarnings("unchecked") public static EventType> editCancelEvent() { @@ -273,6 +279,8 @@ /** * An EventType used to indicate that an edit event has been committed * within the ListView upon which the event was fired. + * @param the type of the objects stored in this ListView + * @return the event type */ @SuppressWarnings("unchecked") public static EventType> editCommitEvent() { @@ -326,6 +334,7 @@ * *

    Refer to the {@link ListView} class documentation for details on the * default state of other properties. + * @param items the list of items */ public ListView(ObservableList items) { getStyleClass().setAll(DEFAULT_STYLE_CLASS); @@ -385,6 +394,7 @@ /** * Sets the underlying data model for the ListView. Note that it has a generic * type that must match the type of the ListView itself. + * @param value the list of items for this ListView */ public final void setItems(ObservableList value) { itemsProperty().set(value); @@ -406,6 +416,7 @@ /** * The underlying data model for the ListView. Note that it has a generic * type that must match the type of the ListView itself. + * @return the items property for this ListView */ public final ObjectProperty> itemsProperty() { if (items == null) { @@ -422,6 +433,7 @@ * This may be the case because the table model has no data in the first * place or that a filter has been applied to the list model, resulting * in there being nothing to show the user.. + * @return the placeholder property for this ListView * @since JavaFX 8.0 */ public final ObjectProperty placeholderProperty() { @@ -447,6 +459,7 @@ * to configure it to only allow single selection (see * {@link MultipleSelectionModel#setSelectionMode(javafx.scene.control.SelectionMode)} * for more information). + * @param value the MultipleSelectionModel to be used in this ListView */ public final void setSelectionModel(MultipleSelectionModel value) { selectionModelProperty().set(value); @@ -454,6 +467,7 @@ /** * Returns the currently installed selection model. + * @return the currently installed selection model */ public final MultipleSelectionModel getSelectionModel() { return selectionModel == null ? null : selectionModel.get(); @@ -464,6 +478,7 @@ * to select single or multiple items within a ListView, as well as inspect * which items have been selected by the user. Note that it has a generic * type that must match the type of the ListView itself. + * @return the selectionModel property */ public final ObjectProperty> selectionModelProperty() { return selectionModel; @@ -475,6 +490,7 @@ /** * Sets the {@link FocusModel} to be used in the ListView. + * @param value the FocusModel to be used in the ListView */ public final void setFocusModel(FocusModel value) { focusModelProperty().set(value); @@ -482,6 +498,7 @@ /** * Returns the currently installed {@link FocusModel}. + * @return the currently installed FocusModel */ public final FocusModel getFocusModel() { return focusModel == null ? null : focusModel.get(); @@ -491,6 +508,7 @@ * The FocusModel provides the API through which it is possible * to both get and set the focus on a single item within a ListView. Note * that it has a generic type that must match the type of the ListView itself. + * @return the FocusModel property */ public final ObjectProperty> focusModelProperty() { if (focusModel == null) { @@ -506,6 +524,7 @@ /** * Sets the orientation of the ListView, which dictates whether * it scrolls vertically or horizontally. + * @param value the orientation of the ListView */ public final void setOrientation(Orientation value) { orientationProperty().set(value); @@ -514,6 +533,7 @@ /** * Returns the current orientation of the ListView, which dictates whether * it scrolls vertically or horizontally. + * @return the current orientation of the ListView */ public final Orientation getOrientation() { return orientation == null ? Orientation.VERTICAL : orientation.get(); @@ -522,6 +542,7 @@ /** * The orientation of the {@code ListView} - this can either be horizontal * or vertical. + * @return the orientation property of this ListView */ public final ObjectProperty orientationProperty() { if (orientation == null) { @@ -561,6 +582,7 @@ * Sets a new cell factory to use in the ListView. This forces all old * {@link ListCell}'s to be thrown away, and new ListCell's created with * the new cell factory. + * @param value ell factory to use in this ListView */ public final void setCellFactory(Callback, ListCell> value) { cellFactoryProperty().set(value); @@ -568,6 +590,7 @@ /** * Returns the current cell factory. + * @return the current cell factory */ public final Callback, ListCell> getCellFactory() { return cellFactory == null ? null : cellFactory.get(); @@ -581,6 +604,7 @@ * which might be usable for representing any item in the ListView. * *

    Refer to the {@link Cell} class documentation for more detail. + * @return the cell factory property */ public final ObjectProperty, ListCell>> cellFactoryProperty() { if (cellFactory == null) { @@ -638,6 +662,7 @@ * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are * specified in CSS, -fx-fixed-cell-size takes precedence.

    * + * @return the fixed cell size property * @since JavaFX 8.0 */ public final DoubleProperty fixedCellSizeProperty() { @@ -672,6 +697,7 @@ * Specifies whether this ListView is editable - only if the ListView and * the ListCells within it are both editable will a ListCell be able to go * into their editing state. + * @return the editable property */ public final BooleanProperty editableProperty() { if (editable == null) { @@ -691,6 +717,7 @@ /** * Returns the index of the item currently being edited in the ListView, * or -1 if no item is being edited. + * @return the index of the item currently being edited */ public final int getEditingIndex() { return editingIndex == null ? -1 : editingIndex.get(); @@ -702,6 +729,7 @@ * *

    It is not possible to set the editing index, instead it is required that * you call {@link #edit(int)}. + * @return the editing index property */ public final ReadOnlyIntegerProperty editingIndexProperty() { return editingIndexPropertyImpl().getReadOnlyProperty(); @@ -725,6 +753,8 @@ *

    This is a convenience method - the same result can be * achieved by calling * addEventHandler(ListView.EDIT_START_EVENT, eventHandler). + * @param value the EventHandler that will be called when the user begins + * an edit */ public final void setOnEditStart(EventHandler> value) { onEditStartProperty().set(value); @@ -733,6 +763,7 @@ /** * Returns the {@link EventHandler} that will be called when the user begins * an edit. + * @return the EventHandler that will be called when the user begins an edit */ public final EventHandler> getOnEditStart() { return onEditStart == null ? null : onEditStart.get(); @@ -741,6 +772,7 @@ /** * This event handler will be fired when the user successfully initiates * editing. + * @return the onEditStart event handler property */ public final ObjectProperty>> onEditStartProperty() { if (onEditStart == null) { @@ -775,6 +807,8 @@ *

    This is a convenience method - the same result can be * achieved by calling * addEventHandler(ListView.EDIT_START_EVENT, eventHandler). + * @param value the EventHandler that will be called when the user has + * completed their editing */ public final void setOnEditCommit(EventHandler> value) { onEditCommitProperty().set(value); @@ -783,6 +817,7 @@ /** * Returns the {@link EventHandler} that will be called when the user commits * an edit. + * @return the EventHandler that will be called when the user commits an edit */ public final EventHandler> getOnEditCommit() { return onEditCommit == null ? null : onEditCommit.get(); @@ -796,6 +831,7 @@ * instead call {@link ListCell#commitEdit(java.lang.Object)} from within * your custom ListCell. This will handle firing this event, updating the * view, and switching out of the editing state.

    + * @return the onEditCommit event handler property */ public final ObjectProperty>> onEditCommitProperty() { if (onEditCommit == null) { @@ -825,6 +861,8 @@ /** * Sets the {@link EventHandler} that will be called when the user cancels * an edit. + * @param value the EventHandler that will be called when the user cancels + * an edit */ public final void setOnEditCancel(EventHandler> value) { onEditCancelProperty().set(value); @@ -833,6 +871,7 @@ /** * Returns the {@link EventHandler} that will be called when the user cancels * an edit. + * @return the EventHandler that will be called when the user cancels an edit */ public final EventHandler> getOnEditCancel() { return onEditCancel == null ? null : onEditCancel.get(); @@ -840,6 +879,7 @@ /** * This event handler will be fired when the user cancels editing a cell. + * @return the onEditCancel event handler property */ public final ObjectProperty>> onEditCancelProperty() { if (onEditCancel == null) { @@ -1121,6 +1161,10 @@ * Creates a new EditEvent instance to represent an edit event. This * event is used for {@link #EDIT_START_EVENT}, * {@link #EDIT_COMMIT_EVENT} and {@link #EDIT_CANCEL_EVENT} types. + * @param source the source + * @param eventType the event type + * @param newValue the new value + * @param editIndex the edit index */ public EditEvent(ListView source, EventType> eventType, @@ -1141,6 +1185,7 @@ /** * Returns the index in which the edit took place. + * @return the index in which the edit took place */ public int getIndex() { return editIndex; @@ -1148,6 +1193,7 @@ /** * Returns the value of the new input provided by the end user. + * @return the value of the new input provided by the end user */ public T getNewValue() { return newValue; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Menu.java 2017-03-09 14:44:23.122173653 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Menu.java 2017-03-09 14:44:23.006173651 -0800 @@ -255,6 +255,7 @@ * Called just prior to the {@code ContextMenu} being shown, even if the menu has * no items to show. Note however that this won't be called if the menu does * not have a valid anchor node. + * @return the on showing property */ public final ObjectProperty> onShowingProperty() { return onShowing; } public final void setOnShowing(EventHandler value) { onShowingProperty().set(value); } @@ -279,6 +280,7 @@ // -- On Shown /** * Called just after the {@link ContextMenu} is shown. + * @return the on shown property */ public final ObjectProperty> onShownProperty() { return onShown; } public final void setOnShown(EventHandler value) { onShownProperty().set(value); } @@ -303,6 +305,7 @@ // --- On Hiding /** * Called just prior to the {@link ContextMenu} being hidden. + * @return the on hiding property */ public final ObjectProperty> onHidingProperty() { return onHiding; } public final void setOnHiding(EventHandler value) { onHidingProperty().set(value); } @@ -327,6 +330,7 @@ // --- On Hidden /** * Called just after the {@link ContextMenu} has been hidden. + * @return the on hidden property */ public final ObjectProperty> onHiddenProperty() { return onHidden; } public final void setOnHidden(EventHandler value) { onHiddenProperty().set(value); } @@ -394,6 +398,7 @@ /** * The items to show within this menu. If this ObservableList is modified at * runtime, the Menu will update as expected. + * @return the list of items */ public final ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/MenuBar.java 2017-03-09 14:44:23.490173659 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/MenuBar.java 2017-03-09 14:44:23.366173657 -0800 @@ -139,6 +139,7 @@ * will throw a RuntimeException. Please use * bi-directional binding to this property instead. * + * @return the use system menu bar property * @since JavaFX 2.1 */ public final BooleanProperty useSystemMenuBarProperty() { @@ -190,6 +191,7 @@ /** * The menus to show within this MenuBar. If this ObservableList is modified at * runtime, the MenuBar will update as expected. + * @return the list of menus to show within this MenuBar * @see Menu */ public final ObservableList getMenus() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/MenuButton.java 2017-03-09 14:44:23.850173665 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/MenuButton.java 2017-03-09 14:44:23.742173664 -0800 @@ -196,6 +196,7 @@ * and of course {@code Menu}, which if added to a menu, will become a sub * menu. {@link SeparatorMenuItem} is another commonly used Node in the Menu's items * ObservableList. + * @return the list of menu items within this buttons menu */ public final ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/MenuItem.java 2017-03-09 14:44:24.198173672 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/MenuItem.java 2017-03-09 14:44:24.094173670 -0800 @@ -117,6 +117,7 @@ /** * Constructs a MenuItem and sets the display text with the specified text + * @param text the display text * @see #setText */ public MenuItem(String text) { @@ -126,6 +127,8 @@ /** * Constructor s MenuItem and sets the display text with the specified text * and sets the graphic {@link Node} to the given node. + * @param text the display text + * @param graphic the graphic node * @see #setText * @see #setGraphic */ @@ -581,6 +584,7 @@ * {@inheritDoc} * @since JavaFX 8.0 */ + @Override public final ObservableSet getPseudoClassStates() { return FXCollections.emptyObservableSet(); } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/MultipleSelectionModel.java 2017-03-09 14:44:24.558173678 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/MultipleSelectionModel.java 2017-03-09 14:44:24.446173676 -0800 @@ -118,6 +118,7 @@ * ObservableList will be updated by the selection model to always reflect * changes in selection. This can be observed by adding a * {@link ListChangeListener} to the returned ObservableList. + * @return the list of selected indices */ public abstract ObservableList getSelectedIndices(); @@ -126,6 +127,7 @@ * ObservableList will be updated further by the selection model to always reflect * changes in selection. This can be observed by adding a * {@link ListChangeListener} to the returned ObservableList. + * @return the list of selected items */ public abstract ObservableList getSelectedItems(); @@ -141,6 +143,8 @@ * *

    The last valid value given will become the selected index / selected * item. + * @param index the selected index + * @param indices the selected indices */ public abstract void selectIndices(int index, int... indices); @@ -148,7 +152,7 @@ *

    Selects all indices from the given start index to the item before the * given end index. This means that the selection is inclusive of the start * index, and exclusive of the end index. This method will work regardless - * of whether start < end or start > end: the only constant is that the + * of whether start < end or start > end: the only constant is that the * index before the given end index will become the selected index. * *

    If there is already one or more indices selected in this model, calling --- old/modules/javafx.controls/src/main/java/javafx/scene/control/MultipleSelectionModelBase.java 2017-03-09 14:44:24.914173684 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/MultipleSelectionModelBase.java 2017-03-09 14:44:24.806173682 -0800 @@ -140,6 +140,7 @@ * An example would be that a ListView selection model would likely return * listView.getItems().size(). The valid range of selectable * indices is between 0 and whatever is returned by this method. + * @return the number of items in the data model that underpins the control */ protected abstract int getItemCount(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java 2017-03-09 14:44:25.274173691 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Pagination.java 2017-03-09 14:44:25.162173689 -0800 @@ -167,6 +167,7 @@ /** * Returns the maximum number of page indicators. + * @return the maximum number of page indicators */ public final int getMaxPageIndicatorCount() { return maxPageIndicatorCount == null ? DEFAULT_MAX_PAGE_INDICATOR_COUNT : maxPageIndicatorCount.get(); @@ -179,6 +180,7 @@ * reduced to fit the control if the {@code maxPageIndicatorCount} cannot fit. * * The default is 10 page indicators. + * @return the maximum number of page indicators to use for this pagination control */ public final IntegerProperty maxPageIndicatorCountProperty() { if (maxPageIndicatorCount == null) { @@ -233,6 +235,7 @@ /** * Returns the number of pages. + * @return the number of pages */ public final int getPageCount() { return pageCount.get(); } @@ -242,6 +245,7 @@ * should be used as the page count if the total number of pages is unknown. * * The default is an {@link #INDETERMINATE} number of pages. + * @return the number of pages for this pagination control */ public final IntegerProperty pageCountProperty() { return pageCount; } @@ -270,6 +274,7 @@ /** * Returns the current page index. + * @return the current page index */ public final int getCurrentPageIndex() { return currentPageIndex.get(); } @@ -285,6 +290,7 @@ * The {@link javafx.beans.property.IntegerProperty#bind(javafx.beans.value.ObservableValue) bind} method * throws an UnsupportedOperationException. *

    + * @return the current page index property */ public final IntegerProperty currentPageIndexProperty() { return currentPageIndex; } @@ -293,11 +299,13 @@ /** * Sets the page factory callback function. + * @param value the page factory callback function */ public final void setPageFactory(Callback value) { pageFactory.set(value); } /** * Returns the page factory callback function. + * @return the page factory callback function */ public final Callback getPageFactory() {return pageFactory.get(); } @@ -311,6 +319,7 @@ * will not change when null is returned. * * The default is null if there is no page factory set. + * @return the page factory property */ public final ObjectProperty> pageFactoryProperty() { return pageFactory; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java 2017-03-09 14:44:25.638173697 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java 2017-03-09 14:44:25.522173695 -0800 @@ -131,6 +131,7 @@ * This is analogous to the "id" attribute on an HTML element * (CSS ID Specification). * + * @return the id property * @defaultValue null */ public final StringProperty idProperty() { return bridge.idProperty(); } @@ -401,6 +402,7 @@ * Setting this value to the USE_PREF_SIZE flag will cause * getMinWidth(forHeight) to return the control's preferred width, * enabling applications to easily restrict the resizability of the control. + * @param value the minimum width */ public final void setMinWidth(double value) { minWidthProperty().set(value); } @@ -416,6 +418,7 @@ * Setting this value to the USE_PREF_SIZE flag will cause * getMinWidth(forHeight) to return the control's preferred width, * enabling applications to easily restrict the resizability of the control. + * @return the minimum width */ public final double getMinWidth() { return minWidth == null ? USE_COMPUTED_SIZE : minWidth.get(); } public final DoubleProperty minWidthProperty() { @@ -469,6 +472,7 @@ * getMinHeight(forWidth) to return the control's preferred height, * enabling applications to easily restrict the resizability of the control. * + * @param value the minimum height */ public final void setMinHeight(double value) { minHeightProperty().set(value); } @@ -485,6 +489,7 @@ * getMinHeight(forWidth) to return the control's preferred height, * enabling applications to easily restrict the resizability of the control. * + * @return the minimum height */ public final double getMinHeight() { return minHeight == null ? USE_COMPUTED_SIZE : minHeight.get(); } public final DoubleProperty minHeightProperty() { @@ -542,6 +547,7 @@ * Defaults to the USE_COMPUTED_SIZE flag, which means that * getPrefWidth(forHeight) will return the control's internally * computed preferred width. + * @param value the preferred width */ public final void setPrefWidth(double value) { prefWidthProperty().set(value); } @@ -553,6 +559,7 @@ * Defaults to the USE_COMPUTED_SIZE flag, which means that * getPrefWidth(forHeight) will return the control's internally * computed preferred width. + * @return the preferred width */ public final double getPrefWidth() { return prefWidth == null ? USE_COMPUTED_SIZE : prefWidth.get(); } public final DoubleProperty prefWidthProperty() { @@ -597,6 +604,7 @@ * getPrefHeight(forWidth) will return the control's internally * computed preferred width. * + * @param value the preferred height */ public final void setPrefHeight(double value) { prefHeightProperty().set(value); } @@ -609,6 +617,7 @@ * getPrefHeight(forWidth) will return the control's internally * computed preferred width. * + * @return the preferred height */ public final double getPrefHeight() { return prefHeight == null ? USE_COMPUTED_SIZE : prefHeight.get(); } public final DoubleProperty prefHeightProperty() { @@ -674,6 +683,7 @@ * Setting this value to the USE_PREF_SIZE flag will cause * getMaxWidth(forHeight) to return the control's preferred width, * enabling applications to easily restrict the resizability of the control. + * @param value the maximum width */ public final void setMaxWidth(double value) { maxWidthProperty().set(value); } @@ -689,6 +699,7 @@ * Setting this value to the USE_PREF_SIZE flag will cause * getMaxWidth(forHeight) to return the control's preferred width, * enabling applications to easily restrict the resizability of the control. + * @return the maximum width */ public final double getMaxWidth() { return maxWidth == null ? USE_COMPUTED_SIZE : maxWidth.get(); } public final DoubleProperty maxWidthProperty() { @@ -741,6 +752,7 @@ * getMaxHeight(forWidth) to return the control's preferred height, * enabling applications to easily restrict the resizability of the control. * + * @param value the maximum height */ public final void setMaxHeight(double value) { maxHeightProperty().set(value); } @@ -757,6 +769,7 @@ * getMaxHeight(forWidth) to return the control's preferred height, * enabling applications to easily restrict the resizability of the control. * + * @return the maximum height */ public final double getMaxHeight() { return maxHeight == null ? USE_COMPUTED_SIZE : maxHeight.get(); } public final DoubleProperty maxHeightProperty() { @@ -1034,6 +1047,8 @@ } /** + * @param pseudoClass the pseudo class + * @param active the active state * @see Node#pseudoClassStateChanged(javafx.css.PseudoClass, boolean) * @since JavaFX 8.0 */ @@ -1054,13 +1069,15 @@ /** * {@inheritDoc} * - * A PopupControl's styles are based on the popup "owner" which is the + * {@literal A PopupControl's styles are based on the popup "owner" which is the} * {@link javafx.stage.PopupWindow#getOwnerNode() ownerNode} or, - * if the ownerNode is not set, the root of the {@link javafx.stage.PopupWindow#getOwnerWindow() ownerWindow's} + * if the ownerNode is not set, the root of the + * {@link javafx.stage.PopupWindow#getOwnerWindow() ownerWindow's} * scene. If the popup has not been shown, both ownerNode and ownerWindow will be null and {@code null} will be returned. * - * Note that the PopupWindow's scene root is not returned because there is no way to guarantee that the - * PopupWindow's scene root would properly return the ownerNode or ownerWindow. + * {@literal Note that the PopupWindow's scene root is not returned because + * there is no way to guarantee that the PopupWindow's scene root would + * properly return the ownerNode or ownerWindow.} * * @return {@link javafx.stage.PopupWindow#getOwnerNode()}, {@link javafx.stage.PopupWindow#getOwnerWindow()}, * or null. @@ -1093,6 +1110,7 @@ * {@inheritDoc} * @since JavaFX 8.0 */ + @Override public final ObservableSet getPseudoClassStates() { return FXCollections.emptyObservableSet(); } @@ -1120,7 +1138,7 @@ * Requests a layout pass to be performed before the next scene is * rendered. This is batched up asynchronously to happen once per * "pulse", or frame of animation. - *

    + *

    * If this parent is either a layout root or unmanaged, then it will be * added directly to the scene's dirty layout list, otherwise requestLayout * will be invoked on its parent. @@ -1138,6 +1156,7 @@ /** * This method should be treated as final and should not be overridden by any subclasses of CSSBridge. + * @return the styleable parent */ @Override public Styleable getStyleableParent() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ProgressBar.java 2017-03-09 14:44:26.010173704 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ProgressBar.java 2017-03-09 14:44:25.902173702 -0800 @@ -75,6 +75,7 @@ /** * Creates a new ProgressBar with the given progress value. + * @param progress the progress */ public ProgressBar(double progress) { // focusTraversable is styleable through css. Calling setFocusTraversable --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ProgressIndicator.java 2017-03-09 14:44:26.374173710 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ProgressIndicator.java 2017-03-09 14:44:26.262173708 -0800 @@ -90,6 +90,7 @@ /** * Creates a new ProgressIndicator with the given progress value. + * @param progress the progress */ public ProgressIndicator(double progress) { // focusTraversable is styleable through css. Calling setFocusTraversable --- old/modules/javafx.controls/src/main/java/javafx/scene/control/RadioMenuItem.java 2017-03-09 14:44:26.766173717 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/RadioMenuItem.java 2017-03-09 14:44:26.630173715 -0800 @@ -87,7 +87,6 @@ * selected at any one time, and should * the selection change, the ToggleGroup will take care of deselecting the * previous item. - * * @see MenuItem * @see Menu @@ -110,6 +109,7 @@ /** * Constructs a RadioMenuItem and sets the display text with the specified text. + * @param text the display text */ public RadioMenuItem(String text) { this(text,null); @@ -118,6 +118,8 @@ /** * Constructs a RadioMenuItem and sets the display text with the specified text * and sets the graphic {@link Node} to the given node. + * @param text the display text + * @param graphic the graphic node */ public RadioMenuItem(String text, Node graphic) { super(text,graphic); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ResizeFeaturesBase.java 2017-03-09 14:44:27.118173723 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ResizeFeaturesBase.java 2017-03-09 14:44:27.002173721 -0800 @@ -56,12 +56,15 @@ * Returns the column upon which the resize is occurring, or null * if this ResizeFeatures instance was created as a result of a * resize operation. + * @return the column upon which the resize is occurring */ public TableColumnBase getColumn() { return column; } /** * Returns the amount of horizontal space added or removed in the * resize operation. + * @return the amount of horizontal space added or removed in the + * resize operation */ public Double getDelta() { return delta; } } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ScrollBar.java 2017-03-09 14:44:27.470173730 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ScrollBar.java 2017-03-09 14:44:27.362173728 -0800 @@ -312,9 +312,10 @@ * position of .5 would indicate that we * should decrement {@link #valueProperty() value} by {@link #blockIncrementProperty blockIncrement}. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. + * @param position the position */ public void adjustValue(double position) { // figure out the "value" associated with the specified position --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ScrollToEvent.java 2017-03-09 14:44:27.850173736 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ScrollToEvent.java 2017-03-09 14:44:27.734173734 -0800 @@ -54,6 +54,7 @@ /** * This event occurs if the user requests scrolling a given index into view. + * @return the scroll to event type */ public static EventType> scrollToTopIndex() { return SCROLL_TO_TOP_INDEX; @@ -65,6 +66,8 @@ /** * This event occurs if the user requests scrolling a {@link TableColumnBase} * (i.e. {@link TableColumn} or {@link TreeTableColumn}) into view. + * @param the type + * @return the scroll to event type */ @SuppressWarnings("unchecked") public static > EventType> scrollToColumn() { @@ -85,7 +88,7 @@ * @param source the event source which sent the event * @param target the event source which sent the event * @param type the event type - * @param target the target of the scroll to operation + * @param scrollTarget the target of the scroll to operation */ public ScrollToEvent(@NamedArg("source") Object source, @NamedArg("target") EventTarget target, @NamedArg("type") EventType> type, @NamedArg("scrollTarget") T scrollTarget) { super(source, target, type); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/SelectionModel.java 2017-03-09 14:44:28.202173742 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/SelectionModel.java 2017-03-09 14:44:28.098173741 -0800 @@ -62,6 +62,7 @@ * a {@link ListChangeListener} to the collection returned by * {@link MultipleSelectionModel#getSelectedIndices()} to be informed whenever * the selection changes, and this will also work in the case of single selection. + * @return the selected index property */ public final ReadOnlyIntegerProperty selectedIndexProperty() { return selectedIndex.getReadOnlyProperty(); } private ReadOnlyIntegerWrapper selectedIndex = new ReadOnlyIntegerWrapper(this, "selectedIndex", -1); @@ -81,6 +82,7 @@ * InvalidationListener listener = ...; * sm.selectedIndexProperty().addListener(listener); * + * @return the selected index */ public final int getSelectedIndex() { return selectedIndexProperty().get(); } @@ -96,6 +98,7 @@ * model is set to be single selection, but is equally applicable when in * multiple selection mode. When in this mode, the selected item will always * represent the last selection made. + * @return the selected item property */ public final ReadOnlyObjectProperty selectedItemProperty() { return selectedItem.getReadOnlyProperty(); } private ReadOnlyObjectWrapper selectedItem = new ReadOnlyObjectWrapper(this, "selectedItem"); @@ -116,6 +119,7 @@ * InvalidationListener listener = ...; * sm.selectedItemProperty().addListener(listener); * + * @return the selected item */ public final T getSelectedItem() { return selectedItemProperty().get(); } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/SeparatorMenuItem.java 2017-03-09 14:44:28.554173749 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/SeparatorMenuItem.java 2017-03-09 14:44:28.446173747 -0800 @@ -38,8 +38,7 @@ * This is provided for convenience as groups of {@link MenuItem menuitems} can be separated * by a separator. Instead of a creating a {@link CustomMenuItem} for this purpose, the user * can use this class as indicated below. - *

    - *

    + *

    
     SeparatorMenuItem separatorMenuItem = new SeparatorMenuItem();
     
    --- old/modules/javafx.controls/src/main/java/javafx/scene/control/SingleSelectionModel.java 2017-03-09 14:44:28.910173755 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/SingleSelectionModel.java 2017-03-09 14:44:28.802173753 -0800 @@ -84,7 +84,7 @@ /** *

    This method will return true if the given index is the currently - * selected index in this SingleSelectionModel.. + * selected index in this SingleSelectionModel. * * @param index The index to check as to whether it is currently selected * or not. --- old/modules/javafx.controls/src/main/java/javafx/scene/control/SkinBase.java 2017-03-09 14:44:29.266173761 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/SkinBase.java 2017-03-09 14:44:29.162173759 -0800 @@ -168,6 +168,7 @@ /** * Returns the children of the skin. + * @return the children of the skin */ public final ObservableList getChildren() { return children; @@ -175,6 +176,10 @@ /** * Called during the layout pass of the scenegraph. + * @param contentX the x position + * @param contentY the y position + * @param contentWidth the width + * @param contentHeight the height */ protected void layoutChildren(final double contentX, final double contentY, final double contentWidth, final double contentHeight) { @@ -189,6 +194,7 @@ /** * Determines whether all mouse events should be automatically consumed. + * @param value the consume mouse events flag */ protected final void consumeMouseEvents(boolean value) { if (value) { @@ -203,6 +209,8 @@ * Subclasses can invoke this method to register that they want to listen to * property change events for the given property. Registered {@link Consumer} instances * will be executed in the order in which they are registered. + * @param property the property + * @param consumer the consumer */ protected final void registerChangeListener(ObservableValue property, Consumer> consumer) { if (lambdaChangeListenerHandler == null) { @@ -888,6 +896,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return SkinBase.StyleableProperties.STYLEABLES; @@ -908,7 +918,7 @@ * pseudo-class is used in a CSS selector that matches this Node, CSS will * be reapplied. Typically, this method is called from the {@code invalidated} * method of a property that is used as a pseudo-class. For example: - *

    +     * 
    
          *
          *     private static final PseudoClass MY_PSEUDO_CLASS_STATE = PseudoClass.getPseudoClass("my-state");
          *
    @@ -926,7 +936,7 @@
          *               return "myPseudoClassState";
          *           }
          *       };
    -     * 
    + *
    * * @see Node#pseudoClassStateChanged * @param pseudoClass the pseudo-class that has changed state --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Skinnable.java 2017-03-09 14:44:29.642173768 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Skinnable.java 2017-03-09 14:44:29.526173766 -0800 @@ -46,16 +46,19 @@ *

    * A skin may be null. * + * @return the skin property for this control */ public ObjectProperty> skinProperty(); /** * Sets the skin that will render this {@link Control} + * @param value the skin value for this control */ public void setSkin(Skin value); /** * Returns the skin that renders this {@link Control} + * @return the skin for this control */ public Skin getSkin(); } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Slider.java 2017-03-09 14:44:30.002173774 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Slider.java 2017-03-09 14:44:29.898173773 -0800 @@ -572,9 +572,10 @@ * is the main difference between adjustValue and setValue. It also ensures * that the value is some valid number between min and max. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. + * @param newValue the new adjusted value */ public void adjustValue(double newValue) { // figure out the "value" associated with the specified position @@ -618,9 +619,9 @@ * either aligned with a tick, or simply clamp between min & max value, * depending on whether snapToTicks is set. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. */ private double snapValueToTicks(double val) { double v = val; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Spinner.java 2017-03-09 14:44:30.366173781 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Spinner.java 2017-03-09 14:44:30.262173779 -0800 @@ -67,16 +67,12 @@ * {@link #valueFactoryProperty() value factory property}. SpinnerValueFactory * classes for some common types are provided with JavaFX, including: * - *
    - * *

      *
    • {@link SpinnerValueFactory.IntegerSpinnerValueFactory}
    • *
    • {@link SpinnerValueFactory.DoubleSpinnerValueFactory}
    • *
    • {@link SpinnerValueFactory.ListSpinnerValueFactory}
    • *
    * - *
    - * *

    A Spinner has a TextField child component that is responsible for displaying * and potentially changing the current {@link #valueProperty() value} of the * Spinner, which is called the {@link #editorProperty() editor}. By default the @@ -573,6 +569,7 @@ // --- editor /** * The editor used by the Spinner control. + * @return the editor property */ public final ReadOnlyObjectProperty editorProperty() { if (editor == null) { @@ -594,6 +591,7 @@ /** * The prompt text to display in the {@code Spinner}, or * {@code null} if no prompt text is displayed. + * @return the prompt text property * @since 9 */ public final StringProperty promptTextProperty() { return getEditor().promptTextProperty(); } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/SpinnerValueFactory.java 2017-03-09 14:44:30.734173787 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/SpinnerValueFactory.java 2017-03-09 14:44:30.626173785 -0800 @@ -73,8 +73,6 @@ * *

    SpinnerValueFactory classes for some common types are provided with JavaFX, including: * - *
    - * *

      *
    • {@link SpinnerValueFactory.IntegerSpinnerValueFactory}
    • *
    • {@link SpinnerValueFactory.DoubleSpinnerValueFactory}
    • @@ -297,6 +295,7 @@ /** * Sets the underlying data model for the ListSpinnerValueFactory. Note that it has a generic * type that must match the type of the Spinner itself. + * @param value the list of items */ public final void setItems(ObservableList value) { itemsProperty().set(value); @@ -318,6 +317,7 @@ /** * The underlying data model for the ListView. Note that it has a generic * type that must match the type of the ListView itself. + * @return the list of items */ public final ObjectProperty> itemsProperty() { if (items == null) { @@ -509,6 +509,7 @@ } /** * Sets the minimum allowable value for this value factory + * @return the minimum allowable value for this value factory */ public final IntegerProperty minProperty() { return min; @@ -542,6 +543,7 @@ } /** * Sets the maximum allowable value for this value factory + * @return the maximum allowable value for this value factory */ public final IntegerProperty maxProperty() { return max; @@ -557,6 +559,7 @@ } /** * Sets the amount to increment or decrement by, per step. + * @return the amount to increment or decrement by, per step */ public final IntegerProperty amountToStepByProperty() { return amountToStepBy; @@ -769,6 +772,7 @@ } /** * Sets the minimum allowable value for this value factory + * @return the minimum allowable value for this value factory */ public final DoubleProperty minProperty() { return min; @@ -802,6 +806,7 @@ } /** * Sets the maximum allowable value for this value factory + * @return the maximum allowable value for this value factory */ public final DoubleProperty maxProperty() { return max; @@ -817,6 +822,7 @@ } /** * Sets the amount to increment or decrement by, per step. + * @return the amount to increment or decrement by, per step */ public final DoubleProperty amountToStepByProperty() { return amountToStepBy; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/SplitMenuButton.java 2017-03-09 14:44:31.094173794 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/SplitMenuButton.java 2017-03-09 14:44:30.994173792 -0800 @@ -49,6 +49,7 @@ * *

      Example:

      *
      + * {@literal
        * SplitMenuButton m = new SplitMenuButton();
        * m.setText("Shutdown");
        * m.getItems().addAll(new MenuItem("Logout"), new MenuItem("Sleep"));
      @@ -57,8 +58,8 @@
        *         System.out.println("Shutdown");
        *     }
        * });
      + * }
        * 
      - *

      * *

      * MnemonicParsing is enabled by default for SplitMenuButton. --- old/modules/javafx.controls/src/main/java/javafx/scene/control/SplitPane.java 2017-03-09 14:44:31.458173800 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/SplitPane.java 2017-03-09 14:44:31.346173798 -0800 @@ -253,6 +253,7 @@ * {@link javafx.geometry.Orientation#VERTICAL} will result in the nodes being * stacked vertically.

      * + * @param value the orientation value */ public final void setOrientation(Orientation value) { orientationProperty().set(value); @@ -268,6 +269,7 @@ /** * The orientation for the SplitPane. + * @return the orientation property for the SplitPane */ public final ObjectProperty orientationProperty() { if (orientation == null) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Tab.java 2017-03-09 14:44:31.814173806 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Tab.java 2017-03-09 14:44:31.710173805 -0800 @@ -125,6 +125,7 @@ /** * Sets the id of this tab. This simple string identifier is useful for * finding a specific Tab within the {@code TabPane}. The default value is {@code null}. + * @param value the id of this tab */ public final void setId(String value) { idProperty().set(value); } @@ -138,6 +139,7 @@ /** * The id of this tab. + * @return the id property of this tab */ public final StringProperty idProperty() { if (id == null) { @@ -158,6 +160,7 @@ * Parsing this style might not be supported on some limited * platforms. It is recommended to use a standalone CSS file instead. * + * @param value the style string */ public final void setStyle(String value) { styleProperty().set(value); } @@ -171,6 +174,7 @@ /** * The CSS style string associated to this tab. + * @return the CSS style string property associated to this tab */ public final StringProperty styleProperty() { if (style == null) { @@ -189,6 +193,7 @@ *

      Represents whether this tab is the currently selected tab, * To change the selected Tab use {@code tabPane.getSelectionModel().select()} *

      + * @return true if selected */ public final boolean isSelected() { return selected == null ? false : selected.get(); @@ -196,6 +201,7 @@ /** * The currently selected tab. + * @return the selected tab */ public final ReadOnlyBooleanProperty selectedProperty() { return selectedPropertyImpl().getReadOnlyProperty(); @@ -232,6 +238,7 @@ /** *

      A reference to the TabPane that contains this tab instance.

      + * @return the TabPane */ public final TabPane getTabPane() { return tabPane == null ? null : tabPane.get(); @@ -239,6 +246,7 @@ /** * The TabPane that contains this tab. + * @return the TabPane property */ public final ReadOnlyObjectProperty tabPaneProperty() { return tabPanePropertyImpl().getReadOnlyProperty(); @@ -276,6 +284,7 @@ *

      Sets the text to show in the tab to allow the user to differentiate between * the function of each tab. The text is always visible *

      + * @param value the text string */ public final void setText(String value) { textProperty().set(value); @@ -292,6 +301,7 @@ /** * The text shown in the tab. + * @return the text property */ public final StringProperty textProperty() { if (text == null) { @@ -307,6 +317,7 @@ * between the function of each tab. By default the graphic does not rotate * based on the TabPane.tabPosition value, but it can be set to rotate by * setting TabPane.rotateGraphic to true.

      + * @param value the graphic node */ public final void setGraphic(Node value) { graphicProperty().set(value); @@ -339,6 +350,7 @@ *

      The content to show within the main TabPane area. The content * can be any Node such as UI controls or groups of nodes added * to a layout container.

      + * @param value the content node */ public final void setContent(Node value) { contentProperty().set(value); @@ -355,6 +367,7 @@ /** *

      The content associated with the tab.

      + * @return the content property */ public final ObjectProperty contentProperty() { if (content == null) { @@ -369,6 +382,7 @@ /** *

      Specifies the context menu to show when the user right-clicks on the tab. *

      + * @param value the context menu */ public final void setContextMenu(ContextMenu value) { contextMenuProperty().set(value); @@ -384,6 +398,7 @@ /** * The context menu associated with the tab. + * @return the context menu property */ public final ObjectProperty contextMenuProperty() { if (contextMenu == null) { @@ -421,6 +436,7 @@ * property is {@code false}, no 'close' button will be shown on the tab. * The default is {@code true}.

      * + * @param value the closable value */ public final void setClosable(boolean value) { closableProperty().set(value); @@ -437,6 +453,7 @@ /** * The closable state for this tab. + * @return the closable property */ public final BooleanProperty closableProperty() { if (closable == null) { @@ -455,6 +472,7 @@ /** * Defines a function to be called when a selection changed has occurred on the tab. + * @param value the on selection changed event handler */ public final void setOnSelectionChanged(EventHandler value) { onSelectionChangedProperty().set(value); @@ -471,6 +489,7 @@ /** * The event handler that is associated with a selection on the tab. + * @return the on selection changed event handler property */ public final ObjectProperty> onSelectionChangedProperty() { if (onSelectionChanged == null) { @@ -501,6 +520,7 @@ /** * Defines a function to be called when the tab is closed. + * @param value the on closed event handler */ public final void setOnClosed(EventHandler value) { onClosedProperty().set(value); @@ -517,6 +537,7 @@ /** * The event handler that is associated with the tab when the tab is closed. + * @return the on closed event handler property */ public final ObjectProperty> onClosedProperty() { if (onClosed == null) { @@ -543,6 +564,7 @@ /** *

      Specifies the tooltip to show when the user hovers over the tab.

      + * @param value the tool tip value */ public final void setTooltip(Tooltip value) { tooltipProperty().setValue(value); } @@ -554,6 +576,7 @@ /** * The tooltip associated with this tab. + * @return the tool tip property */ public final ObjectProperty tooltipProperty() { if (tooltip == null) { @@ -580,6 +603,7 @@ /** * Returns {@code true} if this tab is disable. + * @return true if this tab is disable * @since JavaFX 2.2 */ public final boolean isDisable() { return disable == null ? false : disable.get(); } @@ -589,6 +613,7 @@ * or traversable, but the contents remain interactive. A disable tab * can be selected using {@link TabPane#getSelectionModel()}. * + * @return the disable property * @defaultValue false * @since JavaFX 2.2 */ @@ -623,6 +648,7 @@ /** * Returns true when the {@code Tab} {@link #disableProperty disable} is set to * {@code true} or if the {@code TabPane} is disabled. + * @return true if the TabPane is disabled * @since JavaFX 2.2 */ public final boolean isDisabled() { @@ -634,6 +660,7 @@ * will become disabled if {@link #disableProperty disable} is set to {@code true} on either * itself or if the {@code TabPane} is disabled. * + * @return the disabled property * @defaultValue false * @since JavaFX 2.2 */ --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TabPane.java 2017-03-09 14:44:32.202173813 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TabPane.java 2017-03-09 14:44:32.086173811 -0800 @@ -162,6 +162,7 @@ * selected tab, if it remains within this ObservableList. If the previously * selected tab is no longer in the tabs ObservableList, the selected tab will * become the first tab in the ObservableList.

      + * @return the list of tabs */ public final ObservableList getTabs() { return tabs; @@ -172,16 +173,19 @@ /** *

      Sets the model used for tab selection. By changing the model you can alter * how the tabs are selected and which tabs are first or last.

      + * @param value the selection model */ public final void setSelectionModel(SingleSelectionModel value) { selectionModel.set(value); } /** *

      Gets the model used for tab selection.

      + * @return the model used for tab selection */ public final SingleSelectionModel getSelectionModel() { return selectionModel.get(); } /** * The selection model used for selecting tabs. + * @return selection model property */ public final ObjectProperty> selectionModelProperty() { return selectionModel; } @@ -192,6 +196,7 @@ * the TabPane will immediately update the location of the tabs to reflect * this.

      * + * @param value the side */ public final void setSide(Side value) { sideProperty().set(value); @@ -209,6 +214,7 @@ /** * The position of the tabs in the TabPane. + * @return the side property */ public final ObjectProperty sideProperty() { if (side == null) { @@ -257,6 +263,7 @@ *

      Refer to the {@link TabClosingPolicy} enumeration for further details.

      * * The default closing policy is TabClosingPolicy.SELECTED_TAB + * @param value the closing policy */ public final void setTabClosingPolicy(TabClosingPolicy value) { tabClosingPolicyProperty().set(value); @@ -273,6 +280,7 @@ /** * The closing policy for the tabs. + * @return the closing policy property */ public final ObjectProperty tabClosingPolicyProperty() { if (tabClosingPolicy == null) { @@ -292,6 +300,7 @@ * rotateGraphic is set to {@code true}, the graphic will rotate such that it * rotates with the tab text.

      * + * @param value a flag indicating whether to rotate the graphic */ public final void setRotateGraphic(boolean value) { rotateGraphicProperty().set(value); @@ -308,7 +317,8 @@ } /** - * The rotatedGraphic state of the tabs in the TabPane. + * The rotateGraphic state of the tabs in the TabPane. + * @return the rotateGraphic property */ public final BooleanProperty rotateGraphicProperty() { if (rotateGraphic == null) { @@ -327,6 +337,7 @@ * This value can also be set via CSS using {@code -fx-tab-min-width} * *

      + * @param value the minimum width of the tabs */ public final void setTabMinWidth(double value) { tabMinWidthProperty().setValue(value); @@ -335,7 +346,7 @@ /** * The minimum width of the tabs in the TabPane. * - * @return The minimum width of the tabs. + * @return The minimum width of the tabs */ public final double getTabMinWidth() { return tabMinWidth == null ? DEFAULT_TAB_MIN_WIDTH : tabMinWidth.getValue(); @@ -343,6 +354,7 @@ /** * The minimum width of the tabs in the TabPane. + * @return the minimum width property */ public final DoubleProperty tabMinWidthProperty() { if (tabMinWidth == null) { @@ -383,7 +395,7 @@ /** * The maximum width of the tabs in the TabPane. * - * @return The maximum width of the tabs. + * @return The maximum width of the tabs */ public final double getTabMaxWidth() { return tabMaxWidth == null ? DEFAULT_TAB_MAX_WIDTH : tabMaxWidth.getValue(); @@ -391,6 +403,7 @@ /** * The maximum width of the tabs in the TabPane. + * @return the maximum width property */ public final DoubleProperty tabMaxWidthProperty() { if (tabMaxWidth == null) { @@ -424,6 +437,7 @@ * * This value can also be set via CSS using {@code -fx-tab-min-height} *

      + * @param value the minimum height of the tabs */ public final void setTabMinHeight(double value) { tabMinHeightProperty().setValue(value); @@ -432,7 +446,7 @@ /** * The minimum height of the tabs in the TabPane. * - * @return The minimum height of the tabs. + * @return the minimum height of the tabs */ public final double getTabMinHeight() { return tabMinHeight == null ? DEFAULT_TAB_MIN_HEIGHT : tabMinHeight.getValue(); @@ -440,6 +454,7 @@ /** * The minimum height of the tab. + * @return the minimum height property */ public final DoubleProperty tabMinHeightProperty() { if (tabMinHeight == null) { @@ -480,7 +495,7 @@ /** * The maximum height of the tabs in the TabPane. * - * @return The maximum height of the tabs. + * @return The maximum height of the tabs */ public final double getTabMaxHeight() { return tabMaxHeight == null ? DEFAULT_TAB_MAX_HEIGHT : tabMaxHeight.getValue(); @@ -488,6 +503,7 @@ /** *

      The maximum height of the tabs in the TabPane.

      + * @return the maximum height of the tabs */ public final DoubleProperty tabMaxHeightProperty() { if (tabMaxHeight == null) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TableCell.java 2017-03-09 14:44:32.566173820 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TableCell.java 2017-03-09 14:44:32.462173818 -0800 @@ -63,7 +63,6 @@ * property is set to true (to represent that it is allowable to select * individual cells (and not just rows of cells)). * - *

      * * @see TableView * @see TableColumn @@ -210,6 +209,7 @@ }; /** * The TableColumn instance that backs this TableCell. + * @return the TableColumn instance that backs this TableCell */ public final ReadOnlyObjectProperty> tableColumnProperty() { return tableColumn.getReadOnlyProperty(); } private void setTableColumn(TableColumn value) { tableColumn.set(value); } @@ -227,6 +227,7 @@ /** * The TableView associated with this TableCell. + * @return the TableView associated with this TableCell */ public final ReadOnlyObjectProperty> tableViewProperty() { return tableViewPropertyImpl().getReadOnlyProperty(); @@ -695,9 +696,10 @@ * Updates the TableView associated with this TableCell. This is typically * only done once when the TableCell is first added to the TableView. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param tv the TableView associated with this TableCell */ public final void updateTableView(TableView tv) { setTableView(tv); @@ -706,9 +708,10 @@ /** * Updates the TableRow associated with this TableCell. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param tableRow the TableRow associated with this TableCell */ public final void updateTableRow(TableRow tableRow) { this.setTableRow(tableRow); @@ -717,9 +720,10 @@ /** * Updates the TableColumn associated with this TableCell. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param col the TableColumn associated with this TableCell */ public final void updateTableColumn(TableColumn col) { // remove style class of existing table column, if it is non-null --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TableColumn.java 2017-03-09 14:44:32.982173827 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TableColumn.java 2017-03-09 14:44:32.842173825 -0800 @@ -74,7 +74,6 @@ * {@link #comparatorProperty() comparator}, {@link #sortable sortable} and * {@link #sortTypeProperty() sortType}) *
    - *

    * * When creating a TableColumn instance, perhaps the two most important properties * to set are the column {@link #textProperty() text} (what to show in the column @@ -144,6 +143,9 @@ /** * Parent event for any TableColumn edit event. + * @param The type of the TableView generic type + * @param The type of the content in all cells in this TableColumn + * @return The any TableColumn edit event */ @SuppressWarnings("unchecked") public static EventType> editAnyEvent() { @@ -156,6 +158,9 @@ * Indicates that the user has performed some interaction to start an edit * event, or alternatively the {@link TableView#edit(int, javafx.scene.control.TableColumn)} * method has been called. + * @param The type of the TableView generic type + * @param The type of the content in all cells in this TableColumn + * @return The start an edit event */ @SuppressWarnings("unchecked") public static EventType> editStartEvent() { @@ -167,6 +172,9 @@ /** * Indicates that the editing has been canceled, meaning that no change should * be made to the backing data source. + * @param The type of the TableView generic type + * @param The type of the content in all cells in this TableColumn + * @return The cancel an edit event */ @SuppressWarnings("unchecked") public static EventType> editCancelEvent() { @@ -179,6 +187,9 @@ * Indicates that the editing has been committed by the user, meaning that * a change should be made to the backing data source to reflect the new * data. + * @param The type of the TableView generic type + * @param The type of the content in all cells in this TableColumn + * @return The commit an edit event */ @SuppressWarnings("unchecked") public static EventType> editCommitEvent() { @@ -476,6 +487,7 @@ /** * This event handler will be fired when the user successfully initiates * editing. + * @return the on edit start property */ public final ObjectProperty>> onEditStartProperty() { if (onEditStart == null) { @@ -500,6 +512,7 @@ /** * This event handler will be fired when the user successfully commits their * editing. + * @return the on edit commit property */ public final ObjectProperty>> onEditCommitProperty() { if (onEditCommit == null) { @@ -523,6 +536,7 @@ } /** * This event handler will be fired when the user cancels editing a cell. + * @return the on edit cancel property */ public final ObjectProperty>> onEditCancelProperty() { if (onEditCancel == null) { @@ -708,6 +722,7 @@ /** * Returns the value passed in to the constructor. + * @return the value passed in to the constructor */ public S getValue() { return value; @@ -715,6 +730,7 @@ /** * Returns the {@link TableColumn} passed in to the constructor. + * @return the TableColumn passed in to the constructor */ public TableColumn getTableColumn() { return tableColumn; @@ -722,6 +738,7 @@ /** * Returns the {@link TableView} passed in to the constructor. + * @return the TableView passed in to the constructor */ public TableView getTableView() { return tableView; @@ -732,6 +749,8 @@ /** * An event that is fired when a user performs an edit on a table cell. + * @param The type of the TableView generic type + * @param The type of the content in all cells in this TableColumn * @since JavaFX 2.0 */ public static class CellEditEvent extends Event { @@ -831,6 +850,7 @@ * the TableView {@link TableView#itemsProperty() items} list), for the * row contained within the {@link TablePosition} returned in * {@link #getTablePosition()}. + * @return the value for the row */ public S getRowValue() { List items = getTableView().getItems(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TableColumnBase.java 2017-03-09 14:44:33.334173833 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TableColumnBase.java 2017-03-09 14:44:33.230173831 -0800 @@ -82,7 +82,6 @@ * {@link #comparatorProperty() comparator}, {@link #sortable sortable} and * sortType). * - *

    * * When instantiating a concrete subclass of TableColumnBase, perhaps the two * most important properties to set are the column {@link #textProperty() text} @@ -405,6 +404,7 @@ * external property, as that will result in the column width not being * adjustable by the user through dragging the left and right borders of * column headers. + * @return the width property */ public final ReadOnlyDoubleProperty widthProperty() { return width.getReadOnlyProperty(); } public final double getWidth() { return width.get(); } @@ -438,6 +438,7 @@ // --- Preferred Width /** * The preferred width of the TableColumn. + * @return preferred width property */ public final DoubleProperty prefWidthProperty() { return prefWidth; } public final void setPrefWidth(double value) { prefWidthProperty().set(value); } @@ -454,6 +455,7 @@ // so I've arbitrarily chosen a better, smaller number. /** * The maximum width the table column is permitted to be resized to. + * @return maximum width property */ public final DoubleProperty maxWidthProperty() { return maxWidth; } public final void setMaxWidth(double value) { maxWidthProperty().set(value); } @@ -735,6 +737,7 @@ * Note however that TableColumnBase is not a Node, and therefore no visual * events will be fired on it. * + * @param The type of event * @param eventType the type of the events to receive by the handler * @param eventHandler the handler to register * @throws NullPointerException if the event type or handler is null @@ -749,6 +752,7 @@ * caller needs to specify the particular event type from which to * unregister the handler. * + * @param The type of event * @param eventType the event type from which to unregister * @param eventHandler the handler to unregister * @throws NullPointerException if the event type or handler is null --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TableFocusModel.java 2017-03-09 14:44:33.690173840 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TableFocusModel.java 2017-03-09 14:44:33.586173838 -0800 @@ -53,6 +53,10 @@ /** * Tests whether the row / cell at the given location currently has the * focus within the UI control. + * @param row the row + * @param column the column + * @return true if the row / cell at the given location currently has the + * focus within the UI control */ public abstract boolean isFocused(int row, TC column); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TablePosition.java 2017-03-09 14:44:34.034173846 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TablePosition.java 2017-03-09 14:44:33.930173844 -0800 @@ -111,6 +111,7 @@ /** * The TableView that this TablePosition is related to. + * @return the TableView */ public final TableView getTableView() { return controlRef.get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TablePositionBase.java 2017-03-09 14:44:34.406173852 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TablePositionBase.java 2017-03-09 14:44:34.286173850 -0800 @@ -89,6 +89,7 @@ /** * The row that this TablePosition represents in the TableView. + * @return the row that this TablePosition represents in the TableView */ public int getRow() { return row; @@ -97,11 +98,14 @@ /** * The column index that this TablePosition represents in the TableView. It * is -1 if the TableView or TableColumn instances are null. + * @return the column index that this TablePosition represents in the + * TableView */ public abstract int getColumn(); /** * The TableColumn that this TablePosition represents in the TableView. + * @return the TableColumn that this TablePosition represents in the TableView */ public TC getTableColumn() { return tableColumnRef.get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TableRow.java 2017-03-09 14:44:34.758173859 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TableRow.java 2017-03-09 14:44:34.642173856 -0800 @@ -135,6 +135,7 @@ /** * The TableView associated with this Cell. + * @return the TableView associated with this Cell */ public final ReadOnlyObjectProperty> tableViewProperty() { return tableViewPropertyImpl().getReadOnlyProperty(); @@ -340,9 +341,10 @@ * Updates the TableView associated with this TableCell. This is typically * only done once when the TableCell is first added to the TableView. * - * @expert This function is intended to be used by experts, primarily + * Note: This function is intended to be used by experts, primarily * by those implementing new Skins. It is not common * for developers or designers to access this function directly. + * @param tv the TableView */ public final void updateTableView(TableView tv) { setTableView(tv); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TableSelectionModel.java 2017-03-09 14:44:35.118173865 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TableSelectionModel.java 2017-03-09 14:44:35.014173863 -0800 @@ -43,6 +43,10 @@ * 'cell selection' mode (where individual cells can be selected, rather than * entire rows), and if the column argument is null, this method should return * true only if all cells in the given row are selected. + * @param row the row + * @param column the column + * @return true if the given row and column index is currently selected in + * this table instance */ public abstract boolean isSelected(int row, TableColumnBase column); @@ -51,6 +55,8 @@ * 'cell selection' mode (where individual cells can be selected, rather than * entire rows), and if the column argument is null, this method should select * all cells in the given row. + * @param row the row + * @param column the column */ public abstract void select(int row, TableColumnBase column); @@ -60,6 +66,8 @@ * 'cell selection' mode (where individual cells can be selected, rather than * entire rows), and if the column argument is null, this method should select * all cells in the given row. + * @param row the row + * @param column the column */ public abstract void clearAndSelect(int row, TableColumnBase column); @@ -70,6 +78,8 @@ * 'cell selection' mode (where individual cells can be selected, rather than * entire rows), and if the column argument is null, this method should deselect * all cells in the given row. + * @param row the row + * @param column the column */ public abstract void clearSelection(int row, TableColumnBase column); @@ -96,6 +106,10 @@ /** * Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), * inclusive. + * @param minRow the minRow + * @param minColumn the minColumn + * @param maxRow the maxRow + * @param maxColumn the maxColumn */ public abstract void selectRange(int minRow, TableColumnBase minColumn, int maxRow, TableColumnBase maxColumn); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TableView.java 2017-03-09 14:44:35.478173871 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TableView.java 2017-03-09 14:44:35.370173869 -0800 @@ -107,7 +107,6 @@ * the column header (hold down Shift keyboard key whilst clicking on a * header to sort by multiple columns). * - *

    * *

    Note that TableView is intended to be used to visualize data - it is not * intended to be used for laying out your user interface. If you want to lay @@ -116,11 +115,12 @@ * *

    Creating a TableView

    * - *

    Creating a TableView is a multi-step process, and also depends on the + *

    + * {@literal 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, as it is the simplest way of showing data in a * TableView. The Person class will consist of a first - * name and last name properties. That is: + * name and last name properties. That is:} * *

      * {@code
    @@ -148,9 +148,10 @@
      * {@code
      * TableView table = new TableView();}
    * + * {@literal *

    With the basic table defined, we next focus on the data model. As mentioned, * for this example, we'll be using a ObservableList. We can immediately - * set such a list directly in to the TableView, as such: + * set such a list directly in to the TableView, as such:} * *

      * {@code
    @@ -834,6 +835,7 @@
         /**
          * The underlying data model for the TableView. Note that it has a generic
          * type that must match the type of the TableView itself.
    +     * @return the items property
          */
         public final ObjectProperty> itemsProperty() { return items; }
         private ObjectProperty> items =
    @@ -868,6 +870,7 @@
          * in a designated space within the TableView, within which is a radio menu
          * item for each TableColumn in this table. This menu allows for the user to
          * show and hide all TableColumns easily.
    +     * @return the tableMenuButtonVisible property
          */
         public final BooleanProperty tableMenuButtonVisibleProperty() {
             if (tableMenuButtonVisible == null) {
    @@ -897,6 +900,7 @@
          * operation. The two most common policies are available as static functions
          * in the TableView class: {@link #UNCONSTRAINED_RESIZE_POLICY} and
          * {@link #CONSTRAINED_RESIZE_POLICY}.
    +     * @return columnResizePolicy property
          */
         public final ObjectProperty> columnResizePolicyProperty() {
             if (columnResizePolicy == null) {
    @@ -941,6 +945,7 @@
          * 

    * You can create custom TableCell instances per column by assigning the * appropriate function to the cellFactory property in the TableColumn class. + * @return rowFactory property */ public final ObjectProperty, TableRow>> rowFactoryProperty() { if (rowFactory == null) { @@ -964,6 +969,7 @@ * place, that a filter has been applied to the table model, resulting * in there being nothing to show the user, or that there are no currently * visible columns. + * @return placeholder property */ public final ObjectProperty placeholderProperty() { if (placeholder == null) { @@ -1010,6 +1016,7 @@ * to select single or multiple items within a TableView, as well as inspect * which items have been selected by the user. Note that it has a generic * type that must match the type of the TableView itself. + * @return selectionModel property */ public final ObjectProperty> selectionModelProperty() { return selectionModel; @@ -1035,6 +1042,7 @@ * Represents the currently-installed {@link TableViewFocusModel} for this * TableView. Under almost all circumstances leaving this as the default * focus model will suffice. + * @return focusModel property */ public final ObjectProperty> focusModelProperty() { if (focusModel == null) { @@ -1081,6 +1089,7 @@ * Specifies whether this TableView is editable - only if the TableView, the * TableColumn (if applicable) and the TableCells within it are both * editable will a TableCell be able to go into their editing state. + * @return the editable property */ public final BooleanProperty editableProperty() { if (editable == null) { @@ -1138,6 +1147,7 @@ * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are * specified in CSS, -fx-fixed-cell-size takes precedence.

    * + * @return fixedCellSize property * @since JavaFX 8.0 */ public final DoubleProperty fixedCellSizeProperty() { @@ -1172,6 +1182,7 @@ /** * Represents the current cell being edited, or null if * there is no cell being edited. + * @return the editingCell property */ public final ReadOnlyObjectProperty> editingCellProperty() { return editingCellPropertyImpl().getReadOnlyProperty(); @@ -1303,6 +1314,7 @@ * *

    Note: to display any data in a TableView, there must be at least one * TableColumn in this ObservableList.

    + * @return the columns */ public final ObservableList> getColumns() { return columns; @@ -1451,6 +1463,9 @@ /** * Applies the currently installed resize policy against the given column, * resizing it based on the delta value provided. + * @param column the column + * @param delta the delta + * @return true if column resize is allowed */ public boolean resizeColumn(TableColumn column, double delta) { if (column == null || Double.compare(delta, 0.0) == 0) return false; @@ -1468,6 +1483,8 @@ * *

    Note: This method will cancel editing if the given row * value is less than zero and the given column is null.

    + * @param row the row + * @param column the column */ public void edit(int row, TableColumn column) { if (!isEditable() || (column != null && ! column.isEditable())) { @@ -1483,6 +1500,7 @@ /** * Returns an unmodifiable list containing the currently visible leaf columns. + * @return an unmodifiable list containing the currently visible leaf columns */ public ObservableList> getVisibleLeafColumns() { return unmodifiableVisibleLeafColumns; @@ -1491,6 +1509,9 @@ /** * Returns the position of the given column, relative to all other * visible leaf columns. + * @param column the column + * @return the position of the given column, relative to all other + * visible leaf columns */ public int getVisibleLeafIndex(TableColumn column) { return visibleLeafColumns.indexOf(column); @@ -1499,6 +1520,9 @@ /** * Returns the TableColumn in the given column index, relative to all other * visible leaf columns. + * @param column the column + * @return the TableColumn in the given column index, relative to all other + * visible leaf columns */ public TableColumn getVisibleLeafColumn(int column) { if (column < 0 || column >= visibleLeafColumns.size()) return null; @@ -1825,6 +1849,7 @@ /** * Returns the TableView upon which the resize operation is occurring. + * @return the TableView */ public TableView getTable() { return table; @@ -1892,6 +1917,8 @@ * A read-only ObservableList representing the currently selected cells * in this TableView. Rather than directly modify this list, please * use the other methods provided in the TableViewSelectionModel. + * @return a read-only ObservableList representing the currently + * selected cells in this TableView */ public abstract ObservableList getSelectedCells(); @@ -1911,6 +1938,9 @@ /** * Convenience function which tests whether the given row and column index * is currently selected in this table instance. + * @param row the row + * @param column the column + * @return true if row and column index is currently selected */ public abstract boolean isSelected(int row, TableColumn column); @@ -1923,6 +1953,8 @@ /** * Selects the cell at the given row/column intersection. + * @param row the row + * @param column the column */ public abstract void select(int row, TableColumn column); @@ -1936,6 +1968,8 @@ /** * Clears all selection, and then selects the cell at the given row/column * intersection. + * @param row the row + * @param column the column */ public abstract void clearAndSelect(int row, TableColumn column); @@ -1950,6 +1984,8 @@ * Removes selection from the specified row/column position (in view indexes). * If this particular cell (or row if the column value is -1) is not selected, * nothing happens. + * @param row the row + * @param column the column */ public abstract void clearSelection(int row, TableColumn column); @@ -1975,6 +2011,7 @@ /** * Returns the TableView instance that this selection model is installed in. + * @return the TableView */ public TableView getTableView() { return tableView; @@ -3218,7 +3255,7 @@ * Causes the item at the given index to receive the focus. This does not * cause the current selection to change. Updates the focusedItem and * focusedIndex properties such that focusedIndex = -1 unless - *
    0 <= index < model size
    . + *
    0 <= index < model size
    . * * @param index The index of the item to get focus. */ --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TextArea.java 2017-03-09 14:44:35.882173878 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TextArea.java 2017-03-09 14:44:35.774173877 -0800 @@ -460,6 +460,8 @@ /** * Returns an unmodifiable list of the character sequences that back the * text area's content. + * @return an unmodifiable list of the character sequences that back the + * text area's content */ public ObservableList getParagraphs() { return ((TextAreaContent)getContent()).paragraphList; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TextField.java 2017-03-09 14:44:36.238173885 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TextField.java 2017-03-09 14:44:36.138173883 -0800 @@ -153,6 +153,7 @@ /** * Returns the character sequence backing the text field's content. + * @return the character sequence backing the text field's content */ public CharSequence getCharacters() { return ((TextFieldContent)getContent()).characters; @@ -234,6 +235,7 @@ /** * Specifies how the text should be aligned when there is empty * space within the TextField. + * @return the alignment property * @since JavaFX 2.1 */ public final ObjectProperty alignmentProperty() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TextFormatter.java 2017-03-09 14:44:36.594173891 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TextFormatter.java 2017-03-09 14:44:36.486173889 -0800 @@ -142,7 +142,7 @@ /** * The current value for this formatter. When the formatter is set on a {@code TextInputControl} and has a - * @{code valueConverter}, the value is set by the control, when the text is commited. + * {@code valueConverter}, the value is set by the control, when the text is commited. */ private final ObjectProperty value = new ObjectPropertyBase() { @@ -237,7 +237,6 @@ * E.g. when some text is being deleted, you can simply replace it by some placeholder text just by setting a new text * ({@code setText("new text")}) * - *

    *

    * The Change is mutable, but not observable. It should be used * only for the life of a single change. It is intended that the --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TextInputControl.java 2017-03-09 14:44:36.954173897 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TextInputControl.java 2017-03-09 14:44:36.842173895 -0800 @@ -87,16 +87,18 @@ /** * Retrieves a subset of the content. * - * @param start - * @param end + * @param start the start + * @param end the end + * @return a subset of the content */ public String get(int start, int end); /** * Inserts a sequence of characters into the content. * - * @param index - * @param text + * @param index the index + * @param text the text string + * @param notifyListeners the notify listener flag * @since JavaFX 2.1 */ public void insert(int index, String text, boolean notifyListeners); @@ -104,14 +106,16 @@ /** * Removes a sequence of characters from the content. * - * @param start - * @param end + * @param start the start + * @param end the end + * @param notifyListeners the notify listener flag * @since JavaFX 2.1 */ public void delete(int start, int end, boolean notifyListeners); /** * Returns the number of characters represented by the content. + * @return the number of characters */ public int length(); } @@ -191,6 +195,7 @@ * rich text then this font may or may not be used depending on the font * information embedded in the rich text, but in any case where a default * font is required, this font will be used. + * @return the font property * @since JavaFX 8.0 */ public final ObjectProperty fontProperty() { @@ -339,6 +344,7 @@ private final Content content; /** * Returns the text input's content model. + * @return the text input's content model */ protected final Content getContent() { return content; @@ -443,6 +449,7 @@ * * @param start must be a value between 0 and end - 1. * @param end must be less than or equal to the length + * @return the subset of the text input's content */ public String getText(int start, int end) { if (start > end) { @@ -880,6 +887,7 @@ * Deletes the character that precedes the current caret position from the * text if there is no selection, or deletes the selection if there is one. * This function returns true if the deletion succeeded, false otherwise. + * @return true if the deletion succeeded, false otherwise */ public boolean deletePreviousChar() { boolean failed = true; @@ -910,6 +918,7 @@ * Deletes the character that follows the current caret position from the * text if there is no selection, or deletes the selection if there is one. * This function returns true if the deletion succeeded, false otherwise. + * @return true if the deletion succeeded, false otherwise */ public boolean deleteNextChar() { boolean failed = true; @@ -970,9 +979,9 @@ * then the caret position is moved to the beginning of the selection and * the selection cleared. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins or Behaviors. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins or Behaviors. It is not common + * for developers or designers to access this function directly. */ public void backward() { // user has moved caret to the left @@ -996,6 +1005,7 @@ /** * Positions the caret to the position indicated by {@code pos}. This * function will also clear the selection. + * @param pos the position */ public void positionCaret(int pos) { final int p = Utils.clamp(0, pos, getLength()); @@ -1007,6 +1017,7 @@ * the selection, if there is one. If there is no selection, then a * selection is formed where the anchor is at the current caret position * and the caretPosition is moved to pos. + * @param pos the position */ public void selectPositionCaret(int pos) { selectRange(getAnchor(), Utils.clamp(0, pos, getLength())); @@ -1014,6 +1025,8 @@ /** * Positions the anchor and caretPosition explicitly. + * @param anchor the anchor + * @param caretPosition the caretPosition */ public void selectRange(int anchor, int caretPosition) { caretPosition = Utils.clamp(0, caretPosition, getLength()); @@ -1044,6 +1057,7 @@ * move the caret. Rather, it will reposition the caret and anchor as necessary * to ensure that pos becomes the new caret and the far other end of the * selection becomes the anchor. + * @param pos the position */ public void extendSelection(int pos) { final int p = Utils.clamp(0, pos, getLength()); @@ -1082,6 +1096,7 @@ * no selection, then the replacement text is simply inserted at the current * caret position. If there was a selection, then the selection is cleared * and the given replacement text inserted. + * @param replacement the replacement string */ public void replaceSelection(String replacement) { replaceText(getSelection(), replacement); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TextInputDialog.java 2017-03-09 14:44:37.334173904 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TextInputDialog.java 2017-03-09 14:44:37.222173902 -0800 @@ -71,6 +71,7 @@ /** * Creates a new TextInputDialog with the default value entered into the * dialog {@link TextField}. + * @param defaultValue the default value entered into the dialog */ public TextInputDialog(@NamedArg("defaultValue") String defaultValue) { final DialogPane dialogPane = getDialogPane(); @@ -118,6 +119,7 @@ /** * Returns the {@link TextField} used within this dialog. + * @return the {@link TextField} used within this dialog */ public final TextField getEditor() { return textField; @@ -125,6 +127,7 @@ /** * Returns the default value that was specified in the constructor. + * @return the default value that was specified in the constructor */ public final String getDefaultValue() { return defaultValue; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TitledPane.java 2017-03-09 14:44:37.674173910 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TitledPane.java 2017-03-09 14:44:37.574173908 -0800 @@ -171,6 +171,7 @@ /** * Sets the expanded state of the TitledPane. The default is {@code true}. * + * @param value a flag indicating the expanded state */ public final void setExpanded(boolean value) { expandedProperty().set(value); } @@ -183,6 +184,7 @@ /** * The expanded state of the TitledPane. + * @return the expanded state property */ public final BooleanProperty expandedProperty() { return expanded; } @@ -211,6 +213,7 @@ * Specifies how the TitledPane should open and close. The panel will be * animated out when this value is set to {@code true}. The default is {@code true}. * + * @param value if flag indicating the animated state */ public final void setAnimated(boolean value) { animatedProperty().set(value); } @@ -223,6 +226,7 @@ /** * The animated state of the TitledPane. + * @return the animated state property */ public final BooleanProperty animatedProperty() { return animated; } @@ -250,6 +254,7 @@ /** * Specifies if the TitledPane can be collapsed. The default is {@code true}. * + * @param value a flag indicating the collapsible state */ public final void setCollapsible(boolean value) { collapsibleProperty().set(value); } @@ -262,6 +267,7 @@ /** * The collapsible state of the TitledPane. + * @return the collapsible property */ public final BooleanProperty collapsibleProperty() { return collapsible; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Toggle.java 2017-03-09 14:44:38.038173917 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Toggle.java 2017-03-09 14:44:37.926173915 -0800 @@ -53,6 +53,7 @@ /** * The {@link ToggleGroup} to which this {@code Toggle} belongs. + * @return the toggle group property */ ObjectProperty toggleGroupProperty(); @@ -71,6 +72,7 @@ /** * The selected state for this {@code Toggle}. + * @return the selected property */ BooleanProperty selectedProperty(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ToggleGroup.java 2017-03-09 14:44:38.386173923 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ToggleGroup.java 2017-03-09 14:44:38.282173921 -0800 @@ -62,6 +62,7 @@ /** * The list of toggles within the ToggleGroup. + * @return the list of toggles within the ToggleGroup */ public final ObservableList getToggles() { return toggles; @@ -156,6 +157,7 @@ /** * The selected toggle. + * @return the selected toggle */ public final ReadOnlyObjectProperty selectedToggleProperty() { return selectedToggle.getReadOnlyProperty(); } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/ToolBar.java 2017-03-09 14:44:38.738173929 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/ToolBar.java 2017-03-09 14:44:38.630173927 -0800 @@ -136,6 +136,7 @@ * are {@link Button Buttons}, {@link ToggleButton ToggleButtons}, and {@link Separator Separators}, * but you are not restricted to just these, and can insert any {@link Node}. * The items added must not be null. + * @return the list of items */ public final ObservableList getItems() { return items; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/Tooltip.java 2017-03-09 14:44:39.094173935 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/Tooltip.java 2017-03-09 14:44:38.978173933 -0800 @@ -130,6 +130,8 @@ * Associates the given {@link Tooltip} with the given {@link Node}. The tooltip * can then behave similar to when it is set on any {@link Control}. A single * tooltip can be associated with multiple nodes. + * @param node the node + * @param t the tooltip * @see Tooltip */ public static void install(Node node, Tooltip t) { @@ -140,6 +142,8 @@ * Removes the association of the given {@link Tooltip} on the specified * {@link Node}. Hence hovering on the node will no longer result in showing of the * tooltip. + * @param node the node + * @param t the tooltip * @see Tooltip */ public static void uninstall(Node node, Tooltip t) { @@ -180,6 +184,7 @@ /** * The text to display in the tooltip. If the text is set to null, an empty * string will be displayed, despite the value being null. + * @return the text property */ public final StringProperty textProperty() { return text; } public final void setText(String value) { @@ -204,6 +209,7 @@ * Unlike {@link #contentDisplayProperty() contentDisplay} which affects the * graphic and text, this setting only affects multiple lines of text * relative to the text bounds. + * @return the text alignment property */ public final ObjectProperty textAlignmentProperty() { return textAlignment; @@ -220,6 +226,7 @@ /** * Specifies the behavior to use if the text of the {@code Tooltip} * exceeds the available space for rendering the text. + * @return the text overrun property */ public final ObjectProperty textOverrunProperty() { return textOverrun; @@ -236,6 +243,7 @@ /** * If a run of text exceeds the width of the Tooltip, then this variable * indicates whether the text should wrap onto another line. + * @return the wrap text property */ public final BooleanProperty wrapTextProperty() { return wrapText; @@ -255,6 +263,7 @@ * rich text then this font may or may not be used depending on the font * information embedded in the rich text, but in any case where a default * font is required, this font will be used. + * @return the font property */ public final ObjectProperty fontProperty() { return font; @@ -317,8 +326,9 @@ * The delay between the mouse entering the hovered node and when the associated tooltip will be shown to the user. * The default delay is 1000ms. * + * @return show delay property * @since 9 - * @defaultvalue 1000ms + * @defaultValue 1000ms */ public final ObjectProperty showDelayProperty() { return showDelayProperty; @@ -339,8 +349,9 @@ * for the duration specified in the {@link #hideDelayProperty()}, even if the remaining time of the showDuration * is less than the hideDelay duration. The default value is 5000ms. * + * @return the show duration property * @since 9 - * @defaultvalue 5000ms + * @defaultValue 5000ms */ public final ObjectProperty showDurationProperty() { return showDurationProperty; @@ -359,8 +370,9 @@ * The duration in which to continue showing the tooltip after the mouse has left the node. Once this time has * elapsed the tooltip will hide. The default value is 200ms. * + * @return the hide delay property * @since 9 - * @defaultvalue 200ms + * @defaultValue 200ms */ public final ObjectProperty hideDelayProperty() { return hideDelayProperty; @@ -382,6 +394,7 @@ * The node specified for this variable cannot appear elsewhere in the * scene graph, otherwise the {@code IllegalArgumentException} is thrown. * See the class description of {@link javafx.scene.Node Node} for more detail. + * @return the graphic property */ public final ObjectProperty graphicProperty() { return graphic; @@ -510,6 +523,7 @@ /** * Specifies the positioning of the graphic relative to the text. + * @return the content display property */ public final ObjectProperty contentDisplayProperty() { return contentDisplay; @@ -525,6 +539,7 @@ /** * The amount of space between the graphic and text + * @return the graphic text gap property */ public final DoubleProperty graphicTextGapProperty() { return graphicTextGap; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeCell.java 2017-03-09 14:44:39.462173942 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeCell.java 2017-03-09 14:44:39.350173940 -0800 @@ -220,12 +220,14 @@ /** * Returns the TreeItem currently set in this TreeCell. + * @return the TreeItem currently set in this TreeCell */ public final TreeItem getTreeItem() { return treeItem.get(); } /** * Each TreeCell represents at most a single {@link TreeItem}, which is * represented by this property. + * @return the TreeItem property representing this TreeCell */ public final ReadOnlyObjectProperty> treeItemProperty() { return treeItem.getReadOnlyProperty(); } @@ -240,11 +242,13 @@ * an item in the tree which contains child items. If not specified, the * TreeCell's Skin implementation is responsible for providing a default * disclosure node. + * @param value the disclosure node */ public final void setDisclosureNode(Node value) { disclosureNodeProperty().set(value); } /** * Returns the current disclosure node set in this TreeCell. + * @return the current disclosure node set in this TreeCell */ public final Node getDisclosureNode() { return disclosureNode.get(); } @@ -252,6 +256,7 @@ * The disclosure node is commonly seen represented as a triangle that rotates * on screen to indicate whether or not the TreeItem that it is placed * beside is expanded or collapsed. + * @return the disclosure node */ public final ObjectProperty disclosureNodeProperty() { return disclosureNode; } @@ -328,12 +333,14 @@ /** * Returns the TreeView associated with this TreeCell. + * @return the TreeView associated with this TreeCell */ public final TreeView getTreeView() { return treeView.get(); } /** * A TreeCell is explicitly linked to a single {@link TreeView} instance, * which is represented by this property. + * @return the TreeView property of this TreeCell */ public final ReadOnlyObjectProperty> treeViewProperty() { return treeView.getReadOnlyProperty(); } @@ -600,9 +607,9 @@ * Updates the TreeView associated with this TreeCell. * * @param tree The new TreeView that should be associated with this TreeCell. - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. */ public final void updateTreeView(TreeView tree) { setTreeView(tree); @@ -613,9 +620,9 @@ * * @param treeItem The new TreeItem that should be associated with this * TreeCell. - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. */ public final void updateTreeItem(TreeItem treeItem) { TreeItem _treeItem = getTreeItem(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeItem.java 2017-03-09 14:44:39.826173948 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeItem.java 2017-03-09 14:44:39.722173946 -0800 @@ -133,7 +133,7 @@ * * private ObservableList<TreeItem<File>> buildChildren(TreeItem<File> TreeItem) { * File f = TreeItem.getValue(); - * if (f != null && f.isDirectory()) { + * if (f != null && f.isDirectory()) { * File[] files = f.listFiles(); * if (files != null) { * ObservableList<TreeItem<File>> children = FXCollections.observableArrayList(); @@ -171,17 +171,19 @@ * are shown below (follow the links to learn more about each event type): * *

      - *
    • {@link TreeItem#treeNotificationEvent() TreeItem.treeNotificationEvent()}
    • + *
    • {@link TreeItem#treeNotificationEvent() TreeItem.treeNotificationEvent()} *
        *
      • {@link TreeItem#valueChangedEvent() TreeItem.valueChangedEvent()}
      • *
      • {@link TreeItem#graphicChangedEvent() TreeItem.graphicChangedEvent()}
      • - *
      • {@link TreeItem#treeItemCountChangeEvent() TreeItem.treeItemCountChangeEvent()}
      • + *
      • {@link TreeItem#expandedItemCountChangeEvent() TreeItem.expandedItemCountChangeEvent()} *
          *
        • {@link TreeItem#branchExpandedEvent() TreeItem.branchExpandedEvent()}
        • *
        • {@link TreeItem#branchCollapsedEvent() TreeItem.branchCollapsedEvent()}
        • *
        • {@link TreeItem#childrenModificationEvent() TreeItem.childrenModificationEvent()}
        • *
        + *
      • *
      + *
    • *
    * *

    The indentation shown above signifies the relationship between event types. @@ -220,6 +222,7 @@ * at any point in the tree. * * @param The type of the value contained within the TreeItem. + * @return The base EventType when an event has occurred a within a TreeItem */ @SuppressWarnings("unchecked") public static EventType> treeNotificationEvent() { @@ -237,6 +240,7 @@ * for the three sub-types). * * @param The type of the value contained within the TreeItem. + * @return The general EventType when the TreeItem receives a modification * @since JavaFX 8.0 */ @SuppressWarnings("unchecked") @@ -251,6 +255,7 @@ * expanded property, such that the TreeItem is now in the expanded state. * * @param The type of the value contained within the TreeItem. + * @return The EventType used when the TreeItem receives a modification */ @SuppressWarnings("unchecked") public static EventType> branchExpandedEvent() { @@ -264,6 +269,7 @@ * expanded property, such that the TreeItem is now in the collapsed state. * * @param The type of the value contained within the TreeItem. + * @return The EventType when the TreeItem receives a modification */ @SuppressWarnings("unchecked") public static EventType> branchCollapsedEvent() { @@ -277,6 +283,8 @@ * children list. * * @param The type of the value contained within the TreeItem. + * @return The EventType when the TreeItem receives a direct modification to + * its children list */ @SuppressWarnings("unchecked") public static EventType> childrenModificationEvent() { @@ -290,6 +298,8 @@ * value property. * * @param The type of the value contained within the TreeItem. + * @return The EventType when the TreeItem receives a modification to its + * value property */ @SuppressWarnings("unchecked") public static EventType> valueChangedEvent() { @@ -303,6 +313,8 @@ * graphic property. * * @param The type of the value contained within the TreeItem. + * @return The EventType when the TreeItem receives a modification to its + * graphic property */ @SuppressWarnings("unchecked") public static EventType> graphicChangedEvent() { @@ -425,6 +437,7 @@ /** * Sets the application-specific data represented by this TreeItem. + * @param value the application-specific data */ public final void setValue(T value) { valueProperty().setValue(value); } @@ -437,6 +450,8 @@ /** * A property representing the application-specific data contained within * this TreeItem. + * @return the property representing the application-specific data contained + * within this TreeItem */ public final ObjectProperty valueProperty() { if (value == null) { @@ -480,6 +495,7 @@ /** * The node that is generally shown to the left of the value property. For * best effect, this tends to be a 16x16 image. + * @return The node that is generally shown to the left of the value property */ public final ObjectProperty graphicProperty() { if (graphic == null) { @@ -531,6 +547,7 @@ /** * The expanded state of this TreeItem. + * @return The expanded state property of this TreeItem */ public final BooleanProperty expandedProperty() { if (expanded == null) { @@ -577,11 +594,13 @@ * how a TreeItem may be a leaf, but the general premise is the same: a * leaf can not be expanded by the user, and as such will not show a * disclosure node or respond to expansion requests. + * @return true if this TreeItem has no children */ public boolean isLeaf() { return leaf == null ? true : leaf.getValue(); } /** * Represents the TreeItem leaf property, which is true if the TreeItem has no children. + * @return the TreeItem leaf property */ public final ReadOnlyBooleanProperty leafProperty() { if (leaf == null) { @@ -605,6 +624,7 @@ /** * A property that represents the parent of this TreeItem. + * @return the parent property of this TreeItem */ public final ReadOnlyObjectProperty> parentProperty() { return parent.getReadOnlyProperty(); } @@ -772,6 +792,7 @@ * add relevant observers to the TreeCell instances (via a custom cell factory - * see the {@link Cell} class documentation for more details). * + * @param The event * @param eventType the type of the events to receive by the handler * @param eventHandler the handler to register * @throws NullPointerException if the event type or handler is null @@ -786,6 +807,7 @@ * caller needs to specify the particular event type from which to * unregister the handler. * + * @param The event * @param eventType the event type from which to unregister * @param eventHandler the handler to unregister * @throws NullPointerException if the event type or handler is null @@ -959,6 +981,7 @@ /** * An {@link Event} that contains relevant information for all forms of * TreeItem modifications. + * @param The TreeModificationEvent * @since JavaFX 2.0 */ public static class TreeModificationEvent extends Event { @@ -1155,30 +1178,40 @@ /** * Returns true if this event represents a TreeItem expansion event, * and false if the TreeItem was not expanded. + * @return true if this event represents a TreeItem expansion event, + * and false if the TreeItem was not expanded */ public boolean wasExpanded() { return wasExpanded; } /** * Returns true if this event represents a TreeItem collapse event, * and false if the TreeItem was not collapsed. + * @return true if this event represents a TreeItem collapse event, + * and false if the TreeItem was not collapsed */ public boolean wasCollapsed() { return wasCollapsed; } /** * Returns true if this event represents a TreeItem event where children * TreeItems were added. + * @return true if this event represents a TreeItem event where children + * TreeItems were added */ public boolean wasAdded() { return getAddedSize() > 0; } /** * Returns true if this event represents a TreeItem event where children * TreeItems were removed. + * @return true if this event represents a TreeItem event where children + * TreeItems were removed */ public boolean wasRemoved() { return getRemovedSize() > 0; } /** * Returns true if the order of the TreeItem children list has changed, * but that there have been no additions or removals. + * @return true if the order of the TreeItem children list has changed, + * but that there have been no additions or removals */ public boolean wasPermutated() { return wasPermutated; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableCell.java 2017-03-09 14:44:40.214173955 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableCell.java 2017-03-09 14:44:40.098173953 -0800 @@ -61,8 +61,8 @@ * property is set to true (to represent that it is allowable to select * individual cells (and not just rows of cells)). * - *

    * + * @param The type of the TableView generic type * @see TreeTableView * @see TreeTableColumn * @see Cell @@ -683,9 +683,10 @@ * Updates the TreeTableView associated with this TreeTableCell. This is typically * only done once when the TreeTableCell is first added to the TreeTableView. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param tv the TreeTableView associated with this TreeTableCell */ public final void updateTreeTableView(TreeTableView tv) { setTreeTableView(tv); @@ -694,9 +695,10 @@ /** * Updates the TreeTableRow associated with this TreeTableCell. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param treeTableRow the TreeTableRow associated with this TreeTableCell */ public final void updateTreeTableRow(TreeTableRow treeTableRow) { this.setTreeTableRow(treeTableRow); @@ -705,9 +707,10 @@ /** * Updates the TreeTableColumn associated with this TreeTableCell. * - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. + * @param col the TreeTableColumn associated with this TreeTableCell */ public final void updateTreeTableColumn(TreeTableColumn col) { // remove style class of existing tree table column, if it is non-null --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableColumn.java 2017-03-09 14:44:40.578173962 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableColumn.java 2017-03-09 14:44:40.474173960 -0800 @@ -68,7 +68,6 @@ * {@link #comparatorProperty() comparator}, {@link #sortable sortable} and * {@link #sortTypeProperty() sortType}) * - *

    * * When creating a TreeTableColumn instance, perhaps the two most important properties * to set are the column {@link #textProperty() text} (what to show in the column @@ -136,6 +135,9 @@ /** * Parent event for any TreeTableColumn edit event. + * @param the type of the TableView generic type + * @param the type of the content in all cells in this TableColumn + * @return the edit event */ @SuppressWarnings("unchecked") public static EventType> editAnyEvent() { @@ -149,6 +151,9 @@ * event, or alternatively the * {@link TreeTableView#edit(int, javafx.scene.control.TreeTableColumn)} * method has been called. + * @param the type of the TableView generic type + * @param the type of the content in all cells in this TableColumn + * @return the edit start event */ @SuppressWarnings("unchecked") public static EventType> editStartEvent() { @@ -160,6 +165,9 @@ /** * Indicates that the editing has been canceled, meaning that no change should * be made to the backing data source. + * @param the type of the TableView generic type + * @param the type of the content in all cells in this TableColumn + * @return the edit cancel event */ @SuppressWarnings("unchecked") public static EventType> editCancelEvent() { @@ -172,6 +180,9 @@ * Indicates that the editing has been committed by the user, meaning that * a change should be made to the backing data source to reflect the new * data. + * @param the type of the TableView generic type + * @param the type of the content in all cells in this TableColumn + * @return the edit commit event */ @SuppressWarnings("unchecked") public static EventType> editCommitEvent() { @@ -691,6 +702,7 @@ /** * Returns the value passed in to the constructor. + * @return the value passed in to the constructor */ public TreeItem getValue() { return value; @@ -698,6 +710,7 @@ /** * Returns the {@link TreeTableColumn} passed in to the constructor. + * @return the {@link TreeTableColumn} passed in to the constructor */ public TreeTableColumn getTreeTableColumn() { return tableColumn; @@ -705,6 +718,7 @@ /** * Returns the {@link TableView} passed in to the constructor. + * @return the {@link TableView} passed in to the constructor */ public TreeTableView getTreeTableView() { return treeTableView; @@ -813,6 +827,7 @@ * the TableView {@link TableView#itemsProperty() items} list), for the * row contained within the {@link TablePosition} returned in * {@link #getTreeTablePosition()}. + * @return the row value */ public TreeItem getRowValue() { // List items = getTreeTableView().getItems(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTablePosition.java 2017-03-09 14:44:40.946173968 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTablePosition.java 2017-03-09 14:44:40.842173966 -0800 @@ -111,6 +111,7 @@ /** * The TreeTableView that this TreeTablePosition is related to. + * @return the TreeTableView that this TreeTablePosition is related to */ public final TreeTableView getTreeTableView() { return controlRef.get(); @@ -123,6 +124,7 @@ /** * Returns the {@link TreeItem} that backs the {@link #getRow()} row}. + * @return the {@link TreeItem} that backs the {@link #getRow()} row} */ public final TreeItem getTreeItem() { return treeItemRef.get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableRow.java 2017-03-09 14:44:41.294173974 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableRow.java 2017-03-09 14:44:41.190173972 -0800 @@ -171,12 +171,14 @@ /** * Returns the TreeItem currently set in this TreeCell. + * @return the TreeItem currently set in this TreeCell */ public final TreeItem getTreeItem() { return treeItem.get(); } /** * Each TreeTableCell represents at most a single {@link TreeItem}, which is * represented by this property. + * @return the tree item property */ public final ReadOnlyObjectProperty> treeItemProperty() { return treeItem.getReadOnlyProperty(); } @@ -191,11 +193,13 @@ * an item in the tree which contains child items. If not specified, the * TreeTableCell's Skin implementation is responsible for providing a default * disclosure node. + * @param value the disclosure node */ public final void setDisclosureNode(Node value) { disclosureNodeProperty().set(value); } /** * Returns the current disclosure node set in this TreeTableCell. + * @return the disclosure node */ public final Node getDisclosureNode() { return disclosureNode.get(); } @@ -203,6 +207,7 @@ * The disclosure node is commonly seen represented as a triangle that rotates * on screen to indicate whether or not the TreeItem that it is placed * beside is expanded or collapsed. + * @return the disclosure node property */ public final ObjectProperty disclosureNodeProperty() { return disclosureNode; } @@ -262,12 +267,14 @@ /** * Returns the TreeTableView associated with this TreeTableCell. + * @return the tree table view */ public final TreeTableView getTreeTableView() { return treeTableView.get(); } /** * A TreeTableCell is explicitly linked to a single {@link TreeTableView} instance, * which is represented by this property. + * @return the tree table view property */ public final ReadOnlyObjectProperty> treeTableViewProperty() { return treeTableView.getReadOnlyProperty(); } @@ -476,7 +483,7 @@ * * @param treeTable The new TreeTableView that should be associated with this * TreeTableCell. - * @expert This function is intended to be used by experts, primarily + * Note: This function is intended to be used by experts, primarily * by those implementing new Skins. It is not common * for developers or designers to access this function directly. */ @@ -489,9 +496,9 @@ * * @param treeItem The new TreeItem that should be associated with this * TreeTableCell. - * @expert This function is intended to be used by experts, primarily - * by those implementing new Skins. It is not common - * for developers or designers to access this function directly. + * Note: This function is intended to be used by experts, primarily + * by those implementing new Skins. It is not common + * for developers or designers to access this function directly. */ public final void updateTreeItem(TreeItem treeItem) { TreeItem _treeItem = getTreeItem(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableView.java 2017-03-09 14:44:41.658173981 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeTableView.java 2017-03-09 14:44:41.554173979 -0800 @@ -129,7 +129,6 @@ * the column header (hold down Shift keyboard key whilst clicking on a * header to sort by multiple columns). * - *

    * *

    Creating a TreeTableView

    * @@ -420,7 +419,8 @@ * type of all other edit events: {@link #editStartEvent}, * {@link #editCommitEvent} and {@link #editCancelEvent}. * - * @return An EventType that indicates some edit event has occurred. + * @param The type of the TreeItem instances used in this TreeTableView + * @return An EventType that indicates some edit event has occurred */ @SuppressWarnings("unchecked") public static EventType> editAnyEvent() { @@ -433,7 +433,8 @@ * An EventType used to indicate that an edit event has started within the * TreeTableView upon which the event was fired. * - * @return An EventType used to indicate that an edit event has started. + * @param The type of the TreeItem instances used in this TreeTableView + * @return An EventType used to indicate that an edit event has started */ @SuppressWarnings("unchecked") public static EventType> editStartEvent() { @@ -446,8 +447,9 @@ * An EventType used to indicate that an edit event has just been canceled * within the TreeTableView upon which the event was fired. * + * @param The type of the TreeItem instances used in this TreeTableView * @return An EventType used to indicate that an edit event has just been - * canceled. + * canceled */ @SuppressWarnings("unchecked") public static EventType> editCancelEvent() { @@ -461,8 +463,9 @@ * committed. This means that user has made changes to the data of a * TreeItem, and that the UI should be updated. * + * @param The type of the TreeItem instances used in this TreeTableView * @return An EventType that is used to indicate that an edit in a TreeTableView - * has been committed. + * has been committed */ @SuppressWarnings("unchecked") public static EventType> editCommitEvent() { @@ -937,6 +940,7 @@ /** * Property representing the root node of the TreeTableView. + * @return the root property */ public final ObjectProperty> rootProperty() { return root; @@ -961,6 +965,7 @@ /** * Returns true if the root of the TreeTableView should be shown, and false if * it should not. By default, the root TreeItem is visible in the TreeTableView. + * @return true if the root of the TreeTableView should be shown */ public final boolean isShowRoot() { return showRoot == null ? true : showRoot.get(); @@ -968,6 +973,7 @@ /** * Property that represents whether or not the TreeTableView root node is visible. + * @return the show root property */ public final BooleanProperty showRootProperty() { if (showRoot == null) { @@ -991,6 +997,7 @@ * the left-most column if this property is null, otherwise it will be the * specified column assuming it is non-null and contained within the * {@link #getVisibleLeafColumns() visible leaf columns} list. + * @return the tree column property */ public final ObjectProperty> treeColumnProperty() { if (treeColumn == null) { @@ -1016,6 +1023,7 @@ * it is possible to configure it to only allow single selection (see * {@link MultipleSelectionModel#setSelectionMode(javafx.scene.control.SelectionMode)} * for more information). + * @param value the {@link MultipleSelectionModel} to be used */ public final void setSelectionModel(TreeTableViewSelectionModel value) { selectionModelProperty().set(value); @@ -1023,6 +1031,7 @@ /** * Returns the currently installed selection model. + * @return the currently installed selection model */ public final TreeTableViewSelectionModel getSelectionModel() { return selectionModel == null ? null : selectionModel.get(); @@ -1033,6 +1042,7 @@ * to select single or multiple items within a TreeTableView, as well as inspect * which rows have been selected by the user. Note that it has a generic * type that must match the type of the TreeTableView itself. + * @return the selection model property */ public final ObjectProperty> selectionModelProperty() { if (selectionModel == null) { @@ -1070,6 +1080,7 @@ /** * Sets the {@link FocusModel} to be used in the TreeTableView. + * @param value the {@link FocusModel} to be used */ public final void setFocusModel(TreeTableViewFocusModel value) { focusModelProperty().set(value); @@ -1077,6 +1088,7 @@ /** * Returns the currently installed {@link FocusModel}. + * @return the currently installed {@link FocusModel} */ public final TreeTableViewFocusModel getFocusModel() { return focusModel == null ? null : focusModel.get(); @@ -1086,6 +1098,7 @@ * The FocusModel provides the API through which it is possible * to control focus on zero or one rows of the TreeTableView. Generally the * default implementation should be more than sufficient. + * @return the focus model property */ public final ObjectProperty> focusModelProperty() { if (focusModel == null) { @@ -1132,6 +1145,7 @@ * Specifies whether this TreeTableView is editable - only if the TreeTableView and * the TreeCells within it are both editable will a TreeCell be able to go * into their editing state. + * @return the editable property */ public final BooleanProperty editableProperty() { if (editable == null) { @@ -1153,6 +1167,7 @@ /** * Represents the current cell being edited, or null if * there is no cell being edited. + * @return the editing cell property */ public final ReadOnlyObjectProperty> editingCellProperty() { return editingCellPropertyImpl().getReadOnlyProperty(); @@ -1173,6 +1188,7 @@ * in a designated space within the TableView, within which is a radio menu * item for each TreeTableColumn in this table. This menu allows for the user to * show and hide all TreeTableColumns easily. + * @return the table menu button visible property */ public final BooleanProperty tableMenuButtonVisibleProperty() { if (tableMenuButtonVisible == null) { @@ -1202,6 +1218,7 @@ * operation. The two most common policies are available as static functions * in the TableView class: {@link #UNCONSTRAINED_RESIZE_POLICY} and * {@link #CONSTRAINED_RESIZE_POLICY}. + * @return the column resize policy property */ public final ObjectProperty> columnResizePolicyProperty() { if (columnResizePolicy == null) { @@ -1246,6 +1263,7 @@ *

    * You can create custom TableCell instances per column by assigning the * appropriate function to the cellFactory property in the TreeTableColumn class. + * @return the row factory property */ public final ObjectProperty, TreeTableRow>> rowFactoryProperty() { if (rowFactory == null) { @@ -1269,6 +1287,7 @@ * place, that a filter has been applied to the table model, resulting * in there being nothing to show the user, or that there are no currently * visible columns. + * @return the placeholder property */ public final ObjectProperty placeholderProperty() { if (placeholder == null) { @@ -1332,6 +1351,7 @@ * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are * specified in CSS, -fx-fixed-cell-size takes precedence.

    * + * @return the fixed cell size property * @since JavaFX 8.0 */ public final DoubleProperty fixedCellSizeProperty() { @@ -1683,6 +1703,7 @@ * *

    Note: to display any data in a TableView, there must be at least one * TreeTableColumn in this ObservableList.

    + * @return the table table column */ public final ObservableList> getColumns() { return columns; @@ -1712,6 +1733,9 @@ /** * Applies the currently installed resize policy against the given column, * resizing it based on the delta value provided. + * @param column the column + * @param delta the delta + * @return true if column resizing is applied */ public boolean resizeColumn(TreeTableColumn column, double delta) { if (column == null || Double.compare(delta, 0.0) == 0) return false; @@ -1725,6 +1749,8 @@ * Causes the cell at the given row/column view indexes to switch into * its editing state, if it is not already in it, and assuming that the * TableView and column are also editable. + * @param row the row + * @param column the column */ public void edit(int row, TreeTableColumn column) { if (!isEditable() || (column != null && ! column.isEditable())) { @@ -1740,6 +1766,7 @@ /** * Returns an unmodifiable list containing the currently visible leaf columns. + * @return an unmodifiable list containing the currently visible leaf columns */ public ObservableList> getVisibleLeafColumns() { return unmodifiableVisibleLeafColumns; @@ -1748,6 +1775,9 @@ /** * Returns the position of the given column, relative to all other * visible leaf columns. + * @param column the column + * @return the position of the given column, relative to all other + * visible leaf columns */ public int getVisibleLeafIndex(TreeTableColumn column) { return getVisibleLeafColumns().indexOf(column); @@ -1756,6 +1786,9 @@ /** * Returns the TreeTableColumn in the given column index, relative to all other * visible leaf columns. + * @param column the column + * @return the TreeTableColumn in the given column index, relative to all other + * visible leaf columns */ public TreeTableColumn getVisibleLeafColumn(int column) { if (column < 0 || column >= visibleLeafColumns.size()) return null; @@ -2102,6 +2135,7 @@ /** * Returns the TreeTableView upon which the resize operation is occurring. + * @return the TreeTableView upon which the resize operation is occurring */ public TreeTableView getTable() { return treeTable; } } @@ -2135,6 +2169,11 @@ * Creates a new EditEvent instance to represent an edit event. This * event is used for {@link #EDIT_START_EVENT}, * {@link #EDIT_COMMIT_EVENT} and {@link #EDIT_CANCEL_EVENT} types. + * @param source the source + * @param eventType the eventType + * @param treeItem the treeItem + * @param oldValue the oldValue + * @param newValue the newValue */ public EditEvent(TreeTableView source, EventType eventType, @@ -2148,6 +2187,7 @@ /** * Returns the TreeTableView upon which the edit took place. + * @return the TreeTableView upon which the edit took place */ @Override public TreeTableView getSource() { return source; @@ -2155,6 +2195,7 @@ /** * Returns the {@link TreeItem} upon which the edit took place. + * @return the {@link TreeItem} upon which the edit took place */ public TreeItem getTreeItem() { return treeItem; @@ -2162,6 +2203,7 @@ /** * Returns the new value input into the TreeItem by the end user. + * @return the new value input into the TreeItem by the end user */ public S getNewValue() { return newValue; @@ -2170,6 +2212,8 @@ /** * Returns the old value that existed in the TreeItem prior to the current * edit event. + * @return the old value that existed in the TreeItem prior to the current + * edit event */ public S getOldValue() { return oldValue; @@ -2229,6 +2273,7 @@ * A read-only ObservableList representing the currently selected cells * in this TreeTableView. Rather than directly modify this list, please * use the other methods provided in the TreeTableViewSelectionModel. + * @return a list of selected cells */ public abstract ObservableList> getSelectedCells(); @@ -2242,6 +2287,7 @@ /** * Returns the TreeTableView instance that this selection model is installed in. + * @return the TreeTableView instance that this selection model is installed in */ public TreeTableView getTreeTableView() { return treeTableView; @@ -3560,7 +3606,7 @@ * Causes the item at the given index to receive the focus. This does not * cause the current selection to change. Updates the focusedItem and * focusedIndex properties such that focusedIndex = -1 unless - *
    0 <= index < model size
    . + *
    0 <= index < model size
    . * * @param index The index of the item to get focus. */ --- old/modules/javafx.controls/src/main/java/javafx/scene/control/TreeView.java 2017-03-09 14:44:42.054173988 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/TreeView.java 2017-03-09 14:44:41.954173986 -0800 @@ -209,6 +209,7 @@ * type of all other edit events: {@link #editStartEvent}, * {@link #editCommitEvent} and {@link #editCancelEvent}. * + * @param the type of edit event * @return An EventType that indicates some edit event has occurred. */ @SuppressWarnings("unchecked") @@ -222,6 +223,7 @@ * An EventType used to indicate that an edit event has started within the * TreeView upon which the event was fired. * + * @param the type of edit event * @return An EventType used to indicate that an edit event has started. */ @SuppressWarnings("unchecked") @@ -235,6 +237,7 @@ * An EventType used to indicate that an edit event has just been canceled * within the TreeView upon which the event was fired. * + * @param the type of edit event * @return An EventType used to indicate that an edit event has just been * canceled. */ @@ -250,6 +253,7 @@ * committed. This means that user has made changes to the data of a * TreeItem, and that the UI should be updated. * + * @param the type of edit event * @return An EventType that is used to indicate that an edit in a TreeView * has been committed. */ @@ -416,6 +420,7 @@ *

    Returns the cell factory that will be used for creating TreeCells, * which are used to represent items in the TreeView, or null if no custom * cell factory has been set. + * @return the cell factory */ public final Callback, TreeCell> getCellFactory() { return cellFactory == null ? null : cellFactory.get(); @@ -424,6 +429,7 @@ /** * Represents the cell factory that will be used for creating TreeCells, * which are used to represent items in the TreeView. + * @return the cell factory property */ public final ObjectProperty, TreeCell>> cellFactoryProperty() { if (cellFactory == null) { @@ -480,6 +486,7 @@ /** * Property representing the root node of the TreeView. + * @return the root node property */ public final ObjectProperty> rootProperty() { return root; @@ -504,6 +511,7 @@ /** * Returns true if the root of the TreeView should be shown, and false if * it should not. By default, the root TreeItem is visible in the TreeView. + * @return true if the root of the TreeView should be shown */ public final boolean isShowRoot() { return showRoot == null ? true : showRoot.get(); @@ -511,6 +519,7 @@ /** * Property that represents whether or not the TreeView root node is visible. + * @return the show root property */ public final BooleanProperty showRootProperty() { if (showRoot == null) { @@ -534,6 +543,7 @@ * it is possible to configure it to only allow single selection (see * {@link MultipleSelectionModel#setSelectionMode(javafx.scene.control.SelectionMode)} * for more information). + * @param value the {@link MultipleSelectionModel} to be used */ public final void setSelectionModel(MultipleSelectionModel> value) { selectionModelProperty().set(value); @@ -541,6 +551,7 @@ /** * Returns the currently installed selection model. + * @return the currently installed selection model */ public final MultipleSelectionModel> getSelectionModel() { return selectionModel == null ? null : selectionModel.get(); @@ -551,6 +562,7 @@ * to select single or multiple items within a TreeView, as well as inspect * which rows have been selected by the user. Note that it has a generic * type that must match the type of the TreeView itself. + * @return the selection model property */ public final ObjectProperty>> selectionModelProperty() { if (selectionModel == null) { @@ -565,6 +577,7 @@ /** * Sets the {@link FocusModel} to be used in the TreeView. + * @param value the {@link FocusModel} to be used */ public final void setFocusModel(FocusModel> value) { focusModelProperty().set(value); @@ -572,6 +585,7 @@ /** * Returns the currently installed {@link FocusModel}. + * @return the currently installed {@link FocusModel} */ public final FocusModel> getFocusModel() { return focusModel == null ? null : focusModel.get(); @@ -581,6 +595,7 @@ * The FocusModel provides the API through which it is possible * to control focus on zero or one rows of the TreeView. Generally the * default implementation should be more than sufficient. + * @return the focus model property */ public final ObjectProperty>> focusModelProperty() { if (focusModel == null) { @@ -664,6 +679,7 @@ * use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are * specified in CSS, -fx-fixed-cell-size takes precedence.

    * + * @return the fixed cell size property * @since JavaFX 8.0 */ public final DoubleProperty fixedCellSizeProperty() { @@ -698,6 +714,7 @@ * Specifies whether this TreeView is editable - only if the TreeView and * the TreeCells within it are both editable will a TreeCell be able to go * into their editing state. + * @return the editable property */ public final BooleanProperty editableProperty() { if (editable == null) { @@ -717,6 +734,7 @@ /** * Returns the TreeItem that is currently being edited in the TreeView, * or null if no item is being edited. + * @return the TreeItem that is currently being edited in the TreeView */ public final TreeItem getEditingItem() { return editingItem == null ? null : editingItem.get(); @@ -728,6 +746,7 @@ * *

    It is not possible to set the editing item, instead it is required that * you call {@link #edit(javafx.scene.control.TreeItem)}. + * @return the editing item property */ public final ReadOnlyObjectProperty> editingItemProperty() { return editingItemPropertyImpl().getReadOnlyProperty(); @@ -747,6 +766,8 @@ /** * Sets the {@link EventHandler} that will be called when the user begins * an edit. + * @param value the {@link EventHandler} that will be called when the user + * begins an edit */ public final void setOnEditStart(EventHandler> value) { onEditStartProperty().set(value); @@ -755,6 +776,7 @@ /** * Returns the {@link EventHandler} that will be called when the user begins * an edit. + * @return the {@link EventHandler} when the user begins an edit */ public final EventHandler> getOnEditStart() { return onEditStart == null ? null : onEditStart.get(); @@ -763,6 +785,7 @@ /** * This event handler will be fired when the user successfully initiates * editing. + * @return the event handler when the user successfully initiates editing */ public final ObjectProperty>> onEditStartProperty() { if (onEditStart == null) { @@ -782,6 +805,8 @@ /** * Sets the {@link EventHandler} that will be called when the user commits * an edit. + * @param value the {@link EventHandler} that will be called when the user + * commits an edit */ public final void setOnEditCommit(EventHandler> value) { onEditCommitProperty().set(value); @@ -790,6 +815,8 @@ /** * Returns the {@link EventHandler} that will be called when the user commits * an edit. + * @return the {@link EventHandler} that will be called when the user commits + * an edit */ public final EventHandler> getOnEditCommit() { return onEditCommit == null ? null : onEditCommit.get(); @@ -803,6 +830,8 @@ * instead call {@link TreeCell#commitEdit(java.lang.Object)} from within * your custom TreeCell. This will handle firing this event, updating the * view, and switching out of the editing state.

    + * @return the event handler when the user performs an action that result in + * their editing input being persisted */ public final ObjectProperty>> onEditCommitProperty() { if (onEditCommit == null) { @@ -822,6 +851,8 @@ /** * Sets the {@link EventHandler} that will be called when the user cancels * an edit. + * @param value the {@link EventHandler} that will be called when the user + * cancels an edit */ public final void setOnEditCancel(EventHandler> value) { onEditCancelProperty().set(value); @@ -830,6 +861,8 @@ /** * Returns the {@link EventHandler} that will be called when the user cancels * an edit. + * @return the {@link EventHandler} that will be called when the user cancels + * an edit */ public final EventHandler> getOnEditCancel() { return onEditCancel == null ? null : onEditCancel.get(); @@ -837,6 +870,8 @@ /** * This event handler will be fired when the user cancels editing a cell. + * @return the event handler will be fired when the user cancels editing a + * cell */ public final ObjectProperty>> onEditCancelProperty() { if (onEditCancel == null) { @@ -1178,6 +1213,11 @@ * Creates a new EditEvent instance to represent an edit event. This * event is used for {@link #EDIT_START_EVENT}, * {@link #EDIT_COMMIT_EVENT} and {@link #EDIT_CANCEL_EVENT} types. + * @param source the source + * @param eventType the eventType + * @param treeItem the treeItem + * @param oldValue the oldValue + * @param newValue the newValue */ public EditEvent(TreeView source, EventType eventType, @@ -1198,6 +1238,7 @@ /** * Returns the {@link TreeItem} upon which the edit took place. + * @return the {@link TreeItem} upon which the edit took place */ public TreeItem getTreeItem() { return treeItem; @@ -1205,6 +1246,7 @@ /** * Returns the new value input into the TreeItem by the end user. + * @return the new value input into the TreeItem by the end user */ public T getNewValue() { return newValue; @@ -1213,6 +1255,8 @@ /** * Returns the old value that existed in the TreeItem prior to the current * edit event. + * @return the old value that existed in the TreeItem prior to the current + * edit event */ public T getOldValue() { return oldValue; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxListCell.java 2017-03-09 14:44:42.442173995 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxListCell.java 2017-03-09 14:44:42.326173993 -0800 @@ -52,7 +52,7 @@ * selected or not. This ObservableValue will be bound bidirectionally (meaning * 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). + * {@code ObservableValue}, if it changes externally). * *

    Note that the CheckBoxListCell renders the CheckBox 'live', meaning that * the CheckBox is always interactive and can be directly toggled by the user. @@ -201,6 +201,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -208,6 +209,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -215,6 +217,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -230,6 +233,8 @@ /** * Property representing the {@link Callback} that is bound to by the * CheckBox shown on screen. + * @return the {@link Callback} that is bound to by the CheckBox shown on + * screen */ public final ObjectProperty>> selectedStateCallbackProperty() { return selectedStateCallback; @@ -237,6 +242,7 @@ /** * Sets the {@link Callback} that is bound to by the CheckBox shown on screen. + * @param value the {@link Callback} */ public final void setSelectedStateCallback(Callback> value) { selectedStateCallbackProperty().set(value); @@ -244,6 +250,7 @@ /** * Returns the {@link Callback} that is bound to by the CheckBox shown on screen. + * @return the {@link Callback} that is bound to by the CheckBox shown on screen */ public final Callback> getSelectedStateCallback() { return selectedStateCallbackProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxTableCell.java 2017-03-09 14:44:42.806174001 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxTableCell.java 2017-03-09 14:44:42.702173999 -0800 @@ -89,6 +89,8 @@ * CheckBox will reflect the state of the {@code ObservableValue}, * if it changes externally). * + * @param The type of the TableView generic type + * @param column The TableColumn of type Boolean * @return A {@link Callback} that will return a {@link TableCell} that is * able to work on the type of element contained within the TableColumn. */ @@ -105,6 +107,7 @@ *

    When used in a TableColumn, the CheckBoxCell is rendered with a * CheckBox centered in the column. * + * @param The type of the TableView generic type * @param The type of the elements contained within the {@link TableColumn} * instance. * @param getSelectedProperty A Callback that, given an object of @@ -131,6 +134,7 @@ *

    When used in a TableColumn, the CheckBoxCell is rendered with a * CheckBox centered in the column. * + * @param The type of the TableView generic type * @param The type of the elements contained within the {@link TableColumn} * instance. * @param getSelectedProperty A Callback that, given an object of @@ -168,6 +172,7 @@ *

    When used in a TableColumn, the CheckBoxCell is rendered with a * CheckBox centered in the column. * + * @param The type of the TableView generic type * @param The type of the elements contained within the {@link TableColumn} * instance. * @param getSelectedProperty A Callback that, given an object of type @@ -283,6 +288,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -290,6 +296,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -297,6 +304,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -313,6 +321,8 @@ /** * Property representing the {@link Callback} that is bound to by the * CheckBox shown on screen. + * @return the property representing the {@link Callback} that is bound to + * by the CheckBox shown on screen */ public final ObjectProperty>> selectedStateCallbackProperty() { return selectedStateCallback; @@ -320,6 +330,8 @@ /** * Sets the {@link Callback} that is bound to by the CheckBox shown on screen. + * @param value the {@link Callback} that is bound to by the CheckBox shown + * on screen */ public final void setSelectedStateCallback(Callback> value) { selectedStateCallbackProperty().set(value); @@ -327,6 +339,7 @@ /** * Returns the {@link Callback} that is bound to by the CheckBox shown on screen. + * @return the {@link Callback} that is bound to by the CheckBox shown on screen */ public final Callback> getSelectedStateCallback() { return selectedStateCallbackProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeCell.java 2017-03-09 14:44:43.162174007 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeCell.java 2017-03-09 14:44:43.058174005 -0800 @@ -166,7 +166,7 @@ * @param The type of the elements contained within the {@link TreeItem} * instances. * @param getSelectedProperty A {@link Callback} that, given an object of - * type TreeItem, will return an {@code ObservableValue} + * type {@literal TreeItem}, will return an {@code ObservableValue} * that represents whether the given item is selected or not. This * {@code ObservableValue} will be bound bidirectionally * (meaning that the CheckBox in the cell will set/unset this property @@ -202,15 +202,15 @@ * @param The type of the elements contained within the {@link TreeItem} * instances. * @param getSelectedProperty A Callback that, given an object of - * type TreeItem, will return an {@code ObservableValue} + * type {@literal TreeItem}, will return an {@code ObservableValue} * that represents whether the given item is selected or not. This * {@code ObservableValue} will be bound bidirectionally * (meaning that the CheckBox in the cell will set/unset this property * based on user interactions, and the CheckBox will reflect the state of * the {@code ObservableValue}, if it changes externally). - * @param converter A StringConverter that, give an object of type TreeItem, - * will return a String that can be used to represent the object - * visually. The default implementation in {@link #forTreeView(Callback)} + * @param converter A StringConverter that, give an object of type + * {@literal TreeItem}, will return a String that can be used to represent the + * object visually. The default implementation in {@link #forTreeView(Callback)} * is to simply call .toString() on all non-null items (and to just * return an empty string in cases where the given item is null). * @return A {@link Callback} that will return a TreeCell that is able to @@ -270,7 +270,7 @@ * {@link CheckBoxTreeItem}. * *

    To call this method, it is necessary to provide a - * {@link Callback} that, given an object of type TreeItem, will return + * {@link Callback} that, given an object of type {@literal TreeItem}, will return * an {@code ObservableValue} that represents whether the given * item is selected or not. This {@code ObservableValue} will be * bound bidirectionally (meaning that the CheckBox in the cell will @@ -302,7 +302,7 @@ * {@link CheckBoxTreeItem}. * *

    To call this method, it is necessary to provide a {@link Callback} - * that, given an object of type TreeItem, will return an + * that, given an object of type {@literal TreeItem}, will return an * {@code ObservableValue} that represents whether the given item * is selected or not. This {@code ObservableValue} will be bound * bidirectionally (meaning that the CheckBox in the cell will set/unset @@ -321,8 +321,9 @@ * @param getSelectedProperty A {@link Callback} that will return an * {@code ObservableValue} that represents whether the given * item is selected or not. - * @param converter A StringConverter that, give an object of type TreeItem, will - * return a String that can be used to represent the object visually. + * @param converter {@literal A StringConverter that, give an object of type + * TreeItem, will return a String that can be used to represent the + * object visually.} */ public CheckBoxTreeCell( final Callback, ObservableValue> getSelectedProperty, @@ -359,6 +360,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty>> converterProperty() { return converter; @@ -366,6 +368,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter> value) { converterProperty().set(value); @@ -373,6 +376,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter> getConverter() { return converterProperty().get(); @@ -389,6 +393,8 @@ /** * Property representing the {@link Callback} that is bound to by the * CheckBox shown on screen. + * @return the property representing the {@link Callback} that is bound to + * by the CheckBox shown on screen */ public final ObjectProperty, ObservableValue>> selectedStateCallbackProperty() { return selectedStateCallback; @@ -396,6 +402,7 @@ /** * Sets the {@link Callback} that is bound to by the CheckBox shown on screen. + * @param value the {@link Callback} that is bound to by the CheckBox shown on screen */ public final void setSelectedStateCallback(Callback, ObservableValue> value) { selectedStateCallbackProperty().set(value); @@ -403,6 +410,7 @@ /** * Returns the {@link Callback} that is bound to by the CheckBox shown on screen. + * @return the {@link Callback} that is bound to by the CheckBox shown on screen */ public final Callback, ObservableValue> getSelectedStateCallback() { return selectedStateCallbackProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeTableCell.java 2017-03-09 14:44:43.518174014 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/CheckBoxTreeTableCell.java 2017-03-09 14:44:43.414174012 -0800 @@ -65,6 +65,7 @@ * it is recommended to directly observe the boolean properties that are * manipulated by the CheckBox.

    * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @since JavaFX 8.0 */ @@ -89,6 +90,8 @@ * CheckBox will reflect the state of the {@code ObservableValue}, * if it changes externally). * + * @param The type of the TableView generic type + * @param column the TreeTableColumn of type {@link Boolean} * @return A {@link Callback} that will return a {@link TreeTableCell} that is * able to work on the type of element contained within the TreeTableColumn. */ @@ -105,6 +108,7 @@ *

    When used in a TreeTableColumn, the CheckBoxCell is rendered with a * CheckBox centered in the column. * + * @param The type of the TableView generic type * @param The type of the elements contained within the {@link TreeTableColumn} * instance. * @param getSelectedProperty A Callback that, given an object of @@ -131,6 +135,7 @@ *

    When used in a TreeTableColumn, the CheckBoxCell is rendered with a * CheckBox centered in the column. * + * @param The type of the TableView generic type * @param The type of the elements contained within the {@link TreeTableColumn} * instance. * @param getSelectedProperty A Callback that, given an object of @@ -168,6 +173,7 @@ *

    When used in a TreeTableColumn, the CheckBoxCell is rendered with a * CheckBox centered in the column. * + * @param The type of the TableView generic type * @param The type of the elements contained within the {@link TreeTableColumn} * instance. * @param getSelectedProperty A Callback that, given an object of type @@ -281,6 +287,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -288,6 +295,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -295,6 +303,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -311,6 +320,8 @@ /** * Property representing the {@link Callback} that is bound to by the * CheckBox shown on screen. + * @return the property representing the {@link Callback} that is bound to + * by the CheckBox shown on screen */ public final ObjectProperty>> selectedStateCallbackProperty() { return selectedStateCallback; @@ -318,6 +329,8 @@ /** * Sets the {@link Callback} that is bound to by the CheckBox shown on screen. + * @param value the {@link Callback} that is bound to by the CheckBox shown + * on screen */ public final void setSelectedStateCallback(Callback> value) { selectedStateCallbackProperty().set(value); @@ -325,6 +338,8 @@ /** * Returns the {@link Callback} that is bound to by the CheckBox shown on screen. + * @return the {@link Callback} that is bound to by the CheckBox shown on + * screen */ public final Callback> getSelectedStateCallback() { return selectedStateCallbackProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxListCell.java 2017-03-09 14:44:43.886174020 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxListCell.java 2017-03-09 14:44:43.786174018 -0800 @@ -248,6 +248,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -255,6 +256,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -262,6 +264,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -277,6 +280,7 @@ /** * Returns the items to be displayed in the ChoiceBox when it is showing. + * @return the items to be displayed in the ChoiceBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTableCell.java 2017-03-09 14:44:44.238174026 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTableCell.java 2017-03-09 14:44:44.134174025 -0800 @@ -50,6 +50,7 @@ * items that will be shown to the user when the {@link ChoiceBox} menu is * showing. These items must be of the same type as the TableColumn. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @since JavaFX 2.2 */ @@ -67,6 +68,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ChoiceBox} menu is showing. These items must be of the same @@ -90,6 +92,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox * will, by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param converter A {@link StringConverter} to convert the given item (of type T) * to a String for displaying to the user. @@ -117,6 +120,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ChoiceBox} menu is showing. These items must be of the same @@ -140,6 +144,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param converter A {@link StringConverter} to convert the given item (of type T) * to a String for displaying to the user. @@ -258,6 +263,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -265,6 +271,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -272,6 +279,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -287,6 +295,7 @@ /** * Returns the items to be displayed in the ChoiceBox when it is showing. + * @return the items to be displayed in the ChoiceBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTreeCell.java 2017-03-09 14:44:44.586174033 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTreeCell.java 2017-03-09 14:44:44.482174031 -0800 @@ -70,7 +70,7 @@ * @param The type of the elements contained within the TreeView. * @param items Zero or more items that will be shown to the user when the * {@link ChoiceBox} menu is showing. These items must be of the same - * type as the TreeView, such that upon selection, they replace the + * type as the {@literal TreeView}, such that upon selection, they replace the * existing value in the TreeItem {@link TreeItem#valueProperty() value} * property. * @return A {@link Callback} that will return a TreeCell that is able to @@ -116,7 +116,7 @@ * to a String for displaying to the user. * @param items Zero or more items that will be shown to the user when the * {@link ChoiceBox} menu is showing. These items must be of the same - * type as the TreeView, such that upon selection, they replace the + * type as the {@literal TreeView}, such that upon selection, they replace the * existing value in the TreeItem {@link TreeItem#valueProperty() value} * property. * @return A {@link Callback} that will return a TreeCell that is able to @@ -254,6 +254,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -261,6 +262,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -268,6 +270,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -283,6 +286,7 @@ /** * Returns the items to be displayed in the ChoiceBox when it is showing. + * @return the items to be displayed in the ChoiceBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTreeTableCell.java 2017-03-09 14:44:44.946174039 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ChoiceBoxTreeTableCell.java 2017-03-09 14:44:44.842174037 -0800 @@ -50,6 +50,7 @@ * items that will be shown to the user when the {@link ChoiceBox} menu is * showing. These items must be of the same type as the TreeTableColumn. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @since JavaFX 8.0 */ @@ -67,6 +68,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ChoiceBox} menu is showing. These items must be of the same @@ -90,6 +92,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox * will, by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param converter A {@link StringConverter} to convert the given item (of type T) * to a String for displaying to the user. @@ -117,6 +120,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ChoiceBox} menu is showing. These items must be of the same @@ -140,6 +144,7 @@ * being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param converter A {@link StringConverter} to convert the given item (of type T) * to a String for displaying to the user. @@ -258,6 +263,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -265,6 +271,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -272,6 +279,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -287,6 +295,7 @@ /** * Returns the items to be displayed in the ChoiceBox when it is showing. + * @return the items to be displayed in the ChoiceBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxListCell.java 2017-03-09 14:44:45.314174045 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxListCell.java 2017-03-09 14:44:45.190174043 -0800 @@ -247,6 +247,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -254,6 +255,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -261,6 +263,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -274,6 +277,8 @@ /** * A property representing whether the ComboBox, when shown to the user, * is editable or not. + * @return the property representing whether the ComboBox, when shown to + * the user, is editable or not */ public final BooleanProperty comboBoxEditableProperty() { return comboBoxEditable; @@ -282,6 +287,7 @@ /** * Configures the ComboBox to be editable (to allow user input outside of the * options provide in the dropdown list). + * @param value the editable value for this ComboBox */ public final void setComboBoxEditable(boolean value) { comboBoxEditableProperty().set(value); @@ -289,6 +295,7 @@ /** * Returns true if the ComboBox is editable. + * @return true if the ComboBox is editable */ public final boolean isComboBoxEditable() { return comboBoxEditableProperty().get(); @@ -304,6 +311,7 @@ /** * Returns the items to be displayed in the ChoiceBox when it is showing. + * @return the items to be displayed in the ChoiceBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxTableCell.java 2017-03-09 14:44:45.674174052 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxTableCell.java 2017-03-09 14:44:45.570174050 -0800 @@ -52,6 +52,7 @@ * items that will be shown to the user when the {@link ComboBox} menu is * showing. These items must be of the same type as the TableColumn. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @since JavaFX 2.2 */ @@ -69,6 +70,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ComboBox} menu is showing. These items must be of the same @@ -93,6 +95,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param converter A {@link StringConverter} to convert the given item (of * type T) to a String for displaying to the user. @@ -120,6 +123,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ComboBox} menu is showing. These items must be of the same @@ -143,6 +147,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @param converter A {@link StringConverter} to convert the given item (of * type T) to a String for displaying to the user. @@ -262,6 +267,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -269,6 +275,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -276,6 +283,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -289,6 +297,8 @@ /** * A property representing whether the ComboBox, when shown to the user, * is editable or not. + * @return the property representing whether the ComboBox, when shown to the + * user, is editable or not */ public final BooleanProperty comboBoxEditableProperty() { return comboBoxEditable; @@ -297,6 +307,7 @@ /** * Configures the ComboBox to be editable (to allow user input outside of the * options provide in the dropdown list). + * @param value the editable value to be set for this ComboBox */ public final void setComboBoxEditable(boolean value) { comboBoxEditableProperty().set(value); @@ -304,6 +315,7 @@ /** * Returns true if the ComboBox is editable. + * @return true if the ComboBox is editable */ public final boolean isComboBoxEditable() { return comboBoxEditableProperty().get(); @@ -318,7 +330,8 @@ **************************************************************************/ /** - * Returns the items to be displayed in the ChoiceBox when it is showing. + * Returns the items to be displayed in the ComboBox when it is showing. + * @return the items to be displayed in this ComboBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxTreeCell.java 2017-03-09 14:44:46.030174058 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxTreeCell.java 2017-03-09 14:44:45.930174056 -0800 @@ -72,7 +72,7 @@ * @param The type of the elements contained within the TreeView. * @param items Zero or more items that will be shown to the user when the * {@link ComboBox} menu is showing. These items must be of the same - * type as the TreeView, such that upon selection, they replace the + * type as the {@literal TreeView}, such that upon selection, they replace the * existing value in the TreeItem {@link TreeItem#valueProperty() value} * property. * @return A {@link Callback} that will return a TreeCell that is able to @@ -117,7 +117,7 @@ * type T) to a String for displaying to the user. * @param items Zero or more items that will be shown to the user when the * {@link ComboBox} menu is showing. These items must be of the same - * type as the TreeView, such that upon selection, they replace the + * type as the {@literal TreeView}, such that upon selection, they replace the * existing value in the TreeItem {@link TreeItem#valueProperty() value} * property. * @return A {@link Callback} that will return a TreeCell that is able to @@ -253,6 +253,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -260,6 +261,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -267,6 +269,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); @@ -280,6 +283,8 @@ /** * A property representing whether the ComboBox, when shown to the user, * is editable or not. + * @return the property representing whether the ComboBox, when shown to the + * user, is editable or not */ public final BooleanProperty comboBoxEditableProperty() { return comboBoxEditable; @@ -288,6 +293,7 @@ /** * Configures the ComboBox to be editable (to allow user input outside of the * options provide in the dropdown list). + * @param value the editable value to be set for this ComboBox */ public final void setComboBoxEditable(boolean value) { comboBoxEditableProperty().set(value); @@ -295,6 +301,7 @@ /** * Returns true if the ComboBox is editable. + * @return true if the ComboBox is editable */ public final boolean isComboBoxEditable() { return comboBoxEditableProperty().get(); @@ -309,7 +316,8 @@ **************************************************************************/ /** - * Returns the items to be displayed in the ChoiceBox when it is showing. + * Returns the items to be displayed in the ComboBox when it is showing. + * @return the items to be displayed in this ComboBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxTreeTableCell.java 2017-03-09 14:44:46.394174065 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ComboBoxTreeTableCell.java 2017-03-09 14:44:46.290174063 -0800 @@ -52,6 +52,7 @@ * items that will be shown to the user when the {@link ComboBox} menu is * showing. These items must be of the same type as the TreeTableColumn. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @since JavaFX 8.0 */ @@ -69,6 +70,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ComboBox} menu is showing. These items must be of the same @@ -93,6 +95,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param converter A {@link StringConverter} to convert the given item (of * type T) to a String for displaying to the user. @@ -120,6 +123,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param items Zero or more items that will be shown to the user when the * {@link ComboBox} menu is showing. These items must be of the same @@ -143,6 +147,7 @@ * being edited, and as a ComboBox when in editing mode. The ComboBox will, * by default, stretch to fill the entire list cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @param converter A {@link StringConverter} to convert the given item (of * type T) to a String for displaying to the user. @@ -262,6 +267,7 @@ /** * The {@link StringConverter} property. + * @return the string converter property */ public final ObjectProperty> converterProperty() { return converter; @@ -269,6 +275,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the string converter */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -276,6 +283,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the string converter */ public final StringConverter getConverter() { return converterProperty().get(); @@ -289,6 +297,8 @@ /** * A property representing whether the ComboBox, when shown to the user, * is editable or not. + * @return the property representing whether the ComboBox, when shown to the + * user, is editable or not */ public final BooleanProperty comboBoxEditableProperty() { return comboBoxEditable; @@ -297,6 +307,7 @@ /** * Configures the ComboBox to be editable (to allow user input outside of the * options provide in the dropdown list). + * @param value the editable value to be set for this ComboBox */ public final void setComboBoxEditable(boolean value) { comboBoxEditableProperty().set(value); @@ -304,6 +315,7 @@ /** * Returns true if the ComboBox is editable. + * @return true if the ComboBox is editable */ public final boolean isComboBoxEditable() { return comboBoxEditableProperty().get(); @@ -318,7 +330,8 @@ **************************************************************************/ /** - * Returns the items to be displayed in the ChoiceBox when it is showing. + * Returns the items to be displayed in the ComboBox when it is showing. + * @return the items to be displayed in this ComboBox when it is showing */ public ObservableList getItems() { return items; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/MapValueFactory.java 2017-03-09 14:44:46.766174071 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/MapValueFactory.java 2017-03-09 14:44:46.654174069 -0800 @@ -49,13 +49,13 @@ * of how to use this class is: * *

    
    - * ObservableList personsMapList = ...
    + * {@literal ObservableList personsMapList = ...
      *
    - * TableColumn<Map, String> firstNameColumn = new TableColumn<Map, String>("First Name");
    - * firstNameColumn.setCellValueFactory(new MapValueFactory<String>("firstName"));
    + * TableColumn firstNameColumn = new TableColumn("First Name");
    + * firstNameColumn.setCellValueFactory(new MapValueFactory("firstName"));
      *
      * TableView table = new TableView(personMapList);
    - * tableView.getColumns().setAll(firstNameColumn);
    + * tableView.getColumns().setAll(firstNameColumn);}
      * 
    * *

    In this example, there is a list of Map instances, where each Map instance --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ProgressBarTableCell.java 2017-03-09 14:44:47.126174077 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ProgressBarTableCell.java 2017-03-09 14:44:47.022174076 -0800 @@ -51,6 +51,7 @@ * value as it proceeds from 0.0 to 1.0. If the value is -1, the progress * bar will appear indeterminate. * + * @param The type of the TableView generic type * @return A {@link Callback} that can be inserted into the * {@link TableColumn#cellFactoryProperty() cell factory property} of a * TableColumn, that enables visualisation of a Number as it progresses --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ProgressBarTreeTableCell.java 2017-03-09 14:44:47.482174084 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/ProgressBarTreeTableCell.java 2017-03-09 14:44:47.378174082 -0800 @@ -51,6 +51,7 @@ * value as it proceeds from 0.0 to 1.0. If the value is -1, the progress * bar will appear indeterminate. * + * @param The type of the TableView generic type * @return A {@link Callback} that can be inserted into the * {@link TreeTableColumn#cellFactoryProperty() cell factory property} of a * TreeTableColumn, that enables visualisation of a Number as it progresses --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/PropertyValueFactory.java 2017-03-09 14:44:47.850174090 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/PropertyValueFactory.java 2017-03-09 14:44:47.738174088 -0800 @@ -57,7 +57,8 @@ * (which is the class type of the TableView * {@link TableView#itemsProperty() items} list). Additionally, this method must * return a {@link Property} instance. If a method meeting these requirements - * is found, then the {@link TableCell} is populated with this ObservableValue. + * is found, then the {@link TableCell} is populated with this + * {@literal ObservableValue}. * In addition, the TableView will automatically add an observer to the * returned value, such that any changes fired will be observed by the TableView, * resulting in the cell immediately updating. @@ -121,6 +122,7 @@ /** * Returns the property name provided in the constructor. + * @return the property name provided in the constructor */ public final String getProperty() { return property; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldListCell.java 2017-03-09 14:44:48.206174097 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldListCell.java 2017-03-09 14:44:48.102174095 -0800 @@ -77,6 +77,7 @@ * instance of type T. This item will then be passed along to the * {@link ListView#onEditCommitProperty()} callback. * + * @param The type of the item contained within the Cell * @param converter A {@link StringConverter} that can convert the given String * (from what the user typed in) into an instance of type T. * @return A {@link Callback} that can be inserted into the @@ -147,6 +148,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -154,6 +156,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -161,6 +164,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTableCell.java 2017-03-09 14:44:48.578174103 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTableCell.java 2017-03-09 14:44:48.462174101 -0800 @@ -40,6 +40,7 @@ * being edited, and as a TextField when in editing mode. The TextField will, by * default, stretch to fill the entire table cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TableColumn. * @since JavaFX 2.2 */ @@ -58,6 +59,7 @@ * This method will only work on {@link TableColumn} instances which are of * type String. * + * @param The type of the TableView generic type * @return A {@link Callback} that can be inserted into the * {@link TableColumn#cellFactoryProperty() cell factory property} of a * TableColumn, that enables textual editing of the content. @@ -76,6 +78,8 @@ * in) into an instance of type T. This item will then be passed along to the * {@link TableColumn#onEditCommitProperty()} callback. * + * @param The type of the TableView generic type + * @param The type of the elements contained within the TableColumn * @param converter A {@link StringConverter} that can convert the given String * (from what the user typed in) into an instance of type T. * @return A {@link Callback} that can be inserted into the @@ -147,6 +151,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -154,6 +159,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -161,6 +167,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTreeCell.java 2017-03-09 14:44:48.930174109 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTreeCell.java 2017-03-09 14:44:48.822174107 -0800 @@ -83,6 +83,7 @@ * then be passed along to the {@link TreeView#onEditCommitProperty()} * callback. * + * @param The type of the elements contained within the TreeView * @param converter A {@link StringConverter} that can convert the given String * (from what the user typed in) into an instance of type T. * @return A {@link Callback} that can be inserted into the @@ -156,6 +157,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -163,6 +165,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -170,6 +173,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTreeTableCell.java 2017-03-09 14:44:49.290174116 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TextFieldTreeTableCell.java 2017-03-09 14:44:49.186174114 -0800 @@ -35,13 +35,14 @@ import javafx.util.converter.DefaultStringConverter; /** - * A class containing a {@link TableCell} implementation that draws a + * A class containing a {@link javafx.scene.control.TableCell} implementation that draws a * {@link TextField} node inside the cell. * - *

    By default, the TextFieldTableCell is rendered as a {@link Label} when not + *

    By default, the TextFieldTableCell is rendered as a {@link javafx.scene.control.Label} when not * being edited, and as a TextField when in editing mode. The TextField will, by * default, stretch to fill the entire table cell. * + * @param The type of the TableView generic type * @param The type of the elements contained within the TreeTableColumn. * @since JavaFX 8.0 */ @@ -60,6 +61,7 @@ * This method will only work on {@link TreeTableColumn} instances which are of * type String. * + * @param The type of the TableView generic type * @return A {@link Callback} that can be inserted into the * {@link TreeTableColumn#cellFactoryProperty() cell factory property} of a * TreeTableColumn, that enables textual editing of the content. @@ -78,6 +80,8 @@ * in) into an instance of type T. This item will then be passed along to the * {@link TreeTableColumn#onEditCommitProperty()} callback. * + * @param The type of the TableView generic type + * @param The type of the elements contained within the TreeTableColumn * @param converter A {@link StringConverter} that can convert the given String * (from what the user typed in) into an instance of type T. * @return A {@link Callback} that can be inserted into the @@ -149,6 +153,7 @@ /** * The {@link StringConverter} property. + * @return the {@link StringConverter} property */ public final ObjectProperty> converterProperty() { return converter; @@ -156,6 +161,7 @@ /** * Sets the {@link StringConverter} to be used in this cell. + * @param value the {@link StringConverter} to be used in this cell */ public final void setConverter(StringConverter value) { converterProperty().set(value); @@ -163,6 +169,7 @@ /** * Returns the {@link StringConverter} used in this cell. + * @return the {@link StringConverter} used in this cell */ public final StringConverter getConverter() { return converterProperty().get(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TreeItemPropertyValueFactory.java 2017-03-09 14:44:49.646174122 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/cell/TreeItemPropertyValueFactory.java 2017-03-09 14:44:49.542174120 -0800 @@ -54,7 +54,8 @@ * firstNameProperty() method in the Person class type * (which is the class type of the TreeTableView). Additionally, this method must * return a {@link Property} instance. If a method meeting these requirements - * is found, then the {@link javafx.scene.control.TreeTableCell} is populated with this ObservableValue. + * is found, then the {@link javafx.scene.control.TreeTableCell} is populated + * with this {@literal ObservableValue}. * In addition, the TreeTableView will automatically add an observer to the * returned value, such that any changes fired will be observed by the TreeTableView, * resulting in the cell immediately updating. @@ -74,8 +75,9 @@ * *

    
      * TreeTableColumn<Person,String> firstNameCol = new TreeTableColumn<Person,String>("First Name");
    - * firstNameCol.setCellValueFactory(new Callback<CellDataFeatures<Person, String>, ObservableValue<String>>() {
    - *     public ObservableValue<String> call(CellDataFeatures<Person, String> p) {
    + * {@literal
    + * firstNameCol.setCellValueFactory(new Callback, ObservableValue>() {
    + *     public ObservableValue call(CellDataFeatures p) {
      *         // p.getValue() returns the TreeItem instance for a particular
      *         // TreeTableView row, and the second getValue() call returns the
      *         // Person instance contained within the TreeItem.
    @@ -83,6 +85,7 @@
      *     }
      *  });
      * }
    + * }
      * 
    * * @see TreeTableColumn @@ -119,6 +122,7 @@ /** * Returns the property name provided in the constructor. + * @return the property name provided in the constructor */ public final String getProperty() { return property; } --- old/modules/javafx.controls/src/main/java/javafx/scene/control/package.html 2017-03-09 14:44:50.062174129 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/package.html 2017-03-09 14:44:49.946174127 -0800 @@ -97,7 +97,7 @@

    Each of the default Skins for the built in Controls is comprised of multiple individually styleable areas or regions. This is much like an - HTML page which is made up of <div>'s and then styled from + HTML page which is made up of {@literal

    's} and then styled from CSS. Each individual region may be drawn with backgrounds, borders, images, padding, margins, and so on. The JavaFX CSS support includes the ability to have multiple backgrounds and borders, and to derive colors. These --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/CellSkinBase.java 2017-03-09 14:44:50.474174137 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/CellSkinBase.java 2017-03-09 14:44:50.358174135 -0800 @@ -187,6 +187,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ColorPickerSkin.java 2017-03-09 14:44:50.850174143 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ColorPickerSkin.java 2017-03-09 14:44:50.738174141 -0800 @@ -695,6 +695,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ComboBoxBaseSkin.java 2017-03-09 14:44:51.202174150 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ComboBoxBaseSkin.java 2017-03-09 14:44:51.098174148 -0800 @@ -144,6 +144,7 @@ /** * This method should return a Node that will be positioned within the * ComboBox 'button' area. + * @return the node that will be positioned within the ComboBox 'button' area */ public abstract Node getDisplayNode(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ComboBoxPopupControl.java 2017-03-09 14:44:51.562174156 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ComboBoxPopupControl.java 2017-03-09 14:44:51.458174154 -0800 @@ -212,6 +212,8 @@ /** * This method should return the Node that will be displayed when the user * clicks on the ComboBox 'button' area. + * @return the Node that will be displayed when the user clicks on the + * ComboBox 'button' area */ protected abstract Node getPopupContent(); @@ -222,6 +224,7 @@ * * Note: ComboBoxListViewSkin should return null if editable is false, even * if the ComboBox does have an editor set. + * @return the editor */ protected abstract TextField getEditor(); @@ -229,6 +232,7 @@ * Subclasses are responsible for getting the converter. This will be * removed in FX 9 when the converter property is moved up to ComboBoxBase * with JDK-8130354. + * @return the string converter */ protected abstract StringConverter getConverter(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/MenuBarSkin.java 2017-03-09 14:44:51.910174162 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/MenuBarSkin.java 2017-03-09 14:44:51.810174160 -0800 @@ -487,6 +487,7 @@ * * * Static methods * * * + * @param menuBar the menu bar **************************************************************************/ // RT-22480: This is intended as private API for SceneBuilder, @@ -1213,6 +1214,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/NestedTableColumnHeader.java 2017-03-09 14:44:52.282174169 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/NestedTableColumnHeader.java 2017-03-09 14:44:52.182174167 -0800 @@ -264,6 +264,7 @@ /** * Returns an unmodifiable list of the {@link TableColumnHeader} instances * that are children of this NestedTableColumnHeader. + * @return the unmodifiable list of TableColumnHeader of this NestedTableColumnHeader */ public final ObservableList getColumnHeaders() { if (columnHeaders == null) { @@ -368,6 +369,7 @@ * Note: In most circumstances this method should not be overridden, but in some circumstances it * makes sense (e.g. testing, or when extreme customization is desired). * + * @param col the table column * @return A new TableColumnHeader instance. */ protected TableColumnHeader createTableColumnHeader(TableColumnBase col) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/PaginationSkin.java 2017-03-09 14:44:52.666174176 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/PaginationSkin.java 2017-03-09 14:44:52.558174174 -0800 @@ -1470,6 +1470,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ProgressBarSkin.java 2017-03-09 14:44:53.022174182 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ProgressBarSkin.java 2017-03-09 14:44:52.918174180 -0800 @@ -481,6 +481,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ProgressIndicatorSkin.java 2017-03-09 14:44:53.378174188 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ProgressIndicatorSkin.java 2017-03-09 14:44:53.270174186 -0800 @@ -395,6 +395,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ScrollPaneSkin.java 2017-03-09 14:44:53.742174195 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ScrollPaneSkin.java 2017-03-09 14:44:53.626174193 -0800 @@ -394,6 +394,7 @@ /** * Returns the horizontal {@link ScrollBar} used in this ScrollPaneSkin * instance. + * @return the horizontal ScrollBar used in this ScrollPaneSkin instance */ public final ScrollBar getHorizontalScrollBar() { return hsb; @@ -402,6 +403,7 @@ /** * Returns the vertical {@link ScrollBar} used in this ScrollPaneSkin * instance. + * @return the vertical ScrollBar used in this ScrollPaneSkin instance */ public final ScrollBar getVerticalScrollBar() { return vsb; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TabPaneSkin.java 2017-03-09 14:44:54.102174201 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TabPaneSkin.java 2017-03-09 14:44:54.002174199 -0800 @@ -752,6 +752,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableCellSkinBase.java 2017-03-09 14:44:54.478174208 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableCellSkinBase.java 2017-03-09 14:44:54.370174206 -0800 @@ -116,6 +116,7 @@ /** * The TableColumnBase instance that is responsible for this Cell. + * @return the TableColumnBase instance that is responsible for this Cell */ public abstract ReadOnlyObjectProperty> tableColumnProperty(); public final TableColumnBase getTableColumn() { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableColumnHeader.java 2017-03-09 14:44:54.834174214 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableColumnHeader.java 2017-03-09 14:44:54.730174212 -0800 @@ -1079,8 +1079,10 @@ } /** - * Returnst he CssMetaData associated with this class, which may include the + * Returnst the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableRowSkinBase.java 2017-03-09 14:44:55.214174221 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableRowSkinBase.java 2017-03-09 14:44:55.098174219 -0800 @@ -206,6 +206,8 @@ /** * Creates a new cell instance that is suitable for representing the given table column instance. + * @param tc the table column + * @return the created cell */ protected abstract R createCell(TableColumnBase tc); @@ -220,11 +222,13 @@ /** * Returns the {@link TableColumnBase} instance for the given cell instance. * @param cell The cell for which a TableColumn is desired. + * @return the table column */ protected abstract TableColumnBase getTableColumn(R cell); /** * Returns an unmodifiable list containing the currently visible leaf columns. + * @return the list of visible leaf columns */ protected abstract ObservableList*/> getVisibleLeafColumns(); @@ -241,6 +245,7 @@ * is acceptable when no graphic should be shown. Commonly this is the * graphic associated with a TreeItem (i.e. treeItem.getGraphic()), rather * than a graphic associated with a cell. + * @return the graphic to draw on the inside of the disclosure node */ protected ObjectProperty graphicProperty() { return null; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableViewSkinBase.java 2017-03-09 14:44:55.578174227 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableViewSkinBase.java 2017-03-09 14:44:55.466174225 -0800 @@ -251,7 +251,7 @@ /** * - * @param control + * @param control the control */ public TableViewSkinBase(final C control) { super(control); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TextFieldSkin.java 2017-03-09 14:44:55.958174234 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TextFieldSkin.java 2017-03-09 14:44:55.846174232 -0800 @@ -441,7 +441,7 @@ * @param end The ending index in the range, exclusive. This is one-past the last character to * delete (consistent with the String manipulation methods). This must be > the start, * and <= the length of the text. - * @param text The text that is to replace the range. This must not be null. + * @param txt The text that is to replace the range. This must not be null. * @see TextField#replaceText(int, int, String) */ public void replaceText(int start, int end, String txt) { --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TextInputControlSkin.java 2017-03-09 14:44:56.334174240 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TextInputControlSkin.java 2017-03-09 14:44:56.222174238 -0800 @@ -398,6 +398,7 @@ /** * The fill {@code Paint} used for the foreground text color. + * @param value the text fill */ protected final void setTextFill(Paint value) { textFill.set(value); @@ -426,6 +427,7 @@ /** * The fill {@code Paint} used for the foreground prompt text color. + * @param value the prompt text fill */ protected final void setPromptTextFill(Paint value) { promptTextFill.set(value); @@ -461,6 +463,7 @@ /** * The fill {@code Paint} used for the background of selected text. + * @param value the highlight fill */ protected final void setHighlightFill(Paint value) { highlightFill.set(value); @@ -493,6 +496,7 @@ /** * The fill {@code Paint} used for the foreground of selected text. + * @param value the highlight text fill */ protected final void setHighlightTextFill(Paint value) { highlightTextFill.set(value); @@ -555,19 +559,26 @@ **************************************************************************/ /** + * @param start the start + * @param end the end * @return the path elements describing the shape of the underline for the given range. */ protected abstract PathElement[] getUnderlineShape(int start, int end); /** + * @param start the start + * @param end the end * @return the path elements describing the bounding rectangles for the given range of text. */ protected abstract PathElement[] getRangeShape(int start, int end); /** * Adds highlight for composed text from Input Method. + * @param nodes the list of nodes + * @param start the start */ protected abstract void addHighlight(List nodes, int start); /** * Removes highlight for composed text from Input Method. + * @param nodes the list of nodes */ protected abstract void removeHighlight(List nodes); @@ -595,6 +606,7 @@ * Returns the position to be used for a context menu, based on the location * of the caret handle or selection handles. This is supported only on touch * displays and does not use the location of the mouse. + * @return the position to be used for this context menu */ public Point2D getMenuPosition() { if (SHOW_HANDLES) { @@ -629,22 +641,24 @@ /** * Returns the insertion point for a given location. * - * @param x - * @param y + * @param x the x location + * @param y the y location + * @return the insertion point for a given location */ protected int getInsertionPoint(double x, double y) { return 0; } /** * Returns the bounds of the character at a given index. * - * @param index + * @param index the index + * @return the bounds of the character at a given index */ public Rectangle2D getCharacterBounds(int index) { return null; } /** * Ensures that the character at a given index is visible. * - * @param index + * @param index the index */ protected void scrollCharacterToVisible(int index) {} @@ -959,6 +973,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ToolBarSkin.java 2017-03-09 14:44:56.702174247 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/ToolBarSkin.java 2017-03-09 14:44:56.598174245 -0800 @@ -858,6 +858,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TooltipSkin.java 2017-03-09 14:44:57.066174253 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TooltipSkin.java 2017-03-09 14:44:56.962174252 -0800 @@ -59,6 +59,7 @@ /** * Creates a new TooltipSkin instance for the given {@link Tooltip}. + * @param t the tooltip */ public TooltipSkin(Tooltip t) { this.tooltip = t; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TreeCellSkin.java 2017-03-09 14:44:57.426174260 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TreeCellSkin.java 2017-03-09 14:44:57.322174258 -0800 @@ -414,6 +414,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TreeTableRowSkin.java 2017-03-09 14:44:57.786174266 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/TreeTableRowSkin.java 2017-03-09 14:44:57.686174264 -0800 @@ -439,6 +439,8 @@ /** * Returns the CssMetaData associated with this class, which may include the * CssMetaData of its superclasses. + * @return the CssMetaData associated with this class, which may include the + * CssMetaData of its superclasses */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/VirtualContainerBase.java 2017-03-09 14:44:58.150174273 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/VirtualContainerBase.java 2017-03-09 14:44:58.050174271 -0800 @@ -63,7 +63,7 @@ /** * - * @param control + * @param control the control */ public VirtualContainerBase(final C control) { super(control); @@ -92,6 +92,7 @@ /** * Returns the total number of items in this container, including those * that are currently hidden because they are out of view. + * @return the total number of items in this container */ protected abstract int getItemCount(); --- old/modules/javafx.controls/src/main/java/javafx/scene/control/skin/VirtualFlow.java 2017-03-09 14:44:58.522174279 -0800 +++ new/modules/javafx.controls/src/main/java/javafx/scene/control/skin/VirtualFlow.java 2017-03-09 14:44:58.402174277 -0800 @@ -900,6 +900,7 @@ * Sets a new cell factory to use in the VirtualFlow. This forces all old * cells to be thrown away, and new cells to be created with * the new cell factory. + * @param value the new cell factory */ public final void setCellFactory(Callback, T> value) { cellFactoryProperty().set(value); @@ -907,6 +908,7 @@ /** * Returns the current cell factory. + * @return the current cell factory */ public final Callback, T> getCellFactory() { return cellFactory == null ? null : cellFactory.get(); @@ -920,6 +922,7 @@ * which might be usable for representing any item in the VirtualFlow. * *

    Refer to the {@link Cell} class documentation for more detail. + * @return the cell factory property */ public final ObjectProperty, T>> cellFactoryProperty() { if (cellFactory == null) { @@ -1290,6 +1293,8 @@ * Get a cell which can be used in the layout. This function will reuse * cells from the pile where possible, and will create new cells when * necessary. + * @param prefIndex the preferred index + * @return the available cell */ protected T getAvailableCell(int prefIndex) { T cell = null; @@ -1341,6 +1346,8 @@ * viewport (it may be clipped), but does distinguish between cells that * have been created and are in use vs. those that are in the pile or * not created. + * @param index the index + * @return the visible cell */ public T getVisibleCell(int index) { if (cells.isEmpty()) return null; @@ -1369,6 +1376,7 @@ * Locates and returns the last non-empty IndexedCell that is currently * partially or completely visible. This function may return null if there * are no cells, or if the viewport length is 0. + * @return the last visible cell */ public T getLastVisibleCell() { if (cells.isEmpty() || getViewportLength() <= 0) return null; @@ -1388,6 +1396,7 @@ * Locates and returns the first non-empty IndexedCell that is partially or * completely visible. This really only ever returns null if there are no * cells or the viewport length is 0. + * @return the first visible cell */ public T getFirstVisibleCell() { if (cells.isEmpty() || getViewportLength() <= 0) return null; @@ -1399,6 +1408,7 @@ * Adjust the position of cells so that the specified cell * will be positioned at the start of the viewport. The given cell must * already be "live". + * @param firstCell the first cell */ public void scrollToTop(T firstCell) { if (firstCell != null) { @@ -1410,6 +1420,7 @@ * Adjust the position of cells so that the specified cell * will be positioned at the end of the viewport. The given cell must * already be "live". + * @param lastCell the last cell */ public void scrollToBottom(T lastCell) { if (lastCell != null) { @@ -1420,6 +1431,7 @@ /** * Adjusts the cells such that the selected cell will be fully visible in * the viewport (but only just). + * @param cell the cell */ public void scrollTo(T cell) { if (cell != null) { @@ -1439,6 +1451,7 @@ /** * Adjusts the cells such that the cell in the given index will be fully visible in * the viewport. + * @param index the index */ public void scrollTo(int index) { T cell = getVisibleCell(index); @@ -1454,6 +1467,7 @@ /** * Adjusts the cells such that the cell in the given index will be fully visible in * the viewport, and positioned at the very top of the viewport. + * @param index the index */ public void scrollToTop(int index) { boolean posSet = false; @@ -1486,6 +1500,8 @@ * to move the VirtualFlow in the given direction (positive is down/right, * negative is up/left) the given number of pixels. It returns the number of * pixels actually moved. + * @param delta the delta value + * @return the number of pixels actually moved */ public double scrollPixels(final double delta) { // Short cut this method for cases where nothing should be done @@ -1621,6 +1637,8 @@ * including beyond the range defined by cellCount, in which case an * empty cell will be returned. The returned value should not be stored for * any reason. + * @param index the index + * @return the cell */ public T getCell(int index) { // If there are cells, then we will attempt to get an existing cell @@ -1702,6 +1720,8 @@ /** * Return the index for a given cell. This allows subclasses to customise * how cell indices are retrieved. + * @param cell the cell + * @return the index */ protected int getCellIndex(T cell){ return cell.getIndex();

    Examples
    "..." - Default value for most locales
    " . . . "
    " [...] "