MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when useSystemMenuBar property is enabled #405

Oliver-Loeffler · 2021-09-07T16:32:20Z

For MacOS, when Scene Builder opens a FXML file with a MenuBar with property useSystemMenuBar="true",
then the SceneBuilder menu bar is replaced with the menu bar defined in FXML. Hence SceneBuilder becomes impossible to use.

This PR introduces code which conditionally disables the useSystemMenuBar="true" in the constructor of com.oracle.javafx.scenebuilder.kit.fxom.FXOMDocument. As there was already a boolean parameter normalized, the boolean arguments have been replaced with an enum type FXOMDocumentSwitch which provides the values NON_NORMALIZED and FOR_PREVIEW. The change of internal API is minimal and there is no change in default behavior of the FXOMDocument constructor.

Default behavior
For normal loading of an FXML file using the FXOMDocument constructor, the FXML text which is supplied to the FXMLLoader is modified, so that value of useSystemMenuBar is turned to false. This change is not reflected in the FXOM so that the original setting is preserved and can be saved to an FXML file again.
Thus, when loading an accordingly modified FXML file, the SceneBuilder menu will remain the one displayed in MacOS menu bar.
An prepared example is provided within the test resources. kit/src/test/resources/com/oracle/javafx/scenebuilder/kit/fxom/ContainerWithMenu_SystemMenuBarEnabled.fxml

Preview behavior
For previews instead, it migh be desirable to have exactly the behavior that the menu from a given FXML is displayed in MacOS menu bar. Therefore, the argument FXOMDocumentSwitch.FOR_PREVIEW is added to the call of the FXOMDocument constructor in com.oracle.javafx.scenebuilder.kit.preview.PreviewWindowController. In that case, the FXML text which is supplied to the FXMLLoader is not modified at all and if the property useSystemMenuBar="true" exists, then the menubar defined in preview will be displayed in MacOS menu bar.

Issue

Fixes #404

Progress

Change must not contain extraneous whitespace
License header year is updated, if required
Verify the contributor has signed Gluon Individual Contributor License Agreement (CLA)

… expression which checks if the WYSIWYG adjustment for preview function shall be used or not.

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXMLPropertiesDisabler.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMDocument.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMLoader.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXMLPropertiesDisabler.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMDocument.java

abhinayagarwal · 2021-12-06T13:31:58Z

Hi @Oliver-Loeffler ,

Do you plan to work on this PR and resolve Jose's comments?

Oliver-Loeffler · 2021-12-06T19:09:35Z

Yes for sure - will see to make some progress here during next days.

Javadoc added.

Oliver-Loeffler · 2022-01-05T02:07:12Z

Hi @abhinayagarwal & @jperedadnr,
it took a while but eventually I was able to put some more work in this. Thanks for your feedback so far - looking forward to your remarks & advice.

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMDocument.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXMLPropertiesDisabler.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMDocument.java

perform the replacement. Added a parameterized test accordingly.

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/editor/EditorPlatform.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXMLPropertiesDisabler.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/metadata/Metadata.java

.../test/java/com/oracle/javafx/scenebuilder/kit/fxom/FXMLPropertiesDisablerVariationsTest.java

...esources/com/oracle/javafx/scenebuilder/kit/fxom/ContainerWithMenu_SystemMenuBarEnabled.fxml

renamed property meta data instance accordingly

Oliver-Loeffler · 2022-01-13T19:36:15Z

@jperedadnr Many thanks for your patience in this!

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXMLPropertiesDisabler.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMDocument.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMIntrinsic.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMNodes.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMObject.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/metadata/Metadata.java

kit/src/test/resources/com/oracle/javafx/scenebuilder/kit/fxom/NonNormalized_Accordion.fxml

kit/src/test/resources/com/oracle/javafx/scenebuilder/kit/fxom/Normalized_Accordion.fxml

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/metadata/Metadata.java

NORMALIZED flag if needed.

jperedadnr · 2022-01-16T18:22:30Z

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMArchive.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, Gluon and/or its affiliates.
+ * Copyright (c) 2022, Gluon and/or its affiliates.


2019, 2022,

jperedadnr · 2022-01-16T18:23:46Z

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMNodes.java

