Package com.nomagic.magicdraw.core.options

Class EnvironmentOptions

java.lang.Object
com.nomagic.magicdraw.core.options.EnvironmentOptions
@OpenApi public class EnvironmentOptions extends Object

Represents application environment options.

Application-related options are referred to as environment options. They are saved in the global.opt file that is located in <USER_HOME_DIR>/.magicdraw/<VERSION_NUMBER>/data.

You can add custom environment options for MagicDraw.

To add your own environment options

  • 1. Extend the AbstractPropertyOptionsGroup class.
  • 2. Add the extending class to application environment options.

Example: Adding custom environment options

 class MyOptionsGroup extends AbstractPropertyOptionsGroup
 {
     ...
 }

 Application application = Application.getInstance();
 EnvironmentOptions options = application.getEnvironmentOptions();
 options.addGroup(new ExampleOptionsGroup());
See Also:

  • Field Details

    • OPTIONS_FILE_PATH

      public static final String OPTIONS_FILE_PATH

  • Constructor Details

    • EnvironmentOptions

      public EnvironmentOptions()

  • Method Details

    • addGroup

      @OpenApi public void addGroup(OptionsGroup group)
      Adds an option group to the environment options.
      Parameters:
      group - option group to add.

    • removeGroup

      public void removeGroup(OptionsGroup group)

    • getGroups

      public List<OptionsGroup> getGroups()

    • getGroup

      public OptionsGroup getGroup(String id)

    • getDiagramOptions

      public com.nomagic.magicdraw.core.options.DiagramOptionsGroup getDiagramOptions()

    • getNotificationOptions

      public com.nomagic.magicdraw.core.options.NotificationOptionsGroup getNotificationOptions()
      Returns notification options group
      Returns:
      notification options group

    • getGeneralOptions

      public com.nomagic.magicdraw.core.options.GeneralOptionsGroup getGeneralOptions()

    • getBrowserOptions

      public com.nomagic.magicdraw.core.options.BrowserOptionsGroup getBrowserOptions()

    • getCompositionInspectionOptions

      public com.nomagic.magicdraw.core.options.CompositionInspectionGroup getCompositionInspectionOptions()

    • getTeamworkOptions

      public TeamworkOptionsGroup getTeamworkOptions()

    • getFloatingOptions

      public com.nomagic.magicdraw.core.options.FloatingOptionsGroup getFloatingOptions()

    • getExternalToolsOptions

      public com.nomagic.magicdraw.core.options.ExternalToolsOptionsGroup getExternalToolsOptions()

    • getExperienceOptionsGroup

      public com.nomagic.magicdraw.core.options.ExperienceOptionsGroup getExperienceOptionsGroup()

    • getNetworkOptions

      public com.nomagic.magicdraw.core.options.NetworkOptionsGroup getNetworkOptions()

    • getKeyboardOptions

      public com.nomagic.magicdraw.core.options.KeyboardOptionsGroup getKeyboardOptions()

    • getResourcesOptions

      public com.nomagic.magicdraw.core.options.ResourcesOptionsGroup getResourcesOptions()

    • getPathVariablesOptions

      @OpenApi public PathVariablesOptionsGroup getPathVariablesOptions()
      Get path variables options.
      Returns:
      path variables options group.

    • getSpellingOptions

      public com.nomagic.magicdraw.spellchecker.SpellingOptionsGroup getSpellingOptions()

    • getCustomMetalThemeOptions

      public com.nomagic.magicdraw.core.options.CustomMetalThemeOptionsGroup getCustomMetalThemeOptions()

    • getLaunchersOptionsGroup

      public com.nomagic.magicdraw.core.options.LaunchersOptionsGroup getLaunchersOptionsGroup()

    • getOrganicLayouterOptionsGroup

      public OrganicLayouterOptionsGroup getOrganicLayouterOptionsGroup()

    • getHierarchicLayouterOptionsGroup

      public HierarchicLayouterOptionsGroup getHierarchicLayouterOptionsGroup()

    • getCircularLayouterOptionsGroup

      public CircularLayouterOptionsGroup getCircularLayouterOptionsGroup()

    • getClassDiagramLayouterOptionsGroup

      public ClassDiagramLayouterOptionsGroup getClassDiagramLayouterOptionsGroup()

    • getOrthogonalLayouterOptionsGroup

      public OrthogonalLayouterOptionsGroup getOrthogonalLayouterOptionsGroup()

    • getTreeLayouterOptionsGroup

      public TreeLayouterOptionsGroup getTreeLayouterOptionsGroup()

    • getLinkRouterOptionsGroup

      public OrganicRouterOptionsGroup getLinkRouterOptionsGroup()

    • getSpecificationPropertiesOptionsGroup

      public com.nomagic.magicdraw.core.options.SpecificationPropertiesOptionsGroup getSpecificationPropertiesOptionsGroup()

    • getSymbolPropertiesOptionsGroup

      public com.nomagic.magicdraw.core.options.SymbolPropertiesOptionsGroup getSymbolPropertiesOptionsGroup()

    • load

      @CheckForNull public static StyleManager load(boolean silent)
      Load properties
      Parameters:
      silent - silent load mode
      Returns:
      loaded properties

    • applyLoadedData

      public void applyLoadedData(@CheckForNull com.nomagic.magicdraw.lic.MDVersion version, @CheckForNull StyleManager styleManager, boolean pluginsLoaded)

    • save

      public void save()
      Saves properties

    • optionsChanged

      public void optionsChanged(List<Property> props)
      Parameters:
      props - changed properties

    • addEnvironmentChangeListener

      @OpenApi public void addEnvironmentChangeListener(EnvironmentOptions.EnvironmentChangeListener listener)
      Adds environment change listener to environment options. Make sure to have a strong reference to the listener in the client code, because listeners are managed through weak references to avoid memory leaks.
      Parameters:
      listener - listener to add.

    • insertEnvironmentChangeListener

      public void insertEnvironmentChangeListener(EnvironmentOptions.EnvironmentChangeListener listener)
      Adds environment change listener to environment options. NOTE: Make sure to have a strong reference to the listener in the client code, because listeners are managed through weak references to avoid memory leaks.
      Parameters:
      listener - instance of EnvironmentOptions.EnvironmentChangeListener

    • removeEnvironmentChangeListener

      @OpenApi public void removeEnvironmentChangeListener(EnvironmentOptions.EnvironmentChangeListener listener)
      Removes environment change listener.
      Parameters:
      listener - listener to remove.