Package dk.gtz.graphedit.util

Class EditorActions

java.lang.Object
dk.gtz.graphedit.util.EditorActions
public class EditorActions extends Object
The central point of all scriptable editor actions. These actions can help you modify the editor to your hearts content Plans are in the works to have scripting language bindings to these functions

  • Method Details

    • quit

      public static void quit()
      Will immediately quit the application with no hesitation.

    • addSaveListener

      public static void addSaveListener(Runnable runner)
      Register a callback function that will be called when the project is saved. This is useful to detect things such as "unsaved changes" and similar
      Parameters:
      runner - The callback function to call when projects are saved

    • removeSaveListener

      public static boolean removeSaveListener(Runnable runner)
      Remove a registered save callback function
      Parameters:
      runner - The callback function to remove
      Returns:
      true if the callback function was removed

    • saveAs

      public static void saveAs()
      Saves the currently opened project to disk. Will prompt the user for a path to save to.

    • save

      public static void save()
      Saves the currently opened project to disk. Will not throw any exceptions, but errors may be logged if something went awry.

    • loadEditorSettings

      public static ViewModelEditorSettings loadEditorSettings()
      Loads the global editor settings file and returns a viewmodel version of it. Note. Will provide a default setttings object if the file could not be loaded. Note. Will use the injected to serialize.
      Returns:
      the viewmodel representation of the editor settings

    • saveEditorSettings

      public static void saveEditorSettings(ViewModelEditorSettings settings)
      Save the global editor settings to disk. The location of the file is determined by Note. Will use the injected to serialize.
      Parameters:
      settings - the settings object to save to disk

    • openProject

      public static void openProject(File projectPath)
      Will attempt to open the project file provided Note. Will not prompt to save unsaved changes.
      Parameters:
      projectPath - the project file to load

    • openProject

      public static void openProject()
      Open the project picker dialogue and load the selected project

    • newProject

      public static void newProject()
      Create a new project with a picker dialogue and open it

    • restart

      public static void restart()
      Restart the application. Note. Will not prompt to save unsaved changes.

    • saveProject

      public static void saveProject(ModelProject project, Path projectFilePath)
      Save a model project to a specific file
      Parameters:
      project - The model project to save
      projectFilePath - The file to attempt to save to

    • saveProject

      public static void saveProject()
      Save the currently opened project to disk

    • openProjectPicker

      public static Optional<File> openProjectPicker(javafx.stage.Window window)
      Will open the project picker dialogue
      Parameters:
      window - the associated window
      Returns:
      Optionally a file if one was chosen otherwise empty

    • newFile

      public static Optional<File> newFile()
      Will open a "save as" file picker OS-native dialogue
      Returns:
      Optionally a file if one was chosen otherwise empty

    • toggleTheme

      public static void toggleTheme()
      Toggle between light and dark theme for the editor

    • openEditorSettings

      public static void openEditorSettings()
      Open the editor modal pane

    • openKeybinds

      public static void openKeybinds()
      Open the viewer modal pane

    • openTipOfTheDay

      public static void openTipOfTheDay()
      Open the tip of the day modal pane

    • openProjectSettings

      public static void openProjectSettings()
      Open the editor modal pane

    • openRunTargetsEditor

      public static void openRunTargetsEditor()
      Open the editor modal pane

    • openSearchPane

      public static void openSearchPane()
      Open the modal pane

    • openAboutPane

      public static void openAboutPane()
      Opens the about info pane modal

    • openModal

      public static void openModal(javafx.scene.Node node, String title)
      Opens an injected modal
      Parameters:
      node - The modal to show
      title - The title displayed at the top of the modal

    • openModal

      public static void openModal(String fxmlFile, String title)
      Opens an FXML based modal
      Parameters:
      fxmlFile - the .fxml file to open, must be from the perspective of
      title - The title displayed at the top of the modal

    • undo

      public static void undo()
      Perform an undo action

    • redo

      public static void redo()
      Perform a redo action

    • executeRunTarget

      public static void executeRunTarget(ViewModelRunTarget selectedRunTarget)
      Execute the provided runtarget Note. Will provide the action with all the default environment variables: PROJECT_NAME - the name of the currently open project PROJECT_DIR - the directory path to the currently open project
      Parameters:
      selectedRunTarget - the runtarget to execute

    • showConfirmDialog

      public static Optional<Boolean> showConfirmDialog(String questionTitle, String question, javafx.stage.Window window)
      Will prompt the user for a Confirm / Cancel action
      Parameters:
      questionTitle - prompt title
      question - the question to ask the user
      window - the parent window
      Returns:
      true if the user selected the affirmative action, false if user selected the negative action or Optional.empty if the prompt was closed with no action selected

    • showConfirmAllDialog

      public static Optional<javafx.scene.control.ButtonBar.ButtonData> showConfirmAllDialog(String questionTitle, String question, javafx.stage.Window window)
      Will prompt the user for a Confirm / Confirm All / Cancel action.
      Parameters:
      questionTitle - prompt title
      question - the question to ask the user
      window - the parent window
      Returns:
      ButtonData.YES if the user selected the Confirm action, ButtonData.NO if user selected cancel, ButtonData.OTHER if user selected confirm-all action or empty if the prompt was closed with no action selected

    • createNewModelFile

      public static void createNewModelFile(ModelProjectResource newModel)
      Prompt the user to create a new file and save the provided model If the file already exists, nothing will be saved
      Parameters:
      newModel - The model to serialize and save

    • openJsonFile

      public static Optional<File> openJsonFile()
      Prompt the user to pick a json file
      Returns:
      Possibly a file reference. Will be empty if the user cancelled the action

    • openFile

      public static Optional<File> openFile(String description, List<String> filterTypes)
      Prompt the user to pick a file of some provided type
      Parameters:
      description - Description of the allowed type
      filterTypes - The accepted filename extensions
      Returns:
      Possibly a file reference. Will be empty if the user cancelled the action

    • openFile

      public static Optional<File> openFile(javafx.stage.FileChooser.ExtensionFilter filter)
      Prompt the user to pick a file
      Parameters:
      filter - filter the types of files that can be picked
      Returns:
      Possibly a file reference. Will be empty if the user cancelled the action

    • openJsonFiles

      public static List<File> openJsonFiles()
      Prompt the user to pick one or more json files
      Returns:
      Possibly a list of file references. Will be empty if the user cancelled the action or selected no files

    • openFiles

      public static List<File> openFiles(String description, List<String> filterTypes)
      Prompt the user to pick one or more files of some provided type
      Parameters:
      description - Description of the allowed type
      filterTypes - The accepted filename extensions
      Returns:
      Possibly a list of file references. Will be empty if the user cancelled the action or selected no files

    • openFiles

      public static List<File> openFiles(javafx.stage.FileChooser.ExtensionFilter filter)
      Prompt the user to pick one or more files
      Parameters:
      filter - filter the types of files that can be picked
      Returns:
      Possibly a list of file references. Will be empty if the user cancelled the action or selected no files

    • openFolder

      public static Optional<File> openFolder()
      Prompt the user to pick a folder
      Returns:
      Possibly a folder reference. Will be empty if the user cancelled the action

    • exportFiles

      public static void exportFiles(IExporter exporter, Collection<File> files)
      Export the provided files using the provided exporter This will prompt the user to pick a folder to export to
      Parameters:
      exporter - The exporter to use
      files - The files to export

    • exportFiles

      public static void exportFiles(IExporter exporter, Collection<File> files, Path exportFolder)
      Export the provided files using the provided exporter to the provided folder
      Parameters:
      exporter - The exporter to use
      files - The files to export
      exportFolder - The folder to export to

    • openModel

      public static void openModel()
      Open a file as a model file. Will prompt the user to pick a file

    • openModel

      public static void openModel(Path path)
      Open specified path as a model file.
      Parameters:
      path - Path to a file to try to open as a model

    • createNewModelFile

      public static void createNewModelFile()
      Prompt the user to create a new file, that will become a new ModelProjectResource and save it If the file already exists, nothing will be saved

    • saveModelToFile

      public static void saveModelToFile(Path newFilePath, ModelProjectResource newModel) throws IOException
      Save a specified model to a specified file path
      Parameters:
      newFilePath - The path to write to
      newModel - The model to serialize and save
      Throws:
      IOException - If an I/O error ocurs writing or creating the file

    • createNewModel

      public static ModelProjectResource createNewModel(String modelName)
      Create a new empty project resource model object with a specified name
      Parameters:
      modelName - The name of the model
      Returns:
      A new empty model project resource with no syntactic elements

    • getConfigDir

      public static String getConfigDir()
      Get the primary directory where Graphedit looks for configurations
      Returns:
      Filepath as a string