@@ -1,4 +1,5 @@
-/*
+/* 
+ * Copyright (c) 2017, 2022, Gluon and/or its affiliates.


jperedadnr · 2022-01-16T18:30:02Z

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/fxom/FXOMDocument.java

        this.glue = new GlueDocument(fxmlText);
        this.location = location;
        this.classLoader = classLoader;
        this.resources = resources;
        initialDeclaredClasses = new ArrayList<>();
        if (this.glue.getRootElement() != null) {
+            String fxmlTextToLoad = fxmlText;
+            if (!Set.of(switches).contains(FXOMDocumentSwitch.FOR_PREVIEW)) {


Extract Set.of(switches) to a variable, so you don't create the set twice?

There is now on set used for both places where it is required.

jperedadnr

Looks good, great job!

…SystemMenuBar property is enabled (gluonhq#405) Co-authored-by: Oliver-Loeffler <[email protected]>

Oliver-Loeffler added 7 commits September 7, 2021 14:51

Draft of an idea for issue-404.

0fc2a78

Moved the FXML modification code into a separate class. Corrected the…

a94233f

… expression which checks if the WYSIWYG adjustment for preview function shall be used or not.

Header updated.

a88229c

Formatting reworked.

9e51383

Header added.

1cbe93a

Formatting

7195221

Added tests for changes in FXOMDocument.

401c6f4

Oliver-Loeffler force-pushed the issue-404 branch 3 times, most recently from 3b2e343 to c2e75cd Compare September 7, 2021 17:10

This was referenced Sep 8, 2021

Scenebuilder on MacOS does not display menu #404

Closed

SB won't load a file that contains <userData> #253

Open

abhinayagarwal requested a review from jperedadnr September 13, 2021 06:00

Oliver-Loeffler changed the title ~~Fix for issue #404~~ MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when 'useSystemMenuBar="true"' Sep 13, 2021

Oliver-Loeffler changed the title ~~MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when 'useSystemMenuBar="true"'~~ MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when useSystemMenuBar property is enabled Sep 13, 2021

abhinayagarwal added this to the 18 milestone Sep 13, 2021

abhinayagarwal added the bug Something isn't working label Sep 13, 2021

jperedadnr reviewed Sep 15, 2021

View reviewed changes

Oliver-Loeffler and others added 2 commits January 5, 2022 02:16

Merge branch 'gluonhq:master' into issue-404-develop

d946f46

FXLMPropertiesDiesabler generalized. Spelling mistakes corrected.

bc22b83

Javadoc added.

Oliver-Loeffler force-pushed the issue-404 branch from b532602 to bc22b83 Compare January 5, 2022 01:37

Oliver-Loeffler added 2 commits January 5, 2022 02:50

Updated OS specific test.

e356320

Added javadoc.

074da20

Oliver-Loeffler added 2 commits January 5, 2022 03:17

Formatting.

043da8c

Applied checkstyle formatting.

925490d

Oliver-Loeffler mentioned this pull request Jan 5, 2022

When loading of FXML file fails, in some cases the error is not shown to the user #403

Merged

3 tasks

jperedadnr reviewed Jan 8, 2022

View reviewed changes

Oliver-Loeffler added 8 commits January 13, 2022 15:07

Header updated. Merge errors fixed.

afd72f7

Spaces removed

b36f01d

Replaced platform checks with JUnit Assumptions.

98d9b57

Header update

6d3453a

Reverted changes.

dfbeca1

Added test.

b9fd009

FXMLPropertiesDisabler now uses an approach with a regular expression to

1bfe40b

perform the replacement. Added a parameterized test accordingly.

Enabled useSystemMenuBar as an inspectable for MenuBar.

e61fd4c

jperedadnr reviewed Jan 13, 2022

View reviewed changes

Oliver-Loeffler added 6 commits January 13, 2022 20:15

Header updated.

93a8a40

refactor: constructor chained

1a723d7

feat+refactor: useSystemMenuProperty to be treated as node property,

0e244b9

renamed property meta data instance accordingly

feat: removed "useSystemMenuBar" from hidden properties

3b4c5bc

refactor: removed empty lines between fields

97512d5

refator: removed underscore in test file name

82b285b

jperedadnr reviewed Jan 14, 2022

View reviewed changes

Oliver-Loeffler added 5 commits January 14, 2022 08:40

Javadoc cleanup

f6c34ad

Reverted formatting changes.

1800665

Reverted accidental modification of inspector path setting

dfb4f19

Removed underscore from test file names.

da9738a

All FXOMDocument constructor calls updated in order to use the

afa27e0

NORMALIZED flag if needed.

jperedadnr reviewed Jan 16, 2022

View reviewed changes

Oliver-Loeffler added 2 commits January 16, 2022 20:59

Corrected license headers.

fadf87a

Set of switches is now defined once.

bc8ef4a

jperedadnr approved these changes Jan 16, 2022

View reviewed changes

jperedadnr merged commit 731dbf1 into gluonhq:master Jan 17, 2022

Oliver-Loeffler added a commit to Oliver-Loeffler/scenebuilder that referenced this pull request Jan 21, 2022

MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when use…

9faf0e0

…SystemMenuBar property is enabled (gluonhq#405) Co-authored-by: Oliver-Loeffler <[email protected]>

Oliver-Loeffler mentioned this pull request Oct 3, 2022

FXML with useSystemMenuBar="true" makes SceneBuilder replace its menu #69

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when useSystemMenuBar property is enabled #405

MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when useSystemMenuBar property is enabled #405

Oliver-Loeffler commented Sep 7, 2021 •

edited

Loading

abhinayagarwal commented Dec 6, 2021

Oliver-Loeffler commented Dec 6, 2021

Oliver-Loeffler commented Jan 5, 2022

Oliver-Loeffler commented Jan 13, 2022

jperedadnr Jan 16, 2022

Oliver-Loeffler Jan 16, 2022

jperedadnr Jan 16, 2022

Oliver-Loeffler Jan 16, 2022

jperedadnr Jan 16, 2022

Oliver-Loeffler Jan 16, 2022

jperedadnr left a comment

MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when useSystemMenuBar property is enabled #405

MacOS: avoid hiding SceneBuilder menu bar with FXML menu bar when useSystemMenuBar property is enabled #405

Conversation

Oliver-Loeffler commented Sep 7, 2021 • edited Loading

Issue

Progress

abhinayagarwal commented Dec 6, 2021

Oliver-Loeffler commented Dec 6, 2021

Oliver-Loeffler commented Jan 5, 2022

Oliver-Loeffler commented Jan 13, 2022

jperedadnr Jan 16, 2022

Choose a reason for hiding this comment

Oliver-Loeffler Jan 16, 2022

Choose a reason for hiding this comment

jperedadnr Jan 16, 2022

Choose a reason for hiding this comment

Oliver-Loeffler Jan 16, 2022

Choose a reason for hiding this comment

jperedadnr Jan 16, 2022

Choose a reason for hiding this comment

Oliver-Loeffler Jan 16, 2022

Choose a reason for hiding this comment

jperedadnr left a comment

Choose a reason for hiding this comment

Oliver-Loeffler commented Sep 7, 2021 •

edited

Loading