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