From e7a106faf3c0bb0126080d2f516248195679bf61 Mon Sep 17 00:00:00 2001 From: Ajit Ghaisas Date: Fri, 29 Oct 2021 04:17:08 +0000 Subject: [PATCH] 8271090: Missing API docs in scenegraph classes Reviewed-by: kcr, nlisker --- .../util/converter/FormatStringConverter.java | 4 ++ .../main/java/javafx/fxml/LoadException.java | 16 +++++++ .../main/java/javafx/print/PageLayout.java | 4 ++ .../javafx/scene/AccessibleAttribute.java | 4 ++ .../src/main/java/javafx/scene/Camera.java | 3 ++ .../src/main/java/javafx/scene/Node.java | 5 ++- .../src/main/java/javafx/scene/Scene.java | 3 +- .../src/main/java/javafx/scene/SubScene.java | 3 +- .../java/javafx/scene/image/ImageView.java | 5 ++- .../java/javafx/scene/layout/Background.java | 5 ++- .../main/java/javafx/scene/layout/Border.java | 5 ++- .../java/javafx/scene/layout/FlowPane.java | 5 ++- .../java/javafx/scene/layout/GridPane.java | 5 ++- .../main/java/javafx/scene/layout/HBox.java | 5 ++- .../main/java/javafx/scene/layout/Region.java | 5 ++- .../java/javafx/scene/layout/StackPane.java | 5 ++- .../java/javafx/scene/layout/TilePane.java | 5 ++- .../main/java/javafx/scene/layout/VBox.java | 5 ++- .../java/javafx/scene/paint/Material.java | 3 ++ .../java/javafx/scene/shape/Rectangle.java | 5 ++- .../main/java/javafx/scene/shape/Shape.java | 5 ++- .../main/java/javafx/scene/shape/Shape3D.java | 3 ++ .../src/main/java/javafx/scene/text/Text.java | 5 ++- .../main/java/javafx/scene/text/TextFlow.java | 5 ++- .../main/java/javafx/stage/PopupWindow.java | 3 ++ .../src/main/java/javafx/stage/Stage.java | 7 ++-- .../src/main/java/javafx/stage/Window.java | 42 +++++++++++++++---- .../main/java/javafx/scene/media/Track.java | 3 +- 28 files changed, 129 insertions(+), 44 deletions(-) diff --git a/modules/javafx.base/src/main/java/javafx/util/converter/FormatStringConverter.java b/modules/javafx.base/src/main/java/javafx/util/converter/FormatStringConverter.java index 18082d996c2..deadc5cadc8 100644 --- a/modules/javafx.base/src/main/java/javafx/util/converter/FormatStringConverter.java +++ b/modules/javafx.base/src/main/java/javafx/util/converter/FormatStringConverter.java @@ -43,6 +43,10 @@ public class FormatStringConverter extends StringConverter { // ------------------------------------------------------------ Constructors + /** + * Creates a {@code FormatStringConverter} for the given {@code Format} instance. + * @param format the {@code Format} instance + */ public FormatStringConverter(@NamedArg("format") Format format) { this.format = format; } diff --git a/modules/javafx.fxml/src/main/java/javafx/fxml/LoadException.java b/modules/javafx.fxml/src/main/java/javafx/fxml/LoadException.java index e5ba3a77b3f..ed45d26f72e 100644 --- a/modules/javafx.fxml/src/main/java/javafx/fxml/LoadException.java +++ b/modules/javafx.fxml/src/main/java/javafx/fxml/LoadException.java @@ -34,18 +34,34 @@ public class LoadException extends IOException { private static final long serialVersionUID = 0; + /** + * Creates a default {@code LoadException}. + */ public LoadException() { super(); } + /** + * Creates a {@code LoadException} with the given message. + * @param message the message + */ public LoadException(String message) { super(message); } + /** + * Creates a {@code LoadException} with the given {@code Throwable} cause. + * @param cause the {@code Throwable} cause + */ public LoadException(Throwable cause) { super(cause); } + /** + * Creates a {@code LoadException} with the given message and {@code Throwable} cause. + * @param message the message + * @param cause the {@code Throwable} cause + */ public LoadException(String message, Throwable cause) { super(message, cause); } diff --git a/modules/javafx.graphics/src/main/java/javafx/print/PageLayout.java b/modules/javafx.graphics/src/main/java/javafx/print/PageLayout.java index 5112b6c603d..c7c954028b9 100644 --- a/modules/javafx.graphics/src/main/java/javafx/print/PageLayout.java +++ b/modules/javafx.graphics/src/main/java/javafx/print/PageLayout.java @@ -120,6 +120,10 @@ public final class PageLayout { this.bMargin = bottomMargin; } + /** + * Gets the {@code PageOrientation}. + * @return the {@code PageOrientation} + */ public PageOrientation getPageOrientation() { return orient; } diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/AccessibleAttribute.java b/modules/javafx.graphics/src/main/java/javafx/scene/AccessibleAttribute.java index 40401d3192f..abcc118e5c1 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/AccessibleAttribute.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/AccessibleAttribute.java @@ -793,6 +793,10 @@ public enum AccessibleAttribute { this.returnClass = returnClass; } + /** + * Gets the type of {@code AccessibleAttribute}. + * @return the type of {@code AccessibleAttribute} + */ public Class getReturnType() { return returnClass; } diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/Camera.java b/modules/javafx.graphics/src/main/java/javafx/scene/Camera.java index 98622c0e09d..393f423ae52 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/Camera.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/Camera.java @@ -159,6 +159,9 @@ public Point3D pickProjectPlane(Camera camera, double x, double y) { CameraHelper.initHelper(this); } + /** + * Constructor for subclasses to call. + */ protected Camera() { InvalidationListener dirtyTransformListener = observable -> NodeHelper.markDirty(this, DirtyBits.NODE_CAMERA_TRANSFORM); diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/Node.java b/modules/javafx.graphics/src/main/java/javafx/scene/Node.java index f2722556593..588e106fda1 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/Node.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/Node.java @@ -9148,8 +9148,9 @@ public StyleableProperty getStyleableProperty(Node node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/Scene.java b/modules/javafx.graphics/src/main/java/javafx/scene/Scene.java index 174862e2431..aff0797f5e1 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/Scene.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/Scene.java @@ -1662,7 +1662,8 @@ protected void onChanged(Change c) { private ObjectProperty userAgentStylesheet = null; /** - * @return the userAgentStylesheet property. + * Gets the userAgentStylesheet property. + * @return the userAgentStylesheet property * @see #getUserAgentStylesheet() * @see #setUserAgentStylesheet(String) * @since JavaFX 8u20 diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/SubScene.java b/modules/javafx.graphics/src/main/java/javafx/scene/SubScene.java index c51c2dcf070..06b30a4bf9c 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/SubScene.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/SubScene.java @@ -646,7 +646,8 @@ void processCSS() { private ObjectProperty userAgentStylesheet = null; /** - * @return the userAgentStylesheet property. + * Gets the userAgentStylesheet property. + * @return the userAgentStylesheet property * @see #getUserAgentStylesheet() * @see #setUserAgentStylesheet(String) * @since JavaFX 8u20 diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/image/ImageView.java b/modules/javafx.graphics/src/main/java/javafx/scene/image/ImageView.java index f125dd05508..f969fc79444 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/image/ImageView.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/image/ImageView.java @@ -836,8 +836,9 @@ public StyleableProperty getStyleableProperty(ImageView n) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/Background.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/Background.java index 658d11d9b3e..b49a5bc477c 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/Background.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/Background.java @@ -118,8 +118,9 @@ public final class Background { BACKGROUND_SIZE)); /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} */ public static List> getClassCssMetaData() { return STYLEABLES; diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/Border.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/Border.java index 27f908202d6..25d01f87158 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/Border.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/Border.java @@ -147,8 +147,9 @@ public final class Border { BORDER_IMAGE_INSETS)); /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} */ public static List> getClassCssMetaData() { return STYLEABLES; diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/FlowPane.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/FlowPane.java index b4168123fc5..7c417703847 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/FlowPane.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/FlowPane.java @@ -939,8 +939,9 @@ public StyleableProperty getStyleableProperty(FlowPane node) { /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/GridPane.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/GridPane.java index 73b12d9a432..3ad72775a87 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/GridPane.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/GridPane.java @@ -2483,8 +2483,9 @@ public StyleableProperty getStyleableProperty(GridPane node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/HBox.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/HBox.java index 3885dd8d8fc..de2ed9b7937 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/HBox.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/HBox.java @@ -733,8 +733,9 @@ public StyleableProperty getStyleableProperty(HBox node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/Region.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/Region.java index b711f1ce801..2e8e4835a91 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/Region.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/Region.java @@ -3677,8 +3677,9 @@ public StyleableProperty getStyleableProperty(Region node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/StackPane.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/StackPane.java index 0c22a07ef84..8ad21db9712 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/StackPane.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/StackPane.java @@ -386,8 +386,9 @@ public StyleableProperty getStyleableProperty(StackPane node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/TilePane.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/TilePane.java index d443241ed0a..d926aea333f 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/TilePane.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/TilePane.java @@ -1180,8 +1180,9 @@ public StyleableProperty getStyleableProperty(TilePane node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/layout/VBox.java b/modules/javafx.graphics/src/main/java/javafx/scene/layout/VBox.java index 0680fa46d11..e3f23ca00ee 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/layout/VBox.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/layout/VBox.java @@ -653,8 +653,9 @@ public StyleableProperty getStyleableProperty(VBox node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/paint/Material.java b/modules/javafx.graphics/src/main/java/javafx/scene/paint/Material.java index 5ed1d15ea90..f20f84aa8f3 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/paint/Material.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/paint/Material.java @@ -76,6 +76,9 @@ PhongMaterial maybe the first and only material in FX8 (see 3D conceptual implem No plan to support Multi-texture */ + /** + * Constructor for subclasses to call. + */ protected Material() { if (!Platform.isSupported(ConditionalFeature.SCENE3D)) { String logname = Material.class.getName(); diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/shape/Rectangle.java b/modules/javafx.graphics/src/main/java/javafx/scene/shape/Rectangle.java index 90cedbd4126..40b8f14e0d4 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/shape/Rectangle.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/shape/Rectangle.java @@ -467,8 +467,9 @@ public StyleableProperty getStyleableProperty(Rectangle node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape.java b/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape.java index b47fffd78b1..ec6afd46c99 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape.java @@ -893,8 +893,9 @@ public StyleableProperty getStyleableProperty(Shape node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape3D.java b/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape3D.java index ec34049bd17..89021dc9d35 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape3D.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/shape/Shape3D.java @@ -97,6 +97,9 @@ public boolean doComputeContains(Node node, double localX, double localY) { private static final PhongMaterial DEFAULT_MATERIAL = new PhongMaterial(); + /** + * Constructor for subclasses to call. + */ protected Shape3D() { if (!Platform.isSupported(ConditionalFeature.SCENE3D)) { String logname = Shape3D.class.getName(); diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/text/Text.java b/modules/javafx.graphics/src/main/java/javafx/scene/text/Text.java index cd85e81665a..b8a69d5747a 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/text/Text.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/text/Text.java @@ -1481,8 +1481,9 @@ public StyleableProperty getStyleableProperty(Text node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} * @since JavaFX 8.0 */ public static List> getClassCssMetaData() { diff --git a/modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java b/modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java index 576e17c3811..e4f06c2e587 100644 --- a/modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java +++ b/modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java @@ -599,8 +599,9 @@ public StyleableProperty getStyleableProperty(TextFlow node) { } /** - * @return The CssMetaData associated with this class, which may include the - * CssMetaData of its superclasses. + * Gets the {@code CssMetaData} associated with this class, which may include the + * {@code CssMetaData} of its superclasses. + * @return the {@code CssMetaData} */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; diff --git a/modules/javafx.graphics/src/main/java/javafx/stage/PopupWindow.java b/modules/javafx.graphics/src/main/java/javafx/stage/PopupWindow.java index de9e8003d44..f8509551be9 100644 --- a/modules/javafx.graphics/src/main/java/javafx/stage/PopupWindow.java +++ b/modules/javafx.graphics/src/main/java/javafx/stage/PopupWindow.java @@ -152,6 +152,9 @@ public void invalidated(final Observable observable) { private WeakChangeListener weakOwnerNodeListener = new WeakChangeListener(changeListener); private TreeShowingExpression treeShowingExpression; + /** + * Constructor for subclasses to call. + */ public PopupWindow() { final Pane popupRoot = new Pane(); popupRoot.setBackground(Background.EMPTY); diff --git a/modules/javafx.graphics/src/main/java/javafx/stage/Stage.java b/modules/javafx.graphics/src/main/java/javafx/stage/Stage.java index 475e65e2563..a78ddc2c801 100644 --- a/modules/javafx.graphics/src/main/java/javafx/stage/Stage.java +++ b/modules/javafx.graphics/src/main/java/javafx/stage/Stage.java @@ -1273,9 +1273,6 @@ public final ObjectProperty fullScreenExitKeyProperty() { return fullScreenExitCombination; } - private final ObjectProperty fullScreenExitHint = - new SimpleObjectProperty(this, "fullScreenExitHint", null); - /** * Specifies the text to show when a user enters full screen mode, usually * used to indicate the way a user should go about exiting out of full @@ -1289,9 +1286,11 @@ public final ObjectProperty fullScreenExitKeyProperty() { * value of this property will be ignored, in which case the * default message will be displayed. *

- * @param value the string to be displayed. * @since JavaFX 8.0 */ + private final ObjectProperty fullScreenExitHint = + new SimpleObjectProperty(this, "fullScreenExitHint", null); + public final void setFullScreenExitHint(String value) { fullScreenExitHint.set(value); } diff --git a/modules/javafx.graphics/src/main/java/javafx/stage/Window.java b/modules/javafx.graphics/src/main/java/javafx/stage/Window.java index 21a3a5f7d65..f4df7c1718c 100644 --- a/modules/javafx.graphics/src/main/java/javafx/stage/Window.java +++ b/modules/javafx.graphics/src/main/java/javafx/stage/Window.java @@ -227,6 +227,9 @@ public static ObservableList getWindows() { @SuppressWarnings("removal") final AccessControlContext acc = AccessController.getContext(); + /** + * Constructor for subclasses to call. + */ protected Window() { // necessary for WindowCloseRequestHandler initializeInternalEventDispatcher(); @@ -759,18 +762,43 @@ public Object getUserData() { * a different {@code Window} will cause the old {@code Window} to lose the * reference before the new one gains it. You may swap {@code Scene}s on * a {@code Window} at any time, even if it is an instance of {@code Stage} - * and with {@link Stage#fullScreenProperty() fullScreen} set to true. - * If the width or height of this {@code Window} have never been set by the + * and with {@link Stage#fullScreenProperty() fullScreen} set to {@code true}. + *

If the width or height of this {@code Window} have never been set by the * application, setting the scene will cause this {@code Window} to take its - * width or height from that scene. Resizing this window by end user does - * not count as setting the width or height by the application. + * width or height from that scene. Resizing this {@code Window} by end user does + * not count as setting the width or height by the application.

* - * An {@link IllegalStateException} is thrown if this property is set - * on a thread other than the JavaFX Application Thread. + *

An {@link IllegalStateException} is thrown if this property is set + * on a thread other than the JavaFX Application Thread.

* - * @defaultValue null + * @defaultValue {@code null} */ private SceneModel scene = new SceneModel(); + + /** + * Sets the value of the {@code scene} property. + * + *

The {@code Scene} to be rendered on this {@code Window}. There can only + * be one {@code Scene} on the {@code Window} at a time, and a {@code Scene} + * can only be on one {@code Window} at a time. Setting a {@code Scene} on + * a different {@code Window} will cause the old {@code Window} to lose the + * reference before the new one gains it. You may swap {@code Scene}s on + * a {@code Window} at any time, even if it is an instance of {@code Stage} + * and with {@link Stage#fullScreenProperty() fullScreen} set to {@code true}.

+ *

If the width or height of this {@code Window} have never been set by the + * application, setting the scene will cause this {@code Window} to take its + * width or height from that scene. Resizing this {@code Window} by end user does + * not count as setting the width or height by the application.

+ * + * @throws IllegalStateException if this property is set on a thread other than + * the JavaFX Application Thread. + * + * @defaultValue {@code null} + * + * @param value the value for the {@code scene} property + * @see #getScene() + * @see #sceneProperty() + */ protected void setScene(Scene value) { scene.set(value); } public final Scene getScene() { return scene.get(); } public final ReadOnlyObjectProperty sceneProperty() { return scene.getReadOnlyProperty(); } diff --git a/modules/javafx.media/src/main/java/javafx/scene/media/Track.java b/modules/javafx.media/src/main/java/javafx/scene/media/Track.java index 4013a2daf06..5dbf94cd659 100644 --- a/modules/javafx.media/src/main/java/javafx/scene/media/Track.java +++ b/modules/javafx.media/src/main/java/javafx/scene/media/Track.java @@ -81,7 +81,8 @@ public final long getTrackID() { } /** - * @return a Map containing all known metadata for this Track + * Gets the Map containing all known metadata for this Track. + * @return the Map containing all known metadata for this Track * @since JavaFX 8.0 */ public final Map getMetadata() {