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