|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
void |
addHandlerListener(IHandlerListener handlerListener)
Registers an instance of IHandlerListener to listen for
changes to properties of this instance. |
void |
dispose()
Disposes of this handler. |
Object |
execute(ExecutionEvent event)
Executes with the map of parameter values by name. |
boolean |
isEnabled()
Returns whether this handler is capable of executing at this moment in time. |
boolean |
isHandled()
Returns whether this handler is really capable of handling delegation. |
void |
removeHandlerListener(IHandlerListener handlerListener)
Unregisters an instance of IHandlerListener listening for
changes to properties of this instance. |
Method Detail |
public void addHandlerListener(IHandlerListener handlerListener)
IHandlerListener
to listen for
changes to properties of this instance.
handlerListener
- the instance to register. Must not be null
. If
an attempt is made to register an instance which is already
registered with this instance, no operation is performed.public void dispose()
public Object execute(ExecutionEvent event) throws ExecutionException
event
- An event containing all the information about the current
state of the application; must not be null
.
null
.
ExecutionException
- if an exception occurred during execution.public boolean isEnabled()
true
if the command is enabled; false
otherwise.public boolean isHandled()
true
if the handler is handled; false
otherwise.public void removeHandlerListener(IHandlerListener handlerListener)
IHandlerListener
listening for
changes to properties of this instance.
handlerListener
- the instance to unregister. Must not be null
.
If an attempt is made to unregister an instance which is not
already registered with this instance, no operation is
performed.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.