Gitiles
Code Review Sign In
review.blissroms.org / platform_build_make / df09424f19ca8d455037b19641b15a7c55d9523f / . / tools / droiddoc / templates / class.cs
blob: 90e14721fbc546eaacd4a1f1b0b6bf8059bcb95a [file] [log] [blame]
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]1<?cs include:"doctype.cs" ?>
2<?cs include:"macros.cs" ?>
3<html>
4<?cs include:"head_tag.cs" ?>
5<body>
6<script type="text/javascript">
7function toggleInherited(linkObj, expand) {
8 var base = linkObj.getAttribute("id");
9 var list = document.getElementById(base + "-list");
10 var summary = document.getElementById(base + "-summary");
11 var trigger = document.getElementById(base + "-trigger");
12 var a = $(linkObj);
13 if ( (expand == null && a.hasClass("closed")) || expand ) {
14 list.style.display = "none";
15 summary.style.display = "block";
16 trigger.src = "<?cs var:toroot ?>assets/images/triangle-opened.png";
17 a.removeClass("closed");
18 a.addClass("opened");
19 } else if ( (expand == null && a.hasClass("opened")) || (expand == false) ) {
20 list.style.display = "block";
21 summary.style.display = "none";
22 trigger.src = "<?cs var:toroot ?>assets/images/triangle-closed.png";
23 a.removeClass("opened");
24 a.addClass("closed");
25 }
26 return false;
27}
28</script>
29
30<?cs include:"header.cs" ?>
31
32<div class="g-unit" id="doc-content">
33
34<div id="api-info-block">
35
36<?cs # are there inherited members ?>
37<?cs each:cl=class.inherited ?>
38 <?cs if:subcount(cl.methods) ?>
39 <?cs set:inhmethods = #1 ?>
40 <?cs /if ?>
41 <?cs if:subcount(cl.constants) ?>
42 <?cs set:inhconstants = #1 ?>
43 <?cs /if ?>
44 <?cs if:subcount(cl.fields) ?>
45 <?cs set:inhfields = #1 ?>
46 <?cs /if ?>
47 <?cs if:subcount(cl.attrs) ?>
48 <?cs set:inhattrs = #1 ?>
49 <?cs /if ?>
50<?cs /each ?>
51
52<div class="sum-details-links">
53Summary:
54<?cs if:subcount(class.inners) ?>
55 <a href="#nestedclasses">Nested Classes</a>
56 <?cs set:linkcount = #1 ?>
57<?cs /if ?>
58<?cs if:subcount(class.attrs) ?>
59 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#lattrs">XML Attrs</a>
60 <?cs set:linkcount = #1 ?>
61<?cs /if ?>
62<?cs if:inhattrs ?>
63 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhattrs">Inherited XML Attrs</a>
64 <?cs set:linkcount = #1 ?>
65<?cs /if ?>
66<?cs if:subcount(class.enumConstants) ?>
67 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#enumconstants">Enums</a>
68 <?cs set:linkcount = #1 ?>
69<?cs /if ?>
70<?cs if:subcount(class.constants) ?>
71 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#constants">Constants</a>
72 <?cs set:linkcount = #1 ?>
73<?cs /if ?>
74<?cs if:inhconstants ?>
75 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhconstants">Inherited Constants</a>
76 <?cs set:linkcount = #1 ?>
77<?cs /if ?>
78<?cs if:subcount(class.fields) ?>
79 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#lfields">Fields</a>
80 <?cs set:linkcount = #1 ?>
81<?cs /if ?>
82<?cs if:inhfields ?>
83 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhfields">Inherited Fields</a>
84 <?cs set:linkcount = #1 ?>
85<?cs /if ?>
86<?cs if:subcount(class.ctors.public) ?>
87 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#pubctors">Ctors</a>
88 <?cs set:linkcount = #1 ?>
89<?cs /if ?>
90<?cs if:subcount(class.ctors.protected) ?>
91 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#proctors">Protected Ctors</a>
92 <?cs set:linkcount = #1 ?>
93<?cs /if ?>
94<?cs if:subcount(class.methods.public) ?>
95 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#pubmethods">Methods</a>
96 <?cs set:linkcount = #1 ?>
97<?cs /if ?>
98<?cs if:subcount(class.methods.protected) ?>
99 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#promethods">Protected Methods</a>
100 <?cs set:linkcount = #1 ?>
101<?cs /if ?>
102<?cs if:inhmethods ?>
103 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhmethods">Inherited Methods</a>
104<?cs /if ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]105<?cs if:inhattrs || inhconstants || inhfields || inhmethods || subcount(class.subclasses.direct) || subcount(class.subclasses.indirect) ?>
106&#124; <a href="#" onclick="return toggleAllSummaryInherited(this)">[Expand All]</a>
107<?cs /if ?>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]108</div><!-- end sum-details-links -->
109
110</div><!-- end api-info-block -->
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]111
112<?cs # this next line must be exactly like this to be parsed by eclipse ?>
113<!-- ======== START OF CLASS DATA ======== -->
114
115<div id="jd-header">
116 <?cs var:class.scope ?>
117 <?cs var:class.static ?>
118 <?cs var:class.final ?>
119 <?cs var:class.abstract ?>
120 <?cs var:class.kind ?>
121<h1><?cs var:class.name ?></h1>
122
123<?cs set:colspan = subcount(class.inheritance) ?>
124<?cs each:supr = class.inheritance ?>
125 <?cs if:colspan == 2 ?>
126 extends <?cs call:type_link(supr.short_class) ?><br/>
127 <?cs /if ?>
128 <?cs if:last(supr) && subcount(supr.interfaces) ?>
129 implements
130 <?cs each:t=supr.interfaces ?>
131 <?cs call:type_link(t) ?>
132 <?cs /each ?>
133 <?cs /if ?>
134 <?cs set:colspan = colspan-1 ?>
135<?cs /each ?>
136
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]137<div class="api-level"><?cs call:since_tags(class) ?></div>
138
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]139</div><!-- end header -->
140
141
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]142<div id="jd-content" class="apilevel-<?cs var:class.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]143<table class="jd-inheritance-table">
144<?cs set:colspan = subcount(class.inheritance) ?>
145<?cs each:supr = class.inheritance ?>
146 <tr>
147 <?cs loop:i = 1, (subcount(class.inheritance)-colspan), 1 ?>
148 <td class="jd-inheritance-space">&nbsp;<?cs if:(subcount(class.inheritance)-colspan) == i ?>&nbsp;&nbsp;&#x21b3;<?cs /if ?></td>
149 <?cs /loop ?>
150 <td colspan="<?cs var:colspan ?>" class="jd-inheritance-class-cell"><?cs
151 if:colspan == 1
152 ?><?cs call:class_name(class.qualifiedType) ?><?cs
153 else
154 ?><?cs call:type_link(supr.class) ?><?cs
155 /if ?></td>
156 </tr>
157 <?cs set:colspan = colspan-1 ?>
158<?cs /each ?>
159</table>
160
161<?cs # this next line must be exactly like this to be parsed by eclipse ?>
162
163<?cs if:subcount(class.subclasses.direct) ?>
164<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;">
165<?cs call:expando_trigger("subclasses-direct", "closed") ?>Known Direct Subclasses
166<?cs call:expandable_class_list("subclasses-direct", class.subclasses.direct, "list") ?>
167</td></tr></table>
168<?cs /if ?>
169
170<?cs if:subcount(class.subclasses.indirect) ?>
171<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;">
172<?cs call:expando_trigger("subclasses-indirect", "closed") ?>Known Indirect Subclasses
173<?cs call:expandable_class_list("subclasses-indirect", class.subclasses.indirect, "list") ?>
174</td></tr></table>
175<?cs /if ?>
176
177<div class="jd-descr">
178<?cs call:deprecated_warning(class) ?>
179<?cs if:subcount(class.descr) ?>
180<h2>Class Overview</h2>
181<p><?cs call:tag_list(class.descr) ?></p>
182<?cs /if ?>
183
184<?cs call:see_also_tags(class.seeAlso) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]185
186</div><!-- jd-descr -->
187
188
189<?cs # summary macros ?>
190
191<?cs def:write_method_summary(methods) ?>
192<?cs set:count = #1 ?>
193<?cs each:method = methods ?>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]194 <?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
195 <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:method.since ?>" >
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]196 <td class="jd-typecol"><nobr>
197 <?cs var:method.abstract ?>
198 <?cs var:method.synchronized ?>
199 <?cs var:method.final ?>
200 <?cs var:method.static ?>
201 <?cs call:type_link(method.generic) ?>
202 <?cs call:type_link(method.returnType) ?></nobr>
203 </td>
204 <td class="jd-linkcol" width="100%"><nobr>
205 <span class="sympad"><a href="<?cs var:toroot ?><?cs var:method.href ?>">
206 <?cs var:method.name ?></a></span>(<?cs call:parameter_list(method.params) ?>)</nobr>
207 <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?>
208 <div class="jd-descrdiv"><?cs call:short_descr(method) ?></div>
209 <?cs /if ?>
210 </td></tr>
211<?cs set:count = count + #1 ?>
212<?cs /each ?>
213<?cs /def ?>
214
215<?cs def:write_field_summary(fields) ?>
216<?cs set:count = #1 ?>
217 <?cs each:field=fields ?>
218 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
219 <td class="jd-typecol"><nobr>
220 <?cs var:field.scope ?>
221 <?cs var:field.static ?>
222 <?cs var:field.final ?>
223 <?cs call:type_link(field.type) ?></nobr></td>
224 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td>
225 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
226 </tr>
227 <?cs set:count = count + #1 ?>
228 <?cs /each ?>
229<?cs /def ?>
230
231<?cs def:write_constant_summary(fields) ?>
232<?cs set:count = #1 ?>
233 <?cs each:field=fields ?>
234 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
235 <td class="jd-typecol"><?cs call:type_link(field.type) ?></td>
236 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td>
237 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
238 </tr>
239 <?cs set:count = count + #1 ?>
240 <?cs /each ?>
241<?cs /def ?>
242
243<?cs def:write_attr_summary(attrs) ?>
244<?cs set:count = #1 ?>
245 <tr>
246 <td><nobr><em>Attribute Name</em></nobr></td>
247 <td><nobr><em>Related Method</em></nobr></td>
248 <td><nobr><em>Description</em></nobr></td>
249 </tr>
250 <?cs each:attr=attrs ?>
251 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
252 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></td>
253 <td class="jd-linkcol"><?cs each:m=attr.methods ?>
254 <a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a>
255 <?cs /each ?>
256 </td>
257 <td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?>&nbsp;</td>
258 </tr>
259 <?cs set:count = count + #1 ?>
260 <?cs /each ?>
261<?cs /def ?>
262
263<?cs def:write_inners_summary(classes) ?>
264<?cs set:count = #1 ?>
265 <?cs each:cl=class.inners ?>
266 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
267 <td class="jd-typecol"><nobr>
268 <?cs var:class.scope ?>
269 <?cs var:class.static ?>
270 <?cs var:class.final ?>
271 <?cs var:class.abstract ?>
272 <?cs var:class.kind ?></nobr></td>
273 <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
274 <td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?>&nbsp;</td>
275 </tr>
276 <?cs set:count = count + #1 ?>
277 <?cs /each ?>
278<?cs /def ?>
279
280<?cs # end macros ?>
281
282<div class="jd-descr">
283<h2>Summary</h2>
284
285<?cs if:subcount(class.inners) ?>
286<?cs # this next line must be exactly like this to be parsed by eclipse ?>
287<!-- ======== NESTED CLASS SUMMARY ======== -->
288<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr>
289<?cs call:write_inners_summary(class.inners) ?>
290<?cs /if ?>
291
292<?cs # this next line must be exactly like this to be parsed by eclipse ?>
293<?cs if:subcount(class.attrs) ?>
294<!-- =========== FIELD SUMMARY =========== -->
295<table id="lattrs" class="jd-sumtable"><tr><th colspan="12">XML Attributes</th></tr>
296<?cs call:write_attr_summary(class.attrs) ?>
297<?cs /if ?>
298
299<?cs # if there are inherited attrs, write the table ?>
300<?cs if:inhattrs ?>
301<?cs # this next line must be exactly like this to be parsed by eclipse ?>
302<!-- =========== FIELD SUMMARY =========== -->
303<table id="inhattrs" class="jd-sumtable"><tr><th>
304 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
305 <div style="clear:left;">Inherited XML Attributes</div></th></tr>
306<?cs each:cl=class.inherited ?>
307<?cs if:subcount(cl.attrs) ?>
308<tr><td colspan="12">
309<?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
310<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
311<div id="inherited-attrs-<?cs var:cl.qualified ?>">
312 <div id="inherited-attrs-<?cs var:cl.qualified ?>-list"
313 class="jd-inheritedlinks">
314 </div>
315 <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary" style="display: none;">
316 <table class="jd-sumtable-expando">
317 <?cs call:write_attr_summary(cl.attrs) ?></table>
318 </div>
319</div>
320</td></tr>
321<?cs /if ?>
322<?cs /each ?>
323</table>
324<?cs /if ?>
325
326<?cs if:subcount(class.enumConstants) ?>
327<?cs # this next line must be exactly like this to be parsed by eclipse ?>
328<!-- =========== ENUM CONSTANT SUMMARY =========== -->
329<table id="enumconstants" class="jd-sumtable"><tr><th colspan="12">Enum Values</th></tr>
330<?cs set:count = #1 ?>
331 <?cs each:field=class.enumConstants ?>
332 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
333 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
334 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
335 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
336 </tr>
337 <?cs set:count = count + #1 ?>
338 <?cs /each ?>
339<?cs /if ?>
340
341<?cs if:subcount(class.constants) ?>
342<?cs # this next line must be exactly like this to be parsed by eclipse ?>
343<!-- =========== ENUM CONSTANT SUMMARY =========== -->
344<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
345<?cs call:write_constant_summary(class.constants) ?>
346</table>
347<?cs /if ?>
348
349<?cs # if there are inherited constants, write the table ?>
350<?cs if:inhconstants ?>
351<?cs # this next line must be exactly like this to be parsed by eclipse ?>
352<!-- =========== ENUM CONSTANT SUMMARY =========== -->
353<table id="inhconstants" class="jd-sumtable"><tr><th>
354 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
355 <div style="clear:left;">Inherited Constants</div></th></tr>
356<?cs each:cl=class.inherited ?>
357<?cs if:subcount(cl.constants) ?>
358<tr><td colspan="12">
359<?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
360<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
361<div id="inherited-constants-<?cs var:cl.qualified ?>">
362 <div id="inherited-constants-<?cs var:cl.qualified ?>-list"
363 class="jd-inheritedlinks">
364 </div>
365 <div id="inherited-constants-<?cs var:cl.qualified ?>-summary" style="display: none;">
366 <table class="jd-sumtable-expando">
367 <?cs call:write_constant_summary(cl.constants) ?></table>
368 </div>
369</div>
370</td></tr>
371<?cs /if ?>
372<?cs /each ?>
373</table>
374<?cs /if ?>
375
376<?cs if:subcount(class.fields) ?>
377<?cs # this next line must be exactly like this to be parsed by eclipse ?>
378<!-- =========== FIELD SUMMARY =========== -->
379<table id="lfields" class="jd-sumtable"><tr><th colspan="12">Fields</th></tr>
380<?cs call:write_field_summary(class.fields) ?>
381</table>
382<?cs /if ?>
383
384<?cs # if there are inherited fields, write the table ?>
385<?cs if:inhfields ?>
386<?cs # this next line must be exactly like this to be parsed by eclipse ?>
387<!-- =========== FIELD SUMMARY =========== -->
388<table id="inhfields" class="jd-sumtable"><tr><th>
389 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
390 <div style="clear:left;">Inherited Fields</div></th></tr>
391<?cs each:cl=class.inherited ?>
392<?cs if:subcount(cl.fields) ?>
393<tr><td colspan="12">
394<?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
395<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
396<div id="inherited-fields-<?cs var:cl.qualified ?>">
397 <div id="inherited-fields-<?cs var:cl.qualified ?>-list"
398 class="jd-inheritedlinks">
399 </div>
400 <div id="inherited-fields-<?cs var:cl.qualified ?>-summary" style="display: none;">
401 <table class="jd-sumtable-expando">
402 <?cs call:write_field_summary(cl.fields) ?></table>
403 </div>
404</div>
405</td></tr>
406<?cs /if ?>
407<?cs /each ?>
408</table>
409<?cs /if ?>
410
411<?cs if:subcount(class.ctors.public) ?>
412<?cs # this next line must be exactly like this to be parsed by eclipse ?>
413<!-- ======== CONSTRUCTOR SUMMARY ======== -->
414<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
415<?cs call:write_method_summary(class.ctors.public) ?>
416</table>
417<?cs /if ?>
418
419<?cs if:subcount(class.ctors.protected) ?>
420<?cs # this next line must be exactly like this to be parsed by eclipse ?>
421<!-- ======== CONSTRUCTOR SUMMARY ======== -->
422<table id="proctors" class="jd-sumtable"><tr><th colspan="12">Protected Constructors</th></tr>
423<?cs call:write_method_summary(class.ctors.protected) ?>
424</table>
425<?cs /if ?>
426
427<?cs if:subcount(class.methods.public) ?>
428<?cs # this next line must be exactly like this to be parsed by eclipse ?>
429<!-- ========== METHOD SUMMARY =========== -->
430<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
431<?cs call:write_method_summary(class.methods.public) ?>
432</table>
433<?cs /if ?>
434
435<?cs if:subcount(class.methods.protected) ?>
436<?cs # this next line must be exactly like this to be parsed by eclipse ?>
437<!-- ========== METHOD SUMMARY =========== -->
438<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr>
439<?cs call:write_method_summary(class.methods.protected) ?>
440</table>
441<?cs /if ?>
442
443<?cs # if there are inherited methods, write the table ?>
444<?cs if:inhmethods ?>
445<?cs # this next line must be exactly like this to be parsed by eclipse ?>
446<!-- ========== METHOD SUMMARY =========== -->
447<table id="inhmethods" class="jd-sumtable"><tr><th>
448 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
449 <div style="clear:left;">Inherited Methods</div></th></tr>
450<?cs each:cl=class.inherited ?>
451<?cs if:subcount(cl.methods) ?>
452<tr><td colspan="12"><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>
453From <?cs var:cl.kind ?> <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
454<div id="inherited-methods-<?cs var:cl.qualified ?>">
455 <div id="inherited-methods-<?cs var:cl.qualified ?>-list"
456 class="jd-inheritedlinks">
457 </div>
458 <div id="inherited-methods-<?cs var:cl.qualified ?>-summary" style="display: none;">
459 <table class="jd-sumtable-expando">
460 <?cs call:write_method_summary(cl.methods) ?></table>
461 </div>
462</div>
463</td></tr>
464<?cs /if ?>
465<?cs /each ?>
466</table>
467<?cs /if ?>
468
469</div><!-- jd-descr (summary) -->
470
471<!-- Details -->
472
473<?cs def:write_field_details(fields) ?>
474<?cs each:field=fields ?>
475<?cs # this next line must be exactly like this to be parsed by eclipse ?>
476<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
477<A NAME="<?cs var:field.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]478<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
479<div class="jd-details api apilevel-<?cs var:field.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]480 <h4 class="jd-details-title">
481 <span class="normal">
482 <?cs var:field.scope ?>
483 <?cs var:field.static ?>
484 <?cs var:field.final ?>
485 <?cs call:type_link(field.type) ?>
486 </span>
487 <?cs var:field.name ?>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]488 <span class="api-level">
489 <?cs call:since_tags(field) ?>
490 </span>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]491 </h4>
492 <div class="jd-details-descr"><?cs call:description(field) ?>
493 <?cs if:subcount(field.constantValue) ?>
494 <div class="jd-tagdata">
495 <span class="jd-tagtitle">Constant Value: </span>
496 <span>
497 <?cs if:field.constantValue.isString ?>
498 <?cs var:field.constantValue.str ?>
499 <?cs else ?>
500 <?cs var:field.constantValue.dec ?>
501 (<?cs var:field.constantValue.hex ?>)
502 <?cs /if ?>
503 </span>
504 </div>
505 <?cs /if ?>
506 </div>
507</div>
508<?cs /each ?>
509<?cs /def ?>
510
511<?cs def:write_method_details(methods) ?>
512<?cs each:method=methods ?>
513<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
514<A NAME="<?cs var:method.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]515<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
516<div class="jd-details api apilevel-<?cs var:method.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]517 <h4 class="jd-details-title">
518 <span class="normal">
519 <?cs var:method.scope ?>
520 <?cs var:method.static ?>
521 <?cs var:method.final ?>
522 <?cs var:method.abstract ?>
523 <?cs var:method.synchronized ?>
524 <?cs call:type_link(method.returnType) ?>
525 </span>
526 <span class="sympad"><?cs var:method.name ?></span>
527 <span class="normal">(<?cs call:parameter_list(method.params) ?>)</span>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]528 <span class="api-level">
529 <?cs call:since_tags(method) ?>
530 </span>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]531 </h4>
532 <div class="jd-details-descr"><?cs call:description(method) ?></div>
533</div>
534<?cs /each ?>
535<?cs /def ?>
536
537<?cs def:write_attr_details(attrs) ?>
538<?cs each:attr=attrs ?>
539<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
540<A NAME="<?cs var:attr.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame^]541<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
542<div class="jd-details api apilevel-<?cs var:attr.since ?>">
543 <h4 class="jd-details-title"><?cs var:attr.name ?>
544 <span class="api-level">
545 <?cs call:since_tags(attr) ?>
546 </span>
547 </h4>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]548 <div class="jd-details-descr">
549 <?cs call:description(attr) ?>
550
551 <div class="jd-tagdata">
552 <h5 class="jd-tagtitle">Related Methods</h5>
553 <ul class="nolist">
554 <?cs each:m=attr.methods ?>
555 <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
556 <?cs /each ?>
557 </ul>
558 </div>
559 </div>
560</div>
561<?cs /each ?>
562<?cs /def ?>
563
564
565<!-- XML Attributes -->
566<?cs if:subcount(class.attrs) ?>
567<?cs # this next line must be exactly like this to be parsed by eclipse ?>
568<!-- ========= FIELD DETAIL ======== -->
569<h2>XML Attributes</h2>
570<?cs call:write_attr_details(class.attrs) ?>
571<?cs /if ?>
572
573<!-- Enum Values -->
574<?cs if:subcount(class.enumConstants) ?>
575<?cs # this next line must be exactly like this to be parsed by eclipse ?>
576<!-- ========= ENUM CONSTANTS DETAIL ======== -->
577<h2>Enum Values</h2>
578<?cs call:write_field_details(class.enumConstants) ?>
579<?cs /if ?>
580
581<!-- Constants -->
582<?cs if:subcount(class.constants) ?>
583<?cs # this next line must be exactly like this to be parsed by eclipse ?>
584<!-- ========= ENUM CONSTANTS DETAIL ======== -->
585<h2>Constants</h2>
586<?cs call:write_field_details(class.constants) ?>
587<?cs /if ?>
588
589<!-- Fields -->
590<?cs if:subcount(class.fields) ?>
591<?cs # this next line must be exactly like this to be parsed by eclipse ?>
592<!-- ========= FIELD DETAIL ======== -->
593<h2>Fields</h2>
594<?cs call:write_field_details(class.fields) ?>
595<?cs /if ?>
596
597<!-- Public ctors -->
598<?cs if:subcount(class.ctors.public) ?>
599<?cs # this next line must be exactly like this to be parsed by eclipse ?>
600<!-- ========= CONSTRUCTOR DETAIL ======== -->
601<h2>Public Constructors</h2>
602<?cs call:write_method_details(class.ctors.public) ?>
603<?cs /if ?>
604
605<?cs # this next line must be exactly like this to be parsed by eclipse ?>
606<!-- ========= CONSTRUCTOR DETAIL ======== -->
607<!-- Protected ctors -->
608<?cs if:subcount(class.ctors.protected) ?>
609<h2>Protected Constructors</h2>
610<?cs call:write_method_details(class.ctors.protected) ?>
611<?cs /if ?>
612
613<?cs # this next line must be exactly like this to be parsed by eclipse ?>
614<!-- ========= METHOD DETAIL ======== -->
615<!-- Public methdos -->
616<?cs if:subcount(class.methods.public) ?>
617<h2>Public Methods</h2>
618<?cs call:write_method_details(class.methods.public) ?>
619<?cs /if ?>
620
621<?cs # this next line must be exactly like this to be parsed by eclipse ?>
622<!-- ========= METHOD DETAIL ======== -->
623<?cs if:subcount(class.methods.protected) ?>
624<h2>Protected Methods</h2>
625<?cs call:write_method_details(class.methods.protected) ?>
626<?cs /if ?>
627
628<?cs # the next two lines must be exactly like this to be parsed by eclipse ?>
629<!-- ========= END OF CLASS DATA ========= -->
630<A NAME="navbar_top"></A>
631
632<?cs include:"footer.cs" ?>
633</div> <!-- jd-content -->
634
635</div><!-- end doc-content -->
636
637<?cs include:"trailer.cs" ?>
638
639</body>
640</html>