| org.eclipse.ui.commands.ICommand
All known Subclasses: org.eclipse.ui.internal.commands.CommandLegacyWrapper,
| ICommand | | public interface ICommand extends Comparable(Code) | |
An instance of ICommand is a handle representing a command as
defined by the extension point org.eclipse.ui.commands. The
identifier of the handle is identifier of the command being represented.
An instance of ICommand can be obtained from an instance of
ICommandManager for any identifier, whether or not a command
with that identifier defined in the plugin registry.
The handle-based nature of this API allows it to work well with runtime
plugin activation and deactivation. If a command is defined, that means that
its corresponding plug-in is active. If the plug-in is then deactivated, the
command will still exist but it will be undefined. An attempts to use an
undefined command will result in a NotDefinedException being
thrown.
This interface is not intended to be extended or implemented by clients.
since:
3.0
See Also: ICommandListener
See Also: ICommandManager
See Also: org.eclipse.core.commands.Command |
| Method Summary | |
| void | addCommandListener(ICommandListener commandListener)
Registers an instance of ICommandListener to listen for
changes to attributes of this instance.
Parameters:
commandListener - the instance of ICommandListener to register.Must not be null. | | Object | execute(Map parameterValuesByName)
Executes with the map of parameter values by name.
Parameters:
parameterValuesByName - the map of parameter values by name. | | Map | getAttributeValuesByName()
Returns the map of attribute values by name.
Notification is sent to all registered listeners if this property
changes.
the map of attribute values by name. | | String | getCategoryId()
Returns the identifier of the category of the command represented by this
handle.
Notification is sent to all registered listeners if this attribute
changes.
the identifier of the category of the command represented by thishandle. | | String | getDescription()
Returns the description of the command represented by this handle,
suitable for display to the user. | | String | getId()
Returns the identifier of this handle.
the identifier of this handle. | | List | getKeySequenceBindings()
Returns the list of key sequence bindings for this handle. | | String | getName()
Returns the name of the command represented by this handle, suitable for
display to the user.
Notification is sent to all registered listeners if this attribute
changes.
the name of the command represented by this handle. | | boolean | isDefined()
Returns whether or not the command represented by this handle is defined. | | boolean | isHandled()
Returns whether or not this command is handled. | | void | removeCommandListener(ICommandListener commandListener)
Unregisters an instance of ICommandListener listening for
changes to attributes of this instance.
Parameters:
commandListener - the instance of ICommandListener to unregister.Must not be null. |
| addCommandListener | | void addCommandListener(ICommandListener commandListener)(Code) | | Registers an instance of ICommandListener to listen for
changes to attributes of this instance.
Parameters:
commandListener - the instance of ICommandListener to register.Must not be null. If an attempt is made toregister an instance of ICommandListener whichis already registered with this instance, no operation isperformed. |
| execute | | Object execute(Map parameterValuesByName) throws ExecutionException, NotHandledException(Code) | | Executes with the map of parameter values by name.
Parameters:
parameterValuesByName - the map of parameter values by name. Reserved for future use,must be null. the result of the execution. Reserved for future use, must benull.
throws:
ExecutionException - if an exception occurred during execution.
throws:
NotHandledException - if this is not handled. |
| getAttributeValuesByName | | Map getAttributeValuesByName() throws NotHandledException(Code) | | Returns the map of attribute values by name.
Notification is sent to all registered listeners if this property
changes.
the map of attribute values by name. This map may be empty, butis guaranteed not to be null. If this map is notempty, its collection of keys is guaranteed to only containinstances of String.
throws:
NotHandledException - if this is not handled. |
| getCategoryId | | String getCategoryId() throws NotDefinedException(Code) | |
Returns the identifier of the category of the command represented by this
handle.
Notification is sent to all registered listeners if this attribute
changes.
the identifier of the category of the command represented by thishandle. May be null.
throws:
NotDefinedException - if the command represented by this handle is not defined. |
| getDescription | | String getDescription() throws NotDefinedException(Code) | |
Returns the description of the command represented by this handle,
suitable for display to the user.
Notification is sent to all registered listeners if this attribute
changes.
the description of the command represented by this handle.Guaranteed not to be null.
throws:
NotDefinedException - if the command represented by this handle is not defined. |
| getId | | String getId()(Code) | | Returns the identifier of this handle.
the identifier of this handle. Guaranteed not to benull. |
| getKeySequenceBindings | | List getKeySequenceBindings()(Code) | |
Returns the list of key sequence bindings for this handle. This method
will return all key sequence bindings for this handle's identifier,
whether or not the command represented by this handle is defined.
Notification is sent to all registered listeners if this attribute
changes.
the list of key sequence bindings. This list may be empty, but isguaranteed not to be null. If this list is notempty, it is guaranteed to only contain instances ofIKeySequenceBinding. |
| getName | | String getName() throws NotDefinedException(Code) | |
Returns the name of the command represented by this handle, suitable for
display to the user.
Notification is sent to all registered listeners if this attribute
changes.
the name of the command represented by this handle. Guaranteednot to be null.
throws:
NotDefinedException - if the command represented by this handle is not defined. |
| isDefined | | boolean isDefined()(Code) | |
Returns whether or not the command represented by this handle is defined.
Notification is sent to all registered listeners if this attribute
changes.
true, iff the command represented by this handleis defined. |
| isHandled | | boolean isHandled()(Code) | |
Returns whether or not this command is handled. A command is handled if
it currently has an IHandler instance associated with it.
A command needs a handler to carry out the
ICommand.execute(Map) method.
Notification is sent to all registered listeners if this attribute
changes.
true, iff this command is enabled. |
| removeCommandListener | | void removeCommandListener(ICommandListener commandListener)(Code) | | Unregisters an instance of ICommandListener listening for
changes to attributes of this instance.
Parameters:
commandListener - the instance of ICommandListener to unregister.Must not be null. If an attempt is made tounregister an instance of ICommandListenerwhich is not already registered with this instance, nooperation is performed. |
|
|