Interface ICommandManager
An instance of ICommandManager
can be used to obtain instances
of ICommand
, as well as manage whether or not those instances
are active or inactive, enabled or disabled.
This interface is not intended to be extended or implemented by clients.
- Since:
- 3.0
- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
- Restriction:
- This interface is scheduled for deletion.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommandManagerListener
(ICommandManagerListener commandManagerListener) Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.getCategory
(String categoryId) Deprecated.getCommand
(String commandId) Deprecated.Deprecated.Deprecated.Deprecated.getKeyConfiguration
(String keyConfigurationId) Deprecated.getPartialMatches
(KeySequence keySequence) Deprecated.getPerfectMatch
(KeySequence keySequence) Deprecated.boolean
isPartialMatch
(KeySequence keySequence) Deprecated.boolean
isPerfectMatch
(KeySequence keySequence) Deprecated.void
removeCommandManagerListener
(ICommandManagerListener commandManagerListener) Deprecated.
-
Method Details
-
addCommandManagerListener
Deprecated.Registers an instance ofICommandManagerListener
to listen for changes to attributes of this instance.- Parameters:
commandManagerListener
- the instance ofICommandManagerListener
to register. Must not benull
. If an attempt is made to register an instance ofICommandManagerListener
which is already registered with this instance, no operation is performed.
-
getActiveContextIds
Deprecated.Returns the set of identifiers to active contexts.Notification is sent to all registered listeners if this property changes.
- Returns:
- the set of identifiers to active contexts. This set may be empty, but
is guaranteed not to be
null
. If this set is not empty, it is guaranteed to only contain instances ofString
.
-
getActiveKeyConfigurationId
Deprecated.Returns the active key configuration.Notification is sent to all registered listeners if this property changes.
- Returns:
- the active key configuration identifier. This set may be empty, but
it is guaranteed to not be
null
. If this set is not empty, it is guaranteed to only contains instances ofString
.
-
getActiveLocale
Deprecated.Returns the active locale. While this property tends to be simply the result ofLocale.getDefault()
, it may also be changed at runtime by different implementations of command manager.Notification is sent to all registered listeners if this property changes.
- Returns:
- the active locale. May be
null
.
-
getActivePlatform
Deprecated.Returns the active platform. While this property tends to be simply the result ofSWT.getPlatform()
, it may also be changed at runtime by different implementations of command manager.Notification is sent to all registered listeners if this property changes.
- Returns:
- the active platform. May be
null
.
-
getCategory
Deprecated.Returns a handle to a category given an identifier.- Parameters:
categoryId
- an identifier. Must not benull
- Returns:
- a handle to a category.
-
getCommand
Deprecated.Returns a handle to a command given an identifier.- Parameters:
commandId
- an identifier. Must not benull
- Returns:
- a handle to a command; never
null
.
-
getDefinedCategoryIds
Deprecated.Returns the set of identifiers to defined categories.
Notification is sent to all registered listeners if this attribute changes.
- Returns:
- the set of identifiers to defined categories. This set may be empty,
but is guaranteed not to be
null
. If this set is not empty, it is guaranteed to only contain instances ofString
.
-
getDefinedCommandIds
Deprecated.Returns the set of identifiers to defined commands.
Notification is sent to all registered listeners if this attribute changes.
- Returns:
- the set of identifiers to defined commands. This set may be empty,
but is guaranteed not to be
null
. If this set is not empty, it is guaranteed to only contain instances ofString
.
-
getDefinedKeyConfigurationIds
Deprecated.Returns the set of identifiers to defined key configurations.
Notification is sent to all registered listeners if this attribute changes.
- Returns:
- the set of identifiers to defined key configurations. This set may be
empty, but is guaranteed not to be
null
. If this set is not empty, it is guaranteed to only contain instances ofString
.
-
getKeyConfiguration
Deprecated.Returns a handle to a key configuration given an identifier.- Parameters:
keyConfigurationId
- an identifier. Must not benull
- Returns:
- a handle to a key configuration.
-
getPartialMatches
Deprecated.Finds all of the commands which have key bindings that start with the given key sequence.- Parameters:
keySequence
- The prefix to look for; must not benull
.- Returns:
- A map of all of the matching key sequences (
KeySequence
) to command identifiers (String
). This map may be empty, but it is nevernull
.
-
getPerfectMatch
Deprecated.Finds the command which has the given key sequence as one of its key bindings.- Parameters:
keySequence
- The key binding to look for; must not benull
.- Returns:
- The command id for the matching command, if any;
null
if none.
-
isPartialMatch
Deprecated.Checks to see whether there are any commands which have key bindings that start with the given key sequence.- Parameters:
keySequence
- The prefix to look for; must not benull
.- Returns:
true
if at least one command has a key binding that starts withkeySequence
;false
otherwise.
-
isPerfectMatch
Deprecated.Checks to see if there is a command with the given key sequence as one of its key bindings.- Parameters:
keySequence
- The key binding to look for; must not benull
.- Returns:
true
if a command has a matching key binding;false
otherwise.
-
removeCommandManagerListener
Deprecated.Unregisters an instance ofICommandManagerListener
listening for changes to attributes of this instance.- Parameters:
commandManagerListener
- the instance ofICommandManagerListener
to unregister. Must not benull
. If an attempt is made to unregister an instance ofICommandManagerListener
which is not already registered with this instance, no operation is performed.
-