Gitiles
Code Review Sign In
gerrit.omnirom.org / android_build / 66339ad5cebeae8f4cbf7e335c67368abbb91223 / . / tools / droiddoc / templates / class.cs
blob: 1fd43696397f211a327bea18ff7d8931005518f8 [file] [log] [blame]
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]1<?cs include:"macros.cs" ?>
2<html>
3<?cs include:"head_tag.cs" ?>
4<body>
5<script type="text/javascript">
6function toggle_inherited(base) {
7 var list = document.getElementById(base + "-list");
8 var summary = document.getElementById(base + "-summary");
9 var trigger = document.getElementById(base + "-trigger");
10 if (list.style.display == "none") {
11 list.style.display = "block";
12 summary.style.display = "none";
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]13 trigger.src = "<?cs var:toroot ?>assets/images/triangle-closed.png";
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]14 } else {
15 list.style.display = "none";
16 summary.style.display = "block";
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]17 trigger.src = "<?cs var:toroot ?>assets/images/triangle-opened.png";
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]18 }
19}
20</script>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]21
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]22<?cs include:"header.cs" ?>
23
24<div class="g-unit" id="doc-content">
25
26<?cs # this next line must be exactly like this to be parsed by eclipse ?>
27<!-- ======== START OF CLASS DATA ======== -->
28
29<div id="jd-header">
30 <?cs var:class.scope ?>
31 <?cs var:class.static ?>
32 <?cs var:class.final ?>
33 <?cs var:class.abstract ?>
34 <?cs var:class.kind ?>
35<h1><?cs var:class.name ?></h1>
36
37<?cs set:colspan = subcount(class.inheritance) ?>
38<?cs each:supr = class.inheritance ?>
39 <?cs if:colspan == 2 ?>
40 extends <?cs call:type_link(supr.short_class) ?><br/>
41 <?cs /if ?>
42 <?cs if:last(supr) && subcount(supr.interfaces) ?>
43 implements
44 <?cs each:t=supr.interfaces ?>
45 <?cs call:type_link(t) ?>
46 <?cs /each ?>
47 <?cs /if ?>
48 <?cs set:colspan = colspan-1 ?>
49<?cs /each ?>
50
51</div><!-- end header -->
52
53
54<div id="jd-content">
55<table class="jd-inheritance-table">
56<?cs set:colspan = subcount(class.inheritance) ?>
57<?cs each:supr = class.inheritance ?>
58 <tr>
59 <?cs loop:i = 1, (subcount(class.inheritance)-colspan), 1 ?>
60 <td class="jd-inheritance-space">&nbsp;<?cs if:(subcount(class.inheritance)-colspan) == i ?>&nbsp;&nbsp;&#x21b3;<?cs /if ?></td>
61 <?cs /loop ?>
62 <td colspan="<?cs var:colspan ?>" class="jd-inheritance-class-cell"><?cs
63 if:colspan == 1
64 ?><?cs call:class_name(class.qualifiedType) ?><?cs
65 else
66 ?><?cs call:type_link(supr.class) ?><?cs
67 /if ?></td>
68 </tr>
69 <?cs set:colspan = colspan-1 ?>
70<?cs /each ?>
71</table>
72
73
74<div class="jd-descr">
75<?cs call:deprecated_warning(class) ?>
76<?cs if:subcount(class.descr) ?>
77<h2>Class Overview</h2>
78<p><?cs call:tag_list(class.descr) ?></p>
79<?cs /if ?>
80
81<?cs # this next line must be exactly like this to be parsed by eclipse ?>
82<!-- ======== NESTED CLASS SUMMARY ======== -->
83<?cs if:subcount(class.inners) ?>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]84<h4><?cs call:expando_trigger("nested-classes", "opened") ?>Nested Classes</h4>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]85<?cs call:expandable_class_list("nested-classes", class.inners, "summary") ?>
86<?cs /if ?>
87
88<?cs if:subcount(class.subclasses.direct) ?>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]89<h4><?cs call:expando_trigger("subclasses-direct", "closed") ?>Known Direct Subclasses</h4>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]90<?cs call:expandable_class_list("subclasses-direct", class.subclasses.direct, "list") ?>
91<?cs /if ?>
92
93<?cs if:subcount(class.subclasses.indirect) ?>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]94<h4><?cs call:expando_trigger("subclasses-indirect", "closed") ?>Known Indirect Subclasses</h4>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]95<?cs call:expandable_class_list("subclasses-indirect", class.subclasses.indirect, "list") ?>
96<?cs /if ?>
97
98<?cs call:see_also_tags(class.seeAlso) ?>
99
100</div><!-- jd-descr -->
101
102
103<?cs # summar macros ?>
104
105<?cs def:write_method_summary(methods) ?>
106<?cs set:count = #1 ?>
107<table class="jd-linktable">
108<?cs each:method = methods ?>
109 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
110 <td class="jd-typecol"><nobr>
111 <?cs var:method.abstract ?>
112 <?cs var:method.synchronized ?>
113 <?cs var:method.final ?>
114 <?cs var:method.static ?>
115 <?cs call:type_link(method.generic) ?>
116 <?cs call:type_link(method.returnType) ?></nobr>
117 </td>
118 <td class="jd-linkcol" width="100%"><a href="<?cs var:toroot ?><?cs var:method.href ?>"><strong><?cs var:method.name ?></strong></a>(<?cs call:parameter_list(method.params) ?>)</td>
119 </tr>
120 <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?>
121 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
122 <td class="jd-commentrow"></td>
123 <td class="jd-commentrow"><?cs call:short_descr(method) ?></td>
124 </tr>
125 <?cs /if ?>
126<?cs set:count = count + #1 ?>
127<?cs /each ?>
128</table>
129<?cs /def ?>
130
131<?cs def:write_field_summary(fields) ?>
132<?cs set:count = #1 ?>
133<table class="jd-linktable">
134 <?cs each:field=fields ?>
135 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
136 <td class="jd-descrcol"><?cs var:field.scope ?>&nbsp;</td>
137 <td class="jd-descrcol"><?cs var:field.static ?>&nbsp;</td>
138 <td class="jd-descrcol"><?cs var:field.final ?>&nbsp;</td>
139 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
140 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
141 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
142 </tr>
143 <?cs set:count = count + #1 ?>
144 <?cs /each ?>
145</table>
146<?cs /def ?>
147
148<?cs def:write_constant_summary(fields) ?>
149<?cs set:count = #1 ?>
150<table class="jd-linktable">
151
152 <?cs each:field=fields ?>
153 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
154 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
155 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
156 <td class="jd-descrcol"><?cs call:short_descr(field) ?>&nbsp;</td>
157 </tr>
158 <?cs set:count = count + #1 ?>
159 <?cs /each ?>
160</table>
161<?cs /def ?>
162
163<?cs def:write_attr_summary(attrs) ?>
164<?cs set:count = #1 ?>
165<table class="jd-linktable">
166 <tr>
167 <th>Attribute name</th>
168 <th>Related methods</th>
169 <th>&nbsp;</th>
170 </tr>
171 <?cs each:attr=attrs ?>
172 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
173 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></td>
174 <td class="jd-linkcol"><?cs each:m=attr.methods
175 ?><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a><br/>
176 <?cs /each ?>&nbsp;
177 </td>
178 <td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?>&nbsp;</td>
179 </tr>
180 <?cs set:count = count + #1 ?>
181 <?cs /each ?>
182</table>
183<?cs /def ?>
184
185<?cs # end macros ?>
186
187<div class="jd-descr">
188<h2>Summary</h2>
189
190<?cs # this next line must be exactly like this to be parsed by eclipse ?>
191<!-- =========== FIELD SUMMARY =========== -->
192<?cs if:subcount(class.attrs) ?>
193<h3>XML Attributes</h3>
194<?cs call:write_attr_summary(class.attrs) ?>
195<?cs /if ?>
196
197<?cs each:cl=class.inherited ?>
198<?cs if:subcount(cl.attrs) ?>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]199<h4><?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>XML Attributes inherited
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]200 from <?cs var:cl.kind ?>
201 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
202</h4>
203<div id="inherited-attrs-<?cs var:cl.qualified ?>">
204 <div id="inherited-attrs-<?cs var:cl.qualified ?>-list"
205 class="jd-inheritedlinks">
206 </div>
207 <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary"
208 style="display: none;">
209 <?cs call:write_attr_summary(cl.attrs) ?>
210 </div>
211</div>
212<?cs /if ?>
213<?cs /each ?>
214
215
216
217<?cs if:subcount(class.enumConstants) ?>
218<?cs # this next line must be exactly like this to be parsed by eclipse ?>
219<!-- =========== ENUM CONSTANT SUMMARY =========== -->
220<h3>Enum Values</h3>
221<?cs set:count = #1 ?>
222<table class="jd-linktable">
223 <?cs each:field=class.enumConstants ?>
224 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
225 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
226 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
227 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
228 </tr>
229 <?cs set:count = count + #1 ?>
230 <?cs /each ?>
231</table>
232<?cs /if ?>
233
234<?cs if:subcount(class.constants) ?>
235<?cs # this next line must be exactly like this to be parsed by eclipse ?>
236<!-- =========== FIELD SUMMARY =========== -->
237<h3>Constants</h3>
238<?cs call:write_constant_summary(class.constants) ?>
239<?cs /if ?>
240
241<?cs each:cl=class.inherited ?>
242<?cs if:subcount(cl.constants) ?>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]243<h4><?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>Constants inherited
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]244 from <?cs var:cl.kind ?>
245 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
246</h4>
247<div id="inherited-constants-<?cs var:cl.qualified ?>">
248<div id="inherited-constants-<?cs var:cl.qualified ?>-list"
249 class="jd-inheritedlinks">
250
251</div>
252<div id="inherited-constants-<?cs var:cl.qualified ?>-summary"
253 style="display: none;">
254<?cs call:write_constant_summary(cl.constants) ?>
255</div>
256</div>
257<?cs /if ?>
258<?cs /each ?>
259
260
261<?cs if:subcount(class.fields) ?>
262<?cs # this next line must be exactly like this to be parsed by eclipse ?>
263<!-- =========== FIELD SUMMARY =========== -->
264<h3>Fields</h3>
265<?cs call:write_field_summary(class.fields) ?>
266<?cs /if ?>
267
268<?cs each:cl=class.inherited ?>
269<?cs if:subcount(cl.fields) ?>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]270<h4><?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>Fields inherited
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]271 from <?cs var:cl.kind ?>
272 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
273</h4>
274<div id="inherited-fields-<?cs var:cl.qualified ?>">
275<div id="inherited-fields-<?cs var:cl.qualified ?>-list"
276 class="jd-inheritedlinks">
277
278</div>
279<div id="inherited-fields-<?cs var:cl.qualified ?>-summary"
280 style="display: none;">
281<?cs call:write_field_summary(cl.fields) ?>
282</div>
283</div>
284<?cs /if ?>
285<?cs /each ?>
286
287
288<?cs if:subcount(class.ctors.public) ?>
289<?cs # this next line must be exactly like this to be parsed by eclipse ?>
290<!-- ======== CONSTRUCTOR SUMMARY ======== -->
291<h3>Public Constructors</h3>
292<?cs call:write_method_summary(class.ctors.public) ?>
293<?cs /if ?>
294
295<?cs if:subcount(class.ctors.protected) ?>
296<?cs # this next line must be exactly like this to be parsed by eclipse ?>
297<!-- ======== CONSTRUCTOR SUMMARY ======== -->
298<h3>Protected Constructors</h3>
299<?cs call:write_method_summary(class.ctors.protected) ?>
300<?cs /if ?>
301
302<?cs if:subcount(class.methods.public) ?>
303<?cs # this next line must be exactly like this to be parsed by eclipse ?>
304<!-- ========== METHOD SUMMARY =========== -->
305<h3>Public Methods</h3>
306<?cs call:write_method_summary(class.methods.public) ?>
307<?cs /if ?>
308
309<?cs if:subcount(class.methods.protected) ?>
310<?cs # this next line must be exactly like this to be parsed by eclipse ?>
311<!-- ========== METHOD SUMMARY =========== -->
312<h3>Protected Methods</h3>
313<?cs call:write_method_summary(class.methods.protected) ?>
314<?cs /if ?>
315
316<?cs each:cl=class.inherited ?>
317<?cs if:subcount(cl.methods) ?>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -0800[diff] [blame]318<h4><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>Methods inherited
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700[diff] [blame]319 from <?cs var:cl.kind ?>
320 <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
321</h4>
322<div id="inherited-methods-<?cs var:cl.qualified ?>">
323<div id="inherited-methods-<?cs var:cl.qualified ?>-list"
324 class="jd-inheritedlinks">
325
326</div>
327<div id="inherited-methods-<?cs var:cl.qualified ?>-summary"
328 style="display: none;">
329<?cs call:write_method_summary(cl.methods) ?>
330</div>
331</div>
332<?cs /if ?>
333<?cs /each ?>
334
335</div><!-- jd-descr (summary) -->
336
337<!-- Details -->
338
339<?cs def:write_field_details(fields) ?>
340<?cs each:field=fields ?>
341<?cs # this next line must be exactly like this to be parsed by eclipse ?>
342<div class="jd-details" id="<?cs var:field.anchor ?>">
343 <h4 class="jd-details-title">
344 <span class="normal">
345 <?cs var:field.scope ?>
346 <?cs var:field.static ?>
347 <?cs var:field.final ?>
348 <?cs call:type_link(field.type) ?>
349 </span>
350 <?cs var:field.name ?>
351 </h4>
352 <div class="jd-details-descr"><?cs call:description(field) ?>
353 <?cs if:subcount(field.constantValue) ?>
354 <div class="jd-tagdata">
355 <span class="jd-tagtitle">Constant Value: </span>
356 <span>
357 <?cs if:field.constantValue.isString ?>
358 <?cs var:field.constantValue.str ?>
359 <?cs else ?>
360 <?cs var:field.constantValue.dec ?>
361 (<?cs var:field.constantValue.hex ?>)
362 <?cs /if ?>
363 </span>
364 </div>
365 <?cs /if ?>
366 </div>
367</div>
368<?cs /each ?>
369<?cs /def ?>
370
371<?cs def:write_method_details(methods) ?>
372<?cs each:method=methods ?>
373<?cs # this next line must be exactly like this to be parsed by eclipse ?>
374<div class="jd-details" id="<?cs var:method.anchor ?>">
375 <h4 class="jd-details-title">
376 <span class="normal">
377 <?cs var:method.scope ?>
378 <?cs var:method.static ?>
379 <?cs var:method.final ?>
380 <?cs var:method.abstract ?>
381 <?cs var:method.synchronized ?>
382 <?cs call:type_link(method.returnType) ?>
383 </span>
384 <?cs var:method.name ?>(<?cs call:parameter_list(method.params) ?>)
385 </h4>
386 <div class="jd-details-descr"><?cs call:description(method) ?></div>
387</div>
388<?cs /each ?>
389<?cs /def ?>
390
391<?cs def:write_attr_details(attrs) ?>
392<?cs each:attr=attrs ?>
393<?cs # this next line must be exactly like this to be parsed by eclipse ?>
394<div class="jd-details" id="<?cs var:attr.anchor ?>">
395 <h4 class="jd-details-title"><?cs var:attr.name ?></h4>
396 <div class="jd-details-descr">
397 <?cs call:description(attr) ?>
398
399 <div class="jd-tagdata">
400 <h5 class="jd-tagtitle">Related Methods</h5>
401 <ul class="nolist">
402 <?cs each:m=attr.methods ?>
403 <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
404 <?cs /each ?>
405 </ul>
406 </div>
407 </div>
408</div>
409<?cs /each ?>
410<?cs /def ?>
411
412
413<!-- XML Attributes -->
414<?cs if:subcount(class.attrs) ?>
415<h2>XML Attributes</h2>
416<?cs call:write_attr_details(class.attrs) ?>
417<?cs /if ?>
418
419<!-- Enum Values -->
420<?cs if:subcount(class.enumConstants) ?>
421<h2>Enum Values</h2>
422<?cs call:write_field_details(class.enumConstants) ?>
423<?cs /if ?>
424
425<!-- Constants -->
426<?cs if:subcount(class.constants) ?>
427<h2>Constants</h2>
428<?cs call:write_field_details(class.constants) ?>
429<?cs /if ?>
430
431<!-- Fields -->
432<?cs if:subcount(class.fields) ?>
433<h2>Fields</h2>
434<?cs call:write_field_details(class.fields) ?>
435<?cs /if ?>
436
437<!-- Public ctors -->
438<?cs if:subcount(class.ctors.public) ?>
439<h2>Public Constructors</h2>
440<?cs call:write_method_details(class.ctors.public) ?>
441<?cs /if ?>
442
443<?cs # this next line must be exactly like this to be parsed by eclipse ?>
444<!-- ========= CONSTRUCTOR DETAIL ======== -->
445<!-- Protected ctors -->
446<?cs if:subcount(class.ctors.protected) ?>
447<h2>Protected Constructors</h2>
448<?cs call:write_method_details(class.ctors.protected) ?>
449<?cs /if ?>
450
451<?cs # this next line must be exactly like this to be parsed by eclipse ?>
452<!-- ========= CONSTRUCTOR DETAIL ======== -->
453<!-- Public methdos -->
454<?cs if:subcount(class.methods.public) ?>
455<h2>Public Methods</h2>
456<?cs call:write_method_details(class.methods.public) ?>
457<?cs /if ?>
458
459<?cs # this next line must be exactly like this to be parsed by eclipse ?>
460<!-- ========= METHOD DETAIL ======== -->
461<?cs if:subcount(class.methods.protected) ?>
462<h2>Protected Methods</h2>
463<?cs call:write_method_details(class.methods.protected) ?>
464<?cs /if ?>
465
466<?cs # this next line must be exactly like this to be parsed by eclipse ?>
467<!-- ========= END OF CLASS DATA ========= -->
468
469<?cs include:"footer.cs" ?>
470</div> <!-- jd-content -->
471
472</div><!-- end doc-content -->
473<?cs include:"analytics.cs" ?>
474</body>
475</html>