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