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.
Thanks for the feedback. Here is the revised webrev.01:
http://cr.openjdk.java.net/~ckyang/JDK-8164141/webrev.01/
17-08-2016
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
17-08-2016
Please review the proposed doc fix:
http://cr.openjdk.java.net/~ckyang/JDK-8164141/webrev.00/
17-08-2016
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.
16-08-2016
Request for backport to 8u-dev.
16-08-2016
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".