Class SubActionBars

    • Field Detail

      • P_ACTION_HANDLERS

        public static final String P_ACTION_HANDLERS
        Property constant for changes to action handlers.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SubActionBars

        public SubActionBars​(IActionBars parent)
        Construct a new SubActionBars object. The service locator will simply be the service locator of the parent.
        Parameters:
        parent - The parent of this action bar; must not be null.
      • SubActionBars

        public SubActionBars​(IActionBars parent,
                             IServiceLocator serviceLocator)
        Constructs a new instance of SubActionBars.
        Parameters:
        parent - The parent of this action bar; must not be null.
        serviceLocator - The service locator for this action bar; should not be null.
        Since:
        3.2
    • Method Detail

      • activate

        public void activate()
        Activate the contributions.
      • activate

        public void activate​(boolean forceVisibility)
        Activate the contributions.

        Workaround for toolbar layout flashing when editors contribute large amounts of items. In this case we want to force the items to be visible/hidden only when required, otherwise just change the enablement state.

      • addPropertyChangeListener

        public void addPropertyChangeListener​(IPropertyChangeListener listener)
        Adds a property change listener. Has no effect if an identical listener is already registered.
        Parameters:
        listener - a property change listener
      • basicSetActive

        protected final void basicSetActive​(boolean active)
        Sets the active flag. Clients should not call this method directly unless they are overriding the setActive() method.
      • createSubMenuManager

        protected SubMenuManager createSubMenuManager​(IMenuManager parent)
        Returns a new sub menu manager.
        Parameters:
        parent - the parent menu manager
        Returns:
        the menu manager
      • createSubToolBarManager

        protected SubToolBarManager createSubToolBarManager​(IToolBarManager parent)
        Returns a new sub toolbar manager.
        Parameters:
        parent - the parent toolbar manager
        Returns:
        the tool bar manager
      • deactivate

        public void deactivate()
        Deactivate the contributions.
      • deactivate

        public void deactivate​(boolean forceHide)
        Deactivate the contributions.

        Workaround for menubar/toolbar layout flashing when editors have many contributions. In this case we want to force the contributions to be visible/hidden only when required, otherwise just change the enablement state.

      • dispose

        public void dispose()
        Dispose the contributions.
      • fireActionHandlersChanged

        protected void fireActionHandlersChanged()
        Notifies any property change listeners if the global action handlers have changed
      • getActive

        protected final boolean getActive()
        Return whether the manager is currently active or not.
      • getGlobalActionHandlers

        public Map getGlobalActionHandlers()
        Returns the complete list of active global action handlers. If there are no global action handlers registered return null.
      • getMenuManager

        public IMenuManager getMenuManager()
        Returns the abstract menu manager. If items are added or removed from the manager be sure to call updateActionBars.
        Specified by:
        getMenuManager in interface IActionBars
        Returns:
        the menu manager
      • getParent

        protected final IActionBars getParent()
        Return the parent action bar manager.
      • getServiceLocator

        public final IServiceLocator getServiceLocator()
        Answer the service locator for this action bar.
        Specified by:
        getServiceLocator in interface IActionBars
        Returns:
        an IServiceLocater or the parents if the receiver does not have one
        Since:
        3.2
      • getStatusLineManager

        public IStatusLineManager getStatusLineManager()
        Returns the status line manager. If items are added or removed from the manager be sure to call updateActionBars.
        Specified by:
        getStatusLineManager in interface IActionBars
        Returns:
        the status line manager
      • getToolBarManager

        public IToolBarManager getToolBarManager()
        Returns the tool bar manager. If items are added or removed from the manager be sure to call updateActionBars.
        Specified by:
        getToolBarManager in interface IActionBars
        Returns:
        the tool bar manager
      • isSubMenuManagerCreated

        protected final boolean isSubMenuManagerCreated()
        Return whether the sub menu manager has been created yet.
      • isSubStatusLineManagerCreated

        protected final boolean isSubStatusLineManagerCreated()
        Return whether the sub status line manager has been created yet.
      • isSubToolBarManagerCreated

        protected final boolean isSubToolBarManagerCreated()
        Return whether the sub toolbar manager has been created yet.
      • partChanged

        public void partChanged​(IWorkbenchPart part)
        Notification that the target part for the action bars has changed.
      • removePropertyChangeListener

        public void removePropertyChangeListener​(IPropertyChangeListener listener)
        Removes the given property change listener. Has no effect if an identical listener is not registered.
        Parameters:
        listener - a property change listener
      • setActive

        protected void setActive​(boolean set)
        Activate / deactivate the contributions.
      • setGlobalActionHandler

        public void setGlobalActionHandler​(String actionID,
                                           IAction handler)
        Add a handler for a window action.
        Specified by:
        setGlobalActionHandler in interface IActionBars
        Parameters:
        actionID - an action ID declared in the registry
        handler - an action which implements the action ID. null may be passed to deregister a handler.
        See Also:
        IWorkbenchActionConstants
      • setServiceLocator

        protected final void setServiceLocator​(IServiceLocator locator)
        Sets the service locator for this action bar.
        Parameters:
        locator - The new locator; must not be null.
        Since:
        3.2