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