JDK-8164141 : [Javadoc] Replace references of Stage with Window in the Window class
  • Type: Bug
  • Component: javafx
  • Sub-Component: scenegraph
  • Affected Version: 8,9
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2016-08-16
  • Updated: 2020-01-31
  • Resolved: 2016-08-18
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
8u152Fixed 9Fixed
Related Reports
Blocks :  
There are javadoc of methods and properties in the Window class that should reference {@code Window} instead of {@code Stage}.
Approved to backport to 8u-dev for 8u122.

Request for backport to 8udev: http://cr.openjdk.java.net/~ckyang/JDK-8164141/backport.00/

Changeset: cff9d59e436f Author: ckyang Date: 2016-08-18 14:32 -0700 URL: http://hg.openjdk.java.net/openjfx/9-dev/rt/rev/cff9d59e436f

Looks good. +1

Thanks for the feedback. Here is the revised webrev.01: http://cr.openjdk.java.net/~ckyang/JDK-8164141/webrev.01/

Three comments: 1. For the width and height properties: + * will not visually affect a {@code Window} while {@link Stage#fullScreen} That should be "the" {@code Window} ... 2. For the scene property: + * a {@code Window} at any time, even if it is an instance of {@code Stage} + * and while it is in {@link Stage#fullScreen} mode. That last line would read better as: with {@link Stage#fullScreen} set to true. 3. I found two other "Stage" references that should be changed to "Window" : 1044 * user's system). The Stage might be "showing", yet the user might not 1045 * be able to see it due to the Stage being rendered behind another window

Please review the proposed doc fix: http://cr.openjdk.java.net/~ckyang/JDK-8164141/webrev.00/

I agree that this would be a good bug to consider for backporting to JDK 8, since the documentation is currently misleading, and there is value in keeping the description of these properties in sync. I will review the backport request after the bug has been pushed to 9-dev.

Request for backport to 8u-dev.

I noticed two related problems while reviewing JDK-8130675. 1. The fullScreen property is not a property of Window, but rather a property of stage, so any reference to fullScreen should qualify it with something like "If this Window is an instance of Stage, ..." 2. The fix for JDK-8089847 eliminated the usage of the term "full-screen exclusive" in the Stage documentation, but missed one place it in the "scene" property of the Window class. It should be changed to just "fullScreen" or "fullScreen property".