Package com.nomagic.magicdraw.actions

Class ActionsProvider

java.lang.Object
com.nomagic.magicdraw.actions.ActionsProvider
@OpenApi public final class ActionsProvider extends Object
The singleton class used for accessing actions in different parts (diagrams, browsers, main menu and etc.) of MagicDraw application.

  • Method Details

    • getInstance

      @OpenApi public static ActionsProvider getInstance()
      Returns single instance of this class.
      Returns:
      the instance of ActionsProvider.

    • getDiagramContextActions

      @OpenApi public ActionsManager getDiagramContextActions(String diagramType, DiagramPresentationElement diagram, PresentationElement[] selected, @CheckForNull PresentationElement requester)
      Returns context AM for given diagram type.
      Parameters:
      diagramType - diagram type
      diagram - the given diagram.
      selected - array of selected symbols.
      requester - symbol which requests actions, can be null if requester is diagram.
      Returns:
      manager with actions.

    • getDiagramContextActions

      public ActionsManager getDiagramContextActions(String diagramType, AbstractDiagramPresentationElement diagram, PresentationElement[] selected, @CheckForNull PresentationElement requester)
      Returns context AM for given diagram type.
      Parameters:
      diagramType - diagram type
      diagram - the given diagram.
      selected - array of selected symbols.
      requester - symbol which requests actions, can be null if requester is diagram.
      Returns:
      manager with actions.

    • getTargetElementAMActions

      @OpenApi public ActionsManager getTargetElementAMActions(String diagramType, PresentationElement requester, String pathActionID)
      Returns context AM for given diagram type.
      Parameters:
      diagramType - diagram type
      requester - symbol which requests actions, can be null if requester is diagram.
      pathActionID - path action id
      Returns:
      manager with actions.

    • getDiagramContextToolbarActions

      @OpenApi public ActionsManager getDiagramContextToolbarActions(String diagramType, PresentationElement requester)
      Returns context AM for given diagram type.
      Parameters:
      diagramType - diagram type
      requester - symbol which requests actions, can be null if requester is diagram.
      Returns:
      manager with actions.

    • getDiagramToolbarConfiguration

      @OpenApi public DiagramToolbarConfiguration getDiagramToolbarConfiguration(String diagramType)
      Returns AM for diagram toolbar.
      Parameters:
      diagramType - diagram type
      Returns:
      DiagramToolbarConfiguration object for specified diagram type.

    • getDiagramToolbarConfiguration

      @OpenApi public DiagramToolbarConfiguration getDiagramToolbarConfiguration(AbstractDiagramPresentationElement diagram)
      Returns AM for diagram toolbar.
      Parameters:
      diagram - diagram
      Returns:
      DiagramToolbarConfiguration object for specified diagram

    • getDiagramCommandBarActions

      @OpenApi public ActionsManager getDiagramCommandBarActions(@CheckForNull String diagramType)
      Returns actions of command bar for given diagram type.
      Parameters:
      diagramType - diagram type
      Returns:
      manager with actions.

    • getCommandBarActions

      @OpenApi public ActionsManager getCommandBarActions(AbstractDiagramPresentationElement diagram)
      Returns actions of command bar for given diagram.
      Parameters:
      diagram - diagram
      Returns:
      manager with actions

    • getDiagramShortcutActions

      @OpenApi public ActionsManager getDiagramShortcutActions(String diagramType)
      Returns AM for given diagram type shortcuts.
      Parameters:
      diagramType - diagram type
      Returns:
      manager with actions.

    • getDiagramShortcutActions

      @OpenApi public ActionsManager getDiagramShortcutActions(AbstractDiagramPresentationElement diagram)
      Returns AM for given diagram
      Parameters:
      diagram - diagram
      Returns:
      manager with actions

    • getMainMenuActions

      @OpenApi public ActionsManager getMainMenuActions()
      Returns actions manager for main menu actions.
      Returns:
      manager with actions.

    • getMainToolbarActions

      @OpenApi public ActionsManager getMainToolbarActions()
      Returns manager with actions for main toolbar.
      Returns:
      manager with main toolbar actions.

    • getMainShortcutsActions

      @OpenApi public ActionsManager getMainShortcutsActions()
      Returns actions manager for main shortcuts.
      Returns:
      manager with actions.

    • getContainmentBrowserContextActions

      @OpenApi public static ActionsManager getContainmentBrowserContextActions(BrowserTabTree tree)
      Returns context actions manager for containment browser.
      Parameters:
      tree - instance of tree.
      Returns:
      manager with actions.

    • getExtensionsBrowserContextActions

      @OpenApi public static ActionsManager getExtensionsBrowserContextActions(BrowserTabTree tree)
      Returns context actions manager for containment browser.
      Parameters:
      tree - instance of tree.
      Returns:
      manager with actions.

    • getSearchBrowserContextActions

      @OpenApi public static ActionsManager getSearchBrowserContextActions(BrowserTabTree tree)
      Returns context actions manager for search browser.
      Parameters:
      tree - instance of tree.
      Returns:
      manager with actions.

    • getDiagramsBrowserContextActions

      @OpenApi public static ActionsManager getDiagramsBrowserContextActions(BrowserTabTree tree)
      Returns context actions manager for diagrams browser.
      Parameters:
      tree - instance of tree.
      Returns:
      manager with actions.

    • getInheritanceBrowserContextActions

      @OpenApi public static ActionsManager getInheritanceBrowserContextActions(BrowserTabTree tree)
      Returns context actions manager for inheritance browser.
      Parameters:
      tree - instance of tree.
      Returns:
      manager with actions.

    • getContainmentBrowserShortcutsActions

      @OpenApi public ActionsManager getContainmentBrowserShortcutsActions()
      Returns actions manager for containment browser shortcuts.
      Returns:
      manager with actions.

    • getDiagramsBrowserShortcutsActions

      @OpenApi public ActionsManager getDiagramsBrowserShortcutsActions()
      Returns actions manager for diagrams browser shortcuts.
      Returns:
      manager with actions.

    • getInheritanceBrowserShortcutsActions

      @OpenApi public ActionsManager getInheritanceBrowserShortcutsActions()
      Returns shortcuts actions manager for inheritance browser.
      Returns:
      manager with actions.

    • getLockViewBrowserShortcutsActions

      @OpenApi public ActionsManager getLockViewBrowserShortcutsActions()
      Returns shortcuts actions manager for inheritance browser.
      Returns:
      manager with actions.

    • getExtensionsBrowserShortcutsActions

      @OpenApi public ActionsManager getExtensionsBrowserShortcutsActions()
      Returns shortcuts actions manager for inheritance browser.
      Returns:
      manager with actions.

    • getSearchBrowserShortcutsActions

      @OpenApi public ActionsManager getSearchBrowserShortcutsActions()
      Returns shortcuts actions manager for search browser.
      Returns:
      manager with actions.

    • getCreator

      @OpenApi public ActionsCreator getCreator()
      Returns instance of actions creator.
      Returns:
      the actions creator.

    • createDiagramsActionsManager

      public DiagramsActionsManager createDiagramsActionsManager()
      Creates(or returns already created) action managers for all diagrams.
      Returns:
      the diagrams actions manager.

    • createGeneralActions

      public ActionsManager createGeneralActions()
      Creates the general actions
      Returns:
      the general actions

    • addManagerToUpdateList

      public void addManagerToUpdateList(ActionsManager manager)
      Adds actions to managers list for updating the state.
      Parameters:
      manager - the given actions manager.

    • removeManagerFromUpdateList

      public void removeManagerFromUpdateList(ActionsManager manager)
      Removes manager from updating actions state list.
      Parameters:
      manager - the given actions manager.

    • updateActionsState

      public void updateActionsState(@CheckForNull Project contextProject)
      Call updateState method for all registered actions without assigned group.
      Parameters:
      contextProject - context project

    • updateActionsState

      public static void updateActionsState(ActionsManager manager, @CheckForNull Project contextProject)
      Call updateState method for given actions without assigned groups in manager.
      Parameters:
      manager - manager from which actions without assigned groups will be updated.
      contextProject - context project

    • appendManagers

      public static void appendManagers()
      Appends general and diagrams actions manager with actions from configurator. This should be used before saving and loading actions shortcuts.

    • getCreateDiagramDialogActions

      @OpenApi public ActionsManager getCreateDiagramDialogActions()
      Creates, configures and returns diagram creation actions to display in Create Diagram dialog (action in main menu and main toolbar)
      Returns:
      manager with diagram creation actions

    • resetCashedActions

      @Deprecated public void resetCashedActions()
      Deprecated.
      use resetCachedActions()
      Resets already configured actions cache.

    • resetCachedActions

      public void resetCachedActions()
      Resets already configured actions cache.

    • registerAction

      @OpenApi public void registerAction(NMAction action)
      Registers the action as available in application - other components (such as Perspectives) should know what actions are available.
      • Action id must be stable/constant,
      • It is not necessary to use the same action instance used when configuring appropriate menu/toolbar.
      Parameters:
      action - action to register.
      See Also:

    • unregisterAction

      @OpenApi public void unregisterAction(NMAction action)
      Remove the action as available in application.
      Parameters:
      action - action to remove.
      See Also:

    • getRegisteredAvailableActions

      public Collection<NMAction> getRegisteredAvailableActions()
      Returns:
      a collection of various registered actions. Used in User Modes.