| java.lang.Object
 org.eclipse.ui.internal.services.ExpressionAuthority
All known Subclasses: org.eclipse.ui.internal.services.EvaluationAuthority, org.eclipse.ui.internal.contexts.ContextAuthority, org.eclipse.ui.internal.handlers.HandlerAuthority,
| ExpressionAuthority | | abstract public class ExpressionAuthority implements ISourceProviderListener(Code) | |
Provides common functionality for evaluating expressions and listening to
ISourceProvider (i.e., the common event framework for commands).
This class is not intended for use outside of the
org.eclipse.ui.workbench plug-in.
since:
3.2
See Also: ISourceProvider
See Also: ISources
See Also: Expression
See Also: IEvaluationContext |
| Constructor Summary | |
| protected | ExpressionAuthority()
Constructs a new instance of ExpressionAuthority. |
| Method Summary | |
| final public void | addSourceProvider(ISourceProvider provider)
Adds a source provider to a list of providers to check when updating. | | final protected void | changeVariable(String name, Object value)
Changes the variable of the given name. | | public void | dispose()
Removes all of the source provider listeners. | | final protected boolean | evaluate(Collection collection)
Returns whether at least one of the IEvaluationResultCache
instances in collection evaluates to true.
Parameters:
collection - The evaluation result caches to check; must not benull, but may be empty. | | final protected boolean | evaluate(IEvaluationResultCache expression)
Returns whether the IEvaluationResultCache evaluates to
true.
Parameters:
expression - The evaluation result cache to check; must not benull. | | final public IEvaluationContext | getCurrentState()
Creates a new evaluation context based on the current evaluation context
(i.e., the current state), and places the current selection as the
default variable. | | final protected Object | getVariable(String name)
Returns the variable of the given name.
Parameters:
name - The name of the variable to get; must not be null. | | final public void | removeSourceProvider(ISourceProvider provider)
Removes this source provider from the list, and detaches this authority
as a listener. | | abstract protected void | sourceChanged(int sourcePriority)
Carries out the actual source change notification. | | protected void | sourceChanged(String[] sourceNames)
Similar to sourceChanged(int) this notifies the subclass about the
change, but using the array of source names that changed instead of the
priority ... | | final public void | sourceChanged(int sourcePriority, Map sourceValuesByName)
| | final public void | sourceChanged(int sourcePriority, String sourceName, Object sourceValue)
| | final protected void | updateCurrentState()
Updates the evaluation context with the current state from all of the
source providers. | | protected void | updateEvaluationContext(String name, Object value)
Updates this authority's evaluation context.
Parameters:
name - The name of the variable to update; must not benull.
Parameters:
value - The new value of the variable. |
| ExpressionAuthority | | protected ExpressionAuthority()(Code) | | Constructs a new instance of ExpressionAuthority.
|
| addSourceProvider | | final public void addSourceProvider(ISourceProvider provider)(Code) | | Adds a source provider to a list of providers to check when updating.
This also attaches this authority as a listener to the provider.
Parameters:
provider - The provider to add; must not be null. |
| changeVariable | | final protected void changeVariable(String name, Object value)(Code) | | Changes the variable of the given name. If the value is
null, then the variable is removed.
Parameters:
name - The name of the variable to change; must not benull.
Parameters:
value - The new value; the variable should be removed if this isnull. |
| dispose | | public void dispose()(Code) | | Removes all of the source provider listeners. Subclasses may extend, but
must not override.
|
| evaluate | | final protected boolean evaluate(Collection collection)(Code) | | Returns whether at least one of the IEvaluationResultCache
instances in collection evaluates to true.
Parameters:
collection - The evaluation result caches to check; must not benull, but may be empty. true if there is at least one expression thatevaluates to true; falseotherwise. |
| evaluate | | final protected boolean evaluate(IEvaluationResultCache expression)(Code) | | Returns whether the IEvaluationResultCache evaluates to
true.
Parameters:
expression - The evaluation result cache to check; must not benull. true if the expression evaluates totrue; false otherwise. |
| getCurrentState | | final public IEvaluationContext getCurrentState()(Code) | | Creates a new evaluation context based on the current evaluation context
(i.e., the current state), and places the current selection as the
default variable.
An evaluation context that can be used for evaluatingexpressions; never null. |
| getVariable | | final protected Object getVariable(String name)(Code) | | Returns the variable of the given name.
Parameters:
name - The name of the variable to get; must not be null. The variable of the given name; null if none. |
| removeSourceProvider | | final public void removeSourceProvider(ISourceProvider provider)(Code) | | Removes this source provider from the list, and detaches this authority
as a listener.
Parameters:
provider - The provider to remove; must not be null. |
| sourceChanged | | abstract protected void sourceChanged(int sourcePriority)(Code) | | Carries out the actual source change notification. It assumed that by the
time this method is called, getEvaluationContext() is
up-to-date with the current state of the application.
Parameters:
sourcePriority - A bit mask of all the source priorities that have changed. |
| sourceChanged | | protected void sourceChanged(String[] sourceNames)(Code) | | Similar to sourceChanged(int) this notifies the subclass about the
change, but using the array of source names that changed instead of the
priority ... int based.
Clients may override this method.
Parameters:
sourceNames - The array of names that changed.
since:
3.3 |
| sourceChanged | | final public void sourceChanged(int sourcePriority, Map sourceValuesByName)(Code) | | |
| sourceChanged | | final public void sourceChanged(int sourcePriority, String sourceName, Object sourceValue)(Code) | | |
| updateCurrentState | | final protected void updateCurrentState()(Code) | | Updates the evaluation context with the current state from all of the
source providers.
|
| updateEvaluationContext | | protected void updateEvaluationContext(String name, Object value)(Code) | | Updates this authority's evaluation context.
Parameters:
name - The name of the variable to update; must not benull.
Parameters:
value - The new value of the variable. If this value isnull, then the variable is removed. |
|
|