Attachment 122941 Details for Bug 111778 – Add a pointer to useful core expression doc v01

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

[patch] Add a pointer to useful core expression doc v01

popup-v01.txt (text/plain), 13.08 KB, created by Paul Webster

on 2009-01-19 10:06:49 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Paul Webster

Created: 2009-01-19 10:06:49 EST

Size: 13.08 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.ui
>Index: schema/commonExpression.exsd
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.ui/schema/commonExpression.exsd,v
>retrieving revision 1.13
>diff -u -r1.13 commonExpression.exsd
>--- schema/commonExpression.exsd	16 Mar 2007 18:00:05 -0000	1.13
>+++ schema/commonExpression.exsd	19 Jan 2009 15:06:12 -0000
>@@ -1,12 +1,12 @@
> <?xml version='1.0' encoding='UTF-8'?>
> 
>-<schema targetNamespace="org.eclipse.ui">
>+<schema targetNamespace="org.eclipse.ui" xmlns="http://www.w3.org/2001/XMLSchema">
> <annotation>
>       <appInfo>
>          <meta.schema plugin="org.eclipse.ui" id="commonExpression" name="Common Expressions"/>
>       </appInfo>
>       <documentation>
>-         An action&apos;s enablement and/or visibility can be defined using the elements &lt;samp&gt;enablement&lt;/samp&gt; and &lt;samp&gt;visibility&lt;/samp&gt; respectively. These two elements contain a boolean expression that is evaluated to determine the enablement and/or visibility.
>+         An action&apos;s enablement and/or visibility can be defined using the elements &lt;samp&gt;enablement&lt;/samp&gt; and &lt;samp&gt;visibility&lt;/samp&gt; respectively, if the extension point supports it. These two elements contain a boolean expression that is evaluated to determine the enablement and/or visibility.
> &lt;p&gt;
> The syntax is the same for the &lt;samp&gt;enablement&lt;/samp&gt; and &lt;samp&gt;visibility&lt;/samp&gt; elements. Both contain only one boolean expression sub-element. In the simplest case, this will be an &lt;samp&gt;objectClass&lt;/samp&gt;, &lt;samp&gt;objectState&lt;/samp&gt;, &lt;samp&gt;pluginState&lt;/samp&gt;, or &lt;samp&gt;systemProperty&lt;/samp&gt; element. In the more complex case, the &lt;samp&gt;and&lt;/samp&gt;, &lt;samp&gt;or&lt;/samp&gt;, and &lt;samp&gt;not&lt;/samp&gt; elements can be combined to form a boolean expression. Both the &lt;samp&gt;and&lt;/samp&gt;, and &lt;samp&gt;or&lt;/samp&gt; elements must contain 2 sub-elements. The &lt;samp&gt;not&lt;/samp&gt; element must contain only 1 sub-element.
> &lt;/p&gt;
>@@ -231,32 +231,8 @@
>       </documentation>
>    </annotation>
> 
>-   <annotation>
>-      <appInfo>
>-         <meta.section type="examples"/>
>-      </appInfo>
>-      <documentation>
>-         
>-      </documentation>
>-   </annotation>
> 
>-   <annotation>
>-      <appInfo>
>-         <meta.section type="apiInfo"/>
>-      </appInfo>
>-      <documentation>
>-         
>-      </documentation>
>-   </annotation>
> 
>-   <annotation>
>-      <appInfo>
>-         <meta.section type="implementation"/>
>-      </appInfo>
>-      <documentation>
>-         
>-      </documentation>
>-   </annotation>
> 
>    <annotation>
>       <appInfo>
>Index: schema/popupMenus.exsd
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.ui/schema/popupMenus.exsd,v
>retrieving revision 1.34
>diff -u -r1.34 popupMenus.exsd
>--- schema/popupMenus.exsd	26 Feb 2008 17:57:27 -0000	1.34
>+++ schema/popupMenus.exsd	19 Jan 2009 15:06:12 -0000
>@@ -2,9 +2,9 @@
> 
> <schema targetNamespace="org.eclipse.ui" xmlns="http://www.w3.org/2001/XMLSchema">
> <annotation>
>-      <appinfo>
>+      <appInfo>
>          <meta.schema plugin="org.eclipse.ui" id="popupMenus" name="Pop-up Menus"/>
>-      </appinfo>
>+      </appInfo>
>       <documentation>
>          This extension point is used to add new actions to context menus owned by other plug-ins.  Action contributions may be made against a specific object type (&lt;samp&gt;objectContribution&lt;/samp&gt;) or against a specific context menu of a view or editor part (&lt;samp&gt;viewerContribution&lt;/samp&gt;). When using &lt;samp&gt;objectContribution&lt;/samp&gt;, the contribution will appear in all view or editor part context menus where objects of the specified type are selected. In contrast, using &lt;samp&gt;viewerContribution&lt;/samp&gt;, the contribution will only appear in the specified view or editor part context menu, regardless of the selection.
> &lt;p&gt;
>@@ -18,6 +18,8 @@
> Individual actions in an object contribution can use the attribute &lt;code&gt;enablesFor&lt;/code&gt; to specify if it should only apply for a single, multiple, or any other selection type. 
> &lt;p&gt;
> If these filtering mechanisms are inadequate an action contribution may use the &lt;samp&gt;filter&lt;/samp&gt; mechanism.  In this case the attributes of the target object are described in a series of name-value pairs.  The attributes which apply to the selection are type-specific and beyond the domain of the workbench itself, so the workbench will delegate filtering at this level to the actual selection.
>+&lt;p&gt;
>+The &lt;/code&gt;objectContribution&lt;/code&gt; element uses the core expression &lt;code&gt;enablement&lt;/code&gt;, as defined in &lt;a href=&quot;org_eclipse_core_expressions_definitions.html&quot;&gt;org.eclipse.core.expressions.definitions&lt;/a&gt;.
>       </documentation>
>    </annotation>
> 
>@@ -28,6 +30,11 @@
>    <include schemaLocation="schema://org.eclipse.core.expressions/schema/expressionLanguage.exsd"/>
> 
>    <element name="extension">
>+      <annotation>
>+         <appInfo>
>+            <meta.element />
>+         </appInfo>
>+      </annotation>
>       <complexType>
>          <sequence>
>             <element ref="objectContribution" minOccurs="0" maxOccurs="unbounded"/>
>@@ -45,9 +52,9 @@
>                <documentation>
>                   an optional identifier of the extension instance
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute translatable="true"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>          <attribute name="name" type="string">
>@@ -63,7 +70,7 @@
>    <element name="objectContribution">
>       <annotation>
>          <documentation>
>-            This element is used to define a group of actions and/or menus for any viewer context menus for which the objects of the specified type are selected.
>+            This element is used to define a group of actions and/or menus for any viewer context menus for which the objects of the specified type are selected.  &lt;code&gt;enablement&lt;/code&gt; in this element refers to core expression enablement, as defined in &lt;a href=&quot;org_eclipse_core_expressions_definitions.html&quot;&gt;org.eclipse.core.expressions.definitions&lt;/a&gt;, and effects the enablement of the objectContribution not the contained actions.
>          </documentation>
>       </annotation>
>       <complexType>
>@@ -87,9 +94,9 @@
>                   a fully qualified name of the class or interface that all objects in the 
> selection must subclass or implement.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute kind="java" basedOn="java.lang.object"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>          <attribute name="nameFilter" type="string">
>@@ -140,9 +147,9 @@
> 
>    <element name="action">
>       <annotation>
>-         <appinfo>
>+         <appInfo>
>             <meta.element labelAttribute="label" icon="icon"/>
>-         </appinfo>
>+         </appInfo>
>          <documentation>
>             This element defines an action that the user can invoke in the UI.
>          </documentation>
>@@ -165,9 +172,9 @@
>                <documentation>
>                   a translatable name used as the menu item text. The name can include mnenomic information.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute translatable="true"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>          <attribute name="definitionId" type="string">
>@@ -175,9 +182,9 @@
>                <documentation>
>                   This specifies the command that this action is handling.  This is used to decide which key binding to display in the pop-up menu.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute kind="identifier" basedOn="org.eclipse.ui.commands/command/@id"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>          <attribute name="menubarPath" type="string">
>@@ -193,9 +200,9 @@
>                   a relative path of an icon used to visually represent the action in its context.
> The path is relative to the location of the plugin.xml file of the contributing plug-in.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute kind="resource"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>          <attribute name="helpContextId" type="string">
>@@ -258,9 +265,9 @@
>                <documentation>
>                   a name of the fully qualified class that implements &lt;samp&gt;org.eclipse.ui.IObjectActionDelegate&lt;/samp&gt; (for object contributions), &lt;samp&gt;org.eclipse.ui.IViewActionDelegate&lt;/samp&gt; (for viewer contributions to a view part), or &lt;samp&gt;org.eclipse.ui.IEditorActionDelegate&lt;/samp&gt; (for viewer contributions to an editor part).  For backwards compatibility, &lt;samp&gt;org.eclipse.ui.IActionDelegate&lt;/samp&gt; may be implemented for object contributions.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute kind="java"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>          <attribute name="enablesFor" type="string">
>@@ -318,9 +325,9 @@
>                <documentation>
>                   an optional attribute that specifies the identifier of an action which this action overrides. The action represented by this identifier will not be contributed to the context menu. The action identifier must be from a prerequisite plug-in only. This attribute is only applicable to action elements of an object contribution.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute kind="identifier" basedOn="org.eclipse.ui.popupMenus/objectContribution/action/@id"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>          <attribute name="tooltip" type="string">
>@@ -328,9 +335,9 @@
>                <documentation>
>                   a translatable text representing the action&apos;s tool tip. Only used if the action appears in the toolbar.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute translatable="true"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>       </complexType>
>@@ -338,9 +345,9 @@
> 
>    <element name="filter">
>       <annotation>
>-         <appinfo>
>+         <appInfo>
>             <meta.element labelAttribute="name"/>
>-         </appinfo>
>+         </appInfo>
>          <documentation>
>             This element is used to evaluate the attribute state of each object in the current selection. A match only if each object in the selection has the specified attribute state. Each object in the selection must implement, or adapt to, &lt;samp&gt;org.eclipse.ui.IActionFilter&lt;/samp&gt;.
>          </documentation>
>@@ -402,18 +409,18 @@
>                <documentation>
>                   A class that implements one of the interfaces listed for the class attribute.  It may also implement &lt;code&gt;org.eclipse.core.runtime.IExecutableExtension&lt;/code&gt;.
>                </documentation>
>-               <appinfo>
>+               <appInfo>
>                   <meta.attribute kind="java"/>
>-               </appinfo>
>+               </appInfo>
>             </annotation>
>          </attribute>
>       </complexType>
>    </element>
> 
>    <annotation>
>-      <appinfo>
>+      <appInfo>
>          <meta.section type="examples"/>
>-      </appinfo>
>+      </appInfo>
>       <documentation>
>          The following is an example of a pop-up menu extension point: 
> &lt;p&gt;
>@@ -511,9 +518,9 @@
>    </annotation>
> 
>    <annotation>
>-      <appinfo>
>+      <appInfo>
>          <meta.section type="apiInfo"/>
>-      </appinfo>
>+      </appInfo>
>       <documentation>
>          The value of the action attribute &lt;samp&gt;class&lt;/samp&gt;
> must be a fully qualified class name of a Java class 
>@@ -605,11 +612,10 @@
>    </annotation>
> 
> 
>-
>    <annotation>
>-      <appinfo>
>+      <appInfo>
>          <meta.section type="implementation"/>
>-      </appinfo>
>+      </appInfo>
>       <documentation>
>          The workbench views have built-in context menus 
> that already come loaded with a number of actions. 
>@@ -622,9 +628,9 @@
>    </annotation>
> 
>    <annotation>
>-      <appinfo>
>+      <appInfo>
>          <meta.section type="copyright"/>
>-      </appinfo>
>+      </appInfo>
>       <documentation>
>          Copyright (c) 2000, 2007 IBM Corporation and others.&lt;br&gt;
> All rights reserved. This program and the accompanying materials are made

Actions: View | Diff

Attachments on bug 111778: 122941