fix: enable Scene Builder to load FXML with unresolved imports (#120, #281, #733)

app/src/main/java/com/oracle/javafx/scenebuilder/app/DocumentWindowController.java

@@ -69,6 +69,7 @@
 import com.oracle.javafx.scenebuilder.kit.editor.selection.AbstractSelectionGroup;
 import com.oracle.javafx.scenebuilder.kit.editor.selection.ObjectSelectionGroup;
 import com.oracle.javafx.scenebuilder.kit.fxom.FXOMDocument;
+import com.oracle.javafx.scenebuilder.kit.fxom.FXOMDocument.FXOMDocumentSwitch;
 import com.oracle.javafx.scenebuilder.kit.fxom.FXOMNodes;
 import com.oracle.javafx.scenebuilder.kit.fxom.FXOMObject;
 import com.oracle.javafx.scenebuilder.kit.library.Library;
@@ -98,6 +99,7 @@
 import java.util.Optional;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import java.util.stream.Collectors;
 
 import javafx.beans.InvalidationListener;
 import javafx.beans.binding.Bindings;
@@ -125,6 +127,7 @@
 import javafx.scene.layout.VBox;
 import javafx.scene.paint.Color;
 import javafx.stage.FileChooser;
+import javafx.stage.Stage;
 import javafx.stage.FileChooser.ExtensionFilter;
 import javafx.stage.Window;
 import javafx.stage.WindowEvent;
@@ -402,7 +405,11 @@ public SplitController getDocumentSplitController() {
     public void loadFromFile(File fxmlFile) throws IOException {
         final URL fxmlURL = fxmlFile.toURI().toURL();
         final String fxmlText = FXOMDocument.readContentFromURL(fxmlURL);
-        editorController.setFxmlTextAndLocation(fxmlText, fxmlURL, false);
+
+        FXOMDocumentSwitch[] options = FXOMDocumentSwitch.PRESERVE_UNRESOLVED_IMPORTS
+                                                         .fromToggle(getPreferencesRecordGlobal().isPreserveUnresolvedImports());
+
+        editorController.setFxmlTextAndLocation(fxmlText, fxmlURL, false, options);
         updateLoadFileTime();
         updateStageTitle(); // No-op if fxml has not been loaded yet
         updateFromDocumentPreferences(true);
@@ -2355,6 +2362,37 @@ private PreferencesRecordGlobal getPreferencesRecordGlobal() {
         }
         return recordGlobal;
     }
+
+    public void showMissingTypesNotificationIfNeeded(File fxmlFile) {
+        FXOMDocument doc = getEditorController().getFxomDocument();
+        if (doc.hasUnresolvableTypes()) {
+            notifyUserAboutUnresolvableImports(fxmlFile, doc.getUnresolvableTypes(), getStage());
+        }
+    }
+
+    private void notifyUserAboutUnresolvableImports(File fxmlFile, List<String> missingTypes, Stage owner) {
+        LOGGER.log(Level.WARNING, "Detected unresolved types in FXML: {0}: {1}",
+                               new Object[] {fxmlFile, missingTypes.stream().collect(Collectors.joining(","))});
+
+        final ErrorDialog errorDialog = new ErrorDialog(owner);
+        String first10 = missingTypes.stream()
+                                     .limit(10)
+                                     .collect(Collectors.joining(";"+System.lineSeparator()));
+
+        errorDialog.setMessage(I18N.getString("alert.open.failure.unresolved.imports",
+                               Integer.toString(missingTypes.size())));
+        errorDialog.setDetails(I18N.getString("alert.open.failure.unresolved.imports.details", first10));
+        errorDialog.setDetailsTitle(I18N.getString("alert.open.failure.unresolved.imports",
+                                    Integer.toString(missingTypes.size())));
+
+        String allMissing = missingTypes.stream()
+                                        .collect(Collectors.joining(";"+System.lineSeparator()));
+
+        errorDialog.setDebugInfo(I18N.getString("alert.open.failure.unresolved.imports.advice",
+                                 allMissing, missingTypes.size()));
+        errorDialog.setTitle(I18N.getString("alert.title.open") + ": " + fxmlFile.getName());
+        errorDialog.showAndWait();
+    }
 }
 
 ///**

app/src/main/java/com/oracle/javafx/scenebuilder/app/SceneBuilderApp.java

@@ -531,7 +531,8 @@ public void handleOpenFilesAction(List<String> files, Runnable onSuccess) {
         EditorController.updateNextInitialDirectory(fileObjs.get(0));
 
         Consumer<Map<File, Exception>> onError = errors -> showFileOpenErrors(errors, 
-                                                            () -> WelcomeDialogWindowController.getInstance().getStage());
+                                                            () -> WelcomeDialogWindowController.getInstance()
+                                                                                               .getStage());
 
         // Fix for #45
         if (userLibrary.isFirstExplorationCompleted()) {
@@ -715,10 +716,14 @@ public DocumentWindowController getFrontDocumentWindow() {
     }
 
     private void performOpenFiles(List<File> fxmlFiles) {
-        performOpenFiles(fxmlFiles, r -> showFileOpenErrors(r, getOwnerWindow()), () -> { /* no action here */ } );
+        performOpenFiles(fxmlFiles, 
+                         r -> showFileOpenErrors(r, getOwnerWindow()),
+                         () -> { /* no action here */ } );
     }
 
-    private void performOpenFiles(List<File> fxmlFiles, Consumer<Map<File, Exception>> onError, Runnable onSuccess) {
+    private void performOpenFiles(List<File> fxmlFiles, 
+                                  Consumer<Map<File, Exception>> onError,
+                                  Runnable onSuccess) {
         assert fxmlFiles != null;
         assert fxmlFiles.isEmpty() == false;
 
@@ -740,6 +745,7 @@ private void performOpenFiles(List<File> fxmlFiles, Consumer<Map<File, Exception
                     hostWindow.openWindow();
                     openedFiles.add(fxmlFile);
                     LOGGER.log(Level.INFO, "Successfully opened file {0}", fxmlFile);
+                    hostWindow.showMissingTypesNotificationIfNeeded(fxmlFile);
                 }
             } catch (Exception xx) {
                 LOGGER.log(Level.WARNING, "Failed to open file: %s".formatted(fxmlFile), xx);
@@ -752,7 +758,7 @@ private void performOpenFiles(List<File> fxmlFiles, Consumer<Map<File, Exception
             final PreferencesController pc = PreferencesController.getSingleton();
             pc.getRecordGlobal().addRecentItems(openedFiles);
         }
-
+        
         if (exceptionsPerFile.isEmpty()) {
             LOGGER.log(Level.FINE, "Successfully opened all files.");
             onSuccess.run();

app/src/main/java/com/oracle/javafx/scenebuilder/app/preferences/PreferencesRecordGlobal.java

@@ -101,6 +101,7 @@ public String toString() {
     static final boolean DEFAULT_ACCORDION_ANIMATION = true;
     static final boolean DEFAULT_WILDCARD_IMPORTS = false;
     static final boolean DEFAULT_ALTERNATE_TEXT_INPUT_PASTE = EditorPlatform.IS_MAC;
+    static final boolean DEFAULT_PRESERVE_UNRESOLVED_IMPORTS = true;
 
     static final EditorPlatform.Theme DEFAULT_GLUON_SWATCH = GluonEditorPlatform.DEFAULT_GLUON_SWATCH;
     static final EditorPlatform.Theme DEFAULT_GLUON_THEME = GluonEditorPlatform.DEFAULT_GLUON_THEME;
@@ -121,6 +122,7 @@ public String toString() {
     private int recentItemsSize = DEFAULT_RECENT_ITEMS_SIZE;
     private boolean accordionAnimation = DEFAULT_ACCORDION_ANIMATION;
     private boolean wildcardImports = DEFAULT_WILDCARD_IMPORTS;
+    private boolean preserveUnresolvedImports = DEFAULT_PRESERVE_UNRESOLVED_IMPORTS;
     private final List<String> recentItems = new ArrayList<>();
 
     private LocalDate showUpdateDialogDate = null;
@@ -400,6 +402,14 @@ public void setWildcardImports(boolean wildcardImports) {
         this.wildcardImports = wildcardImports;
     }
 
+    public boolean isPreserveUnresolvedImports() {
+        return this.preserveUnresolvedImports;
+    }
+
+    public void setPreserveUnresolvedImports(boolean preserveUnresolvedImports) {
+        this.preserveUnresolvedImports = preserveUnresolvedImports;
+    }
+
     public boolean isAlternateTextInputControlPaste() {
         return alternatePasteBehavior;
     }
@@ -501,6 +511,9 @@ public void readFromJavaPreferences() {
         // Wildcard imports
         setWildcardImports(applicationRootPreferences.getBoolean(WILDCARD_IMPORT, DEFAULT_WILDCARD_IMPORTS));
 
+        // Unresolvable Imports
+        setPreserveUnresolvedImports(applicationRootPreferences.getBoolean(PRESERVE_UNRESOLVED_IMPORTS, DEFAULT_PRESERVE_UNRESOLVED_IMPORTS));
+
         // Alternate paste behavior for Text Input Controls
         setAlternateTextInputControlPaste(applicationRootPreferences.getBoolean(ALTERNATE_TEXT_INPUT_PASTE, DEFAULT_ALTERNATE_TEXT_INPUT_PASTE));
     }
@@ -578,6 +591,9 @@ public void writeToJavaPreferences(String key) {
             case ALTERNATE_TEXT_INPUT_PASTE:
                 applicationRootPreferences.putBoolean(ALTERNATE_TEXT_INPUT_PASTE,isAlternateTextInputControlPaste());
                 break;
+            case PRESERVE_UNRESOLVED_IMPORTS:
+                applicationRootPreferences.putBoolean(PRESERVE_UNRESOLVED_IMPORTS, isPreserveUnresolvedImports());
+                break;
             default:
                 super.writeToJavaPreferences(key);
                 break;

app/src/main/java/com/oracle/javafx/scenebuilder/app/preferences/PreferencesWindowController.java

@@ -55,6 +55,7 @@
 import static com.oracle.javafx.scenebuilder.app.preferences.PreferencesController.TOOL_THEME;
 import static com.oracle.javafx.scenebuilder.app.preferences.PreferencesController.WILDCARD_IMPORT;
 import static com.oracle.javafx.scenebuilder.app.preferences.PreferencesController.ALTERNATE_TEXT_INPUT_PASTE;
+import static com.oracle.javafx.scenebuilder.app.preferences.PreferencesController.PRESERVE_UNRESOLVED_IMPORTS;
 
 import static com.oracle.javafx.scenebuilder.kit.preferences.PreferencesRecordGlobalBase.DEFAULT_ALIGNMENT_GUIDES_COLOR;
 import static com.oracle.javafx.scenebuilder.kit.preferences.PreferencesRecordGlobalBase.DEFAULT_BACKGROUND_IMAGE;
@@ -143,6 +144,8 @@ public class PreferencesWindowController extends AbstractFxmlWindowController {
     @FXML
     private CheckBox wildcardImports;
     @FXML
+    private CheckBox preserveUnresolvedImports;
+    @FXML
     private CheckBox alternatePasteBehavior;
     @FXML
     private Label alternatePasteBehaviorLabel;
@@ -265,6 +268,10 @@ protected void controllerDidLoadFxml() {
         // Wildcard Imports
         wildcardImports.setSelected(recordGlobal.isWildcardImports());
         wildcardImports.selectedProperty().addListener(new WildcardImportListener());
+
+        // Unresolvable Imports
+        preserveUnresolvedImports.setSelected(recordGlobal.isPreserveUnresolvedImports());
+        preserveUnresolvedImports.selectedProperty().addListener(new PreserveUnresolvedImportListener());
 
         if (EditorPlatform.IS_MAC) {
             // Alternate paste behavior for Text Input Controls
@@ -594,6 +601,17 @@ public void changed(ObservableValue<? extends Boolean> observable, Boolean oldVa
         }
     }
 
+    private static class PreserveUnresolvedImportListener implements ChangeListener<Boolean> {
+
+        @Override
+        public void changed(ObservableValue<? extends Boolean> observable, Boolean oldValue, Boolean newValue) {
+            final PreferencesController preferencesController = PreferencesController.getSingleton();
+            final PreferencesRecordGlobal recordGlobal = preferencesController.getRecordGlobal();
+            recordGlobal.setPreserveUnresolvedImports(newValue);
+            recordGlobal.writeToJavaPreferences(PRESERVE_UNRESOLVED_IMPORTS);
+        }
+    }
+
     private static class AlternatePasteListener implements ChangeListener<Boolean> {
 
         @Override

app/src/main/resources/com/oracle/javafx/scenebuilder/app/i18n/SceneBuilderApp.properties

@@ -250,6 +250,7 @@ prefs.cssanalyzer.columns.defaults.last = "Defaults" Column Last
 prefs.recent.items = Recent items :
 prefs.animate.accordion = Animate Accordion :
 prefs.wildcard.import = Use Wildcard Imports :
+prefs.preserve.unresolved.import = Load FXML with unresolved imports :
 prefs.tic.paste.alternate.behavior = Alternative paste behavior for text input :
 prefs.tic.paste.alternate.behavior.tooltip = MacOS only: Enables workaround for pasting into text input controls.\nDisable when pasting text is not working as expected. 
 prefs.reset.default = Reset to Builtin Default Values
@@ -431,12 +432,15 @@ alert.save.noextension.savewith = Save with '.fxml'
 alert.save.noextension.savewithout = Save without '.fxml'
 alert.open.failure.charset.not.found = The given charset could not be set.
 alert.open.failure.charset.not.found.details = It may be due to the encoding in your document.
+alert.open.failure.unresolved.imports = Failed to resolve {0} FXML import(s):
+alert.open.failure.unresolved.imports.details = Use Show Details to obtain a full list of unresolveable imports:\n\n{0}\n\nScene Builder will open the FXML for editing but the custom content will not be rendered correctly.\n\nUnresolved UI elements will be removed from FXML when the file is saved.\n\nPlease add the missing components to your user library within the JAR/FXML Manager. If individual class files are used, make sure, those are organized in a directory structure matching the package structure.\n\n
+alert.open.failure.unresolved.imports.advice = Please add the missing components to your user library within the JAR/FXML Manager.\nIf individual class files are used, make sure, those are organized in a directory structure matching the package structure.\n\n{0}\n\nA total of {1} unresolvable import(s) was found.\n
 alert.welcome.file.not.found.question = One or more project files were not found.
 alert.welcome.file.not.found.message = If those are located on a removable or network drive, please make sure the drive is connected.\n\n
 alert.welcome.file.not.found.title = Project file(s) not found
 alert.welcome.file.not.found.okay  = Remove From List
 alert.welcome.file.not.found.no = OK
-  
+
 # -----------------------------------------------------------------------------
 # Log Messages
 # -----------------------------------------------------------------------------

app/src/main/resources/com/oracle/javafx/scenebuilder/app/preferences/Preferences.fxml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <!--
-  Copyright (c) 2016, 2019, Gluon and/or its affiliates.
+  Copyright (c) 2016, 2024, Gluon and/or its affiliates.
   Copyright (c) 2012, 2014, Oracle and/or its affiliates.
   All rights reserved. Use is subject to license terms.
 
@@ -50,7 +50,7 @@
 <?import javafx.scene.layout.RowConstraints?>
 <?import javafx.scene.shape.Rectangle?>
 
-<GridPane hgap="6.0" maxWidth="1.7976931348623157E308" styleClass="theme-presets" vgap="10.0" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1">
+<GridPane hgap="6.0" maxWidth="1.7976931348623157E308" prefHeight="-Infinity" prefWidth="550.0" styleClass="theme-presets" vgap="10.0" xmlns="http://javafx.com/javafx/19" xmlns:fx="http://javafx.com/fxml/1">
   <children>
     <Label text="%prefs.doc.width" GridPane.columnIndex="0" GridPane.rowIndex="0" />
     <DoubleField fx:id="rootContainerWidth" prefWidth="200.0" text="" GridPane.columnIndex="1" GridPane.rowIndex="0" />
@@ -127,11 +127,11 @@
                 <Label text="%prefs.wildcard.import" GridPane.columnIndex="0" GridPane.rowIndex="18" />
     <CheckBox fx:id="wildcardImports" selected="true" GridPane.columnIndex="1" GridPane.rowIndex="18" />
 
-                <Button onAction="#resetToDefaultAction" prefWidth="-1.0" text="%prefs.reset.default" GridPane.columnSpan="2" GridPane.halignment="CENTER" GridPane.rowIndex="21">
+                <Button onAction="#resetToDefaultAction" prefWidth="-1.0" text="%prefs.reset.default" GridPane.columnSpan="2" GridPane.halignment="CENTER" GridPane.rowIndex="22">
          <GridPane.margin>
             <Insets top="-10.0" />
          </GridPane.margin></Button>
-      <GridPane fx:id="alternatePasteBehaviorPane" hgap="5.0" vgap="10.0" GridPane.columnSpan="2" GridPane.rowIndex="20">
+      <GridPane fx:id="alternatePasteBehaviorPane" hgap="5.0" vgap="10.0" GridPane.columnSpan="2" GridPane.rowIndex="21">
         <columnConstraints>
           <ColumnConstraints halignment="RIGHT" hgrow="ALWAYS" percentWidth="50.0" />
           <ColumnConstraints halignment="LEFT" hgrow="ALWAYS" percentWidth="50.0" />
@@ -157,7 +157,9 @@
                </GridPane.margin></Separator>
          </children>
       </GridPane>
-      <Separator layoutX="30.0" layoutY="500.0" prefWidth="-1.0" GridPane.columnSpan="2" GridPane.rowIndex="19" />
+      <Separator layoutX="30.0" layoutY="500.0" prefWidth="-1.0" GridPane.columnSpan="2" GridPane.rowIndex="20" />
+      <Label text="%prefs.preserve.unresolved.import" GridPane.rowIndex="19" />
+      <CheckBox fx:id="preserveUnresolvedImports" mnemonicParsing="false" GridPane.columnIndex="1" GridPane.rowIndex="19" />
   </children>
   <columnConstraints>
     <ColumnConstraints halignment="RIGHT" hgrow="SOMETIMES" maxWidth="-Infinity" minWidth="-Infinity" percentWidth="50.0" />
@@ -189,5 +191,6 @@
     <RowConstraints maxHeight="-Infinity" minHeight="-Infinity" vgrow="NEVER" />
     <RowConstraints maxHeight="-Infinity" minHeight="-Infinity" vgrow="NEVER" />
     <RowConstraints maxHeight="-Infinity" minHeight="-Infinity" vgrow="NEVER" />
+    <RowConstraints maxHeight="-Infinity" minHeight="-Infinity" vgrow="NEVER" />
   </rowConstraints>
 </GridPane>

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

@@ -707,10 +707,11 @@ public void setFxmlTextAndLocation(String fxmlText, URL fxmlLocation) throws IOE
      * @param fxmlLocation null or the location of the fxml text being edited
      * @param checkTheme if set to true a check will be made if the fxml contains
      *                           Gluon controls and if so, the correct theme is set
+     * @param switches Optional switches to configure FXOM and FXML processes
      * @throws IOException if fxml text cannot be parsed and loaded correctly.
      */
-    public void setFxmlTextAndLocation(String fxmlText, URL fxmlLocation, boolean checkTheme) throws IOException {
-        updateFxomDocument(fxmlText, fxmlLocation, getResources(), checkTheme);
+    public void setFxmlTextAndLocation(String fxmlText, URL fxmlLocation, boolean checkTheme, FXOMDocumentSwitch ... switches) throws IOException {
+        updateFxomDocument(fxmlText, fxmlLocation, getResources(), checkTheme, switches);
         this.fxmlLocationProperty.setValue(fxmlLocation);
     }
 
@@ -2513,11 +2514,12 @@ private boolean isSelectionControl() {
         return true;
     }
 
-    private void updateFxomDocument(String fxmlText, URL fxmlLocation, ResourceBundle resources, boolean checkTheme) throws IOException {
+    private void updateFxomDocument(String fxmlText, URL fxmlLocation, ResourceBundle resources, boolean checkTheme, FXOMDocumentSwitch ... switches) throws IOException {
         final FXOMDocument newFxomDocument;
 
         if (fxmlText != null) {
-            newFxomDocument = new FXOMDocument(fxmlText, fxmlLocation, getLibrary().getClassLoader(), resources, FXOMDocumentSwitch.NORMALIZED);
+            FXOMDocumentSwitch[] options = FXOMDocumentSwitch.combined(switches, FXOMDocumentSwitch.NORMALIZED);
+            newFxomDocument = new FXOMDocument(fxmlText, fxmlLocation, getLibrary().getClassLoader(), resources, options);
         } else {
             newFxomDocument = null;
         }