Command Core Expressions

From Eclipsepedia

Jump to: navigation, search

Core expressions are declarative or programmatic expressions based on the org.eclipse.core.expressions plugin.

Contents

Expressions and the Command Framework

The Platform Command Framework uses core expressions for enabledWhen and activeWhen for handlers, programmatic activation of contexts, and for visibleWhen for menu contributions. The command framework provides the IEvaluationContext that command core expressions are evaluate against.

The IEvaluationContext provides a default variable for evaluations, and a number of named variables. In the command framework, we provide the global selection as a java.util.Collection as the default variable. It can either be empty, have one entry (if the ISelection was something like an ITextSelection), or have the contents of an IStructuredSelection.

The <with/> element can be used to change which variable the child expression elements are evaluating against.

Variables and the Command Framework

The variables used for command framework evaluation are listed in ISources.java

Name Type Description Since
activeContexts A java.util.Collection of java.lang.String

This is a collection of the active context IDs as strings. Most commonly used with <iterate> and <count>, and can also be used with <test> and a org.eclipse.common.expressions.PropertyTester.

3.2
activeActionSets An IActionSetDescriptor[]

Note: This is currently not used as points to an internal class and the type might change in any released.

3.2
activeShell org.eclipse.swt.widgets.Shell 3.2
activeWorkbenchWindowShell org.eclipse.swt.widgets.Shell 3.2
activeWorkbenchWindow org.eclipse.ui.IWorkbenchWindow 3.2
activeWorkbenchWindow.isCoolbarVisible java.lang.Boolean 3.3
activeWorkbenchWindow.isPerspectiveBarVisible java.lang.Boolean 3.3
activeEditor org.eclipse.ui.IEditorPart 3.2
activeEditorId java.lang.String 3.2
activePart org.eclipse.ui.IWorkbenchPart 3.2
activePartId java.lang.String 3.2
activeSite org.eclipse.ui.IWorkbenchPartSite 3.2
selection org.eclipse.jface.viewers.ISelection 3.2
activeMenu A java.util.Collection of java.lang.String 3.2
activeMenuSelection org.eclipse.jface.viewers.ISelection 3.3
activeMenuEditorInput org.eclipse.jface.viewers.ISelection 3.3
activeFocusControl org.eclipse.swt.widgets.Control 3.3
activeFocusControlId java.lang.String 3.3

Expression examples

Here are some examples. I'll pretend all of the examples are deciding when a handler is active.

Basic IStructuredSelection

A view provides a structured selection through its selection provider. An example would be the InfoView in org.eclipse.ui.examples.contributions. You can browse the plugin.xml and InfoView.java files. The InfoView provides an IStructuredSelection with 0 or more org.eclipse.ui.examples.contributions.model.Person.

When using the default variable, you must treat it as an java.util.Collection. That means using <count> or <iterate>


<activeWhen>
   <iterate>
      <instanceof value="org.eclipse.ui.examples.contributions.model.Person"/>
   </iterate>
</activeWhen>

Package Explorer IStructuredSelection

The Package Explorer is a mixture of org.eclipse.core.resources.IResource and