Package org.eclipse.jface.action

Class ExternalActionManager.CommandCallback

    • Constructor Detail

      • CommandCallback

        public CommandCallback​(BindingManager bindingManager,
                       CommandManager commandManager)
        Constructs a new instance of CommandCallback with the workbench it should be using. All commands will be considered active.
        Parameters:
        bindingManager - The binding manager which will provide the callback; must not be null.
        commandManager - The command manager which will provide the callback; must not be null.
        Since:
        3.1

      • CommandCallback

        public CommandCallback​(BindingManager bindingManager,
                       CommandManager commandManager,
                       ExternalActionManager.IActiveChecker activeChecker)
        Constructs a new instance of CommandCallback with the workbench it should be using.
        Parameters:
        bindingManager - The binding manager which will provide the callback; must not be null.
        commandManager - The command manager which will provide the callback; must not be null.
        activeChecker - The callback mechanism for checking whether a command is active; must not be null.
        Since:
        3.1

      • CommandCallback

        public CommandCallback​(BindingManager bindingManager,
                       CommandManager commandManager,
                       ExternalActionManager.IActiveChecker activeChecker,
                       ExternalActionManager.IExecuteApplicable checker)
        Constructs a new instance of CommandCallback with the workbench it should be using.
        Parameters:
        bindingManager - The binding manager which will provide the callback; must not be null.
        commandManager - The command manager which will provide the callback; must not be null.
        activeChecker - The callback mechanism for checking whether a command is active; must not be null.
        checker - The callback to check if an IAction should fire execution events.
        Since:
        3.4

    • Method Detail

      • bindingManagerChanged

        public final void bindingManagerChanged​(BindingManagerEvent event)
        Description copied from interface: IBindingManagerListener
        Notifies that attributes inside an instance of BindingManager have changed. Specific details are described in the BindingManagerEvent. Changes in the binding manager can cause the set of defined or active schemes or bindings to change.
        Specified by:
        bindingManagerChanged in interface IBindingManagerListener
        Parameters:
        event - the binding manager event. Guaranteed not to be null.

      • getAccelerator

        public final java.lang.Integer getAccelerator​(java.lang.String commandId)
        Description copied from interface: ExternalActionManager.ICallback
        An accessor for the accelerator associated with the item indicated by the identifier. This identifier is specific to mechanism being used. In the case of the Eclipse workbench, this is the command identifier.
        Specified by:
        getAccelerator in interface ExternalActionManager.ICallback
        Parameters:
        commandId - The identifier of the item from which the accelerator should be obtained ; must not be null.
        Returns:
        An integer representation of the accelerator. This is the same accelerator format used by SWT.
        See Also:
        ExternalActionManager.ICallback.getAccelerator(String)

      • getAcceleratorText

        public final java.lang.String getAcceleratorText​(java.lang.String commandId)
        Description copied from interface: ExternalActionManager.ICallback
        An accessor for the accelerator text associated with the item indicated by the identifier. This identifier is specific to mechanism being used. In the case of the Eclipse workbench, this is the command identifier.
        Specified by:
        getAcceleratorText in interface ExternalActionManager.ICallback
        Parameters:
        commandId - The identifier of the item from which the accelerator text should be obtained ; must not be null.
        Returns:
        A string representation of the accelerator. This is the string representation that should be displayed to the user.
        See Also:
        ExternalActionManager.ICallback.getAcceleratorText(String)

      • getActiveBindingsFor

        public final TriggerSequence[] getActiveBindingsFor​(java.lang.String commandId)
        Returns the active bindings for a particular command identifier.
        Specified by:
        getActiveBindingsFor in interface ExternalActionManager.IBindingManagerCallback
        Parameters:
        commandId - The identifier of the command whose bindings are requested. This argument may be null. It is assumed that the command has no parameters.
        Returns:
        The array of active triggers (TriggerSequence) for a particular command identifier. This value is guaranteed not to be null, but it may be empty.
        Since:
        3.2

      • isAcceleratorInUse

        public final boolean isAcceleratorInUse​(int accelerator)
        Description copied from interface: ExternalActionManager.ICallback
        Checks to see whether the given accelerator is being used by some other mechanism (outside of the menus controlled by JFace). This is used to keep JFace from trying to grab accelerators away from someone else.
        Specified by:
        isAcceleratorInUse in interface ExternalActionManager.ICallback
        Parameters:
        accelerator - The accelerator to check -- in SWT's internal accelerator format.
        Returns:
        true if the accelerator is already being used and shouldn't be used again; false otherwise.
        See Also:
        ExternalActionManager.ICallback.isAcceleratorInUse(int)

      • isActive

        public final boolean isActive​(java.lang.String commandId)
        Checks whether the item matching this identifier is active. This is used to decide whether a contribution item with this identifier should be made visible. An inactive item is not visible. Calling this method with an undefined command id will generate a log message.
        Specified by:
        isActive in interface ExternalActionManager.ICallback
        Parameters:
        commandId - The identifier of the item from which the active state should be retrieved; must not be null.
        Returns:
        true if the item is active; false otherwise.