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