blob: 54000c15abe7c2cc53a81639a85e22ceb9625fcb [file] [log] [blame]
Robert Ly3c4b4f72012-11-30 04:02:04 -08001<!DOCTYPE html>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76<html>
77<head>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -070078
79
80
Robert Ly3c4b4f72012-11-30 04:02:04 -080081<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
82
83<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico" />
84<title>GroundOverlay | Android Developers</title>
85
86<!-- STYLESHEETS -->
87<link rel="stylesheet"
Robert Lyf6f5cf42013-02-04 18:24:15 -080088href="//fonts.googleapis.com/css?family=Roboto:regular,medium,thin,italic,mediumitalic,bold" title="roboto">
Robert Ly3c4b4f72012-11-30 04:02:04 -080089<link href="/assets/css/default.css" rel="stylesheet" type="text/css">
90
91
92
93<!-- JAVASCRIPT -->
Dirk Dougherty8a72b6e2013-02-01 15:00:09 -080094<script src="//www.google.com/jsapi" type="text/javascript"></script>
Robert Lyf6f5cf42013-02-04 18:24:15 -080095<script src="/assets/js/android_3p-bundle.js" type="text/javascript"></script>
Robert Ly3c4b4f72012-11-30 04:02:04 -080096<script type="text/javascript">
97 var toRoot = "/";
Robert Lyf6f5cf42013-02-04 18:24:15 -080098 var devsite = false;
Robert Ly3c4b4f72012-11-30 04:02:04 -080099</script>
100<script src="/assets/js/docs.js" type="text/javascript"></script>
101
Robert Lyf6f5cf42013-02-04 18:24:15 -0800102<script type="text/javascript">
103 var _gaq = _gaq || [];
104 _gaq.push(['_setAccount', 'UA-5831155-1']);
105 _gaq.push(['_trackPageview']);
106
107 (function() {
108 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
109 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
110 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
111 })();
112</script>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800113</head>
Robert Ly555c93b2012-12-03 12:24:07 -0800114<body class="gc-documentation google
Robert Ly3c4b4f72012-11-30 04:02:04 -0800115 develop" itemscope itemtype="http://schema.org/Article">
116 <div id="doc-api-level" class="" style="display:none"></div>
117 <a name="top"></a>
118
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700119<a name="top"></a>
120
Robert Ly3c4b4f72012-11-30 04:02:04 -0800121 <!-- Header -->
122 <div id="header">
123 <div class="wrap" id="header-wrap">
124 <div class="col-3 logo">
125 <a href="/index.html">
126 <img src="/assets/images/dac_logo.png" width="123" height="25" alt="Android Developers" />
127 </a>
128 <div class="btn-quicknav" id="btn-quicknav">
129 <a href="#" class="arrow-inactive">Quicknav</a>
130 <a href="#" class="arrow-active">Quicknav</a>
131 </div>
132 </div>
133 <ul class="nav-x col-9">
134 <li class="design">
Robert Ly05c8e632013-02-25 14:43:01 -0800135 <a href="/design/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700136 zh-tw-lang="設計"
137 zh-cn-lang="设计"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800138 ru-lang="Проектирование"
139 ko-lang="디자인"
140 ja-lang="設計"
141 es-lang="Diseñar"
142 >Design</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800143 <li class="develop"><a href="/develop/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700144 zh-tw-lang="開發"
145 zh-cn-lang="开发"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800146 ru-lang="Разработка"
147 ko-lang="개발"
148 ja-lang="開発"
149 es-lang="Desarrollar"
150 >Develop</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800151 <li class="distribute last"><a href="/distribute/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700152 zh-tw-lang="發佈"
153 zh-cn-lang="分发"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800154 ru-lang="Распространение"
155 ko-lang="배포"
156 ja-lang="配布"
157 es-lang="Distribuir"
158 >Distribute</a></li>
159 </ul>
160
161 <!-- New Search -->
162 <div class="menu-container">
163 <div class="moremenu">
164 <div id="more-btn"></div>
165 </div>
166 <div class="morehover" id="moremenu">
167 <div class="top"></div>
168 <div class="mid">
169 <div class="header">Links</div>
170 <ul>
171 <li><a href="https://play.google.com/apps/publish/">Google Play Developer Console</a></li>
172 <li><a href="http://android-developers.blogspot.com/">Android Developers Blog</a></li>
173 <li><a href="/about/index.html">About Android</a></li>
174 </ul>
175 <div class="header">Android Sites</div>
176 <ul>
177 <li><a href="http://www.android.com">Android.com</a></li>
178 <li class="active"><a>Android Developers</a></li>
179 <li><a href="http://source.android.com">Android Open Source Project</a></li>
180 </ul>
Robert Lyf6f5cf42013-02-04 18:24:15 -0800181
Robert Lyf6f5cf42013-02-04 18:24:15 -0800182
183
184 <div class="header">Language</div>
185 <div id="language" class="locales">
186 <select name="language" onChange="changeLangPref(this.value, true)">
187 <option value="en">English</option>
188 <option value="es">Español</option>
189 <option value="ja">日本語</option>
190 <option value="ko">한국어</option>
191 <option value="ru">Русский</option>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700192 <option value="zh-cn">中文 (中国)</option>
193 <option value="zh-tw">中文 (台灣)</option>
Robert Lyf6f5cf42013-02-04 18:24:15 -0800194 </select>
195 </div>
196 <script type="text/javascript">
197 <!--
198 loadLangPref();
199 //-->
200 </script>
201
202
203
204
Robert Ly3c4b4f72012-11-30 04:02:04 -0800205 <br class="clearfix" />
206 </div>
207 <div class="bottom"></div>
208 </div>
209 <div class="search" id="search-container">
210 <div class="search-inner">
211 <div id="search-btn"></div>
212 <div class="left"></div>
213 <form onsubmit="return submit_search()">
214 <input id="search_autocomplete" type="text" value="" autocomplete="off" name="q"
215onfocus="search_focus_changed(this, true)" onblur="search_focus_changed(this, false)"
216onkeydown="return search_changed(event, true, '/')"
217onkeyup="return search_changed(event, false, '/')" />
218 </form>
219 <div class="right"></div>
220 <a class="close hide">close</a>
221 <div class="left"></div>
222 <div class="right"></div>
223 </div>
224 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700225
226 <div class="search_filtered_wrapper reference">
227 <div class="suggest-card reference no-display">
228 <ul class="search_filtered">
229 </ul>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800230 </div>
231 </div>
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700232
233 <div class="search_filtered_wrapper docs">
234 <div class="suggest-card dummy no-display">&nbsp;</div>
235 <div class="suggest-card develop no-display">
236 <ul class="search_filtered">
237 </ul>
238 <div class="child-card guides no-display">
239 </div>
240 <div class="child-card training no-display">
241 </div>
242 </div>
243 <div class="suggest-card design no-display">
244 <ul class="search_filtered">
245 </ul>
246 </div>
247 <div class="suggest-card distribute no-display">
248 <ul class="search_filtered">
249 </ul>
250 </div>
251 </div>
252
Robert Ly3c4b4f72012-11-30 04:02:04 -0800253 </div>
254 <!-- /New Search>
255
256
257 <!-- Expanded quicknav -->
258 <div id="quicknav" class="col-9">
259 <ul>
260 <li class="design">
261 <ul>
262 <li><a href="/design/index.html">Get Started</a></li>
263 <li><a href="/design/style/index.html">Style</a></li>
264 <li><a href="/design/patterns/index.html">Patterns</a></li>
265 <li><a href="/design/building-blocks/index.html">Building Blocks</a></li>
266 <li><a href="/design/downloads/index.html">Downloads</a></li>
267 <li><a href="/design/videos/index.html">Videos</a></li>
268 </ul>
269 </li>
270 <li class="develop">
271 <ul>
272 <li><a href="/training/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700273 zh-tw-lang="訓練課程"
274 zh-cn-lang="培训"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800275 ru-lang="Курсы"
276 ko-lang="교육"
277 ja-lang="トレーニング"
278 es-lang="Capacitación"
279 >Training</a></li>
280 <li><a href="/guide/components/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700281 zh-tw-lang="API 指南"
282 zh-cn-lang="API 指南"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800283 ru-lang="Руководства по API"
284 ko-lang="API 가이드"
285 ja-lang="API ガイド"
286 es-lang="Guías de la API"
287 >API Guides</a></li>
288 <li><a href="/reference/packages.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700289 zh-tw-lang="參考資源"
290 zh-cn-lang="参考"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800291 ru-lang="Справочник"
292 ko-lang="참조문서"
293 ja-lang="リファレンス"
294 es-lang="Referencia"
295 >Reference</a></li>
296 <li><a href="/tools/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700297 zh-tw-lang="相關工具"
298 zh-cn-lang="工具"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800299 ru-lang="Инструменты"
300 ko-lang="도구"
301 ja-lang="ツール"
302 es-lang="Herramientas"
303 >Tools</a>
304 <ul><li><a href="/sdk/index.html">Get the SDK</a></li></ul>
305 </li>
306 <li><a href="/google/index.html">Google Services</a>
307 </li>
308 </ul>
309 </li>
310 <li class="distribute last">
311 <ul>
312 <li><a href="/distribute/index.html">Google Play</a></li>
313 <li><a href="/distribute/googleplay/publish/index.html">Publishing</a></li>
314 <li><a href="/distribute/googleplay/promote/index.html">Promoting</a></li>
315 <li><a href="/distribute/googleplay/quality/index.html">App Quality</a></li>
316 <li><a href="/distribute/googleplay/spotlight/index.html">Spotlight</a></li>
317 <li><a href="/distribute/open.html">Open Distribution</a></li>
318 </ul>
319 </li>
320 </ul>
321 </div>
322 <!-- /Expanded quicknav -->
323 </div>
324 </div>
325 <!-- /Header -->
326
327
328 <div id="searchResults" class="wrap" style="display:none;">
329 <h2 id="searchTitle">Results</h2>
330 <div id="leftSearchControl" class="search-control">Loading...</div>
331 </div>
332
333
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700334
Robert Ly3c4b4f72012-11-30 04:02:04 -0800335 <!-- Secondary x-nav -->
336 <div id="nav-x">
337 <div class="wrap">
338 <ul class="nav-x col-9 develop" style="width:100%">
Robert Ly05c8e632013-02-25 14:43:01 -0800339 <li class="training"><a href="/training/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700340 zh-tw-lang="訓練課程"
341 zh-cn-lang="培训"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800342 ru-lang="Курсы"
343 ko-lang="교육"
344 ja-lang="トレーニング"
345 es-lang="Capacitación"
346 >Training</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800347 <li class="guide"><a href="/guide/components/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700348 zh-tw-lang="API 指南"
349 zh-cn-lang="API 指南"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800350 ru-lang="Руководства по API"
351 ko-lang="API 가이드"
352 ja-lang="API ガイド"
353 es-lang="Guías de la API"
354 >API Guides</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800355 <li class="reference"><a href="/reference/packages.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700356 zh-tw-lang="參考資源"
357 zh-cn-lang="参考"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800358 ru-lang="Справочник"
359 ko-lang="참조문서"
360 ja-lang="リファレンス"
361 es-lang="Referencia"
362 >Reference</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800363 <li class="tools"><a href="/tools/index.html"
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700364 zh-tw-lang="相關工具"
365 zh-cn-lang="工具"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800366 ru-lang="Инструменты"
367 ko-lang="도구"
368 ja-lang="ツール"
369 es-lang="Herramientas"
370 >Tools</a></li>
Robert Ly05c8e632013-02-25 14:43:01 -0800371 <li class="google"><a href="/google/index.html"
Robert Ly3c4b4f72012-11-30 04:02:04 -0800372 >Google Services</a>
373 </li>
374 </ul>
375 </div>
376
377 </div>
378 <!-- /Sendondary x-nav -->
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700379
380
381
382
Robert Ly3c4b4f72012-11-30 04:02:04 -0800383
384
Robert Ly3c4b4f72012-11-30 04:02:04 -0800385
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700386
387
Robert Ly3c4b4f72012-11-30 04:02:04 -0800388 <div class="wrap clearfix" id="body-content">
389 <div class="col-4" id="side-nav" itemscope itemtype="http://schema.org/SiteNavigationElement">
390 <div id="devdoc-nav" class="scroll-pane">
391<a class="totop" href="#top" data-g-event="left-nav-top">to top</a>
392
393
394
395<ul id="nav">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700396
Robert Ly3c4b4f72012-11-30 04:02:04 -0800397 <li class="nav-section">
398 <div class="nav-section-header empty"><a href="/google/index.html">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700399 <span class="en">Overview</span>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800400 </a></div>
401 </li>
402
403 <li class="nav-section">
Dirk Doughertya38ca332013-05-15 02:36:33 -0700404 <div class="nav-section-header empty"><a href="/google/play-services/games.html">
405 <span class="en">Games</span>
406 </a></div>
407 </li>
408 <li class="nav-section">
409 <div class="nav-section-header empty"><a href="/google/play-services/location.html">
410 <span class="en">Location</span>
411 </a></div>
412 </li>
413 <li class="nav-section">
414 <div class="nav-section-header empty"><a href="/google/play-services/plus.html">
415 <span class="en">Google+</span>
416 </a></div>
417 </li>
418 <li class="nav-section">
419 <div class="nav-section-header empty"><a href="/google/play-services/maps.html">
420 <span class="en">Google Maps</span>
421 </a></div>
422 </li>
423 <li class="nav-section">
424 <div class="nav-section-header empty"><a href="/google/play-services/auth.html">
425 <span class="en">Authorization</span>
426 </a></div>
427 </li>
428
429
430
431 <li class="nav-section">
Robert Ly3c4b4f72012-11-30 04:02:04 -0800432 <div class="nav-section-header"><a href="/google/play-services/index.html">
Robert Lyd84d5cc2013-01-04 10:13:35 -0800433 <span class="en">Google Play Services</span></a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800434 </div>
435 <ul>
436 <li><a href="/google/play-services/setup.html">
437 <span class="en">Setup</span></a>
438 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800439 <li id="gms-tree-list" class="nav-section">
440 <div class="nav-section-header">
441 <a href="/reference/gms-packages.html">
442 <span class="en">Reference</span>
443 </a>
444 <div>
445 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800446 </ul>
447 </li>
448
Robert Lyd84d5cc2013-01-04 10:13:35 -0800449
Robert Ly3c4b4f72012-11-30 04:02:04 -0800450 <li class="nav-section">
451 <div class="nav-section-header"><a href="/google/play/billing/index.html">
Robert Ly672b3ad2012-11-30 16:15:46 -0800452 <span class="en">Google Play In-app Billing</span></a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800453 </div>
454 <ul>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800455 <li><a href="/google/play/billing/billing_overview.html">
456 <span class="en">Overview</span></a>
457 </li>
458 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/api.html">
459 <span class="en">Version 3 API</span></a></div>
460 <ul>
461 <li><a href="/google/play/billing/billing_integrate.html">
462 <span class="en">Implementing the API</span></a></li>
463 <li><a href="/google/play/billing/billing_reference.html">
464 <span class="en">Reference</span></a></li>
465 </ul>
466 </li>
467 <li class="nav-section"><div class="nav-section-header"><a href="/google/play/billing/v2/api.html">
468 <span class="en">Version 2 API</span></a></div>
469 <ul>
470 <li><a href="/google/play/billing/v2/billing_integrate.html">
471 <span class="en">Implementing the API</span></a></li>
472 <li><a href="/google/play/billing/v2/billing_subscriptions.html">
473 <span class="en">Subscriptions</span></a></li>
474 <li><a href="/google/play/billing/v2/billing_reference.html">
475 <span class="en">Reference</span></a></li>
476 </ul>
477 </li>
Robert Ly05c8e632013-02-25 14:43:01 -0800478 <li><a href="/google/play/billing/billing_subscriptions.html">
479 <span class="en">Subscriptions</span></a>
480 </li>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800481 <li><a href="/google/play/billing/billing_best_practices.html">
Robert Ly3c4b4f72012-11-30 04:02:04 -0800482 <span class="en">Security and Design</span></a>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800483 </li>
484 <li><a href="/google/play/billing/billing_testing.html">
Robert Ly555c93b2012-12-03 12:24:07 -0800485 <span class="en">Testing In-app Billing</span></a>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800486 </li>
487 <li><a href="/google/play/billing/billing_admin.html">
Robert Ly3c4b4f72012-11-30 04:02:04 -0800488 <span class="en">Administering In-app Billing</span></a>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800489 </li>
Dirk Doughertyfe3da792013-06-12 18:06:08 -0700490 <li><a href="/google/play/billing/gp-purchase-status-api.html">
491 <span class="en">Purchase Status API</span></a>
492 </li>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800493 <li><a href="/google/play/billing/versions.html">
494 <span class="en">Version Notes</span></a>
495 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800496 </ul>
497 </li>
498
Dirk Doughertya38ca332013-05-15 02:36:33 -0700499
500
501 <li class="nav-section">
502 <div class="nav-section-header"><a href="/google/gcm/index.html">
503 <span class="en">Google Cloud Messaging</span></a>
504 </div>
505 <ul>
506 <li><a href="/google/gcm/gs.html">
507 <span class="en">Getting Started</span></a>
508 </li>
509 <li><a href="/google/gcm/gcm.html">
510 <span class="en">Architectural Overview</span></a>
511 </li>
Dirk Doughertyfe3da792013-06-12 18:06:08 -0700512 <li><a href="/google/gcm/ccs.html">
513 <span class="en">Cloud Connection Server</span></a>
514 </li>
515 <li><a href="/google/gcm/notifications.html">
516 <span class="en">User Notifications</span></a>
517 </li>
518 <li><a href="/google/gcm/client.html">
519 <span class="en">GCM Client</span></a>
520 </li>
521 <li><a href="/google/gcm/server.html">
522 <span class="en">GCM Server</span></a>
Dirk Doughertya38ca332013-05-15 02:36:33 -0700523 </li>
524 <li><a href="/google/gcm/adv.html">
525 <span class="en">Advanced Topics</span></a>
526 </li>
527 <li><a href="/google/gcm/c2dm.html">
528 <span class="en">Migration</span></a>
529 </li>
530 <li id="gcm-tree-list" class="nav-section">
531 <div class="nav-section-header">
532 <a href="/reference/gcm-packages.html">
533 <span class="en">Reference</span>
534 </a>
535 <div>
536 </li>
537 </ul>
538 </li>
539
Robert Ly3c4b4f72012-11-30 04:02:04 -0800540 <li class="nav-section">
541 <div class="nav-section-header"><a href="/google/play/dist.html">
Robert Ly672b3ad2012-11-30 16:15:46 -0800542 <span class="en">Google Play Distribution</span></a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800543 </div>
544 <ul>
545 <li><a href="/google/play/filters.html">
546 <span class="en">Filters on Google Play</span></a>
547 </li>
548
549 <li><a href="/google/play/publishing/multiple-apks.html">
550 <span class="en">Multiple APK Support</span></a>
551 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800552 <li><a href="/google/play/expansion-files.html">
553 <span class="en">APK Expansion Files</span></a>
554 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800555 <li class="nav-section">
556 <div class="nav-section-header"><a href="/google/play/licensing/index.html">
557 <span class="en">Application Licensing</span></a>
558 </div>
559 <ul>
560 <li><a href="/google/play/licensing/overview.html">
561 <span class="en">Licensing Overview</span></a>
562 </li>
563 <li><a href="/google/play/licensing/setting-up.html">
564 <span class="en">Setting Up for Licensing</span></a>
565 </li>
566 <li><a href="/google/play/licensing/adding-licensing.html">
567 <span class="en">Adding Licensing to Your App</span></a>
568 </li>
569 <li><a href="/google/play/licensing/licensing-reference.html">
570 <span class="en">Licensing Reference</span></a>
571 </li>
572 </ul>
573 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800574
Robert Lyd84d5cc2013-01-04 10:13:35 -0800575 <li class="nav-section">
576 <div class="nav-section-header"><a href="/google/backup/index.html">
577 Android Backup Service</a>
578 </div>
579 <ul>
580 <li><a href="/google/backup/signup.html">
581 Register</a>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800582 </li>
Robert Lyd84d5cc2013-01-04 10:13:35 -0800583 </ul>
584 </li>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800585
Dirk Doughertya38ca332013-05-15 02:36:33 -0700586 </ul>
587
588</li>
589
590
591
Robert Ly3c4b4f72012-11-30 04:02:04 -0800592</ul>
593
594<script type="text/javascript">
595<!--
596 buildToggleLists();
597 changeNavLang(getLangPref());
598//-->
599</script>
600
601
602
603
604 </div>
605 <script type="text/javascript">
606 showGoogleRefTree();
607
608 </script>
609 </div> <!-- end side-nav -->
610 <script>
611 $(document).ready(function() {
612 scrollIntoView("devdoc-nav");
613 });
614 </script>
615
616
Dirk Dougherty4af1bf82013-05-09 15:04:08 -0700617
618
Robert Ly3c4b4f72012-11-30 04:02:04 -0800619
620
621<div class="col-12" id="doc-col">
622
623<div id="api-info-block">
624
625
626
627
628
629
630
631
632
633
634
635<div class="sum-details-links">
636
637Summary:
638
639
640
641
642
643
644
645
646
647
648
649 <a href="#pubmethods">Methods</a>
650
651
652
653
654 &#124; <a href="#inhmethods">Inherited Methods</a>
655
656&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>
657
658</div><!-- end sum-details-links -->
659<div class="api-level">
660
661
662
663
664</div>
665</div><!-- end api-info-block -->
666
667
668<!-- ======== START OF CLASS DATA ======== -->
669
670<div id="jd-header">
671 public
672
673 final
674
675 class
676<h1 itemprop="name">GroundOverlay</h1>
677
678
679
680
Robert Ly672b3ad2012-11-30 16:15:46 -0800681 extends Object<br/>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800682
683
684
685
686
687
688
689
690
691</div><!-- end header -->
692
693<div id="naMessage"></div>
694
695<div id="jd-content" class="api apilevel-">
696<table class="jd-inheritance-table">
697
698
699 <tr>
700
Robert Ly672b3ad2012-11-30 16:15:46 -0800701 <td colspan="2" class="jd-inheritance-class-cell">java.lang.Object</td>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800702 </tr>
703
704
705 <tr>
706
707 <td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;&#x21b3;</td>
708
709 <td colspan="1" class="jd-inheritance-class-cell">com.google.android.gms.maps.model.GroundOverlay</td>
710 </tr>
711
712
713</table>
714
715
716
717
718
719
720
721<div class="jd-descr">
722
723
724<h2>Class Overview</h2>
725<p itemprop="articleBody">A ground overlay is an image that is fixed to a map. A ground overlay has the following
726 properties:
727 <p>
728 <dl>
729 <dt>Position</dt>
730 <dd>There are two ways to specify the position of the ground overlay:
731 <ul>
732 <li>Using an location: You must provide an image of the ground overlay, a <code><a href="/reference/com/google/android/gms/maps/model/LatLng.html">LatLng</a></code> to which
733 the anchor will be fixed and the width of the overlay (in meters). The anchor is by default 50%
734 from the top of the image and 50% from the left of the image. This can be changed. You can
735 optionally provide the height of the overlay (in meters). If you do not provide the height of the
736 overlay, it will be automatically calculated to preserve the proportions of the image.</li>
737 <li>Using a Bounds: You must provide a <code><a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a></code> which will contain the image.</li>
738 </ul>
739 You must specify the position of the ground overlay before it is added to the map, otherwise an
Robert Ly672b3ad2012-11-30 16:15:46 -0800740 <code><a href="/reference/java/lang/IllegalArgumentException.html">IllegalArgumentException</a></code> will be thrown when the ground overlay is added to the map.
Robert Ly3c4b4f72012-11-30 04:02:04 -0800741 Furthermore, you must only specify the position using one of these methods in the
Robert Ly672b3ad2012-11-30 16:15:46 -0800742 <code><a href="/reference/com/google/android/gms/maps/model/GroundOverlayOptions.html">GroundOverlayOptions</a></code> object; otherwise an <code><a href="/reference/java/lang/IllegalStateException.html">IllegalStateException</a></code> will be thrown
Robert Ly3c4b4f72012-11-30 04:02:04 -0800743 when specifying using a second method.</dd>
744 <dt>Image</dt>
745 <dd>The image (as an <code><a href="/reference/com/google/android/gms/maps/model/BitmapDescriptor.html">BitmapDescriptor</a></code>) to be used for this overlay. The image will be
746 scaled to fit the position provided. You cannot change the image used in the ground overlay once
747 it has been added to the map. You must specify an image before adding the ground overlay to the
Robert Ly672b3ad2012-11-30 16:15:46 -0800748 map; if not an <code><a href="/reference/java/lang/IllegalArgumentException.html">IllegalArgumentException</a></code> will be thrown when it is added to the map.</dd>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800749 <dt>Bearing</dt>
750 <dd>The amount that the image should be rotated in a clockwise direction. The center of the
751 rotation will be the image's anchor. This is optional and the default bearing is 0, i.e., the
752 image is aligned so that up is north.</dd>
753 <dt>zIndex</dt>
754 <dd>The order in which this ground overlay is drawn with respect to other overlays (including
755 <code><a href="/reference/com/google/android/gms/maps/model/Polyline.html">Polyline</a></code>s and <code><a href="/reference/com/google/android/gms/maps/model/TileOverlay.html">TileOverlay</a></code>s, but not <code><a href="/reference/com/google/android/gms/maps/model/Marker.html">Marker</a></code>s). An overlay with a larger
756 zIndex is drawn over overlays with smaller zIndexes. The order of overlays with the same zIndex
757 value is arbitrary. This is optional and the default zIndex is 0.</dd>
758 <dt>Transparency</dt>
759 <dd>Transparency of the ground overlay in the range <code>[0..1]</code> where <code>0</code> means the
760 overlay is opaque and <code>1</code> means the overlay is fully transparent. If the specified bitmap
761 is already partially transparent, the transparency of each pixel will be scaled accordingly (e.g.
762 if a pixel in the bitmap has an alpha value of 200 and you specify the transparency of the ground
763 overlay as 0.25, then the pixel will be rendered on the screen with an alpha value of 150). This
764 is optional and the default transparency is 0 (opaque).</dd>
765 <dt>Visibility</dt>
766 <dd>Indicates if the ground overlay is visible or invisible, i.e. whether it is drawn on the map.
767 An invisible ground overlay is not drawn, but retains all of its other properties. This is
768 optional and the default visibility is <code>true</code>, i.e., visible.</dd>
769 </dl>
770 Methods that modify a Polyline must be called on the UI thread. If not, an
Robert Ly672b3ad2012-11-30 16:15:46 -0800771 <code><a href="/reference/java/lang/IllegalStateException.html">IllegalStateException</a></code> will be thrown at runtime.
Robert Ly3c4b4f72012-11-30 04:02:04 -0800772 <h3>Example</h3>
773
774 <pre> <code>GoogleMap map = ...; // get a map.
775 BitmapDescriptor image = ...; // get an image.
776 LatLngBounds bounds = ...; // get a bounds
777 // Adds a ground overlay with 50% transparency.
778 GroundOverlay groundOverlay = map.addGroundOverlay(new GroundOverlayOptions()
779 .image(image)
780 .positionFromBounds(bounds)
781 .transparency(0.5));</code></pre>
782</p>
783
784
785
786
787
788</div><!-- jd-descr -->
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805<div class="jd-descr">
806
807
808<h2>Summary</h2>
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836<!-- ========== METHOD SUMMARY =========== -->
837<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
838
839
840
841
842 <tr class="alt-color api apilevel-" >
843 <td class="jd-typecol"><nobr>
844
845
846
847
848
849 boolean</nobr>
850 </td>
851 <td class="jd-linkcol" width="100%"><nobr>
Robert Ly672b3ad2012-11-30 16:15:46 -0800852 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#equals(java.lang.Object)">equals</a></span>(Object other)</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800853
854 </td></tr>
855
856
857
858 <tr class=" api apilevel-" >
859 <td class="jd-typecol"><nobr>
860
861
862
863
864
865 float</nobr>
866 </td>
867 <td class="jd-linkcol" width="100%"><nobr>
868 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getBearing()">getBearing</a></span>()</nobr>
869
870 <div class="jd-descrdiv">Gets the bearing of the ground overlay in degrees clockwise from north.</div>
871
872 </td></tr>
873
874
875
876 <tr class="alt-color api apilevel-" >
877 <td class="jd-typecol"><nobr>
878
879
880
881
882
883 <a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a></nobr>
884 </td>
885 <td class="jd-linkcol" width="100%"><nobr>
886 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getBounds()">getBounds</a></span>()</nobr>
887
888 <div class="jd-descrdiv">Gets the bounds for the ground overlay.</div>
889
890 </td></tr>
891
892
893
894 <tr class=" api apilevel-" >
895 <td class="jd-typecol"><nobr>
896
897
898
899
900
901 float</nobr>
902 </td>
903 <td class="jd-linkcol" width="100%"><nobr>
904 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getHeight()">getHeight</a></span>()</nobr>
905
906 <div class="jd-descrdiv">Gets the height of the ground overlay.</div>
907
908 </td></tr>
909
910
911
912 <tr class="alt-color api apilevel-" >
913 <td class="jd-typecol"><nobr>
914
915
916
917
918
Robert Ly672b3ad2012-11-30 16:15:46 -0800919 String</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -0800920 </td>
921 <td class="jd-linkcol" width="100%"><nobr>
922 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getId()">getId</a></span>()</nobr>
923
924 <div class="jd-descrdiv">Gets this ground overlay's id.</div>
925
926 </td></tr>
927
928
929
930 <tr class=" api apilevel-" >
931 <td class="jd-typecol"><nobr>
932
933
934
935
936
937 <a href="/reference/com/google/android/gms/maps/model/LatLng.html">LatLng</a></nobr>
938 </td>
939 <td class="jd-linkcol" width="100%"><nobr>
940 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getPosition()">getPosition</a></span>()</nobr>
941
942 <div class="jd-descrdiv">Gets the location of the anchored point.</div>
943
944 </td></tr>
945
946
947
948 <tr class="alt-color api apilevel-" >
949 <td class="jd-typecol"><nobr>
950
951
952
953
954
955 float</nobr>
956 </td>
957 <td class="jd-linkcol" width="100%"><nobr>
958 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getTransparency()">getTransparency</a></span>()</nobr>
959
960 <div class="jd-descrdiv">Gets the transparency of this ground overlay.</div>
961
962 </td></tr>
963
964
965
966 <tr class=" api apilevel-" >
967 <td class="jd-typecol"><nobr>
968
969
970
971
972
973 float</nobr>
974 </td>
975 <td class="jd-linkcol" width="100%"><nobr>
976 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getWidth()">getWidth</a></span>()</nobr>
977
978 <div class="jd-descrdiv">Gets the width of the ground overlay.</div>
979
980 </td></tr>
981
982
983
984 <tr class="alt-color api apilevel-" >
985 <td class="jd-typecol"><nobr>
986
987
988
989
990
991 float</nobr>
992 </td>
993 <td class="jd-linkcol" width="100%"><nobr>
994 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#getZIndex()">getZIndex</a></span>()</nobr>
995
996 <div class="jd-descrdiv">Gets the zIndex of this ground overlay.</div>
997
998 </td></tr>
999
1000
1001
1002 <tr class=" api apilevel-" >
1003 <td class="jd-typecol"><nobr>
1004
1005
1006
1007
1008
1009 int</nobr>
1010 </td>
1011 <td class="jd-linkcol" width="100%"><nobr>
1012 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#hashCode()">hashCode</a></span>()</nobr>
1013
1014 </td></tr>
1015
1016
1017
1018 <tr class="alt-color api apilevel-" >
1019 <td class="jd-typecol"><nobr>
1020
1021
1022
1023
1024
1025 boolean</nobr>
1026 </td>
1027 <td class="jd-linkcol" width="100%"><nobr>
1028 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#isVisible()">isVisible</a></span>()</nobr>
1029
1030 <div class="jd-descrdiv">Gets the visibility of this ground overlay.</div>
1031
1032 </td></tr>
1033
1034
1035
1036 <tr class=" api apilevel-" >
1037 <td class="jd-typecol"><nobr>
1038
1039
1040
1041
1042
1043 void</nobr>
1044 </td>
1045 <td class="jd-linkcol" width="100%"><nobr>
1046 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#remove()">remove</a></span>()</nobr>
1047
1048 <div class="jd-descrdiv">Removes this ground overlay from the map.</div>
1049
1050 </td></tr>
1051
1052
1053
1054 <tr class="alt-color api apilevel-" >
1055 <td class="jd-typecol"><nobr>
1056
1057
1058
1059
1060
1061 void</nobr>
1062 </td>
1063 <td class="jd-linkcol" width="100%"><nobr>
1064 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setBearing(float)">setBearing</a></span>(float bearing)</nobr>
1065
1066 <div class="jd-descrdiv">Sets the bearing of the ground overlay (the direction that the vertical axis of the ground
1067 overlay points) in degrees clockwise from north.</div>
1068
1069 </td></tr>
1070
1071
1072
1073 <tr class=" api apilevel-" >
1074 <td class="jd-typecol"><nobr>
1075
1076
1077
1078
1079
1080 void</nobr>
1081 </td>
1082 <td class="jd-linkcol" width="100%"><nobr>
1083 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setDimensions(float)">setDimensions</a></span>(float width)</nobr>
1084
1085 <div class="jd-descrdiv">Sets the dimensions of the ground overlay.</div>
1086
1087 </td></tr>
1088
1089
1090
1091 <tr class="alt-color api apilevel-" >
1092 <td class="jd-typecol"><nobr>
1093
1094
1095
1096
1097
1098 void</nobr>
1099 </td>
1100 <td class="jd-linkcol" width="100%"><nobr>
1101 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setDimensions(float, float)">setDimensions</a></span>(float width, float height)</nobr>
1102
1103 <div class="jd-descrdiv">Sets the dimensions of the ground overlay.</div>
1104
1105 </td></tr>
1106
1107
1108
1109 <tr class=" api apilevel-" >
1110 <td class="jd-typecol"><nobr>
1111
1112
1113
1114
1115
1116 void</nobr>
1117 </td>
1118 <td class="jd-linkcol" width="100%"><nobr>
1119 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setPosition(com.google.android.gms.maps.model.LatLng)">setPosition</a></span>(<a href="/reference/com/google/android/gms/maps/model/LatLng.html">LatLng</a> latLng)</nobr>
1120
1121 <div class="jd-descrdiv">Sets the position of the ground overlay by changing the location of the anchored point.</div>
1122
1123 </td></tr>
1124
1125
1126
1127 <tr class="alt-color api apilevel-" >
1128 <td class="jd-typecol"><nobr>
1129
1130
1131
1132
1133
1134 void</nobr>
1135 </td>
1136 <td class="jd-linkcol" width="100%"><nobr>
1137 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setPositionFromBounds(com.google.android.gms.maps.model.LatLngBounds)">setPositionFromBounds</a></span>(<a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a> bounds)</nobr>
1138
1139 <div class="jd-descrdiv">Sets the position of the ground overlay by fitting it to the given <code><a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a></code>.</div>
1140
1141 </td></tr>
1142
1143
1144
1145 <tr class=" api apilevel-" >
1146 <td class="jd-typecol"><nobr>
1147
1148
1149
1150
1151
1152 void</nobr>
1153 </td>
1154 <td class="jd-linkcol" width="100%"><nobr>
1155 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setTransparency(float)">setTransparency</a></span>(float transparency)</nobr>
1156
1157 <div class="jd-descrdiv">Sets the transparency of this ground overlay.</div>
1158
1159 </td></tr>
1160
1161
1162
1163 <tr class="alt-color api apilevel-" >
1164 <td class="jd-typecol"><nobr>
1165
1166
1167
1168
1169
1170 void</nobr>
1171 </td>
1172 <td class="jd-linkcol" width="100%"><nobr>
1173 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setVisible(boolean)">setVisible</a></span>(boolean visible)</nobr>
1174
1175 <div class="jd-descrdiv">Sets the visibility of this ground overlay.</div>
1176
1177 </td></tr>
1178
1179
1180
1181 <tr class=" api apilevel-" >
1182 <td class="jd-typecol"><nobr>
1183
1184
1185
1186
1187
1188 void</nobr>
1189 </td>
1190 <td class="jd-linkcol" width="100%"><nobr>
1191 <span class="sympad"><a href="/reference/com/google/android/gms/maps/model/GroundOverlay.html#setZIndex(float)">setZIndex</a></span>(float zIndex)</nobr>
1192
1193 <div class="jd-descrdiv">Sets the zIndex of this ground overlay.</div>
1194
1195 </td></tr>
1196
1197
1198
1199</table>
1200
1201
1202
1203
1204
1205
1206
1207<!-- ========== METHOD SUMMARY =========== -->
1208<table id="inhmethods" class="jd-sumtable"><tr><th>
1209 <a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
1210 <div style="clear:left;">Inherited Methods</div></th></tr>
1211
1212
1213<tr class="api apilevel-" >
1214<td colspan="12">
1215 <a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
1216 ><img id="inherited-methods-java.lang.Object-trigger"
1217 src="/assets/images/triangle-closed.png"
1218 class="jd-expando-trigger-img" /></a>
1219From class
1220
Robert Ly672b3ad2012-11-30 16:15:46 -08001221 java.lang.Object
Robert Ly3c4b4f72012-11-30 04:02:04 -08001222
1223<div id="inherited-methods-java.lang.Object">
1224 <div id="inherited-methods-java.lang.Object-list"
1225 class="jd-inheritedlinks">
1226 </div>
1227 <div id="inherited-methods-java.lang.Object-summary" style="display: none;">
1228 <table class="jd-sumtable-expando">
1229
1230
1231
1232
1233 <tr class="alt-color api apilevel-" >
1234 <td class="jd-typecol"><nobr>
1235
1236
1237
1238
1239
Robert Ly672b3ad2012-11-30 16:15:46 -08001240 Object</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001241 </td>
1242 <td class="jd-linkcol" width="100%"><nobr>
1243 <span class="sympad">clone</span>()</nobr>
1244
1245 </td></tr>
1246
1247
1248
1249 <tr class=" api apilevel-" >
1250 <td class="jd-typecol"><nobr>
1251
1252
1253
1254
1255
1256 boolean</nobr>
1257 </td>
1258 <td class="jd-linkcol" width="100%"><nobr>
Robert Ly672b3ad2012-11-30 16:15:46 -08001259 <span class="sympad">equals</span>(Object arg0)</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001260
1261 </td></tr>
1262
1263
1264
1265 <tr class="alt-color api apilevel-" >
1266 <td class="jd-typecol"><nobr>
1267
1268
1269
1270
1271
1272 void</nobr>
1273 </td>
1274 <td class="jd-linkcol" width="100%"><nobr>
1275 <span class="sympad">finalize</span>()</nobr>
1276
1277 </td></tr>
1278
1279
1280
1281 <tr class=" api apilevel-" >
1282 <td class="jd-typecol"><nobr>
1283
1284
1285 final
1286
1287
Robert Ly672b3ad2012-11-30 16:15:46 -08001288 Class&lt;?&gt;</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001289 </td>
1290 <td class="jd-linkcol" width="100%"><nobr>
1291 <span class="sympad">getClass</span>()</nobr>
1292
1293 </td></tr>
1294
1295
1296
1297 <tr class="alt-color api apilevel-" >
1298 <td class="jd-typecol"><nobr>
1299
1300
1301
1302
1303
1304 int</nobr>
1305 </td>
1306 <td class="jd-linkcol" width="100%"><nobr>
1307 <span class="sympad">hashCode</span>()</nobr>
1308
1309 </td></tr>
1310
1311
1312
1313 <tr class=" api apilevel-" >
1314 <td class="jd-typecol"><nobr>
1315
1316
1317 final
1318
1319
1320 void</nobr>
1321 </td>
1322 <td class="jd-linkcol" width="100%"><nobr>
1323 <span class="sympad">notify</span>()</nobr>
1324
1325 </td></tr>
1326
1327
1328
1329 <tr class="alt-color api apilevel-" >
1330 <td class="jd-typecol"><nobr>
1331
1332
1333 final
1334
1335
1336 void</nobr>
1337 </td>
1338 <td class="jd-linkcol" width="100%"><nobr>
1339 <span class="sympad">notifyAll</span>()</nobr>
1340
1341 </td></tr>
1342
1343
1344
1345 <tr class=" api apilevel-" >
1346 <td class="jd-typecol"><nobr>
1347
1348
1349
1350
1351
Robert Ly672b3ad2012-11-30 16:15:46 -08001352 String</nobr>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001353 </td>
1354 <td class="jd-linkcol" width="100%"><nobr>
1355 <span class="sympad">toString</span>()</nobr>
1356
1357 </td></tr>
1358
1359
1360
1361 <tr class="alt-color api apilevel-" >
1362 <td class="jd-typecol"><nobr>
1363
1364
1365 final
1366
1367
1368 void</nobr>
1369 </td>
1370 <td class="jd-linkcol" width="100%"><nobr>
1371 <span class="sympad">wait</span>()</nobr>
1372
1373 </td></tr>
1374
1375
1376
1377 <tr class=" api apilevel-" >
1378 <td class="jd-typecol"><nobr>
1379
1380
1381 final
1382
1383
1384 void</nobr>
1385 </td>
1386 <td class="jd-linkcol" width="100%"><nobr>
1387 <span class="sympad">wait</span>(long arg0, int arg1)</nobr>
1388
1389 </td></tr>
1390
1391
1392
1393 <tr class="alt-color api apilevel-" >
1394 <td class="jd-typecol"><nobr>
1395
1396
1397 final
1398
1399
1400 void</nobr>
1401 </td>
1402 <td class="jd-linkcol" width="100%"><nobr>
1403 <span class="sympad">wait</span>(long arg0)</nobr>
1404
1405 </td></tr>
1406
1407
1408</table>
1409 </div>
1410</div>
1411</td></tr>
1412
1413
1414</table>
1415
1416
1417</div><!-- jd-descr (summary) -->
1418
1419<!-- Details -->
1420
1421
1422
1423
1424
1425
1426
1427
1428<!-- XML Attributes -->
1429
1430
1431<!-- Enum Values -->
1432
1433
1434<!-- Constants -->
1435
1436
1437<!-- Fields -->
1438
1439
1440<!-- Public ctors -->
1441
1442
1443
1444<!-- ========= CONSTRUCTOR DETAIL ======== -->
1445<!-- Protected ctors -->
1446
1447
1448
1449<!-- ========= METHOD DETAIL ======== -->
1450<!-- Public methdos -->
1451
1452<h2>Public Methods</h2>
1453
1454
1455
1456<A NAME="equals(java.lang.Object)"></A>
1457
1458<div class="jd-details api apilevel-">
1459 <h4 class="jd-details-title">
1460 <span class="normal">
1461 public
1462
1463
1464
1465
1466 boolean
1467 </span>
1468 <span class="sympad">equals</span>
Robert Ly672b3ad2012-11-30 16:15:46 -08001469 <span class="normal">(Object other)</span>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001470 </h4>
1471 <div class="api-level">
1472 <div></div>
1473
1474
1475
1476 </div>
1477 <div class="jd-details-descr">
1478
1479 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1480
1481 </div>
1482</div>
1483
1484
1485<A NAME="getBearing()"></A>
1486
1487<div class="jd-details api apilevel-">
1488 <h4 class="jd-details-title">
1489 <span class="normal">
1490 public
1491
1492
1493
1494
1495 float
1496 </span>
1497 <span class="sympad">getBearing</span>
1498 <span class="normal">()</span>
1499 </h4>
1500 <div class="api-level">
1501 <div></div>
1502
1503
1504
1505 </div>
1506 <div class="jd-details-descr">
1507
1508 <div class="jd-tagdata jd-tagdescr"><p>Gets the bearing of the ground overlay in degrees clockwise from north.</p></div>
1509 <div class="jd-tagdata">
1510 <h5 class="jd-tagtitle">Returns</h5>
1511 <ul class="nolist"><li>the bearing of the ground overlay.
1512</li></ul>
1513 </div>
1514
1515 </div>
1516</div>
1517
1518
1519<A NAME="getBounds()"></A>
1520
1521<div class="jd-details api apilevel-">
1522 <h4 class="jd-details-title">
1523 <span class="normal">
1524 public
1525
1526
1527
1528
1529 <a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a>
1530 </span>
1531 <span class="sympad">getBounds</span>
1532 <span class="normal">()</span>
1533 </h4>
1534 <div class="api-level">
1535 <div></div>
1536
1537
1538
1539 </div>
1540 <div class="jd-details-descr">
1541
1542 <div class="jd-tagdata jd-tagdescr"><p>Gets the bounds for the ground overlay. This ignores the rotation of the ground overlay.</p></div>
1543 <div class="jd-tagdata">
1544 <h5 class="jd-tagtitle">Returns</h5>
1545 <ul class="nolist"><li>a <code><a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a></code> that contains the ground overlay, ignoring rotation.
1546</li></ul>
1547 </div>
1548
1549 </div>
1550</div>
1551
1552
1553<A NAME="getHeight()"></A>
1554
1555<div class="jd-details api apilevel-">
1556 <h4 class="jd-details-title">
1557 <span class="normal">
1558 public
1559
1560
1561
1562
1563 float
1564 </span>
1565 <span class="sympad">getHeight</span>
1566 <span class="normal">()</span>
1567 </h4>
1568 <div class="api-level">
1569 <div></div>
1570
1571
1572
1573 </div>
1574 <div class="jd-details-descr">
1575
1576 <div class="jd-tagdata jd-tagdescr"><p>Gets the height of the ground overlay.</p></div>
1577 <div class="jd-tagdata">
1578 <h5 class="jd-tagtitle">Returns</h5>
1579 <ul class="nolist"><li>the height of the ground overlay in meters.
1580</li></ul>
1581 </div>
1582
1583 </div>
1584</div>
1585
1586
1587<A NAME="getId()"></A>
1588
1589<div class="jd-details api apilevel-">
1590 <h4 class="jd-details-title">
1591 <span class="normal">
1592 public
1593
1594
1595
1596
Robert Ly672b3ad2012-11-30 16:15:46 -08001597 String
Robert Ly3c4b4f72012-11-30 04:02:04 -08001598 </span>
1599 <span class="sympad">getId</span>
1600 <span class="normal">()</span>
1601 </h4>
1602 <div class="api-level">
1603 <div></div>
1604
1605
1606
1607 </div>
1608 <div class="jd-details-descr">
1609
1610 <div class="jd-tagdata jd-tagdescr"><p>Gets this ground overlay's id.
1611 <p>
Robert Ly672b3ad2012-11-30 16:15:46 -08001612 When a map is restored from a <code><a href="/reference/android/os/Bundle.html">Bundle</a></code>, ground overlays that were on that
Robert Ly3c4b4f72012-11-30 04:02:04 -08001613 map are also restored. However, those ground overlays will then be represented by different
1614 <code>GroundOverlay</code> objects. A ground overlay's id can be used to retrieve the new
Robert Ly05c8e632013-02-25 14:43:01 -08001615 instance of a <code>GroundOverlay</code> object after such restoration.</p></div>
Robert Ly3c4b4f72012-11-30 04:02:04 -08001616 <div class="jd-tagdata">
1617 <h5 class="jd-tagtitle">Returns</h5>
1618 <ul class="nolist"><li>this ground overlay's id.
1619</li></ul>
1620 </div>
1621
1622 </div>
1623</div>
1624
1625
1626<A NAME="getPosition()"></A>
1627
1628<div class="jd-details api apilevel-">
1629 <h4 class="jd-details-title">
1630 <span class="normal">
1631 public
1632
1633
1634
1635
1636 <a href="/reference/com/google/android/gms/maps/model/LatLng.html">LatLng</a>
1637 </span>
1638 <span class="sympad">getPosition</span>
1639 <span class="normal">()</span>
1640 </h4>
1641 <div class="api-level">
1642 <div></div>
1643
1644
1645
1646 </div>
1647 <div class="jd-details-descr">
1648
1649 <div class="jd-tagdata jd-tagdescr"><p>Gets the location of the anchored point.</p></div>
1650 <div class="jd-tagdata">
1651 <h5 class="jd-tagtitle">Returns</h5>
1652 <ul class="nolist"><li>the position on the map (a <code><a href="/reference/com/google/android/gms/maps/model/LatLng.html">LatLng</a></code>).
1653</li></ul>
1654 </div>
1655
1656 </div>
1657</div>
1658
1659
1660<A NAME="getTransparency()"></A>
1661
1662<div class="jd-details api apilevel-">
1663 <h4 class="jd-details-title">
1664 <span class="normal">
1665 public
1666
1667
1668
1669
1670 float
1671 </span>
1672 <span class="sympad">getTransparency</span>
1673 <span class="normal">()</span>
1674 </h4>
1675 <div class="api-level">
1676 <div></div>
1677
1678
1679
1680 </div>
1681 <div class="jd-details-descr">
1682
1683 <div class="jd-tagdata jd-tagdescr"><p>Gets the transparency of this ground overlay.</p></div>
1684 <div class="jd-tagdata">
1685 <h5 class="jd-tagtitle">Returns</h5>
1686 <ul class="nolist"><li>the transparency of this ground overlay.
1687</li></ul>
1688 </div>
1689
1690 </div>
1691</div>
1692
1693
1694<A NAME="getWidth()"></A>
1695
1696<div class="jd-details api apilevel-">
1697 <h4 class="jd-details-title">
1698 <span class="normal">
1699 public
1700
1701
1702
1703
1704 float
1705 </span>
1706 <span class="sympad">getWidth</span>
1707 <span class="normal">()</span>
1708 </h4>
1709 <div class="api-level">
1710 <div></div>
1711
1712
1713
1714 </div>
1715 <div class="jd-details-descr">
1716
1717 <div class="jd-tagdata jd-tagdescr"><p>Gets the width of the ground overlay.</p></div>
1718 <div class="jd-tagdata">
1719 <h5 class="jd-tagtitle">Returns</h5>
1720 <ul class="nolist"><li>the width of the ground overlay in meters.
1721</li></ul>
1722 </div>
1723
1724 </div>
1725</div>
1726
1727
1728<A NAME="getZIndex()"></A>
1729
1730<div class="jd-details api apilevel-">
1731 <h4 class="jd-details-title">
1732 <span class="normal">
1733 public
1734
1735
1736
1737
1738 float
1739 </span>
1740 <span class="sympad">getZIndex</span>
1741 <span class="normal">()</span>
1742 </h4>
1743 <div class="api-level">
1744 <div></div>
1745
1746
1747
1748 </div>
1749 <div class="jd-details-descr">
1750
1751 <div class="jd-tagdata jd-tagdescr"><p>Gets the zIndex of this ground overlay.</p></div>
1752 <div class="jd-tagdata">
1753 <h5 class="jd-tagtitle">Returns</h5>
1754 <ul class="nolist"><li>the zIndex of the ground overlay.
1755</li></ul>
1756 </div>
1757
1758 </div>
1759</div>
1760
1761
1762<A NAME="hashCode()"></A>
1763
1764<div class="jd-details api apilevel-">
1765 <h4 class="jd-details-title">
1766 <span class="normal">
1767 public
1768
1769
1770
1771
1772 int
1773 </span>
1774 <span class="sympad">hashCode</span>
1775 <span class="normal">()</span>
1776 </h4>
1777 <div class="api-level">
1778 <div></div>
1779
1780
1781
1782 </div>
1783 <div class="jd-details-descr">
1784
1785 <div class="jd-tagdata jd-tagdescr"><p></p></div>
1786
1787 </div>
1788</div>
1789
1790
1791<A NAME="isVisible()"></A>
1792
1793<div class="jd-details api apilevel-">
1794 <h4 class="jd-details-title">
1795 <span class="normal">
1796 public
1797
1798
1799
1800
1801 boolean
1802 </span>
1803 <span class="sympad">isVisible</span>
1804 <span class="normal">()</span>
1805 </h4>
1806 <div class="api-level">
1807 <div></div>
1808
1809
1810
1811 </div>
1812 <div class="jd-details-descr">
1813
1814 <div class="jd-tagdata jd-tagdescr"><p>Gets the visibility of this ground overlay. Note that this does not return whether the ground
1815 overlay is actually on screen, but whether it will be drawn if it is contained in the
1816 camera's viewport.</p></div>
1817 <div class="jd-tagdata">
1818 <h5 class="jd-tagtitle">Returns</h5>
1819 <ul class="nolist"><li>this ground overlay's visibility.
1820</li></ul>
1821 </div>
1822
1823 </div>
1824</div>
1825
1826
1827<A NAME="remove()"></A>
1828
1829<div class="jd-details api apilevel-">
1830 <h4 class="jd-details-title">
1831 <span class="normal">
1832 public
1833
1834
1835
1836
1837 void
1838 </span>
1839 <span class="sympad">remove</span>
1840 <span class="normal">()</span>
1841 </h4>
1842 <div class="api-level">
1843 <div></div>
1844
1845
1846
1847 </div>
1848 <div class="jd-details-descr">
1849
1850 <div class="jd-tagdata jd-tagdescr"><p>Removes this ground overlay from the map. After a ground overlay has been removed, the
1851 behavior of all its methods is undefined.
1852</p></div>
1853
1854 </div>
1855</div>
1856
1857
1858<A NAME="setBearing(float)"></A>
1859
1860<div class="jd-details api apilevel-">
1861 <h4 class="jd-details-title">
1862 <span class="normal">
1863 public
1864
1865
1866
1867
1868 void
1869 </span>
1870 <span class="sympad">setBearing</span>
1871 <span class="normal">(float bearing)</span>
1872 </h4>
1873 <div class="api-level">
1874 <div></div>
1875
1876
1877
1878 </div>
1879 <div class="jd-details-descr">
1880
1881 <div class="jd-tagdata jd-tagdescr"><p>Sets the bearing of the ground overlay (the direction that the vertical axis of the ground
1882 overlay points) in degrees clockwise from north. The rotation is performed about the anchor
1883 point.</p></div>
1884 <div class="jd-tagdata">
1885 <h5 class="jd-tagtitle">Parameters</h5>
1886 <table class="jd-tagtable">
1887 <tr>
1888 <th>bearing</td>
1889 <td>bearing in degrees clockwise from north
1890</td>
1891 </tr>
1892 </table>
1893 </div>
1894
1895 </div>
1896</div>
1897
1898
1899<A NAME="setDimensions(float)"></A>
1900
1901<div class="jd-details api apilevel-">
1902 <h4 class="jd-details-title">
1903 <span class="normal">
1904 public
1905
1906
1907
1908
1909 void
1910 </span>
1911 <span class="sympad">setDimensions</span>
1912 <span class="normal">(float width)</span>
1913 </h4>
1914 <div class="api-level">
1915 <div></div>
1916
1917
1918
1919 </div>
1920 <div class="jd-details-descr">
1921
1922 <div class="jd-tagdata jd-tagdescr"><p>Sets the dimensions of the ground overlay. The height of the ground overlay will be
1923 calculated to preserve the proportions inherited from the bitmap.</p></div>
1924 <div class="jd-tagdata">
1925 <h5 class="jd-tagtitle">Parameters</h5>
1926 <table class="jd-tagtable">
1927 <tr>
1928 <th>width</td>
1929 <td>width in meters
1930</td>
1931 </tr>
1932 </table>
1933 </div>
1934
1935 </div>
1936</div>
1937
1938
1939<A NAME="setDimensions(float, float)"></A>
1940
1941<div class="jd-details api apilevel-">
1942 <h4 class="jd-details-title">
1943 <span class="normal">
1944 public
1945
1946
1947
1948
1949 void
1950 </span>
1951 <span class="sympad">setDimensions</span>
1952 <span class="normal">(float width, float height)</span>
1953 </h4>
1954 <div class="api-level">
1955 <div></div>
1956
1957
1958
1959 </div>
1960 <div class="jd-details-descr">
1961
1962 <div class="jd-tagdata jd-tagdescr"><p>Sets the dimensions of the ground overlay. The image will be stretched (and hence may not
1963 retain its proportions) to fit these dimensions.</p></div>
1964 <div class="jd-tagdata">
1965 <h5 class="jd-tagtitle">Parameters</h5>
1966 <table class="jd-tagtable">
1967 <tr>
1968 <th>width</td>
1969 <td>width in meters</td>
1970 </tr>
1971 <tr>
1972 <th>height</td>
1973 <td>height in meters
1974</td>
1975 </tr>
1976 </table>
1977 </div>
1978
1979 </div>
1980</div>
1981
1982
1983<A NAME="setPosition(com.google.android.gms.maps.model.LatLng)"></A>
1984
1985<div class="jd-details api apilevel-">
1986 <h4 class="jd-details-title">
1987 <span class="normal">
1988 public
1989
1990
1991
1992
1993 void
1994 </span>
1995 <span class="sympad">setPosition</span>
1996 <span class="normal">(<a href="/reference/com/google/android/gms/maps/model/LatLng.html">LatLng</a> latLng)</span>
1997 </h4>
1998 <div class="api-level">
1999 <div></div>
2000
2001
2002
2003 </div>
2004 <div class="jd-details-descr">
2005
2006 <div class="jd-tagdata jd-tagdescr"><p>Sets the position of the ground overlay by changing the location of the anchored point.
2007 Preserves all other properties of the image.</p></div>
2008 <div class="jd-tagdata">
2009 <h5 class="jd-tagtitle">Parameters</h5>
2010 <table class="jd-tagtable">
2011 <tr>
2012 <th>latLng</td>
2013 <td>a <code><a href="/reference/com/google/android/gms/maps/model/LatLng.html">LatLng</a></code> that is the new location to place the anchor point.
2014</td>
2015 </tr>
2016 </table>
2017 </div>
2018
2019 </div>
2020</div>
2021
2022
2023<A NAME="setPositionFromBounds(com.google.android.gms.maps.model.LatLngBounds)"></A>
2024
2025<div class="jd-details api apilevel-">
2026 <h4 class="jd-details-title">
2027 <span class="normal">
2028 public
2029
2030
2031
2032
2033 void
2034 </span>
2035 <span class="sympad">setPositionFromBounds</span>
2036 <span class="normal">(<a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a> bounds)</span>
2037 </h4>
2038 <div class="api-level">
2039 <div></div>
2040
2041
2042
2043 </div>
2044 <div class="jd-details-descr">
2045
2046 <div class="jd-tagdata jd-tagdescr"><p>Sets the position of the ground overlay by fitting it to the given <code><a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a></code>. This
2047 method will ignore the rotation (bearing) of the ground overlay when positioning it, but the
2048 bearing will still be used when drawing it.</p></div>
2049 <div class="jd-tagdata">
2050 <h5 class="jd-tagtitle">Parameters</h5>
2051 <table class="jd-tagtable">
2052 <tr>
2053 <th>bounds</td>
2054 <td>a <code><a href="/reference/com/google/android/gms/maps/model/LatLngBounds.html">LatLngBounds</a></code> in which to place the ground overlay
2055</td>
2056 </tr>
2057 </table>
2058 </div>
2059
2060 </div>
2061</div>
2062
2063
2064<A NAME="setTransparency(float)"></A>
2065
2066<div class="jd-details api apilevel-">
2067 <h4 class="jd-details-title">
2068 <span class="normal">
2069 public
2070
2071
2072
2073
2074 void
2075 </span>
2076 <span class="sympad">setTransparency</span>
2077 <span class="normal">(float transparency)</span>
2078 </h4>
2079 <div class="api-level">
2080 <div></div>
2081
2082
2083
2084 </div>
2085 <div class="jd-details-descr">
2086
2087 <div class="jd-tagdata jd-tagdescr"><p>Sets the transparency of this ground overlay. See the documentation at the top of this class
2088 for more information.</p></div>
2089 <div class="jd-tagdata">
2090 <h5 class="jd-tagtitle">Parameters</h5>
2091 <table class="jd-tagtable">
2092 <tr>
2093 <th>transparency</td>
2094 <td>a float in the range <code>[0..1]</code> where <code>0</code> means that the ground
2095 overlay is opaque and <code>1</code> means that the ground overlay is transparent
2096</td>
2097 </tr>
2098 </table>
2099 </div>
2100
2101 </div>
2102</div>
2103
2104
2105<A NAME="setVisible(boolean)"></A>
2106
2107<div class="jd-details api apilevel-">
2108 <h4 class="jd-details-title">
2109 <span class="normal">
2110 public
2111
2112
2113
2114
2115 void
2116 </span>
2117 <span class="sympad">setVisible</span>
2118 <span class="normal">(boolean visible)</span>
2119 </h4>
2120 <div class="api-level">
2121 <div></div>
2122
2123
2124
2125 </div>
2126 <div class="jd-details-descr">
2127
2128 <div class="jd-tagdata jd-tagdescr"><p>Sets the visibility of this ground overlay. When not visible, a ground overlay is not drawn,
2129 but it keeps all of its other properties.</p></div>
2130 <div class="jd-tagdata">
2131 <h5 class="jd-tagtitle">Parameters</h5>
2132 <table class="jd-tagtable">
2133 <tr>
2134 <th>visible</td>
2135 <td>if <code>true</code>, then the ground overlay is visible; if <code>false</code>, it is
2136 not
2137</td>
2138 </tr>
2139 </table>
2140 </div>
2141
2142 </div>
2143</div>
2144
2145
2146<A NAME="setZIndex(float)"></A>
2147
2148<div class="jd-details api apilevel-">
2149 <h4 class="jd-details-title">
2150 <span class="normal">
2151 public
2152
2153
2154
2155
2156 void
2157 </span>
2158 <span class="sympad">setZIndex</span>
2159 <span class="normal">(float zIndex)</span>
2160 </h4>
2161 <div class="api-level">
2162 <div></div>
2163
2164
2165
2166 </div>
2167 <div class="jd-details-descr">
2168
2169 <div class="jd-tagdata jd-tagdescr"><p>Sets the zIndex of this ground overlay. See the documentation at the top of this class for
2170 more information.</p></div>
2171 <div class="jd-tagdata">
2172 <h5 class="jd-tagtitle">Parameters</h5>
2173 <table class="jd-tagtable">
2174 <tr>
2175 <th>zIndex</td>
2176 <td>the zIndex of this ground overlay
2177</td>
2178 </tr>
2179 </table>
2180 </div>
2181
2182 </div>
2183</div>
2184
2185
2186
2187
2188
2189<!-- ========= METHOD DETAIL ======== -->
2190
2191
2192
2193<!-- ========= END OF CLASS DATA ========= -->
2194<A NAME="navbar_top"></A>
2195
2196<div id="footer" class="wrap" >
2197
2198
2199 <div id="copyright">
2200
2201 Except as noted, this content is licensed under <a
2202 href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>.
2203 For details and restrictions, see the <a href="/license.html">
2204 Content License</a>.
2205 </div>
Robert Lyf6f5cf42013-02-04 18:24:15 -08002206 <div id="build_info">
2207
2208<script src="/timestamp.js" type="text/javascript"></script>
2209<script>document.write(BUILD_TIMESTAMP)</script>
2210
2211 </div>
Robert Ly3c4b4f72012-11-30 04:02:04 -08002212
2213
2214 <div id="footerlinks">
2215
2216 <p>
2217 <a href="/about/index.html">About Android</a>&nbsp;&nbsp;|&nbsp;
2218 <a href="/legal.html">Legal</a>&nbsp;&nbsp;|&nbsp;
2219 <a href="/support.html">Support</a>
2220 </p>
2221 </div>
2222
2223</div> <!-- end footer -->
2224</div> <!-- jd-content -->
2225
2226</div><!-- end doc-content -->
2227
2228</div> <!-- end body-content -->
2229
2230
2231
2232
Robert Ly3c4b4f72012-11-30 04:02:04 -08002233
2234
2235</body>
2236</html>