Activity.java revision d2d6014f715f12f6263f61ba3eeb6f8cba6d0fa6
1/* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.app; 18 19import com.android.internal.policy.PolicyManager; 20 21import android.content.ComponentCallbacks; 22import android.content.ComponentName; 23import android.content.ContentResolver; 24import android.content.Context; 25import android.content.Intent; 26import android.content.IIntentSender; 27import android.content.SharedPreferences; 28import android.content.pm.ActivityInfo; 29import android.content.res.Configuration; 30import android.content.res.Resources; 31import android.database.Cursor; 32import android.graphics.Bitmap; 33import android.graphics.Canvas; 34import android.graphics.drawable.Drawable; 35import android.media.AudioManager; 36import android.net.Uri; 37import android.os.Bundle; 38import android.os.Handler; 39import android.os.IBinder; 40import android.os.RemoteException; 41import android.text.Selection; 42import android.text.SpannableStringBuilder; 43import android.text.TextUtils; 44import android.text.method.TextKeyListener; 45import android.util.AttributeSet; 46import android.util.Config; 47import android.util.EventLog; 48import android.util.Log; 49import android.util.SparseArray; 50import android.view.ContextMenu; 51import android.view.ContextThemeWrapper; 52import android.view.KeyEvent; 53import android.view.LayoutInflater; 54import android.view.Menu; 55import android.view.MenuInflater; 56import android.view.MenuItem; 57import android.view.MotionEvent; 58import android.view.View; 59import android.view.ViewGroup; 60import android.view.ViewManager; 61import android.view.Window; 62import android.view.WindowManager; 63import android.view.ContextMenu.ContextMenuInfo; 64import android.view.View.OnCreateContextMenuListener; 65import android.view.ViewGroup.LayoutParams; 66import android.view.accessibility.AccessibilityEvent; 67import android.widget.AdapterView; 68 69import java.util.ArrayList; 70import java.util.HashMap; 71 72/** 73 * An activity is a single, focused thing that the user can do. Almost all 74 * activities interact with the user, so the Activity class takes care of 75 * creating a window for you in which you can place your UI with 76 * {@link #setContentView}. While activities are often presented to the user 77 * as full-screen windows, they can also be used in other ways: as floating 78 * windows (via a theme with {@link android.R.attr#windowIsFloating} set) 79 * or embedded inside of another activity (using {@link ActivityGroup}). 80 * 81 * There are two methods almost all subclasses of Activity will implement: 82 * 83 * <ul> 84 * <li> {@link #onCreate} is where you initialize your activity. Most 85 * importantly, here you will usually call {@link #setContentView(int)} 86 * with a layout resource defining your UI, and using {@link #findViewById} 87 * to retrieve the widgets in that UI that you need to interact with 88 * programmatically. 89 * 90 * <li> {@link #onPause} is where you deal with the user leaving your 91 * activity. Most importantly, any changes made by the user should at this 92 * point be committed (usually to the 93 * {@link android.content.ContentProvider} holding the data). 94 * </ul> 95 * 96 * <p>To be of use with {@link android.content.Context#startActivity Context.startActivity()}, all 97 * activity classes must have a corresponding 98 * {@link android.R.styleable#AndroidManifestActivity <activity>} 99 * declaration in their package's <code>AndroidManifest.xml</code>.</p> 100 * 101 * <p>The Activity class is an important part of an application's overall lifecycle, 102 * and the way activities are launched and put together is a fundamental 103 * part of the platform's application model. For a detailed perspective on the structure of 104 * Android applications and lifecycles, please read the <em>Dev Guide</em> document on 105 * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a>.</p> 106 * 107 * <p>Topics covered here: 108 * <ol> 109 * <li><a href="#ActivityLifecycle">Activity Lifecycle</a> 110 * <li><a href="#ConfigurationChanges">Configuration Changes</a> 111 * <li><a href="#StartingActivities">Starting Activities and Getting Results</a> 112 * <li><a href="#SavingPersistentState">Saving Persistent State</a> 113 * <li><a href="#Permissions">Permissions</a> 114 * <li><a href="#ProcessLifecycle">Process Lifecycle</a> 115 * </ol> 116 * 117 * <a name="ActivityLifecycle"></a> 118 * <h3>Activity Lifecycle</h3> 119 * 120 * <p>Activities in the system are managed as an <em>activity stack</em>. 121 * When a new activity is started, it is placed on the top of the stack 122 * and becomes the running activity -- the previous activity always remains 123 * below it in the stack, and will not come to the foreground again until 124 * the new activity exits.</p> 125 * 126 * <p>An activity has essentially four states:</p> 127 * <ul> 128 * <li> If an activity in the foreground of the screen (at the top of 129 * the stack), 130 * it is <em>active</em> or <em>running</em>. </li> 131 * <li>If an activity has lost focus but is still visible (that is, a new non-full-sized 132 * or transparent activity has focus on top of your activity), it 133 * is <em>paused</em>. A paused activity is completely alive (it 134 * maintains all state and member information and remains attached to 135 * the window manager), but can be killed by the system in extreme 136 * low memory situations. 137 * <li>If an activity is completely obscured by another activity, 138 * it is <em>stopped</em>. It still retains all state and member information, 139 * however, it is no longer visible to the user so its window is hidden 140 * and it will often be killed by the system when memory is needed 141 * elsewhere.</li> 142 * <li>If an activity is paused or stopped, the system can drop the activity 143 * from memory by either asking it to finish, or simply killing its 144 * process. When it is displayed again to the user, it must be 145 * completely restarted and restored to its previous state.</li> 146 * </ul> 147 * 148 * <p>The following diagram shows the important state paths of an Activity. 149 * The square rectangles represent callback methods you can implement to 150 * perform operations when the Activity moves between states. The colored 151 * ovals are major states the Activity can be in.</p> 152 * 153 * <p><img src="../../../images/activity_lifecycle.png" 154 * alt="State diagram for an Android Activity Lifecycle." border="0" /></p> 155 * 156 * <p>There are three key loops you may be interested in monitoring within your 157 * activity: 158 * 159 * <ul> 160 * <li>The <b>entire lifetime</b> of an activity happens between the first call 161 * to {@link android.app.Activity#onCreate} through to a single final call 162 * to {@link android.app.Activity#onDestroy}. An activity will do all setup 163 * of "global" state in onCreate(), and release all remaining resources in 164 * onDestroy(). For example, if it has a thread running in the background 165 * to download data from the network, it may create that thread in onCreate() 166 * and then stop the thread in onDestroy(). 167 * 168 * <li>The <b>visible lifetime</b> of an activity happens between a call to 169 * {@link android.app.Activity#onStart} until a corresponding call to 170 * {@link android.app.Activity#onStop}. During this time the user can see the 171 * activity on-screen, though it may not be in the foreground and interacting 172 * with the user. Between these two methods you can maintain resources that 173 * are needed to show the activity to the user. For example, you can register 174 * a {@link android.content.BroadcastReceiver} in onStart() to monitor for changes 175 * that impact your UI, and unregister it in onStop() when the user an no 176 * longer see what you are displaying. The onStart() and onStop() methods 177 * can be called multiple times, as the activity becomes visible and hidden 178 * to the user. 179 * 180 * <li>The <b>foreground lifetime</b> of an activity happens between a call to 181 * {@link android.app.Activity#onResume} until a corresponding call to 182 * {@link android.app.Activity#onPause}. During this time the activity is 183 * in front of all other activities and interacting with the user. An activity 184 * can frequently go between the resumed and paused states -- for example when 185 * the device goes to sleep, when an activity result is delivered, when a new 186 * intent is delivered -- so the code in these methods should be fairly 187 * lightweight. 188 * </ul> 189 * 190 * <p>The entire lifecycle of an activity is defined by the following 191 * Activity methods. All of these are hooks that you can override 192 * to do appropriate work when the activity changes state. All 193 * activities will implement {@link android.app.Activity#onCreate} 194 * to do their initial setup; many will also implement 195 * {@link android.app.Activity#onPause} to commit changes to data and 196 * otherwise prepare to stop interacting with the user. You should always 197 * call up to your superclass when implementing these methods.</p> 198 * 199 * </p> 200 * <pre class="prettyprint"> 201 * public class Activity extends ApplicationContext { 202 * protected void onCreate(Bundle savedInstanceState); 203 * 204 * protected void onStart(); 205 * 206 * protected void onRestart(); 207 * 208 * protected void onResume(); 209 * 210 * protected void onPause(); 211 * 212 * protected void onStop(); 213 * 214 * protected void onDestroy(); 215 * } 216 * </pre> 217 * 218 * <p>In general the movement through an activity's lifecycle looks like 219 * this:</p> 220 * 221 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 222 * <colgroup align="left" span="3" /> 223 * <colgroup align="left" /> 224 * <colgroup align="center" /> 225 * <colgroup align="center" /> 226 * 227 * <thead> 228 * <tr><th colspan="3">Method</th> <th>Description</th> <th>Killable?</th> <th>Next</th></tr> 229 * </thead> 230 * 231 * <tbody> 232 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onCreate onCreate()}</th> 233 * <td>Called when the activity is first created. 234 * This is where you should do all of your normal static set up: 235 * create views, bind data to lists, etc. This method also 236 * provides you with a Bundle containing the activity's previously 237 * frozen state, if there was one. 238 * <p>Always followed by <code>onStart()</code>.</td> 239 * <td align="center">No</td> 240 * <td align="center"><code>onStart()</code></td> 241 * </tr> 242 * 243 * <tr><td rowspan="5" style="border-left: none; border-right: none;"> </td> 244 * <th colspan="2" align="left" border="0">{@link android.app.Activity#onRestart onRestart()}</th> 245 * <td>Called after your activity has been stopped, prior to it being 246 * started again. 247 * <p>Always followed by <code>onStart()</code></td> 248 * <td align="center">No</td> 249 * <td align="center"><code>onStart()</code></td> 250 * </tr> 251 * 252 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStart onStart()}</th> 253 * <td>Called when the activity is becoming visible to the user. 254 * <p>Followed by <code>onResume()</code> if the activity comes 255 * to the foreground, or <code>onStop()</code> if it becomes hidden.</td> 256 * <td align="center">No</td> 257 * <td align="center"><code>onResume()</code> or <code>onStop()</code></td> 258 * </tr> 259 * 260 * <tr><td rowspan="2" style="border-left: none;"> </td> 261 * <th align="left" border="0">{@link android.app.Activity#onResume onResume()}</th> 262 * <td>Called when the activity will start 263 * interacting with the user. At this point your activity is at 264 * the top of the activity stack, with user input going to it. 265 * <p>Always followed by <code>onPause()</code>.</td> 266 * <td align="center">No</td> 267 * <td align="center"><code>onPause()</code></td> 268 * </tr> 269 * 270 * <tr><th align="left" border="0">{@link android.app.Activity#onPause onPause()}</th> 271 * <td>Called when the system is about to start resuming a previous 272 * activity. This is typically used to commit unsaved changes to 273 * persistent data, stop animations and other things that may be consuming 274 * CPU, etc. Implementations of this method must be very quick because 275 * the next activity will not be resumed until this method returns. 276 * <p>Followed by either <code>onResume()</code> if the activity 277 * returns back to the front, or <code>onStop()</code> if it becomes 278 * invisible to the user.</td> 279 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td> 280 * <td align="center"><code>onResume()</code> or<br> 281 * <code>onStop()</code></td> 282 * </tr> 283 * 284 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStop onStop()}</th> 285 * <td>Called when the activity is no longer visible to the user, because 286 * another activity has been resumed and is covering this one. This 287 * may happen either because a new activity is being started, an existing 288 * one is being brought in front of this one, or this one is being 289 * destroyed. 290 * <p>Followed by either <code>onRestart()</code> if 291 * this activity is coming back to interact with the user, or 292 * <code>onDestroy()</code> if this activity is going away.</td> 293 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td> 294 * <td align="center"><code>onRestart()</code> or<br> 295 * <code>onDestroy()</code></td> 296 * </tr> 297 * 298 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onDestroy onDestroy()}</th> 299 * <td>The final call you receive before your 300 * activity is destroyed. This can happen either because the 301 * activity is finishing (someone called {@link Activity#finish} on 302 * it, or because the system is temporarily destroying this 303 * instance of the activity to save space. You can distinguish 304 * between these two scenarios with the {@link 305 * Activity#isFinishing} method.</td> 306 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td> 307 * <td align="center"><em>nothing</em></td> 308 * </tr> 309 * </tbody> 310 * </table> 311 * 312 * <p>Note the "Killable" column in the above table -- for those methods that 313 * are marked as being killable, after that method returns the process hosting the 314 * activity may killed by the system <em>at any time</em> without another line 315 * of its code being executed. Because of this, you should use the 316 * {@link #onPause} method to write any persistent data (such as user edits) 317 * to storage. In addition, the method 318 * {@link #onSaveInstanceState(Bundle)} is called before placing the activity 319 * in such a background state, allowing you to save away any dynamic instance 320 * state in your activity into the given Bundle, to be later received in 321 * {@link #onCreate} if the activity needs to be re-created. 322 * See the <a href="#ProcessLifecycle">Process Lifecycle</a> 323 * section for more information on how the lifecycle of a process is tied 324 * to the activities it is hosting. Note that it is important to save 325 * persistent data in {@link #onPause} instead of {@link #onSaveInstanceState} 326 * because the later is not part of the lifecycle callbacks, so will not 327 * be called in every situation as described in its documentation.</p> 328 * 329 * <p>For those methods that are not marked as being killable, the activity's 330 * process will not be killed by the system starting from the time the method 331 * is called and continuing after it returns. Thus an activity is in the killable 332 * state, for example, between after <code>onPause()</code> to the start of 333 * <code>onResume()</code>.</p> 334 * 335 * <a name="ConfigurationChanges"></a> 336 * <h3>Configuration Changes</h3> 337 * 338 * <p>If the configuration of the device (as defined by the 339 * {@link Configuration Resources.Configuration} class) changes, 340 * then anything displaying a user interface will need to update to match that 341 * configuration. Because Activity is the primary mechanism for interacting 342 * with the user, it includes special support for handling configuration 343 * changes.</p> 344 * 345 * <p>Unless you specify otherwise, a configuration change (such as a change 346 * in screen orientation, language, input devices, etc) will cause your 347 * current activity to be <em>destroyed</em>, going through the normal activity 348 * lifecycle process of {@link #onPause}, 349 * {@link #onStop}, and {@link #onDestroy} as appropriate. If the activity 350 * had been in the foreground or visible to the user, once {@link #onDestroy} is 351 * called in that instance then a new instance of the activity will be 352 * created, with whatever savedInstanceState the previous instance had generated 353 * from {@link #onSaveInstanceState}.</p> 354 * 355 * <p>This is done because any application resource, 356 * including layout files, can change based on any configuration value. Thus 357 * the only safe way to handle a configuration change is to re-retrieve all 358 * resources, including layouts, drawables, and strings. Because activities 359 * must already know how to save their state and re-create themselves from 360 * that state, this is a convenient way to have an activity restart itself 361 * with a new configuration.</p> 362 * 363 * <p>In some special cases, you may want to bypass restarting of your 364 * activity based on one or more types of configuration changes. This is 365 * done with the {@link android.R.attr#configChanges android:configChanges} 366 * attribute in its manifest. For any types of configuration changes you say 367 * that you handle there, you will receive a call to your current activity's 368 * {@link #onConfigurationChanged} method instead of being restarted. If 369 * a configuration change involves any that you do not handle, however, the 370 * activity will still be restarted and {@link #onConfigurationChanged} 371 * will not be called.</p> 372 * 373 * <a name="StartingActivities"></a> 374 * <h3>Starting Activities and Getting Results</h3> 375 * 376 * <p>The {@link android.app.Activity#startActivity} 377 * method is used to start a 378 * new activity, which will be placed at the top of the activity stack. It 379 * takes a single argument, an {@link android.content.Intent Intent}, 380 * which describes the activity 381 * to be executed.</p> 382 * 383 * <p>Sometimes you want to get a result back from an activity when it 384 * ends. For example, you may start an activity that lets the user pick 385 * a person in a list of contacts; when it ends, it returns the person 386 * that was selected. To do this, you call the 387 * {@link android.app.Activity#startActivityForResult(Intent, int)} 388 * version with a second integer parameter identifying the call. The result 389 * will come back through your {@link android.app.Activity#onActivityResult} 390 * method.</p> 391 * 392 * <p>When an activity exits, it can call 393 * {@link android.app.Activity#setResult(int)} 394 * to return data back to its parent. It must always supply a result code, 395 * which can be the standard results RESULT_CANCELED, RESULT_OK, or any 396 * custom values starting at RESULT_FIRST_USER. In addition, it can optionally 397 * return back an Intent containing any additional data it wants. All of this 398 * information appears back on the 399 * parent's <code>Activity.onActivityResult()</code>, along with the integer 400 * identifier it originally supplied.</p> 401 * 402 * <p>If a child activity fails for any reason (such as crashing), the parent 403 * activity will receive a result with the code RESULT_CANCELED.</p> 404 * 405 * <pre class="prettyprint"> 406 * public class MyActivity extends Activity { 407 * ... 408 * 409 * static final int PICK_CONTACT_REQUEST = 0; 410 * 411 * protected boolean onKeyDown(int keyCode, KeyEvent event) { 412 * if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) { 413 * // When the user center presses, let them pick a contact. 414 * startActivityForResult( 415 * new Intent(Intent.ACTION_PICK, 416 * new Uri("content://contacts")), 417 * PICK_CONTACT_REQUEST); 418 * return true; 419 * } 420 * return false; 421 * } 422 * 423 * protected void onActivityResult(int requestCode, int resultCode, 424 * Intent data) { 425 * if (requestCode == PICK_CONTACT_REQUEST) { 426 * if (resultCode == RESULT_OK) { 427 * // A contact was picked. Here we will just display it 428 * // to the user. 429 * startActivity(new Intent(Intent.ACTION_VIEW, data)); 430 * } 431 * } 432 * } 433 * } 434 * </pre> 435 * 436 * <a name="SavingPersistentState"></a> 437 * <h3>Saving Persistent State</h3> 438 * 439 * <p>There are generally two kinds of persistent state than an activity 440 * will deal with: shared document-like data (typically stored in a SQLite 441 * database using a {@linkplain android.content.ContentProvider content provider}) 442 * and internal state such as user preferences.</p> 443 * 444 * <p>For content provider data, we suggest that activities use a 445 * "edit in place" user model. That is, any edits a user makes are effectively 446 * made immediately without requiring an additional confirmation step. 447 * Supporting this model is generally a simple matter of following two rules:</p> 448 * 449 * <ul> 450 * <li> <p>When creating a new document, the backing database entry or file for 451 * it is created immediately. For example, if the user chooses to write 452 * a new e-mail, a new entry for that e-mail is created as soon as they 453 * start entering data, so that if they go to any other activity after 454 * that point this e-mail will now appear in the list of drafts.</p> 455 * <li> <p>When an activity's <code>onPause()</code> method is called, it should 456 * commit to the backing content provider or file any changes the user 457 * has made. This ensures that those changes will be seen by any other 458 * activity that is about to run. You will probably want to commit 459 * your data even more aggressively at key times during your 460 * activity's lifecycle: for example before starting a new 461 * activity, before finishing your own activity, when the user 462 * switches between input fields, etc.</p> 463 * </ul> 464 * 465 * <p>This model is designed to prevent data loss when a user is navigating 466 * between activities, and allows the system to safely kill an activity (because 467 * system resources are needed somewhere else) at any time after it has been 468 * paused. Note this implies 469 * that the user pressing BACK from your activity does <em>not</em> 470 * mean "cancel" -- it means to leave the activity with its current contents 471 * saved away. Cancelling edits in an activity must be provided through 472 * some other mechanism, such as an explicit "revert" or "undo" option.</p> 473 * 474 * <p>See the {@linkplain android.content.ContentProvider content package} for 475 * more information about content providers. These are a key aspect of how 476 * different activities invoke and propagate data between themselves.</p> 477 * 478 * <p>The Activity class also provides an API for managing internal persistent state 479 * associated with an activity. This can be used, for example, to remember 480 * the user's preferred initial display in a calendar (day view or week view) 481 * or the user's default home page in a web browser.</p> 482 * 483 * <p>Activity persistent state is managed 484 * with the method {@link #getPreferences}, 485 * allowing you to retrieve and 486 * modify a set of name/value pairs associated with the activity. To use 487 * preferences that are shared across multiple application components 488 * (activities, receivers, services, providers), you can use the underlying 489 * {@link Context#getSharedPreferences Context.getSharedPreferences()} method 490 * to retrieve a preferences 491 * object stored under a specific name. 492 * (Note that it is not possible to share settings data across application 493 * packages -- for that you will need a content provider.)</p> 494 * 495 * <p>Here is an excerpt from a calendar activity that stores the user's 496 * preferred view mode in its persistent settings:</p> 497 * 498 * <pre class="prettyprint"> 499 * public class CalendarActivity extends Activity { 500 * ... 501 * 502 * static final int DAY_VIEW_MODE = 0; 503 * static final int WEEK_VIEW_MODE = 1; 504 * 505 * private SharedPreferences mPrefs; 506 * private int mCurViewMode; 507 * 508 * protected void onCreate(Bundle savedInstanceState) { 509 * super.onCreate(savedInstanceState); 510 * 511 * SharedPreferences mPrefs = getSharedPreferences(); 512 * mCurViewMode = mPrefs.getInt("view_mode" DAY_VIEW_MODE); 513 * } 514 * 515 * protected void onPause() { 516 * super.onPause(); 517 * 518 * SharedPreferences.Editor ed = mPrefs.edit(); 519 * ed.putInt("view_mode", mCurViewMode); 520 * ed.commit(); 521 * } 522 * } 523 * </pre> 524 * 525 * <a name="Permissions"></a> 526 * <h3>Permissions</h3> 527 * 528 * <p>The ability to start a particular Activity can be enforced when it is 529 * declared in its 530 * manifest's {@link android.R.styleable#AndroidManifestActivity <activity>} 531 * tag. By doing so, other applications will need to declare a corresponding 532 * {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 533 * element in their own manifest to be able to start that activity. 534 * 535 * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a> 536 * document for more information on permissions and security in general. 537 * 538 * <a name="ProcessLifecycle"></a> 539 * <h3>Process Lifecycle</h3> 540 * 541 * <p>The Android system attempts to keep application process around for as 542 * long as possible, but eventually will need to remove old processes when 543 * memory runs low. As described in <a href="#ActivityLifecycle">Activity 544 * Lifecycle</a>, the decision about which process to remove is intimately 545 * tied to the state of the user's interaction with it. In general, there 546 * are four states a process can be in based on the activities running in it, 547 * listed here in order of importance. The system will kill less important 548 * processes (the last ones) before it resorts to killing more important 549 * processes (the first ones). 550 * 551 * <ol> 552 * <li> <p>The <b>foreground activity</b> (the activity at the top of the screen 553 * that the user is currently interacting with) is considered the most important. 554 * Its process will only be killed as a last resort, if it uses more memory 555 * than is available on the device. Generally at this point the device has 556 * reached a memory paging state, so this is required in order to keep the user 557 * interface responsive. 558 * <li> <p>A <b>visible activity</b> (an activity that is visible to the user 559 * but not in the foreground, such as one sitting behind a foreground dialog) 560 * is considered extremely important and will not be killed unless that is 561 * required to keep the foreground activity running. 562 * <li> <p>A <b>background activity</b> (an activity that is not visible to 563 * the user and has been paused) is no longer critical, so the system may 564 * safely kill its process to reclaim memory for other foreground or 565 * visible processes. If its process needs to be killed, when the user navigates 566 * back to the activity (making it visible on the screen again), its 567 * {@link #onCreate} method will be called with the savedInstanceState it had previously 568 * supplied in {@link #onSaveInstanceState} so that it can restart itself in the same 569 * state as the user last left it. 570 * <li> <p>An <b>empty process</b> is one hosting no activities or other 571 * application components (such as {@link Service} or 572 * {@link android.content.BroadcastReceiver} classes). These are killed very 573 * quickly by the system as memory becomes low. For this reason, any 574 * background operation you do outside of an activity must be executed in the 575 * context of an activity BroadcastReceiver or Service to ensure that the system 576 * knows it needs to keep your process around. 577 * </ol> 578 * 579 * <p>Sometimes an Activity may need to do a long-running operation that exists 580 * independently of the activity lifecycle itself. An example may be a camera 581 * application that allows you to upload a picture to a web site. The upload 582 * may take a long time, and the application should allow the user to leave 583 * the application will it is executing. To accomplish this, your Activity 584 * should start a {@link Service} in which the upload takes place. This allows 585 * the system to properly prioritize your process (considering it to be more 586 * important than other non-visible applications) for the duration of the 587 * upload, independent of whether the original activity is paused, stopped, 588 * or finished. 589 */ 590public class Activity extends ContextThemeWrapper 591 implements LayoutInflater.Factory, 592 Window.Callback, KeyEvent.Callback, 593 OnCreateContextMenuListener, ComponentCallbacks { 594 private static final String TAG = "Activity"; 595 596 /** Standard activity result: operation canceled. */ 597 public static final int RESULT_CANCELED = 0; 598 /** Standard activity result: operation succeeded. */ 599 public static final int RESULT_OK = -1; 600 /** Start of user-defined activity results. */ 601 public static final int RESULT_FIRST_USER = 1; 602 603 private static long sInstanceCount = 0; 604 605 private static final String WINDOW_HIERARCHY_TAG = "android:viewHierarchyState"; 606 private static final String SAVED_DIALOG_IDS_KEY = "android:savedDialogIds"; 607 private static final String SAVED_DIALOGS_TAG = "android:savedDialogs"; 608 private static final String SAVED_DIALOG_KEY_PREFIX = "android:dialog_"; 609 610 private SparseArray<Dialog> mManagedDialogs; 611 612 // set by the thread after the constructor and before onCreate(Bundle savedInstanceState) is called. 613 private Instrumentation mInstrumentation; 614 private IBinder mToken; 615 private int mIdent; 616 /*package*/ String mEmbeddedID; 617 private Application mApplication; 618 /*package*/ Intent mIntent; 619 private ComponentName mComponent; 620 /*package*/ ActivityInfo mActivityInfo; 621 /*package*/ ActivityThread mMainThread; 622 /*package*/ Object mLastNonConfigurationInstance; 623 /*package*/ HashMap<String,Object> mLastNonConfigurationChildInstances; 624 Activity mParent; 625 boolean mCalled; 626 private boolean mResumed; 627 private boolean mStopped; 628 boolean mFinished; 629 boolean mStartedActivity; 630 /*package*/ int mConfigChangeFlags; 631 /*package*/ Configuration mCurrentConfig; 632 private SearchManager mSearchManager; 633 634 private Window mWindow; 635 636 private WindowManager mWindowManager; 637 /*package*/ View mDecor = null; 638 /*package*/ boolean mWindowAdded = false; 639 /*package*/ boolean mVisibleFromServer = false; 640 /*package*/ boolean mVisibleFromClient = true; 641 642 private CharSequence mTitle; 643 private int mTitleColor = 0; 644 645 private static final class ManagedCursor { 646 ManagedCursor(Cursor cursor) { 647 mCursor = cursor; 648 mReleased = false; 649 mUpdated = false; 650 } 651 652 private final Cursor mCursor; 653 private boolean mReleased; 654 private boolean mUpdated; 655 } 656 private final ArrayList<ManagedCursor> mManagedCursors = 657 new ArrayList<ManagedCursor>(); 658 659 // protected by synchronized (this) 660 int mResultCode = RESULT_CANCELED; 661 Intent mResultData = null; 662 663 private boolean mTitleReady = false; 664 665 private int mDefaultKeyMode = DEFAULT_KEYS_DISABLE; 666 private SpannableStringBuilder mDefaultKeySsb = null; 667 668 protected static final int[] FOCUSED_STATE_SET = {com.android.internal.R.attr.state_focused}; 669 670 private Thread mUiThread; 671 private final Handler mHandler = new Handler(); 672 673 public Activity() { 674 ++sInstanceCount; 675 } 676 677 678 @Override 679 protected void finalize() throws Throwable { 680 super.finalize(); 681 --sInstanceCount; 682 } 683 684 public static long getInstanceCount() { 685 return sInstanceCount; 686 } 687 688 /** Return the intent that started this activity. */ 689 public Intent getIntent() { 690 return mIntent; 691 } 692 693 /** 694 * Change the intent returned by {@link #getIntent}. This holds a 695 * reference to the given intent; it does not copy it. Often used in 696 * conjunction with {@link #onNewIntent}. 697 * 698 * @param newIntent The new Intent object to return from getIntent 699 * 700 * @see #getIntent 701 * @see #onNewIntent 702 */ 703 public void setIntent(Intent newIntent) { 704 mIntent = newIntent; 705 } 706 707 /** Return the application that owns this activity. */ 708 public final Application getApplication() { 709 return mApplication; 710 } 711 712 /** Is this activity embedded inside of another activity? */ 713 public final boolean isChild() { 714 return mParent != null; 715 } 716 717 /** Return the parent activity if this view is an embedded child. */ 718 public final Activity getParent() { 719 return mParent; 720 } 721 722 /** Retrieve the window manager for showing custom windows. */ 723 public WindowManager getWindowManager() { 724 return mWindowManager; 725 } 726 727 /** 728 * Retrieve the current {@link android.view.Window} for the activity. 729 * This can be used to directly access parts of the Window API that 730 * are not available through Activity/Screen. 731 * 732 * @return Window The current window, or null if the activity is not 733 * visual. 734 */ 735 public Window getWindow() { 736 return mWindow; 737 } 738 739 /** 740 * Calls {@link android.view.Window#getCurrentFocus} on the 741 * Window of this Activity to return the currently focused view. 742 * 743 * @return View The current View with focus or null. 744 * 745 * @see #getWindow 746 * @see android.view.Window#getCurrentFocus 747 */ 748 public View getCurrentFocus() { 749 return mWindow != null ? mWindow.getCurrentFocus() : null; 750 } 751 752 @Override 753 public int getWallpaperDesiredMinimumWidth() { 754 int width = super.getWallpaperDesiredMinimumWidth(); 755 return width <= 0 ? getWindowManager().getDefaultDisplay().getWidth() : width; 756 } 757 758 @Override 759 public int getWallpaperDesiredMinimumHeight() { 760 int height = super.getWallpaperDesiredMinimumHeight(); 761 return height <= 0 ? getWindowManager().getDefaultDisplay().getHeight() : height; 762 } 763 764 /** 765 * Called when the activity is starting. This is where most initialization 766 * should go: calling {@link #setContentView(int)} to inflate the 767 * activity's UI, using {@link #findViewById} to programmatically interact 768 * with widgets in the UI, calling 769 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)} to retrieve 770 * cursors for data being displayed, etc. 771 * 772 * <p>You can call {@link #finish} from within this function, in 773 * which case onDestroy() will be immediately called without any of the rest 774 * of the activity lifecycle ({@link #onStart}, {@link #onResume}, 775 * {@link #onPause}, etc) executing. 776 * 777 * <p><em>Derived classes must call through to the super class's 778 * implementation of this method. If they do not, an exception will be 779 * thrown.</em></p> 780 * 781 * @param savedInstanceState If the activity is being re-initialized after 782 * previously being shut down then this Bundle contains the data it most 783 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b> 784 * 785 * @see #onStart 786 * @see #onSaveInstanceState 787 * @see #onRestoreInstanceState 788 * @see #onPostCreate 789 */ 790 protected void onCreate(Bundle savedInstanceState) { 791 mVisibleFromClient = mWindow.getWindowStyle().getBoolean( 792 com.android.internal.R.styleable.Window_windowNoDisplay, true); 793 mCalled = true; 794 } 795 796 /** 797 * The hook for {@link ActivityThread} to restore the state of this activity. 798 * 799 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and 800 * {@link #restoreManagedDialogs(android.os.Bundle)}. 801 * 802 * @param savedInstanceState contains the saved state 803 */ 804 final void performRestoreInstanceState(Bundle savedInstanceState) { 805 onRestoreInstanceState(savedInstanceState); 806 restoreManagedDialogs(savedInstanceState); 807 } 808 809 /** 810 * This method is called after {@link #onStart} when the activity is 811 * being re-initialized from a previously saved state, given here in 812 * <var>state</var>. Most implementations will simply use {@link #onCreate} 813 * to restore their state, but it is sometimes convenient to do it here 814 * after all of the initialization has been done or to allow subclasses to 815 * decide whether to use your default implementation. The default 816 * implementation of this method performs a restore of any view state that 817 * had previously been frozen by {@link #onSaveInstanceState}. 818 * 819 * <p>This method is called between {@link #onStart} and 820 * {@link #onPostCreate}. 821 * 822 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}. 823 * 824 * @see #onCreate 825 * @see #onPostCreate 826 * @see #onResume 827 * @see #onSaveInstanceState 828 */ 829 protected void onRestoreInstanceState(Bundle savedInstanceState) { 830 if (mWindow != null) { 831 Bundle windowState = savedInstanceState.getBundle(WINDOW_HIERARCHY_TAG); 832 if (windowState != null) { 833 mWindow.restoreHierarchyState(windowState); 834 } 835 } 836 } 837 838 /** 839 * Restore the state of any saved managed dialogs. 840 * 841 * @param savedInstanceState The bundle to restore from. 842 */ 843 private void restoreManagedDialogs(Bundle savedInstanceState) { 844 final Bundle b = savedInstanceState.getBundle(SAVED_DIALOGS_TAG); 845 if (b == null) { 846 return; 847 } 848 849 final int[] ids = b.getIntArray(SAVED_DIALOG_IDS_KEY); 850 final int numDialogs = ids.length; 851 mManagedDialogs = new SparseArray<Dialog>(numDialogs); 852 for (int i = 0; i < numDialogs; i++) { 853 final Integer dialogId = ids[i]; 854 Bundle dialogState = b.getBundle(savedDialogKeyFor(dialogId)); 855 if (dialogState != null) { 856 // Calling onRestoreInstanceState() below will invoke dispatchOnCreate 857 // so tell createDialog() not to do it, otherwise we get an exception 858 final Dialog dialog = createDialog(dialogId, dialogState); 859 mManagedDialogs.put(dialogId, dialog); 860 onPrepareDialog(dialogId, dialog); 861 dialog.onRestoreInstanceState(dialogState); 862 } 863 } 864 } 865 866 private Dialog createDialog(Integer dialogId, Bundle state) { 867 final Dialog dialog = onCreateDialog(dialogId); 868 if (dialog == null) { 869 throw new IllegalArgumentException("Activity#onCreateDialog did " 870 + "not create a dialog for id " + dialogId); 871 } 872 dialog.dispatchOnCreate(state); 873 return dialog; 874 } 875 876 private String savedDialogKeyFor(int key) { 877 return SAVED_DIALOG_KEY_PREFIX + key; 878 } 879 880 881 /** 882 * Called when activity start-up is complete (after {@link #onStart} 883 * and {@link #onRestoreInstanceState} have been called). Applications will 884 * generally not implement this method; it is intended for system 885 * classes to do final initialization after application code has run. 886 * 887 * <p><em>Derived classes must call through to the super class's 888 * implementation of this method. If they do not, an exception will be 889 * thrown.</em></p> 890 * 891 * @param savedInstanceState If the activity is being re-initialized after 892 * previously being shut down then this Bundle contains the data it most 893 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b> 894 * @see #onCreate 895 */ 896 protected void onPostCreate(Bundle savedInstanceState) { 897 if (!isChild()) { 898 mTitleReady = true; 899 onTitleChanged(getTitle(), getTitleColor()); 900 } 901 mCalled = true; 902 } 903 904 /** 905 * Called after {@link #onCreate} — or after {@link #onRestart} when 906 * the activity had been stopped, but is now again being displayed to the 907 * user. It will be followed by {@link #onResume}. 908 * 909 * <p><em>Derived classes must call through to the super class's 910 * implementation of this method. If they do not, an exception will be 911 * thrown.</em></p> 912 * 913 * @see #onCreate 914 * @see #onStop 915 * @see #onResume 916 */ 917 protected void onStart() { 918 mCalled = true; 919 } 920 921 /** 922 * Called after {@link #onStop} when the current activity is being 923 * re-displayed to the user (the user has navigated back to it). It will 924 * be followed by {@link #onStart} and then {@link #onResume}. 925 * 926 * <p>For activities that are using raw {@link Cursor} objects (instead of 927 * creating them through 928 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)}, 929 * this is usually the place 930 * where the cursor should be requeried (because you had deactivated it in 931 * {@link #onStop}. 932 * 933 * <p><em>Derived classes must call through to the super class's 934 * implementation of this method. If they do not, an exception will be 935 * thrown.</em></p> 936 * 937 * @see #onStop 938 * @see #onStart 939 * @see #onResume 940 */ 941 protected void onRestart() { 942 mCalled = true; 943 } 944 945 /** 946 * Called after {@link #onRestoreInstanceState}, {@link #onRestart}, or 947 * {@link #onPause}, for your activity to start interacting with the user. 948 * This is a good place to begin animations, open exclusive-access devices 949 * (such as the camera), etc. 950 * 951 * <p>Keep in mind that onResume is not the best indicator that your activity 952 * is visible to the user; a system window such as the keyguard may be in 953 * front. Use {@link #onWindowFocusChanged} to know for certain that your 954 * activity is visible to the user (for example, to resume a game). 955 * 956 * <p><em>Derived classes must call through to the super class's 957 * implementation of this method. If they do not, an exception will be 958 * thrown.</em></p> 959 * 960 * @see #onRestoreInstanceState 961 * @see #onRestart 962 * @see #onPostResume 963 * @see #onPause 964 */ 965 protected void onResume() { 966 mCalled = true; 967 } 968 969 /** 970 * Called when activity resume is complete (after {@link #onResume} has 971 * been called). Applications will generally not implement this method; 972 * it is intended for system classes to do final setup after application 973 * resume code has run. 974 * 975 * <p><em>Derived classes must call through to the super class's 976 * implementation of this method. If they do not, an exception will be 977 * thrown.</em></p> 978 * 979 * @see #onResume 980 */ 981 protected void onPostResume() { 982 final Window win = getWindow(); 983 if (win != null) win.makeActive(); 984 mCalled = true; 985 } 986 987 /** 988 * This is called for activities that set launchMode to "singleTop" in 989 * their package, or if a client used the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} 990 * flag when calling {@link #startActivity}. In either case, when the 991 * activity is re-launched while at the top of the activity stack instead 992 * of a new instance of the activity being started, onNewIntent() will be 993 * called on the existing instance with the Intent that was used to 994 * re-launch it. 995 * 996 * <p>An activity will always be paused before receiving a new intent, so 997 * you can count on {@link #onResume} being called after this method. 998 * 999 * <p>Note that {@link #getIntent} still returns the original Intent. You 1000 * can use {@link #setIntent} to update it to this new Intent. 1001 * 1002 * @param intent The new intent that was started for the activity. 1003 * 1004 * @see #getIntent 1005 * @see #setIntent 1006 * @see #onResume 1007 */ 1008 protected void onNewIntent(Intent intent) { 1009 } 1010 1011 /** 1012 * The hook for {@link ActivityThread} to save the state of this activity. 1013 * 1014 * Calls {@link #onSaveInstanceState(android.os.Bundle)} 1015 * and {@link #saveManagedDialogs(android.os.Bundle)}. 1016 * 1017 * @param outState The bundle to save the state to. 1018 */ 1019 final void performSaveInstanceState(Bundle outState) { 1020 onSaveInstanceState(outState); 1021 saveManagedDialogs(outState); 1022 } 1023 1024 /** 1025 * Called to retrieve per-instance state from an activity before being killed 1026 * so that the state can be restored in {@link #onCreate} or 1027 * {@link #onRestoreInstanceState} (the {@link Bundle} populated by this method 1028 * will be passed to both). 1029 * 1030 * <p>This method is called before an activity may be killed so that when it 1031 * comes back some time in the future it can restore its state. For example, 1032 * if activity B is launched in front of activity A, and at some point activity 1033 * A is killed to reclaim resources, activity A will have a chance to save the 1034 * current state of its user interface via this method so that when the user 1035 * returns to activity A, the state of the user interface can be restored 1036 * via {@link #onCreate} or {@link #onRestoreInstanceState}. 1037 * 1038 * <p>Do not confuse this method with activity lifecycle callbacks such as 1039 * {@link #onPause}, which is always called when an activity is being placed 1040 * in the background or on its way to destruction, or {@link #onStop} which 1041 * is called before destruction. One example of when {@link #onPause} and 1042 * {@link #onStop} is called and not this method is when a user navigates back 1043 * from activity B to activity A: there is no need to call {@link #onSaveInstanceState} 1044 * on B because that particular instance will never be restored, so the 1045 * system avoids calling it. An example when {@link #onPause} is called and 1046 * not {@link #onSaveInstanceState} is when activity B is launched in front of activity A: 1047 * the system may avoid calling {@link #onSaveInstanceState} on activity A if it isn't 1048 * killed during the lifetime of B since the state of the user interface of 1049 * A will stay intact. 1050 * 1051 * <p>The default implementation takes care of most of the UI per-instance 1052 * state for you by calling {@link android.view.View#onSaveInstanceState()} on each 1053 * view in the hierarchy that has an id, and by saving the id of the currently 1054 * focused view (all of which is restored by the default implementation of 1055 * {@link #onRestoreInstanceState}). If you override this method to save additional 1056 * information not captured by each individual view, you will likely want to 1057 * call through to the default implementation, otherwise be prepared to save 1058 * all of the state of each view yourself. 1059 * 1060 * <p>If called, this method will occur before {@link #onStop}. There are 1061 * no guarantees about whether it will occur before or after {@link #onPause}. 1062 * 1063 * @param outState Bundle in which to place your saved state. 1064 * 1065 * @see #onCreate 1066 * @see #onRestoreInstanceState 1067 * @see #onPause 1068 */ 1069 protected void onSaveInstanceState(Bundle outState) { 1070 outState.putBundle(WINDOW_HIERARCHY_TAG, mWindow.saveHierarchyState()); 1071 } 1072 1073 /** 1074 * Save the state of any managed dialogs. 1075 * 1076 * @param outState place to store the saved state. 1077 */ 1078 private void saveManagedDialogs(Bundle outState) { 1079 if (mManagedDialogs == null) { 1080 return; 1081 } 1082 1083 final int numDialogs = mManagedDialogs.size(); 1084 if (numDialogs == 0) { 1085 return; 1086 } 1087 1088 Bundle dialogState = new Bundle(); 1089 1090 int[] ids = new int[mManagedDialogs.size()]; 1091 1092 // save each dialog's bundle, gather the ids 1093 for (int i = 0; i < numDialogs; i++) { 1094 final int key = mManagedDialogs.keyAt(i); 1095 ids[i] = key; 1096 final Dialog dialog = mManagedDialogs.valueAt(i); 1097 dialogState.putBundle(savedDialogKeyFor(key), dialog.onSaveInstanceState()); 1098 } 1099 1100 dialogState.putIntArray(SAVED_DIALOG_IDS_KEY, ids); 1101 outState.putBundle(SAVED_DIALOGS_TAG, dialogState); 1102 } 1103 1104 1105 /** 1106 * Called as part of the activity lifecycle when an activity is going into 1107 * the background, but has not (yet) been killed. The counterpart to 1108 * {@link #onResume}. 1109 * 1110 * <p>When activity B is launched in front of activity A, this callback will 1111 * be invoked on A. B will not be created until A's {@link #onPause} returns, 1112 * so be sure to not do anything lengthy here. 1113 * 1114 * <p>This callback is mostly used for saving any persistent state the 1115 * activity is editing, to present a "edit in place" model to the user and 1116 * making sure nothing is lost if there are not enough resources to start 1117 * the new activity without first killing this one. This is also a good 1118 * place to do things like stop animations and other things that consume a 1119 * noticeable mount of CPU in order to make the switch to the next activity 1120 * as fast as possible, or to close resources that are exclusive access 1121 * such as the camera. 1122 * 1123 * <p>In situations where the system needs more memory it may kill paused 1124 * processes to reclaim resources. Because of this, you should be sure 1125 * that all of your state is saved by the time you return from 1126 * this function. In general {@link #onSaveInstanceState} is used to save 1127 * per-instance state in the activity and this method is used to store 1128 * global persistent data (in content providers, files, etc.) 1129 * 1130 * <p>After receiving this call you will usually receive a following call 1131 * to {@link #onStop} (after the next activity has been resumed and 1132 * displayed), however in some cases there will be a direct call back to 1133 * {@link #onResume} without going through the stopped state. 1134 * 1135 * <p><em>Derived classes must call through to the super class's 1136 * implementation of this method. If they do not, an exception will be 1137 * thrown.</em></p> 1138 * 1139 * @see #onResume 1140 * @see #onSaveInstanceState 1141 * @see #onStop 1142 */ 1143 protected void onPause() { 1144 mCalled = true; 1145 } 1146 1147 /** 1148 * Called as part of the activity lifecycle when an activity is about to go 1149 * into the background as the result of user choice. For example, when the 1150 * user presses the Home key, {@link #onUserLeaveHint} will be called, but 1151 * when an incoming phone call causes the in-call Activity to be automatically 1152 * brought to the foreground, {@link #onUserLeaveHint} will not be called on 1153 * the activity being interrupted. In cases when it is invoked, this method 1154 * is called right before the activity's {@link #onPause} callback. 1155 * 1156 * <p>This callback and {@link #onUserInteraction} are intended to help 1157 * activities manage status bar notifications intelligently; specifically, 1158 * for helping activities determine the proper time to cancel a notfication. 1159 * 1160 * @see #onUserInteraction() 1161 */ 1162 protected void onUserLeaveHint() { 1163 } 1164 1165 /** 1166 * Generate a new thumbnail for this activity. This method is called before 1167 * pausing the activity, and should draw into <var>outBitmap</var> the 1168 * imagery for the desired thumbnail in the dimensions of that bitmap. It 1169 * can use the given <var>canvas</var>, which is configured to draw into the 1170 * bitmap, for rendering if desired. 1171 * 1172 * <p>The default implementation renders the Screen's current view 1173 * hierarchy into the canvas to generate a thumbnail. 1174 * 1175 * <p>If you return false, the bitmap will be filled with a default 1176 * thumbnail. 1177 * 1178 * @param outBitmap The bitmap to contain the thumbnail. 1179 * @param canvas Can be used to render into the bitmap. 1180 * 1181 * @return Return true if you have drawn into the bitmap; otherwise after 1182 * you return it will be filled with a default thumbnail. 1183 * 1184 * @see #onCreateDescription 1185 * @see #onSaveInstanceState 1186 * @see #onPause 1187 */ 1188 public boolean onCreateThumbnail(Bitmap outBitmap, Canvas canvas) { 1189 final View view = mDecor; 1190 if (view == null) { 1191 return false; 1192 } 1193 1194 final int vw = view.getWidth(); 1195 final int vh = view.getHeight(); 1196 final int dw = outBitmap.getWidth(); 1197 final int dh = outBitmap.getHeight(); 1198 1199 canvas.save(); 1200 canvas.scale(((float)dw)/vw, ((float)dh)/vh); 1201 view.draw(canvas); 1202 canvas.restore(); 1203 1204 return true; 1205 } 1206 1207 /** 1208 * Generate a new description for this activity. This method is called 1209 * before pausing the activity and can, if desired, return some textual 1210 * description of its current state to be displayed to the user. 1211 * 1212 * <p>The default implementation returns null, which will cause you to 1213 * inherit the description from the previous activity. If all activities 1214 * return null, generally the label of the top activity will be used as the 1215 * description. 1216 * 1217 * @return A description of what the user is doing. It should be short and 1218 * sweet (only a few words). 1219 * 1220 * @see #onCreateThumbnail 1221 * @see #onSaveInstanceState 1222 * @see #onPause 1223 */ 1224 public CharSequence onCreateDescription() { 1225 return null; 1226 } 1227 1228 /** 1229 * Called when you are no longer visible to the user. You will next 1230 * receive either {@link #onRestart}, {@link #onDestroy}, or nothing, 1231 * depending on later user activity. 1232 * 1233 * <p>Note that this method may never be called, in low memory situations 1234 * where the system does not have enough memory to keep your activity's 1235 * process running after its {@link #onPause} method is called. 1236 * 1237 * <p><em>Derived classes must call through to the super class's 1238 * implementation of this method. If they do not, an exception will be 1239 * thrown.</em></p> 1240 * 1241 * @see #onRestart 1242 * @see #onResume 1243 * @see #onSaveInstanceState 1244 * @see #onDestroy 1245 */ 1246 protected void onStop() { 1247 mCalled = true; 1248 } 1249 1250 /** 1251 * Perform any final cleanup before an activity is destroyed. This can 1252 * happen either because the activity is finishing (someone called 1253 * {@link #finish} on it, or because the system is temporarily destroying 1254 * this instance of the activity to save space. You can distinguish 1255 * between these two scenarios with the {@link #isFinishing} method. 1256 * 1257 * <p><em>Note: do not count on this method being called as a place for 1258 * saving data! For example, if an activity is editing data in a content 1259 * provider, those edits should be committed in either {@link #onPause} or 1260 * {@link #onSaveInstanceState}, not here.</em> This method is usually implemented to 1261 * free resources like threads that are associated with an activity, so 1262 * that a destroyed activity does not leave such things around while the 1263 * rest of its application is still running. There are situations where 1264 * the system will simply kill the activity's hosting process without 1265 * calling this method (or any others) in it, so it should not be used to 1266 * do things that are intended to remain around after the process goes 1267 * away. 1268 * 1269 * <p><em>Derived classes must call through to the super class's 1270 * implementation of this method. If they do not, an exception will be 1271 * thrown.</em></p> 1272 * 1273 * @see #onPause 1274 * @see #onStop 1275 * @see #finish 1276 * @see #isFinishing 1277 */ 1278 protected void onDestroy() { 1279 mCalled = true; 1280 1281 // dismiss any dialogs we are managing. 1282 if (mManagedDialogs != null) { 1283 1284 final int numDialogs = mManagedDialogs.size(); 1285 for (int i = 0; i < numDialogs; i++) { 1286 final Dialog dialog = mManagedDialogs.valueAt(i); 1287 if (dialog.isShowing()) { 1288 dialog.dismiss(); 1289 } 1290 } 1291 } 1292 1293 // close any cursors we are managing. 1294 int numCursors = mManagedCursors.size(); 1295 for (int i = 0; i < numCursors; i++) { 1296 ManagedCursor c = mManagedCursors.get(i); 1297 if (c != null) { 1298 c.mCursor.close(); 1299 } 1300 } 1301 } 1302 1303 /** 1304 * Called by the system when the device configuration changes while your 1305 * activity is running. Note that this will <em>only</em> be called if 1306 * you have selected configurations you would like to handle with the 1307 * {@link android.R.attr#configChanges} attribute in your manifest. If 1308 * any configuration change occurs that is not selected to be reported 1309 * by that attribute, then instead of reporting it the system will stop 1310 * and restart the activity (to have it launched with the new 1311 * configuration). 1312 * 1313 * <p>At the time that this function has been called, your Resources 1314 * object will have been updated to return resource values matching the 1315 * new configuration. 1316 * 1317 * @param newConfig The new device configuration. 1318 */ 1319 public void onConfigurationChanged(Configuration newConfig) { 1320 mCalled = true; 1321 1322 if (mWindow != null) { 1323 // Pass the configuration changed event to the window 1324 mWindow.onConfigurationChanged(newConfig); 1325 } 1326 } 1327 1328 /** 1329 * If this activity is being destroyed because it can not handle a 1330 * configuration parameter being changed (and thus its 1331 * {@link #onConfigurationChanged(Configuration)} method is 1332 * <em>not</em> being called), then you can use this method to discover 1333 * the set of changes that have occurred while in the process of being 1334 * destroyed. Note that there is no guarantee that these will be 1335 * accurate (other changes could have happened at any time), so you should 1336 * only use this as an optimization hint. 1337 * 1338 * @return Returns a bit field of the configuration parameters that are 1339 * changing, as defined by the {@link android.content.res.Configuration} 1340 * class. 1341 */ 1342 public int getChangingConfigurations() { 1343 return mConfigChangeFlags; 1344 } 1345 1346 /** 1347 * Retrieve the non-configuration instance data that was previously 1348 * returned by {@link #onRetainNonConfigurationInstance()}. This will 1349 * be available from the initial {@link #onCreate} and 1350 * {@link #onStart} calls to the new instance, allowing you to extract 1351 * any useful dynamic state from the previous instance. 1352 * 1353 * <p>Note that the data you retrieve here should <em>only</em> be used 1354 * as an optimization for handling configuration changes. You should always 1355 * be able to handle getting a null pointer back, and an activity must 1356 * still be able to restore itself to its previous state (through the 1357 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this 1358 * function returns null. 1359 * 1360 * @return Returns the object previously returned by 1361 * {@link #onRetainNonConfigurationInstance()}. 1362 */ 1363 public Object getLastNonConfigurationInstance() { 1364 return mLastNonConfigurationInstance; 1365 } 1366 1367 /** 1368 * Called by the system, as part of destroying an 1369 * activity due to a configuration change, when it is known that a new 1370 * instance will immediately be created for the new configuration. You 1371 * can return any object you like here, including the activity instance 1372 * itself, which can later be retrieved by calling 1373 * {@link #getLastNonConfigurationInstance()} in the new activity 1374 * instance. 1375 * 1376 * <p>This function is called purely as an optimization, and you must 1377 * not rely on it being called. When it is called, a number of guarantees 1378 * will be made to help optimize configuration switching: 1379 * <ul> 1380 * <li> The function will be called between {@link #onStop} and 1381 * {@link #onDestroy}. 1382 * <li> A new instance of the activity will <em>always</em> be immediately 1383 * created after this one's {@link #onDestroy()} is called. 1384 * <li> The object you return here will <em>always</em> be available from 1385 * the {@link #getLastNonConfigurationInstance()} method of the following 1386 * activity instance as described there. 1387 * </ul> 1388 * 1389 * <p>These guarantees are designed so that an activity can use this API 1390 * to propagate extensive state from the old to new activity instance, from 1391 * loaded bitmaps, to network connections, to evenly actively running 1392 * threads. Note that you should <em>not</em> propagate any data that 1393 * may change based on the configuration, including any data loaded from 1394 * resources such as strings, layouts, or drawables. 1395 * 1396 * @return Return any Object holding the desired state to propagate to the 1397 * next activity instance. 1398 */ 1399 public Object onRetainNonConfigurationInstance() { 1400 return null; 1401 } 1402 1403 /** 1404 * Retrieve the non-configuration instance data that was previously 1405 * returned by {@link #onRetainNonConfigurationChildInstances()}. This will 1406 * be available from the initial {@link #onCreate} and 1407 * {@link #onStart} calls to the new instance, allowing you to extract 1408 * any useful dynamic state from the previous instance. 1409 * 1410 * <p>Note that the data you retrieve here should <em>only</em> be used 1411 * as an optimization for handling configuration changes. You should always 1412 * be able to handle getting a null pointer back, and an activity must 1413 * still be able to restore itself to its previous state (through the 1414 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this 1415 * function returns null. 1416 * 1417 * @return Returns the object previously returned by 1418 * {@link #onRetainNonConfigurationChildInstances()} 1419 */ 1420 HashMap<String,Object> getLastNonConfigurationChildInstances() { 1421 return mLastNonConfigurationChildInstances; 1422 } 1423 1424 /** 1425 * This method is similar to {@link #onRetainNonConfigurationInstance()} except that 1426 * it should return either a mapping from child activity id strings to arbitrary objects, 1427 * or null. This method is intended to be used by Activity framework subclasses that control a 1428 * set of child activities, such as ActivityGroup. The same guarantees and restrictions apply 1429 * as for {@link #onRetainNonConfigurationInstance()}. The default implementation returns null. 1430 */ 1431 HashMap<String,Object> onRetainNonConfigurationChildInstances() { 1432 return null; 1433 } 1434 1435 public void onLowMemory() { 1436 mCalled = true; 1437 } 1438 1439 /** 1440 * Wrapper around 1441 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)} 1442 * that gives the resulting {@link Cursor} to call 1443 * {@link #startManagingCursor} so that the activity will manage its 1444 * lifecycle for you. 1445 * 1446 * @param uri The URI of the content provider to query. 1447 * @param projection List of columns to return. 1448 * @param selection SQL WHERE clause. 1449 * @param sortOrder SQL ORDER BY clause. 1450 * 1451 * @return The Cursor that was returned by query(). 1452 * 1453 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String) 1454 * @see #startManagingCursor 1455 * @hide 1456 */ 1457 public final Cursor managedQuery(Uri uri, 1458 String[] projection, 1459 String selection, 1460 String sortOrder) 1461 { 1462 Cursor c = getContentResolver().query(uri, projection, selection, null, sortOrder); 1463 if (c != null) { 1464 startManagingCursor(c); 1465 } 1466 return c; 1467 } 1468 1469 /** 1470 * Wrapper around 1471 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)} 1472 * that gives the resulting {@link Cursor} to call 1473 * {@link #startManagingCursor} so that the activity will manage its 1474 * lifecycle for you. 1475 * 1476 * @param uri The URI of the content provider to query. 1477 * @param projection List of columns to return. 1478 * @param selection SQL WHERE clause. 1479 * @param selectionArgs The arguments to selection, if any ?s are pesent 1480 * @param sortOrder SQL ORDER BY clause. 1481 * 1482 * @return The Cursor that was returned by query(). 1483 * 1484 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String) 1485 * @see #startManagingCursor 1486 */ 1487 public final Cursor managedQuery(Uri uri, 1488 String[] projection, 1489 String selection, 1490 String[] selectionArgs, 1491 String sortOrder) 1492 { 1493 Cursor c = getContentResolver().query(uri, projection, selection, selectionArgs, sortOrder); 1494 if (c != null) { 1495 startManagingCursor(c); 1496 } 1497 return c; 1498 } 1499 1500 /** 1501 * Wrapper around {@link Cursor#commitUpdates()} that takes care of noting 1502 * that the Cursor needs to be requeried. You can call this method in 1503 * {@link #onPause} or {@link #onStop} to have the system call 1504 * {@link Cursor#requery} for you if the activity is later resumed. This 1505 * allows you to avoid determing when to do the requery yourself (which is 1506 * required for the Cursor to see any data changes that were committed with 1507 * it). 1508 * 1509 * @param c The Cursor whose changes are to be committed. 1510 * 1511 * @see #managedQuery(android.net.Uri , String[], String, String[], String) 1512 * @see #startManagingCursor 1513 * @see Cursor#commitUpdates() 1514 * @see Cursor#requery 1515 * @hide 1516 */ 1517 @Deprecated 1518 public void managedCommitUpdates(Cursor c) { 1519 synchronized (mManagedCursors) { 1520 final int N = mManagedCursors.size(); 1521 for (int i=0; i<N; i++) { 1522 ManagedCursor mc = mManagedCursors.get(i); 1523 if (mc.mCursor == c) { 1524 c.commitUpdates(); 1525 mc.mUpdated = true; 1526 return; 1527 } 1528 } 1529 throw new RuntimeException( 1530 "Cursor " + c + " is not currently managed"); 1531 } 1532 } 1533 1534 /** 1535 * This method allows the activity to take care of managing the given 1536 * {@link Cursor}'s lifecycle for you based on the activity's lifecycle. 1537 * That is, when the activity is stopped it will automatically call 1538 * {@link Cursor#deactivate} on the given Cursor, and when it is later restarted 1539 * it will call {@link Cursor#requery} for you. When the activity is 1540 * destroyed, all managed Cursors will be closed automatically. 1541 * 1542 * @param c The Cursor to be managed. 1543 * 1544 * @see #managedQuery(android.net.Uri , String[], String, String[], String) 1545 * @see #stopManagingCursor 1546 */ 1547 public void startManagingCursor(Cursor c) { 1548 synchronized (mManagedCursors) { 1549 mManagedCursors.add(new ManagedCursor(c)); 1550 } 1551 } 1552 1553 /** 1554 * Given a Cursor that was previously given to 1555 * {@link #startManagingCursor}, stop the activity's management of that 1556 * cursor. 1557 * 1558 * @param c The Cursor that was being managed. 1559 * 1560 * @see #startManagingCursor 1561 */ 1562 public void stopManagingCursor(Cursor c) { 1563 synchronized (mManagedCursors) { 1564 final int N = mManagedCursors.size(); 1565 for (int i=0; i<N; i++) { 1566 ManagedCursor mc = mManagedCursors.get(i); 1567 if (mc.mCursor == c) { 1568 mManagedCursors.remove(i); 1569 break; 1570 } 1571 } 1572 } 1573 } 1574 1575 /** 1576 * Control whether this activity is required to be persistent. By default 1577 * activities are not persistent; setting this to true will prevent the 1578 * system from stopping this activity or its process when running low on 1579 * resources. 1580 * 1581 * <p><em>You should avoid using this method</em>, it has severe negative 1582 * consequences on how well the system can manage its resources. A better 1583 * approach is to implement an application service that you control with 1584 * {@link Context#startService} and {@link Context#stopService}. 1585 * 1586 * @param isPersistent Control whether the current activity must be 1587 * persistent, true if so, false for the normal 1588 * behavior. 1589 */ 1590 public void setPersistent(boolean isPersistent) { 1591 if (mParent == null) { 1592 try { 1593 ActivityManagerNative.getDefault() 1594 .setPersistent(mToken, isPersistent); 1595 } catch (RemoteException e) { 1596 // Empty 1597 } 1598 } else { 1599 throw new RuntimeException("setPersistent() not yet supported for embedded activities"); 1600 } 1601 } 1602 1603 /** 1604 * Finds a view that was identified by the id attribute from the XML that 1605 * was processed in {@link #onCreate}. 1606 * 1607 * @return The view if found or null otherwise. 1608 */ 1609 public View findViewById(int id) { 1610 return getWindow().findViewById(id); 1611 } 1612 1613 /** 1614 * Set the activity content from a layout resource. The resource will be 1615 * inflated, adding all top-level views to the activity. 1616 * 1617 * @param layoutResID Resource ID to be inflated. 1618 */ 1619 public void setContentView(int layoutResID) { 1620 getWindow().setContentView(layoutResID); 1621 } 1622 1623 /** 1624 * Set the activity content to an explicit view. This view is placed 1625 * directly into the activity's view hierarchy. It can itself be a complex 1626 * view hierarhcy. 1627 * 1628 * @param view The desired content to display. 1629 */ 1630 public void setContentView(View view) { 1631 getWindow().setContentView(view); 1632 } 1633 1634 /** 1635 * Set the activity content to an explicit view. This view is placed 1636 * directly into the activity's view hierarchy. It can itself be a complex 1637 * view hierarhcy. 1638 * 1639 * @param view The desired content to display. 1640 * @param params Layout parameters for the view. 1641 */ 1642 public void setContentView(View view, ViewGroup.LayoutParams params) { 1643 getWindow().setContentView(view, params); 1644 } 1645 1646 /** 1647 * Add an additional content view to the activity. Added after any existing 1648 * ones in the activity -- existing views are NOT removed. 1649 * 1650 * @param view The desired content to display. 1651 * @param params Layout parameters for the view. 1652 */ 1653 public void addContentView(View view, ViewGroup.LayoutParams params) { 1654 getWindow().addContentView(view, params); 1655 } 1656 1657 /** 1658 * Use with {@link #setDefaultKeyMode} to turn off default handling of 1659 * keys. 1660 * 1661 * @see #setDefaultKeyMode 1662 */ 1663 static public final int DEFAULT_KEYS_DISABLE = 0; 1664 /** 1665 * Use with {@link #setDefaultKeyMode} to launch the dialer during default 1666 * key handling. 1667 * 1668 * @see #setDefaultKeyMode 1669 */ 1670 static public final int DEFAULT_KEYS_DIALER = 1; 1671 /** 1672 * Use with {@link #setDefaultKeyMode} to execute a menu shortcut in 1673 * default key handling. 1674 * 1675 * <p>That is, the user does not need to hold down the menu key to execute menu shortcuts. 1676 * 1677 * @see #setDefaultKeyMode 1678 */ 1679 static public final int DEFAULT_KEYS_SHORTCUT = 2; 1680 /** 1681 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes 1682 * will start an application-defined search. (If the application or activity does not 1683 * actually define a search, the the keys will be ignored.) 1684 * 1685 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details. 1686 * 1687 * @see #setDefaultKeyMode 1688 */ 1689 static public final int DEFAULT_KEYS_SEARCH_LOCAL = 3; 1690 1691 /** 1692 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes 1693 * will start a global search (typically web search, but some platforms may define alternate 1694 * methods for global search) 1695 * 1696 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details. 1697 * 1698 * @see #setDefaultKeyMode 1699 */ 1700 static public final int DEFAULT_KEYS_SEARCH_GLOBAL = 4; 1701 1702 /** 1703 * Select the default key handling for this activity. This controls what 1704 * will happen to key events that are not otherwise handled. The default 1705 * mode ({@link #DEFAULT_KEYS_DISABLE}) will simply drop them on the 1706 * floor. Other modes allow you to launch the dialer 1707 * ({@link #DEFAULT_KEYS_DIALER}), execute a shortcut in your options 1708 * menu without requiring the menu key be held down 1709 * ({@link #DEFAULT_KEYS_SHORTCUT}), or launch a search ({@link #DEFAULT_KEYS_SEARCH_LOCAL} 1710 * and {@link #DEFAULT_KEYS_SEARCH_GLOBAL}). 1711 * 1712 * <p>Note that the mode selected here does not impact the default 1713 * handling of system keys, such as the "back" and "menu" keys, and your 1714 * activity and its views always get a first chance to receive and handle 1715 * all application keys. 1716 * 1717 * @param mode The desired default key mode constant. 1718 * 1719 * @see #DEFAULT_KEYS_DISABLE 1720 * @see #DEFAULT_KEYS_DIALER 1721 * @see #DEFAULT_KEYS_SHORTCUT 1722 * @see #DEFAULT_KEYS_SEARCH_LOCAL 1723 * @see #DEFAULT_KEYS_SEARCH_GLOBAL 1724 * @see #onKeyDown 1725 */ 1726 public final void setDefaultKeyMode(int mode) { 1727 mDefaultKeyMode = mode; 1728 1729 // Some modes use a SpannableStringBuilder to track & dispatch input events 1730 // This list must remain in sync with the switch in onKeyDown() 1731 switch (mode) { 1732 case DEFAULT_KEYS_DISABLE: 1733 case DEFAULT_KEYS_SHORTCUT: 1734 mDefaultKeySsb = null; // not used in these modes 1735 break; 1736 case DEFAULT_KEYS_DIALER: 1737 case DEFAULT_KEYS_SEARCH_LOCAL: 1738 case DEFAULT_KEYS_SEARCH_GLOBAL: 1739 mDefaultKeySsb = new SpannableStringBuilder(); 1740 Selection.setSelection(mDefaultKeySsb,0); 1741 break; 1742 default: 1743 throw new IllegalArgumentException(); 1744 } 1745 } 1746 1747 /** 1748 * Called when a key was pressed down and not handled by any of the views 1749 * inside of the activity. So, for example, key presses while the cursor 1750 * is inside a TextView will not trigger the event (unless it is a navigation 1751 * to another object) because TextView handles its own key presses. 1752 * 1753 * <p>If the focused view didn't want this event, this method is called. 1754 * 1755 * <p>The default implementation handles KEYCODE_BACK to stop the activity 1756 * and go back, and other default key handling if configured with {@link #setDefaultKeyMode}. 1757 * 1758 * @return Return <code>true</code> to prevent this event from being propagated 1759 * further, or <code>false</code> to indicate that you have not handled 1760 * this event and it should continue to be propagated. 1761 * @see #onKeyUp 1762 * @see android.view.KeyEvent 1763 */ 1764 public boolean onKeyDown(int keyCode, KeyEvent event) { 1765 if (keyCode == KeyEvent.KEYCODE_BACK && event.getRepeatCount() == 0) { 1766 finish(); 1767 return true; 1768 } 1769 1770 if (mDefaultKeyMode == DEFAULT_KEYS_DISABLE) { 1771 return false; 1772 } else if (mDefaultKeyMode == DEFAULT_KEYS_SHORTCUT) { 1773 return getWindow().performPanelShortcut(Window.FEATURE_OPTIONS_PANEL, 1774 keyCode, event, Menu.FLAG_ALWAYS_PERFORM_CLOSE); 1775 } else { 1776 // Common code for DEFAULT_KEYS_DIALER & DEFAULT_KEYS_SEARCH_* 1777 boolean clearSpannable = false; 1778 boolean handled; 1779 if ((event.getRepeatCount() != 0) || event.isSystem()) { 1780 clearSpannable = true; 1781 handled = false; 1782 } else { 1783 handled = TextKeyListener.getInstance().onKeyDown(null, mDefaultKeySsb, 1784 keyCode, event); 1785 if (handled && mDefaultKeySsb.length() > 0) { 1786 // something useable has been typed - dispatch it now. 1787 1788 final String str = mDefaultKeySsb.toString(); 1789 clearSpannable = true; 1790 1791 switch (mDefaultKeyMode) { 1792 case DEFAULT_KEYS_DIALER: 1793 Intent intent = new Intent(Intent.ACTION_DIAL, Uri.parse("tel:" + str)); 1794 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); 1795 startActivity(intent); 1796 break; 1797 case DEFAULT_KEYS_SEARCH_LOCAL: 1798 startSearch(str, false, null, false); 1799 break; 1800 case DEFAULT_KEYS_SEARCH_GLOBAL: 1801 startSearch(str, false, null, true); 1802 break; 1803 } 1804 } 1805 } 1806 if (clearSpannable) { 1807 mDefaultKeySsb.clear(); 1808 mDefaultKeySsb.clearSpans(); 1809 Selection.setSelection(mDefaultKeySsb,0); 1810 } 1811 return handled; 1812 } 1813 } 1814 1815 /** 1816 * Called when a key was released and not handled by any of the views 1817 * inside of the activity. So, for example, key presses while the cursor 1818 * is inside a TextView will not trigger the event (unless it is a navigation 1819 * to another object) because TextView handles its own key presses. 1820 * 1821 * @return Return <code>true</code> to prevent this event from being propagated 1822 * further, or <code>false</code> to indicate that you have not handled 1823 * this event and it should continue to be propagated. 1824 * @see #onKeyDown 1825 * @see KeyEvent 1826 */ 1827 public boolean onKeyUp(int keyCode, KeyEvent event) { 1828 return false; 1829 } 1830 1831 /** 1832 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 1833 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 1834 * the event). 1835 */ 1836 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 1837 return false; 1838 } 1839 1840 /** 1841 * Called when a touch screen event was not handled by any of the views 1842 * under it. This is most useful to process touch events that happen 1843 * outside of your window bounds, where there is no view to receive it. 1844 * 1845 * @param event The touch screen event being processed. 1846 * 1847 * @return Return true if you have consumed the event, false if you haven't. 1848 * The default implementation always returns false. 1849 */ 1850 public boolean onTouchEvent(MotionEvent event) { 1851 return false; 1852 } 1853 1854 /** 1855 * Called when the trackball was moved and not handled by any of the 1856 * views inside of the activity. So, for example, if the trackball moves 1857 * while focus is on a button, you will receive a call here because 1858 * buttons do not normally do anything with trackball events. The call 1859 * here happens <em>before</em> trackball movements are converted to 1860 * DPAD key events, which then get sent back to the view hierarchy, and 1861 * will be processed at the point for things like focus navigation. 1862 * 1863 * @param event The trackball event being processed. 1864 * 1865 * @return Return true if you have consumed the event, false if you haven't. 1866 * The default implementation always returns false. 1867 */ 1868 public boolean onTrackballEvent(MotionEvent event) { 1869 return false; 1870 } 1871 1872 /** 1873 * Called whenever a key, touch, or trackball event is dispatched to the 1874 * activity. Implement this method if you wish to know that the user has 1875 * interacted with the device in some way while your activity is running. 1876 * This callback and {@link #onUserLeaveHint} are intended to help 1877 * activities manage status bar notifications intelligently; specifically, 1878 * for helping activities determine the proper time to cancel a notfication. 1879 * 1880 * <p>All calls to your activity's {@link #onUserLeaveHint} callback will 1881 * be accompanied by calls to {@link #onUserInteraction}. This 1882 * ensures that your activity will be told of relevant user activity such 1883 * as pulling down the notification pane and touching an item there. 1884 * 1885 * <p>Note that this callback will be invoked for the touch down action 1886 * that begins a touch gesture, but may not be invoked for the touch-moved 1887 * and touch-up actions that follow. 1888 * 1889 * @see #onUserLeaveHint() 1890 */ 1891 public void onUserInteraction() { 1892 } 1893 1894 public void onWindowAttributesChanged(WindowManager.LayoutParams params) { 1895 // Update window manager if: we have a view, that view is 1896 // attached to its parent (which will be a RootView), and 1897 // this activity is not embedded. 1898 if (mParent == null) { 1899 View decor = mDecor; 1900 if (decor != null && decor.getParent() != null) { 1901 getWindowManager().updateViewLayout(decor, params); 1902 } 1903 } 1904 } 1905 1906 public void onContentChanged() { 1907 } 1908 1909 /** 1910 * Called when the current {@link Window} of the activity gains or loses 1911 * focus. This is the best indicator of whether this activity is visible 1912 * to the user. 1913 * 1914 * <p>Note that this provides information what global focus state, which 1915 * is managed independently of activity lifecycles. As such, while focus 1916 * changes will generally have some relation to lifecycle changes (an 1917 * activity that is stopped will not generally get window focus), you 1918 * should not rely on any particular order between the callbacks here and 1919 * those in the other lifecycle methods such as {@link #onResume}. 1920 * 1921 * <p>As a general rule, however, a resumed activity will have window 1922 * focus... unless it has displayed other dialogs or popups that take 1923 * input focus, in which case the activity itself will not have focus 1924 * when the other windows have it. Likewise, the system may display 1925 * system-level windows (such as the status bar notification panel or 1926 * a system alert) which will temporarily take window input focus without 1927 * pausing the foreground activity. 1928 * 1929 * @param hasFocus Whether the window of this activity has focus. 1930 * 1931 * @see #hasWindowFocus() 1932 * @see #onResume 1933 */ 1934 public void onWindowFocusChanged(boolean hasFocus) { 1935 } 1936 1937 /** 1938 * Returns true if this activity's <em>main</em> window currently has window focus. 1939 * Note that this is not the same as the view itself having focus. 1940 * 1941 * @return True if this activity's main window currently has window focus. 1942 * 1943 * @see #onWindowAttributesChanged(android.view.WindowManager.LayoutParams) 1944 */ 1945 public boolean hasWindowFocus() { 1946 Window w = getWindow(); 1947 if (w != null) { 1948 View d = w.getDecorView(); 1949 if (d != null) { 1950 return d.hasWindowFocus(); 1951 } 1952 } 1953 return false; 1954 } 1955 1956 /** 1957 * Called to process key events. You can override this to intercept all 1958 * key events before they are dispatched to the window. Be sure to call 1959 * this implementation for key events that should be handled normally. 1960 * 1961 * @param event The key event. 1962 * 1963 * @return boolean Return true if this event was consumed. 1964 */ 1965 public boolean dispatchKeyEvent(KeyEvent event) { 1966 onUserInteraction(); 1967 if (getWindow().superDispatchKeyEvent(event)) { 1968 return true; 1969 } 1970 return event.dispatch(this); 1971 } 1972 1973 /** 1974 * Called to process touch screen events. You can override this to 1975 * intercept all touch screen events before they are dispatched to the 1976 * window. Be sure to call this implementation for touch screen events 1977 * that should be handled normally. 1978 * 1979 * @param ev The touch screen event. 1980 * 1981 * @return boolean Return true if this event was consumed. 1982 */ 1983 public boolean dispatchTouchEvent(MotionEvent ev) { 1984 if (ev.getAction() == MotionEvent.ACTION_DOWN) { 1985 onUserInteraction(); 1986 } 1987 if (getWindow().superDispatchTouchEvent(ev)) { 1988 return true; 1989 } 1990 return onTouchEvent(ev); 1991 } 1992 1993 /** 1994 * Called to process trackball events. You can override this to 1995 * intercept all trackball events before they are dispatched to the 1996 * window. Be sure to call this implementation for trackball events 1997 * that should be handled normally. 1998 * 1999 * @param ev The trackball event. 2000 * 2001 * @return boolean Return true if this event was consumed. 2002 */ 2003 public boolean dispatchTrackballEvent(MotionEvent ev) { 2004 onUserInteraction(); 2005 if (getWindow().superDispatchTrackballEvent(ev)) { 2006 return true; 2007 } 2008 return onTrackballEvent(ev); 2009 } 2010 2011 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 2012 event.setClassName(getClass().getName()); 2013 event.setPackageName(getPackageName()); 2014 2015 LayoutParams params = getWindow().getAttributes(); 2016 boolean isFullScreen = (params.width == LayoutParams.FILL_PARENT) && 2017 (params.height == LayoutParams.FILL_PARENT); 2018 event.setFullScreen(isFullScreen); 2019 2020 CharSequence title = getTitle(); 2021 if (!TextUtils.isEmpty(title)) { 2022 event.getText().add(title); 2023 } 2024 2025 return true; 2026 } 2027 2028 /** 2029 * Default implementation of 2030 * {@link android.view.Window.Callback#onCreatePanelView} 2031 * for activities. This 2032 * simply returns null so that all panel sub-windows will have the default 2033 * menu behavior. 2034 */ 2035 public View onCreatePanelView(int featureId) { 2036 return null; 2037 } 2038 2039 /** 2040 * Default implementation of 2041 * {@link android.view.Window.Callback#onCreatePanelMenu} 2042 * for activities. This calls through to the new 2043 * {@link #onCreateOptionsMenu} method for the 2044 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel, 2045 * so that subclasses of Activity don't need to deal with feature codes. 2046 */ 2047 public boolean onCreatePanelMenu(int featureId, Menu menu) { 2048 if (featureId == Window.FEATURE_OPTIONS_PANEL) { 2049 return onCreateOptionsMenu(menu); 2050 } 2051 return false; 2052 } 2053 2054 /** 2055 * Default implementation of 2056 * {@link android.view.Window.Callback#onPreparePanel} 2057 * for activities. This 2058 * calls through to the new {@link #onPrepareOptionsMenu} method for the 2059 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} 2060 * panel, so that subclasses of 2061 * Activity don't need to deal with feature codes. 2062 */ 2063 public boolean onPreparePanel(int featureId, View view, Menu menu) { 2064 if (featureId == Window.FEATURE_OPTIONS_PANEL && menu != null) { 2065 boolean goforit = onPrepareOptionsMenu(menu); 2066 return goforit && menu.hasVisibleItems(); 2067 } 2068 return true; 2069 } 2070 2071 /** 2072 * {@inheritDoc} 2073 * 2074 * @return The default implementation returns true. 2075 */ 2076 public boolean onMenuOpened(int featureId, Menu menu) { 2077 return true; 2078 } 2079 2080 /** 2081 * Default implementation of 2082 * {@link android.view.Window.Callback#onMenuItemSelected} 2083 * for activities. This calls through to the new 2084 * {@link #onOptionsItemSelected} method for the 2085 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} 2086 * panel, so that subclasses of 2087 * Activity don't need to deal with feature codes. 2088 */ 2089 public boolean onMenuItemSelected(int featureId, MenuItem item) { 2090 switch (featureId) { 2091 case Window.FEATURE_OPTIONS_PANEL: 2092 // Put event logging here so it gets called even if subclass 2093 // doesn't call through to superclass's implmeentation of each 2094 // of these methods below 2095 EventLog.writeEvent(50000, 0, item.getTitleCondensed()); 2096 return onOptionsItemSelected(item); 2097 2098 case Window.FEATURE_CONTEXT_MENU: 2099 EventLog.writeEvent(50000, 1, item.getTitleCondensed()); 2100 return onContextItemSelected(item); 2101 2102 default: 2103 return false; 2104 } 2105 } 2106 2107 /** 2108 * Default implementation of 2109 * {@link android.view.Window.Callback#onPanelClosed(int, Menu)} for 2110 * activities. This calls through to {@link #onOptionsMenuClosed(Menu)} 2111 * method for the {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel, 2112 * so that subclasses of Activity don't need to deal with feature codes. 2113 * For context menus ({@link Window#FEATURE_CONTEXT_MENU}), the 2114 * {@link #onContextMenuClosed(Menu)} will be called. 2115 */ 2116 public void onPanelClosed(int featureId, Menu menu) { 2117 switch (featureId) { 2118 case Window.FEATURE_OPTIONS_PANEL: 2119 onOptionsMenuClosed(menu); 2120 break; 2121 2122 case Window.FEATURE_CONTEXT_MENU: 2123 onContextMenuClosed(menu); 2124 break; 2125 } 2126 } 2127 2128 /** 2129 * Initialize the contents of the Activity's standard options menu. You 2130 * should place your menu items in to <var>menu</var>. 2131 * 2132 * <p>This is only called once, the first time the options menu is 2133 * displayed. To update the menu every time it is displayed, see 2134 * {@link #onPrepareOptionsMenu}. 2135 * 2136 * <p>The default implementation populates the menu with standard system 2137 * menu items. These are placed in the {@link Menu#CATEGORY_SYSTEM} group so that 2138 * they will be correctly ordered with application-defined menu items. 2139 * Deriving classes should always call through to the base implementation. 2140 * 2141 * <p>You can safely hold on to <var>menu</var> (and any items created 2142 * from it), making modifications to it as desired, until the next 2143 * time onCreateOptionsMenu() is called. 2144 * 2145 * <p>When you add items to the menu, you can implement the Activity's 2146 * {@link #onOptionsItemSelected} method to handle them there. 2147 * 2148 * @param menu The options menu in which you place your items. 2149 * 2150 * @return You must return true for the menu to be displayed; 2151 * if you return false it will not be shown. 2152 * 2153 * @see #onPrepareOptionsMenu 2154 * @see #onOptionsItemSelected 2155 */ 2156 public boolean onCreateOptionsMenu(Menu menu) { 2157 if (mParent != null) { 2158 return mParent.onCreateOptionsMenu(menu); 2159 } 2160 return true; 2161 } 2162 2163 /** 2164 * Prepare the Screen's standard options menu to be displayed. This is 2165 * called right before the menu is shown, every time it is shown. You can 2166 * use this method to efficiently enable/disable items or otherwise 2167 * dynamically modify the contents. 2168 * 2169 * <p>The default implementation updates the system menu items based on the 2170 * activity's state. Deriving classes should always call through to the 2171 * base class implementation. 2172 * 2173 * @param menu The options menu as last shown or first initialized by 2174 * onCreateOptionsMenu(). 2175 * 2176 * @return You must return true for the menu to be displayed; 2177 * if you return false it will not be shown. 2178 * 2179 * @see #onCreateOptionsMenu 2180 */ 2181 public boolean onPrepareOptionsMenu(Menu menu) { 2182 if (mParent != null) { 2183 return mParent.onPrepareOptionsMenu(menu); 2184 } 2185 return true; 2186 } 2187 2188 /** 2189 * This hook is called whenever an item in your options menu is selected. 2190 * The default implementation simply returns false to have the normal 2191 * processing happen (calling the item's Runnable or sending a message to 2192 * its Handler as appropriate). You can use this method for any items 2193 * for which you would like to do processing without those other 2194 * facilities. 2195 * 2196 * <p>Derived classes should call through to the base class for it to 2197 * perform the default menu handling. 2198 * 2199 * @param item The menu item that was selected. 2200 * 2201 * @return boolean Return false to allow normal menu processing to 2202 * proceed, true to consume it here. 2203 * 2204 * @see #onCreateOptionsMenu 2205 */ 2206 public boolean onOptionsItemSelected(MenuItem item) { 2207 if (mParent != null) { 2208 return mParent.onOptionsItemSelected(item); 2209 } 2210 return false; 2211 } 2212 2213 /** 2214 * This hook is called whenever the options menu is being closed (either by the user canceling 2215 * the menu with the back/menu button, or when an item is selected). 2216 * 2217 * @param menu The options menu as last shown or first initialized by 2218 * onCreateOptionsMenu(). 2219 */ 2220 public void onOptionsMenuClosed(Menu menu) { 2221 if (mParent != null) { 2222 mParent.onOptionsMenuClosed(menu); 2223 } 2224 } 2225 2226 /** 2227 * Programmatically opens the options menu. If the options menu is already 2228 * open, this method does nothing. 2229 */ 2230 public void openOptionsMenu() { 2231 mWindow.openPanel(Window.FEATURE_OPTIONS_PANEL, null); 2232 } 2233 2234 /** 2235 * Progammatically closes the options menu. If the options menu is already 2236 * closed, this method does nothing. 2237 */ 2238 public void closeOptionsMenu() { 2239 mWindow.closePanel(Window.FEATURE_OPTIONS_PANEL); 2240 } 2241 2242 /** 2243 * Called when a context menu for the {@code view} is about to be shown. 2244 * Unlike {@link #onCreateOptionsMenu(Menu)}, this will be called every 2245 * time the context menu is about to be shown and should be populated for 2246 * the view (or item inside the view for {@link AdapterView} subclasses, 2247 * this can be found in the {@code menuInfo})). 2248 * <p> 2249 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an 2250 * item has been selected. 2251 * <p> 2252 * It is not safe to hold onto the context menu after this method returns. 2253 * {@inheritDoc} 2254 */ 2255 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { 2256 } 2257 2258 /** 2259 * Registers a context menu to be shown for the given view (multiple views 2260 * can show the context menu). This method will set the 2261 * {@link OnCreateContextMenuListener} on the view to this activity, so 2262 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be 2263 * called when it is time to show the context menu. 2264 * 2265 * @see #unregisterForContextMenu(View) 2266 * @param view The view that should show a context menu. 2267 */ 2268 public void registerForContextMenu(View view) { 2269 view.setOnCreateContextMenuListener(this); 2270 } 2271 2272 /** 2273 * Prevents a context menu to be shown for the given view. This method will remove the 2274 * {@link OnCreateContextMenuListener} on the view. 2275 * 2276 * @see #registerForContextMenu(View) 2277 * @param view The view that should stop showing a context menu. 2278 */ 2279 public void unregisterForContextMenu(View view) { 2280 view.setOnCreateContextMenuListener(null); 2281 } 2282 2283 /** 2284 * Programmatically opens the context menu for a particular {@code view}. 2285 * The {@code view} should have been added via 2286 * {@link #registerForContextMenu(View)}. 2287 * 2288 * @param view The view to show the context menu for. 2289 */ 2290 public void openContextMenu(View view) { 2291 view.showContextMenu(); 2292 } 2293 2294 /** 2295 * Programmatically closes the most recently opened context menu, if showing. 2296 */ 2297 public void closeContextMenu() { 2298 mWindow.closePanel(Window.FEATURE_CONTEXT_MENU); 2299 } 2300 2301 /** 2302 * This hook is called whenever an item in a context menu is selected. The 2303 * default implementation simply returns false to have the normal processing 2304 * happen (calling the item's Runnable or sending a message to its Handler 2305 * as appropriate). You can use this method for any items for which you 2306 * would like to do processing without those other facilities. 2307 * <p> 2308 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the 2309 * View that added this menu item. 2310 * <p> 2311 * Derived classes should call through to the base class for it to perform 2312 * the default menu handling. 2313 * 2314 * @param item The context menu item that was selected. 2315 * @return boolean Return false to allow normal context menu processing to 2316 * proceed, true to consume it here. 2317 */ 2318 public boolean onContextItemSelected(MenuItem item) { 2319 if (mParent != null) { 2320 return mParent.onContextItemSelected(item); 2321 } 2322 return false; 2323 } 2324 2325 /** 2326 * This hook is called whenever the context menu is being closed (either by 2327 * the user canceling the menu with the back/menu button, or when an item is 2328 * selected). 2329 * 2330 * @param menu The context menu that is being closed. 2331 */ 2332 public void onContextMenuClosed(Menu menu) { 2333 if (mParent != null) { 2334 mParent.onContextMenuClosed(menu); 2335 } 2336 } 2337 2338 /** 2339 * Callback for creating dialogs that are managed (saved and restored) for you 2340 * by the activity. 2341 * 2342 * If you use {@link #showDialog(int)}, the activity will call through to 2343 * this method the first time, and hang onto it thereafter. Any dialog 2344 * that is created by this method will automatically be saved and restored 2345 * for you, including whether it is showing. 2346 * 2347 * If you would like the activity to manage the saving and restoring dialogs 2348 * for you, you should override this method and handle any ids that are 2349 * passed to {@link #showDialog}. 2350 * 2351 * If you would like an opportunity to prepare your dialog before it is shown, 2352 * override {@link #onPrepareDialog(int, Dialog)}. 2353 * 2354 * @param id The id of the dialog. 2355 * @return The dialog 2356 * 2357 * @see #onPrepareDialog(int, Dialog) 2358 * @see #showDialog(int) 2359 * @see #dismissDialog(int) 2360 * @see #removeDialog(int) 2361 */ 2362 protected Dialog onCreateDialog(int id) { 2363 return null; 2364 } 2365 2366 /** 2367 * Provides an opportunity to prepare a managed dialog before it is being 2368 * shown. 2369 * <p> 2370 * Override this if you need to update a managed dialog based on the state 2371 * of the application each time it is shown. For example, a time picker 2372 * dialog might want to be updated with the current time. You should call 2373 * through to the superclass's implementation. The default implementation 2374 * will set this Activity as the owner activity on the Dialog. 2375 * 2376 * @param id The id of the managed dialog. 2377 * @param dialog The dialog. 2378 * @see #onCreateDialog(int) 2379 * @see #showDialog(int) 2380 * @see #dismissDialog(int) 2381 * @see #removeDialog(int) 2382 */ 2383 protected void onPrepareDialog(int id, Dialog dialog) { 2384 dialog.setOwnerActivity(this); 2385 } 2386 2387 /** 2388 * Show a dialog managed by this activity. A call to {@link #onCreateDialog(int)} 2389 * will be made with the same id the first time this is called for a given 2390 * id. From thereafter, the dialog will be automatically saved and restored. 2391 * 2392 * Each time a dialog is shown, {@link #onPrepareDialog(int, Dialog)} will 2393 * be made to provide an opportunity to do any timely preparation. 2394 * 2395 * @param id The id of the managed dialog. 2396 * 2397 * @see Dialog 2398 * @see #onCreateDialog(int) 2399 * @see #onPrepareDialog(int, Dialog) 2400 * @see #dismissDialog(int) 2401 * @see #removeDialog(int) 2402 */ 2403 public final void showDialog(int id) { 2404 if (mManagedDialogs == null) { 2405 mManagedDialogs = new SparseArray<Dialog>(); 2406 } 2407 Dialog dialog = mManagedDialogs.get(id); 2408 if (dialog == null) { 2409 dialog = createDialog(id, null); 2410 mManagedDialogs.put(id, dialog); 2411 } 2412 2413 onPrepareDialog(id, dialog); 2414 dialog.show(); 2415 } 2416 2417 /** 2418 * Dismiss a dialog that was previously shown via {@link #showDialog(int)}. 2419 * 2420 * @param id The id of the managed dialog. 2421 * 2422 * @throws IllegalArgumentException if the id was not previously shown via 2423 * {@link #showDialog(int)}. 2424 * 2425 * @see #onCreateDialog(int) 2426 * @see #onPrepareDialog(int, Dialog) 2427 * @see #showDialog(int) 2428 * @see #removeDialog(int) 2429 */ 2430 public final void dismissDialog(int id) { 2431 if (mManagedDialogs == null) { 2432 throw missingDialog(id); 2433 2434 } 2435 final Dialog dialog = mManagedDialogs.get(id); 2436 if (dialog == null) { 2437 throw missingDialog(id); 2438 } 2439 dialog.dismiss(); 2440 } 2441 2442 /** 2443 * Creates an exception to throw if a user passed in a dialog id that is 2444 * unexpected. 2445 */ 2446 private IllegalArgumentException missingDialog(int id) { 2447 return new IllegalArgumentException("no dialog with id " + id + " was ever " 2448 + "shown via Activity#showDialog"); 2449 } 2450 2451 /** 2452 * Removes any internal references to a dialog managed by this Activity. 2453 * If the dialog is showing, it will dismiss it as part of the clean up. 2454 * 2455 * This can be useful if you know that you will never show a dialog again and 2456 * want to avoid the overhead of saving and restoring it in the future. 2457 * 2458 * @param id The id of the managed dialog. 2459 * 2460 * @see #onCreateDialog(int) 2461 * @see #onPrepareDialog(int, Dialog) 2462 * @see #showDialog(int) 2463 * @see #dismissDialog(int) 2464 */ 2465 public final void removeDialog(int id) { 2466 2467 if (mManagedDialogs == null) { 2468 return; 2469 } 2470 2471 final Dialog dialog = mManagedDialogs.get(id); 2472 if (dialog == null) { 2473 return; 2474 } 2475 2476 dialog.dismiss(); 2477 mManagedDialogs.remove(id); 2478 } 2479 2480 /** 2481 * This hook is called when the user signals the desire to start a search. 2482 * 2483 * <p>You can use this function as a simple way to launch the search UI, in response to a 2484 * menu item, search button, or other widgets within your activity. Unless overidden, 2485 * calling this function is the same as calling: 2486 * <p>The default implementation simply calls 2487 * {@link #startSearch startSearch(null, false, null, false)}, launching a local search. 2488 * 2489 * <p>You can override this function to force global search, e.g. in response to a dedicated 2490 * search key, or to block search entirely (by simply returning false). 2491 * 2492 * @return Returns true if search launched, false if activity blocks it 2493 * 2494 * @see android.app.SearchManager 2495 */ 2496 public boolean onSearchRequested() { 2497 startSearch(null, false, null, false); 2498 return true; 2499 } 2500 2501 /** 2502 * This hook is called to launch the search UI. 2503 * 2504 * <p>It is typically called from onSearchRequested(), either directly from 2505 * Activity.onSearchRequested() or from an overridden version in any given 2506 * Activity. If your goal is simply to activate search, it is preferred to call 2507 * onSearchRequested(), which may have been overriden elsewhere in your Activity. If your goal 2508 * is to inject specific data such as context data, it is preferred to <i>override</i> 2509 * onSearchRequested(), so that any callers to it will benefit from the override. 2510 * 2511 * @param initialQuery Any non-null non-empty string will be inserted as 2512 * pre-entered text in the search query box. 2513 * @param selectInitialQuery If true, the intial query will be preselected, which means that 2514 * any further typing will replace it. This is useful for cases where an entire pre-formed 2515 * query is being inserted. If false, the selection point will be placed at the end of the 2516 * inserted query. This is useful when the inserted query is text that the user entered, 2517 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful 2518 * if initialQuery is a non-empty string.</i> 2519 * @param appSearchData An application can insert application-specific 2520 * context here, in order to improve quality or specificity of its own 2521 * searches. This data will be returned with SEARCH intent(s). Null if 2522 * no extra data is required. 2523 * @param globalSearch If false, this will only launch the search that has been specifically 2524 * defined by the application (which is usually defined as a local search). If no default 2525 * search is defined in the current application or activity, no search will be launched. 2526 * If true, this will always launch a platform-global (e.g. web-based) search instead. 2527 * 2528 * @see android.app.SearchManager 2529 * @see #onSearchRequested 2530 */ 2531 public void startSearch(String initialQuery, boolean selectInitialQuery, 2532 Bundle appSearchData, boolean globalSearch) { 2533 ensureSearchManager(); 2534 mSearchManager.startSearch(initialQuery, selectInitialQuery, getComponentName(), 2535 appSearchData, globalSearch); 2536 } 2537 2538 /** 2539 * Similar to {@link #startSearch}, but actually fires off the search query after invoking 2540 * the search dialog. Made available for testing purposes. 2541 * 2542 * @param query The query to trigger. If empty, the request will be ignored. 2543 * @param appSearchData An application can insert application-specific 2544 * context here, in order to improve quality or specificity of its own 2545 * searches. This data will be returned with SEARCH intent(s). Null if 2546 * no extra data is required. 2547 * @param globalSearch If false, this will only launch the search that has been specifically 2548 * defined by the application (which is usually defined as a local search). If no default 2549 * search is defined in the current application or activity, no search will be launched. 2550 * If true, this will always launch a platform-global (e.g. web-based) search instead. 2551 */ 2552 public void triggerSearch(String query, Bundle appSearchData, boolean globalSearch) { 2553 ensureSearchManager(); 2554 mSearchManager.triggerSearch(query, getComponentName(), appSearchData, globalSearch); 2555 } 2556 2557 /** 2558 * Request that key events come to this activity. Use this if your 2559 * activity has no views with focus, but the activity still wants 2560 * a chance to process key events. 2561 * 2562 * @see android.view.Window#takeKeyEvents 2563 */ 2564 public void takeKeyEvents(boolean get) { 2565 getWindow().takeKeyEvents(get); 2566 } 2567 2568 /** 2569 * Enable extended window features. This is a convenience for calling 2570 * {@link android.view.Window#requestFeature getWindow().requestFeature()}. 2571 * 2572 * @param featureId The desired feature as defined in 2573 * {@link android.view.Window}. 2574 * @return Returns true if the requested feature is supported and now 2575 * enabled. 2576 * 2577 * @see android.view.Window#requestFeature 2578 */ 2579 public final boolean requestWindowFeature(int featureId) { 2580 return getWindow().requestFeature(featureId); 2581 } 2582 2583 /** 2584 * Convenience for calling 2585 * {@link android.view.Window#setFeatureDrawableResource}. 2586 */ 2587 public final void setFeatureDrawableResource(int featureId, int resId) { 2588 getWindow().setFeatureDrawableResource(featureId, resId); 2589 } 2590 2591 /** 2592 * Convenience for calling 2593 * {@link android.view.Window#setFeatureDrawableUri}. 2594 */ 2595 public final void setFeatureDrawableUri(int featureId, Uri uri) { 2596 getWindow().setFeatureDrawableUri(featureId, uri); 2597 } 2598 2599 /** 2600 * Convenience for calling 2601 * {@link android.view.Window#setFeatureDrawable(int, Drawable)}. 2602 */ 2603 public final void setFeatureDrawable(int featureId, Drawable drawable) { 2604 getWindow().setFeatureDrawable(featureId, drawable); 2605 } 2606 2607 /** 2608 * Convenience for calling 2609 * {@link android.view.Window#setFeatureDrawableAlpha}. 2610 */ 2611 public final void setFeatureDrawableAlpha(int featureId, int alpha) { 2612 getWindow().setFeatureDrawableAlpha(featureId, alpha); 2613 } 2614 2615 /** 2616 * Convenience for calling 2617 * {@link android.view.Window#getLayoutInflater}. 2618 */ 2619 public LayoutInflater getLayoutInflater() { 2620 return getWindow().getLayoutInflater(); 2621 } 2622 2623 /** 2624 * Returns a {@link MenuInflater} with this context. 2625 */ 2626 public MenuInflater getMenuInflater() { 2627 return new MenuInflater(this); 2628 } 2629 2630 @Override 2631 protected void onApplyThemeResource(Resources.Theme theme, 2632 int resid, 2633 boolean first) 2634 { 2635 if (mParent == null) { 2636 super.onApplyThemeResource(theme, resid, first); 2637 } else { 2638 try { 2639 theme.setTo(mParent.getTheme()); 2640 } catch (Exception e) { 2641 // Empty 2642 } 2643 theme.applyStyle(resid, false); 2644 } 2645 } 2646 2647 /** 2648 * Launch an activity for which you would like a result when it finished. 2649 * When this activity exits, your 2650 * onActivityResult() method will be called with the given requestCode. 2651 * Using a negative requestCode is the same as calling 2652 * {@link #startActivity} (the activity is not launched as a sub-activity). 2653 * 2654 * <p>Note that this method should only be used with Intent protocols 2655 * that are defined to return a result. In other protocols (such as 2656 * {@link Intent#ACTION_MAIN} or {@link Intent#ACTION_VIEW}), you may 2657 * not get the result when you expect. For example, if the activity you 2658 * are launching uses the singleTask launch mode, it will not run in your 2659 * task and thus you will immediately receive a cancel result. 2660 * 2661 * <p>As a special case, if you call startActivityForResult() with a requestCode 2662 * >= 0 during the initial onCreate(Bundle savedInstanceState)/onResume() of your 2663 * activity, then your window will not be displayed until a result is 2664 * returned back from the started activity. This is to avoid visible 2665 * flickering when redirecting to another activity. 2666 * 2667 * <p>This method throws {@link android.content.ActivityNotFoundException} 2668 * if there was no Activity found to run the given Intent. 2669 * 2670 * @param intent The intent to start. 2671 * @param requestCode If >= 0, this code will be returned in 2672 * onActivityResult() when the activity exits. 2673 * 2674 * @throws android.content.ActivityNotFoundException 2675 * 2676 * @see #startActivity 2677 */ 2678 public void startActivityForResult(Intent intent, int requestCode) { 2679 if (mParent == null) { 2680 Instrumentation.ActivityResult ar = 2681 mInstrumentation.execStartActivity( 2682 this, mMainThread.getApplicationThread(), mToken, this, 2683 intent, requestCode); 2684 if (ar != null) { 2685 mMainThread.sendActivityResult( 2686 mToken, mEmbeddedID, requestCode, ar.getResultCode(), 2687 ar.getResultData()); 2688 } 2689 if (requestCode >= 0) { 2690 // If this start is requesting a result, we can avoid making 2691 // the activity visible until the result is received. Setting 2692 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the 2693 // activity hidden during this time, to avoid flickering. 2694 // This can only be done when a result is requested because 2695 // that guarantees we will get information back when the 2696 // activity is finished, no matter what happens to it. 2697 mStartedActivity = true; 2698 } 2699 } else { 2700 mParent.startActivityFromChild(this, intent, requestCode); 2701 } 2702 } 2703 2704 /** 2705 * Launch a new activity. You will not receive any information about when 2706 * the activity exits. This implementation overrides the base version, 2707 * providing information about 2708 * the activity performing the launch. Because of this additional 2709 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not 2710 * required; if not specified, the new activity will be added to the 2711 * task of the caller. 2712 * 2713 * <p>This method throws {@link android.content.ActivityNotFoundException} 2714 * if there was no Activity found to run the given Intent. 2715 * 2716 * @param intent The intent to start. 2717 * 2718 * @throws android.content.ActivityNotFoundException 2719 * 2720 * @see #startActivityForResult 2721 */ 2722 @Override 2723 public void startActivity(Intent intent) { 2724 startActivityForResult(intent, -1); 2725 } 2726 2727 /** 2728 * A special variation to launch an activity only if a new activity 2729 * instance is needed to handle the given Intent. In other words, this is 2730 * just like {@link #startActivityForResult(Intent, int)} except: if you are 2731 * using the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} flag, or 2732 * singleTask or singleTop 2733 * {@link android.R.styleable#AndroidManifestActivity_launchMode launchMode}, 2734 * and the activity 2735 * that handles <var>intent</var> is the same as your currently running 2736 * activity, then a new instance is not needed. In this case, instead of 2737 * the normal behavior of calling {@link #onNewIntent} this function will 2738 * return and you can handle the Intent yourself. 2739 * 2740 * <p>This function can only be called from a top-level activity; if it is 2741 * called from a child activity, a runtime exception will be thrown. 2742 * 2743 * @param intent The intent to start. 2744 * @param requestCode If >= 0, this code will be returned in 2745 * onActivityResult() when the activity exits, as described in 2746 * {@link #startActivityForResult}. 2747 * 2748 * @return If a new activity was launched then true is returned; otherwise 2749 * false is returned and you must handle the Intent yourself. 2750 * 2751 * @see #startActivity 2752 * @see #startActivityForResult 2753 */ 2754 public boolean startActivityIfNeeded(Intent intent, int requestCode) { 2755 if (mParent == null) { 2756 int result = IActivityManager.START_RETURN_INTENT_TO_CALLER; 2757 try { 2758 result = ActivityManagerNative.getDefault() 2759 .startActivity(mMainThread.getApplicationThread(), 2760 intent, intent.resolveTypeIfNeeded( 2761 getContentResolver()), 2762 null, 0, 2763 mToken, mEmbeddedID, requestCode, true, false); 2764 } catch (RemoteException e) { 2765 // Empty 2766 } 2767 2768 Instrumentation.checkStartActivityResult(result, intent); 2769 2770 if (requestCode >= 0) { 2771 // If this start is requesting a result, we can avoid making 2772 // the activity visible until the result is received. Setting 2773 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the 2774 // activity hidden during this time, to avoid flickering. 2775 // This can only be done when a result is requested because 2776 // that guarantees we will get information back when the 2777 // activity is finished, no matter what happens to it. 2778 mStartedActivity = true; 2779 } 2780 return result != IActivityManager.START_RETURN_INTENT_TO_CALLER; 2781 } 2782 2783 throw new UnsupportedOperationException( 2784 "startActivityIfNeeded can only be called from a top-level activity"); 2785 } 2786 2787 /** 2788 * Special version of starting an activity, for use when you are replacing 2789 * other activity components. You can use this to hand the Intent off 2790 * to the next Activity that can handle it. You typically call this in 2791 * {@link #onCreate} with the Intent returned by {@link #getIntent}. 2792 * 2793 * @param intent The intent to dispatch to the next activity. For 2794 * correct behavior, this must be the same as the Intent that started 2795 * your own activity; the only changes you can make are to the extras 2796 * inside of it. 2797 * 2798 * @return Returns a boolean indicating whether there was another Activity 2799 * to start: true if there was a next activity to start, false if there 2800 * wasn't. In general, if true is returned you will then want to call 2801 * finish() on yourself. 2802 */ 2803 public boolean startNextMatchingActivity(Intent intent) { 2804 if (mParent == null) { 2805 try { 2806 return ActivityManagerNative.getDefault() 2807 .startNextMatchingActivity(mToken, intent); 2808 } catch (RemoteException e) { 2809 // Empty 2810 } 2811 return false; 2812 } 2813 2814 throw new UnsupportedOperationException( 2815 "startNextMatchingActivity can only be called from a top-level activity"); 2816 } 2817 2818 /** 2819 * This is called when a child activity of this one calls its 2820 * {@link #startActivity} or {@link #startActivityForResult} method. 2821 * 2822 * <p>This method throws {@link android.content.ActivityNotFoundException} 2823 * if there was no Activity found to run the given Intent. 2824 * 2825 * @param child The activity making the call. 2826 * @param intent The intent to start. 2827 * @param requestCode Reply request code. < 0 if reply is not requested. 2828 * 2829 * @throws android.content.ActivityNotFoundException 2830 * 2831 * @see #startActivity 2832 * @see #startActivityForResult 2833 */ 2834 public void startActivityFromChild(Activity child, Intent intent, 2835 int requestCode) { 2836 Instrumentation.ActivityResult ar = 2837 mInstrumentation.execStartActivity( 2838 this, mMainThread.getApplicationThread(), mToken, child, 2839 intent, requestCode); 2840 if (ar != null) { 2841 mMainThread.sendActivityResult( 2842 mToken, child.mEmbeddedID, requestCode, 2843 ar.getResultCode(), ar.getResultData()); 2844 } 2845 } 2846 2847 /** 2848 * Call this to set the result that your activity will return to its 2849 * caller. 2850 * 2851 * @param resultCode The result code to propagate back to the originating 2852 * activity, often RESULT_CANCELED or RESULT_OK 2853 * 2854 * @see #RESULT_CANCELED 2855 * @see #RESULT_OK 2856 * @see #RESULT_FIRST_USER 2857 * @see #setResult(int, Intent) 2858 */ 2859 public final void setResult(int resultCode) { 2860 synchronized (this) { 2861 mResultCode = resultCode; 2862 mResultData = null; 2863 } 2864 } 2865 2866 /** 2867 * Call this to set the result that your activity will return to its 2868 * caller. 2869 * 2870 * @param resultCode The result code to propagate back to the originating 2871 * activity, often RESULT_CANCELED or RESULT_OK 2872 * @param data The data to propagate back to the originating activity. 2873 * 2874 * @see #RESULT_CANCELED 2875 * @see #RESULT_OK 2876 * @see #RESULT_FIRST_USER 2877 * @see #setResult(int) 2878 */ 2879 public final void setResult(int resultCode, Intent data) { 2880 synchronized (this) { 2881 mResultCode = resultCode; 2882 mResultData = data; 2883 } 2884 } 2885 2886 /** 2887 * Return the name of the package that invoked this activity. This is who 2888 * the data in {@link #setResult setResult()} will be sent to. You can 2889 * use this information to validate that the recipient is allowed to 2890 * receive the data. 2891 * 2892 * <p>Note: if the calling activity is not expecting a result (that is it 2893 * did not use the {@link #startActivityForResult} 2894 * form that includes a request code), then the calling package will be 2895 * null. 2896 * 2897 * @return The package of the activity that will receive your 2898 * reply, or null if none. 2899 */ 2900 public String getCallingPackage() { 2901 try { 2902 return ActivityManagerNative.getDefault().getCallingPackage(mToken); 2903 } catch (RemoteException e) { 2904 return null; 2905 } 2906 } 2907 2908 /** 2909 * Return the name of the activity that invoked this activity. This is 2910 * who the data in {@link #setResult setResult()} will be sent to. You 2911 * can use this information to validate that the recipient is allowed to 2912 * receive the data. 2913 * 2914 * <p>Note: if the calling activity is not expecting a result (that is it 2915 * did not use the {@link #startActivityForResult} 2916 * form that includes a request code), then the calling package will be 2917 * null. 2918 * 2919 * @return String The full name of the activity that will receive your 2920 * reply, or null if none. 2921 */ 2922 public ComponentName getCallingActivity() { 2923 try { 2924 return ActivityManagerNative.getDefault().getCallingActivity(mToken); 2925 } catch (RemoteException e) { 2926 return null; 2927 } 2928 } 2929 2930 /** 2931 * Control whether this activity's main window is visible. This is intended 2932 * only for the special case of an activity that is not going to show a 2933 * UI itself, but can't just finish prior to onResume() because it needs 2934 * to wait for a service binding or such. Setting this to false allows 2935 * you to prevent your UI from being shown during that time. 2936 * 2937 * <p>The default value for this is taken from the 2938 * {@link android.R.attr#windowNoDisplay} attribute of the activity's theme. 2939 */ 2940 public void setVisible(boolean visible) { 2941 if (mVisibleFromClient != visible) { 2942 mVisibleFromClient = visible; 2943 if (mVisibleFromServer) { 2944 if (visible) makeVisible(); 2945 else mDecor.setVisibility(View.INVISIBLE); 2946 } 2947 } 2948 } 2949 2950 void makeVisible() { 2951 if (!mWindowAdded) { 2952 ViewManager wm = getWindowManager(); 2953 wm.addView(mDecor, getWindow().getAttributes()); 2954 mWindowAdded = true; 2955 } 2956 mDecor.setVisibility(View.VISIBLE); 2957 } 2958 2959 /** 2960 * Check to see whether this activity is in the process of finishing, 2961 * either because you called {@link #finish} on it or someone else 2962 * has requested that it finished. This is often used in 2963 * {@link #onPause} to determine whether the activity is simply pausing or 2964 * completely finishing. 2965 * 2966 * @return If the activity is finishing, returns true; else returns false. 2967 * 2968 * @see #finish 2969 */ 2970 public boolean isFinishing() { 2971 return mFinished; 2972 } 2973 2974 /** 2975 * Call this when your activity is done and should be closed. The 2976 * ActivityResult is propagated back to whoever launched you via 2977 * onActivityResult(). 2978 */ 2979 public void finish() { 2980 if (mParent == null) { 2981 int resultCode; 2982 Intent resultData; 2983 synchronized (this) { 2984 resultCode = mResultCode; 2985 resultData = mResultData; 2986 } 2987 if (Config.LOGV) Log.v(TAG, "Finishing self: token=" + mToken); 2988 try { 2989 if (ActivityManagerNative.getDefault() 2990 .finishActivity(mToken, resultCode, resultData)) { 2991 mFinished = true; 2992 } 2993 } catch (RemoteException e) { 2994 // Empty 2995 } 2996 } else { 2997 mParent.finishFromChild(this); 2998 } 2999 } 3000 3001 /** 3002 * This is called when a child activity of this one calls its 3003 * {@link #finish} method. The default implementation simply calls 3004 * finish() on this activity (the parent), finishing the entire group. 3005 * 3006 * @param child The activity making the call. 3007 * 3008 * @see #finish 3009 */ 3010 public void finishFromChild(Activity child) { 3011 finish(); 3012 } 3013 3014 /** 3015 * Force finish another activity that you had previously started with 3016 * {@link #startActivityForResult}. 3017 * 3018 * @param requestCode The request code of the activity that you had 3019 * given to startActivityForResult(). If there are multiple 3020 * activities started with this request code, they 3021 * will all be finished. 3022 */ 3023 public void finishActivity(int requestCode) { 3024 if (mParent == null) { 3025 try { 3026 ActivityManagerNative.getDefault() 3027 .finishSubActivity(mToken, mEmbeddedID, requestCode); 3028 } catch (RemoteException e) { 3029 // Empty 3030 } 3031 } else { 3032 mParent.finishActivityFromChild(this, requestCode); 3033 } 3034 } 3035 3036 /** 3037 * This is called when a child activity of this one calls its 3038 * finishActivity(). 3039 * 3040 * @param child The activity making the call. 3041 * @param requestCode Request code that had been used to start the 3042 * activity. 3043 */ 3044 public void finishActivityFromChild(Activity child, int requestCode) { 3045 try { 3046 ActivityManagerNative.getDefault() 3047 .finishSubActivity(mToken, child.mEmbeddedID, requestCode); 3048 } catch (RemoteException e) { 3049 // Empty 3050 } 3051 } 3052 3053 /** 3054 * Called when an activity you launched exits, giving you the requestCode 3055 * you started it with, the resultCode it returned, and any additional 3056 * data from it. The <var>resultCode</var> will be 3057 * {@link #RESULT_CANCELED} if the activity explicitly returned that, 3058 * didn't return any result, or crashed during its operation. 3059 * 3060 * <p>You will receive this call immediately before onResume() when your 3061 * activity is re-starting. 3062 * 3063 * @param requestCode The integer request code originally supplied to 3064 * startActivityForResult(), allowing you to identify who this 3065 * result came from. 3066 * @param resultCode The integer result code returned by the child activity 3067 * through its setResult(). 3068 * @param data An Intent, which can return result data to the caller 3069 * (various data can be attached to Intent "extras"). 3070 * 3071 * @see #startActivityForResult 3072 * @see #createPendingResult 3073 * @see #setResult(int) 3074 */ 3075 protected void onActivityResult(int requestCode, int resultCode, 3076 Intent data) { 3077 } 3078 3079 /** 3080 * Create a new PendingIntent object which you can hand to others 3081 * for them to use to send result data back to your 3082 * {@link #onActivityResult} callback. The created object will be either 3083 * one-shot (becoming invalid after a result is sent back) or multiple 3084 * (allowing any number of results to be sent through it). 3085 * 3086 * @param requestCode Private request code for the sender that will be 3087 * associated with the result data when it is returned. The sender can not 3088 * modify this value, allowing you to identify incoming results. 3089 * @param data Default data to supply in the result, which may be modified 3090 * by the sender. 3091 * @param flags May be {@link PendingIntent#FLAG_ONE_SHOT PendingIntent.FLAG_ONE_SHOT}, 3092 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE}, 3093 * {@link PendingIntent#FLAG_CANCEL_CURRENT PendingIntent.FLAG_CANCEL_CURRENT}, 3094 * {@link PendingIntent#FLAG_UPDATE_CURRENT PendingIntent.FLAG_UPDATE_CURRENT}, 3095 * or any of the flags as supported by 3096 * {@link Intent#fillIn Intent.fillIn()} to control which unspecified parts 3097 * of the intent that can be supplied when the actual send happens. 3098 * 3099 * @return Returns an existing or new PendingIntent matching the given 3100 * parameters. May return null only if 3101 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE} has been 3102 * supplied. 3103 * 3104 * @see PendingIntent 3105 */ 3106 public PendingIntent createPendingResult(int requestCode, Intent data, 3107 int flags) { 3108 String packageName = getPackageName(); 3109 try { 3110 IIntentSender target = 3111 ActivityManagerNative.getDefault().getIntentSender( 3112 IActivityManager.INTENT_SENDER_ACTIVITY_RESULT, packageName, 3113 mParent == null ? mToken : mParent.mToken, 3114 mEmbeddedID, requestCode, data, null, flags); 3115 return target != null ? new PendingIntent(target) : null; 3116 } catch (RemoteException e) { 3117 // Empty 3118 } 3119 return null; 3120 } 3121 3122 /** 3123 * Change the desired orientation of this activity. If the activity 3124 * is currently in the foreground or otherwise impacting the screen 3125 * orientation, the screen will immediately be changed (possibly causing 3126 * the activity to be restarted). Otherwise, this will be used the next 3127 * time the activity is visible. 3128 * 3129 * @param requestedOrientation An orientation constant as used in 3130 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}. 3131 */ 3132 public void setRequestedOrientation(int requestedOrientation) { 3133 if (mParent == null) { 3134 try { 3135 ActivityManagerNative.getDefault().setRequestedOrientation( 3136 mToken, requestedOrientation); 3137 } catch (RemoteException e) { 3138 // Empty 3139 } 3140 } else { 3141 mParent.setRequestedOrientation(requestedOrientation); 3142 } 3143 } 3144 3145 /** 3146 * Return the current requested orientation of the activity. This will 3147 * either be the orientation requested in its component's manifest, or 3148 * the last requested orientation given to 3149 * {@link #setRequestedOrientation(int)}. 3150 * 3151 * @return Returns an orientation constant as used in 3152 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}. 3153 */ 3154 public int getRequestedOrientation() { 3155 if (mParent == null) { 3156 try { 3157 return ActivityManagerNative.getDefault() 3158 .getRequestedOrientation(mToken); 3159 } catch (RemoteException e) { 3160 // Empty 3161 } 3162 } else { 3163 return mParent.getRequestedOrientation(); 3164 } 3165 return ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED; 3166 } 3167 3168 /** 3169 * Return the identifier of the task this activity is in. This identifier 3170 * will remain the same for the lifetime of the activity. 3171 * 3172 * @return Task identifier, an opaque integer. 3173 */ 3174 public int getTaskId() { 3175 try { 3176 return ActivityManagerNative.getDefault() 3177 .getTaskForActivity(mToken, false); 3178 } catch (RemoteException e) { 3179 return -1; 3180 } 3181 } 3182 3183 /** 3184 * Return whether this activity is the root of a task. The root is the 3185 * first activity in a task. 3186 * 3187 * @return True if this is the root activity, else false. 3188 */ 3189 public boolean isTaskRoot() { 3190 try { 3191 return ActivityManagerNative.getDefault() 3192 .getTaskForActivity(mToken, true) >= 0; 3193 } catch (RemoteException e) { 3194 return false; 3195 } 3196 } 3197 3198 /** 3199 * Move the task containing this activity to the back of the activity 3200 * stack. The activity's order within the task is unchanged. 3201 * 3202 * @param nonRoot If false then this only works if the activity is the root 3203 * of a task; if true it will work for any activity in 3204 * a task. 3205 * 3206 * @return If the task was moved (or it was already at the 3207 * back) true is returned, else false. 3208 */ 3209 public boolean moveTaskToBack(boolean nonRoot) { 3210 try { 3211 return ActivityManagerNative.getDefault().moveActivityTaskToBack( 3212 mToken, nonRoot); 3213 } catch (RemoteException e) { 3214 // Empty 3215 } 3216 return false; 3217 } 3218 3219 /** 3220 * Returns class name for this activity with the package prefix removed. 3221 * This is the default name used to read and write settings. 3222 * 3223 * @return The local class name. 3224 */ 3225 public String getLocalClassName() { 3226 final String pkg = getPackageName(); 3227 final String cls = mComponent.getClassName(); 3228 int packageLen = pkg.length(); 3229 if (!cls.startsWith(pkg) || cls.length() <= packageLen 3230 || cls.charAt(packageLen) != '.') { 3231 return cls; 3232 } 3233 return cls.substring(packageLen+1); 3234 } 3235 3236 /** 3237 * Returns complete component name of this activity. 3238 * 3239 * @return Returns the complete component name for this activity 3240 */ 3241 public ComponentName getComponentName() 3242 { 3243 return mComponent; 3244 } 3245 3246 /** 3247 * Retrieve a {@link SharedPreferences} object for accessing preferences 3248 * that are private to this activity. This simply calls the underlying 3249 * {@link #getSharedPreferences(String, int)} method by passing in this activity's 3250 * class name as the preferences name. 3251 * 3252 * @param mode Operating mode. Use {@link #MODE_PRIVATE} for the default 3253 * operation, {@link #MODE_WORLD_READABLE} and 3254 * {@link #MODE_WORLD_WRITEABLE} to control permissions. 3255 * 3256 * @return Returns the single SharedPreferences instance that can be used 3257 * to retrieve and modify the preference values. 3258 */ 3259 public SharedPreferences getPreferences(int mode) { 3260 return getSharedPreferences(getLocalClassName(), mode); 3261 } 3262 3263 private void ensureSearchManager() { 3264 if (mSearchManager != null) { 3265 return; 3266 } 3267 3268 // uses super.getSystemService() since this.getSystemService() looks at the 3269 // mSearchManager field. 3270 mSearchManager = (SearchManager) super.getSystemService(Context.SEARCH_SERVICE); 3271 int ident = mIdent; 3272 if (ident == 0) { 3273 if (mParent != null) ident = mParent.mIdent; 3274 if (ident == 0) { 3275 throw new IllegalArgumentException("no ident"); 3276 } 3277 } 3278 mSearchManager.setIdent(ident, getComponentName()); 3279 } 3280 3281 @Override 3282 public Object getSystemService(String name) { 3283 if (getBaseContext() == null) { 3284 throw new IllegalStateException( 3285 "System services not available to Activities before onCreate()"); 3286 } 3287 3288 if (WINDOW_SERVICE.equals(name)) { 3289 return mWindowManager; 3290 } else if (SEARCH_SERVICE.equals(name)) { 3291 ensureSearchManager(); 3292 return mSearchManager; 3293 } 3294 return super.getSystemService(name); 3295 } 3296 3297 /** 3298 * Change the title associated with this activity. If this is a 3299 * top-level activity, the title for its window will change. If it 3300 * is an embedded activity, the parent can do whatever it wants 3301 * with it. 3302 */ 3303 public void setTitle(CharSequence title) { 3304 mTitle = title; 3305 onTitleChanged(title, mTitleColor); 3306 3307 if (mParent != null) { 3308 mParent.onChildTitleChanged(this, title); 3309 } 3310 } 3311 3312 /** 3313 * Change the title associated with this activity. If this is a 3314 * top-level activity, the title for its window will change. If it 3315 * is an embedded activity, the parent can do whatever it wants 3316 * with it. 3317 */ 3318 public void setTitle(int titleId) { 3319 setTitle(getText(titleId)); 3320 } 3321 3322 public void setTitleColor(int textColor) { 3323 mTitleColor = textColor; 3324 onTitleChanged(mTitle, textColor); 3325 } 3326 3327 public final CharSequence getTitle() { 3328 return mTitle; 3329 } 3330 3331 public final int getTitleColor() { 3332 return mTitleColor; 3333 } 3334 3335 protected void onTitleChanged(CharSequence title, int color) { 3336 if (mTitleReady) { 3337 final Window win = getWindow(); 3338 if (win != null) { 3339 win.setTitle(title); 3340 if (color != 0) { 3341 win.setTitleColor(color); 3342 } 3343 } 3344 } 3345 } 3346 3347 protected void onChildTitleChanged(Activity childActivity, CharSequence title) { 3348 } 3349 3350 /** 3351 * Sets the visibility of the progress bar in the title. 3352 * <p> 3353 * In order for the progress bar to be shown, the feature must be requested 3354 * via {@link #requestWindowFeature(int)}. 3355 * 3356 * @param visible Whether to show the progress bars in the title. 3357 */ 3358 public final void setProgressBarVisibility(boolean visible) { 3359 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, visible ? Window.PROGRESS_VISIBILITY_ON : 3360 Window.PROGRESS_VISIBILITY_OFF); 3361 } 3362 3363 /** 3364 * Sets the visibility of the indeterminate progress bar in the title. 3365 * <p> 3366 * In order for the progress bar to be shown, the feature must be requested 3367 * via {@link #requestWindowFeature(int)}. 3368 * 3369 * @param visible Whether to show the progress bars in the title. 3370 */ 3371 public final void setProgressBarIndeterminateVisibility(boolean visible) { 3372 getWindow().setFeatureInt(Window.FEATURE_INDETERMINATE_PROGRESS, 3373 visible ? Window.PROGRESS_VISIBILITY_ON : Window.PROGRESS_VISIBILITY_OFF); 3374 } 3375 3376 /** 3377 * Sets whether the horizontal progress bar in the title should be indeterminate (the circular 3378 * is always indeterminate). 3379 * <p> 3380 * In order for the progress bar to be shown, the feature must be requested 3381 * via {@link #requestWindowFeature(int)}. 3382 * 3383 * @param indeterminate Whether the horizontal progress bar should be indeterminate. 3384 */ 3385 public final void setProgressBarIndeterminate(boolean indeterminate) { 3386 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, 3387 indeterminate ? Window.PROGRESS_INDETERMINATE_ON : Window.PROGRESS_INDETERMINATE_OFF); 3388 } 3389 3390 /** 3391 * Sets the progress for the progress bars in the title. 3392 * <p> 3393 * In order for the progress bar to be shown, the feature must be requested 3394 * via {@link #requestWindowFeature(int)}. 3395 * 3396 * @param progress The progress for the progress bar. Valid ranges are from 3397 * 0 to 10000 (both inclusive). If 10000 is given, the progress 3398 * bar will be completely filled and will fade out. 3399 */ 3400 public final void setProgress(int progress) { 3401 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, progress + Window.PROGRESS_START); 3402 } 3403 3404 /** 3405 * Sets the secondary progress for the progress bar in the title. This 3406 * progress is drawn between the primary progress (set via 3407 * {@link #setProgress(int)} and the background. It can be ideal for media 3408 * scenarios such as showing the buffering progress while the default 3409 * progress shows the play progress. 3410 * <p> 3411 * In order for the progress bar to be shown, the feature must be requested 3412 * via {@link #requestWindowFeature(int)}. 3413 * 3414 * @param secondaryProgress The secondary progress for the progress bar. Valid ranges are from 3415 * 0 to 10000 (both inclusive). 3416 */ 3417 public final void setSecondaryProgress(int secondaryProgress) { 3418 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, 3419 secondaryProgress + Window.PROGRESS_SECONDARY_START); 3420 } 3421 3422 /** 3423 * Suggests an audio stream whose volume should be changed by the hardware 3424 * volume controls. 3425 * <p> 3426 * The suggested audio stream will be tied to the window of this Activity. 3427 * If the Activity is switched, the stream set here is no longer the 3428 * suggested stream. The client does not need to save and restore the old 3429 * suggested stream value in onPause and onResume. 3430 * 3431 * @param streamType The type of the audio stream whose volume should be 3432 * changed by the hardware volume controls. It is not guaranteed that 3433 * the hardware volume controls will always change this stream's 3434 * volume (for example, if a call is in progress, its stream's volume 3435 * may be changed instead). To reset back to the default, use 3436 * {@link AudioManager#USE_DEFAULT_STREAM_TYPE}. 3437 */ 3438 public final void setVolumeControlStream(int streamType) { 3439 getWindow().setVolumeControlStream(streamType); 3440 } 3441 3442 /** 3443 * Gets the suggested audio stream whose volume should be changed by the 3444 * harwdare volume controls. 3445 * 3446 * @return The suggested audio stream type whose volume should be changed by 3447 * the hardware volume controls. 3448 * @see #setVolumeControlStream(int) 3449 */ 3450 public final int getVolumeControlStream() { 3451 return getWindow().getVolumeControlStream(); 3452 } 3453 3454 /** 3455 * Runs the specified action on the UI thread. If the current thread is the UI 3456 * thread, then the action is executed immediately. If the current thread is 3457 * not the UI thread, the action is posted to the event queue of the UI thread. 3458 * 3459 * @param action the action to run on the UI thread 3460 */ 3461 public final void runOnUiThread(Runnable action) { 3462 if (Thread.currentThread() != mUiThread) { 3463 mHandler.post(action); 3464 } else { 3465 action.run(); 3466 } 3467 } 3468 3469 /** 3470 * Stub implementation of {@link android.view.LayoutInflater.Factory#onCreateView} used when 3471 * inflating with the LayoutInflater returned by {@link #getSystemService}. This 3472 * implementation simply returns null for all view names. 3473 * 3474 * @see android.view.LayoutInflater#createView 3475 * @see android.view.Window#getLayoutInflater 3476 */ 3477 public View onCreateView(String name, Context context, AttributeSet attrs) { 3478 return null; 3479 } 3480 3481 // ------------------ Internal API ------------------ 3482 3483 final void setParent(Activity parent) { 3484 mParent = parent; 3485 } 3486 3487 final void attach(Context context, ActivityThread aThread, Instrumentation instr, IBinder token, 3488 Application application, Intent intent, ActivityInfo info, CharSequence title, 3489 Activity parent, String id, Object lastNonConfigurationInstance, 3490 Configuration config) { 3491 attach(context, aThread, instr, token, 0, application, intent, info, title, parent, id, 3492 lastNonConfigurationInstance, null, config); 3493 } 3494 3495 final void attach(Context context, ActivityThread aThread, 3496 Instrumentation instr, IBinder token, int ident, 3497 Application application, Intent intent, ActivityInfo info, 3498 CharSequence title, Activity parent, String id, 3499 Object lastNonConfigurationInstance, 3500 HashMap<String,Object> lastNonConfigurationChildInstances, 3501 Configuration config) { 3502 attachBaseContext(context); 3503 3504 mWindow = PolicyManager.makeNewWindow(this); 3505 mWindow.setCallback(this); 3506 if (info.softInputMode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) { 3507 mWindow.setSoftInputMode(info.softInputMode); 3508 } 3509 mUiThread = Thread.currentThread(); 3510 3511 mMainThread = aThread; 3512 mInstrumentation = instr; 3513 mToken = token; 3514 mIdent = ident; 3515 mApplication = application; 3516 mIntent = intent; 3517 mComponent = intent.getComponent(); 3518 mActivityInfo = info; 3519 mTitle = title; 3520 mParent = parent; 3521 mEmbeddedID = id; 3522 mLastNonConfigurationInstance = lastNonConfigurationInstance; 3523 mLastNonConfigurationChildInstances = lastNonConfigurationChildInstances; 3524 3525 mWindow.setWindowManager(null, mToken, mComponent.flattenToString()); 3526 if (mParent != null) { 3527 mWindow.setContainer(mParent.getWindow()); 3528 } 3529 mWindowManager = mWindow.getWindowManager(); 3530 mCurrentConfig = config; 3531 } 3532 3533 final IBinder getActivityToken() { 3534 return mParent != null ? mParent.getActivityToken() : mToken; 3535 } 3536 3537 final void performStart() { 3538 mCalled = false; 3539 mInstrumentation.callActivityOnStart(this); 3540 if (!mCalled) { 3541 throw new SuperNotCalledException( 3542 "Activity " + mComponent.toShortString() + 3543 " did not call through to super.onStart()"); 3544 } 3545 } 3546 3547 final void performRestart() { 3548 final int N = mManagedCursors.size(); 3549 for (int i=0; i<N; i++) { 3550 ManagedCursor mc = mManagedCursors.get(i); 3551 if (mc.mReleased || mc.mUpdated) { 3552 mc.mCursor.requery(); 3553 mc.mReleased = false; 3554 mc.mUpdated = false; 3555 } 3556 } 3557 3558 if (mStopped) { 3559 mStopped = false; 3560 mCalled = false; 3561 mInstrumentation.callActivityOnRestart(this); 3562 if (!mCalled) { 3563 throw new SuperNotCalledException( 3564 "Activity " + mComponent.toShortString() + 3565 " did not call through to super.onRestart()"); 3566 } 3567 performStart(); 3568 } 3569 } 3570 3571 final void performResume() { 3572 performRestart(); 3573 3574 mLastNonConfigurationInstance = null; 3575 3576 // First call onResume() -before- setting mResumed, so we don't 3577 // send out any status bar / menu notifications the client makes. 3578 mCalled = false; 3579 mInstrumentation.callActivityOnResume(this); 3580 if (!mCalled) { 3581 throw new SuperNotCalledException( 3582 "Activity " + mComponent.toShortString() + 3583 " did not call through to super.onResume()"); 3584 } 3585 3586 // Now really resume, and install the current status bar and menu. 3587 mResumed = true; 3588 mCalled = false; 3589 onPostResume(); 3590 if (!mCalled) { 3591 throw new SuperNotCalledException( 3592 "Activity " + mComponent.toShortString() + 3593 " did not call through to super.onPostResume()"); 3594 } 3595 } 3596 3597 final void performPause() { 3598 onPause(); 3599 } 3600 3601 final void performUserLeaving() { 3602 onUserInteraction(); 3603 onUserLeaveHint(); 3604 } 3605 3606 final void performStop() { 3607 if (!mStopped) { 3608 if (mWindow != null) { 3609 mWindow.closeAllPanels(); 3610 } 3611 3612 mCalled = false; 3613 mInstrumentation.callActivityOnStop(this); 3614 if (!mCalled) { 3615 throw new SuperNotCalledException( 3616 "Activity " + mComponent.toShortString() + 3617 " did not call through to super.onStop()"); 3618 } 3619 3620 final int N = mManagedCursors.size(); 3621 for (int i=0; i<N; i++) { 3622 ManagedCursor mc = mManagedCursors.get(i); 3623 if (!mc.mReleased) { 3624 mc.mCursor.deactivate(); 3625 mc.mReleased = true; 3626 } 3627 } 3628 3629 mStopped = true; 3630 } 3631 mResumed = false; 3632 } 3633 3634 final boolean isResumed() { 3635 return mResumed; 3636 } 3637 3638 void dispatchActivityResult(String who, int requestCode, 3639 int resultCode, Intent data) { 3640 if (Config.LOGV) Log.v( 3641 TAG, "Dispatching result: who=" + who + ", reqCode=" + requestCode 3642 + ", resCode=" + resultCode + ", data=" + data); 3643 if (who == null) { 3644 onActivityResult(requestCode, resultCode, data); 3645 } 3646 } 3647} 3648