blob: d54d371cb3c23300a0a96add1a8ae477fefff1f8 [file] [log] [blame]
Ben Dodson4dbb28a2010-08-10 18:22:55 -07001<?cs
Scott Maine4d8f1b2012-06-21 18:03:05 -07002def:fullpage() ?>
3 <div id="body-content">
4<?cs /def ?>
5<?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -07006def:sdk_nav() ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -07007 <div class="wrap clearfix" id="body-content">
8 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
9 <div id="devdoc-nav" class="scroll-pane">
10<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
11
12<?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -070013 include:"../../../../frameworks/base/docs/html/sdk/sdk_toc.cs" ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -070014
15
Ben Dodson4dbb28a2010-08-10 18:22:55 -070016 </div>
17 </div> <!-- end side-nav -->
18<?cs /def ?>
19<?cs
20def:resources_tab_nav() ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -070021 <div class="wrap clearfix" id="body-content">
22 <a
23 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
24 <div id="devdoc-nav" class="scroll-pane">
25<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
26
27<?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -070028 include:"../../../../frameworks/base/docs/html/resources/resources_toc.cs" ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -070029
30
Ben Dodson4dbb28a2010-08-10 18:22:55 -070031 </div>
32 </div> <!-- end side-nav -->
33 <script>
Scott Maine4d8f1b2012-06-21 18:03:05 -070034 $(document).ready(function() {
35 scrollIntoView("devdoc-nav");
36 });
37 </script>
38<?cs /def ?>
39<?cs
40def:tools_nav() ?>
41 <div class="wrap clearfix" id="body-content">
42 <div class="col-3" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
43 <div id="devdoc-nav" class="scroll-pane">
44<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
45<?cs
46 include:"../../../../frameworks/base/docs/html/tools/tools_toc.cs" ?>
47
48
49 </div>
50 </div> <!-- end side-nav -->
51 <script>
52 $(document).ready(function() {
53 scrollIntoView("devdoc-nav");
54 });
55 </script>
56<?cs /def ?>
57<?cs
58def:training_nav() ?>
59 <div class="wrap clearfix" id="body-content">
60 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
61 <div id="devdoc-nav" class="scroll-pane">
62<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
63
64
65<?cs
66 include:"../../../../frameworks/base/docs/html/training/training_toc.cs" ?>
67
68
69 </div>
70 </div> <!-- end side-nav -->
71 <script>
72 $(document).ready(function() {
Ben Dodson4dbb28a2010-08-10 18:22:55 -070073 scrollIntoView("devdoc-nav");
74 });
75 </script>
76<?cs /def ?>
77<?cs
78def:guide_nav() ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -070079 <div class="wrap clearfix" id="body-content">
80 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
81 <div id="devdoc-nav" class="scroll-pane">
82<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
83
84
85<?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -070086 include:"../../../../frameworks/base/docs/html/guide/guide_toc.cs" ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -070087
88
Ben Dodson4dbb28a2010-08-10 18:22:55 -070089 </div>
90 </div> <!-- end side-nav -->
91 <script>
Scott Maine4d8f1b2012-06-21 18:03:05 -070092 $(document).ready(function() {
Ben Dodson4dbb28a2010-08-10 18:22:55 -070093 scrollIntoView("devdoc-nav");
94 });
95 </script>
96<?cs /def ?>
Roman Nurikd9ca90b2012-03-06 12:25:34 -080097<?cs
98def:design_nav() ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -070099 <div class="wrap clearfix" id="body-content">
100 <div class="col-3" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
101 <div id="devdoc-nav" class="scroll-pane">
102<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700103
Scott Maine4d8f1b2012-06-21 18:03:05 -0700104
105<?cs
106 include:"../../../../frameworks/base/docs/html/design/design_toc.cs" ?>
107
108
109 </div>
110 </div> <!-- end side-nav -->
111 <script>
112 $(document).ready(function() {
113 scrollIntoView("devdoc-nav");
114 });
115 </script>
116<?cs /def ?>
117<?cs
118def:distribute_nav() ?>
119 <div class="wrap clearfix" id="body-content">
120 <div class="col-3" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
121 <div id="devdoc-nav" class="scroll-pane">
122<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
123
124<?cs
125 include:"../../../../frameworks/base/docs/html/distribute/distribute_toc.cs" ?>
126
127
128 </div>
129 </div> <!-- end side-nav -->
130 <script>
131 $(document).ready(function() {
132 scrollIntoView("devdoc-nav");
133 });
134 </script>
135<?cs /def ?>
Robert Ly7d131e02012-11-27 17:27:34 -0800136
137<?cs
Dirk Dougherty4f7e5152010-09-16 10:43:40 -0700138def:samples_nav() ?>
139 <div class="wrap clearfix" id="body-content">
140 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
141 <div id="devdoc-nav" class="scroll-pane">
142<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
143
144<?cs
145 include:"../../../../frameworks/base/docs/html/samples/samples_toc.cs" ?>
146
147
148 </div>
149 <script type="text/javascript">
150 showSamplesRefTree();
151
152 </script>
153 </div> <!-- end side-nav -->
154 <script>
155 $(document).ready(function() {
156 scrollIntoView("devdoc-nav");
157 });
158 </script>
159<?cs /def ?>
160
161<?cs
Robert Ly7d131e02012-11-27 17:27:34 -0800162def:google_nav() ?>
163 <div class="wrap clearfix" id="body-content">
164 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
165 <div id="devdoc-nav" class="scroll-pane">
166<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
167
168<?cs
169 include:"../../../../frameworks/base/docs/html/google/google_toc.cs" ?>
170
171
172 </div>
Robert Lyd2dd6e52012-11-29 21:28:48 -0800173 <script type="text/javascript">
174 showGoogleRefTree();
175
176 </script>
Robert Ly7d131e02012-11-27 17:27:34 -0800177 </div> <!-- end side-nav -->
178 <script>
179 $(document).ready(function() {
180 scrollIntoView("devdoc-nav");
181 });
182 </script>
183<?cs /def ?>
184
Scott Maine4d8f1b2012-06-21 18:03:05 -0700185<?cs
186def:about_nav() ?>
187 <div class="wrap clearfix" id="body-content">
188 <div class="col-3" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
189 <div id="devdoc-nav" class="scroll-pane">
190<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
191
192<?cs
193 include:"../../../../frameworks/base/docs/html/about/about_toc.cs" ?>
194
195
196 </div>
197 </div> <!-- end side-nav -->
198 <script>
199 $(document).ready(function() {
200 scrollIntoView("devdoc-nav");
201 });
202 </script>
203<?cs /def ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -0700204
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700205<?cs # The default side navigation for the reference docs ?><?cs
206def:default_left_nav() ?>
Robert Lyd2dd6e52012-11-29 21:28:48 -0800207<?cs if:reference.gcm || reference.gms ?>
208 <?cs call:google_nav() ?>
209<?cs else ?>
Scott Maine4d8f1b2012-06-21 18:03:05 -0700210 <div class="wrap clearfix" id="body-content">
211 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
212 <div id="devdoc-nav">
Robert Lyd2dd6e52012-11-29 21:28:48 -0800213
Scott Maine4d8f1b2012-06-21 18:03:05 -0700214<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
215 <div id="api-nav-header">
216 <div id="api-level-toggle">
Scott Main641c2c22013-10-31 14:48:45 -0700217 <label for="apiLevelCheckbox" class="disabled"
218 title="Select your target API level to dim unavailable APIs">API level: </label>
Scott Maine4d8f1b2012-06-21 18:03:05 -0700219 <div class="select-wrapper">
220 <select id="apiLevelSelector">
221 <!-- option elements added by buildApiLevelSelector() -->
222 </select>
223 </div>
224 </div><!-- end toggle -->
225 <div id="api-nav-title">Android APIs</div>
226 </div><!-- end nav header -->
227 <script>
228 var SINCE_DATA = [ <?cs
229 each:since = since ?>'<?cs
230 var:since.name ?>'<?cs
231 if:!last(since) ?>, <?cs /if ?><?cs
232 /each
233 ?> ];
234 buildApiLevelSelector();
235 </script>
236
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700237 <div id="swapper">
238 <div id="nav-panels">
239 <div id="resize-packages-nav">
Scott Maine4d8f1b2012-06-21 18:03:05 -0700240 <div id="packages-nav" class="scroll-pane">
241
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700242 <ul>
Scott Main641c2c22013-10-31 14:48:45 -0700243 <?cs call:package_link_list(docs.packages) ?>
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700244 </ul><br/>
Scott Maine4d8f1b2012-06-21 18:03:05 -0700245
246 </div> <!-- end packages-nav -->
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700247 </div> <!-- end resize-packages -->
Scott Maine4d8f1b2012-06-21 18:03:05 -0700248 <div id="classes-nav" class="scroll-pane">
249
250
251<?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700252 if:subcount(class.package) ?>
253 <ul>
254 <?cs call:list("Interfaces", class.package.interfaces) ?>
255 <?cs call:list("Classes", class.package.classes) ?>
256 <?cs call:list("Enums", class.package.enums) ?>
257 <?cs call:list("Exceptions", class.package.exceptions) ?>
258 <?cs call:list("Errors", class.package.errors) ?>
259 </ul><?cs
260 elif:subcount(package) ?>
261 <ul>
262 <?cs call:class_link_list("Interfaces", package.interfaces) ?>
263 <?cs call:class_link_list("Classes", package.classes) ?>
264 <?cs call:class_link_list("Enums", package.enums) ?>
265 <?cs call:class_link_list("Exceptions", package.exceptions) ?>
266 <?cs call:class_link_list("Errors", package.errors) ?>
267 </ul><?cs
268 else ?>
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700269 <p style="padding:10px">Select a package to view its members</p><?cs
270 /if ?><br/>
Scott Maine4d8f1b2012-06-21 18:03:05 -0700271
272
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700273 </div><!-- end classes -->
274 </div><!-- end nav-panels -->
Scott Maine4d8f1b2012-06-21 18:03:05 -0700275 <div id="nav-tree" style="display:none" class="scroll-pane">
276 <div id="tree-list"></div>
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700277 </div><!-- end nav-tree -->
278 </div><!-- end swapper -->
Scott Maine4d8f1b2012-06-21 18:03:05 -0700279 <div id="nav-swap">
280 <a class="fullscreen">fullscreen</a>
281 <a href='#' onclick='swapNav();return false;'><span id='tree-link'>Use Tree Navigation</span><span id='panel-link' style='display:none'>Use Panel Navigation</span></a>
282 </div>
283 </div> <!-- end devdoc-nav -->
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700284 </div> <!-- end side-nav -->
Scott Maine4d8f1b2012-06-21 18:03:05 -0700285 <script type="text/javascript">
286 // init fullscreen based on user pref
287 var fullscreen = readCookie("fullscreen");
288 if (fullscreen != 0) {
289 if (fullscreen == "false") {
290 toggleFullscreen(false);
291 } else {
292 toggleFullscreen(true);
293 }
294 }
295 // init nav version for mobile
296 if (isMobile) {
297 swapNav(); // tree view should be used on mobile
298 $('#nav-swap').hide();
299 } else {
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700300 chooseDefaultNav();
301 if ($("#nav-tree").is(':visible')) {
302 init_default_navtree("<?cs var:toroot ?>");
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700303 }
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700304 }
Scott Maine4d8f1b2012-06-21 18:03:05 -0700305 // scroll the selected page into view
306 $(document).ready(function() {
307 scrollIntoView("packages-nav");
308 scrollIntoView("classes-nav");
309 });
Robert Lyd2dd6e52012-11-29 21:28:48 -0800310 </script>
311<?cs /if ?>
312 <?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700313/def ?>
314
315<?cs
Scott Maine4d8f1b2012-06-21 18:03:05 -0700316def:custom_left_nav() ?><?cs
317 if:fullpage ?><?cs
318 call:fullpage() ?><?cs
319 elif:guide ?><?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700320 call:guide_nav() ?><?cs
Scott Maine4d8f1b2012-06-21 18:03:05 -0700321 elif:design ?><?cs
322 call:design_nav() ?><?cs
323 elif:training ?><?cs
324 call:training_nav() ?><?cs
325 elif:tools ?><?cs
326 call:tools_nav() ?><?cs
327 elif:google ?><?cs
Robert Ly7d131e02012-11-27 17:27:34 -0800328 call:google_nav() ?><?cs
Dirk Dougherty4f7e5152010-09-16 10:43:40 -0700329 elif:samples ?><?cs
330 call:samples_nav() ?><?cs
Scott Maine4d8f1b2012-06-21 18:03:05 -0700331 elif:more ?><?cs
332 call:dist_more_nav() ?><?cs
333 elif:distribute ?><?cs
334 call:distribute_nav() ?><?cs
335 elif:about ?><?cs
336 call:about_nav() ?><?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700337 else ?><?cs
Robert Lyd2dd6e52012-11-29 21:28:48 -0800338 call:default_left_nav() ?> <?cs
Scott Main015d6162013-01-29 09:01:52 -0800339 /if ?><?cs
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700340/def ?>
341
342<?cs # appears at the bottom of every page ?><?cs
343def:custom_cc_copyright() ?>
344 Except as noted, this content is
345 licensed under <a href="http://creativecommons.org/licenses/by/2.5/">
346 Creative Commons Attribution 2.5</a>. For details and
347 restrictions, see the <a href="<?cs var:toroot ?>license.html">Content
348 License</a>.<?cs
349/def ?>
350
351<?cs
352def:custom_copyright() ?>
353 Except as noted, this content is licensed under <a
354 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>.
355 For details and restrictions, see the <a href="<?cs var:toroot ?>license.html">
356 Content License</a>.<?cs
357/def ?>
358
359<?cs
360def:custom_footerlinks() ?>
361 <p>
Scott Maine4d8f1b2012-06-21 18:03:05 -0700362 <a href="<?cs var:toroot ?>about/index.html">About Android</a>&nbsp;&nbsp;|&nbsp;
363 <a href="<?cs var:toroot ?>legal.html">Legal</a>&nbsp;&nbsp;|&nbsp;
364 <a href="<?cs var:toroot ?>support.html">Support</a>
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700365 </p><?cs
366/def ?>
367
368<?cs # appears on the right side of the blue bar at the bottom off every page ?><?cs
Scott Main8fa53512012-11-30 20:16:42 -0800369def:custom_buildinfo() ?><?cs
Robert Ly54056be2013-02-20 16:07:32 -0800370 if:!google && !reference.gcm && !reference.gms ?>
Scott Main8fa53512012-11-30 20:16:42 -0800371 Android <?cs var:sdk.version ?>&nbsp;r<?cs var:sdk.rel.id ?> &mdash; <?cs
Scott Maine05e6f92013-01-29 13:34:17 -0800372 /if ?>
373<script src="<?cs var:toroot ?>timestamp.js" type="text/javascript"></script>
374<script>document.write(BUILD_TIMESTAMP)</script>
Ben Dodson4dbb28a2010-08-10 18:22:55 -0700375<?cs /def ?>
376