core/com.nokia.carbide.search.system/schema/searchResultSorters.exsd
changeset 0 fb279309251b
equal deleted inserted replaced
-1:000000000000 0:fb279309251b
       
     1 <?xml version='1.0' encoding='UTF-8'?>
       
     2 <!-- Schema file written by PDE -->
       
     3 <schema targetNamespace="com.nokia.carbide.search.system">
       
     4 <annotation>
       
     5       <appInfo>
       
     6          <meta.schema plugin="com.nokia.carbide.search.system" id="searchResultSorters" name="Result Sorters"/>
       
     7       </appInfo>
       
     8       <documentation>
       
     9          This extension point allows a plug-in to contribute 
       
    10 search result sorters to the (old) search result view&apos;s Sort 
       
    11 context menu.
       
    12 This extension point is deprecated since 3.0. The search
       
    13 result views are now contributed by clients and sorters
       
    14 are directly managed by these pages.
       
    15       </documentation>
       
    16    </annotation>
       
    17 
       
    18    <element name="extension">
       
    19       <annotation>
       
    20          <appInfo>
       
    21             <meta.element deprecated="true"/>
       
    22          </appInfo>
       
    23       </annotation>
       
    24       <complexType>
       
    25          <sequence>
       
    26             <element ref="sorter" minOccurs="0" maxOccurs="unbounded"/>
       
    27          </sequence>
       
    28          <attribute name="point" type="string" use="required">
       
    29             <annotation>
       
    30                <documentation>
       
    31                   a fully qualified identifier of the target extension point
       
    32                </documentation>
       
    33             </annotation>
       
    34          </attribute>
       
    35          <attribute name="id" type="string">
       
    36             <annotation>
       
    37                <documentation>
       
    38                   an optional identifier of the extension instance
       
    39                </documentation>
       
    40             </annotation>
       
    41          </attribute>
       
    42          <attribute name="name" type="string">
       
    43             <annotation>
       
    44                <documentation>
       
    45                   an optional name of the extension instance
       
    46                </documentation>
       
    47                <appInfo>
       
    48                   <meta.attribute translatable="true"/>
       
    49                </appInfo>
       
    50             </annotation>
       
    51          </attribute>
       
    52       </complexType>
       
    53    </element>
       
    54 
       
    55    <element name="sorter">
       
    56       <annotation>
       
    57          <appInfo>
       
    58             <meta.element labelAttribute="label" icon="icon"/>
       
    59          </appInfo>
       
    60       </annotation>
       
    61       <complexType>
       
    62          <attribute name="id" type="string" use="required">
       
    63             <annotation>
       
    64                <documentation>
       
    65                   a unique name that will be used to identify this search result sorter.
       
    66                </documentation>
       
    67             </annotation>
       
    68          </attribute>
       
    69          <attribute name="pageId" type="string" use="required">
       
    70             <annotation>
       
    71                <documentation>
       
    72                   the ID of a registered search page for which the 
       
    73 sorter will be activated. &quot;*&quot; activates the sorter 
       
    74 for all pages.
       
    75                </documentation>
       
    76             </annotation>
       
    77          </attribute>
       
    78          <attribute name="label" type="string" use="required">
       
    79             <annotation>
       
    80                <documentation>
       
    81                   a translatable label that will be used as the 
       
    82 menu item&apos;s label.
       
    83                </documentation>
       
    84                <appInfo>
       
    85                   <meta.attribute translatable="true"/>
       
    86                </appInfo>
       
    87             </annotation>
       
    88          </attribute>
       
    89          <attribute name="tooltip" type="string">
       
    90             <annotation>
       
    91                <documentation>
       
    92                   a translatable text that will be used as the menu
       
    93 item&apos;s tool tip . If omitted, the menu item will 
       
    94 have no tool tip.
       
    95                </documentation>
       
    96                <appInfo>
       
    97                   <meta.attribute translatable="true"/>
       
    98                </appInfo>
       
    99             </annotation>
       
   100          </attribute>
       
   101          <attribute name="icon" type="string">
       
   102             <annotation>
       
   103                <documentation>
       
   104                   a relative name of the image that will be shown in 
       
   105 the context menu along with the label. If omitted, 
       
   106 the menu entry will only contain a label.
       
   107                </documentation>
       
   108                <appInfo>
       
   109                   <meta.attribute kind="resource"/>
       
   110                </appInfo>
       
   111             </annotation>
       
   112          </attribute>
       
   113          <attribute name="class" type="string" use="required">
       
   114             <annotation>
       
   115                <documentation>
       
   116                   a name of the class that extends &lt;samp&gt;org.eclipse.jface.viewers.ViewerSorter&lt;/samp&gt;
       
   117                </documentation>
       
   118                <appInfo>
       
   119                   <meta.attribute kind="java" basedOn="org.eclipse.jface.viewers.ViewerSorter"/>
       
   120                </appInfo>
       
   121             </annotation>
       
   122          </attribute>
       
   123       </complexType>
       
   124    </element>
       
   125 
       
   126    <annotation>
       
   127       <appInfo>
       
   128          <meta.section type="examples"/>
       
   129       </appInfo>
       
   130       <documentation>
       
   131          The following is an example of a search page extension definition: 
       
   132 &lt;p&gt;
       
   133 &lt;pre&gt;
       
   134    &lt;extension point=&quot;com.nokia.carbide.search.system.searchResultSorters&quot;&gt; 
       
   135     &lt;sorter 
       
   136         id=&quot;com.nokia.carbide.search.system.internal.ui.FileNameSorter&quot; 
       
   137         pageId=&quot;*&quot; 
       
   138         label=&quot;%FileNameSorter.label&quot; 
       
   139         tooltip=&quot;%FilenNameSorter.tooltip&quot; 
       
   140         icon=&quot;icons/full/ecl16/search_sort.gif&quot; 
       
   141         class=&quot;com.nokia.carbide.search.system.internal.ui.FileNameSorter&quot;&gt; 
       
   142     &lt;/sorter&gt; 
       
   143    &lt;/extension&gt; 
       
   144 &lt;/pre&gt;
       
   145 &lt;/p&gt;
       
   146       </documentation>
       
   147    </annotation>
       
   148 
       
   149    <annotation>
       
   150       <appInfo>
       
   151          <meta.section type="apiInfo"/>
       
   152       </appInfo>
       
   153       <documentation>
       
   154          The contributed class must implement &lt;code&gt;org.eclipse.jface.viewers.ViewerSorter&lt;/code&gt;
       
   155       </documentation>
       
   156    </annotation>
       
   157 
       
   158    <annotation>
       
   159       <appInfo>
       
   160          <meta.section type="implementation"/>
       
   161       </appInfo>
       
   162       <documentation>
       
   163          The search infrastructure provides a sorter that sorts 
       
   164 the matches by the resource name.
       
   165       </documentation>
       
   166    </annotation>
       
   167 
       
   168    <annotation>
       
   169       <appInfo>
       
   170          <meta.section type="copyright"/>
       
   171       </appInfo>
       
   172       <documentation>
       
   173          Copyright (c) 2001, 2005 IBM Corporation and others.&lt;br&gt;
       
   174 All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
       
   175       </documentation>
       
   176    </annotation>
       
   177 
       
   178 </schema>