Gitiles
Code Review Sign In
review.blissroms.org / platform_build_make / 63ec8e3b58b50f86a03af8ddd7db388e42fc5c2a / . / tools / droiddoc / templates / class.cs
blob: 89eb9275b88c967a46f1b3e989b5ff590cbdd70d [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
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]191<?cs def:write_method_summary(methods, included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]205 <span class="sympad"><?cs call:cond_link(method.name, toroot, method.href, included) ?></span>(<?cs call:parameter_list(method.params) ?>)</nobr>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]206 <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?>
207 <div class="jd-descrdiv"><?cs call:short_descr(method) ?></div>
208 <?cs /if ?>
209 </td></tr>
210<?cs set:count = count + #1 ?>
211<?cs /each ?>
212<?cs /def ?>
213
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]214<?cs def:write_field_summary(fields, included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]215<?cs set:count = #1 ?>
216 <?cs each:field=fields ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]217 <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]218 <td class="jd-typecol"><nobr>
219 <?cs var:field.scope ?>
220 <?cs var:field.static ?>
221 <?cs var:field.final ?>
222 <?cs call:type_link(field.type) ?></nobr></td>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]223 <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]224 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
225 </tr>
226 <?cs set:count = count + #1 ?>
227 <?cs /each ?>
228<?cs /def ?>
229
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]230<?cs def:write_constant_summary(fields, included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]231<?cs set:count = #1 ?>
232 <?cs each:field=fields ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]233 <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]234 <td class="jd-typecol"><?cs call:type_link(field.type) ?></td>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]235 <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]236 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
237 </tr>
238 <?cs set:count = count + #1 ?>
239 <?cs /each ?>
240<?cs /def ?>
241
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]242<?cs def:write_attr_summary(attrs, included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]243<?cs set:count = #1 ?>
244 <tr>
245 <td><nobr><em>Attribute Name</em></nobr></td>
246 <td><nobr><em>Related Method</em></nobr></td>
247 <td><nobr><em>Description</em></nobr></td>
248 </tr>
249 <?cs each:attr=attrs ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]250 <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:attr.since ?>" >
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]251 <td class="jd-linkcol"><?cs if:included ?><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs /if ?><?cs var:attr.name ?><?cs if:included ?></a><?cs /if ?></td>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]252 <td class="jd-linkcol"><?cs each:m=attr.methods ?>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]253 <?cs call:cond_link(m.name, toroot, m.href, included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]254 <?cs /each ?>
255 </td>
256 <td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?>&nbsp;</td>
257 </tr>
258 <?cs set:count = count + #1 ?>
259 <?cs /each ?>
260<?cs /def ?>
261
262<?cs def:write_inners_summary(classes) ?>
263<?cs set:count = #1 ?>
264 <?cs each:cl=class.inners ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]265 <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]266 <td class="jd-typecol"><nobr>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]267 <?cs var:cl.scope ?>
268 <?cs var:cl.static ?>
269 <?cs var:cl.final ?>
270 <?cs var:cl.abstract ?>
271 <?cs var:cl.kind ?></nobr></td>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]272 <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
273 <td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?>&nbsp;</td>
274 </tr>
275 <?cs set:count = count + #1 ?>
276 <?cs /each ?>
277<?cs /def ?>
278
279<?cs # end macros ?>
280
281<div class="jd-descr">
282<h2>Summary</h2>
283
284<?cs if:subcount(class.inners) ?>
285<?cs # this next line must be exactly like this to be parsed by eclipse ?>
286<!-- ======== NESTED CLASS SUMMARY ======== -->
287<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr>
288<?cs call:write_inners_summary(class.inners) ?>
289<?cs /if ?>
290
291<?cs # this next line must be exactly like this to be parsed by eclipse ?>
292<?cs if:subcount(class.attrs) ?>
293<!-- =========== FIELD SUMMARY =========== -->
294<table id="lattrs" class="jd-sumtable"><tr><th colspan="12">XML Attributes</th></tr>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]295<?cs call:write_attr_summary(class.attrs, 1) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]296<?cs /if ?>
297
298<?cs # if there are inherited attrs, write the table ?>
299<?cs if:inhattrs ?>
300<?cs # this next line must be exactly like this to be parsed by eclipse ?>
301<!-- =========== FIELD SUMMARY =========== -->
302<table id="inhattrs" class="jd-sumtable"><tr><th>
303 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
304 <div style="clear:left;">Inherited XML Attributes</div></th></tr>
305<?cs each:cl=class.inherited ?>
306<?cs if:subcount(cl.attrs) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]307<tr class="api apilevel-<?cs var:cl.since ?>" >
308<td colspan="12">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]309<?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]310<?cs call:cond_link(cl.qualified, toroot, cl.link, cl.included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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">
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]317 <?cs call:write_attr_summary(cl.attrs, cl.included) ?></table>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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 ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]332 <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]333 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]334 <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, cl.included) ?>&nbsp;</td>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]345<?cs call:write_constant_summary(class.constants, 1) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]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) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]358<tr class="api apilevel-<?cs var:cl.since ?>" >
359<td colspan="12">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]360<?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]361<?cs call:cond_link(cl.qualified, toroot, cl.link, cl.included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]362<div id="inherited-constants-<?cs var:cl.qualified ?>">
363 <div id="inherited-constants-<?cs var:cl.qualified ?>-list"
364 class="jd-inheritedlinks">
365 </div>
366 <div id="inherited-constants-<?cs var:cl.qualified ?>-summary" style="display: none;">
367 <table class="jd-sumtable-expando">
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]368 <?cs call:write_constant_summary(cl.constants, cl.included) ?></table>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]369 </div>
370</div>
371</td></tr>
372<?cs /if ?>
373<?cs /each ?>
374</table>
375<?cs /if ?>
376
377<?cs if:subcount(class.fields) ?>
378<?cs # this next line must be exactly like this to be parsed by eclipse ?>
379<!-- =========== FIELD SUMMARY =========== -->
380<table id="lfields" class="jd-sumtable"><tr><th colspan="12">Fields</th></tr>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]381<?cs call:write_field_summary(class.fields, 1) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]382</table>
383<?cs /if ?>
384
385<?cs # if there are inherited fields, write the table ?>
386<?cs if:inhfields ?>
387<?cs # this next line must be exactly like this to be parsed by eclipse ?>
388<!-- =========== FIELD SUMMARY =========== -->
389<table id="inhfields" class="jd-sumtable"><tr><th>
390 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
391 <div style="clear:left;">Inherited Fields</div></th></tr>
392<?cs each:cl=class.inherited ?>
393<?cs if:subcount(cl.fields) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]394<tr class="api apilevel-<?cs var:cl.since ?>" >
395<td colspan="12">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]396<?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]397<?cs call:cond_link(cl.qualified, toroot, cl.link, cl.included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]398<div id="inherited-fields-<?cs var:cl.qualified ?>">
399 <div id="inherited-fields-<?cs var:cl.qualified ?>-list"
400 class="jd-inheritedlinks">
401 </div>
402 <div id="inherited-fields-<?cs var:cl.qualified ?>-summary" style="display: none;">
403 <table class="jd-sumtable-expando">
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]404 <?cs call:write_field_summary(cl.fields, cl.included) ?></table>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]405 </div>
406</div>
407</td></tr>
408<?cs /if ?>
409<?cs /each ?>
410</table>
411<?cs /if ?>
412
413<?cs if:subcount(class.ctors.public) ?>
414<?cs # this next line must be exactly like this to be parsed by eclipse ?>
415<!-- ======== CONSTRUCTOR SUMMARY ======== -->
416<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]417<?cs call:write_method_summary(class.ctors.public, 1) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]418</table>
419<?cs /if ?>
420
421<?cs if:subcount(class.ctors.protected) ?>
422<?cs # this next line must be exactly like this to be parsed by eclipse ?>
423<!-- ======== CONSTRUCTOR SUMMARY ======== -->
424<table id="proctors" class="jd-sumtable"><tr><th colspan="12">Protected Constructors</th></tr>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]425<?cs call:write_method_summary(class.ctors.protected, 1) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]426</table>
427<?cs /if ?>
428
429<?cs if:subcount(class.methods.public) ?>
430<?cs # this next line must be exactly like this to be parsed by eclipse ?>
431<!-- ========== METHOD SUMMARY =========== -->
432<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]433<?cs call:write_method_summary(class.methods.public, 1) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]434</table>
435<?cs /if ?>
436
437<?cs if:subcount(class.methods.protected) ?>
438<?cs # this next line must be exactly like this to be parsed by eclipse ?>
439<!-- ========== METHOD SUMMARY =========== -->
440<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]441<?cs call:write_method_summary(class.methods.protected, 1) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]442</table>
443<?cs /if ?>
444
445<?cs # if there are inherited methods, write the table ?>
446<?cs if:inhmethods ?>
447<?cs # this next line must be exactly like this to be parsed by eclipse ?>
448<!-- ========== METHOD SUMMARY =========== -->
449<table id="inhmethods" class="jd-sumtable"><tr><th>
450 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
451 <div style="clear:left;">Inherited Methods</div></th></tr>
452<?cs each:cl=class.inherited ?>
453<?cs if:subcount(cl.methods) ?>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]454<tr class="api apilevel-<?cs var:cl.since ?>" >
455<td colspan="12"><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]456From <?cs var:cl.kind ?> <?cs call:cond_link(cl.qualified, toroot, cl.link, cl.included) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]457<div id="inherited-methods-<?cs var:cl.qualified ?>">
458 <div id="inherited-methods-<?cs var:cl.qualified ?>-list"
459 class="jd-inheritedlinks">
460 </div>
461 <div id="inherited-methods-<?cs var:cl.qualified ?>-summary" style="display: none;">
462 <table class="jd-sumtable-expando">
Xavier Ducrohet63ec8e32009-09-11 10:59:31 -0700[diff] [blame^]463 <?cs call:write_method_summary(cl.methods, cl.included) ?></table>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]464 </div>
465</div>
466</td></tr>
467<?cs /if ?>
468<?cs /each ?>
469</table>
470<?cs /if ?>
471
472</div><!-- jd-descr (summary) -->
473
474<!-- Details -->
475
476<?cs def:write_field_details(fields) ?>
477<?cs each:field=fields ?>
478<?cs # this next line must be exactly like this to be parsed by eclipse ?>
479<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
480<A NAME="<?cs var:field.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]481<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
482<div class="jd-details api apilevel-<?cs var:field.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]483 <h4 class="jd-details-title">
484 <span class="normal">
485 <?cs var:field.scope ?>
486 <?cs var:field.static ?>
487 <?cs var:field.final ?>
488 <?cs call:type_link(field.type) ?>
489 </span>
490 <?cs var:field.name ?>
491 </h4>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]492 <div class="api-level">
493 <?cs call:since_tags(field) ?>
494 </div>
495 <div class="jd-details-descr">
496 <?cs call:description(field) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]497 <?cs if:subcount(field.constantValue) ?>
498 <div class="jd-tagdata">
499 <span class="jd-tagtitle">Constant Value: </span>
500 <span>
501 <?cs if:field.constantValue.isString ?>
502 <?cs var:field.constantValue.str ?>
503 <?cs else ?>
504 <?cs var:field.constantValue.dec ?>
505 (<?cs var:field.constantValue.hex ?>)
506 <?cs /if ?>
507 </span>
508 </div>
509 <?cs /if ?>
510 </div>
511</div>
512<?cs /each ?>
513<?cs /def ?>
514
515<?cs def:write_method_details(methods) ?>
516<?cs each:method=methods ?>
517<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
518<A NAME="<?cs var:method.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]519<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
520<div class="jd-details api apilevel-<?cs var:method.since ?>">
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]521 <h4 class="jd-details-title">
522 <span class="normal">
523 <?cs var:method.scope ?>
524 <?cs var:method.static ?>
525 <?cs var:method.final ?>
526 <?cs var:method.abstract ?>
527 <?cs var:method.synchronized ?>
528 <?cs call:type_link(method.returnType) ?>
529 </span>
530 <span class="sympad"><?cs var:method.name ?></span>
531 <span class="normal">(<?cs call:parameter_list(method.params) ?>)</span>
532 </h4>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]533 <div class="api-level">
534 <?cs call:since_tags(method) ?>
535 </div>
536 <div class="jd-details-descr">
537 <?cs call:description(method) ?>
538 </div>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]539</div>
540<?cs /each ?>
541<?cs /def ?>
542
543<?cs def:write_attr_details(attrs) ?>
544<?cs each:attr=attrs ?>
545<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
546<A NAME="<?cs var:attr.anchor ?>"></A>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]547<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
548<div class="jd-details api apilevel-<?cs var:attr.since ?>">
549 <h4 class="jd-details-title"><?cs var:attr.name ?>
Scott Maindf094242009-07-27 09:47:11 -0700[diff] [blame]550 </h4>
Scott Main25fda192009-08-04 11:26:30 -0700[diff] [blame]551 <div class="api-level">
552 <?cs call:since_tags(attr) ?>
553 </div>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]554 <div class="jd-details-descr">
555 <?cs call:description(attr) ?>
556
557 <div class="jd-tagdata">
558 <h5 class="jd-tagtitle">Related Methods</h5>
559 <ul class="nolist">
560 <?cs each:m=attr.methods ?>
561 <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
562 <?cs /each ?>
563 </ul>
564 </div>
565 </div>
566</div>
567<?cs /each ?>
568<?cs /def ?>
569
570
571<!-- XML Attributes -->
572<?cs if:subcount(class.attrs) ?>
573<?cs # this next line must be exactly like this to be parsed by eclipse ?>
574<!-- ========= FIELD DETAIL ======== -->
575<h2>XML Attributes</h2>
576<?cs call:write_attr_details(class.attrs) ?>
577<?cs /if ?>
578
579<!-- Enum Values -->
580<?cs if:subcount(class.enumConstants) ?>
581<?cs # this next line must be exactly like this to be parsed by eclipse ?>
582<!-- ========= ENUM CONSTANTS DETAIL ======== -->
583<h2>Enum Values</h2>
584<?cs call:write_field_details(class.enumConstants) ?>
585<?cs /if ?>
586
587<!-- Constants -->
588<?cs if:subcount(class.constants) ?>
589<?cs # this next line must be exactly like this to be parsed by eclipse ?>
590<!-- ========= ENUM CONSTANTS DETAIL ======== -->
591<h2>Constants</h2>
592<?cs call:write_field_details(class.constants) ?>
593<?cs /if ?>
594
595<!-- Fields -->
596<?cs if:subcount(class.fields) ?>
597<?cs # this next line must be exactly like this to be parsed by eclipse ?>
598<!-- ========= FIELD DETAIL ======== -->
599<h2>Fields</h2>
600<?cs call:write_field_details(class.fields) ?>
601<?cs /if ?>
602
603<!-- Public ctors -->
604<?cs if:subcount(class.ctors.public) ?>
605<?cs # this next line must be exactly like this to be parsed by eclipse ?>
606<!-- ========= CONSTRUCTOR DETAIL ======== -->
607<h2>Public Constructors</h2>
608<?cs call:write_method_details(class.ctors.public) ?>
609<?cs /if ?>
610
611<?cs # this next line must be exactly like this to be parsed by eclipse ?>
612<!-- ========= CONSTRUCTOR DETAIL ======== -->
613<!-- Protected ctors -->
614<?cs if:subcount(class.ctors.protected) ?>
615<h2>Protected Constructors</h2>
616<?cs call:write_method_details(class.ctors.protected) ?>
617<?cs /if ?>
618
619<?cs # this next line must be exactly like this to be parsed by eclipse ?>
620<!-- ========= METHOD DETAIL ======== -->
621<!-- Public methdos -->
622<?cs if:subcount(class.methods.public) ?>
623<h2>Public Methods</h2>
624<?cs call:write_method_details(class.methods.public) ?>
625<?cs /if ?>
626
627<?cs # this next line must be exactly like this to be parsed by eclipse ?>
628<!-- ========= METHOD DETAIL ======== -->
629<?cs if:subcount(class.methods.protected) ?>
630<h2>Protected Methods</h2>
631<?cs call:write_method_details(class.methods.protected) ?>
632<?cs /if ?>
633
634<?cs # the next two lines must be exactly like this to be parsed by eclipse ?>
635<!-- ========= END OF CLASS DATA ========= -->
636<A NAME="navbar_top"></A>
637
638<?cs include:"footer.cs" ?>
639</div> <!-- jd-content -->
640
641</div><!-- end doc-content -->
642
643<?cs include:"trailer.cs" ?>
644
645</body>
646</html>