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