public interface IHandlerActivation extends org.eclipse.ui.internal.services.IEvaluationResultCache, Comparable
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
Modifier and Type | Field and Description |
---|---|
static int |
ROOT_DEPTH
The depth at which the root exists.
|
Modifier and Type | Method and Description |
---|---|
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. |
clearResult, evaluate, getExpression, getSourcePriority, setResult
compareTo
static final int ROOT_DEPTH
@Deprecated 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.String getCommandId()
null
.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.IHandler getHandler()
null
.IHandlerService getHandlerService()
null
.@Deprecated 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.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.