Class ActionBarContributor

    • Constructor Detail

      • ActionBarContributor

        public ActionBarContributor()
    • Method Detail

      • addAction

        protected void addAction​(IAction action)
        Adds the given action to the action registry.
        Parameters:
        action - the action to add
      • addGlobalActionKey

        protected void addGlobalActionKey​(java.lang.String key)
        Indicates the existence of a global action identified by the specified key. This global action is defined outside the scope of this contributor, such as the Workbench's undo action, or an action provided by a workbench ActionSet. The list of global action keys is used whenever the active editor is changed (setActiveEditor(IEditorPart)). Keys provided here will result in corresponding actions being obtained from the active editor's ActionRegistry, and those actions will be registered with the ActionBars for this contributor. The editor's action handler and the global action must have the same key.
        Parameters:
        key - the key identifying the global action
      • addRetargetAction

        protected void addRetargetAction​(RetargetAction action)
        Adds the specified RetargetAction to this contributors ActionRegistry. The RetargetAction is also added as a IPartListener of the contributor's page. Also, the retarget action's ID is flagged as a global action key, by calling addGlobalActionKey(String).
        Parameters:
        action - the retarget action being added
      • buildActions

        protected abstract void buildActions()
        Creates and initializes Actions managed by this contributor.
      • declareGlobalActionKeys

        protected abstract void declareGlobalActionKeys()
        Subclasses must implement to declare additional global actions IDs. Only IDs which were not already added directly or indirectly using addGlobalActionKey(String) need to be added.
        See Also:
        addGlobalActionKey(String)
      • getAction

        protected IAction getAction​(java.lang.String id)
        Retrieves an action from the action registry using the given ID.
        Parameters:
        id - the ID of the sought action
        Returns:
        null or the action if found
      • getActionRegistry

        protected ActionRegistry getActionRegistry()
        returns this contributor's ActionRegsitry.
        Returns:
        the ActionRegistry