|
Eclipse Platform Release 3.2 |
|||||||||||
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
Field Summary | |
---|---|
static int |
ROOT_DEPTH
The depth at which the root exists. |
Method Summary | |
---|---|
void |
clearActive()
Deprecated. Use IEvaluationResultCache.clearResult() instead. |
String |
getCommandId()
Returns the identifier of the command whose handler is being activated. |
int |
getDepth()
Returns the depth at which this activation was created within the services hierarchy. |
IHandler |
getHandler()
Returns the handler that should be activated. |
IHandlerService |
getHandlerService()
Returns the handler service from which this activation was requested. |
boolean |
isActive(IEvaluationContext context)
Deprecated. Use IEvaluationResultCache.evaluate(IEvaluationContext)
instead. |
Methods inherited from interface org.eclipse.ui.internal.services.IEvaluationResultCache |
---|
clearResult, evaluate, getExpression, getSourcePriority |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Field Detail |
public static final int ROOT_DEPTH
Method Detail |
public void clearActive()
IEvaluationResultCache.clearResult()
instead.
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 int getDepth()
1
. This is used as the final tie-breaker in the event
that no other method can be used to determine a winner.
public IHandler getHandler()
null
.public IHandlerService getHandlerService()
null
.public boolean isActive(IEvaluationContext context)
IEvaluationResultCache.evaluate(IEvaluationContext)
instead.
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.2 |
|||||||||||
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, 2006. All rights reserved.