| org.eclipse.ui.commands.IHandler
All known Subclasses: org.eclipse.ui.commands.AbstractHandler,
| IHandler | | public interface IHandler (Code) | | A handler is the pluggable piece of a command that handles execution. Each
command can have zero or more handlers associated with it (in general), of
which only one will be active at any given moment in time. When the command
is asked to execute, it will simply pass that request on to its active
handler, if any.
This interface is not intended to be extended by clients.
since:
3.0
See Also: org.eclipse.core.commands.IHandler |
| Method Summary | |
| void | addHandlerListener(IHandlerListener handlerListener)
Registers an instance of IHandlerListener to listen for
changes to properties of this instance.
Parameters:
handlerListener - the instance to register. | | public void | dispose()
Disposes of this handler. | | 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. | | void | removeHandlerListener(IHandlerListener handlerListener)
Unregisters an instance of IPropertyListener listening for
changes to properties of this instance.
Parameters:
handlerListener - the instance to unregister. |
| addHandlerListener | | void addHandlerListener(IHandlerListener handlerListener)(Code) | | Registers an instance of IHandlerListener to listen for
changes to properties of this instance.
Parameters:
handlerListener - the instance to register. Must not be null. Ifan attempt is made to register an instance which is alreadyregistered with this instance, no operation is performed. |
| dispose | | public void dispose()(Code) | | Disposes of this handler. This method is run once when the object is no
longer referenced. This can be used as an opportunity to unhook listeners
from other objects.
|
| execute | | Object execute(Map parameterValuesByName) throws ExecutionException(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. |
| getAttributeValuesByName | | Map getAttributeValuesByName()(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. |
| removeHandlerListener | | void removeHandlerListener(IHandlerListener handlerListener)(Code) | | Unregisters an instance of IPropertyListener listening for
changes to properties of this instance.
Parameters:
handlerListener - the instance to unregister. Must not be null.If an attempt is made to unregister an instance which is notalready registered with this instance, no operation isperformed. |
|
|