Package com.nomagic.magicdraw.actions

Class ActionsConfiguratorsManager

java.lang.Object
com.nomagic.magicdraw.actions.ActionsConfiguratorsManager
@OpenApi public final class ActionsConfiguratorsManager extends Object
The singleton class for adding/removing configurations of actions managers in MagicDraw application.

  • Method Details

    • getInstance

      @OpenApi public static ActionsConfiguratorsManager getInstance()
      Returns shared instance of this manager.

    • addTargetElementAMConfigurator

      @OpenApi public void addTargetElementAMConfigurator(String diagramType, TargetElementAMConfigurator configurator)
      Adds new drawable targets configurator in context toolbar for given diagram type
      Parameters:
      diagramType - diagram type
      configurator - configurator to be added.

    • removeTargetElementAMConfigurator

      @OpenApi public void removeTargetElementAMConfigurator(String diagramType, TargetElementAMConfigurator configurator)
      Removes drawable targets' configurator for given diagram type
      Parameters:
      diagramType - diagram type
      configurator - configurator to be added.

    • configureTargetElementAM

      @OpenApi public void configureTargetElementAM(String diagramType, ActionsManager manager, PresentationElement requestor, String pathActionID)
      Configures given diagram type drawable targets.
      Parameters:
      diagramType - diagram type
      manager - manager to be configured.
      requestor - - object which requests actions, can be null if requestor is diagram window.

    • addDiagramContextToolbarConfigurator

      @OpenApi public void addDiagramContextToolbarConfigurator(String diagramType, DiagramContextToolbarAMConfigurator configurator)
      Adds new toolbar configurator for given diagram type.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be added.

    • removeDiagramContextToolbarConfigurator

      @OpenApi public void removeDiagramContextToolbarConfigurator(String diagramType, DiagramContextToolbarAMConfigurator configurator)
      Removes configurator from given diagram toolbar configurators.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be removed.

    • removeBaseDiagramContextToolbarConfigurator

      @OpenApi public void removeBaseDiagramContextToolbarConfigurator(String diagramType, DiagramContextToolbarAMConfigurator configurator)
      Removes given configurator from given diagram type context configurators. This configurator will be removed to the given type of the
      Parameters:
      diagramType - diagram type
      configurator - configurator to remove.

    • addDiagramContextConfigurator

      @OpenApi public void addDiagramContextConfigurator(String diagramType, DiagramContextAMConfigurator configurator)
      Adds new diagram context configurator for given diagram type.
      Parameters:
      diagramType - diagram type
      configurator - new configurator to add.

    • addBaseDiagramContextConfigurator

      @OpenApi public void addBaseDiagramContextConfigurator(String diagramType, DiagramContextAMConfigurator configurator)
      Adds new diagram context configurator for given diagram type. This configurator will be added to the given type of the diagram and to all derived diagram types.
      Parameters:
      diagramType - diagram type
      configurator - new configurator to add.

    • addBaseDiagramContextConfigurator

      @OpenApi public void addBaseDiagramContextConfigurator(String diagramType, com.dassault_systemes.modeler.magic.ui.diagrams.actions.AbstractDiagramContextAMConfigurator configurator)
      Adds new diagram context configurator for given diagram type. This configurator will be added to the given type of the diagram and to all derived diagram types.
      Parameters:
      diagramType - diagram type
      configurator - new configurator to add.

    • removeDiagramContextConfigurator

      @OpenApi public void removeDiagramContextConfigurator(String diagramType, DiagramContextAMConfigurator configurator)
      Removes given configurator from given diagram type context configurators.
      Parameters:
      diagramType - diagram type
      configurator - configurator to remove.

    • removeBaseDiagramContextConfigurator

      @OpenApi public void removeBaseDiagramContextConfigurator(String diagramType, DiagramContextAMConfigurator configurator)
      Removes given configurator from given diagram type context configurators. This configurator will be removed to the given type of the
      Parameters:
      diagramType - diagram type
      configurator - configurator to remove.

    • addDiagramCommandBarConfigurator

      @OpenApi @Deprecated public void addDiagramCommandBarConfigurator(AMConfigurator configurator)
      Deprecated.
      deprecated because of too generic name. Use addSymbolDiagramCommandBarConfigurator(AMConfigurator)
      Add configurator for any type of "symbol" diagrams Those do not include tables, maps, matrices and etc.
      Parameters:
      configurator - configurator to be added.

    • removeDiagramCommandBarConfigurator

      @OpenApi @Deprecated public void removeDiagramCommandBarConfigurator(AMConfigurator configurator)
      Deprecated.
      deprecated because of too generic name. Use removeSymbolDiagramCommandBarConfigurator(AMConfigurator)
      Remove configurator for any type "symbol" diagrams Those do not include tables, maps, matrices and etc.
      Parameters:
      configurator - configurator to be removed.

    • addSymbolDiagramCommandBarConfigurator

      @OpenApi public void addSymbolDiagramCommandBarConfigurator(AMConfigurator configurator)
      Add configurator for any type of "symbol" diagrams Those do not include tables, maps, matrices and etc.
      Parameters:
      configurator - configurator to be added.

    • removeSymbolDiagramCommandBarConfigurator

      @OpenApi public void removeSymbolDiagramCommandBarConfigurator(AMConfigurator configurator)
      Remove configurator for any type "symbol" diagrams Those do not include tables, maps, matrices and etc.
      Parameters:
      configurator - configurator to be removed.

    • addAnyDiagramCommandBarConfigurator

      @OpenApi public void addAnyDiagramCommandBarConfigurator(AMConfigurator configurator)
      Registers configurator for any type of diagrams.
      Parameters:
      configurator - configurator to be added.

    • removeAnyDiagramCommandBarConfigurator

      @OpenApi public void removeAnyDiagramCommandBarConfigurator(AMConfigurator configurator)
      Remove configurator for any type diagrams.
      Parameters:
      configurator - configurator to be removed.

    • addDiagramCommandBarConfigurator

      @OpenApi public void addDiagramCommandBarConfigurator(String diagramType, AMConfigurator configurator)
      Add configurator for diagram of given type.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be added.

    • removeDiagramCommandBarConfigurator

      @OpenApi public void removeDiagramCommandBarConfigurator(String diagramType, AMConfigurator configurator)
      Remove configurator for diagram of given type.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be removed.

    • addDiagramToolbarConfigurator

      @OpenApi public void addDiagramToolbarConfigurator(String diagramType, AMConfigurator configurator)
      Adds new toolbar configurator for given diagram type.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be added.

    • removeDiagramToolbarConfigurator

      @OpenApi public void removeDiagramToolbarConfigurator(String diagramType, AMConfigurator configurator)
      Removes configurator from given diagram toolbar configurators.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be removed.

    • addAnyDiagramShortcutsConfigurator

      @OpenApi public void addAnyDiagramShortcutsConfigurator(AMConfigurator configurator)
      Adds configurator for any type diagram.
      Parameters:
      configurator - configurator to be added.

    • removeAnyDiagramShortcutsConfigurator

      @OpenApi public void removeAnyDiagramShortcutsConfigurator(AMConfigurator configurator)
      Removes configurator from any type diagram.
      Parameters:
      configurator - configurator to be removed.

    • addSymbolDiagramShortcutsConfigurator

      @OpenApi public void addSymbolDiagramShortcutsConfigurator(AMConfigurator configurator)
      Adds configurator for any "symbol" diagram. Those diagrams do not include tables, maps, matrices and etc.
      Parameters:
      configurator - configurator to be added.

    • removeSymbolDiagramShortcutsConfigurator

      @OpenApi public void removeSymbolDiagramShortcutsConfigurator(AMConfigurator configurator)
      Removes configurator from any "symbol" diagram. Those diagrams do not include tables, maps, matrices and etc.
      Parameters:
      configurator - configurator to be removed.

    • addDiagramShortcutsConfigurator

      @OpenApi public void addDiagramShortcutsConfigurator(String diagramType, AMConfigurator configurator)
      Adds new shortcuts' configurator for given diagram type.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be added.

    • removeDiagramShortcutsConfigurator

      @OpenApi public void removeDiagramShortcutsConfigurator(String diagramType, AMConfigurator configurator)
      Removes configurator from given diagram type shortcuts configurators.
      Parameters:
      diagramType - diagram type
      configurator - configurator to be removed.

    • addInheritanceBrowserContextConfigurator

      @OpenApi public void addInheritanceBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Adds new context configurator to inheritance browser.
      Parameters:
      configurator - configurator to be added.

    • removeInheritanceBrowserContextConfigurator

      @OpenApi public void removeInheritanceBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Removes context configurator from inheritance browser.
      Parameters:
      configurator - configurator to be removed.

    • addDiagramsBrowserContextConfigurator

      @OpenApi public void addDiagramsBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Adds new context configurator to diagrams browser.
      Parameters:
      configurator - configurator to be added.

    • removeDiagramsBrowserContextConfigurator

      @OpenApi public void removeDiagramsBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Removes context configurator from diagrams browser.
      Parameters:
      configurator - configurator to be removed.

    • addLockViewBrowserContextConfigurator

      @OpenApi public void addLockViewBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Adds new context configurator to lock view browser.
      Parameters:
      configurator - configurator to be added.

    • removeLockViewBrowserContextConfigurator

      @OpenApi public void removeLockViewBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Removes context configurator from lock view browser.
      Parameters:
      configurator - configurator to be removed.

    • addContainmentBrowserContextConfigurator

      @OpenApi public void addContainmentBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Adds new context configurator to containment browser.
      Parameters:
      configurator - configurator to be added.

    • removeContainmentBrowserContextConfigurator

      @OpenApi public void removeContainmentBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Removes context configurator from containment browser.
      Parameters:
      configurator - configurator to be removed.

    • addExtensionsBrowserContextConfigurator

      @OpenApi public void addExtensionsBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Adds new context configurator to extensions browser.
      Parameters:
      configurator - configurator to be added.

    • removeExtensionsBrowserContextConfigurator

      @OpenApi public void removeExtensionsBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Removes context configurator from extensions browser.
      Parameters:
      configurator - configurator to be removed.

    • addSearchBrowserContextConfigurator

      @OpenApi public void addSearchBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Adds new context configurator for search browser.
      Parameters:
      configurator - configurator to be added.

    • removeSearchBrowserContextConfigurator

      @OpenApi public void removeSearchBrowserContextConfigurator(BrowserContextAMConfigurator configurator)
      Removes context configurator from search browser.
      Parameters:
      configurator - configurator to be removed.

    • addInheritanceBrowserToolbarConfigurator

      @OpenApi public void addInheritanceBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Adds new context configurator to inheritance browser.
      Parameters:
      configurator - configurator to be added.

    • removeInheritanceBrowserToolbarConfigurator

      @OpenApi public void removeInheritanceBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Removes context configurator from inheritance browser.
      Parameters:
      configurator - configurator to be removed.

    • addDiagramsBrowserToolbarConfigurator

      @OpenApi public void addDiagramsBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Adds new Toolbar configurator to diagrams browser.
      Parameters:
      configurator - configurator to be added.

    • removeDiagramsBrowserToolbarConfigurator

      @OpenApi public void removeDiagramsBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Removes Toolbar configurator from diagrams browser.
      Parameters:
      configurator - configurator to be removed.

    • addLockViewBrowserToolbarConfigurator

      @OpenApi public void addLockViewBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Adds new context configurator to inheritance browser.
      Parameters:
      configurator - configurator to be added.

    • removeLockViewBrowserToolbarConfigurator

      @OpenApi public void removeLockViewBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Removes context configurator from inheritance browser.
      Parameters:
      configurator - configurator to be removed.

    • addContainmentBrowserToolbarConfigurator

      @OpenApi public void addContainmentBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Adds new Toolbar configurator to containment browser.
      Parameters:
      configurator - configurator to be added.

    • removeContainmentBrowserToolbarConfigurator

      @OpenApi public void removeContainmentBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Removes Toolbar configurator from containment browser.
      Parameters:
      configurator - configurator to be removed.

    • addExtensionsBrowserToolbarConfigurator

      @OpenApi public void addExtensionsBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Adds new Toolbar configurator to extensions browser.
      Parameters:
      configurator - configurator to be added.

    • removeExtensionsBrowserToolbarConfigurator

      @OpenApi public void removeExtensionsBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Removes Toolbar configurator from extensions browser.
      Parameters:
      configurator - configurator to be removed.

    • addSearchBrowserToolbarConfigurator

      @OpenApi public void addSearchBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Adds new Toolbar configurator for search browser.
      Parameters:
      configurator - configurator to be added.

    • removeSearchBrowserToolbarConfigurator

      @OpenApi public void removeSearchBrowserToolbarConfigurator(BrowserToolbarAMConfigurator configurator)
      Removes Toolbar configurator from search browser.
      Parameters:
      configurator - configurator to be removed.

    • addInheritanceBrowserShortcutsConfigurator

      @OpenApi public void addInheritanceBrowserShortcutsConfigurator(AMConfigurator configurator)
      Adds new shortcuts' configurator to inheritance browser.
      Parameters:
      configurator - configurator to be added.

    • removeInheritanceBrowserShortcutsConfigurator

      @OpenApi public void removeInheritanceBrowserShortcutsConfigurator(AMConfigurator configurator)
      Removes shortcuts configurator from inheritance browser.
      Parameters:
      configurator - configurator to be removed.

    • addDiagramsBrowserShortcutsConfigurator

      @OpenApi public void addDiagramsBrowserShortcutsConfigurator(AMConfigurator configurator)
      Adds new shortcuts' configurator to diagrams browser.
      Parameters:
      configurator - configurator to be added.

    • removeDiagramsBrowserShortcutsConfigurator

      @OpenApi public void removeDiagramsBrowserShortcutsConfigurator(AMConfigurator configurator)
      Removes shortcuts configurator from diagrams browser.
      Parameters:
      configurator - configurator to be removed.

    • addLockViewBrowserShortcutsConfigurator

      @OpenApi public void addLockViewBrowserShortcutsConfigurator(AMConfigurator configurator)
      Adds new shortcuts' configurator to lock view browser.
      Parameters:
      configurator - configurator to be added.

    • removeLockViewBrowserShortcutsConfigurator

      @OpenApi public void removeLockViewBrowserShortcutsConfigurator(AMConfigurator configurator)
      Removes shortcuts configurator from lock view browser.
      Parameters:
      configurator - configurator to be removed.

    • addExtensionsBrowserShortcutsConfigurator

      @OpenApi public void addExtensionsBrowserShortcutsConfigurator(AMConfigurator configurator)
      Adds new shortcuts' configurator to extensions browser.
      Parameters:
      configurator - configurator to be added.

    • removeExtensionsBrowserShortcutsConfigurator

      @OpenApi public void removeExtensionsBrowserShortcutsConfigurator(AMConfigurator configurator)
      Removes shortcuts configurator from extensions browser.
      Parameters:
      configurator - configurator to be removed.

    • addSearchBrowserShortcutsConfigurator

      @OpenApi public void addSearchBrowserShortcutsConfigurator(AMConfigurator configurator)
      Adds new shortcuts' configurator to search browser.
      Parameters:
      configurator - configurator to be added.

    • removeSearchBrowserShortcutsConfigurator

      @OpenApi public void removeSearchBrowserShortcutsConfigurator(AMConfigurator configurator)
      Removes shortcuts configurator from search browser.
      Parameters:
      configurator - configurator to be removed.

    • addContainmentBrowserShortcutsConfigurator

      @OpenApi public void addContainmentBrowserShortcutsConfigurator(AMConfigurator configurator)
      Adds new shortcuts' configurator to containment browser.
      Parameters:
      configurator - configurator to be added.

    • removeContainmentBrowserShortcutsConfigurator

      @OpenApi public void removeContainmentBrowserShortcutsConfigurator(AMConfigurator configurator)
      Removes shortcuts configurator from containment browser.
      Parameters:
      configurator - configurator to be removed.

    • removeMainMenuConfigurator

      @OpenApi public void removeMainMenuConfigurator(AMConfigurator configurator)
      Removes configurator from main menu configuration.
      Parameters:
      configurator - configurator to remove.

    • addMainMenuConfigurator

      @OpenApi public void addMainMenuConfigurator(AMConfigurator configurator)
      Adds configurator to main menu. This method should be called before menu becomes visible.
      Parameters:
      configurator - configurator will be added.

    • addCreateDiagramDialogConfigurator

      @OpenApi public void addCreateDiagramDialogConfigurator(AMConfigurator configurator)
      Adds configurator to configure actions inside the dialog which opens when action in main menu or toolbar "Create Diagram" is executed. To configure actions inside context menu please see addDialogActionsConfigurator(String, ActionsManager, AMConfigurator)
      Parameters:
      configurator - actions configurator

    • removeCreateDiagramDialogConfigurator

      @OpenApi public void removeCreateDiagramDialogConfigurator(AMConfigurator configurator)
      Remove configurator to configure actions inside "Create Diagram" dialog.
      Parameters:
      configurator - configurator to be removed

    • addDialogActionsConfigurator

      @OpenApi public static void addDialogActionsConfigurator(String categoryID, ActionsManager manager, AMConfigurator configurator)
      Adds configurator to configure actions inside specific popup dialog which constructs its actions only when respective popup menu item is clicked.

      Call this method inside BrowserContextAMConfigurator.configure(ActionsManager, Tree) in order to configure browser context menu actions. Call this method inside (@link DiagramContextAMConfigurator.configure(ActionsManager, DiagramPresentationElement, PresentationElement[], PresentationElement) to configure diagram context menu actions

      Parameters:
      categoryID - id of the category which represents the dialog to be configured. Most common examples:
      ActionsID.NEW_ELEMENT_CATEGORY_ID - to configure "Create Element" context action
      ActionsID.NEW_DIAGRAM_CATEGORY_ID - to configure "Create Diagram" context action
      ActionsID.NEW_RELATION_CATEGORY_FROM_ID - to configure "Create Relation->Outgoing" context action
      ActionsID.NEW_RELATION_CATEGORY_TO_ID - to configure "Create Relation->Outgoing" context action
      manager - actions manager that contains the category with the given id. Category may be empty at the time this method is called. since category actions are only created when the menu item is clicked Category may not exist in the manager, in that case nothing will get configured. Category should not be added to the manager manually if it is not present.
      configurator - actions configurator which will be called when constructing actions (when displaying the dialog with actions)

    • removeDiagramNavigationConfigurator

      @OpenApi public void removeDiagramNavigationConfigurator(AMConfigurator configurator)
      Removes configurator from diagram navigation configuration.
      Parameters:
      configurator - configurator to remove.

    • addDiagramNavigationConfigurator

      @OpenApi public void addDiagramNavigationConfigurator(AMConfigurator configurator)
      Adds configurator to diagram navigation toolbar. This method should be called before menu becomes visible.
      Parameters:
      configurator - configurator to add.

    • removeMainShortcutsConfigurator

      @OpenApi public void removeMainShortcutsConfigurator(AMConfigurator configurator)
      Removes configurator for main shortcuts.
      Parameters:
      configurator - configurator will be removed.

    • addMainShortcutsConfigurator

      @OpenApi public void addMainShortcutsConfigurator(AMConfigurator configurator)
      Adds configurator for main shortcuts.
      Parameters:
      configurator - configurator will be added.

    • removeCustomizableShortcutsConfigurator

      @OpenApi public void removeCustomizableShortcutsConfigurator(AMConfigurator configurator)
      Removes configurator for main shortcuts.
      Parameters:
      configurator - configurator will be removed.

    • addCustomizableShortcutsConfigurator

      @OpenApi public void addCustomizableShortcutsConfigurator(AMConfigurator configurator)
      Adds configurator for main shortcuts.
      Parameters:
      configurator - configurator will be added.

    • addMainToolbarConfigurator

      @OpenApi public void addMainToolbarConfigurator(AMConfigurator configurator)
      Adds configurator to main toolbar. This method should be called before toolbar becomes visible.
      Parameters:
      configurator - configurator will be added.

    • removeMainToolbarConfigurator

      @OpenApi public void removeMainToolbarConfigurator(AMConfigurator configurator)
      Removes configurator from main toolbar.
      Parameters:
      configurator - configurator will be removed.

    • addDiagramToolbarActionsProvider

      @OpenApi public void addDiagramToolbarActionsProvider(String diagramType, CustomizableDiagramToolbarActionsProvider provider)
      Adds new toolbar provider for given diagram type.
      Parameters:
      diagramType - diagram type.
      provider - action provider to be added.

    • removeDiagramToolbarActionsProvider

      @OpenApi public void removeDiagramToolbarActionsProvider(String diagramType, CustomizableDiagramToolbarActionsProvider provider)
      Removes action provider for specified diagram type.
      Parameters:
      diagramType - diagram type
      provider - action provider to be removed.