blob: 0fccd379e8bf539d356e101987075bf42401603e [file] [log] [blame]
The Android Open Source Project475fa122009-02-10 15:43:57 -08001<?cs include:"doctype.cs" ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -07002<?cs include:"macros.cs" ?>
3<html>
4<?cs include:"head_tag.cs" ?>
5<body>
6<script type="text/javascript">
The Android Open Source Project475fa122009-02-10 15:43:57 -08007function toggleInherited(linkObj, expand) {
8 var base = linkObj.getAttribute("id");
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -07009 var list = document.getElementById(base + "-list");
10 var summary = document.getElementById(base + "-summary");
11 var trigger = document.getElementById(base + "-trigger");
The Android Open Source Project475fa122009-02-10 15:43:57 -080012 var a = $(linkObj);
13 if ( (expand == null && a.hasClass("closed")) || expand ) {
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -070014 list.style.display = "none";
15 summary.style.display = "block";
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -080016 trigger.src = "<?cs var:toroot ?>assets/images/triangle-opened.png";
The Android Open Source Project475fa122009-02-10 15:43:57 -080017 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");
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -070025 }
The Android Open Source Project475fa122009-02-10 15:43:57 -080026 return false;
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -070027}
28</script>
The Android Open Source Projectdcc08f02008-12-17 18:03:49 -080029
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -070030<?cs include:"header.cs" ?>
31
32<div class="g-unit" id="doc-content">
33
The Android Open Source Projected187412009-01-20 14:03:55 -080034<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 ?>
105</nobr>
106<?cs if:inhattrs || inhconstants || inhfields || inhmethods || subcount(class.subclasses.direct) || subcount(class.subclasses.indirect) ?>
The Android Open Source Project475fa122009-02-10 15:43:57 -0800107&#124; <a href="#" onclick="return toggleAllSummaryInherited(this)">[Expand All]</a>
The Android Open Source Projected187412009-01-20 14:03:55 -0800108<?cs /if ?>
109</div>
110</div>
111
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700112<?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
137</div><!-- end header -->
138
139
140<div id="jd-content">
141<table class="jd-inheritance-table">
142<?cs set:colspan = subcount(class.inheritance) ?>
143<?cs each:supr = class.inheritance ?>
144 <tr>
145 <?cs loop:i = 1, (subcount(class.inheritance)-colspan), 1 ?>
146 <td class="jd-inheritance-space">&nbsp;<?cs if:(subcount(class.inheritance)-colspan) == i ?>&nbsp;&nbsp;&#x21b3;<?cs /if ?></td>
The Android Open Source Projected187412009-01-20 14:03:55 -0800147 <?cs /loop ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700148 <td colspan="<?cs var:colspan ?>" class="jd-inheritance-class-cell"><?cs
149 if:colspan == 1
150 ?><?cs call:class_name(class.qualifiedType) ?><?cs
151 else
152 ?><?cs call:type_link(supr.class) ?><?cs
153 /if ?></td>
154 </tr>
155 <?cs set:colspan = colspan-1 ?>
156<?cs /each ?>
157</table>
158
The Android Open Source Projected187412009-01-20 14:03:55 -0800159<?cs # this next line must be exactly like this to be parsed by eclipse ?>
160<!-- ======== NESTED CLASS SUMMARY ======== -->
161<?cs if:subcount(class.subclasses.direct) ?>
162<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;">
163<?cs call:expando_trigger("subclasses-direct", "closed") ?>Known Direct Subclasses
164<?cs call:expandable_class_list("subclasses-direct", class.subclasses.direct, "list") ?>
165</td></tr></table>
166<?cs /if ?>
167
168<?cs if:subcount(class.subclasses.indirect) ?>
169<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;">
170<?cs call:expando_trigger("subclasses-indirect", "closed") ?>Known Indirect Subclasses
171<?cs call:expandable_class_list("subclasses-indirect", class.subclasses.indirect, "list") ?>
172</td></tr></table>
173<?cs /if ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700174
175<div class="jd-descr">
176<?cs call:deprecated_warning(class) ?>
177<?cs if:subcount(class.descr) ?>
178<h2>Class Overview</h2>
179<p><?cs call:tag_list(class.descr) ?></p>
180<?cs /if ?>
181
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700182<?cs call:see_also_tags(class.seeAlso) ?>
183
184</div><!-- jd-descr -->
185
186
The Android Open Source Projected187412009-01-20 14:03:55 -0800187<?cs # summary macros ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700188
189<?cs def:write_method_summary(methods) ?>
190<?cs set:count = #1 ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700191<?cs each:method = methods ?>
192 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
193 <td class="jd-typecol"><nobr>
194 <?cs var:method.abstract ?>
195 <?cs var:method.synchronized ?>
196 <?cs var:method.final ?>
197 <?cs var:method.static ?>
198 <?cs call:type_link(method.generic) ?>
199 <?cs call:type_link(method.returnType) ?></nobr>
200 </td>
The Android Open Source Projected187412009-01-20 14:03:55 -0800201 <td class="jd-linkcol" width="100%"><nobr>
202 <span class="sympad"><a href="<?cs var:toroot ?><?cs var:method.href ?>">
203 <?cs var:method.name ?></a></span>(<?cs call:parameter_list(method.params) ?>)</nobr>
204 <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?>
205 <div class="jd-descrdiv"><?cs call:short_descr(method) ?></div>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700206 <?cs /if ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800207 </td></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700208<?cs set:count = count + #1 ?>
209<?cs /each ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700210<?cs /def ?>
211
212<?cs def:write_field_summary(fields) ?>
213<?cs set:count = #1 ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700214 <?cs each:field=fields ?>
215 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
The Android Open Source Projected187412009-01-20 14:03:55 -0800216 <td class="jd-typecol"><nobr>
217 <?cs var:field.scope ?>
218 <?cs var:field.static ?>
219 <?cs var:field.final ?>
220 <?cs call:type_link(field.type) ?></nobr></td>
221 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td>
222 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700223 </tr>
224 <?cs set:count = count + #1 ?>
225 <?cs /each ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700226<?cs /def ?>
227
228<?cs def:write_constant_summary(fields) ?>
229<?cs set:count = #1 ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700230 <?cs each:field=fields ?>
231 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
The Android Open Source Projected187412009-01-20 14:03:55 -0800232 <td class="jd-typecol"><?cs call:type_link(field.type) ?></td>
233 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td>
234 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700235 </tr>
236 <?cs set:count = count + #1 ?>
237 <?cs /each ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700238<?cs /def ?>
239
240<?cs def:write_attr_summary(attrs) ?>
241<?cs set:count = #1 ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700242 <tr>
The Android Open Source Projected187412009-01-20 14:03:55 -0800243 <td><nobr><em>Attribute Name</em></nobr></td>
244 <td><nobr><em>Related Method</em></nobr></td>
245 <td><nobr><em>Description</em></nobr></td>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700246 </tr>
247 <?cs each:attr=attrs ?>
248 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
249 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></td>
The Android Open Source Projected187412009-01-20 14:03:55 -0800250 <td class="jd-linkcol"><?cs each:m=attr.methods ?>
251 <a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a>
252 <?cs /each ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700253 </td>
254 <td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?>&nbsp;</td>
255 </tr>
256 <?cs set:count = count + #1 ?>
257 <?cs /each ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800258<?cs /def ?>
259
260<?cs def:write_inners_summary(classes) ?>
261<?cs set:count = #1 ?>
262 <?cs each:cl=class.inners ?>
263 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
264 <td class="jd-typecol"><nobr>
265 <?cs var:class.scope ?>
266 <?cs var:class.static ?>
267 <?cs var:class.final ?>
268 <?cs var:class.abstract ?>
269 <?cs var:class.kind ?></nobr></td>
270 <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
271 <td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?>&nbsp;</td>
272 </tr>
273 <?cs set:count = count + #1 ?>
274 <?cs /each ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700275<?cs /def ?>
276
277<?cs # end macros ?>
278
279<div class="jd-descr">
280<h2>Summary</h2>
281
The Android Open Source Projected187412009-01-20 14:03:55 -0800282<?cs if:subcount(class.inners) ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700283<?cs # this next line must be exactly like this to be parsed by eclipse ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800284<!-- ======== NESTED CLASS SUMMARY ======== -->
285<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr>
286<?cs call:write_inners_summary(class.inners) ?>
287<?cs /if ?>
288
289<?cs # this next line must be exactly like this to be parsed by eclipse ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700290<?cs if:subcount(class.attrs) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800291<!-- =========== FIELD SUMMARY =========== -->
292<table id="lattrs" class="jd-sumtable"><tr><th colspan="12">XML Attributes</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700293<?cs call:write_attr_summary(class.attrs) ?>
294<?cs /if ?>
295
The Android Open Source Projected187412009-01-20 14:03:55 -0800296<?cs # if there are inherited attrs, write the table ?>
297<?cs if:inhattrs ?>
298<table id="inhattrs" class="jd-sumtable"><tr><th>
The Android Open Source Project475fa122009-02-10 15:43:57 -0800299 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
The Android Open Source Projected187412009-01-20 14:03:55 -0800300 <div style="clear:left;">Inherited XML Attributes</div></th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700301<?cs each:cl=class.inherited ?>
302<?cs if:subcount(cl.attrs) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800303<tr><td colspan="12">
304<?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
305<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700306<div id="inherited-attrs-<?cs var:cl.qualified ?>">
307 <div id="inherited-attrs-<?cs var:cl.qualified ?>-list"
The Android Open Source Projected187412009-01-20 14:03:55 -0800308 class="jd-inheritedlinks">
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700309 </div>
The Android Open Source Projected187412009-01-20 14:03:55 -0800310 <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary" style="display: none;">
311 <table class="jd-sumtable-expando">
312 <?cs call:write_attr_summary(cl.attrs) ?></table>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700313 </div>
314</div>
The Android Open Source Projected187412009-01-20 14:03:55 -0800315</td></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700316<?cs /if ?>
317<?cs /each ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800318</table>
319<?cs /if ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700320
321<?cs if:subcount(class.enumConstants) ?>
322<?cs # this next line must be exactly like this to be parsed by eclipse ?>
323<!-- =========== ENUM CONSTANT SUMMARY =========== -->
The Android Open Source Projected187412009-01-20 14:03:55 -0800324<table id="enumconstants" class="jd-sumtable"><tr><th colspan="12">Enum Values</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700325<?cs set:count = #1 ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700326 <?cs each:field=class.enumConstants ?>
327 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
328 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
329 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
330 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
331 </tr>
332 <?cs set:count = count + #1 ?>
333 <?cs /each ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700334<?cs /if ?>
335
336<?cs if:subcount(class.constants) ?>
337<?cs # this next line must be exactly like this to be parsed by eclipse ?>
338<!-- =========== FIELD SUMMARY =========== -->
The Android Open Source Projected187412009-01-20 14:03:55 -0800339<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700340<?cs call:write_constant_summary(class.constants) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800341</table>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700342<?cs /if ?>
343
The Android Open Source Projected187412009-01-20 14:03:55 -0800344<?cs # if there are inherited constants, write the table ?>
345<?cs if:inhconstants ?>
346<table id="inhconstants" class="jd-sumtable"><tr><th>
The Android Open Source Project475fa122009-02-10 15:43:57 -0800347 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
The Android Open Source Projected187412009-01-20 14:03:55 -0800348 <div style="clear:left;">Inherited Constants</div></th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700349<?cs each:cl=class.inherited ?>
350<?cs if:subcount(cl.constants) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800351<tr><td colspan="12">
352<?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
353<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700354<div id="inherited-constants-<?cs var:cl.qualified ?>">
The Android Open Source Projected187412009-01-20 14:03:55 -0800355 <div id="inherited-constants-<?cs var:cl.qualified ?>-list"
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700356 class="jd-inheritedlinks">
The Android Open Source Projected187412009-01-20 14:03:55 -0800357 </div>
358 <div id="inherited-constants-<?cs var:cl.qualified ?>-summary" style="display: none;">
359 <table class="jd-sumtable-expando">
360 <?cs call:write_constant_summary(cl.constants) ?></table>
361 </div>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700362</div>
The Android Open Source Projected187412009-01-20 14:03:55 -0800363</td></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700364<?cs /if ?>
365<?cs /each ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800366</table>
367<?cs /if ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700368
369<?cs if:subcount(class.fields) ?>
370<?cs # this next line must be exactly like this to be parsed by eclipse ?>
371<!-- =========== FIELD SUMMARY =========== -->
The Android Open Source Projected187412009-01-20 14:03:55 -0800372<table id="lfields" class="jd-sumtable"><tr><th colspan="12">Fields</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700373<?cs call:write_field_summary(class.fields) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800374</table>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700375<?cs /if ?>
376
The Android Open Source Projected187412009-01-20 14:03:55 -0800377<?cs # if there are inherited fields, write the table ?>
378<?cs if:inhfields ?>
379<table id="inhfields" class="jd-sumtable"><tr><th>
The Android Open Source Project475fa122009-02-10 15:43:57 -0800380 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
The Android Open Source Projected187412009-01-20 14:03:55 -0800381 <div style="clear:left;">Inherited Fields</div></th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700382<?cs each:cl=class.inherited ?>
383<?cs if:subcount(cl.fields) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800384<tr><td colspan="12">
385<?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
386<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700387<div id="inherited-fields-<?cs var:cl.qualified ?>">
The Android Open Source Projected187412009-01-20 14:03:55 -0800388 <div id="inherited-fields-<?cs var:cl.qualified ?>-list"
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700389 class="jd-inheritedlinks">
The Android Open Source Projected187412009-01-20 14:03:55 -0800390 </div>
391 <div id="inherited-fields-<?cs var:cl.qualified ?>-summary" style="display: none;">
392 <table class="jd-sumtable-expando">
393 <?cs call:write_field_summary(cl.fields) ?></table>
394 </div>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700395</div>
The Android Open Source Projected187412009-01-20 14:03:55 -0800396</td></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700397<?cs /if ?>
398<?cs /each ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800399</table>
400<?cs /if ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700401
402<?cs if:subcount(class.ctors.public) ?>
403<?cs # this next line must be exactly like this to be parsed by eclipse ?>
404<!-- ======== CONSTRUCTOR SUMMARY ======== -->
The Android Open Source Projected187412009-01-20 14:03:55 -0800405<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700406<?cs call:write_method_summary(class.ctors.public) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800407</table>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700408<?cs /if ?>
409
410<?cs if:subcount(class.ctors.protected) ?>
411<?cs # this next line must be exactly like this to be parsed by eclipse ?>
412<!-- ======== CONSTRUCTOR SUMMARY ======== -->
The Android Open Source Projected187412009-01-20 14:03:55 -0800413<table id="proctors" class="jd-sumtable"><tr><th colspan="12">Protected Constructors</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700414<?cs call:write_method_summary(class.ctors.protected) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800415</table>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700416<?cs /if ?>
417
418<?cs if:subcount(class.methods.public) ?>
419<?cs # this next line must be exactly like this to be parsed by eclipse ?>
420<!-- ========== METHOD SUMMARY =========== -->
The Android Open Source Projected187412009-01-20 14:03:55 -0800421<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700422<?cs call:write_method_summary(class.methods.public) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800423</table>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700424<?cs /if ?>
425
426<?cs if:subcount(class.methods.protected) ?>
427<?cs # this next line must be exactly like this to be parsed by eclipse ?>
428<!-- ========== METHOD SUMMARY =========== -->
The Android Open Source Projected187412009-01-20 14:03:55 -0800429<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700430<?cs call:write_method_summary(class.methods.protected) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800431</table>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700432<?cs /if ?>
433
The Android Open Source Projected187412009-01-20 14:03:55 -0800434<?cs # if there are inherited methods, write the table ?>
435<?cs if:inhmethods ?>
436<table id="inhmethods" class="jd-sumtable"><tr><th>
The Android Open Source Project475fa122009-02-10 15:43:57 -0800437 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
The Android Open Source Projected187412009-01-20 14:03:55 -0800438 <div style="clear:left;">Inherited Methods</div></th></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700439<?cs each:cl=class.inherited ?>
440<?cs if:subcount(cl.methods) ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800441<tr><td colspan="12"><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>
442From <?cs var:cl.kind ?> <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700443<div id="inherited-methods-<?cs var:cl.qualified ?>">
The Android Open Source Projected187412009-01-20 14:03:55 -0800444 <div id="inherited-methods-<?cs var:cl.qualified ?>-list"
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700445 class="jd-inheritedlinks">
The Android Open Source Projected187412009-01-20 14:03:55 -0800446 </div>
447 <div id="inherited-methods-<?cs var:cl.qualified ?>-summary" style="display: none;">
448 <table class="jd-sumtable-expando">
449 <?cs call:write_method_summary(cl.methods) ?></table>
450 </div>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700451</div>
The Android Open Source Projected187412009-01-20 14:03:55 -0800452</td></tr>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700453<?cs /if ?>
454<?cs /each ?>
The Android Open Source Projected187412009-01-20 14:03:55 -0800455</table>
456<?cs /if ?>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700457
458</div><!-- jd-descr (summary) -->
459
460<!-- Details -->
461
462<?cs def:write_field_details(fields) ?>
463<?cs each:field=fields ?>
464<?cs # this next line must be exactly like this to be parsed by eclipse ?>
465<div class="jd-details" id="<?cs var:field.anchor ?>">
466 <h4 class="jd-details-title">
467 <span class="normal">
468 <?cs var:field.scope ?>
469 <?cs var:field.static ?>
470 <?cs var:field.final ?>
471 <?cs call:type_link(field.type) ?>
472 </span>
473 <?cs var:field.name ?>
474 </h4>
475 <div class="jd-details-descr"><?cs call:description(field) ?>
476 <?cs if:subcount(field.constantValue) ?>
477 <div class="jd-tagdata">
478 <span class="jd-tagtitle">Constant Value: </span>
479 <span>
480 <?cs if:field.constantValue.isString ?>
481 <?cs var:field.constantValue.str ?>
482 <?cs else ?>
483 <?cs var:field.constantValue.dec ?>
484 (<?cs var:field.constantValue.hex ?>)
485 <?cs /if ?>
486 </span>
487 </div>
488 <?cs /if ?>
489 </div>
490</div>
491<?cs /each ?>
492<?cs /def ?>
493
494<?cs def:write_method_details(methods) ?>
495<?cs each:method=methods ?>
496<?cs # this next line must be exactly like this to be parsed by eclipse ?>
497<div class="jd-details" id="<?cs var:method.anchor ?>">
498 <h4 class="jd-details-title">
499 <span class="normal">
500 <?cs var:method.scope ?>
501 <?cs var:method.static ?>
502 <?cs var:method.final ?>
503 <?cs var:method.abstract ?>
504 <?cs var:method.synchronized ?>
505 <?cs call:type_link(method.returnType) ?>
506 </span>
The Android Open Source Projected187412009-01-20 14:03:55 -0800507 <span class="sympad"><?cs var:method.name ?></span>
508 <span class="normal">(<?cs call:parameter_list(method.params) ?>)</span>
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700509 </h4>
510 <div class="jd-details-descr"><?cs call:description(method) ?></div>
511</div>
512<?cs /each ?>
513<?cs /def ?>
514
515<?cs def:write_attr_details(attrs) ?>
516<?cs each:attr=attrs ?>
517<?cs # this next line must be exactly like this to be parsed by eclipse ?>
518<div class="jd-details" id="<?cs var:attr.anchor ?>">
519 <h4 class="jd-details-title"><?cs var:attr.name ?></h4>
520 <div class="jd-details-descr">
521 <?cs call:description(attr) ?>
522
523 <div class="jd-tagdata">
524 <h5 class="jd-tagtitle">Related Methods</h5>
525 <ul class="nolist">
526 <?cs each:m=attr.methods ?>
527 <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
528 <?cs /each ?>
529 </ul>
530 </div>
531 </div>
532</div>
533<?cs /each ?>
534<?cs /def ?>
535
536
537<!-- XML Attributes -->
538<?cs if:subcount(class.attrs) ?>
539<h2>XML Attributes</h2>
540<?cs call:write_attr_details(class.attrs) ?>
541<?cs /if ?>
542
543<!-- Enum Values -->
544<?cs if:subcount(class.enumConstants) ?>
545<h2>Enum Values</h2>
546<?cs call:write_field_details(class.enumConstants) ?>
547<?cs /if ?>
548
549<!-- Constants -->
550<?cs if:subcount(class.constants) ?>
551<h2>Constants</h2>
552<?cs call:write_field_details(class.constants) ?>
553<?cs /if ?>
554
555<!-- Fields -->
556<?cs if:subcount(class.fields) ?>
557<h2>Fields</h2>
558<?cs call:write_field_details(class.fields) ?>
559<?cs /if ?>
560
561<!-- Public ctors -->
562<?cs if:subcount(class.ctors.public) ?>
563<h2>Public Constructors</h2>
564<?cs call:write_method_details(class.ctors.public) ?>
565<?cs /if ?>
566
567<?cs # this next line must be exactly like this to be parsed by eclipse ?>
568<!-- ========= CONSTRUCTOR DETAIL ======== -->
569<!-- Protected ctors -->
570<?cs if:subcount(class.ctors.protected) ?>
571<h2>Protected Constructors</h2>
572<?cs call:write_method_details(class.ctors.protected) ?>
573<?cs /if ?>
574
575<?cs # this next line must be exactly like this to be parsed by eclipse ?>
576<!-- ========= CONSTRUCTOR DETAIL ======== -->
577<!-- Public methdos -->
578<?cs if:subcount(class.methods.public) ?>
579<h2>Public Methods</h2>
580<?cs call:write_method_details(class.methods.public) ?>
581<?cs /if ?>
582
583<?cs # this next line must be exactly like this to be parsed by eclipse ?>
584<!-- ========= METHOD DETAIL ======== -->
585<?cs if:subcount(class.methods.protected) ?>
586<h2>Protected Methods</h2>
587<?cs call:write_method_details(class.methods.protected) ?>
588<?cs /if ?>
589
590<?cs # this next line must be exactly like this to be parsed by eclipse ?>
591<!-- ========= END OF CLASS DATA ========= -->
592
593<?cs include:"footer.cs" ?>
594</div> <!-- jd-content -->
595
596</div><!-- end doc-content -->
The Android Open Source Project475fa122009-02-10 15:43:57 -0800597
598<?cs include:"trailer.cs" ?>
599
The Android Open Source Projectb6c1cf62008-10-21 07:00:00 -0700600</body>
601</html>