macros.cs revision 1be4b1524f27696c9c71b78468742c162dd0b9c1 
1<?cs # A link to a package ?><?cs
2def:package_link(pkg) ?>
3  <a href="<?cs var:toroot ?><?cs var:pkg.link ?>"><?cs var:pkg.name ?></a><?cs
4/def ?>
5
6<?cs # A link to a type, or not if it's a primitive type
7        link: whether to create a link at the top level, always creates links in
8              recursive invocations.
9        Expects the following fields:
10            .name
11            .link
12            .isPrimitive
13            .superBounds.N.(more links)   (... super ... & ...)
14            .extendsBounds.N.(more links) (... extends ... & ...)
15            .typeArguments.N.(more links) (< ... >)
16?><?cs
17def:type_link_impl(type, link) ?><?cs
18  if:type.link && link=="true" ?><?cs
19    if:type.federated ?><a href="<?cs var:type.link ?>"><?cs
20      var:type.label ?></a><?cs
21    else ?><a href="<?cs var:toroot ?><?cs var:type.link ?>"><?cs var:type.label ?></a><?cs
22    /if ?><?cs
23  else ?><?cs var:type.label ?><?cs
24  /if ?><?cs if:subcount(type.extendsBounds) ?><?cs
25      each:t=type.extendsBounds ?><?cs
26          if:first(t) ?>&nbsp;extends&nbsp;<?cs else ?>&nbsp;&amp;&nbsp;<?cs /if ?><?cs
27          call:type_link_impl(t, "true") ?><?cs
28      /each ?><?cs
29  /if ?><?cs
30  if:subcount(type.superBounds) ?><?cs
31      each:t=type.superBounds ?><?cs
32          if:first(t) ?>&nbsp;super&nbsp;<?cs else ?>&nbsp;&amp;&nbsp;<?cs /if ?><?cs
33          call:type_link_impl(t, "true") ?><?cs
34      /each ?><?cs
35  /if ?><?cs
36  if:subcount(type.typeArguments)
37      ?>&lt;<?cs each:t=type.typeArguments ?><?cs call:type_link_impl(t, "true") ?><?cs
38          if:!last(t) ?>,&nbsp;<?cs /if ?><?cs
39      /each ?>&gt;<?cs
40  /if ?><?cs
41/def ?>
42
43<?cs def:class_name(type) ?><?cs call:type_link_impl(type, "false") ?><?cs /def ?>
44<?cs def:type_link(type) ?><?cs call:type_link_impl(type, "true") ?><?cs /def ?>
45
46<?cs # a conditional link.
47      if the "condition" parameter evals to true then the link is displayed
48      otherwise only the text is displayed
49?><?cs
50def:cond_link(text, root, path, condition) ?><?cs
51  if:condition ?><a href="<?cs var:root ?><?cs var:path ?>"><?cs /if ?><?cs var:text ?><?cs if:condition ?></a><?cs /if ?><?cs
52/def ?>
53
54<?cs # A comma separated parameter list ?><?cs
55def:parameter_list(params) ?><?cs
56  each:param = params ?><?cs
57      call:type_link(param.type)?> <?cs
58      var:param.name ?><?cs
59      if: name(param)!=subcount(params)-1?>, <?cs /if ?><?cs
60  /each ?><?cs
61/def ?>
62
63<?cs # Print a list of tags (e.g. description text ?><?cs
64def:tag_list(tags) ?><?cs
65  each:tag = tags ?><?cs
66      if:tag.name == "Text" ?><?cs var:tag.text?><?cs
67      elif:tag.kind == "@more" ?><p><?cs
68      elif:tag.kind == "@see" ?><code><a href="<?cs var:toroot ?><?cs var:tag.href ?>"><?cs var:tag.label ?></a></code><?cs
69      elif:tag.kind == "@seeHref" ?><a href="<?cs var:tag.href ?>"><?cs var:tag.label ?></a><?cs
70      elif:tag.kind == "@seeJustLabel" ?><?cs var:tag.label ?><?cs
71      elif:tag.kind == "@code" ?><code><?cs var:tag.text ?></code><?cs
72      elif:tag.kind == "@samplecode" ?><pre><?cs var:tag.text ?></pre><?cs
73      elif:tag.name == "@sample" ?><pre><?cs var:tag.text ?></pre><?cs
74      elif:tag.name == "@include" ?><?cs var:tag.text ?><?cs
75      elif:tag.kind == "@docRoot" ?><?cs var:toroot ?><?cs
76      elif:tag.kind == "@sdkCurrent" ?><?cs var:sdk.current ?><?cs
77      elif:tag.kind == "@sdkCurrentVersion" ?><?cs var:sdk.version ?><?cs
78      elif:tag.kind == "@sdkCurrentRelId" ?><?cs var:sdk.rel.id ?><?cs
79      elif:tag.kind == "@sdkPlatformVersion" ?><?cs var:sdk.platform.version ?><?cs
80      elif:tag.kind == "@sdkPlatformApiLevel" ?><?cs var:sdk.platform.apiLevel ?><?cs
81      elif:tag.kind == "@sdkPlatformMajorMinor" ?><?cs var:sdk.platform.majorMinor ?><?cs
82      elif:tag.kind == "@sdkPlatformReleaseDate" ?><?cs var:sdk.platform.releaseDate ?><?cs
83      elif:tag.kind == "@sdkPlatformDeployableDate" ?><?cs var:sdk.platform.deployableDate ?><?cs
84      elif:tag.kind == "@adtZipVersion" ?><?cs var:adt.zip.version ?><?cs
85      elif:tag.kind == "@adtZipDownload" ?><?cs var:adt.zip.download ?><?cs
86      elif:tag.kind == "@adtZipBytes" ?><?cs var:adt.zip.bytes ?><?cs
87      elif:tag.kind == "@adtZipChecksum" ?><?cs var:adt.zip.checksum ?><?cs
88      elif:tag.kind == "@inheritDoc" ?><?cs # This is the case when @inheritDoc is in something
89                                              that doesn't inherit from anything?><?cs
90      elif:tag.kind == "@attr" ?><?cs
91      else ?>{<?cs var:tag.name?> <?cs var:tag.text ?>}<?cs
92      /if ?><?cs
93  /each ?><?cs
94/def ?>
95
96<?cs # The message about This xxx is deprecated. ?><?cs
97def:deprecated_text(kind) ?>
98  This <?cs var:kind ?> is deprecated.<?cs
99/def ?>
100
101<?cs # Show the short-form description of something.  These come from shortDescr and deprecated ?><?cs
102def:short_descr(obj) ?><?cs
103  if:subcount(obj.deprecated) ?>
104      <em><?cs call:deprecated_text(obj.kind) ?>
105      <?cs call:tag_list(obj.deprecated) ?></em><?cs
106  else ?><?cs call:tag_list(obj.shortDescr) ?><?cs
107  /if ?><?cs
108/def ?>
109
110<?cs # Show the red box with the deprecated warning ?><?cs
111def:deprecated_warning(obj) ?><?cs
112  if:subcount(obj.deprecated) ?><p>
113  <p class="caution">
114      <strong><?cs call:deprecated_text(obj.kind) ?></strong><br/> <?cs
115      call:tag_list(obj.deprecated) ?>
116  </p><?cs
117  /if ?><?cs
118/def ?>
119
120<?cs # print the See Also: section ?><?cs
121def:see_also_tags(also) ?><?cs
122  if:subcount(also) ?>
123  <div class="jd-tagdata">
124      <h5 class="jd-tagtitle">See Also</h5>
125      <ul class="nolist"><?cs
126        each:tag=also ?><li><?cs
127            if:tag.kind == "@see" ?><code><a href="<?cs var:toroot ?><?cs var:tag.href ?>"><?cs
128                    var:tag.label ?></a></code><?cs
129            elif:tag.kind == "@seeHref" ?><a href="<?cs var:tag.href ?>"><?cs var:tag.label ?></a><?cs
130            elif:tag.kind == "@seeJustLabel" ?><?cs var:tag.label ?><?cs
131            else ?>[ERROR: Unknown @see kind]<?cs
132            /if ?></li><?cs
133        /each ?>
134      </ul>
135  </div><?cs
136  /if ?>
137<?cs /def ?>
138
139<?cs # print the API Level ?><?cs
140def:since_tags(obj) ?>
141<?cs if:reference.apilevels && obj.since ?>
142  Since: <a href="<?cs var:toroot ?>guide/appendix/api-levels.html#level<?cs var:obj.since ?>">API Level <?cs var:obj.since ?></a>
143<?cs /if ?>
144<?cs /def ?>
145<?cs def:federated_refs(obj) ?>
146  <?cs if:subcount(obj.federated) ?>
147    <div>
148    Also:
149    <?cs each:federated=obj.federated ?>
150      <a href="<?cs var:federated.url ?>"><?cs var:federated.name ?></a><?cs
151      if:!last(federated) ?>,<?cs /if ?>
152    <?cs /each ?>
153    </div>
154  <?cs /if ?>
155<?cs /def ?>
156<?cs # Print the long-form description for something.
157       Uses the following fields: deprecated descr seeAlso since ?><?cs
158def:description(obj) ?><?cs
159  call:deprecated_warning(obj) ?>
160  <div class="jd-tagdata jd-tagdescr"><p><?cs call:tag_list(obj.descr) ?></p></div><?cs
161  if:subcount(obj.attrRefs) ?>
162  <div class="jd-tagdata">
163      <h5 class="jd-tagtitle">Related XML Attributes</h5>
164      <ul class="nolist"><?cs
165        each:attr=obj.attrRefs ?>
166            <li><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></li><?cs
167        /each ?>
168      </ul>
169  </div><?cs
170  /if ?><?cs
171  if:subcount(obj.paramTags) ?>
172  <div class="jd-tagdata">
173      <h5 class="jd-tagtitle">Parameters</h5>
174      <table class="jd-tagtable"><?cs
175      each:tag=obj.paramTags ?>
176        <tr>
177          <th><?cs if:tag.isTypeParameter ?>&lt;<?cs /if ?><?cs var:tag.name
178                  ?><?cs if:tag.isTypeParameter ?>&gt;<?cs /if ?></td>
179          <td><?cs call:tag_list(tag.comment) ?></td>
180        </tr><?cs
181      /each ?>
182      </table>
183  </div><?cs
184  /if ?><?cs
185  if:subcount(obj.returns) ?>
186  <div class="jd-tagdata">
187      <h5 class="jd-tagtitle">Returns</h5>
188      <ul class="nolist"><li><?cs call:tag_list(obj.returns) ?></li></ul>
189  </div><?cs
190  /if ?><?cs
191  if:subcount(obj.throws) ?>
192  <div class="jd-tagdata">
193      <h5 class="jd-tagtitle">Throws</h5>
194      <table class="jd-tagtable"><?cs
195      each:tag=obj.throws ?>
196        <tr>
197            <th><?cs call:type_link(tag.type) ?></td>
198            <td><?cs call:tag_list(tag.comment) ?></td>
199        </tr><?cs
200      /each ?>
201      </table>
202  </div><?cs
203  /if ?><?cs
204  call:see_also_tags(obj.seeAlso) ?><?cs
205/def ?>
206
207<?cs # A table of links to classes with descriptions, as in a package file or the nested classes ?><?cs
208def:class_link_table(classes) ?><?cs
209  set:count = #1 ?>
210  <table class="jd-sumtable-expando"><?cs
211      each:cl=classes ?>
212        <tr class="<?cs if:count % #2 ?>alt-color<?cs /if ?> api apilevel-<?cs var:cl.type.since ?>" >
213              <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td>
214              <td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?>&nbsp;</td>
215          </tr><?cs set:count = count + #1 ?><?cs
216      /each ?>
217  </table><?cs
218/def ?>
219
220<?cs # A list of links to classes, for use in the side navigation of classes when viewing a package (panel nav) ?><?cs
221def:class_link_list(label, classes) ?><?cs
222  if:subcount(classes) ?>
223    <li><h2><?cs var:label ?></h2>
224      <ul><?cs
225      each:cl=classes ?>
226        <li class="api apilevel-<?cs var:cl.type.since ?>"><?cs call:type_link(cl.type) ?></li><?cs
227      /each ?>
228      </ul>
229    </li><?cs
230  /if ?><?cs
231/def ?>
232
233<?cs # A list of links to classes, for use in the side navigation of classes when viewing a class (panel nav) ?><?cs
234def:list(label, classes) ?><?cs
235  if:subcount(classes) ?>
236    <li><h2><?cs var:label ?></h2>
237      <ul><?cs
238      each:cl=classes ?>
239          <li class="<?cs if:class.name == cl.label?>selected <?cs /if ?>api apilevel-<?cs var:cl.since ?>"><?cs call:type_link(cl) ?></li><?cs
240      /each ?>
241      </ul>
242    </li><?cs
243  /if ?><?cs
244/def ?>
245
246<?cs # A list of links to packages, for use in the side navigation of packages (panel nav) ?><?cs
247def:package_link_list(packages) ?><?cs
248  each:pkg=packages ?>
249    <li class="<?cs if:(class.package.name == pkg.name) || (package.name == pkg.name)?>selected <?cs /if ?>api apilevel-<?cs var:pkg.since ?>"><?cs call:package_link(pkg) ?></li><?cs
250  /each ?><?cs
251/def ?>
252
253<?cs # An expando trigger ?><?cs
254def:expando_trigger(id, default) ?>
255  <a href="#" onclick="return toggleInherited(this, null)" id="<?cs var:id ?>" class="jd-expando-trigger closed"
256          ><img id="<?cs var:id ?>-trigger"
257          src="<?cs var:toroot ?>assets/images/triangle-<?cs var:default ?>.png"
258          class="jd-expando-trigger-img" /></a><?cs
259/def ?>
260
261<?cs # An expandable list of classes ?><?cs
262def:expandable_class_list(id, classes, default) ?>
263  <div id="<?cs var:id ?>">
264      <div id="<?cs var:id ?>-list"
265              class="jd-inheritedlinks"
266              <?cs if:default != "list" ?>style="display: none;"<?cs /if ?>
267              >
268          <?cs if:subcount(classes) <= #20 ?>
269            <?cs each:cl=classes ?>
270              <?cs call:type_link(cl.type) ?><?cs if:!last(cl) ?>,<?cs /if ?>
271            <?cs /each ?>
272          <?cs else ?>
273            <?cs set:leftovers = subcount(classes) - #15 ?>
274            <?cs loop:i = #0, #14, #1 ?>
275              <?cs with:cl=classes[i] ?>
276                <?cs call:type_link(cl.type) ?>,
277              <?cs /with ?>
278              <?cs  if:(#i == #14) ?>and
279                <a href="#" onclick="return toggleInherited(document.getElementById('<?cs
280                   var:id ?>', null))"><?cs var:leftovers ?> others.</a>
281              <?cs /if ?>
282            <?cs /loop ?>
283          <?cs /if ?>
284      </div>
285      <div id="<?cs var:id ?>-summary"
286              <?cs if:default != "summary" ?>style="display: none;"<?cs /if ?>
287              ><?cs
288          call:class_link_table(classes) ?>
289      </div>
290  </div><?cs
291/def ?>
292
293<?cs include:"components.cs" ?>
294
295