|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A token representing the activation of a handler. This token can later be used to cancel that activation. Without this token, then handler will only become inactive if the component in which the handler was activated is destroyed.
This interface is not intended to be implemented or extended by clients.
ISources
,
ISourceProvider
Method Summary | |
---|---|
void |
clearActive()
Clears the cached computation of the isActive method, if
any. |
String |
getCommandId()
Returns the identifier of the command whose handler is being activated. |
IHandler |
getHandler()
Returns the handler that should be activated. |
IHandlerService |
getHandlerService()
Returns the handler service from which this activation was requested. |
int |
getSourcePriority()
Returns the priority that has been given to this handler activation. |
boolean |
isActive(IEvaluationContext context)
Returns whether this handler activation is currently active -- given the current state of the workbench. |
Method Detail |
public void clearActive()
isActive
method, if
any. This method is only intended for internal use. It provides a
mechanism by which ISourceProvider
events can invalidate
state on a IHandlerActivation
instance.
public String getCommandId()
null
.public IHandler getHandler()
null
.public IHandlerService getHandlerService()
null
.public int getSourcePriority()
ISources
public boolean isActive(IEvaluationContext context)
clearActive
.
context
- The context in which this state should be evaluated; must not
be null
.
true
if the activation is currently active;
false
otherwise.
|
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.