The Android Open Source Project | 88b6079 | 2009-03-03 19:28:42 -0800 | [diff] [blame^] | 1 | <?cs # A link to a package ?><?cs |
| 2 | def: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 |
| 17 | def:type_link_impl(type, link) ?><?cs |
| 18 | if:type.link && link=="true" ?><a href="<?cs var:toroot ?><?cs var:type.link ?>"><?cs /if |
| 19 | ?><?cs var:type.label ?><?cs if:type.link && link=="true" ?></a><?cs /if ?><?cs |
| 20 | if:subcount(type.extendsBounds) ?><?cs |
| 21 | each:t=type.extendsBounds ?><?cs |
| 22 | if:first(t) ?> extends <?cs else ?> & <?cs /if ?><?cs |
| 23 | call:type_link_impl(t, "true") ?><?cs |
| 24 | /each ?><?cs |
| 25 | /if ?><?cs |
| 26 | if:subcount(type.superBounds) ?><?cs |
| 27 | each:t=type.superBounds ?><?cs |
| 28 | if:first(t) ?> super <?cs else ?> & <?cs /if ?><?cs |
| 29 | call:type_link_impl(t, "true") ?><?cs |
| 30 | /each ?><?cs |
| 31 | /if ?><?cs |
| 32 | if:subcount(type.typeArguments) |
| 33 | ?><<?cs each:t=type.typeArguments ?><?cs call:type_link_impl(t, "true") ?><?cs |
| 34 | if:!last(t) ?>, <?cs /if ?><?cs |
| 35 | /each ?>><?cs |
| 36 | /if ?><?cs |
| 37 | /def ?> |
| 38 | |
| 39 | <?cs def:class_name(type) ?><?cs call:type_link_impl(type, "false") ?><?cs /def ?> |
| 40 | <?cs def:type_link(type) ?><?cs call:type_link_impl(type, "true") ?><?cs /def ?> |
| 41 | |
| 42 | <?cs # A comma separated parameter list ?><?cs |
| 43 | def:parameter_list(params) ?><?cs |
| 44 | each:param = params ?><?cs |
| 45 | call:type_link(param.type)?> <?cs |
| 46 | var:param.name ?><?cs |
| 47 | if: name(param)!=subcount(params)-1?>, <?cs /if ?><?cs |
| 48 | /each ?><?cs |
| 49 | /def ?> |
| 50 | |
| 51 | <?cs # Print a list of tags (e.g. description text ?><?cs |
| 52 | def:tag_list(tags) ?><?cs |
| 53 | each:tag = tags ?><?cs |
| 54 | if:tag.name == "Text" ?><?cs var:tag.text?><?cs |
| 55 | elif:tag.kind == "@more" ?><p><?cs |
| 56 | elif:tag.kind == "@see" ?><a href="<?cs var:toroot ?><?cs var:tag.href ?>"><?cs var:tag.label ?></a><?cs |
| 57 | elif:tag.kind == "@seeHref" ?><a href="<?cs var:tag.href ?>"><?cs var:tag.label ?></a><?cs |
| 58 | elif:tag.kind == "@seeJustLabel" ?><?cs var:tag.label ?><?cs |
| 59 | elif:tag.kind == "@code" ?><code class="Code prettyprint"><?cs var:tag.text ?></code><?cs |
| 60 | elif:tag.kind == "@samplecode" ?><pre class="Code prettyprint"><?cs var:tag.text ?></pre><?cs |
| 61 | elif:tag.name == "@sample" ?><pre class="Code prettyprint"><?cs var:tag.text ?></pre><?cs |
| 62 | elif:tag.name == "@include" ?><?cs var:tag.text ?><?cs |
| 63 | elif:tag.kind == "@docRoot" ?><?cs var:toroot ?><?cs |
| 64 | elif:tag.kind == "@inheritDoc" ?><?cs # This is the case when @inheritDoc is in something |
| 65 | that doesn't inherit from anything?><?cs |
| 66 | elif:tag.kind == "@attr" ?><?cs |
| 67 | else ?>{<?cs var:tag.name?> <?cs var:tag.text ?>}<?cs |
| 68 | /if ?><?cs |
| 69 | /each ?><?cs |
| 70 | /def ?> |
| 71 | |
| 72 | <?cs # The message about This xxx is deprecated. ?><?cs |
| 73 | def:deprecated_text(kind) ?> |
| 74 | This <?cs var:kind ?> is deprecated.<?cs |
| 75 | /def ?> |
| 76 | |
| 77 | <?cs # Show the short-form description of something. These come from shortDescr and deprecated ?><?cs |
| 78 | def:short_descr(obj) ?><?cs |
| 79 | if:subcount(obj.deprecated) ?> |
| 80 | <em><?cs call:deprecated_text(obj.kind) ?> |
| 81 | <?cs call:tag_list(obj.deprecated) ?></em><?cs |
| 82 | else ?><?cs call:tag_list(obj.shortDescr) ?><?cs |
| 83 | /if ?><?cs |
| 84 | /def ?> |
| 85 | |
| 86 | <?cs # Show the red box with the deprecated warning ?><?cs |
| 87 | def:deprecated_warning(obj) ?><?cs |
| 88 | if:subcount(obj.deprecated) ?><p> |
| 89 | <p class="warning jd-deprecated-warning"> |
| 90 | <strong><?cs call:deprecated_text(obj.kind) ?></strong><?cs |
| 91 | call:tag_list(obj.deprecated) ?> |
| 92 | </p><?cs |
| 93 | /if ?><?cs |
| 94 | /def ?> |
| 95 | |
| 96 | <?cs # print the See Also: section ?><?cs |
| 97 | def:see_also_tags(also) ?><?cs |
| 98 | if:subcount(also) ?> |
| 99 | <div class="jd-tagdata"> |
| 100 | <h5 class="jd-tagtitle">See Also</h5> |
| 101 | <ul class="nolist"><?cs |
| 102 | each:tag=also ?><li><?cs |
| 103 | if:tag.kind == "@see" ?><a href="<?cs var:toroot ?><?cs var:tag.href ?>"><?cs |
| 104 | var:tag.label ?></a><?cs |
| 105 | elif:tag.kind == "@seeHref" ?><a href="<?cs var:tag.href ?>"><?cs var:tag.label ?></a><?cs |
| 106 | elif:tag.kind == "@seeJustLabel" ?><?cs var:tag.label ?><?cs |
| 107 | else ?>[ERROR: Unknown @see kind]<?cs |
| 108 | /if ?></li><?cs |
| 109 | /each ?> |
| 110 | </ul> |
| 111 | </div><?cs |
| 112 | /if ?> |
| 113 | <?cs /def ?> |
| 114 | |
| 115 | |
| 116 | <?cs # Print the long-form description for something. |
| 117 | Uses the following fields: deprecated descr seeAlso ?><?cs |
| 118 | def:description(obj) ?><?cs |
| 119 | call:deprecated_warning(obj) ?> |
| 120 | <div class="jd-tagdata jd-tagdescr"><p><?cs call:tag_list(obj.descr) ?></p></div><?cs |
| 121 | if:subcount(obj.attrRefs) ?> |
| 122 | <div class="jd-tagdata"> |
| 123 | <h5 class="jd-tagtitle">Related XML Attributes</h5> |
| 124 | <ul class="nolist"><?cs |
| 125 | each:attr=obj.attrRefs ?> |
| 126 | <li><a href="<?cs var:toroot ?><?cs var:attr.href ?>"><?cs var:attr.name ?></a></li><?cs |
| 127 | /each ?> |
| 128 | </ul> |
| 129 | </div><?cs |
| 130 | /if ?><?cs |
| 131 | if:subcount(obj.paramTags) ?> |
| 132 | <div class="jd-tagdata"> |
| 133 | <h5 class="jd-tagtitle">Parameters</h5> |
| 134 | <table class="jd-tagtable"><?cs |
| 135 | each:tag=obj.paramTags ?> |
| 136 | <tr> |
| 137 | <th><?cs if:tag.isTypeParameter ?><<?cs /if ?><?cs var:tag.name |
| 138 | ?><?cs if:tag.isTypeParameter ?>><?cs /if ?></td> |
| 139 | <td><?cs call:tag_list(tag.comment) ?></td> |
| 140 | </tr><?cs |
| 141 | /each ?> |
| 142 | </table> |
| 143 | </div><?cs |
| 144 | /if ?><?cs |
| 145 | if:subcount(obj.returns) ?> |
| 146 | <div class="jd-tagdata"> |
| 147 | <h5 class="jd-tagtitle">Returns</h5> |
| 148 | <ul class="nolist"><li><?cs call:tag_list(obj.returns) ?></li></ul> |
| 149 | </div><?cs |
| 150 | /if ?><?cs |
| 151 | if:subcount(obj.throws) ?> |
| 152 | <div class="jd-tagdata"> |
| 153 | <h5 class="jd-tagtitle">Throws</h5> |
| 154 | <table class="jd-tagtable"><?cs |
| 155 | each:tag=obj.throws ?> |
| 156 | <tr> |
| 157 | <th><?cs call:type_link(tag.type) ?></td> |
| 158 | <td><?cs call:tag_list(tag.comment) ?></td> |
| 159 | </tr><?cs |
| 160 | /each ?> |
| 161 | </table> |
| 162 | </div><?cs |
| 163 | /if ?><?cs |
| 164 | call:see_also_tags(obj.seeAlso) ?><?cs |
| 165 | /def ?> |
| 166 | |
| 167 | <?cs # A table of links to classes with descriptions, as in a package file or the nested classes ?><?cs |
| 168 | def:class_link_table(classes) ?><?cs |
| 169 | set:count = #1 ?> |
| 170 | <table class="jd-sumtable-expando"><?cs |
| 171 | each:cl=classes ?> |
| 172 | <tr <?cs if:count % #2 ?>class="alt-color"<?cs /if ?> > |
| 173 | <td class="jd-linkcol"><?cs call:type_link(cl.type) ?></td> |
| 174 | <td class="jd-descrcol" width="100%"><?cs call:short_descr(cl) ?> </td> |
| 175 | </tr><?cs set:count = count + #1 ?><?cs |
| 176 | /each ?> |
| 177 | </table><?cs |
| 178 | /def ?> |
| 179 | |
| 180 | <?cs # A list of links to classes, for use in the side navigation of packages ?><?cs |
| 181 | def:class_link_list(label, classes) ?><?cs |
| 182 | if:subcount(classes) ?> |
| 183 | <li><h2><?cs var:label ?></h2> |
| 184 | <ul><?cs |
| 185 | each:cl=classes ?> |
| 186 | <li><?cs call:type_link(cl.type) ?></li><?cs |
| 187 | /each ?> |
| 188 | </ul> |
| 189 | </li><?cs |
| 190 | /if ?><?cs |
| 191 | /def ?> |
| 192 | |
| 193 | <?cs # A list of links to classes, for use in the side navigation of classes ?><?cs |
| 194 | def:list(label, classes) ?><?cs |
| 195 | if:subcount(classes) ?> |
| 196 | <li><h2><?cs var:label ?></h2> |
| 197 | <ul><?cs |
| 198 | each:cl=classes ?> |
| 199 | <li <?cs if:class.name == cl.label?>class="selected"<?cs /if ?>><?cs call:type_link(cl) ?></li><?cs |
| 200 | /each ?> |
| 201 | </ul> |
| 202 | </li><?cs |
| 203 | /if ?><?cs |
| 204 | /def ?> |
| 205 | |
| 206 | <?cs # An expando trigger ?><?cs |
| 207 | def:expando_trigger(id, default) ?> |
| 208 | <a href="#" onclick="return toggleInherited(this, null)" id="<?cs var:id ?>" class="jd-expando-trigger closed" |
| 209 | ><img id="<?cs var:id ?>-trigger" |
| 210 | src="<?cs var:toroot ?>assets/images/triangle-<?cs var:default ?>.png" |
| 211 | class="jd-expando-trigger-img" /></a><?cs |
| 212 | /def ?> |
| 213 | |
| 214 | <?cs # An expandable list of classes ?><?cs |
| 215 | def:expandable_class_list(id, classes, default) ?> |
| 216 | <div id="<?cs var:id ?>"> |
| 217 | <div id="<?cs var:id ?>-list" |
| 218 | class="jd-inheritedlinks" |
| 219 | <?cs if:default != "list" ?>style="display: none;"<?cs /if ?> |
| 220 | ><?cs |
| 221 | each:cl=classes ?> |
| 222 | <?cs call:type_link(cl.type) ?><?cs if:!last(cl) ?>,<?cs /if ?><?cs |
| 223 | /each ?> |
| 224 | </div> |
| 225 | <div id="<?cs var:id ?>-summary" |
| 226 | <?cs if:default != "summary" ?>style="display: none;"<?cs /if ?> |
| 227 | ><?cs |
| 228 | call:class_link_table(classes) ?> |
| 229 | </div> |
| 230 | </div><?cs |
| 231 | /def ?> |
| 232 | |
| 233 | <?cs # The default side navigation for the reference docs ?><?cs |
| 234 | def:default_left_nav() ?> |
| 235 | <div class="g-section g-tpl-240" id="body-content"> |
| 236 | <div class="g-unit g-first side-nav-resizable" id="side-nav"> |
| 237 | <div id="swapper"> |
| 238 | <div id="nav-panels"> |
| 239 | <div id="resize-packages-nav"> |
| 240 | <div id="packages-nav"> |
| 241 | <div id="index-links"><nobr> |
| 242 | <a href="<?cs var:toroot ?>reference/packages.html" <?cs if:(page.title == "Package Index") ?>class="selected"<?cs /if ?> >Package Index</a> | |
| 243 | <a href="<?cs var:toroot ?>reference/classes.html" <?cs if:(page.title == "Class Index") ?>class="selected"<?cs /if ?>>Class Index</a></nobr> |
| 244 | </div> |
| 245 | <ul><?cs |
| 246 | each:pkg=docs.packages ?> |
| 247 | <li <?cs if:(class.package.name == pkg.name) || (package.name == pkg.name)?>class="selected"<?cs /if ?>><?cs call:package_link(pkg) ?></li><?cs |
| 248 | /each ?> |
| 249 | </ul><br/> |
| 250 | </div> <!-- end packages --> |
| 251 | </div> <!-- end resize-packages --> |
| 252 | <div id="classes-nav"><?cs |
| 253 | if:subcount(class.package) ?> |
| 254 | <ul> |
| 255 | <?cs call:list("Interfaces", class.package.interfaces) ?> |
| 256 | <?cs call:list("Classes", class.package.classes) ?> |
| 257 | <?cs call:list("Enums", class.package.enums) ?> |
| 258 | <?cs call:list("Exceptions", class.package.exceptions) ?> |
| 259 | <?cs call:list("Errors", class.package.errors) ?> |
| 260 | </ul><?cs |
| 261 | elif:subcount(package) ?> |
| 262 | <ul> |
| 263 | <?cs call:class_link_list("Interfaces", package.interfaces) ?> |
| 264 | <?cs call:class_link_list("Classes", package.classes) ?> |
| 265 | <?cs call:class_link_list("Enums", package.enums) ?> |
| 266 | <?cs call:class_link_list("Exceptions", package.exceptions) ?> |
| 267 | <?cs call:class_link_list("Errors", package.errors) ?> |
| 268 | </ul><?cs |
| 269 | else ?> |
| 270 | <script> |
| 271 | /*addLoadEvent(maxPackageHeight);*/ |
| 272 | </script> |
| 273 | <p style="padding:10px">Select a package to view its members</p><?cs |
| 274 | /if ?><br/> |
| 275 | </div><!-- end classes --> |
| 276 | </div><!-- end nav-panels --> |
| 277 | <div id="nav-tree" style="display:none"> |
| 278 | <div id="index-links"><nobr> |
| 279 | <a href="<?cs var:toroot ?>reference/packages.html" <?cs if:(page.title == "Package Index") ?>class="selected"<?cs /if ?> >Package Index</a> | |
| 280 | <a href="<?cs var:toroot ?>reference/classes.html" <?cs if:(page.title == "Class Index") ?>class="selected"<?cs /if ?>>Class Index</a></nobr> |
| 281 | </div> |
| 282 | </div><!-- end nav-tree --> |
| 283 | </div><!-- end swapper --> |
| 284 | </div> <!-- end side-nav --> |
| 285 | <script> |
| 286 | $("<a href='#' id='nav-swap' onclick='swapNav();return false;' style='font-size:10px;line-height:9px;margin-left:1em;text-decoration:none;'><span id='tree-link'>Use Tree Navigation</span><span id='panel-link' style='display:none'>Use Panel Navigation</span></a>").appendTo("#side-nav"); |
| 287 | chooseDefaultNav(); |
| 288 | if ($("#nav-tree").is(':visible')) init_navtree("nav-tree", "<?cs var:toroot ?>", NAVTREE_DATA); |
| 289 | else { |
| 290 | addLoadEvent(function() { |
| 291 | scrollIntoView("packages-nav"); |
| 292 | scrollIntoView("classes-nav"); |
| 293 | }); |
| 294 | } |
| 295 | $("#swapper").css({borderBottom:"2px solid #aaa"}); |
| 296 | </script><?cs |
| 297 | /def ?> |
| 298 | |
| 299 | <?cs # The default search box that goes in the header ?><?cs |
| 300 | def:default_search_box() ?> |
| 301 | <div id="search" > |
| 302 | <div id="searchForm"> |
| 303 | <form accept-charset="utf-8" class="gsc-search-box" |
| 304 | onsubmit="return submit_search()"> |
| 305 | <table class="gsc-search-box" cellpadding="0" cellspacing="0"><tbody> |
| 306 | <tr> |
| 307 | <td class="gsc-input"> |
| 308 | <input id="search_autocomplete" class="gsc-input" type="text" size="33" autocomplete="off" |
| 309 | title="search developer docs" name="q" |
| 310 | value="search developer docs" |
| 311 | onFocus="search_focus_changed(this, true)" |
| 312 | onBlur="search_focus_changed(this, false)" |
| 313 | onkeydown="return search_changed(event, true, '<?cs var:toroot?>')" |
| 314 | onkeyup="return search_changed(event, false, '<?cs var:toroot?>')" /> |
| 315 | <div id="search_filtered_div" class="no-display"> |
| 316 | <table id="search_filtered" cellspacing=0> |
| 317 | </table> |
| 318 | </div> |
| 319 | </td> |
| 320 | <td class="gsc-search-button"> |
| 321 | <input type="submit" value="Search" title="search" id="search-button" class="gsc-search-button" /> |
| 322 | </td> |
| 323 | <td class="gsc-clear-button"> |
| 324 | <div title="clear results" class="gsc-clear-button"> </div> |
| 325 | </td> |
| 326 | </tr></tbody> |
| 327 | </table> |
| 328 | </form> |
| 329 | </div><!-- searchForm --> |
| 330 | </div><!-- search --><?cs |
| 331 | /def ?> |
| 332 | |
| 333 | <?cs include:"customization.cs" ?> |