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