Class WorkbenchPartAction

    • Constructor Detail

      • WorkbenchPartAction

        public WorkbenchPartAction​(IWorkbenchPart part)
        Constructs a WorkbenchPartAction for the given part.
        Parameters:
        part - the workbench part
      • WorkbenchPartAction

        public WorkbenchPartAction​(IWorkbenchPart part,
                                   int style)
        Constructs a WorkbenchPartAction for the given part and style.
        Parameters:
        part - the workbench part
        style - one of AS_PUSH_BUTTON, AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_RADIO_BUTTON, and AS_UNSPECIFIED.
    • Method Detail

      • calculateEnabled

        protected abstract boolean calculateEnabled()
        Calculates and returns the enabled state of this action.
        Returns:
        true if the action is enabled
      • dispose

        public void dispose()
        Disposes the action when it is no longer needed.
        Specified by:
        dispose in interface Disposable
      • execute

        protected void execute​(Command command)
        Executes the given Command using the command stack. The stack is obtained by calling getCommandStack(), which uses IAdapatable to retrieve the stack from the workbench part.
        Parameters:
        command - the command to execute
      • getWorkbenchPart

        protected IWorkbenchPart getWorkbenchPart()
        Returns the workbench part given in the constructor
        Returns:
        the workbench part
      • init

        protected void init()
        Initializes this action.
      • refresh

        protected void refresh()
        Refreshes the properties of this action.
      • setLazyEnablementCalculation

        public void setLazyEnablementCalculation​(boolean value)
        Sets lazy calculation of the isEnabled property. If this value is set to true, then the action will always use calculateEnabled() whenever isEnabled() is called.

        Sometimes a value of false can be used to improve performance and reduce the number of times calculateEnabled() is called. However, the client must then call the update() method at the proper times to force the update of enablement.

        Sometimes a value of true can be used to improve performance. If an Action only appears in a dynamic context menu, then there is no reason to agressively update its enablement status because the user cannot see the Action. Instead, its enablement only needs to be determined when asked for, or lazily.

        The default value for this setting is true.

        Parameters:
        value - true if the enablement should be lazy
      • setWorkbenchPart

        protected void setWorkbenchPart​(IWorkbenchPart part)
        Sets the workbench part.
        Parameters:
        part - the workbench part