Tmf: Add the experiment type to the trace type extension point
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / schema / org.eclipse.linuxtools.tmf.ui.tracetypeui.exsd
1 <?xml version='1.0' encoding='UTF-8'?>
2 <!-- Schema file written by PDE -->
3 <schema targetNamespace="org.eclipse.linuxtools.tmf.ui" xmlns="http://www.w3.org/2001/XMLSchema">
4 <annotation>
5 <appinfo>
6 <meta.schema plugin="org.eclipse.linuxtools.tmf.ui" id="tracetypeui" name="TMF Trace Type UI Elements"/>
7 </appinfo>
8 <documentation>
9 This extension point is used to assign UI elements to a trace type defined by org.eclipse.linuxtools.tmf.core.tracetype.
10 </documentation>
11 </annotation>
12
13 <element name="extension">
14 <annotation>
15 <appinfo>
16 <meta.element />
17 </appinfo>
18 </annotation>
19 <complexType>
20 <choice minOccurs="0" maxOccurs="unbounded">
21 <element ref="type"/>
22 <element ref="experiment"/>
23 </choice>
24 <attribute name="point" type="string" use="required">
25 <annotation>
26 <documentation>
27 a fully qualified identifier of the target extension point
28 </documentation>
29 </annotation>
30 </attribute>
31 <attribute name="id" type="string">
32 <annotation>
33 <documentation>
34 an optional identifier of the extension instance
35 </documentation>
36 </annotation>
37 </attribute>
38 <attribute name="name" type="string">
39 <annotation>
40 <documentation>
41 an optional name of the extension instance
42 </documentation>
43 <appinfo>
44 <meta.attribute translatable="true"/>
45 </appinfo>
46 </annotation>
47 </attribute>
48 </complexType>
49 </element>
50
51 <element name="type">
52 <complexType>
53 <sequence>
54 <element ref="eventsTableType" minOccurs="0" maxOccurs="1"/>
55 <element ref="defaultEditor" minOccurs="0" maxOccurs="1"/>
56 </sequence>
57 <attribute name="tracetype" type="string" use="required">
58 <annotation>
59 <documentation>
60 The unique ID that identifies this trace type.
61 </documentation>
62 <appinfo>
63 <meta.attribute kind="identifier" basedOn="org.eclipse.linuxtools.tmf.core.tracetype/type/@id"/>
64 </appinfo>
65 </annotation>
66 </attribute>
67 <attribute name="icon" type="string">
68 <annotation>
69 <documentation>
70 The icon associated to the trace type.
71 </documentation>
72 <appinfo>
73 <meta.attribute kind="resource"/>
74 </appinfo>
75 </annotation>
76 </attribute>
77 </complexType>
78 </element>
79
80 <element name="experiment">
81 <complexType>
82 <sequence>
83 <element ref="eventsTableType" minOccurs="0" maxOccurs="1"/>
84 <element ref="defaultEditor" minOccurs="0" maxOccurs="1"/>
85 </sequence>
86 <attribute name="tracetype" type="string" use="required">
87 <annotation>
88 <documentation>
89 The unique ID that identifies this experiment type.
90 </documentation>
91 <appinfo>
92 <meta.attribute kind="identifier" basedOn="org.eclipse.linuxtools.tmf.core.tracetype/experiment/@id"/>
93 </appinfo>
94 </annotation>
95 </attribute>
96 <attribute name="icon" type="string">
97 <annotation>
98 <documentation>
99 The icon associated to the experiment type.
100 </documentation>
101 <appinfo>
102 <meta.attribute kind="resource"/>
103 </appinfo>
104 </annotation>
105 </attribute>
106 </complexType>
107 </element>
108
109 <element name="eventsTableType">
110 <annotation>
111 <documentation>
112 The events table to use for this trace type.
113 If omitted, the default events table will be used.
114 </documentation>
115 </annotation>
116 <complexType>
117 <attribute name="class" type="string" use="default" value="org.eclipse.linuxtools.tmf.ui.viewers.events.TmfEventsTable">
118 <annotation>
119 <documentation>
120 The fully qualified name of a class that extends &lt;samp&gt;TmfEventsTable&lt;/samp&gt; .
121 If empty, the default events table will be used.
122 </documentation>
123 <appinfo>
124 <meta.attribute kind="java" basedOn="org.eclipse.linuxtools.tmf.ui.viewers.events.TmfEventsTable:"/>
125 </appinfo>
126 </annotation>
127 </attribute>
128 </complexType>
129 </element>
130
131 <element name="defaultEditor">
132 <annotation>
133 <documentation>
134 The default editor to use for this trace type.
135 If omitted, the default events editor will be used.
136 </documentation>
137 </annotation>
138 <complexType>
139 <attribute name="id" type="string" use="default" value="org.eclipse.linuxtools.tmf.ui.editors.events">
140 <annotation>
141 <documentation>
142 The id of the editor to use for this trace type.
143 If empty, the default events editor will be used.
144 </documentation>
145 </annotation>
146 </attribute>
147 </complexType>
148 </element>
149
150 <annotation>
151 <appinfo>
152 <meta.section type="since"/>
153 </appinfo>
154 <documentation>
155 3.0
156 </documentation>
157 </annotation>
158
159 <annotation>
160 <appinfo>
161 <meta.section type="examples"/>
162 </appinfo>
163 <documentation>
164 Example use of the extension point: the GDB trace type, which specifies a custom icon and a custom editor, also the generic experiment, which specifies a custom icon. The &apos;type/tracetype&apos; element has to point to an existing tmf.core.tracetype extension!
165
166 &lt;extension
167 point=&quot;org.eclipse.linuxtools.tmf.ui.tracetypeui&quot;&gt;
168 &lt;type
169 icon=&quot;icons/obj16/gdb_icon16.png&quot;
170 tracetype=&quot;org.eclipse.linuxtools.gdbtrace.core.type.gdb&quot;&gt;
171 &lt;eventsTableType
172 class=&quot;org.eclipse.linuxtools.internal.gdbtrace.ui.views.events.GdbEventsTable&quot;&gt;
173 &lt;/eventsTableType&gt;
174 &lt;/type&gt;
175 &lt;experiment_type
176 tracetype=&quot;org.eclipse.linuxtools.tmf.core.experiment.generic&quot;
177 icon=&quot;icons/elcl16/experiment.gif&quot;&gt;
178 &lt;/experiment_type&gt;
179 &lt;/extension&gt;
180 </documentation>
181 </annotation>
182
183 <annotation>
184 <appinfo>
185 <meta.section type="apiinfo"/>
186 </appinfo>
187 <documentation>
188 The &apos;eventsTableType/class&apos; element has to extend TmfEventsTable. It is optional however ; if it is not specified, the default TmfEventsTable will be used.
189 </documentation>
190 </annotation>
191
192 <annotation>
193 <appinfo>
194 <meta.section type="implementation"/>
195 </appinfo>
196 <documentation>
197 [Enter information about supplied implementation of this extension point.]
198 </documentation>
199 </annotation>
200
201 <annotation>
202 <appinfo>
203 <meta.section type="copyright"/>
204 </appinfo>
205 <documentation>
206 Copyright (c) 2014 Ericsson
207
208 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;
209 </documentation>
210 </annotation>
211
212 </schema>
This page took 0.039818 seconds and 6 git commands to generate.