Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / build / 25fda19689516e00a7c20d0fb9e5b7d09842884c / . / tools / droiddoc / templates / class.cs
blob: 9bc2ba0a8d9fb34f04364f73c86dc641e43af76d [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" ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]5<body class="<?cs var:class.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]29<?cs include:"header.cs" ?>
30
31<div class="g-unit" id="doc-content">
32
33<div id="api-info-block">
34
35<?cs # are there inherited members ?>
36<?cs each:cl=class.inherited ?>
37 <?cs if:subcount(cl.methods) ?>
38 <?cs set:inhmethods = #1 ?>
39 <?cs /if ?>
40 <?cs if:subcount(cl.constants) ?>
41 <?cs set:inhconstants = #1 ?>
42 <?cs /if ?>
43 <?cs if:subcount(cl.fields) ?>
44 <?cs set:inhfields = #1 ?>
45 <?cs /if ?>
46 <?cs if:subcount(cl.attrs) ?>
47 <?cs set:inhattrs = #1 ?>
48 <?cs /if ?>
49<?cs /each ?>
50
51<div class="sum-details-links">
52Summary:
53<?cs if:subcount(class.inners) ?>
54 <a href="#nestedclasses">Nested Classes</a>
55 <?cs set:linkcount = #1 ?>
56<?cs /if ?>
57<?cs if:subcount(class.attrs) ?>
58 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#lattrs">XML Attrs</a>
59 <?cs set:linkcount = #1 ?>
60<?cs /if ?>
61<?cs if:inhattrs ?>
62 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhattrs">Inherited XML Attrs</a>
63 <?cs set:linkcount = #1 ?>
64<?cs /if ?>
65<?cs if:subcount(class.enumConstants) ?>
66 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#enumconstants">Enums</a>
67 <?cs set:linkcount = #1 ?>
68<?cs /if ?>
69<?cs if:subcount(class.constants) ?>
70 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#constants">Constants</a>
71 <?cs set:linkcount = #1 ?>
72<?cs /if ?>
73<?cs if:inhconstants ?>
74 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhconstants">Inherited Constants</a>
75 <?cs set:linkcount = #1 ?>
76<?cs /if ?>
77<?cs if:subcount(class.fields) ?>
78 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#lfields">Fields</a>
79 <?cs set:linkcount = #1 ?>
80<?cs /if ?>
81<?cs if:inhfields ?>
82 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhfields">Inherited Fields</a>
83 <?cs set:linkcount = #1 ?>
84<?cs /if ?>
85<?cs if:subcount(class.ctors.public) ?>
86 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#pubctors">Ctors</a>
87 <?cs set:linkcount = #1 ?>
88<?cs /if ?>
89<?cs if:subcount(class.ctors.protected) ?>
90 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#proctors">Protected Ctors</a>
91 <?cs set:linkcount = #1 ?>
92<?cs /if ?>
93<?cs if:subcount(class.methods.public) ?>
94 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#pubmethods">Methods</a>
95 <?cs set:linkcount = #1 ?>
96<?cs /if ?>
97<?cs if:subcount(class.methods.protected) ?>
98 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#promethods">Protected Methods</a>
99 <?cs set:linkcount = #1 ?>
100<?cs /if ?>
101<?cs if:inhmethods ?>
102 <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhmethods">Inherited Methods</a>
103<?cs /if ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]104<?cs if:inhattrs || inhconstants || inhfields || inhmethods || subcount(class.subclasses.direct) || subcount(class.subclasses.indirect) ?>
105&#124; <a href="#" onclick="return toggleAllSummaryInherited(this)">[Expand All]</a>
106<?cs /if ?>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]107</div><!-- end sum-details-links -->
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]108<div class="api-level">
109 <?cs call:since_tags(class) ?>
110</div>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]111</div><!-- end api-info-block -->
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]112
113<?cs # this next line must be exactly like this to be parsed by eclipse ?>
114<!-- ======== START OF CLASS DATA ======== -->
115
116<div id="jd-header">
117 <?cs var:class.scope ?>
118 <?cs var:class.static ?>
119 <?cs var:class.final ?>
120 <?cs var:class.abstract ?>
121 <?cs var:class.kind ?>
122<h1><?cs var:class.name ?></h1>
123
124<?cs set:colspan = subcount(class.inheritance) ?>
125<?cs each:supr = class.inheritance ?>
126 <?cs if:colspan == 2 ?>
127 extends <?cs call:type_link(supr.short_class) ?><br/>
128 <?cs /if ?>
129 <?cs if:last(supr) && subcount(supr.interfaces) ?>
130 implements
131 <?cs each:t=supr.interfaces ?>
132 <?cs call:type_link(t) ?>
133 <?cs /each ?>
134 <?cs /if ?>
135 <?cs set:colspan = colspan-1 ?>
136<?cs /each ?>
137
138</div><!-- end header -->
139
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]140<div id="naMessage"></div>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]141
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]142<div id="jd-content" class="api 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 ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]218 <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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 ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]234 <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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 ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]251 <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:attr.since ?>" >
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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 ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]266 <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:cl.since ?>" >
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]267 <td class="jd-typecol"><nobr>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]268 <?cs var:cl.scope ?>
269 <?cs var:cl.static ?>
270 <?cs var:cl.final ?>
271 <?cs var:cl.abstract ?>
272 <?cs var:cl.kind ?></nobr></td>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]308<tr class="api apilevel-<?cs var:cl.since ?>" >
309<td colspan="12">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]310<?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
311<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
312<div id="inherited-attrs-<?cs var:cl.qualified ?>">
313 <div id="inherited-attrs-<?cs var:cl.qualified ?>-list"
314 class="jd-inheritedlinks">
315 </div>
316 <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary" style="display: none;">
317 <table class="jd-sumtable-expando">
318 <?cs call:write_attr_summary(cl.attrs) ?></table>
319 </div>
320</div>
321</td></tr>
322<?cs /if ?>
323<?cs /each ?>
324</table>
325<?cs /if ?>
326
327<?cs if:subcount(class.enumConstants) ?>
328<?cs # this next line must be exactly like this to be parsed by eclipse ?>
329<!-- =========== ENUM CONSTANT SUMMARY =========== -->
330<table id="enumconstants" class="jd-sumtable"><tr><th colspan="12">Enum Values</th></tr>
331<?cs set:count = #1 ?>
332 <?cs each:field=class.enumConstants ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]333 <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]334 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
335 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
336 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
337 </tr>
338 <?cs set:count = count + #1 ?>
339 <?cs /each ?>
340<?cs /if ?>
341
342<?cs if:subcount(class.constants) ?>
343<?cs # this next line must be exactly like this to be parsed by eclipse ?>
344<!-- =========== ENUM CONSTANT SUMMARY =========== -->
345<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
346<?cs call:write_constant_summary(class.constants) ?>
347</table>
348<?cs /if ?>
349
350<?cs # if there are inherited constants, write the table ?>
351<?cs if:inhconstants ?>
352<?cs # this next line must be exactly like this to be parsed by eclipse ?>
353<!-- =========== ENUM CONSTANT SUMMARY =========== -->
354<table id="inhconstants" class="jd-sumtable"><tr><th>
355 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
356 <div style="clear:left;">Inherited Constants</div></th></tr>
357<?cs each:cl=class.inherited ?>
358<?cs if:subcount(cl.constants) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]359<tr class="api apilevel-<?cs var:cl.since ?>" >
360<td colspan="12">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]361<?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
362<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
363<div id="inherited-constants-<?cs var:cl.qualified ?>">
364 <div id="inherited-constants-<?cs var:cl.qualified ?>-list"
365 class="jd-inheritedlinks">
366 </div>
367 <div id="inherited-constants-<?cs var:cl.qualified ?>-summary" style="display: none;">
368 <table class="jd-sumtable-expando">
369 <?cs call:write_constant_summary(cl.constants) ?></table>
370 </div>
371</div>
372</td></tr>
373<?cs /if ?>
374<?cs /each ?>
375</table>
376<?cs /if ?>
377
378<?cs if:subcount(class.fields) ?>
379<?cs # this next line must be exactly like this to be parsed by eclipse ?>
380<!-- =========== FIELD SUMMARY =========== -->
381<table id="lfields" class="jd-sumtable"><tr><th colspan="12">Fields</th></tr>
382<?cs call:write_field_summary(class.fields) ?>
383</table>
384<?cs /if ?>
385
386<?cs # if there are inherited fields, write the table ?>
387<?cs if:inhfields ?>
388<?cs # this next line must be exactly like this to be parsed by eclipse ?>
389<!-- =========== FIELD SUMMARY =========== -->
390<table id="inhfields" class="jd-sumtable"><tr><th>
391 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
392 <div style="clear:left;">Inherited Fields</div></th></tr>
393<?cs each:cl=class.inherited ?>
394<?cs if:subcount(cl.fields) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]395<tr class="api apilevel-<?cs var:cl.since ?>" >
396<td colspan="12">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]397<?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
398<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
399<div id="inherited-fields-<?cs var:cl.qualified ?>">
400 <div id="inherited-fields-<?cs var:cl.qualified ?>-list"
401 class="jd-inheritedlinks">
402 </div>
403 <div id="inherited-fields-<?cs var:cl.qualified ?>-summary" style="display: none;">
404 <table class="jd-sumtable-expando">
405 <?cs call:write_field_summary(cl.fields) ?></table>
406 </div>
407</div>
408</td></tr>
409<?cs /if ?>
410<?cs /each ?>
411</table>
412<?cs /if ?>
413
414<?cs if:subcount(class.ctors.public) ?>
415<?cs # this next line must be exactly like this to be parsed by eclipse ?>
416<!-- ======== CONSTRUCTOR SUMMARY ======== -->
417<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
418<?cs call:write_method_summary(class.ctors.public) ?>
419</table>
420<?cs /if ?>
421
422<?cs if:subcount(class.ctors.protected) ?>
423<?cs # this next line must be exactly like this to be parsed by eclipse ?>
424<!-- ======== CONSTRUCTOR SUMMARY ======== -->
425<table id="proctors" class="jd-sumtable"><tr><th colspan="12">Protected Constructors</th></tr>
426<?cs call:write_method_summary(class.ctors.protected) ?>
427</table>
428<?cs /if ?>
429
430<?cs if:subcount(class.methods.public) ?>
431<?cs # this next line must be exactly like this to be parsed by eclipse ?>
432<!-- ========== METHOD SUMMARY =========== -->
433<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
434<?cs call:write_method_summary(class.methods.public) ?>
435</table>
436<?cs /if ?>
437
438<?cs if:subcount(class.methods.protected) ?>
439<?cs # this next line must be exactly like this to be parsed by eclipse ?>
440<!-- ========== METHOD SUMMARY =========== -->
441<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr>
442<?cs call:write_method_summary(class.methods.protected) ?>
443</table>
444<?cs /if ?>
445
446<?cs # if there are inherited methods, write the table ?>
447<?cs if:inhmethods ?>
448<?cs # this next line must be exactly like this to be parsed by eclipse ?>
449<!-- ========== METHOD SUMMARY =========== -->
450<table id="inhmethods" class="jd-sumtable"><tr><th>
451 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
452 <div style="clear:left;">Inherited Methods</div></th></tr>
453<?cs each:cl=class.inherited ?>
454<?cs if:subcount(cl.methods) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]455<tr class="api apilevel-<?cs var:cl.since ?>" >
456<td colspan="12"><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]457From <?cs var:cl.kind ?> <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
458<div id="inherited-methods-<?cs var:cl.qualified ?>">
459 <div id="inherited-methods-<?cs var:cl.qualified ?>-list"
460 class="jd-inheritedlinks">
461 </div>
462 <div id="inherited-methods-<?cs var:cl.qualified ?>-summary" style="display: none;">
463 <table class="jd-sumtable-expando">
464 <?cs call:write_method_summary(cl.methods) ?></table>
465 </div>
466</div>
467</td></tr>
468<?cs /if ?>
469<?cs /each ?>
470</table>
471<?cs /if ?>
472
473</div><!-- jd-descr (summary) -->
474
475<!-- Details -->
476
477<?cs def:write_field_details(fields) ?>
478<?cs each:field=fields ?>
479<?cs # this next line must be exactly like this to be parsed by eclipse ?>
480<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
481<A NAME="<?cs var:field.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]482<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
483<div class="jd-details api apilevel-<?cs var:field.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]484 <h4 class="jd-details-title">
485 <span class="normal">
486 <?cs var:field.scope ?>
487 <?cs var:field.static ?>
488 <?cs var:field.final ?>
489 <?cs call:type_link(field.type) ?>
490 </span>
491 <?cs var:field.name ?>
492 </h4>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]493 <div class="api-level">
494 <?cs call:since_tags(field) ?>
495 </div>
496 <div class="jd-details-descr">
497 <?cs call:description(field) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]498 <?cs if:subcount(field.constantValue) ?>
499 <div class="jd-tagdata">
500 <span class="jd-tagtitle">Constant Value: </span>
501 <span>
502 <?cs if:field.constantValue.isString ?>
503 <?cs var:field.constantValue.str ?>
504 <?cs else ?>
505 <?cs var:field.constantValue.dec ?>
506 (<?cs var:field.constantValue.hex ?>)
507 <?cs /if ?>
508 </span>
509 </div>
510 <?cs /if ?>
511 </div>
512</div>
513<?cs /each ?>
514<?cs /def ?>
515
516<?cs def:write_method_details(methods) ?>
517<?cs each:method=methods ?>
518<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
519<A NAME="<?cs var:method.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]520<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
521<div class="jd-details api apilevel-<?cs var:method.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]522 <h4 class="jd-details-title">
523 <span class="normal">
524 <?cs var:method.scope ?>
525 <?cs var:method.static ?>
526 <?cs var:method.final ?>
527 <?cs var:method.abstract ?>
528 <?cs var:method.synchronized ?>
529 <?cs call:type_link(method.returnType) ?>
530 </span>
531 <span class="sympad"><?cs var:method.name ?></span>
532 <span class="normal">(<?cs call:parameter_list(method.params) ?>)</span>
533 </h4>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]534 <div class="api-level">
535 <?cs call:since_tags(method) ?>
536 </div>
537 <div class="jd-details-descr">
538 <?cs call:description(method) ?>
539 </div>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]540</div>
541<?cs /each ?>
542<?cs /def ?>
543
544<?cs def:write_attr_details(attrs) ?>
545<?cs each:attr=attrs ?>
546<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
547<A NAME="<?cs var:attr.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]548<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
549<div class="jd-details api apilevel-<?cs var:attr.since ?>">
550 <h4 class="jd-details-title"><?cs var:attr.name ?>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]551 </h4>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame^]552 <div class="api-level">
553 <?cs call:since_tags(attr) ?>
554 </div>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]555 <div class="jd-details-descr">
556 <?cs call:description(attr) ?>
557
558 <div class="jd-tagdata">
559 <h5 class="jd-tagtitle">Related Methods</h5>
560 <ul class="nolist">
561 <?cs each:m=attr.methods ?>
562 <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
563 <?cs /each ?>
564 </ul>
565 </div>
566 </div>
567</div>
568<?cs /each ?>
569<?cs /def ?>
570
571
572<!-- XML Attributes -->
573<?cs if:subcount(class.attrs) ?>
574<?cs # this next line must be exactly like this to be parsed by eclipse ?>
575<!-- ========= FIELD DETAIL ======== -->
576<h2>XML Attributes</h2>
577<?cs call:write_attr_details(class.attrs) ?>
578<?cs /if ?>
579
580<!-- Enum Values -->
581<?cs if:subcount(class.enumConstants) ?>
582<?cs # this next line must be exactly like this to be parsed by eclipse ?>
583<!-- ========= ENUM CONSTANTS DETAIL ======== -->
584<h2>Enum Values</h2>
585<?cs call:write_field_details(class.enumConstants) ?>
586<?cs /if ?>
587
588<!-- Constants -->
589<?cs if:subcount(class.constants) ?>
590<?cs # this next line must be exactly like this to be parsed by eclipse ?>
591<!-- ========= ENUM CONSTANTS DETAIL ======== -->
592<h2>Constants</h2>
593<?cs call:write_field_details(class.constants) ?>
594<?cs /if ?>
595
596<!-- Fields -->
597<?cs if:subcount(class.fields) ?>
598<?cs # this next line must be exactly like this to be parsed by eclipse ?>
599<!-- ========= FIELD DETAIL ======== -->
600<h2>Fields</h2>
601<?cs call:write_field_details(class.fields) ?>
602<?cs /if ?>
603
604<!-- Public ctors -->
605<?cs if:subcount(class.ctors.public) ?>
606<?cs # this next line must be exactly like this to be parsed by eclipse ?>
607<!-- ========= CONSTRUCTOR DETAIL ======== -->
608<h2>Public Constructors</h2>
609<?cs call:write_method_details(class.ctors.public) ?>
610<?cs /if ?>
611
612<?cs # this next line must be exactly like this to be parsed by eclipse ?>
613<!-- ========= CONSTRUCTOR DETAIL ======== -->
614<!-- Protected ctors -->
615<?cs if:subcount(class.ctors.protected) ?>
616<h2>Protected Constructors</h2>
617<?cs call:write_method_details(class.ctors.protected) ?>
618<?cs /if ?>
619
620<?cs # this next line must be exactly like this to be parsed by eclipse ?>
621<!-- ========= METHOD DETAIL ======== -->
622<!-- Public methdos -->
623<?cs if:subcount(class.methods.public) ?>
624<h2>Public Methods</h2>
625<?cs call:write_method_details(class.methods.public) ?>
626<?cs /if ?>
627
628<?cs # this next line must be exactly like this to be parsed by eclipse ?>
629<!-- ========= METHOD DETAIL ======== -->
630<?cs if:subcount(class.methods.protected) ?>
631<h2>Protected Methods</h2>
632<?cs call:write_method_details(class.methods.protected) ?>
633<?cs /if ?>
634
635<?cs # the next two lines must be exactly like this to be parsed by eclipse ?>
636<!-- ========= END OF CLASS DATA ========= -->
637<A NAME="navbar_top"></A>
638
639<?cs include:"footer.cs" ?>
640</div> <!-- jd-content -->
641
642</div><!-- end doc-content -->
643
644<?cs include:"trailer.cs" ?>
645
646</body>
647</html>