Gitiles
Code Review Sign In
review.blissroms.org / platform_build_make / 233bc0b84aef261a67a364ff3a8e91077fd70fd6 / . / tools / droiddoc / templates / class.cs
blob: 41d34dde28e144b511aab9c0c27cbee15f513b87 [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" ?>
5<body>
6<script type="text/javascript">
7function toggleInherited(linkObj, expand) {
8 var base = linkObj.getAttribute("id");
9 var list = document.getElementById(base + "-list");
10 var summary = document.getElementById(base + "-summary");
11 var trigger = document.getElementById(base + "-trigger");
12 var a = $(linkObj);
13 if ( (expand == null && a.hasClass("closed")) || expand ) {
14 list.style.display = "none";
15 summary.style.display = "block";
16 trigger.src = "<?cs var:toroot ?>assets/images/triangle-opened.png";
17 a.removeClass("closed");
18 a.addClass("opened");
19 } else if ( (expand == null && a.hasClass("opened")) || (expand == false) ) {
20 list.style.display = "block";
21 summary.style.display = "none";
22 trigger.src = "<?cs var:toroot ?>assets/images/triangle-closed.png";
23 a.removeClass("opened");
24 a.addClass("closed");
25 }
26 return false;
27}
28</script>
29
30<?cs include:"header.cs" ?>
31
32<div class="g-unit" id="doc-content">
33
34<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) ?>
107&#124; <a href="#" onclick="return toggleAllSummaryInherited(this)">[Expand All]</a>
108<?cs /if ?>
109</div>
110</div>
111
112<?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>
147 <?cs /loop ?>
148 <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
159<?cs # this next line must be exactly like this to be parsed by eclipse ?>
160
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 ?>
174
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
182<?cs call:see_also_tags(class.seeAlso) ?>
Jesse Wilson289d80e2009-07-21 14:02:14 -0700[diff] [blame]183<?cs call:since_tags(class) ?>
The Android Open Source Project88b60792009-03-03 19:28:42 -0800[diff] [blame]184
185</div><!-- jd-descr -->
186
187
188<?cs # summary macros ?>
189
190<?cs def:write_method_summary(methods) ?>
191<?cs set:count = #1 ?>
192<?cs each:method = methods ?>
193 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
194 <td class="jd-typecol"><nobr>
195 <?cs var:method.abstract ?>
196 <?cs var:method.synchronized ?>
197 <?cs var:method.final ?>
198 <?cs var:method.static ?>
199 <?cs call:type_link(method.generic) ?>
200 <?cs call:type_link(method.returnType) ?></nobr>
201 </td>
202 <td class="jd-linkcol" width="100%"><nobr>
203 <span class="sympad"><a href="<?cs var:toroot ?><?cs var:method.href ?>">
204 <?cs var:method.name ?></a></span>(<?cs call:parameter_list(method.params) ?>)</nobr>
205 <?cs if:subcount(method.shortDescr) || subcount(method.deprecated) ?>
206 <div class="jd-descrdiv"><?cs call:short_descr(method) ?></div>
207 <?cs /if ?>
208 </td></tr>
209<?cs set:count = count + #1 ?>
210<?cs /each ?>
211<?cs /def ?>
212
213<?cs def:write_field_summary(fields) ?>
214<?cs set:count = #1 ?>
215 <?cs each:field=fields ?>
216 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
217 <td class="jd-typecol"><nobr>
218 <?cs var:field.scope ?>
219 <?cs var:field.static ?>
220 <?cs var:field.final ?>
221 <?cs call:type_link(field.type) ?></nobr></td>
222 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td>
223 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
224 </tr>
225 <?cs set:count = count + #1 ?>
226 <?cs /each ?>
227<?cs /def ?>
228
229<?cs def:write_constant_summary(fields) ?>
230<?cs set:count = #1 ?>
231 <?cs each:field=fields ?>
232 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
233 <td class="jd-typecol"><?cs call:type_link(field.type) ?></td>
234 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a></td>
235 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?></td>
236 </tr>
237 <?cs set:count = count + #1 ?>
238 <?cs /each ?>
239<?cs /def ?>
240
241<?cs def:write_attr_summary(attrs) ?>
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 <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
250 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></td>
251 <td class="jd-linkcol"><?cs each:m=attr.methods ?>
252 <a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a>
253 <?cs /each ?>
254 </td>
255 <td class="jd-descrcol" width="100%"><?cs call:short_descr(attr) ?>&nbsp;</td>
256 </tr>
257 <?cs set:count = count + #1 ?>
258 <?cs /each ?>
259<?cs /def ?>
260
261<?cs def:write_inners_summary(classes) ?>
262<?cs set:count = #1 ?>
263 <?cs each:cl=class.inners ?>
264 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
265 <td class="jd-typecol"><nobr>
266 <?cs var:class.scope ?>
267 <?cs var:class.static ?>
268 <?cs var:class.final ?>
269 <?cs var:class.abstract ?>
270 <?cs var:class.kind ?></nobr></td>
271 <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
272 <td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?>&nbsp;</td>
273 </tr>
274 <?cs set:count = count + #1 ?>
275 <?cs /each ?>
276<?cs /def ?>
277
278<?cs # end macros ?>
279
280<div class="jd-descr">
281<h2>Summary</h2>
282
283<?cs if:subcount(class.inners) ?>
284<?cs # this next line must be exactly like this to be parsed by eclipse ?>
285<!-- ======== NESTED CLASS SUMMARY ======== -->
286<table id="nestedclasses" class="jd-sumtable"><tr><th colspan="12">Nested Classes</th></tr>
287<?cs call:write_inners_summary(class.inners) ?>
288<?cs /if ?>
289
290<?cs # this next line must be exactly like this to be parsed by eclipse ?>
291<?cs if:subcount(class.attrs) ?>
292<!-- =========== FIELD SUMMARY =========== -->
293<table id="lattrs" class="jd-sumtable"><tr><th colspan="12">XML Attributes</th></tr>
294<?cs call:write_attr_summary(class.attrs) ?>
295<?cs /if ?>
296
297<?cs # if there are inherited attrs, write the table ?>
298<?cs if:inhattrs ?>
299<?cs # this next line must be exactly like this to be parsed by eclipse ?>
300<!-- =========== FIELD SUMMARY =========== -->
301<table id="inhattrs" class="jd-sumtable"><tr><th>
302 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
303 <div style="clear:left;">Inherited XML Attributes</div></th></tr>
304<?cs each:cl=class.inherited ?>
305<?cs if:subcount(cl.attrs) ?>
306<tr><td colspan="12">
307<?cs call:expando_trigger("inherited-attrs-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
308<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
309<div id="inherited-attrs-<?cs var:cl.qualified ?>">
310 <div id="inherited-attrs-<?cs var:cl.qualified ?>-list"
311 class="jd-inheritedlinks">
312 </div>
313 <div id="inherited-attrs-<?cs var:cl.qualified ?>-summary" style="display: none;">
314 <table class="jd-sumtable-expando">
315 <?cs call:write_attr_summary(cl.attrs) ?></table>
316 </div>
317</div>
318</td></tr>
319<?cs /if ?>
320<?cs /each ?>
321</table>
322<?cs /if ?>
323
324<?cs if:subcount(class.enumConstants) ?>
325<?cs # this next line must be exactly like this to be parsed by eclipse ?>
326<!-- =========== ENUM CONSTANT SUMMARY =========== -->
327<table id="enumconstants" class="jd-sumtable"><tr><th colspan="12">Enum Values</th></tr>
328<?cs set:count = #1 ?>
329 <?cs each:field=class.enumConstants ?>
330 <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> >
331 <td class="jd-descrcol"><?cs call:type_link(field.type) ?>&nbsp;</td>
332 <td class="jd-linkcol"><a href="<?cs var:toroot ?><?cs var:field.href ?>"><?cs var:field.name ?></a>&nbsp;</td>
333 <td class="jd-descrcol" width="100%"><?cs call:short_descr(field) ?>&nbsp;</td>
334 </tr>
335 <?cs set:count = count + #1 ?>
336 <?cs /each ?>
337<?cs /if ?>
338
339<?cs if:subcount(class.constants) ?>
340<?cs # this next line must be exactly like this to be parsed by eclipse ?>
341<!-- =========== ENUM CONSTANT SUMMARY =========== -->
342<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
343<?cs call:write_constant_summary(class.constants) ?>
344</table>
345<?cs /if ?>
346
347<?cs # if there are inherited constants, write the table ?>
348<?cs if:inhconstants ?>
349<?cs # this next line must be exactly like this to be parsed by eclipse ?>
350<!-- =========== ENUM CONSTANT SUMMARY =========== -->
351<table id="inhconstants" class="jd-sumtable"><tr><th>
352 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
353 <div style="clear:left;">Inherited Constants</div></th></tr>
354<?cs each:cl=class.inherited ?>
355<?cs if:subcount(cl.constants) ?>
356<tr><td colspan="12">
357<?cs call:expando_trigger("inherited-constants-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
358<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
359<div id="inherited-constants-<?cs var:cl.qualified ?>">
360 <div id="inherited-constants-<?cs var:cl.qualified ?>-list"
361 class="jd-inheritedlinks">
362 </div>
363 <div id="inherited-constants-<?cs var:cl.qualified ?>-summary" style="display: none;">
364 <table class="jd-sumtable-expando">
365 <?cs call:write_constant_summary(cl.constants) ?></table>
366 </div>
367</div>
368</td></tr>
369<?cs /if ?>
370<?cs /each ?>
371</table>
372<?cs /if ?>
373
374<?cs if:subcount(class.fields) ?>
375<?cs # this next line must be exactly like this to be parsed by eclipse ?>
376<!-- =========== FIELD SUMMARY =========== -->
377<table id="lfields" class="jd-sumtable"><tr><th colspan="12">Fields</th></tr>
378<?cs call:write_field_summary(class.fields) ?>
379</table>
380<?cs /if ?>
381
382<?cs # if there are inherited fields, write the table ?>
383<?cs if:inhfields ?>
384<?cs # this next line must be exactly like this to be parsed by eclipse ?>
385<!-- =========== FIELD SUMMARY =========== -->
386<table id="inhfields" class="jd-sumtable"><tr><th>
387 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
388 <div style="clear:left;">Inherited Fields</div></th></tr>
389<?cs each:cl=class.inherited ?>
390<?cs if:subcount(cl.fields) ?>
391<tr><td colspan="12">
392<?cs call:expando_trigger("inherited-fields-"+cl.qualified, "closed") ?>From <?cs var:cl.kind ?>
393<a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
394<div id="inherited-fields-<?cs var:cl.qualified ?>">
395 <div id="inherited-fields-<?cs var:cl.qualified ?>-list"
396 class="jd-inheritedlinks">
397 </div>
398 <div id="inherited-fields-<?cs var:cl.qualified ?>-summary" style="display: none;">
399 <table class="jd-sumtable-expando">
400 <?cs call:write_field_summary(cl.fields) ?></table>
401 </div>
402</div>
403</td></tr>
404<?cs /if ?>
405<?cs /each ?>
406</table>
407<?cs /if ?>
408
409<?cs if:subcount(class.ctors.public) ?>
410<?cs # this next line must be exactly like this to be parsed by eclipse ?>
411<!-- ======== CONSTRUCTOR SUMMARY ======== -->
412<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
413<?cs call:write_method_summary(class.ctors.public) ?>
414</table>
415<?cs /if ?>
416
417<?cs if:subcount(class.ctors.protected) ?>
418<?cs # this next line must be exactly like this to be parsed by eclipse ?>
419<!-- ======== CONSTRUCTOR SUMMARY ======== -->
420<table id="proctors" class="jd-sumtable"><tr><th colspan="12">Protected Constructors</th></tr>
421<?cs call:write_method_summary(class.ctors.protected) ?>
422</table>
423<?cs /if ?>
424
425<?cs if:subcount(class.methods.public) ?>
426<?cs # this next line must be exactly like this to be parsed by eclipse ?>
427<!-- ========== METHOD SUMMARY =========== -->
428<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
429<?cs call:write_method_summary(class.methods.public) ?>
430</table>
431<?cs /if ?>
432
433<?cs if:subcount(class.methods.protected) ?>
434<?cs # this next line must be exactly like this to be parsed by eclipse ?>
435<!-- ========== METHOD SUMMARY =========== -->
436<table id="promethods" class="jd-sumtable"><tr><th colspan="12">Protected Methods</th></tr>
437<?cs call:write_method_summary(class.methods.protected) ?>
438</table>
439<?cs /if ?>
440
441<?cs # if there are inherited methods, write the table ?>
442<?cs if:inhmethods ?>
443<?cs # this next line must be exactly like this to be parsed by eclipse ?>
444<!-- ========== METHOD SUMMARY =========== -->
445<table id="inhmethods" class="jd-sumtable"><tr><th>
446 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
447 <div style="clear:left;">Inherited Methods</div></th></tr>
448<?cs each:cl=class.inherited ?>
449<?cs if:subcount(cl.methods) ?>
450<tr><td colspan="12"><?cs call:expando_trigger("inherited-methods-"+cl.qualified, "closed") ?>
451From <?cs var:cl.kind ?> <a href="<?cs var:toroot ?><?cs var:cl.link ?>"><?cs var:cl.qualified ?></a>
452<div id="inherited-methods-<?cs var:cl.qualified ?>">
453 <div id="inherited-methods-<?cs var:cl.qualified ?>-list"
454 class="jd-inheritedlinks">
455 </div>
456 <div id="inherited-methods-<?cs var:cl.qualified ?>-summary" style="display: none;">
457 <table class="jd-sumtable-expando">
458 <?cs call:write_method_summary(cl.methods) ?></table>
459 </div>
460</div>
461</td></tr>
462<?cs /if ?>
463<?cs /each ?>
464</table>
465<?cs /if ?>
466
467</div><!-- jd-descr (summary) -->
468
469<!-- Details -->
470
471<?cs def:write_field_details(fields) ?>
472<?cs each:field=fields ?>
473<?cs # this next line must be exactly like this to be parsed by eclipse ?>
474<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
475<A NAME="<?cs var:field.anchor ?>"></A>
476<div class="jd-details">
477 <h4 class="jd-details-title">
478 <span class="normal">
479 <?cs var:field.scope ?>
480 <?cs var:field.static ?>
481 <?cs var:field.final ?>
482 <?cs call:type_link(field.type) ?>
483 </span>
484 <?cs var:field.name ?>
485 </h4>
486 <div class="jd-details-descr"><?cs call:description(field) ?>
487 <?cs if:subcount(field.constantValue) ?>
488 <div class="jd-tagdata">
489 <span class="jd-tagtitle">Constant Value: </span>
490 <span>
491 <?cs if:field.constantValue.isString ?>
492 <?cs var:field.constantValue.str ?>
493 <?cs else ?>
494 <?cs var:field.constantValue.dec ?>
495 (<?cs var:field.constantValue.hex ?>)
496 <?cs /if ?>
497 </span>
498 </div>
499 <?cs /if ?>
500 </div>
501</div>
502<?cs /each ?>
503<?cs /def ?>
504
505<?cs def:write_method_details(methods) ?>
506<?cs each:method=methods ?>
507<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
508<A NAME="<?cs var:method.anchor ?>"></A>
509<div class="jd-details">
510 <h4 class="jd-details-title">
511 <span class="normal">
512 <?cs var:method.scope ?>
513 <?cs var:method.static ?>
514 <?cs var:method.final ?>
515 <?cs var:method.abstract ?>
516 <?cs var:method.synchronized ?>
517 <?cs call:type_link(method.returnType) ?>
518 </span>
519 <span class="sympad"><?cs var:method.name ?></span>
520 <span class="normal">(<?cs call:parameter_list(method.params) ?>)</span>
521 </h4>
522 <div class="jd-details-descr"><?cs call:description(method) ?></div>
523</div>
524<?cs /each ?>
525<?cs /def ?>
526
527<?cs def:write_attr_details(attrs) ?>
528<?cs each:attr=attrs ?>
529<?cs # the A tag in the next line must remain where it is, so that Eclipse can parse the docs ?>
530<A NAME="<?cs var:attr.anchor ?>"></A>
531<div class="jd-details">
532 <h4 class="jd-details-title"><?cs var:attr.name ?></h4>
533 <div class="jd-details-descr">
534 <?cs call:description(attr) ?>
535
536 <div class="jd-tagdata">
537 <h5 class="jd-tagtitle">Related Methods</h5>
538 <ul class="nolist">
539 <?cs each:m=attr.methods ?>
540 <li><a href="<?cs var:toroot ?><?cs var:m.href ?>"><?cs var:m.name ?></a></li>
541 <?cs /each ?>
542 </ul>
543 </div>
544 </div>
545</div>
546<?cs /each ?>
547<?cs /def ?>
548
549
550<!-- XML Attributes -->
551<?cs if:subcount(class.attrs) ?>
552<?cs # this next line must be exactly like this to be parsed by eclipse ?>
553<!-- ========= FIELD DETAIL ======== -->
554<h2>XML Attributes</h2>
555<?cs call:write_attr_details(class.attrs) ?>
556<?cs /if ?>
557
558<!-- Enum Values -->
559<?cs if:subcount(class.enumConstants) ?>
560<?cs # this next line must be exactly like this to be parsed by eclipse ?>
561<!-- ========= ENUM CONSTANTS DETAIL ======== -->
562<h2>Enum Values</h2>
563<?cs call:write_field_details(class.enumConstants) ?>
564<?cs /if ?>
565
566<!-- Constants -->
567<?cs if:subcount(class.constants) ?>
568<?cs # this next line must be exactly like this to be parsed by eclipse ?>
569<!-- ========= ENUM CONSTANTS DETAIL ======== -->
570<h2>Constants</h2>
571<?cs call:write_field_details(class.constants) ?>
572<?cs /if ?>
573
574<!-- Fields -->
575<?cs if:subcount(class.fields) ?>
576<?cs # this next line must be exactly like this to be parsed by eclipse ?>
577<!-- ========= FIELD DETAIL ======== -->
578<h2>Fields</h2>
579<?cs call:write_field_details(class.fields) ?>
580<?cs /if ?>
581
582<!-- Public ctors -->
583<?cs if:subcount(class.ctors.public) ?>
584<?cs # this next line must be exactly like this to be parsed by eclipse ?>
585<!-- ========= CONSTRUCTOR DETAIL ======== -->
586<h2>Public Constructors</h2>
587<?cs call:write_method_details(class.ctors.public) ?>
588<?cs /if ?>
589
590<?cs # this next line must be exactly like this to be parsed by eclipse ?>
591<!-- ========= CONSTRUCTOR DETAIL ======== -->
592<!-- Protected ctors -->
593<?cs if:subcount(class.ctors.protected) ?>
594<h2>Protected Constructors</h2>
595<?cs call:write_method_details(class.ctors.protected) ?>
596<?cs /if ?>
597
598<?cs # this next line must be exactly like this to be parsed by eclipse ?>
599<!-- ========= METHOD DETAIL ======== -->
600<!-- Public methdos -->
601<?cs if:subcount(class.methods.public) ?>
602<h2>Public Methods</h2>
603<?cs call:write_method_details(class.methods.public) ?>
604<?cs /if ?>
605
606<?cs # this next line must be exactly like this to be parsed by eclipse ?>
607<!-- ========= METHOD DETAIL ======== -->
608<?cs if:subcount(class.methods.protected) ?>
609<h2>Protected Methods</h2>
610<?cs call:write_method_details(class.methods.protected) ?>
611<?cs /if ?>
612
613<?cs # the next two lines must be exactly like this to be parsed by eclipse ?>
614<!-- ========= END OF CLASS DATA ========= -->
615<A NAME="navbar_top"></A>
616
617<?cs include:"footer.cs" ?>
618</div> <!-- jd-content -->
619
620</div><!-- end doc-content -->
621
622<?cs include:"trailer.cs" ?>
623
624</body>
625</html>