|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.commands.ExecutionEvent
The data object to pass to the command (and its handler) as it executes. This carries information about the current state of the application, and the application context in which the command was executed.
An execution event carries three blocks of data: the parameters, the trigger, and the application context. How these blocks are used is application dependent. In the Eclipse workbench, the trigger is an SWT event, and the application context contains information about the selection and active part.
Constructor Summary | |
---|---|
ExecutionEvent(Map parameters,
Object trigger,
Object applicationContext)
Constructs a new instance of ExecutionEvent . |
Method Summary | |
---|---|
Object |
getApplicationContext()
Returns the state of the application at the time the execution was triggered. |
String |
getParameter(String parameterName)
Returns the parameter of the given name. |
Map |
getParameters()
Returns all of the parameters. |
Object |
getTrigger()
Returns the object that triggered the execution |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ExecutionEvent(Map parameters, Object trigger, Object applicationContext)
ExecutionEvent
.
parameters
- The parameters to qualify the execution; must not be
null
. This must be a map of parameter names (String
)
to parameter values (String
).trigger
- The object that triggered the execution; may be
null
.applicationContext
- The state of the application at the time the execution was
triggered; may be null
.Method Detail |
public final Object getApplicationContext()
null
.public final String getParameter(String parameterName)
parameterName
- The name of the parameter to retrieve; may be
null
.
null
if the parameter cannot
be found.public final Map getParameters()
null
, but may be empty.public final Object getTrigger()
null
if there was no trigger.
|
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.