fix: adds <fx:include> elements to controller skeleton when a fxid is assigned (#811) by Oliver-Loeffler · Pull Request #841 · gluonhq/scenebuilder

Oliver-Loeffler · 2025-10-02T18:40:23Z

This PR introduces code which enables Scene Builder to declare references to <fx:include> elements which have a fx:id assigned in the controller skeleton. It uses the fx:id defined in the outer FXML file but the type of the node declared as root in the inner FXML file.

Issue

Fixes #811

Progress

Change must not contain extraneous whitespace
License header year is updated, if required
The PR name must follow the pre-defined format
Verify the contributor has signed Gluon Individual Contributor License Agreement (CLA)

…assigned, are now added to the controller skeleton. (gluonhq#811)

…com.oracle.javafx.scenebuilder.kit.skeleton to ALL-UNNAMED to enable testing.

jperedadnr

Great work!
I added two minor comments, and possibly some follow-ups:

The skeleton shows classes from private packages instead of public ones:

(it should be import javafx.collections.FXCollections instead of import com.sun.javafx.collections.ObservableListWrapper)

And when trying to edit the included file from the Hierarchy context menu:

I get this error:

com.oracle.javafx.scenebuilder.kit.editor.FileBrowserRevealException: The command to reval the file exited with an error (exitValue=1).
Command: open /Users/user/SceneBuilder/kit/src/test/resources/com/oracle/javafx/scenebuilder/kit/skeleton/fxinclude_with_fxid_inner.fxml
Working Dir: null
	at com.gluonhq.scenebuilder.kit@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.kit.editor.EditorPlatform.executeDaemon(EditorPlatform.java:339)
	at com.gluonhq.scenebuilder.kit@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.kit.editor.EditorPlatform.open(EditorPlatform.java:242)
	at com.gluonhq.scenebuilder.kit@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.kit.editor.EditorController.performEditIncludedFile(EditorController.java:2283)
	at com.gluonhq.scenebuilder.kit@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.kit.editor.EditorController.performControlAction(EditorController.java:1522)
	at com.gluonhq.scenebuilder.kit@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.kit.editor.util.ContextMenuController$ControlActionController.perform(ContextMenuController.java:568)
...

kit/src/test/java/com/oracle/javafx/scenebuilder/kit/skeleton/SkeletonBufferJavaTest.java

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/skeleton/SkeletonContext.java

…g tested.

…vafx-interface or nearest super class are selected as types.

…g to edit included files.

Oliver-Loeffler · 2025-10-14T21:50:44Z

I've reworked the type detection for the controller skeleton. Instead of the ObservableListWrapper, there is now the reference to the nearest JavaFX related interface, which is javafx.collections.ObservableList. The editing should also now work (have not tested on MacOS or Linux yet). On Windows it works, regardless if the working dir is provided or not.

Ideally, this would open in SceneBuilder as a document, but this is much more complex hence I propose we make this work in a separate issue. Would you file an issue for that @jperedadnr ?

The FXML code forces the loader to create an ObservableList.

<FXCollections fx:id="myItems" fx:factory="observableArrayList">
    <String fx:value="1" />
    <String fx:value="20" />
    <String fx:value="300" />
</FXCollections>

The corresponding FXCollections code shows, that the import should be javafx.collections.ObservableList (as it is now).

    /**
     * Creates a new observable array list with {@code items} added to it.
     * @param <E> The type of List to be wrapped
     * @param items the items that will be in the new observable ArrayList
     * @return a newly created observableArrayList
     * @see #observableArrayList()
     */
    public static <E> ObservableList<E> observableArrayList(E... items) {
        return observableList(new ArrayList<>(Arrays.asList(items)));
    }

jperedadnr

When I run SB with the changes from this PR, and open this file kit/src/test/resources/com/oracle/javafx/scenebuilder/kit/skeleton/fxinclude_with_fxid_outer.fxml, I see the skeleton controller as expected, good work!

However, if I select the FXML Pane node from the hierarchy, press right click, and select from the context menu Edit Included File, it doesn't work (nothing happens), and now I see this exception:

INFO: Successfully opened file /kit/src/test/resources/com/oracle/javafx/scenebuilder/kit/skeleton/fxinclude_with_fxid_outer.fxml
Nov 23, 2025 2:33:11 PM com.oracle.javafx.scenebuilder.app.SceneBuilderApp$SceneBuilderUncaughtExceptionHandler uncaughtException
SEVERE: An exception was thrown:
java.lang.IndexOutOfBoundsException: Index 0 out of bounds for length 0
        at java.base/jdk.internal.util.Preconditions.outOfBounds(Preconditions.java:100)
        at java.base/jdk.internal.util.Preconditions.outOfBoundsCheckIndex(Preconditions.java:106)
        at java.base/jdk.internal.util.Preconditions.checkIndex(Preconditions.java:302)
        at java.base/java.util.Objects.checkIndex(Objects.java:365)
        at java.base/java.util.ArrayList.get(ArrayList.java:428)
        at com.gluonhq.scenebuilder.app@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.app.SceneBuilderApp.handleOpenFilesAction(SceneBuilderApp.java:531)
        at com.gluonhq.scenebuilder.app@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.app.SceneBuilderApp.handleOpenFilesAction(SceneBuilderApp.java:512)
        at com.gluonhq.scenebuilder.app@25.0.0-SNAPSHOT/com.oracle.javafx.scenebuilder.app.AppPlatform$MessageBoxDelegate.lambda$messageBoxDidGetMessage$0(AppPlatform.java:203)
        at javafx.graphics@25/com.sun.javafx.application.PlatformImpl.lambda$runLater$0(PlatformImpl.java:424)
        at javafx.graphics@25/com.sun.glass.ui.InvokeLaterDispatcher$Future.run(InvokeLaterDispatcher.java:95)

I don't get to the error I mentioned in my previous review #841 (review), that seems fixed with your changes in EditorPlatform, but still nothing happens.

jperedadnr · 2025-11-23T12:54:21Z

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/skeleton/TypeLookup.java

+ */
+class TypeLookup {
+
+    private String packageNamePrefix;


This should be final

jperedadnr · 2025-11-23T12:56:44Z

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/skeleton/TypeLookup.java

+        return new TypeLookup("javafx.").findFirstPublicInterfaceOrSuperclass(source);
+    }
+
+    public Optional<Class<?>> findFirstPublicInterfaceOrSuperclass(Object obj) {


This should be package-private (so it can be accessed by the test)

jperedadnr · 2025-11-23T12:59:19Z

kit/src/test/java/com/oracle/javafx/scenebuilder/kit/skeleton/TypeLookupTest.java

+        assertEquals(javafx.css.Styleable.class, result.get());
+    }
+
+    class CustomJavaFxType implements Styleable {


This class can be static

jperedadnr · 2025-11-23T13:10:14Z

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/skeleton/TypeLookup.java

+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.oracle.javafx.scenebuilder.kit.skeleton;


II wonder if this should belong to com.oracle.javafx.scenebuilder.kit.util

jperedadnr · 2025-11-23T13:16:06Z

...rc/test/resources/com/oracle/javafx/scenebuilder/kit/skeleton/fxinclude_with_fxid_outer.fxml

+         <children>
+            <fx:include fx:id="includedPane" source="fxinclude_with_fxid_inner.fxml" />
+            <Label fx:id="myLabel" text="Label" />
+            <Label fx:id="myLabel" text="Label" />


Duplicated line, remove

jperedadnr · 2025-11-23T13:26:49Z

...rc/test/resources/com/oracle/javafx/scenebuilder/kit/skeleton/fxinclude_with_fxid_outer.fxml

+
+<Pane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="400.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/23" xmlns:fx="http://javafx.com/fxml/1">
+   <children>
+      <HBox prefHeight="100.0" prefWidth="200.0">


The inner pane is too big, and pushes label and combo to the right

While this is totally fine for a test, if you want to play around with this, opening with SB, it is probably better to adjust it.
For instance, inner pane with pref size 100x50, and Box with pref size 100x400 gives

I added the red background to the inner panner just for testing, but I noticed an issue (for a follow up):
if you select the inner FXML Pane node from the hierarchy, the selection goes to its parent (the HBox) instead:

jperedadnr · 2025-11-23T13:32:08Z

...rc/test/resources/com/oracle/javafx/scenebuilder/kit/skeleton/fxinclude_with_fxid_outer.fxml

+            <Label fx:id="myLabel" text="Label" />
+			<ComboBox fx:id="descriptionFilter" editable="true" layoutX="226.0" layoutY="55.0" prefHeight="25.0" prefWidth="204.0" promptText="Series Description">
+				<items>
+					<FXCollections fx:id="myItems" fx:factory="observableArrayList">


The fix for the FXCollections works with TypeLookup, good work!

Oliver-Loeffler added this to the 26 milestone Oct 2, 2025

Oliver-Loeffler requested review from abhinayagarwal and jperedadnr October 2, 2025 18:40

Oliver-Loeffler self-assigned this Oct 2, 2025

Oliver-Loeffler force-pushed the issue-811 branch from 3c5c771 to 0eec13c Compare October 2, 2025 18:41

fix: Reference fields for <fx:include> elements, which have a 'fxid' …

01f1b3f

…assigned, are now added to the controller skeleton. (gluonhq#811)

Oliver-Loeffler force-pushed the issue-811 branch from 0eec13c to 01f1b3f Compare October 2, 2025 18:42

Oliver-Loeffler changed the title ~~fix: Reference fields for <fx:include> elements, which have a 'fxid' …~~ fix: adds <fx:include> elements to controller skeleton when a fxid is assigned (#811) Oct 2, 2025

build: updated surefire configuration so that kit module exposes the …

f8d6df4

…com.oracle.javafx.scenebuilder.kit.skeleton to ALL-UNNAMED to enable testing.

Oliver-Loeffler requested review from abhinayagarwal and removed request for abhinayagarwal October 2, 2025 19:10

jperedadnr reviewed Oct 14, 2025

View reviewed changes

kit/src/test/java/com/oracle/javafx/scenebuilder/kit/skeleton/SkeletonBufferJavaTest.java Show resolved Hide resolved

kit/src/main/java/com/oracle/javafx/scenebuilder/kit/skeleton/SkeletonContext.java Outdated Show resolved Hide resolved

Oliver-Loeffler added 2 commits October 14, 2025 17:36

fix: Introduced additional assertion to check size of collection bein…

faf7bd2

…g tested.

feat: Updated type resolution in skeleton context so, that nearest ja…

aaaeb20

…vafx-interface or nearest super class are selected as types.

Oliver-Loeffler force-pushed the issue-811 branch 2 times, most recently from 88d95b8 to a09948e Compare October 14, 2025 21:44

fix: Addressed the problem that the working dir is not set when tryin…

d38dcbb

…g to edit included files.

Oliver-Loeffler force-pushed the issue-811 branch from a09948e to d38dcbb Compare October 14, 2025 21:46

Added another constraint to force public classes only.

86eb099

jperedadnr reviewed Nov 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

fix: adds <fx:include> elements to controller skeleton when a fxid is assigned (#811)#841

fix: adds <fx:include> elements to controller skeleton when a fxid is assigned (#811)#841
Oliver-Loeffler wants to merge 6 commits intogluonhq:masterfrom
Oliver-Loeffler:issue-811

Oliver-Loeffler commented Oct 2, 2025

Uh oh!

jperedadnr left a comment

Uh oh!

Uh oh!

Uh oh!

Oliver-Loeffler commented Oct 14, 2025 •

edited

Loading

Uh oh!

jperedadnr left a comment

Uh oh!

jperedadnr Nov 23, 2025

Uh oh!

jperedadnr Nov 23, 2025

Uh oh!

jperedadnr Nov 23, 2025

Uh oh!

jperedadnr Nov 23, 2025

Uh oh!

jperedadnr Nov 23, 2025

Uh oh!

jperedadnr Nov 23, 2025

Uh oh!

jperedadnr Nov 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

Oliver-Loeffler commented Oct 2, 2025

Issue

Progress

Uh oh!

jperedadnr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Oliver-Loeffler commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jperedadnr left a comment

Choose a reason for hiding this comment

Uh oh!

jperedadnr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

jperedadnr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

jperedadnr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

jperedadnr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

jperedadnr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

jperedadnr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

jperedadnr Nov 23, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Oliver-Loeffler commented Oct 14, 2025 •

edited

Loading