class.cs revision 3d039178d7c9bb0a644b733f9efbefa6ad566fa6
1<?cs include:"doctype.cs" ?>
2<?cs include:"macros.cs" ?>
3<?cs include:"macros_override.cs" ?>
4<html<?cs if:devsite ?> devsite<?cs /if ?>>
5<?cs include:"head_tag.cs" ?>
6<body class="gc-documentation <?cs if:(reference.gms || reference.gcm) ?>google<?cs /if ?>
7  <?cs if:(guide||develop||training||reference||tools||sdk) ?>develop<?cs
8    if:reference ?> reference<?cs
9    /if ?><?cs
10  elif:design ?>design<?cs
11  elif:distribute ?>distribute<?cs
12  /if ?>" itemscope itemtype="http://schema.org/Article">
13  <div id="doc-api-level" class="<?cs var:class.since ?>" style="display:none"></div>
14  <a name="top"></a>
15<?cs include:"header.cs" ?>
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">
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 ?>
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 ?>
127<?cs call:show_annotations_list(class) ?>
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.final ?>
190            <?cs var:method.static ?>
191            <?cs call:type_link(method.generic) ?>
192            <?cs call:type_link(method.returnType) ?></nobr>
193        </td>
194        <td class="jd-linkcol" width="100%"><nobr>
195        <span class="sympad"><?cs call:cond_link(method.name, toroot, method.href, included) ?></span>(<?cs call:parameter_list(method.params) ?>)</nobr>
196        <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?>
197        <div class="jd-descrdiv">
198          <?cs call:short_descr(method) ?>
199          <?cs call:show_annotations_list(method) ?>
200        </div>
201  <?cs /if ?>
202  </td></tr>
203<?cs set:count = count + #1 ?>
204<?cs /each ?>
205<?cs /def ?>
206
207<?cs def:write_field_summary(fields, included) ?>
208<?cs set:count = #1 ?>
209    <?cs each:field=fields ?>
210      <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
211          <td class="jd-typecol"><nobr>
212          <?cs var:field.scope ?>
213          <?cs var:field.static ?>
214          <?cs var:field.final ?>
215          <?cs call:type_link(field.type) ?></nobr></td>
216          <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td>
217          <td class="jd-descrcol" width="100%">
218            <?cs call:short_descr(field) ?>
219            <?cs call:show_annotations_list(field) ?>
220          </td>
221      </tr>
222      <?cs set:count = count + #1 ?>
223    <?cs /each ?>
224<?cs /def ?>
225
226<?cs def:write_constant_summary(fields, included) ?>
227<?cs set:count = #1 ?>
228    <?cs each:field=fields ?>
229    <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
230        <td class="jd-typecol"><?cs call:type_link(field.type) ?></td>
231        <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, included) ?></td>
232        <td class="jd-descrcol" width="100%">
233          <?cs call:short_descr(field) ?>
234          <?cs call:show_annotations_list(field) ?>
235        </td>
236    </tr>
237    <?cs set:count = count + #1 ?>
238    <?cs /each ?>
239<?cs /def ?>
240
241<?cs def:write_attr_summary(attrs, included) ?>
242<?cs set:count = #1 ?>
243    <tr>
244        <td><nobr><em>Attribute Name</em></nobr></td>
245        <td><nobr><em>Related Method</em></nobr></td>
246        <td><nobr><em>Description</em></nobr></td>
247    </tr>
248    <?cs each:attr=attrs ?>
249    <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:attr.since ?>" >
250        <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>
251        <td class="jd-linkcol"><?cs each:m=attr.methods ?>
252            <?cs call:cond_link(m.name, toroot, m.href, included) ?>
253            <?cs /each ?>
254        </td>
255        <td class="jd-descrcol" width="100%">
256          <?cs call:short_descr(attr) ?>&nbsp;
257          <?cs call:show_annotations_list(attr) ?>
258        </td>
259    </tr>
260    <?cs set:count = count + #1 ?>
261    <?cs /each ?>
262<?cs /def ?>
263
264<?cs def:write_inners_summary(classes) ?>
265<?cs set:count = #1 ?>
266  <?cs each:cl=class.inners ?>
267    <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:cl.since ?>" >
268      <td class="jd-typecol"><nobr>
269        <?cs var:cl.scope ?>
270        <?cs var:cl.static ?>
271        <?cs var:cl.final ?>
272        <?cs var:cl.abstract ?>
273        <?cs var:cl.kind ?></nobr></td>
274      <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
275      <td class="jd-descrcol" width="100%">
276        <?cs call:short_descr(cl) ?>&nbsp;
277        <?cs call:show_annotations_list(cl) ?>
278      </td>
279    </tr>
280    <?cs set:count = count + #1 ?>
281    <?cs /each ?>
282<?cs /def ?>
283
284<?cs # end macros ?>
285
286<div class="jd-descr">
287<?cs # make sure there's a summary view to display ?>
288<?cs if:subcount(class.inners)
289     || subcount(class.attrs)
290     || inhattrs
291     || subcount(class.enumConstants)
292     || subcount(class.constants)
293     || inhconstants
294     || subcount(class.fields)
295     || inhfields
296     || subcount(class.ctors.public)
297     || subcount(class.ctors.protected)
298     || subcount(class.methods.public)
299     || subcount(class.methods.protected)
300     || inhmethods ?>
301<h2>Summary</h2>
302
303<?cs if:subcount(class.inners) ?>
304<?cs # this next line must be exactly like this to be parsed by eclipse ?>
305<!-- ======== NESTED CLASS SUMMARY ======== -->
306<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr>
307<?cs call:write_inners_summary(class.inners) ?>
308<?cs /if ?>
309
310<?cs # this next line must be exactly like this to be parsed by eclipse ?>
311<?cs if:subcount(class.attrs) ?>
312<!-- =========== FIELD SUMMARY =========== -->
313<table id="lattrs" class="jd-sumtable"><tr><th colspan="12">XML Attributes</th></tr>
314<?cs call:write_attr_summary(class.attrs, 1) ?>
315<?cs /if ?>
316
317<?cs # if there are inherited attrs, write the table ?>
318<?cs if:inhattrs ?>
319<?cs # this next line must be exactly like this to be parsed by eclipse ?>
320<!-- =========== FIELD SUMMARY =========== -->
321<table id="inhattrs" class="jd-sumtable"><tr><th>
322  <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
323  <div style="clear:left;">Inherited XML Attributes</div></th></tr>
324<?cs each:cl=class.inherited ?>
325<?cs if:subcount(cl.attrs) ?>
326<tr class="api apilevel-<?cs var:cl.since ?>" >
327<td colspan="12">
328<?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
329<?cs call:cond_link(cl.qualified, toroot, cl.link, cl.included) ?>
330<div id="inherited-attrs-<?cs var:cl.qualified ?>">
331  <div id="inherited-attrs-<?cs var:cl.qualified ?>-list"
332        class="jd-inheritedlinks">
333  </div>
334  <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary" style="display: none;">
335    <table class="jd-sumtable-expando">
336    <?cs call:write_attr_summary(cl.attrs, cl.included) ?></table>
337  </div>
338</div>
339</td></tr>
340<?cs /if ?>
341<?cs /each ?>
342</table>
343<?cs /if ?>
344
345<?cs if:subcount(class.enumConstants) ?>
346<?cs # this next line must be exactly like this to be parsed by eclipse ?>
347<!-- =========== ENUM CONSTANT SUMMARY =========== -->
348<table id="enumconstants" class="jd-sumtable"><tr><th colspan="12">Enum Values</th></tr>
349<?cs set:count = #1 ?>
350    <?cs each:field=class.enumConstants ?>
351    <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:field.since ?>" >
352        <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
353        <td class="jd-linkcol"><?cs call:cond_link(field.name, toroot, field.href, cl.included) ?>&nbsp;</td>
354        <td class="jd-descrcol" width="100%">
355          <?cs call:short_descr(field) ?>&nbsp;
356          <?cs call:show_annotations_list(field) ?>
357        </td>
358    </tr>
359    <?cs set:count = count + #1 ?>
360    <?cs /each ?>
361<?cs /if ?>
362
363<?cs if:subcount(class.constants) ?>
364<?cs # this next line must be exactly like this to be parsed by eclipse ?>
365<!-- =========== ENUM CONSTANT SUMMARY =========== -->
366<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
367<?cs call:write_constant_summary(class.constants, 1) ?>
368</table>
369<?cs /if ?>
370
371<?cs # if there are inherited constants, write the table ?>
372<?cs if:inhconstants ?>
373<?cs # this next line must be exactly like this to be parsed by eclipse ?>
374<!-- =========== ENUM CONSTANT SUMMARY =========== -->
375<table id="inhconstants" class="jd-sumtable"><tr><th>
376  <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
377  <div style="clear:left;">Inherited Constants</div></th></tr>
378<?cs each:cl=class.inherited ?>
379<?cs if:subcount(cl.constants) ?>
380<tr class="api apilevel-<?cs var:cl.since ?>" >
381<td colspan="12">
382<?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
383<?cs call:cond_link(cl.qualified, toroot, cl.link, cl.included) ?>
384<div id="inherited-constants-<?cs var:cl.qualified ?>">
385  <div id="inherited-constants-<?cs var:cl.qualified ?>-list"
386        class="jd-inheritedlinks">
387  </div>
388  <div id="inherited-constants-<?cs var:cl.qualified ?>-summary" style="display: none;">
389    <table class="jd-sumtable-expando">
390    <?cs call:write_constant_summary(cl.constants, cl.included) ?></table>
391  </div>
392</div>
393</td></tr>
394<?cs /if ?>
395<?cs /each ?>
396</table>
397<?cs /if ?>
398
399<?cs if:subcount(class.fields) ?>
400<?cs # this next line must be exactly like this to be parsed by eclipse ?>
401<!-- =========== FIELD SUMMARY =========== -->
402<table id="lfields" class="jd-sumtable"><tr><th colspan="12">Fields</th></tr>
403<?cs call:write_field_summary(class.fields, 1) ?>
404</table>
405<?cs /if ?>
406
407<?cs # if there are inherited fields, write the table ?>
408<?cs if:inhfields ?>
409<?cs # this next line must be exactly like this to be parsed by eclipse ?>
410<!-- =========== FIELD SUMMARY =========== -->
411<table id="inhfields" class="jd-sumtable"><tr><th>
412  <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
413  <div style="clear:left;">Inherited Fields</div></th></tr>
414<?cs each:cl=class.inherited ?>
415<?cs if:subcount(cl.fields) ?>
416<tr class="api apilevel-<?cs var:cl.since ?>" >
417<td colspan="12">
418<?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
419<?cs call:cond_link(cl.qualified, toroot, cl.link, cl.included) ?>
420<div id="inherited-fields-<?cs var:cl.qualified ?>">
421  <div id="inherited-fields-<?cs var:cl.qualified ?>-list"
422        class="jd-inheritedlinks">
423  </div>
424  <div id="inherited-fields-<?cs var:cl.qualified ?>-summary" style="display: none;">
425    <table class="jd-sumtable-expando">
426    <?cs call:write_field_summary(cl.fields, cl.included) ?></table>
427  </div>
428</div>
429</td></tr>
430<?cs /if ?>
431<?cs /each ?>
432</table>
433<?cs /if ?>
434
435<?cs if:subcount(class.ctors.public) ?>
436<?cs # this next line must be exactly like this to be parsed by eclipse ?>
437<!-- ======== CONSTRUCTOR SUMMARY ======== -->
438<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
439<?cs call:write_method_summary(class.ctors.public, 1) ?>
440</table>
441<?cs /if ?>
442
443<?cs if:subcount(class.ctors.protected) ?>
444<?cs # this next line must be exactly like this to be parsed by eclipse ?>
445<!-- ======== CONSTRUCTOR SUMMARY ======== -->
446<table id="proctors" class="jd-sumtable"><tr><th colspan="12">Protected Constructors</th></tr>
447<?cs call:write_method_summary(class.ctors.protected, 1) ?>
448</table>
449<?cs /if ?>
450
451<?cs if:subcount(class.methods.public) ?>
452<?cs # this next line must be exactly like this to be parsed by eclipse ?>
453<!-- ========== METHOD SUMMARY =========== -->
454<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
455<?cs call:write_method_summary(class.methods.public, 1) ?>
456</table>
457<?cs /if ?>
458
459<?cs if:subcount(class.methods.protected) ?>
460<?cs # this next line must be exactly like this to be parsed by eclipse ?>
461<!-- ========== METHOD SUMMARY =========== -->
462<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr>
463<?cs call:write_method_summary(class.methods.protected, 1) ?>
464</table>
465<?cs /if ?>
466
467<?cs # if there are inherited methods, write the table ?>
468<?cs if:inhmethods ?>
469<?cs # this next line must be exactly like this to be parsed by eclipse ?>
470<!-- ========== METHOD SUMMARY =========== -->
471<table id="inhmethods" class="jd-sumtable"><tr><th>
472  <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
473  <div style="clear:left;">Inherited Methods</div></th></tr>
474<?cs each:cl=class.inherited ?>
475<?cs if:subcount(cl.methods) ?>
476<tr class="api apilevel-<?cs var:cl.since ?>" >
477<td colspan="12"><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>
478From <?cs var:cl.kind ?>
479<?cs if:cl.included ?>
480  <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
481<?cs elif:cl.federated ?>
482  <a href="<?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
483<?cs else ?>
484  <?cs var:cl.qualified ?>
485<?cs /if ?>
486<div id="inherited-methods-<?cs var:cl.qualified ?>">
487  <div id="inherited-methods-<?cs var:cl.qualified ?>-list"
488        class="jd-inheritedlinks">
489  </div>
490  <div id="inherited-methods-<?cs var:cl.qualified ?>-summary" style="display: none;">
491    <table class="jd-sumtable-expando">
492    <?cs call:write_method_summary(cl.methods, cl.included) ?></table>
493  </div>
494</div>
495</td></tr>
496<?cs /if ?>
497<?cs /each ?>
498</table>
499<?cs /if ?>
500<?cs /if ?>
501</div><!-- jd-descr (summary) -->
502
503<!-- Details -->
504
505<?cs def:write_field_details(fields) ?>
506<?cs each:field=fields ?>
507<?cs # this next line must be exactly like this to be parsed by eclipse ?>
508<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
509<A NAME="<?cs var:field.anchor ?>"></A>
510<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
511<div class="jd-details api apilevel-<?cs var:field.since ?>">
512    <h4 class="jd-details-title">
513      <span class="normal">
514        <?cs var:field.scope ?>
515        <?cs var:field.static ?>
516        <?cs var:field.final ?>
517        <?cs call:type_link(field.type) ?>
518      </span>
519        <?cs var:field.name ?>
520    </h4>
521      <div class="api-level">
522        <?cs call:since_tags(field) ?>
523        <?cs call:federated_refs(field) ?>
524      </div>
525    <div class="jd-details-descr">
526      <?cs call:show_annotations_list(field) ?>
527      <?cs call:description(field) ?>
528    <?cs if:subcount(field.constantValue) ?>
529        <div class="jd-tagdata">
530        <span class="jd-tagtitle">Constant Value: </span>
531        <span>
532            <?cs if:field.constantValue.isString ?>
533                <?cs var:field.constantValue.str ?>
534            <?cs else ?>
535                <?cs var:field.constantValue.dec ?>
536                (<?cs var:field.constantValue.hex ?>)
537            <?cs /if ?>
538        </span>
539        </div>
540    <?cs /if ?>
541    </div>
542</div>
543<?cs /each ?>
544<?cs /def ?>
545
546<?cs def:write_method_details(methods) ?>
547<?cs each:method=methods ?>
548<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
549<A NAME="<?cs var:method.anchor ?>"></A>
550<?cs # The apilevel-N class MUST BE LAST in the sequence of class names ?>
551<div class="jd-details api apilevel-<?cs var:method.since ?>">
552    <h4 class="jd-details-title">
553      <span class="normal">
554        <?cs var:method.scope ?>
555        <?cs var:method.static ?>
556        <?cs var:method.final ?>
557        <?cs var:method.abstract ?>
558        <?cs call:type_link(method.returnType) ?>
559      </span>
560      <span class="sympad"><?cs var:method.name ?></span>
561      <span class="normal">(<?cs call:parameter_list(method.params) ?>)</span>
562    </h4>
563      <div class="api-level">
564        <div><?cs call:since_tags(method) ?></div>
565        <?cs call:federated_refs(method) ?>
566      </div>
567    <div class="jd-details-descr">
568      <?cs call:show_annotations_list(method) ?>
569      <?cs call:description(method) ?>
570    </div>
571</div>
572<?cs /each ?>
573<?cs /def ?>
574
575<?cs def:write_attr_details(attrs) ?>
576<?cs each:attr=attrs ?>
577<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
578<A NAME="<?cs var:attr.anchor ?>"></A>
579<div class="jd-details">
580    <h4 class="jd-details-title"><?cs var:attr.name ?>
581    </h4>
582    <div class="jd-details-descr">
583        <?cs call:show_annotations_list(attr) ?>
584        <?cs call:description(attr) ?>
585
586        <div class="jd-tagdata">
587            <h5 class="jd-tagtitle">Related Methods</h5>
588            <ul class="nolist">
589            <?cs each:m=attr.methods ?>
590                <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
591            <?cs /each ?>
592            </ul>
593        </div>
594    </div>
595</div>
596<?cs /each ?>
597<?cs /def ?>
598
599
600<!-- XML Attributes -->
601<?cs if:subcount(class.attrs) ?>
602<?cs # this next line must be exactly like this to be parsed by eclipse ?>
603<!-- ========= FIELD DETAIL ======== -->
604<h2>XML Attributes</h2>
605<?cs call:write_attr_details(class.attrs) ?>
606<?cs /if ?>
607
608<!-- Enum Values -->
609<?cs if:subcount(class.enumConstants) ?>
610<?cs # this next line must be exactly like this to be parsed by eclipse ?>
611<!-- ========= ENUM CONSTANTS DETAIL ======== -->
612<h2>Enum Values</h2>
613<?cs call:write_field_details(class.enumConstants) ?>
614<?cs /if ?>
615
616<!-- Constants -->
617<?cs if:subcount(class.constants) ?>
618<?cs # this next line must be exactly like this to be parsed by eclipse ?>
619<!-- ========= ENUM CONSTANTS DETAIL ======== -->
620<h2>Constants</h2>
621<?cs call:write_field_details(class.constants) ?>
622<?cs /if ?>
623
624<!-- Fields -->
625<?cs if:subcount(class.fields) ?>
626<?cs # this next line must be exactly like this to be parsed by eclipse ?>
627<!-- ========= FIELD DETAIL ======== -->
628<h2>Fields</h2>
629<?cs call:write_field_details(class.fields) ?>
630<?cs /if ?>
631
632<!-- Public ctors -->
633<?cs if:subcount(class.ctors.public) ?>
634<?cs # this next line must be exactly like this to be parsed by eclipse ?>
635<!-- ========= CONSTRUCTOR DETAIL ======== -->
636<h2>Public Constructors</h2>
637<?cs call:write_method_details(class.ctors.public) ?>
638<?cs /if ?>
639
640<?cs # this next line must be exactly like this to be parsed by eclipse ?>
641<!-- ========= CONSTRUCTOR DETAIL ======== -->
642<!-- Protected ctors -->
643<?cs if:subcount(class.ctors.protected) ?>
644<h2>Protected Constructors</h2>
645<?cs call:write_method_details(class.ctors.protected) ?>
646<?cs /if ?>
647
648<?cs # this next line must be exactly like this to be parsed by eclipse ?>
649<!-- ========= METHOD DETAIL ======== -->
650<!-- Public methdos -->
651<?cs if:subcount(class.methods.public) ?>
652<h2>Public Methods</h2>
653<?cs call:write_method_details(class.methods.public) ?>
654<?cs /if ?>
655
656<?cs # this next line must be exactly like this to be parsed by eclipse ?>
657<!-- ========= METHOD DETAIL ======== -->
658<?cs if:subcount(class.methods.protected) ?>
659<h2>Protected Methods</h2>
660<?cs call:write_method_details(class.methods.protected) ?>
661<?cs /if ?>
662
663<?cs # the next two lines must be exactly like this to be parsed by eclipse ?>
664<!-- ========= END OF CLASS DATA ========= -->
665<A NAME="navbar_top"></A>
666</div> <!-- jd-content -->
667
668<?cs include:"footer.cs" ?>
669
670<?cs include:"trailer.cs" ?>
671
672</body>
673</html>
674