Activity.java revision 84a3834a0c23c4fee4f909f986ba6975a87c807b
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 static java.lang.Character.MIN_VALUE; 20 21import android.annotation.CallSuper; 22import android.annotation.DrawableRes; 23import android.annotation.IdRes; 24import android.annotation.IntDef; 25import android.annotation.LayoutRes; 26import android.annotation.MainThread; 27import android.annotation.NonNull; 28import android.annotation.Nullable; 29import android.annotation.RequiresPermission; 30import android.annotation.StyleRes; 31import android.annotation.SystemApi; 32import android.app.VoiceInteractor.Request; 33import android.app.admin.DevicePolicyManager; 34import android.app.assist.AssistContent; 35import android.content.ComponentCallbacks2; 36import android.content.ComponentName; 37import android.content.ContentResolver; 38import android.content.Context; 39import android.content.CursorLoader; 40import android.content.IIntentSender; 41import android.content.Intent; 42import android.content.IntentSender; 43import android.content.SharedPreferences; 44import android.content.pm.ActivityInfo; 45import android.content.pm.ApplicationInfo; 46import android.content.pm.PackageManager; 47import android.content.pm.PackageManager.NameNotFoundException; 48import android.content.res.Configuration; 49import android.content.res.Resources; 50import android.content.res.TypedArray; 51import android.database.Cursor; 52import android.graphics.Bitmap; 53import android.graphics.Canvas; 54import android.graphics.Color; 55import android.graphics.drawable.Drawable; 56import android.hardware.input.InputManager; 57import android.media.AudioManager; 58import android.media.session.MediaController; 59import android.net.Uri; 60import android.os.BadParcelableException; 61import android.os.Build; 62import android.os.Bundle; 63import android.os.Handler; 64import android.os.IBinder; 65import android.os.Looper; 66import android.os.Parcelable; 67import android.os.PersistableBundle; 68import android.os.RemoteException; 69import android.os.ServiceManager.ServiceNotFoundException; 70import android.os.StrictMode; 71import android.os.SystemProperties; 72import android.os.UserHandle; 73import android.text.Selection; 74import android.text.SpannableStringBuilder; 75import android.text.TextUtils; 76import android.text.method.TextKeyListener; 77import android.transition.Scene; 78import android.transition.TransitionManager; 79import android.util.ArrayMap; 80import android.util.AttributeSet; 81import android.util.EventLog; 82import android.util.Log; 83import android.util.PrintWriterPrinter; 84import android.util.Slog; 85import android.util.SparseArray; 86import android.util.SuperNotCalledException; 87import android.view.ActionMode; 88import android.view.ContextMenu; 89import android.view.ContextMenu.ContextMenuInfo; 90import android.view.ContextThemeWrapper; 91import android.view.DragAndDropPermissions; 92import android.view.DragEvent; 93import android.view.InputDevice; 94import android.view.KeyCharacterMap; 95import android.view.KeyEvent; 96import android.view.KeyboardShortcutGroup; 97import android.view.KeyboardShortcutInfo; 98import android.view.LayoutInflater; 99import android.view.Menu; 100import android.view.MenuInflater; 101import android.view.MenuItem; 102import android.view.MotionEvent; 103import android.view.SearchEvent; 104import android.view.View; 105import android.view.View.OnCreateContextMenuListener; 106import android.view.ViewGroup; 107import android.view.ViewGroup.LayoutParams; 108import android.view.ViewManager; 109import android.view.ViewRootImpl; 110import android.view.Window; 111import android.view.Window.WindowControllerCallback; 112import android.view.WindowManager; 113import android.view.WindowManagerGlobal; 114import android.view.accessibility.AccessibilityEvent; 115import android.widget.AdapterView; 116import android.widget.Toast; 117import android.widget.Toolbar; 118 119import com.android.internal.app.IVoiceInteractor; 120import com.android.internal.app.ToolbarActionBar; 121import com.android.internal.app.WindowDecorActionBar; 122import com.android.internal.policy.PhoneWindow; 123 124import java.io.FileDescriptor; 125import java.io.PrintWriter; 126import java.lang.annotation.Retention; 127import java.lang.annotation.RetentionPolicy; 128import java.util.ArrayList; 129import java.util.HashMap; 130import java.util.List; 131 132/** 133 * An activity is a single, focused thing that the user can do. Almost all 134 * activities interact with the user, so the Activity class takes care of 135 * creating a window for you in which you can place your UI with 136 * {@link #setContentView}. While activities are often presented to the user 137 * as full-screen windows, they can also be used in other ways: as floating 138 * windows (via a theme with {@link android.R.attr#windowIsFloating} set) 139 * or embedded inside of another activity (using {@link ActivityGroup}). 140 * 141 * There are two methods almost all subclasses of Activity will implement: 142 * 143 * <ul> 144 * <li> {@link #onCreate} is where you initialize your activity. Most 145 * importantly, here you will usually call {@link #setContentView(int)} 146 * with a layout resource defining your UI, and using {@link #findViewById} 147 * to retrieve the widgets in that UI that you need to interact with 148 * programmatically. 149 * 150 * <li> {@link #onPause} is where you deal with the user leaving your 151 * activity. Most importantly, any changes made by the user should at this 152 * point be committed (usually to the 153 * {@link android.content.ContentProvider} holding the data). 154 * </ul> 155 * 156 * <p>To be of use with {@link android.content.Context#startActivity Context.startActivity()}, all 157 * activity classes must have a corresponding 158 * {@link android.R.styleable#AndroidManifestActivity <activity>} 159 * declaration in their package's <code>AndroidManifest.xml</code>.</p> 160 * 161 * <p>Topics covered here: 162 * <ol> 163 * <li><a href="#Fragments">Fragments</a> 164 * <li><a href="#ActivityLifecycle">Activity Lifecycle</a> 165 * <li><a href="#ConfigurationChanges">Configuration Changes</a> 166 * <li><a href="#StartingActivities">Starting Activities and Getting Results</a> 167 * <li><a href="#SavingPersistentState">Saving Persistent State</a> 168 * <li><a href="#Permissions">Permissions</a> 169 * <li><a href="#ProcessLifecycle">Process Lifecycle</a> 170 * </ol> 171 * 172 * <div class="special reference"> 173 * <h3>Developer Guides</h3> 174 * <p>The Activity class is an important part of an application's overall lifecycle, 175 * and the way activities are launched and put together is a fundamental 176 * part of the platform's application model. For a detailed perspective on the structure of an 177 * Android application and how activities behave, please read the 178 * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a> and 179 * <a href="{@docRoot}guide/components/tasks-and-back-stack.html">Tasks and Back Stack</a> 180 * developer guides.</p> 181 * 182 * <p>You can also find a detailed discussion about how to create activities in the 183 * <a href="{@docRoot}guide/components/activities.html">Activities</a> 184 * developer guide.</p> 185 * </div> 186 * 187 * <a name="Fragments"></a> 188 * <h3>Fragments</h3> 189 * 190 * <p>Starting with {@link android.os.Build.VERSION_CODES#HONEYCOMB}, Activity 191 * implementations can make use of the {@link Fragment} class to better 192 * modularize their code, build more sophisticated user interfaces for larger 193 * screens, and help scale their application between small and large screens. 194 * 195 * <a name="ActivityLifecycle"></a> 196 * <h3>Activity Lifecycle</h3> 197 * 198 * <p>Activities in the system are managed as an <em>activity stack</em>. 199 * When a new activity is started, it is placed on the top of the stack 200 * and becomes the running activity -- the previous activity always remains 201 * below it in the stack, and will not come to the foreground again until 202 * the new activity exits.</p> 203 * 204 * <p>An activity has essentially four states:</p> 205 * <ul> 206 * <li> If an activity is in the foreground of the screen (at the top of 207 * the stack), 208 * it is <em>active</em> or <em>running</em>. </li> 209 * <li>If an activity has lost focus but is still visible (that is, a new non-full-sized 210 * or transparent activity has focus on top of your activity), it 211 * is <em>paused</em>. A paused activity is completely alive (it 212 * maintains all state and member information and remains attached to 213 * the window manager), but can be killed by the system in extreme 214 * low memory situations. 215 * <li>If an activity is completely obscured by another activity, 216 * it is <em>stopped</em>. It still retains all state and member information, 217 * however, it is no longer visible to the user so its window is hidden 218 * and it will often be killed by the system when memory is needed 219 * elsewhere.</li> 220 * <li>If an activity is paused or stopped, the system can drop the activity 221 * from memory by either asking it to finish, or simply killing its 222 * process. When it is displayed again to the user, it must be 223 * completely restarted and restored to its previous state.</li> 224 * </ul> 225 * 226 * <p>The following diagram shows the important state paths of an Activity. 227 * The square rectangles represent callback methods you can implement to 228 * perform operations when the Activity moves between states. The colored 229 * ovals are major states the Activity can be in.</p> 230 * 231 * <p><img src="../../../images/activity_lifecycle.png" 232 * alt="State diagram for an Android Activity Lifecycle." border="0" /></p> 233 * 234 * <p>There are three key loops you may be interested in monitoring within your 235 * activity: 236 * 237 * <ul> 238 * <li>The <b>entire lifetime</b> of an activity happens between the first call 239 * to {@link android.app.Activity#onCreate} through to a single final call 240 * to {@link android.app.Activity#onDestroy}. An activity will do all setup 241 * of "global" state in onCreate(), and release all remaining resources in 242 * onDestroy(). For example, if it has a thread running in the background 243 * to download data from the network, it may create that thread in onCreate() 244 * and then stop the thread in onDestroy(). 245 * 246 * <li>The <b>visible lifetime</b> of an activity happens between a call to 247 * {@link android.app.Activity#onStart} until a corresponding call to 248 * {@link android.app.Activity#onStop}. During this time the user can see the 249 * activity on-screen, though it may not be in the foreground and interacting 250 * with the user. Between these two methods you can maintain resources that 251 * are needed to show the activity to the user. For example, you can register 252 * a {@link android.content.BroadcastReceiver} in onStart() to monitor for changes 253 * that impact your UI, and unregister it in onStop() when the user no 254 * longer sees what you are displaying. The onStart() and onStop() methods 255 * can be called multiple times, as the activity becomes visible and hidden 256 * to the user. 257 * 258 * <li>The <b>foreground lifetime</b> of an activity happens between a call to 259 * {@link android.app.Activity#onResume} until a corresponding call to 260 * {@link android.app.Activity#onPause}. During this time the activity is 261 * in front of all other activities and interacting with the user. An activity 262 * can frequently go between the resumed and paused states -- for example when 263 * the device goes to sleep, when an activity result is delivered, when a new 264 * intent is delivered -- so the code in these methods should be fairly 265 * lightweight. 266 * </ul> 267 * 268 * <p>The entire lifecycle of an activity is defined by the following 269 * Activity methods. All of these are hooks that you can override 270 * to do appropriate work when the activity changes state. All 271 * activities will implement {@link android.app.Activity#onCreate} 272 * to do their initial setup; many will also implement 273 * {@link android.app.Activity#onPause} to commit changes to data and 274 * otherwise prepare to stop interacting with the user. You should always 275 * call up to your superclass when implementing these methods.</p> 276 * 277 * </p> 278 * <pre class="prettyprint"> 279 * public class Activity extends ApplicationContext { 280 * protected void onCreate(Bundle savedInstanceState); 281 * 282 * protected void onStart(); 283 * 284 * protected void onRestart(); 285 * 286 * protected void onResume(); 287 * 288 * protected void onPause(); 289 * 290 * protected void onStop(); 291 * 292 * protected void onDestroy(); 293 * } 294 * </pre> 295 * 296 * <p>In general the movement through an activity's lifecycle looks like 297 * this:</p> 298 * 299 * <table border="2" width="85%" align="center" frame="hsides" rules="rows"> 300 * <colgroup align="left" span="3" /> 301 * <colgroup align="left" /> 302 * <colgroup align="center" /> 303 * <colgroup align="center" /> 304 * 305 * <thead> 306 * <tr><th colspan="3">Method</th> <th>Description</th> <th>Killable?</th> <th>Next</th></tr> 307 * </thead> 308 * 309 * <tbody> 310 * <tr><td colspan="3" align="left" border="0">{@link android.app.Activity#onCreate onCreate()}</td> 311 * <td>Called when the activity is first created. 312 * This is where you should do all of your normal static set up: 313 * create views, bind data to lists, etc. This method also 314 * provides you with a Bundle containing the activity's previously 315 * frozen state, if there was one. 316 * <p>Always followed by <code>onStart()</code>.</td> 317 * <td align="center">No</td> 318 * <td align="center"><code>onStart()</code></td> 319 * </tr> 320 * 321 * <tr><td rowspan="5" style="border-left: none; border-right: none;"> </td> 322 * <td colspan="2" align="left" border="0">{@link android.app.Activity#onRestart onRestart()}</td> 323 * <td>Called after your activity has been stopped, prior to it being 324 * started again. 325 * <p>Always followed by <code>onStart()</code></td> 326 * <td align="center">No</td> 327 * <td align="center"><code>onStart()</code></td> 328 * </tr> 329 * 330 * <tr><td colspan="2" align="left" border="0">{@link android.app.Activity#onStart onStart()}</td> 331 * <td>Called when the activity is becoming visible to the user. 332 * <p>Followed by <code>onResume()</code> if the activity comes 333 * to the foreground, or <code>onStop()</code> if it becomes hidden.</td> 334 * <td align="center">No</td> 335 * <td align="center"><code>onResume()</code> or <code>onStop()</code></td> 336 * </tr> 337 * 338 * <tr><td rowspan="2" style="border-left: none;"> </td> 339 * <td align="left" border="0">{@link android.app.Activity#onResume onResume()}</td> 340 * <td>Called when the activity will start 341 * interacting with the user. At this point your activity is at 342 * the top of the activity stack, with user input going to it. 343 * <p>Always followed by <code>onPause()</code>.</td> 344 * <td align="center">No</td> 345 * <td align="center"><code>onPause()</code></td> 346 * </tr> 347 * 348 * <tr><td align="left" border="0">{@link android.app.Activity#onPause onPause()}</td> 349 * <td>Called when the system is about to start resuming a previous 350 * activity. This is typically used to commit unsaved changes to 351 * persistent data, stop animations and other things that may be consuming 352 * CPU, etc. Implementations of this method must be very quick because 353 * the next activity will not be resumed until this method returns. 354 * <p>Followed by either <code>onResume()</code> if the activity 355 * returns back to the front, or <code>onStop()</code> if it becomes 356 * invisible to the user.</td> 357 * <td align="center"><font color="#800000"><strong>Pre-{@link android.os.Build.VERSION_CODES#HONEYCOMB}</strong></font></td> 358 * <td align="center"><code>onResume()</code> or<br> 359 * <code>onStop()</code></td> 360 * </tr> 361 * 362 * <tr><td colspan="2" align="left" border="0">{@link android.app.Activity#onStop onStop()}</td> 363 * <td>Called when the activity is no longer visible to the user, because 364 * another activity has been resumed and is covering this one. This 365 * may happen either because a new activity is being started, an existing 366 * one is being brought in front of this one, or this one is being 367 * destroyed. 368 * <p>Followed by either <code>onRestart()</code> if 369 * this activity is coming back to interact with the user, or 370 * <code>onDestroy()</code> if this activity is going away.</td> 371 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td> 372 * <td align="center"><code>onRestart()</code> or<br> 373 * <code>onDestroy()</code></td> 374 * </tr> 375 * 376 * <tr><td colspan="3" align="left" border="0">{@link android.app.Activity#onDestroy onDestroy()}</td> 377 * <td>The final call you receive before your 378 * activity is destroyed. This can happen either because the 379 * activity is finishing (someone called {@link Activity#finish} on 380 * it, or because the system is temporarily destroying this 381 * instance of the activity to save space. You can distinguish 382 * between these two scenarios with the {@link 383 * Activity#isFinishing} method.</td> 384 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td> 385 * <td align="center"><em>nothing</em></td> 386 * </tr> 387 * </tbody> 388 * </table> 389 * 390 * <p>Note the "Killable" column in the above table -- for those methods that 391 * are marked as being killable, after that method returns the process hosting the 392 * activity may be killed by the system <em>at any time</em> without another line 393 * of its code being executed. Because of this, you should use the 394 * {@link #onPause} method to write any persistent data (such as user edits) 395 * to storage. In addition, the method 396 * {@link #onSaveInstanceState(Bundle)} is called before placing the activity 397 * in such a background state, allowing you to save away any dynamic instance 398 * state in your activity into the given Bundle, to be later received in 399 * {@link #onCreate} if the activity needs to be re-created. 400 * See the <a href="#ProcessLifecycle">Process Lifecycle</a> 401 * section for more information on how the lifecycle of a process is tied 402 * to the activities it is hosting. Note that it is important to save 403 * persistent data in {@link #onPause} instead of {@link #onSaveInstanceState} 404 * because the latter is not part of the lifecycle callbacks, so will not 405 * be called in every situation as described in its documentation.</p> 406 * 407 * <p class="note">Be aware that these semantics will change slightly between 408 * applications targeting platforms starting with {@link android.os.Build.VERSION_CODES#HONEYCOMB} 409 * vs. those targeting prior platforms. Starting with Honeycomb, an application 410 * is not in the killable state until its {@link #onStop} has returned. This 411 * impacts when {@link #onSaveInstanceState(Bundle)} may be called (it may be 412 * safely called after {@link #onPause()} and allows and application to safely 413 * wait until {@link #onStop()} to save persistent state.</p> 414 * 415 * <p>For those methods that are not marked as being killable, the activity's 416 * process will not be killed by the system starting from the time the method 417 * is called and continuing after it returns. Thus an activity is in the killable 418 * state, for example, between after <code>onPause()</code> to the start of 419 * <code>onResume()</code>.</p> 420 * 421 * <a name="ConfigurationChanges"></a> 422 * <h3>Configuration Changes</h3> 423 * 424 * <p>If the configuration of the device (as defined by the 425 * {@link Configuration Resources.Configuration} class) changes, 426 * then anything displaying a user interface will need to update to match that 427 * configuration. Because Activity is the primary mechanism for interacting 428 * with the user, it includes special support for handling configuration 429 * changes.</p> 430 * 431 * <p>Unless you specify otherwise, a configuration change (such as a change 432 * in screen orientation, language, input devices, etc) will cause your 433 * current activity to be <em>destroyed</em>, going through the normal activity 434 * lifecycle process of {@link #onPause}, 435 * {@link #onStop}, and {@link #onDestroy} as appropriate. If the activity 436 * had been in the foreground or visible to the user, once {@link #onDestroy} is 437 * called in that instance then a new instance of the activity will be 438 * created, with whatever savedInstanceState the previous instance had generated 439 * from {@link #onSaveInstanceState}.</p> 440 * 441 * <p>This is done because any application resource, 442 * including layout files, can change based on any configuration value. Thus 443 * the only safe way to handle a configuration change is to re-retrieve all 444 * resources, including layouts, drawables, and strings. Because activities 445 * must already know how to save their state and re-create themselves from 446 * that state, this is a convenient way to have an activity restart itself 447 * with a new configuration.</p> 448 * 449 * <p>In some special cases, you may want to bypass restarting of your 450 * activity based on one or more types of configuration changes. This is 451 * done with the {@link android.R.attr#configChanges android:configChanges} 452 * attribute in its manifest. For any types of configuration changes you say 453 * that you handle there, you will receive a call to your current activity's 454 * {@link #onConfigurationChanged} method instead of being restarted. If 455 * a configuration change involves any that you do not handle, however, the 456 * activity will still be restarted and {@link #onConfigurationChanged} 457 * will not be called.</p> 458 * 459 * <a name="StartingActivities"></a> 460 * <h3>Starting Activities and Getting Results</h3> 461 * 462 * <p>The {@link android.app.Activity#startActivity} 463 * method is used to start a 464 * new activity, which will be placed at the top of the activity stack. It 465 * takes a single argument, an {@link android.content.Intent Intent}, 466 * which describes the activity 467 * to be executed.</p> 468 * 469 * <p>Sometimes you want to get a result back from an activity when it 470 * ends. For example, you may start an activity that lets the user pick 471 * a person in a list of contacts; when it ends, it returns the person 472 * that was selected. To do this, you call the 473 * {@link android.app.Activity#startActivityForResult(Intent, int)} 474 * version with a second integer parameter identifying the call. The result 475 * will come back through your {@link android.app.Activity#onActivityResult} 476 * method.</p> 477 * 478 * <p>When an activity exits, it can call 479 * {@link android.app.Activity#setResult(int)} 480 * to return data back to its parent. It must always supply a result code, 481 * which can be the standard results RESULT_CANCELED, RESULT_OK, or any 482 * custom values starting at RESULT_FIRST_USER. In addition, it can optionally 483 * return back an Intent containing any additional data it wants. All of this 484 * information appears back on the 485 * parent's <code>Activity.onActivityResult()</code>, along with the integer 486 * identifier it originally supplied.</p> 487 * 488 * <p>If a child activity fails for any reason (such as crashing), the parent 489 * activity will receive a result with the code RESULT_CANCELED.</p> 490 * 491 * <pre class="prettyprint"> 492 * public class MyActivity extends Activity { 493 * ... 494 * 495 * static final int PICK_CONTACT_REQUEST = 0; 496 * 497 * public boolean onKeyDown(int keyCode, KeyEvent event) { 498 * if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) { 499 * // When the user center presses, let them pick a contact. 500 * startActivityForResult( 501 * new Intent(Intent.ACTION_PICK, 502 * new Uri("content://contacts")), 503 * PICK_CONTACT_REQUEST); 504 * return true; 505 * } 506 * return false; 507 * } 508 * 509 * protected void onActivityResult(int requestCode, int resultCode, 510 * Intent data) { 511 * if (requestCode == PICK_CONTACT_REQUEST) { 512 * if (resultCode == RESULT_OK) { 513 * // A contact was picked. Here we will just display it 514 * // to the user. 515 * startActivity(new Intent(Intent.ACTION_VIEW, data)); 516 * } 517 * } 518 * } 519 * } 520 * </pre> 521 * 522 * <a name="SavingPersistentState"></a> 523 * <h3>Saving Persistent State</h3> 524 * 525 * <p>There are generally two kinds of persistent state than an activity 526 * will deal with: shared document-like data (typically stored in a SQLite 527 * database using a {@linkplain android.content.ContentProvider content provider}) 528 * and internal state such as user preferences.</p> 529 * 530 * <p>For content provider data, we suggest that activities use a 531 * "edit in place" user model. That is, any edits a user makes are effectively 532 * made immediately without requiring an additional confirmation step. 533 * Supporting this model is generally a simple matter of following two rules:</p> 534 * 535 * <ul> 536 * <li> <p>When creating a new document, the backing database entry or file for 537 * it is created immediately. For example, if the user chooses to write 538 * a new e-mail, a new entry for that e-mail is created as soon as they 539 * start entering data, so that if they go to any other activity after 540 * that point this e-mail will now appear in the list of drafts.</p> 541 * <li> <p>When an activity's <code>onPause()</code> method is called, it should 542 * commit to the backing content provider or file any changes the user 543 * has made. This ensures that those changes will be seen by any other 544 * activity that is about to run. You will probably want to commit 545 * your data even more aggressively at key times during your 546 * activity's lifecycle: for example before starting a new 547 * activity, before finishing your own activity, when the user 548 * switches between input fields, etc.</p> 549 * </ul> 550 * 551 * <p>This model is designed to prevent data loss when a user is navigating 552 * between activities, and allows the system to safely kill an activity (because 553 * system resources are needed somewhere else) at any time after it has been 554 * paused. Note this implies 555 * that the user pressing BACK from your activity does <em>not</em> 556 * mean "cancel" -- it means to leave the activity with its current contents 557 * saved away. Canceling edits in an activity must be provided through 558 * some other mechanism, such as an explicit "revert" or "undo" option.</p> 559 * 560 * <p>See the {@linkplain android.content.ContentProvider content package} for 561 * more information about content providers. These are a key aspect of how 562 * different activities invoke and propagate data between themselves.</p> 563 * 564 * <p>The Activity class also provides an API for managing internal persistent state 565 * associated with an activity. This can be used, for example, to remember 566 * the user's preferred initial display in a calendar (day view or week view) 567 * or the user's default home page in a web browser.</p> 568 * 569 * <p>Activity persistent state is managed 570 * with the method {@link #getPreferences}, 571 * allowing you to retrieve and 572 * modify a set of name/value pairs associated with the activity. To use 573 * preferences that are shared across multiple application components 574 * (activities, receivers, services, providers), you can use the underlying 575 * {@link Context#getSharedPreferences Context.getSharedPreferences()} method 576 * to retrieve a preferences 577 * object stored under a specific name. 578 * (Note that it is not possible to share settings data across application 579 * packages -- for that you will need a content provider.)</p> 580 * 581 * <p>Here is an excerpt from a calendar activity that stores the user's 582 * preferred view mode in its persistent settings:</p> 583 * 584 * <pre class="prettyprint"> 585 * public class CalendarActivity extends Activity { 586 * ... 587 * 588 * static final int DAY_VIEW_MODE = 0; 589 * static final int WEEK_VIEW_MODE = 1; 590 * 591 * private SharedPreferences mPrefs; 592 * private int mCurViewMode; 593 * 594 * protected void onCreate(Bundle savedInstanceState) { 595 * super.onCreate(savedInstanceState); 596 * 597 * SharedPreferences mPrefs = getSharedPreferences(); 598 * mCurViewMode = mPrefs.getInt("view_mode", DAY_VIEW_MODE); 599 * } 600 * 601 * protected void onPause() { 602 * super.onPause(); 603 * 604 * SharedPreferences.Editor ed = mPrefs.edit(); 605 * ed.putInt("view_mode", mCurViewMode); 606 * ed.commit(); 607 * } 608 * } 609 * </pre> 610 * 611 * <a name="Permissions"></a> 612 * <h3>Permissions</h3> 613 * 614 * <p>The ability to start a particular Activity can be enforced when it is 615 * declared in its 616 * manifest's {@link android.R.styleable#AndroidManifestActivity <activity>} 617 * tag. By doing so, other applications will need to declare a corresponding 618 * {@link android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 619 * element in their own manifest to be able to start that activity. 620 * 621 * <p>When starting an Activity you can set {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 622 * Intent.FLAG_GRANT_READ_URI_PERMISSION} and/or {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 623 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} on the Intent. This will grant the 624 * Activity access to the specific URIs in the Intent. Access will remain 625 * until the Activity has finished (it will remain across the hosting 626 * process being killed and other temporary destruction). As of 627 * {@link android.os.Build.VERSION_CODES#GINGERBREAD}, if the Activity 628 * was already created and a new Intent is being delivered to 629 * {@link #onNewIntent(Intent)}, any newly granted URI permissions will be added 630 * to the existing ones it holds. 631 * 632 * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a> 633 * document for more information on permissions and security in general. 634 * 635 * <a name="ProcessLifecycle"></a> 636 * <h3>Process Lifecycle</h3> 637 * 638 * <p>The Android system attempts to keep application process around for as 639 * long as possible, but eventually will need to remove old processes when 640 * memory runs low. As described in <a href="#ActivityLifecycle">Activity 641 * Lifecycle</a>, the decision about which process to remove is intimately 642 * tied to the state of the user's interaction with it. In general, there 643 * are four states a process can be in based on the activities running in it, 644 * listed here in order of importance. The system will kill less important 645 * processes (the last ones) before it resorts to killing more important 646 * processes (the first ones). 647 * 648 * <ol> 649 * <li> <p>The <b>foreground activity</b> (the activity at the top of the screen 650 * that the user is currently interacting with) is considered the most important. 651 * Its process will only be killed as a last resort, if it uses more memory 652 * than is available on the device. Generally at this point the device has 653 * reached a memory paging state, so this is required in order to keep the user 654 * interface responsive. 655 * <li> <p>A <b>visible activity</b> (an activity that is visible to the user 656 * but not in the foreground, such as one sitting behind a foreground dialog) 657 * is considered extremely important and will not be killed unless that is 658 * required to keep the foreground activity running. 659 * <li> <p>A <b>background activity</b> (an activity that is not visible to 660 * the user and has been paused) is no longer critical, so the system may 661 * safely kill its process to reclaim memory for other foreground or 662 * visible processes. If its process needs to be killed, when the user navigates 663 * back to the activity (making it visible on the screen again), its 664 * {@link #onCreate} method will be called with the savedInstanceState it had previously 665 * supplied in {@link #onSaveInstanceState} so that it can restart itself in the same 666 * state as the user last left it. 667 * <li> <p>An <b>empty process</b> is one hosting no activities or other 668 * application components (such as {@link Service} or 669 * {@link android.content.BroadcastReceiver} classes). These are killed very 670 * quickly by the system as memory becomes low. For this reason, any 671 * background operation you do outside of an activity must be executed in the 672 * context of an activity BroadcastReceiver or Service to ensure that the system 673 * knows it needs to keep your process around. 674 * </ol> 675 * 676 * <p>Sometimes an Activity may need to do a long-running operation that exists 677 * independently of the activity lifecycle itself. An example may be a camera 678 * application that allows you to upload a picture to a web site. The upload 679 * may take a long time, and the application should allow the user to leave 680 * the application while it is executing. To accomplish this, your Activity 681 * should start a {@link Service} in which the upload takes place. This allows 682 * the system to properly prioritize your process (considering it to be more 683 * important than other non-visible applications) for the duration of the 684 * upload, independent of whether the original activity is paused, stopped, 685 * or finished. 686 */ 687public class Activity extends ContextThemeWrapper 688 implements LayoutInflater.Factory2, 689 Window.Callback, KeyEvent.Callback, 690 OnCreateContextMenuListener, ComponentCallbacks2, 691 Window.OnWindowDismissedCallback, WindowControllerCallback { 692 private static final String TAG = "Activity"; 693 private static final boolean DEBUG_LIFECYCLE = false; 694 695 /** Standard activity result: operation canceled. */ 696 public static final int RESULT_CANCELED = 0; 697 /** Standard activity result: operation succeeded. */ 698 public static final int RESULT_OK = -1; 699 /** Start of user-defined activity results. */ 700 public static final int RESULT_FIRST_USER = 1; 701 702 /** @hide Task isn't finished when activity is finished */ 703 public static final int DONT_FINISH_TASK_WITH_ACTIVITY = 0; 704 /** 705 * @hide Task is finished if the finishing activity is the root of the task. To preserve the 706 * past behavior the task is also removed from recents. 707 */ 708 public static final int FINISH_TASK_WITH_ROOT_ACTIVITY = 1; 709 /** 710 * @hide Task is finished along with the finishing activity, but it is not removed from 711 * recents. 712 */ 713 public static final int FINISH_TASK_WITH_ACTIVITY = 2; 714 715 static final String FRAGMENTS_TAG = "android:fragments"; 716 717 private static final String WINDOW_HIERARCHY_TAG = "android:viewHierarchyState"; 718 private static final String SAVED_DIALOG_IDS_KEY = "android:savedDialogIds"; 719 private static final String SAVED_DIALOGS_TAG = "android:savedDialogs"; 720 private static final String SAVED_DIALOG_KEY_PREFIX = "android:dialog_"; 721 private static final String SAVED_DIALOG_ARGS_KEY_PREFIX = "android:dialog_args_"; 722 private static final String HAS_CURENT_PERMISSIONS_REQUEST_KEY = 723 "android:hasCurrentPermissionsRequest"; 724 725 private static final String REQUEST_PERMISSIONS_WHO_PREFIX = "@android:requestPermissions:"; 726 727 private static final String KEYBOARD_SHORTCUTS_RECEIVER_PKG_NAME = "com.android.systemui"; 728 729 private static class ManagedDialog { 730 Dialog mDialog; 731 Bundle mArgs; 732 } 733 private SparseArray<ManagedDialog> mManagedDialogs; 734 735 // set by the thread after the constructor and before onCreate(Bundle savedInstanceState) is called. 736 private Instrumentation mInstrumentation; 737 private IBinder mToken; 738 private int mIdent; 739 /*package*/ String mEmbeddedID; 740 private Application mApplication; 741 /*package*/ Intent mIntent; 742 /*package*/ String mReferrer; 743 private ComponentName mComponent; 744 /*package*/ ActivityInfo mActivityInfo; 745 /*package*/ ActivityThread mMainThread; 746 Activity mParent; 747 boolean mCalled; 748 /*package*/ boolean mResumed; 749 /*package*/ boolean mStopped; 750 boolean mFinished; 751 boolean mStartedActivity; 752 private boolean mDestroyed; 753 private boolean mDoReportFullyDrawn = true; 754 /** true if the activity is going through a transient pause */ 755 /*package*/ boolean mTemporaryPause = false; 756 /** true if the activity is being destroyed in order to recreate it with a new configuration */ 757 /*package*/ boolean mChangingConfigurations = false; 758 /*package*/ int mConfigChangeFlags; 759 /*package*/ Configuration mCurrentConfig; 760 private SearchManager mSearchManager; 761 private MenuInflater mMenuInflater; 762 763 static final class NonConfigurationInstances { 764 Object activity; 765 HashMap<String, Object> children; 766 FragmentManagerNonConfig fragments; 767 ArrayMap<String, LoaderManager> loaders; 768 VoiceInteractor voiceInteractor; 769 } 770 /* package */ NonConfigurationInstances mLastNonConfigurationInstances; 771 772 private Window mWindow; 773 774 private WindowManager mWindowManager; 775 /*package*/ View mDecor = null; 776 /*package*/ boolean mWindowAdded = false; 777 /*package*/ boolean mVisibleFromServer = false; 778 /*package*/ boolean mVisibleFromClient = true; 779 /*package*/ ActionBar mActionBar = null; 780 private boolean mEnableDefaultActionBarUp; 781 782 private VoiceInteractor mVoiceInteractor; 783 784 private CharSequence mTitle; 785 private int mTitleColor = 0; 786 787 // we must have a handler before the FragmentController is constructed 788 final Handler mHandler = new Handler(); 789 final FragmentController mFragments = FragmentController.createController(new HostCallbacks()); 790 791 // Most recent call to requestVisibleBehind(). 792 boolean mVisibleBehind; 793 794 private static final class ManagedCursor { 795 ManagedCursor(Cursor cursor) { 796 mCursor = cursor; 797 mReleased = false; 798 mUpdated = false; 799 } 800 801 private final Cursor mCursor; 802 private boolean mReleased; 803 private boolean mUpdated; 804 } 805 private final ArrayList<ManagedCursor> mManagedCursors = 806 new ArrayList<ManagedCursor>(); 807 808 // protected by synchronized (this) 809 int mResultCode = RESULT_CANCELED; 810 Intent mResultData = null; 811 812 private TranslucentConversionListener mTranslucentCallback; 813 private boolean mChangeCanvasToTranslucent; 814 815 private SearchEvent mSearchEvent; 816 817 private boolean mTitleReady = false; 818 private int mActionModeTypeStarting = ActionMode.TYPE_PRIMARY; 819 820 private int mDefaultKeyMode = DEFAULT_KEYS_DISABLE; 821 private SpannableStringBuilder mDefaultKeySsb = null; 822 823 private ActivityManager.TaskDescription mTaskDescription = 824 new ActivityManager.TaskDescription(); 825 826 protected static final int[] FOCUSED_STATE_SET = {com.android.internal.R.attr.state_focused}; 827 828 @SuppressWarnings("unused") 829 private final Object mInstanceTracker = StrictMode.trackActivity(this); 830 831 private Thread mUiThread; 832 833 ActivityTransitionState mActivityTransitionState = new ActivityTransitionState(); 834 SharedElementCallback mEnterTransitionListener = SharedElementCallback.NULL_CALLBACK; 835 SharedElementCallback mExitTransitionListener = SharedElementCallback.NULL_CALLBACK; 836 837 private boolean mHasCurrentPermissionsRequest; 838 private boolean mEatKeyUpEvent; 839 840 private static native String getDlWarning(); 841 842 /** Return the intent that started this activity. */ 843 public Intent getIntent() { 844 return mIntent; 845 } 846 847 /** 848 * Change the intent returned by {@link #getIntent}. This holds a 849 * reference to the given intent; it does not copy it. Often used in 850 * conjunction with {@link #onNewIntent}. 851 * 852 * @param newIntent The new Intent object to return from getIntent 853 * 854 * @see #getIntent 855 * @see #onNewIntent 856 */ 857 public void setIntent(Intent newIntent) { 858 mIntent = newIntent; 859 } 860 861 /** Return the application that owns this activity. */ 862 public final Application getApplication() { 863 return mApplication; 864 } 865 866 /** Is this activity embedded inside of another activity? */ 867 public final boolean isChild() { 868 return mParent != null; 869 } 870 871 /** Return the parent activity if this view is an embedded child. */ 872 public final Activity getParent() { 873 return mParent; 874 } 875 876 /** Retrieve the window manager for showing custom windows. */ 877 public WindowManager getWindowManager() { 878 return mWindowManager; 879 } 880 881 /** 882 * Retrieve the current {@link android.view.Window} for the activity. 883 * This can be used to directly access parts of the Window API that 884 * are not available through Activity/Screen. 885 * 886 * @return Window The current window, or null if the activity is not 887 * visual. 888 */ 889 public Window getWindow() { 890 return mWindow; 891 } 892 893 /** 894 * Return the LoaderManager for this activity, creating it if needed. 895 */ 896 public LoaderManager getLoaderManager() { 897 return mFragments.getLoaderManager(); 898 } 899 900 /** 901 * Calls {@link android.view.Window#getCurrentFocus} on the 902 * Window of this Activity to return the currently focused view. 903 * 904 * @return View The current View with focus or null. 905 * 906 * @see #getWindow 907 * @see android.view.Window#getCurrentFocus 908 */ 909 @Nullable 910 public View getCurrentFocus() { 911 return mWindow != null ? mWindow.getCurrentFocus() : null; 912 } 913 914 /** 915 * Called when the activity is starting. This is where most initialization 916 * should go: calling {@link #setContentView(int)} to inflate the 917 * activity's UI, using {@link #findViewById} to programmatically interact 918 * with widgets in the UI, calling 919 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)} to retrieve 920 * cursors for data being displayed, etc. 921 * 922 * <p>You can call {@link #finish} from within this function, in 923 * which case onDestroy() will be immediately called without any of the rest 924 * of the activity lifecycle ({@link #onStart}, {@link #onResume}, 925 * {@link #onPause}, etc) executing. 926 * 927 * <p><em>Derived classes must call through to the super class's 928 * implementation of this method. If they do not, an exception will be 929 * thrown.</em></p> 930 * 931 * @param savedInstanceState If the activity is being re-initialized after 932 * previously being shut down then this Bundle contains the data it most 933 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b> 934 * 935 * @see #onStart 936 * @see #onSaveInstanceState 937 * @see #onRestoreInstanceState 938 * @see #onPostCreate 939 */ 940 @MainThread 941 @CallSuper 942 protected void onCreate(@Nullable Bundle savedInstanceState) { 943 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onCreate " + this + ": " + savedInstanceState); 944 if (mLastNonConfigurationInstances != null) { 945 mFragments.restoreLoaderNonConfig(mLastNonConfigurationInstances.loaders); 946 } 947 if (mActivityInfo.parentActivityName != null) { 948 if (mActionBar == null) { 949 mEnableDefaultActionBarUp = true; 950 } else { 951 mActionBar.setDefaultDisplayHomeAsUpEnabled(true); 952 } 953 } 954 if (savedInstanceState != null) { 955 Parcelable p = savedInstanceState.getParcelable(FRAGMENTS_TAG); 956 mFragments.restoreAllState(p, mLastNonConfigurationInstances != null 957 ? mLastNonConfigurationInstances.fragments : null); 958 } 959 mFragments.dispatchCreate(); 960 getApplication().dispatchActivityCreated(this, savedInstanceState); 961 if (mVoiceInteractor != null) { 962 mVoiceInteractor.attachActivity(this); 963 } 964 mCalled = true; 965 } 966 967 /** 968 * Same as {@link #onCreate(android.os.Bundle)} but called for those activities created with 969 * the attribute {@link android.R.attr#persistableMode} set to 970 * <code>persistAcrossReboots</code>. 971 * 972 * @param savedInstanceState if the activity is being re-initialized after 973 * previously being shut down then this Bundle contains the data it most 974 * recently supplied in {@link #onSaveInstanceState}. 975 * <b><i>Note: Otherwise it is null.</i></b> 976 * @param persistentState if the activity is being re-initialized after 977 * previously being shut down or powered off then this Bundle contains the data it most 978 * recently supplied to outPersistentState in {@link #onSaveInstanceState}. 979 * <b><i>Note: Otherwise it is null.</i></b> 980 * 981 * @see #onCreate(android.os.Bundle) 982 * @see #onStart 983 * @see #onSaveInstanceState 984 * @see #onRestoreInstanceState 985 * @see #onPostCreate 986 */ 987 public void onCreate(@Nullable Bundle savedInstanceState, 988 @Nullable PersistableBundle persistentState) { 989 onCreate(savedInstanceState); 990 } 991 992 /** 993 * The hook for {@link ActivityThread} to restore the state of this activity. 994 * 995 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and 996 * {@link #restoreManagedDialogs(android.os.Bundle)}. 997 * 998 * @param savedInstanceState contains the saved state 999 */ 1000 final void performRestoreInstanceState(Bundle savedInstanceState) { 1001 onRestoreInstanceState(savedInstanceState); 1002 restoreManagedDialogs(savedInstanceState); 1003 } 1004 1005 /** 1006 * The hook for {@link ActivityThread} to restore the state of this activity. 1007 * 1008 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and 1009 * {@link #restoreManagedDialogs(android.os.Bundle)}. 1010 * 1011 * @param savedInstanceState contains the saved state 1012 * @param persistentState contains the persistable saved state 1013 */ 1014 final void performRestoreInstanceState(Bundle savedInstanceState, 1015 PersistableBundle persistentState) { 1016 onRestoreInstanceState(savedInstanceState, persistentState); 1017 if (savedInstanceState != null) { 1018 restoreManagedDialogs(savedInstanceState); 1019 } 1020 } 1021 1022 /** 1023 * This method is called after {@link #onStart} when the activity is 1024 * being re-initialized from a previously saved state, given here in 1025 * <var>savedInstanceState</var>. Most implementations will simply use {@link #onCreate} 1026 * to restore their state, but it is sometimes convenient to do it here 1027 * after all of the initialization has been done or to allow subclasses to 1028 * decide whether to use your default implementation. The default 1029 * implementation of this method performs a restore of any view state that 1030 * had previously been frozen by {@link #onSaveInstanceState}. 1031 * 1032 * <p>This method is called between {@link #onStart} and 1033 * {@link #onPostCreate}. 1034 * 1035 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}. 1036 * 1037 * @see #onCreate 1038 * @see #onPostCreate 1039 * @see #onResume 1040 * @see #onSaveInstanceState 1041 */ 1042 protected void onRestoreInstanceState(Bundle savedInstanceState) { 1043 if (mWindow != null) { 1044 Bundle windowState = savedInstanceState.getBundle(WINDOW_HIERARCHY_TAG); 1045 if (windowState != null) { 1046 mWindow.restoreHierarchyState(windowState); 1047 } 1048 } 1049 } 1050 1051 /** 1052 * This is the same as {@link #onRestoreInstanceState(Bundle)} but is called for activities 1053 * created with the attribute {@link android.R.attr#persistableMode} set to 1054 * <code>persistAcrossReboots</code>. The {@link android.os.PersistableBundle} passed 1055 * came from the restored PersistableBundle first 1056 * saved in {@link #onSaveInstanceState(Bundle, PersistableBundle)}. 1057 * 1058 * <p>This method is called between {@link #onStart} and 1059 * {@link #onPostCreate}. 1060 * 1061 * <p>If this method is called {@link #onRestoreInstanceState(Bundle)} will not be called. 1062 * 1063 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}. 1064 * @param persistentState the data most recently supplied in {@link #onSaveInstanceState}. 1065 * 1066 * @see #onRestoreInstanceState(Bundle) 1067 * @see #onCreate 1068 * @see #onPostCreate 1069 * @see #onResume 1070 * @see #onSaveInstanceState 1071 */ 1072 public void onRestoreInstanceState(Bundle savedInstanceState, 1073 PersistableBundle persistentState) { 1074 if (savedInstanceState != null) { 1075 onRestoreInstanceState(savedInstanceState); 1076 } 1077 } 1078 1079 /** 1080 * Restore the state of any saved managed dialogs. 1081 * 1082 * @param savedInstanceState The bundle to restore from. 1083 */ 1084 private void restoreManagedDialogs(Bundle savedInstanceState) { 1085 final Bundle b = savedInstanceState.getBundle(SAVED_DIALOGS_TAG); 1086 if (b == null) { 1087 return; 1088 } 1089 1090 final int[] ids = b.getIntArray(SAVED_DIALOG_IDS_KEY); 1091 final int numDialogs = ids.length; 1092 mManagedDialogs = new SparseArray<ManagedDialog>(numDialogs); 1093 for (int i = 0; i < numDialogs; i++) { 1094 final Integer dialogId = ids[i]; 1095 Bundle dialogState = b.getBundle(savedDialogKeyFor(dialogId)); 1096 if (dialogState != null) { 1097 // Calling onRestoreInstanceState() below will invoke dispatchOnCreate 1098 // so tell createDialog() not to do it, otherwise we get an exception 1099 final ManagedDialog md = new ManagedDialog(); 1100 md.mArgs = b.getBundle(savedDialogArgsKeyFor(dialogId)); 1101 md.mDialog = createDialog(dialogId, dialogState, md.mArgs); 1102 if (md.mDialog != null) { 1103 mManagedDialogs.put(dialogId, md); 1104 onPrepareDialog(dialogId, md.mDialog, md.mArgs); 1105 md.mDialog.onRestoreInstanceState(dialogState); 1106 } 1107 } 1108 } 1109 } 1110 1111 private Dialog createDialog(Integer dialogId, Bundle state, Bundle args) { 1112 final Dialog dialog = onCreateDialog(dialogId, args); 1113 if (dialog == null) { 1114 return null; 1115 } 1116 dialog.dispatchOnCreate(state); 1117 return dialog; 1118 } 1119 1120 private static String savedDialogKeyFor(int key) { 1121 return SAVED_DIALOG_KEY_PREFIX + key; 1122 } 1123 1124 private static String savedDialogArgsKeyFor(int key) { 1125 return SAVED_DIALOG_ARGS_KEY_PREFIX + key; 1126 } 1127 1128 /** 1129 * Called when activity start-up is complete (after {@link #onStart} 1130 * and {@link #onRestoreInstanceState} have been called). Applications will 1131 * generally not implement this method; it is intended for system 1132 * classes to do final initialization after application code has run. 1133 * 1134 * <p><em>Derived classes must call through to the super class's 1135 * implementation of this method. If they do not, an exception will be 1136 * thrown.</em></p> 1137 * 1138 * @param savedInstanceState If the activity is being re-initialized after 1139 * previously being shut down then this Bundle contains the data it most 1140 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b> 1141 * @see #onCreate 1142 */ 1143 @CallSuper 1144 protected void onPostCreate(@Nullable Bundle savedInstanceState) { 1145 if (!isChild()) { 1146 mTitleReady = true; 1147 onTitleChanged(getTitle(), getTitleColor()); 1148 } 1149 1150 mCalled = true; 1151 } 1152 1153 /** 1154 * This is the same as {@link #onPostCreate(Bundle)} but is called for activities 1155 * created with the attribute {@link android.R.attr#persistableMode} set to 1156 * <code>persistAcrossReboots</code>. 1157 * 1158 * @param savedInstanceState The data most recently supplied in {@link #onSaveInstanceState} 1159 * @param persistentState The data caming from the PersistableBundle first 1160 * saved in {@link #onSaveInstanceState(Bundle, PersistableBundle)}. 1161 * 1162 * @see #onCreate 1163 */ 1164 public void onPostCreate(@Nullable Bundle savedInstanceState, 1165 @Nullable PersistableBundle persistentState) { 1166 onPostCreate(savedInstanceState); 1167 } 1168 1169 /** 1170 * Called after {@link #onCreate} — or after {@link #onRestart} when 1171 * the activity had been stopped, but is now again being displayed to the 1172 * user. It will be followed by {@link #onResume}. 1173 * 1174 * <p><em>Derived classes must call through to the super class's 1175 * implementation of this method. If they do not, an exception will be 1176 * thrown.</em></p> 1177 * 1178 * @see #onCreate 1179 * @see #onStop 1180 * @see #onResume 1181 */ 1182 @CallSuper 1183 protected void onStart() { 1184 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onStart " + this); 1185 mCalled = true; 1186 1187 mFragments.doLoaderStart(); 1188 1189 getApplication().dispatchActivityStarted(this); 1190 } 1191 1192 /** 1193 * Called after {@link #onStop} when the current activity is being 1194 * re-displayed to the user (the user has navigated back to it). It will 1195 * be followed by {@link #onStart} and then {@link #onResume}. 1196 * 1197 * <p>For activities that are using raw {@link Cursor} objects (instead of 1198 * creating them through 1199 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)}, 1200 * this is usually the place 1201 * where the cursor should be requeried (because you had deactivated it in 1202 * {@link #onStop}. 1203 * 1204 * <p><em>Derived classes must call through to the super class's 1205 * implementation of this method. If they do not, an exception will be 1206 * thrown.</em></p> 1207 * 1208 * @see #onStop 1209 * @see #onStart 1210 * @see #onResume 1211 */ 1212 @CallSuper 1213 protected void onRestart() { 1214 mCalled = true; 1215 } 1216 1217 /** 1218 * Called when an {@link #onResume} is coming up, prior to other pre-resume callbacks 1219 * such as {@link #onNewIntent} and {@link #onActivityResult}. This is primarily intended 1220 * to give the activity a hint that its state is no longer saved -- it will generally 1221 * be called after {@link #onSaveInstanceState} and prior to the activity being 1222 * resumed/started again. 1223 */ 1224 public void onStateNotSaved() { 1225 } 1226 1227 /** 1228 * Called after {@link #onRestoreInstanceState}, {@link #onRestart}, or 1229 * {@link #onPause}, for your activity to start interacting with the user. 1230 * This is a good place to begin animations, open exclusive-access devices 1231 * (such as the camera), etc. 1232 * 1233 * <p>Keep in mind that onResume is not the best indicator that your activity 1234 * is visible to the user; a system window such as the keyguard may be in 1235 * front. Use {@link #onWindowFocusChanged} to know for certain that your 1236 * activity is visible to the user (for example, to resume a game). 1237 * 1238 * <p><em>Derived classes must call through to the super class's 1239 * implementation of this method. If they do not, an exception will be 1240 * thrown.</em></p> 1241 * 1242 * @see #onRestoreInstanceState 1243 * @see #onRestart 1244 * @see #onPostResume 1245 * @see #onPause 1246 */ 1247 @CallSuper 1248 protected void onResume() { 1249 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onResume " + this); 1250 getApplication().dispatchActivityResumed(this); 1251 mActivityTransitionState.onResume(this, isTopOfTask()); 1252 mCalled = true; 1253 } 1254 1255 /** 1256 * Called when activity resume is complete (after {@link #onResume} has 1257 * been called). Applications will generally not implement this method; 1258 * it is intended for system classes to do final setup after application 1259 * resume code has run. 1260 * 1261 * <p><em>Derived classes must call through to the super class's 1262 * implementation of this method. If they do not, an exception will be 1263 * thrown.</em></p> 1264 * 1265 * @see #onResume 1266 */ 1267 @CallSuper 1268 protected void onPostResume() { 1269 final Window win = getWindow(); 1270 if (win != null) win.makeActive(); 1271 if (mActionBar != null) mActionBar.setShowHideAnimationEnabled(true); 1272 mCalled = true; 1273 } 1274 1275 void setVoiceInteractor(IVoiceInteractor voiceInteractor) { 1276 if (mVoiceInteractor != null) { 1277 for (Request activeRequest: mVoiceInteractor.getActiveRequests()) { 1278 activeRequest.cancel(); 1279 activeRequest.clear(); 1280 } 1281 } 1282 if (voiceInteractor == null) { 1283 mVoiceInteractor = null; 1284 } else { 1285 mVoiceInteractor = new VoiceInteractor(voiceInteractor, this, this, 1286 Looper.myLooper()); 1287 } 1288 } 1289 1290 /** 1291 * Check whether this activity is running as part of a voice interaction with the user. 1292 * If true, it should perform its interaction with the user through the 1293 * {@link VoiceInteractor} returned by {@link #getVoiceInteractor}. 1294 */ 1295 public boolean isVoiceInteraction() { 1296 return mVoiceInteractor != null; 1297 } 1298 1299 /** 1300 * Like {@link #isVoiceInteraction}, but only returns true if this is also the root 1301 * of a voice interaction. That is, returns true if this activity was directly 1302 * started by the voice interaction service as the initiation of a voice interaction. 1303 * Otherwise, for example if it was started by another activity while under voice 1304 * interaction, returns false. 1305 */ 1306 public boolean isVoiceInteractionRoot() { 1307 try { 1308 return mVoiceInteractor != null 1309 && ActivityManagerNative.getDefault().isRootVoiceInteraction(mToken); 1310 } catch (RemoteException e) { 1311 } 1312 return false; 1313 } 1314 1315 /** 1316 * Retrieve the active {@link VoiceInteractor} that the user is going through to 1317 * interact with this activity. 1318 */ 1319 public VoiceInteractor getVoiceInteractor() { 1320 return mVoiceInteractor; 1321 } 1322 1323 /** 1324 * Queries whether the currently enabled voice interaction service supports returning 1325 * a voice interactor for use by the activity. This is valid only for the duration of the 1326 * activity. 1327 * 1328 * @return whether the current voice interaction service supports local voice interaction 1329 */ 1330 public boolean isLocalVoiceInteractionSupported() { 1331 try { 1332 return ActivityManagerNative.getDefault().supportsLocalVoiceInteraction(); 1333 } catch (RemoteException re) { 1334 } 1335 return false; 1336 } 1337 1338 /** 1339 * Starts a local voice interaction session. When ready, 1340 * {@link #onLocalVoiceInteractionStarted()} is called. You can pass a bundle of private options 1341 * to the registered voice interaction service. 1342 * @param privateOptions a Bundle of private arguments to the current voice interaction service 1343 */ 1344 public void startLocalVoiceInteraction(Bundle privateOptions) { 1345 try { 1346 ActivityManagerNative.getDefault().startLocalVoiceInteraction(mToken, privateOptions); 1347 } catch (RemoteException re) { 1348 } 1349 } 1350 1351 /** 1352 * Callback to indicate that {@link #startLocalVoiceInteraction(Bundle)} has resulted in a 1353 * voice interaction session being started. You can now retrieve a voice interactor using 1354 * {@link #getVoiceInteractor()}. 1355 */ 1356 public void onLocalVoiceInteractionStarted() { 1357 } 1358 1359 /** 1360 * Callback to indicate that the local voice interaction has stopped either 1361 * because it was requested through a call to {@link #stopLocalVoiceInteraction()} 1362 * or because it was canceled by the user. The previously acquired {@link VoiceInteractor} 1363 * is no longer valid after this. 1364 */ 1365 public void onLocalVoiceInteractionStopped() { 1366 } 1367 1368 /** 1369 * Request to terminate the current voice interaction that was previously started 1370 * using {@link #startLocalVoiceInteraction(Bundle)}. When the interaction is 1371 * terminated, {@link #onLocalVoiceInteractionStopped()} will be called. 1372 */ 1373 public void stopLocalVoiceInteraction() { 1374 try { 1375 ActivityManagerNative.getDefault().stopLocalVoiceInteraction(mToken); 1376 } catch (RemoteException re) { 1377 } 1378 } 1379 1380 /** 1381 * This is called for activities that set launchMode to "singleTop" in 1382 * their package, or if a client used the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} 1383 * flag when calling {@link #startActivity}. In either case, when the 1384 * activity is re-launched while at the top of the activity stack instead 1385 * of a new instance of the activity being started, onNewIntent() will be 1386 * called on the existing instance with the Intent that was used to 1387 * re-launch it. 1388 * 1389 * <p>An activity will always be paused before receiving a new intent, so 1390 * you can count on {@link #onResume} being called after this method. 1391 * 1392 * <p>Note that {@link #getIntent} still returns the original Intent. You 1393 * can use {@link #setIntent} to update it to this new Intent. 1394 * 1395 * @param intent The new intent that was started for the activity. 1396 * 1397 * @see #getIntent 1398 * @see #setIntent 1399 * @see #onResume 1400 */ 1401 protected void onNewIntent(Intent intent) { 1402 } 1403 1404 /** 1405 * The hook for {@link ActivityThread} to save the state of this activity. 1406 * 1407 * Calls {@link #onSaveInstanceState(android.os.Bundle)} 1408 * and {@link #saveManagedDialogs(android.os.Bundle)}. 1409 * 1410 * @param outState The bundle to save the state to. 1411 */ 1412 final void performSaveInstanceState(Bundle outState) { 1413 onSaveInstanceState(outState); 1414 saveManagedDialogs(outState); 1415 mActivityTransitionState.saveState(outState); 1416 storeHasCurrentPermissionRequest(outState); 1417 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onSaveInstanceState " + this + ": " + outState); 1418 } 1419 1420 /** 1421 * The hook for {@link ActivityThread} to save the state of this activity. 1422 * 1423 * Calls {@link #onSaveInstanceState(android.os.Bundle)} 1424 * and {@link #saveManagedDialogs(android.os.Bundle)}. 1425 * 1426 * @param outState The bundle to save the state to. 1427 * @param outPersistentState The bundle to save persistent state to. 1428 */ 1429 final void performSaveInstanceState(Bundle outState, PersistableBundle outPersistentState) { 1430 onSaveInstanceState(outState, outPersistentState); 1431 saveManagedDialogs(outState); 1432 storeHasCurrentPermissionRequest(outState); 1433 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onSaveInstanceState " + this + ": " + outState + 1434 ", " + outPersistentState); 1435 } 1436 1437 /** 1438 * Called to retrieve per-instance state from an activity before being killed 1439 * so that the state can be restored in {@link #onCreate} or 1440 * {@link #onRestoreInstanceState} (the {@link Bundle} populated by this method 1441 * will be passed to both). 1442 * 1443 * <p>This method is called before an activity may be killed so that when it 1444 * comes back some time in the future it can restore its state. For example, 1445 * if activity B is launched in front of activity A, and at some point activity 1446 * A is killed to reclaim resources, activity A will have a chance to save the 1447 * current state of its user interface via this method so that when the user 1448 * returns to activity A, the state of the user interface can be restored 1449 * via {@link #onCreate} or {@link #onRestoreInstanceState}. 1450 * 1451 * <p>Do not confuse this method with activity lifecycle callbacks such as 1452 * {@link #onPause}, which is always called when an activity is being placed 1453 * in the background or on its way to destruction, or {@link #onStop} which 1454 * is called before destruction. One example of when {@link #onPause} and 1455 * {@link #onStop} is called and not this method is when a user navigates back 1456 * from activity B to activity A: there is no need to call {@link #onSaveInstanceState} 1457 * on B because that particular instance will never be restored, so the 1458 * system avoids calling it. An example when {@link #onPause} is called and 1459 * not {@link #onSaveInstanceState} is when activity B is launched in front of activity A: 1460 * the system may avoid calling {@link #onSaveInstanceState} on activity A if it isn't 1461 * killed during the lifetime of B since the state of the user interface of 1462 * A will stay intact. 1463 * 1464 * <p>The default implementation takes care of most of the UI per-instance 1465 * state for you by calling {@link android.view.View#onSaveInstanceState()} on each 1466 * view in the hierarchy that has an id, and by saving the id of the currently 1467 * focused view (all of which is restored by the default implementation of 1468 * {@link #onRestoreInstanceState}). If you override this method to save additional 1469 * information not captured by each individual view, you will likely want to 1470 * call through to the default implementation, otherwise be prepared to save 1471 * all of the state of each view yourself. 1472 * 1473 * <p>If called, this method will occur before {@link #onStop}. There are 1474 * no guarantees about whether it will occur before or after {@link #onPause}. 1475 * 1476 * @param outState Bundle in which to place your saved state. 1477 * 1478 * @see #onCreate 1479 * @see #onRestoreInstanceState 1480 * @see #onPause 1481 */ 1482 protected void onSaveInstanceState(Bundle outState) { 1483 outState.putBundle(WINDOW_HIERARCHY_TAG, mWindow.saveHierarchyState()); 1484 Parcelable p = mFragments.saveAllState(); 1485 if (p != null) { 1486 outState.putParcelable(FRAGMENTS_TAG, p); 1487 } 1488 getApplication().dispatchActivitySaveInstanceState(this, outState); 1489 } 1490 1491 /** 1492 * This is the same as {@link #onSaveInstanceState} but is called for activities 1493 * created with the attribute {@link android.R.attr#persistableMode} set to 1494 * <code>persistAcrossReboots</code>. The {@link android.os.PersistableBundle} passed 1495 * in will be saved and presented in {@link #onCreate(Bundle, PersistableBundle)} 1496 * the first time that this activity is restarted following the next device reboot. 1497 * 1498 * @param outState Bundle in which to place your saved state. 1499 * @param outPersistentState State which will be saved across reboots. 1500 * 1501 * @see #onSaveInstanceState(Bundle) 1502 * @see #onCreate 1503 * @see #onRestoreInstanceState(Bundle, PersistableBundle) 1504 * @see #onPause 1505 */ 1506 public void onSaveInstanceState(Bundle outState, PersistableBundle outPersistentState) { 1507 onSaveInstanceState(outState); 1508 } 1509 1510 /** 1511 * Save the state of any managed dialogs. 1512 * 1513 * @param outState place to store the saved state. 1514 */ 1515 private void saveManagedDialogs(Bundle outState) { 1516 if (mManagedDialogs == null) { 1517 return; 1518 } 1519 1520 final int numDialogs = mManagedDialogs.size(); 1521 if (numDialogs == 0) { 1522 return; 1523 } 1524 1525 Bundle dialogState = new Bundle(); 1526 1527 int[] ids = new int[mManagedDialogs.size()]; 1528 1529 // save each dialog's bundle, gather the ids 1530 for (int i = 0; i < numDialogs; i++) { 1531 final int key = mManagedDialogs.keyAt(i); 1532 ids[i] = key; 1533 final ManagedDialog md = mManagedDialogs.valueAt(i); 1534 dialogState.putBundle(savedDialogKeyFor(key), md.mDialog.onSaveInstanceState()); 1535 if (md.mArgs != null) { 1536 dialogState.putBundle(savedDialogArgsKeyFor(key), md.mArgs); 1537 } 1538 } 1539 1540 dialogState.putIntArray(SAVED_DIALOG_IDS_KEY, ids); 1541 outState.putBundle(SAVED_DIALOGS_TAG, dialogState); 1542 } 1543 1544 1545 /** 1546 * Called as part of the activity lifecycle when an activity is going into 1547 * the background, but has not (yet) been killed. The counterpart to 1548 * {@link #onResume}. 1549 * 1550 * <p>When activity B is launched in front of activity A, this callback will 1551 * be invoked on A. B will not be created until A's {@link #onPause} returns, 1552 * so be sure to not do anything lengthy here. 1553 * 1554 * <p>This callback is mostly used for saving any persistent state the 1555 * activity is editing, to present a "edit in place" model to the user and 1556 * making sure nothing is lost if there are not enough resources to start 1557 * the new activity without first killing this one. This is also a good 1558 * place to do things like stop animations and other things that consume a 1559 * noticeable amount of CPU in order to make the switch to the next activity 1560 * as fast as possible, or to close resources that are exclusive access 1561 * such as the camera. 1562 * 1563 * <p>In situations where the system needs more memory it may kill paused 1564 * processes to reclaim resources. Because of this, you should be sure 1565 * that all of your state is saved by the time you return from 1566 * this function. In general {@link #onSaveInstanceState} is used to save 1567 * per-instance state in the activity and this method is used to store 1568 * global persistent data (in content providers, files, etc.) 1569 * 1570 * <p>After receiving this call you will usually receive a following call 1571 * to {@link #onStop} (after the next activity has been resumed and 1572 * displayed), however in some cases there will be a direct call back to 1573 * {@link #onResume} without going through the stopped state. 1574 * 1575 * <p><em>Derived classes must call through to the super class's 1576 * implementation of this method. If they do not, an exception will be 1577 * thrown.</em></p> 1578 * 1579 * @see #onResume 1580 * @see #onSaveInstanceState 1581 * @see #onStop 1582 */ 1583 @CallSuper 1584 protected void onPause() { 1585 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onPause " + this); 1586 getApplication().dispatchActivityPaused(this); 1587 mCalled = true; 1588 } 1589 1590 /** 1591 * Called as part of the activity lifecycle when an activity is about to go 1592 * into the background as the result of user choice. For example, when the 1593 * user presses the Home key, {@link #onUserLeaveHint} will be called, but 1594 * when an incoming phone call causes the in-call Activity to be automatically 1595 * brought to the foreground, {@link #onUserLeaveHint} will not be called on 1596 * the activity being interrupted. In cases when it is invoked, this method 1597 * is called right before the activity's {@link #onPause} callback. 1598 * 1599 * <p>This callback and {@link #onUserInteraction} are intended to help 1600 * activities manage status bar notifications intelligently; specifically, 1601 * for helping activities determine the proper time to cancel a notfication. 1602 * 1603 * @see #onUserInteraction() 1604 */ 1605 protected void onUserLeaveHint() { 1606 } 1607 1608 /** 1609 * Generate a new thumbnail for this activity. This method is called before 1610 * pausing the activity, and should draw into <var>outBitmap</var> the 1611 * imagery for the desired thumbnail in the dimensions of that bitmap. It 1612 * can use the given <var>canvas</var>, which is configured to draw into the 1613 * bitmap, for rendering if desired. 1614 * 1615 * <p>The default implementation returns fails and does not draw a thumbnail; 1616 * this will result in the platform creating its own thumbnail if needed. 1617 * 1618 * @param outBitmap The bitmap to contain the thumbnail. 1619 * @param canvas Can be used to render into the bitmap. 1620 * 1621 * @return Return true if you have drawn into the bitmap; otherwise after 1622 * you return it will be filled with a default thumbnail. 1623 * 1624 * @see #onCreateDescription 1625 * @see #onSaveInstanceState 1626 * @see #onPause 1627 */ 1628 public boolean onCreateThumbnail(Bitmap outBitmap, Canvas canvas) { 1629 return false; 1630 } 1631 1632 /** 1633 * Generate a new description for this activity. This method is called 1634 * before pausing the activity and can, if desired, return some textual 1635 * description of its current state to be displayed to the user. 1636 * 1637 * <p>The default implementation returns null, which will cause you to 1638 * inherit the description from the previous activity. If all activities 1639 * return null, generally the label of the top activity will be used as the 1640 * description. 1641 * 1642 * @return A description of what the user is doing. It should be short and 1643 * sweet (only a few words). 1644 * 1645 * @see #onCreateThumbnail 1646 * @see #onSaveInstanceState 1647 * @see #onPause 1648 */ 1649 @Nullable 1650 public CharSequence onCreateDescription() { 1651 return null; 1652 } 1653 1654 /** 1655 * This is called when the user is requesting an assist, to build a full 1656 * {@link Intent#ACTION_ASSIST} Intent with all of the context of the current 1657 * application. You can override this method to place into the bundle anything 1658 * you would like to appear in the {@link Intent#EXTRA_ASSIST_CONTEXT} part 1659 * of the assist Intent. 1660 * 1661 * <p>This function will be called after any global assist callbacks that had 1662 * been registered with {@link Application#registerOnProvideAssistDataListener 1663 * Application.registerOnProvideAssistDataListener}. 1664 */ 1665 public void onProvideAssistData(Bundle data) { 1666 } 1667 1668 /** 1669 * This is called when the user is requesting an assist, to provide references 1670 * to content related to the current activity. Before being called, the 1671 * {@code outContent} Intent is filled with the base Intent of the activity (the Intent 1672 * returned by {@link #getIntent()}). The Intent's extras are stripped of any types 1673 * that are not valid for {@link PersistableBundle} or non-framework Parcelables, and 1674 * the flags {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION} and 1675 * {@link Intent#FLAG_GRANT_PERSISTABLE_URI_PERMISSION} are cleared from the Intent. 1676 * 1677 * <p>Custom implementation may adjust the content intent to better reflect the top-level 1678 * context of the activity, and fill in its ClipData with additional content of 1679 * interest that the user is currently viewing. For example, an image gallery application 1680 * that has launched in to an activity allowing the user to swipe through pictures should 1681 * modify the intent to reference the current image they are looking it; such an 1682 * application when showing a list of pictures should add a ClipData that has 1683 * references to all of the pictures currently visible on screen.</p> 1684 * 1685 * @param outContent The assist content to return. 1686 */ 1687 public void onProvideAssistContent(AssistContent outContent) { 1688 } 1689 1690 /** 1691 * Request the Keyboard Shortcuts screen to show up. This will trigger 1692 * {@link #onProvideKeyboardShortcuts} to retrieve the shortcuts for the foreground activity. 1693 */ 1694 public final void requestShowKeyboardShortcuts() { 1695 Intent intent = new Intent(Intent.ACTION_SHOW_KEYBOARD_SHORTCUTS); 1696 intent.setPackage(KEYBOARD_SHORTCUTS_RECEIVER_PKG_NAME); 1697 sendBroadcastAsUser(intent, UserHandle.SYSTEM); 1698 } 1699 1700 /** 1701 * Dismiss the Keyboard Shortcuts screen. 1702 */ 1703 public final void dismissKeyboardShortcutsHelper() { 1704 Intent intent = new Intent(Intent.ACTION_DISMISS_KEYBOARD_SHORTCUTS); 1705 intent.setPackage(KEYBOARD_SHORTCUTS_RECEIVER_PKG_NAME); 1706 sendBroadcastAsUser(intent, UserHandle.SYSTEM); 1707 } 1708 1709 @Override 1710 public void onProvideKeyboardShortcuts( 1711 List<KeyboardShortcutGroup> data, Menu menu, int deviceId) { 1712 if (menu == null) { 1713 return; 1714 } 1715 KeyboardShortcutGroup group = null; 1716 int menuSize = menu.size(); 1717 for (int i = 0; i < menuSize; ++i) { 1718 final MenuItem item = menu.getItem(i); 1719 final CharSequence title = item.getTitle(); 1720 final char alphaShortcut = item.getAlphabeticShortcut(); 1721 if (title != null && alphaShortcut != MIN_VALUE) { 1722 if (group == null) { 1723 final int resource = mApplication.getApplicationInfo().labelRes; 1724 group = new KeyboardShortcutGroup(resource != 0 ? getString(resource) : null); 1725 } 1726 group.addItem(new KeyboardShortcutInfo( 1727 title, alphaShortcut, KeyEvent.META_CTRL_ON)); 1728 } 1729 } 1730 if (group != null) { 1731 data.add(group); 1732 } 1733 } 1734 1735 /** 1736 * Ask to have the current assistant shown to the user. This only works if the calling 1737 * activity is the current foreground activity. It is the same as calling 1738 * {@link android.service.voice.VoiceInteractionService#showSession 1739 * VoiceInteractionService.showSession} and requesting all of the possible context. 1740 * The receiver will always see 1741 * {@link android.service.voice.VoiceInteractionSession#SHOW_SOURCE_APPLICATION} set. 1742 * @return Returns true if the assistant was successfully invoked, else false. For example 1743 * false will be returned if the caller is not the current top activity. 1744 */ 1745 public boolean showAssist(Bundle args) { 1746 try { 1747 return ActivityManagerNative.getDefault().showAssistFromActivity(mToken, args); 1748 } catch (RemoteException e) { 1749 } 1750 return false; 1751 } 1752 1753 /** 1754 * Called when you are no longer visible to the user. You will next 1755 * receive either {@link #onRestart}, {@link #onDestroy}, or nothing, 1756 * depending on later user activity. 1757 * 1758 * <p><em>Derived classes must call through to the super class's 1759 * implementation of this method. If they do not, an exception will be 1760 * thrown.</em></p> 1761 * 1762 * @see #onRestart 1763 * @see #onResume 1764 * @see #onSaveInstanceState 1765 * @see #onDestroy 1766 */ 1767 @CallSuper 1768 protected void onStop() { 1769 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onStop " + this); 1770 if (mActionBar != null) mActionBar.setShowHideAnimationEnabled(false); 1771 mActivityTransitionState.onStop(); 1772 getApplication().dispatchActivityStopped(this); 1773 mTranslucentCallback = null; 1774 mCalled = true; 1775 } 1776 1777 /** 1778 * Perform any final cleanup before an activity is destroyed. This can 1779 * happen either because the activity is finishing (someone called 1780 * {@link #finish} on it, or because the system is temporarily destroying 1781 * this instance of the activity to save space. You can distinguish 1782 * between these two scenarios with the {@link #isFinishing} method. 1783 * 1784 * <p><em>Note: do not count on this method being called as a place for 1785 * saving data! For example, if an activity is editing data in a content 1786 * provider, those edits should be committed in either {@link #onPause} or 1787 * {@link #onSaveInstanceState}, not here.</em> This method is usually implemented to 1788 * free resources like threads that are associated with an activity, so 1789 * that a destroyed activity does not leave such things around while the 1790 * rest of its application is still running. There are situations where 1791 * the system will simply kill the activity's hosting process without 1792 * calling this method (or any others) in it, so it should not be used to 1793 * do things that are intended to remain around after the process goes 1794 * away. 1795 * 1796 * <p><em>Derived classes must call through to the super class's 1797 * implementation of this method. If they do not, an exception will be 1798 * thrown.</em></p> 1799 * 1800 * @see #onPause 1801 * @see #onStop 1802 * @see #finish 1803 * @see #isFinishing 1804 */ 1805 @CallSuper 1806 protected void onDestroy() { 1807 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onDestroy " + this); 1808 mCalled = true; 1809 1810 // dismiss any dialogs we are managing. 1811 if (mManagedDialogs != null) { 1812 final int numDialogs = mManagedDialogs.size(); 1813 for (int i = 0; i < numDialogs; i++) { 1814 final ManagedDialog md = mManagedDialogs.valueAt(i); 1815 if (md.mDialog.isShowing()) { 1816 md.mDialog.dismiss(); 1817 } 1818 } 1819 mManagedDialogs = null; 1820 } 1821 1822 // close any cursors we are managing. 1823 synchronized (mManagedCursors) { 1824 int numCursors = mManagedCursors.size(); 1825 for (int i = 0; i < numCursors; i++) { 1826 ManagedCursor c = mManagedCursors.get(i); 1827 if (c != null) { 1828 c.mCursor.close(); 1829 } 1830 } 1831 mManagedCursors.clear(); 1832 } 1833 1834 // Close any open search dialog 1835 if (mSearchManager != null) { 1836 mSearchManager.stopSearch(); 1837 } 1838 1839 if (mActionBar != null) { 1840 mActionBar.onDestroy(); 1841 } 1842 1843 getApplication().dispatchActivityDestroyed(this); 1844 } 1845 1846 /** 1847 * Report to the system that your app is now fully drawn, purely for diagnostic 1848 * purposes (calling it does not impact the visible behavior of the activity). 1849 * This is only used to help instrument application launch times, so that the 1850 * app can report when it is fully in a usable state; without this, the only thing 1851 * the system itself can determine is the point at which the activity's window 1852 * is <em>first</em> drawn and displayed. To participate in app launch time 1853 * measurement, you should always call this method after first launch (when 1854 * {@link #onCreate(android.os.Bundle)} is called), at the point where you have 1855 * entirely drawn your UI and populated with all of the significant data. You 1856 * can safely call this method any time after first launch as well, in which case 1857 * it will simply be ignored. 1858 */ 1859 public void reportFullyDrawn() { 1860 if (mDoReportFullyDrawn) { 1861 mDoReportFullyDrawn = false; 1862 try { 1863 ActivityManagerNative.getDefault().reportActivityFullyDrawn(mToken); 1864 } catch (RemoteException e) { 1865 } 1866 } 1867 } 1868 1869 /** 1870 * Called by the system when the activity changes from fullscreen mode to multi-window mode and 1871 * visa-versa. 1872 * @see android.R.attr#resizeableActivity 1873 * 1874 * @param isInMultiWindowMode True if the activity is in multi-window mode. 1875 */ 1876 public void onMultiWindowModeChanged(boolean isInMultiWindowMode) { 1877 // Left deliberately empty. There should be no side effects if a direct 1878 // subclass of Activity does not call super. 1879 } 1880 1881 /** 1882 * Returns true if the activity is currently in multi-window mode. 1883 * @see android.R.attr#resizeableActivity 1884 * 1885 * @return True if the activity is in multi-window mode. 1886 */ 1887 public boolean isInMultiWindowMode() { 1888 try { 1889 return ActivityManagerNative.getDefault().isInMultiWindowMode(mToken); 1890 } catch (RemoteException e) { 1891 } 1892 return false; 1893 } 1894 1895 /** 1896 * Called by the system when the activity changes to and from picture-in-picture mode. 1897 * @see android.R.attr#supportsPictureInPicture 1898 * 1899 * @param isInPictureInPictureMode True if the activity is in picture-in-picture mode. 1900 */ 1901 public void onPictureInPictureModeChanged(boolean isInPictureInPictureMode) { 1902 // Left deliberately empty. There should be no side effects if a direct 1903 // subclass of Activity does not call super. 1904 } 1905 1906 /** 1907 * Returns true if the activity is currently in picture-in-picture mode. 1908 * @see android.R.attr#supportsPictureInPicture 1909 * 1910 * @return True if the activity is in picture-in-picture mode. 1911 */ 1912 public boolean isInPictureInPictureMode() { 1913 try { 1914 return ActivityManagerNative.getDefault().isInPictureInPictureMode(mToken); 1915 } catch (RemoteException e) { 1916 } 1917 return false; 1918 } 1919 1920 /** 1921 * Puts the activity in picture-in-picture mode. 1922 * @see android.R.attr#supportsPictureInPicture 1923 */ 1924 public void enterPictureInPictureMode() { 1925 try { 1926 ActivityManagerNative.getDefault().enterPictureInPictureMode(mToken); 1927 } catch (RemoteException e) { 1928 } 1929 } 1930 1931 /** 1932 * Puts the activity in picture-in-picture mode with a given aspect ratio. 1933 * @see android.R.attr#supportsPictureInPicture 1934 * 1935 * @param aspectRatio the new aspect ratio of the picture-in-picture. 1936 */ 1937 public void enterPictureInPictureMode(float aspectRatio) { 1938 try { 1939 ActivityManagerNative.getDefault().enterPictureInPictureModeWithAspectRatio(mToken, 1940 aspectRatio); 1941 } catch (RemoteException e) { 1942 } 1943 } 1944 1945 /** 1946 * Updates the aspect ratio of the current picture-in-picture activity. 1947 * 1948 * @param aspectRatio the new aspect ratio of the picture-in-picture. 1949 */ 1950 public void setPictureInPictureAspectRatio(float aspectRatio) { 1951 try { 1952 ActivityManagerNative.getDefault().setPictureInPictureAspectRatio(mToken, aspectRatio); 1953 } catch (RemoteException e) { 1954 } 1955 } 1956 1957 /** 1958 * Called by the system when the device configuration changes while your 1959 * activity is running. Note that this will <em>only</em> be called if 1960 * you have selected configurations you would like to handle with the 1961 * {@link android.R.attr#configChanges} attribute in your manifest. If 1962 * any configuration change occurs that is not selected to be reported 1963 * by that attribute, then instead of reporting it the system will stop 1964 * and restart the activity (to have it launched with the new 1965 * configuration). 1966 * 1967 * <p>At the time that this function has been called, your Resources 1968 * object will have been updated to return resource values matching the 1969 * new configuration. 1970 * 1971 * @param newConfig The new device configuration. 1972 */ 1973 public void onConfigurationChanged(Configuration newConfig) { 1974 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onConfigurationChanged " + this + ": " + newConfig); 1975 mCalled = true; 1976 1977 mFragments.dispatchConfigurationChanged(newConfig); 1978 1979 if (mWindow != null) { 1980 // Pass the configuration changed event to the window 1981 mWindow.onConfigurationChanged(newConfig); 1982 } 1983 1984 if (mActionBar != null) { 1985 // Do this last; the action bar will need to access 1986 // view changes from above. 1987 mActionBar.onConfigurationChanged(newConfig); 1988 } 1989 } 1990 1991 /** 1992 * If this activity is being destroyed because it can not handle a 1993 * configuration parameter being changed (and thus its 1994 * {@link #onConfigurationChanged(Configuration)} method is 1995 * <em>not</em> being called), then you can use this method to discover 1996 * the set of changes that have occurred while in the process of being 1997 * destroyed. Note that there is no guarantee that these will be 1998 * accurate (other changes could have happened at any time), so you should 1999 * only use this as an optimization hint. 2000 * 2001 * @return Returns a bit field of the configuration parameters that are 2002 * changing, as defined by the {@link android.content.res.Configuration} 2003 * class. 2004 */ 2005 public int getChangingConfigurations() { 2006 return mConfigChangeFlags; 2007 } 2008 2009 /** 2010 * Retrieve the non-configuration instance data that was previously 2011 * returned by {@link #onRetainNonConfigurationInstance()}. This will 2012 * be available from the initial {@link #onCreate} and 2013 * {@link #onStart} calls to the new instance, allowing you to extract 2014 * any useful dynamic state from the previous instance. 2015 * 2016 * <p>Note that the data you retrieve here should <em>only</em> be used 2017 * as an optimization for handling configuration changes. You should always 2018 * be able to handle getting a null pointer back, and an activity must 2019 * still be able to restore itself to its previous state (through the 2020 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this 2021 * function returns null. 2022 * 2023 * <p><strong>Note:</strong> For most cases you should use the {@link Fragment} API 2024 * {@link Fragment#setRetainInstance(boolean)} instead; this is also 2025 * available on older platforms through the Android support libraries. 2026 * 2027 * @return the object previously returned by {@link #onRetainNonConfigurationInstance()} 2028 */ 2029 @Nullable 2030 public Object getLastNonConfigurationInstance() { 2031 return mLastNonConfigurationInstances != null 2032 ? mLastNonConfigurationInstances.activity : null; 2033 } 2034 2035 /** 2036 * Called by the system, as part of destroying an 2037 * activity due to a configuration change, when it is known that a new 2038 * instance will immediately be created for the new configuration. You 2039 * can return any object you like here, including the activity instance 2040 * itself, which can later be retrieved by calling 2041 * {@link #getLastNonConfigurationInstance()} in the new activity 2042 * instance. 2043 * 2044 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB} 2045 * or later, consider instead using a {@link Fragment} with 2046 * {@link Fragment#setRetainInstance(boolean) 2047 * Fragment.setRetainInstance(boolean}.</em> 2048 * 2049 * <p>This function is called purely as an optimization, and you must 2050 * not rely on it being called. When it is called, a number of guarantees 2051 * will be made to help optimize configuration switching: 2052 * <ul> 2053 * <li> The function will be called between {@link #onStop} and 2054 * {@link #onDestroy}. 2055 * <li> A new instance of the activity will <em>always</em> be immediately 2056 * created after this one's {@link #onDestroy()} is called. In particular, 2057 * <em>no</em> messages will be dispatched during this time (when the returned 2058 * object does not have an activity to be associated with). 2059 * <li> The object you return here will <em>always</em> be available from 2060 * the {@link #getLastNonConfigurationInstance()} method of the following 2061 * activity instance as described there. 2062 * </ul> 2063 * 2064 * <p>These guarantees are designed so that an activity can use this API 2065 * to propagate extensive state from the old to new activity instance, from 2066 * loaded bitmaps, to network connections, to evenly actively running 2067 * threads. Note that you should <em>not</em> propagate any data that 2068 * may change based on the configuration, including any data loaded from 2069 * resources such as strings, layouts, or drawables. 2070 * 2071 * <p>The guarantee of no message handling during the switch to the next 2072 * activity simplifies use with active objects. For example if your retained 2073 * state is an {@link android.os.AsyncTask} you are guaranteed that its 2074 * call back functions (like {@link android.os.AsyncTask#onPostExecute}) will 2075 * not be called from the call here until you execute the next instance's 2076 * {@link #onCreate(Bundle)}. (Note however that there is of course no such 2077 * guarantee for {@link android.os.AsyncTask#doInBackground} since that is 2078 * running in a separate thread.) 2079 * 2080 * <p><strong>Note:</strong> For most cases you should use the {@link Fragment} API 2081 * {@link Fragment#setRetainInstance(boolean)} instead; this is also 2082 * available on older platforms through the Android support libraries. 2083 * 2084 * @return any Object holding the desired state to propagate to the 2085 * next activity instance 2086 */ 2087 public Object onRetainNonConfigurationInstance() { 2088 return null; 2089 } 2090 2091 /** 2092 * Retrieve the non-configuration instance data that was previously 2093 * returned by {@link #onRetainNonConfigurationChildInstances()}. This will 2094 * be available from the initial {@link #onCreate} and 2095 * {@link #onStart} calls to the new instance, allowing you to extract 2096 * any useful dynamic state from the previous instance. 2097 * 2098 * <p>Note that the data you retrieve here should <em>only</em> be used 2099 * as an optimization for handling configuration changes. You should always 2100 * be able to handle getting a null pointer back, and an activity must 2101 * still be able to restore itself to its previous state (through the 2102 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this 2103 * function returns null. 2104 * 2105 * @return Returns the object previously returned by 2106 * {@link #onRetainNonConfigurationChildInstances()} 2107 */ 2108 @Nullable 2109 HashMap<String, Object> getLastNonConfigurationChildInstances() { 2110 return mLastNonConfigurationInstances != null 2111 ? mLastNonConfigurationInstances.children : null; 2112 } 2113 2114 /** 2115 * This method is similar to {@link #onRetainNonConfigurationInstance()} except that 2116 * it should return either a mapping from child activity id strings to arbitrary objects, 2117 * or null. This method is intended to be used by Activity framework subclasses that control a 2118 * set of child activities, such as ActivityGroup. The same guarantees and restrictions apply 2119 * as for {@link #onRetainNonConfigurationInstance()}. The default implementation returns null. 2120 */ 2121 @Nullable 2122 HashMap<String,Object> onRetainNonConfigurationChildInstances() { 2123 return null; 2124 } 2125 2126 NonConfigurationInstances retainNonConfigurationInstances() { 2127 Object activity = onRetainNonConfigurationInstance(); 2128 HashMap<String, Object> children = onRetainNonConfigurationChildInstances(); 2129 FragmentManagerNonConfig fragments = mFragments.retainNestedNonConfig(); 2130 2131 // We're already stopped but we've been asked to retain. 2132 // Our fragments are taken care of but we need to mark the loaders for retention. 2133 // In order to do this correctly we need to restart the loaders first before 2134 // handing them off to the next activity. 2135 mFragments.doLoaderStart(); 2136 mFragments.doLoaderStop(true); 2137 ArrayMap<String, LoaderManager> loaders = mFragments.retainLoaderNonConfig(); 2138 2139 if (activity == null && children == null && fragments == null && loaders == null 2140 && mVoiceInteractor == null) { 2141 return null; 2142 } 2143 2144 NonConfigurationInstances nci = new NonConfigurationInstances(); 2145 nci.activity = activity; 2146 nci.children = children; 2147 nci.fragments = fragments; 2148 nci.loaders = loaders; 2149 if (mVoiceInteractor != null) { 2150 mVoiceInteractor.retainInstance(); 2151 nci.voiceInteractor = mVoiceInteractor; 2152 } 2153 return nci; 2154 } 2155 2156 public void onLowMemory() { 2157 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onLowMemory " + this); 2158 mCalled = true; 2159 mFragments.dispatchLowMemory(); 2160 } 2161 2162 public void onTrimMemory(int level) { 2163 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onTrimMemory " + this + ": " + level); 2164 mCalled = true; 2165 mFragments.dispatchTrimMemory(level); 2166 } 2167 2168 /** 2169 * Return the FragmentManager for interacting with fragments associated 2170 * with this activity. 2171 */ 2172 public FragmentManager getFragmentManager() { 2173 return mFragments.getFragmentManager(); 2174 } 2175 2176 /** 2177 * Called when a Fragment is being attached to this activity, immediately 2178 * after the call to its {@link Fragment#onAttach Fragment.onAttach()} 2179 * method and before {@link Fragment#onCreate Fragment.onCreate()}. 2180 */ 2181 public void onAttachFragment(Fragment fragment) { 2182 } 2183 2184 /** 2185 * Wrapper around 2186 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)} 2187 * that gives the resulting {@link Cursor} to call 2188 * {@link #startManagingCursor} so that the activity will manage its 2189 * lifecycle for you. 2190 * 2191 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB} 2192 * or later, consider instead using {@link LoaderManager} instead, available 2193 * via {@link #getLoaderManager()}.</em> 2194 * 2195 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on a cursor obtained using 2196 * this method, because the activity will do that for you at the appropriate time. However, if 2197 * you call {@link #stopManagingCursor} on a cursor from a managed query, the system <em>will 2198 * not</em> automatically close the cursor and, in that case, you must call 2199 * {@link Cursor#close()}.</p> 2200 * 2201 * @param uri The URI of the content provider to query. 2202 * @param projection List of columns to return. 2203 * @param selection SQL WHERE clause. 2204 * @param sortOrder SQL ORDER BY clause. 2205 * 2206 * @return The Cursor that was returned by query(). 2207 * 2208 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String) 2209 * @see #startManagingCursor 2210 * @hide 2211 * 2212 * @deprecated Use {@link CursorLoader} instead. 2213 */ 2214 @Deprecated 2215 public final Cursor managedQuery(Uri uri, String[] projection, String selection, 2216 String sortOrder) { 2217 Cursor c = getContentResolver().query(uri, projection, selection, null, sortOrder); 2218 if (c != null) { 2219 startManagingCursor(c); 2220 } 2221 return c; 2222 } 2223 2224 /** 2225 * Wrapper around 2226 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)} 2227 * that gives the resulting {@link Cursor} to call 2228 * {@link #startManagingCursor} so that the activity will manage its 2229 * lifecycle for you. 2230 * 2231 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB} 2232 * or later, consider instead using {@link LoaderManager} instead, available 2233 * via {@link #getLoaderManager()}.</em> 2234 * 2235 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on a cursor obtained using 2236 * this method, because the activity will do that for you at the appropriate time. However, if 2237 * you call {@link #stopManagingCursor} on a cursor from a managed query, the system <em>will 2238 * not</em> automatically close the cursor and, in that case, you must call 2239 * {@link Cursor#close()}.</p> 2240 * 2241 * @param uri The URI of the content provider to query. 2242 * @param projection List of columns to return. 2243 * @param selection SQL WHERE clause. 2244 * @param selectionArgs The arguments to selection, if any ?s are pesent 2245 * @param sortOrder SQL ORDER BY clause. 2246 * 2247 * @return The Cursor that was returned by query(). 2248 * 2249 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String) 2250 * @see #startManagingCursor 2251 * 2252 * @deprecated Use {@link CursorLoader} instead. 2253 */ 2254 @Deprecated 2255 public final Cursor managedQuery(Uri uri, String[] projection, String selection, 2256 String[] selectionArgs, String sortOrder) { 2257 Cursor c = getContentResolver().query(uri, projection, selection, selectionArgs, sortOrder); 2258 if (c != null) { 2259 startManagingCursor(c); 2260 } 2261 return c; 2262 } 2263 2264 /** 2265 * This method allows the activity to take care of managing the given 2266 * {@link Cursor}'s lifecycle for you based on the activity's lifecycle. 2267 * That is, when the activity is stopped it will automatically call 2268 * {@link Cursor#deactivate} on the given Cursor, and when it is later restarted 2269 * it will call {@link Cursor#requery} for you. When the activity is 2270 * destroyed, all managed Cursors will be closed automatically. 2271 * 2272 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB} 2273 * or later, consider instead using {@link LoaderManager} instead, available 2274 * via {@link #getLoaderManager()}.</em> 2275 * 2276 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on cursor obtained from 2277 * {@link #managedQuery}, because the activity will do that for you at the appropriate time. 2278 * However, if you call {@link #stopManagingCursor} on a cursor from a managed query, the system 2279 * <em>will not</em> automatically close the cursor and, in that case, you must call 2280 * {@link Cursor#close()}.</p> 2281 * 2282 * @param c The Cursor to be managed. 2283 * 2284 * @see #managedQuery(android.net.Uri , String[], String, String[], String) 2285 * @see #stopManagingCursor 2286 * 2287 * @deprecated Use the new {@link android.content.CursorLoader} class with 2288 * {@link LoaderManager} instead; this is also 2289 * available on older platforms through the Android compatibility package. 2290 */ 2291 @Deprecated 2292 public void startManagingCursor(Cursor c) { 2293 synchronized (mManagedCursors) { 2294 mManagedCursors.add(new ManagedCursor(c)); 2295 } 2296 } 2297 2298 /** 2299 * Given a Cursor that was previously given to 2300 * {@link #startManagingCursor}, stop the activity's management of that 2301 * cursor. 2302 * 2303 * <p><strong>Warning:</strong> After calling this method on a cursor from a managed query, 2304 * the system <em>will not</em> automatically close the cursor and you must call 2305 * {@link Cursor#close()}.</p> 2306 * 2307 * @param c The Cursor that was being managed. 2308 * 2309 * @see #startManagingCursor 2310 * 2311 * @deprecated Use the new {@link android.content.CursorLoader} class with 2312 * {@link LoaderManager} instead; this is also 2313 * available on older platforms through the Android compatibility package. 2314 */ 2315 @Deprecated 2316 public void stopManagingCursor(Cursor c) { 2317 synchronized (mManagedCursors) { 2318 final int N = mManagedCursors.size(); 2319 for (int i=0; i<N; i++) { 2320 ManagedCursor mc = mManagedCursors.get(i); 2321 if (mc.mCursor == c) { 2322 mManagedCursors.remove(i); 2323 break; 2324 } 2325 } 2326 } 2327 } 2328 2329 /** 2330 * @deprecated As of {@link android.os.Build.VERSION_CODES#GINGERBREAD} 2331 * this is a no-op. 2332 * @hide 2333 */ 2334 @Deprecated 2335 public void setPersistent(boolean isPersistent) { 2336 } 2337 2338 /** 2339 * Finds a view that was identified by the id attribute from the XML that 2340 * was processed in {@link #onCreate}. 2341 * 2342 * @return The view if found or null otherwise. 2343 */ 2344 @Nullable 2345 public View findViewById(@IdRes int id) { 2346 return getWindow().findViewById(id); 2347 } 2348 2349 /** 2350 * Retrieve a reference to this activity's ActionBar. 2351 * 2352 * @return The Activity's ActionBar, or null if it does not have one. 2353 */ 2354 @Nullable 2355 public ActionBar getActionBar() { 2356 initWindowDecorActionBar(); 2357 return mActionBar; 2358 } 2359 2360 /** 2361 * Set a {@link android.widget.Toolbar Toolbar} to act as the {@link ActionBar} for this 2362 * Activity window. 2363 * 2364 * <p>When set to a non-null value the {@link #getActionBar()} method will return 2365 * an {@link ActionBar} object that can be used to control the given toolbar as if it were 2366 * a traditional window decor action bar. The toolbar's menu will be populated with the 2367 * Activity's options menu and the navigation button will be wired through the standard 2368 * {@link android.R.id#home home} menu select action.</p> 2369 * 2370 * <p>In order to use a Toolbar within the Activity's window content the application 2371 * must not request the window feature {@link Window#FEATURE_ACTION_BAR FEATURE_ACTION_BAR}.</p> 2372 * 2373 * @param toolbar Toolbar to set as the Activity's action bar, or {@code null} to clear it 2374 */ 2375 public void setActionBar(@Nullable Toolbar toolbar) { 2376 final ActionBar ab = getActionBar(); 2377 if (ab instanceof WindowDecorActionBar) { 2378 throw new IllegalStateException("This Activity already has an action bar supplied " + 2379 "by the window decor. Do not request Window.FEATURE_ACTION_BAR and set " + 2380 "android:windowActionBar to false in your theme to use a Toolbar instead."); 2381 } 2382 2383 // If we reach here then we're setting a new action bar 2384 // First clear out the MenuInflater to make sure that it is valid for the new Action Bar 2385 mMenuInflater = null; 2386 2387 // If we have an action bar currently, destroy it 2388 if (ab != null) { 2389 ab.onDestroy(); 2390 } 2391 2392 if (toolbar != null) { 2393 final ToolbarActionBar tbab = new ToolbarActionBar(toolbar, getTitle(), this); 2394 mActionBar = tbab; 2395 mWindow.setCallback(tbab.getWrappedWindowCallback()); 2396 } else { 2397 mActionBar = null; 2398 // Re-set the original window callback since we may have already set a Toolbar wrapper 2399 mWindow.setCallback(this); 2400 } 2401 2402 invalidateOptionsMenu(); 2403 } 2404 2405 /** 2406 * Creates a new ActionBar, locates the inflated ActionBarView, 2407 * initializes the ActionBar with the view, and sets mActionBar. 2408 */ 2409 private void initWindowDecorActionBar() { 2410 Window window = getWindow(); 2411 2412 // Initializing the window decor can change window feature flags. 2413 // Make sure that we have the correct set before performing the test below. 2414 window.getDecorView(); 2415 2416 if (isChild() || !window.hasFeature(Window.FEATURE_ACTION_BAR) || mActionBar != null) { 2417 return; 2418 } 2419 2420 mActionBar = new WindowDecorActionBar(this); 2421 mActionBar.setDefaultDisplayHomeAsUpEnabled(mEnableDefaultActionBarUp); 2422 2423 mWindow.setDefaultIcon(mActivityInfo.getIconResource()); 2424 mWindow.setDefaultLogo(mActivityInfo.getLogoResource()); 2425 } 2426 2427 /** 2428 * Set the activity content from a layout resource. The resource will be 2429 * inflated, adding all top-level views to the activity. 2430 * 2431 * @param layoutResID Resource ID to be inflated. 2432 * 2433 * @see #setContentView(android.view.View) 2434 * @see #setContentView(android.view.View, android.view.ViewGroup.LayoutParams) 2435 */ 2436 public void setContentView(@LayoutRes int layoutResID) { 2437 getWindow().setContentView(layoutResID); 2438 initWindowDecorActionBar(); 2439 } 2440 2441 /** 2442 * Set the activity content to an explicit view. This view is placed 2443 * directly into the activity's view hierarchy. It can itself be a complex 2444 * view hierarchy. When calling this method, the layout parameters of the 2445 * specified view are ignored. Both the width and the height of the view are 2446 * set by default to {@link ViewGroup.LayoutParams#MATCH_PARENT}. To use 2447 * your own layout parameters, invoke 2448 * {@link #setContentView(android.view.View, android.view.ViewGroup.LayoutParams)} 2449 * instead. 2450 * 2451 * @param view The desired content to display. 2452 * 2453 * @see #setContentView(int) 2454 * @see #setContentView(android.view.View, android.view.ViewGroup.LayoutParams) 2455 */ 2456 public void setContentView(View view) { 2457 getWindow().setContentView(view); 2458 initWindowDecorActionBar(); 2459 } 2460 2461 /** 2462 * Set the activity content to an explicit view. This view is placed 2463 * directly into the activity's view hierarchy. It can itself be a complex 2464 * view hierarchy. 2465 * 2466 * @param view The desired content to display. 2467 * @param params Layout parameters for the view. 2468 * 2469 * @see #setContentView(android.view.View) 2470 * @see #setContentView(int) 2471 */ 2472 public void setContentView(View view, ViewGroup.LayoutParams params) { 2473 getWindow().setContentView(view, params); 2474 initWindowDecorActionBar(); 2475 } 2476 2477 /** 2478 * Add an additional content view to the activity. Added after any existing 2479 * ones in the activity -- existing views are NOT removed. 2480 * 2481 * @param view The desired content to display. 2482 * @param params Layout parameters for the view. 2483 */ 2484 public void addContentView(View view, ViewGroup.LayoutParams params) { 2485 getWindow().addContentView(view, params); 2486 initWindowDecorActionBar(); 2487 } 2488 2489 /** 2490 * Retrieve the {@link TransitionManager} responsible for default transitions in this window. 2491 * Requires {@link Window#FEATURE_CONTENT_TRANSITIONS}. 2492 * 2493 * <p>This method will return non-null after content has been initialized (e.g. by using 2494 * {@link #setContentView}) if {@link Window#FEATURE_CONTENT_TRANSITIONS} has been granted.</p> 2495 * 2496 * @return This window's content TransitionManager or null if none is set. 2497 */ 2498 public TransitionManager getContentTransitionManager() { 2499 return getWindow().getTransitionManager(); 2500 } 2501 2502 /** 2503 * Set the {@link TransitionManager} to use for default transitions in this window. 2504 * Requires {@link Window#FEATURE_CONTENT_TRANSITIONS}. 2505 * 2506 * @param tm The TransitionManager to use for scene changes. 2507 */ 2508 public void setContentTransitionManager(TransitionManager tm) { 2509 getWindow().setTransitionManager(tm); 2510 } 2511 2512 /** 2513 * Retrieve the {@link Scene} representing this window's current content. 2514 * Requires {@link Window#FEATURE_CONTENT_TRANSITIONS}. 2515 * 2516 * <p>This method will return null if the current content is not represented by a Scene.</p> 2517 * 2518 * @return Current Scene being shown or null 2519 */ 2520 public Scene getContentScene() { 2521 return getWindow().getContentScene(); 2522 } 2523 2524 /** 2525 * Sets whether this activity is finished when touched outside its window's 2526 * bounds. 2527 */ 2528 public void setFinishOnTouchOutside(boolean finish) { 2529 mWindow.setCloseOnTouchOutside(finish); 2530 } 2531 2532 /** @hide */ 2533 @IntDef({ 2534 DEFAULT_KEYS_DISABLE, 2535 DEFAULT_KEYS_DIALER, 2536 DEFAULT_KEYS_SHORTCUT, 2537 DEFAULT_KEYS_SEARCH_LOCAL, 2538 DEFAULT_KEYS_SEARCH_GLOBAL}) 2539 @Retention(RetentionPolicy.SOURCE) 2540 @interface DefaultKeyMode {} 2541 2542 /** 2543 * Use with {@link #setDefaultKeyMode} to turn off default handling of 2544 * keys. 2545 * 2546 * @see #setDefaultKeyMode 2547 */ 2548 static public final int DEFAULT_KEYS_DISABLE = 0; 2549 /** 2550 * Use with {@link #setDefaultKeyMode} to launch the dialer during default 2551 * key handling. 2552 * 2553 * @see #setDefaultKeyMode 2554 */ 2555 static public final int DEFAULT_KEYS_DIALER = 1; 2556 /** 2557 * Use with {@link #setDefaultKeyMode} to execute a menu shortcut in 2558 * default key handling. 2559 * 2560 * <p>That is, the user does not need to hold down the menu key to execute menu shortcuts. 2561 * 2562 * @see #setDefaultKeyMode 2563 */ 2564 static public final int DEFAULT_KEYS_SHORTCUT = 2; 2565 /** 2566 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes 2567 * will start an application-defined search. (If the application or activity does not 2568 * actually define a search, the the keys will be ignored.) 2569 * 2570 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details. 2571 * 2572 * @see #setDefaultKeyMode 2573 */ 2574 static public final int DEFAULT_KEYS_SEARCH_LOCAL = 3; 2575 2576 /** 2577 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes 2578 * will start a global search (typically web search, but some platforms may define alternate 2579 * methods for global search) 2580 * 2581 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details. 2582 * 2583 * @see #setDefaultKeyMode 2584 */ 2585 static public final int DEFAULT_KEYS_SEARCH_GLOBAL = 4; 2586 2587 /** 2588 * Select the default key handling for this activity. This controls what 2589 * will happen to key events that are not otherwise handled. The default 2590 * mode ({@link #DEFAULT_KEYS_DISABLE}) will simply drop them on the 2591 * floor. Other modes allow you to launch the dialer 2592 * ({@link #DEFAULT_KEYS_DIALER}), execute a shortcut in your options 2593 * menu without requiring the menu key be held down 2594 * ({@link #DEFAULT_KEYS_SHORTCUT}), or launch a search ({@link #DEFAULT_KEYS_SEARCH_LOCAL} 2595 * and {@link #DEFAULT_KEYS_SEARCH_GLOBAL}). 2596 * 2597 * <p>Note that the mode selected here does not impact the default 2598 * handling of system keys, such as the "back" and "menu" keys, and your 2599 * activity and its views always get a first chance to receive and handle 2600 * all application keys. 2601 * 2602 * @param mode The desired default key mode constant. 2603 * 2604 * @see #DEFAULT_KEYS_DISABLE 2605 * @see #DEFAULT_KEYS_DIALER 2606 * @see #DEFAULT_KEYS_SHORTCUT 2607 * @see #DEFAULT_KEYS_SEARCH_LOCAL 2608 * @see #DEFAULT_KEYS_SEARCH_GLOBAL 2609 * @see #onKeyDown 2610 */ 2611 public final void setDefaultKeyMode(@DefaultKeyMode int mode) { 2612 mDefaultKeyMode = mode; 2613 2614 // Some modes use a SpannableStringBuilder to track & dispatch input events 2615 // This list must remain in sync with the switch in onKeyDown() 2616 switch (mode) { 2617 case DEFAULT_KEYS_DISABLE: 2618 case DEFAULT_KEYS_SHORTCUT: 2619 mDefaultKeySsb = null; // not used in these modes 2620 break; 2621 case DEFAULT_KEYS_DIALER: 2622 case DEFAULT_KEYS_SEARCH_LOCAL: 2623 case DEFAULT_KEYS_SEARCH_GLOBAL: 2624 mDefaultKeySsb = new SpannableStringBuilder(); 2625 Selection.setSelection(mDefaultKeySsb,0); 2626 break; 2627 default: 2628 throw new IllegalArgumentException(); 2629 } 2630 } 2631 2632 /** 2633 * Called when a key was pressed down and not handled by any of the views 2634 * inside of the activity. So, for example, key presses while the cursor 2635 * is inside a TextView will not trigger the event (unless it is a navigation 2636 * to another object) because TextView handles its own key presses. 2637 * 2638 * <p>If the focused view didn't want this event, this method is called. 2639 * 2640 * <p>The default implementation takes care of {@link KeyEvent#KEYCODE_BACK} 2641 * by calling {@link #onBackPressed()}, though the behavior varies based 2642 * on the application compatibility mode: for 2643 * {@link android.os.Build.VERSION_CODES#ECLAIR} or later applications, 2644 * it will set up the dispatch to call {@link #onKeyUp} where the action 2645 * will be performed; for earlier applications, it will perform the 2646 * action immediately in on-down, as those versions of the platform 2647 * behaved. 2648 * 2649 * <p>Other additional default key handling may be performed 2650 * if configured with {@link #setDefaultKeyMode}. 2651 * 2652 * @return Return <code>true</code> to prevent this event from being propagated 2653 * further, or <code>false</code> to indicate that you have not handled 2654 * this event and it should continue to be propagated. 2655 * @see #onKeyUp 2656 * @see android.view.KeyEvent 2657 */ 2658 public boolean onKeyDown(int keyCode, KeyEvent event) { 2659 if (keyCode == KeyEvent.KEYCODE_BACK) { 2660 if (getApplicationInfo().targetSdkVersion 2661 >= Build.VERSION_CODES.ECLAIR) { 2662 event.startTracking(); 2663 } else { 2664 onBackPressed(); 2665 } 2666 return true; 2667 } 2668 2669 if (mDefaultKeyMode == DEFAULT_KEYS_DISABLE) { 2670 return false; 2671 } else if (mDefaultKeyMode == DEFAULT_KEYS_SHORTCUT) { 2672 Window w = getWindow(); 2673 if (w.hasFeature(Window.FEATURE_OPTIONS_PANEL) && 2674 w.performPanelShortcut(Window.FEATURE_OPTIONS_PANEL, keyCode, event, 2675 Menu.FLAG_ALWAYS_PERFORM_CLOSE)) { 2676 return true; 2677 } 2678 return false; 2679 } else { 2680 // Common code for DEFAULT_KEYS_DIALER & DEFAULT_KEYS_SEARCH_* 2681 boolean clearSpannable = false; 2682 boolean handled; 2683 if ((event.getRepeatCount() != 0) || event.isSystem()) { 2684 clearSpannable = true; 2685 handled = false; 2686 } else { 2687 handled = TextKeyListener.getInstance().onKeyDown( 2688 null, mDefaultKeySsb, keyCode, event); 2689 if (handled && mDefaultKeySsb.length() > 0) { 2690 // something useable has been typed - dispatch it now. 2691 2692 final String str = mDefaultKeySsb.toString(); 2693 clearSpannable = true; 2694 2695 switch (mDefaultKeyMode) { 2696 case DEFAULT_KEYS_DIALER: 2697 Intent intent = new Intent(Intent.ACTION_DIAL, Uri.parse("tel:" + str)); 2698 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK); 2699 startActivity(intent); 2700 break; 2701 case DEFAULT_KEYS_SEARCH_LOCAL: 2702 startSearch(str, false, null, false); 2703 break; 2704 case DEFAULT_KEYS_SEARCH_GLOBAL: 2705 startSearch(str, false, null, true); 2706 break; 2707 } 2708 } 2709 } 2710 if (clearSpannable) { 2711 mDefaultKeySsb.clear(); 2712 mDefaultKeySsb.clearSpans(); 2713 Selection.setSelection(mDefaultKeySsb,0); 2714 } 2715 return handled; 2716 } 2717 } 2718 2719 /** 2720 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 2721 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 2722 * the event). 2723 */ 2724 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 2725 return false; 2726 } 2727 2728 /** 2729 * Called when a key was released and not handled by any of the views 2730 * inside of the activity. So, for example, key presses while the cursor 2731 * is inside a TextView will not trigger the event (unless it is a navigation 2732 * to another object) because TextView handles its own key presses. 2733 * 2734 * <p>The default implementation handles KEYCODE_BACK to stop the activity 2735 * and go back. 2736 * 2737 * @return Return <code>true</code> to prevent this event from being propagated 2738 * further, or <code>false</code> to indicate that you have not handled 2739 * this event and it should continue to be propagated. 2740 * @see #onKeyDown 2741 * @see KeyEvent 2742 */ 2743 public boolean onKeyUp(int keyCode, KeyEvent event) { 2744 if (getApplicationInfo().targetSdkVersion 2745 >= Build.VERSION_CODES.ECLAIR) { 2746 if (keyCode == KeyEvent.KEYCODE_BACK && event.isTracking() 2747 && !event.isCanceled()) { 2748 onBackPressed(); 2749 return true; 2750 } 2751 } 2752 return false; 2753 } 2754 2755 /** 2756 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 2757 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 2758 * the event). 2759 */ 2760 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 2761 return false; 2762 } 2763 2764 /** 2765 * Called when the activity has detected the user's press of the back 2766 * key. The default implementation simply finishes the current activity, 2767 * but you can override this to do whatever you want. 2768 */ 2769 public void onBackPressed() { 2770 if (mActionBar != null && mActionBar.collapseActionView()) { 2771 return; 2772 } 2773 2774 if (!mFragments.getFragmentManager().popBackStackImmediate()) { 2775 finishAfterTransition(); 2776 } 2777 } 2778 2779 /** 2780 * Called when a key shortcut event is not handled by any of the views in the Activity. 2781 * Override this method to implement global key shortcuts for the Activity. 2782 * Key shortcuts can also be implemented by setting the 2783 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items. 2784 * 2785 * @param keyCode The value in event.getKeyCode(). 2786 * @param event Description of the key event. 2787 * @return True if the key shortcut was handled. 2788 */ 2789 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 2790 // Let the Action Bar have a chance at handling the shortcut. 2791 ActionBar actionBar = getActionBar(); 2792 return (actionBar != null && actionBar.onKeyShortcut(keyCode, event)); 2793 } 2794 2795 /** 2796 * Called when a touch screen event was not handled by any of the views 2797 * under it. This is most useful to process touch events that happen 2798 * outside of your window bounds, where there is no view to receive it. 2799 * 2800 * @param event The touch screen event being processed. 2801 * 2802 * @return Return true if you have consumed the event, false if you haven't. 2803 * The default implementation always returns false. 2804 */ 2805 public boolean onTouchEvent(MotionEvent event) { 2806 if (mWindow.shouldCloseOnTouch(this, event)) { 2807 finish(); 2808 return true; 2809 } 2810 2811 return false; 2812 } 2813 2814 /** 2815 * Called when the trackball was moved and not handled by any of the 2816 * views inside of the activity. So, for example, if the trackball moves 2817 * while focus is on a button, you will receive a call here because 2818 * buttons do not normally do anything with trackball events. The call 2819 * here happens <em>before</em> trackball movements are converted to 2820 * DPAD key events, which then get sent back to the view hierarchy, and 2821 * will be processed at the point for things like focus navigation. 2822 * 2823 * @param event The trackball event being processed. 2824 * 2825 * @return Return true if you have consumed the event, false if you haven't. 2826 * The default implementation always returns false. 2827 */ 2828 public boolean onTrackballEvent(MotionEvent event) { 2829 return false; 2830 } 2831 2832 /** 2833 * Called when a generic motion event was not handled by any of the 2834 * views inside of the activity. 2835 * <p> 2836 * Generic motion events describe joystick movements, mouse hovers, track pad 2837 * touches, scroll wheel movements and other input events. The 2838 * {@link MotionEvent#getSource() source} of the motion event specifies 2839 * the class of input that was received. Implementations of this method 2840 * must examine the bits in the source before processing the event. 2841 * The following code example shows how this is done. 2842 * </p><p> 2843 * Generic motion events with source class 2844 * {@link android.view.InputDevice#SOURCE_CLASS_POINTER} 2845 * are delivered to the view under the pointer. All other generic motion events are 2846 * delivered to the focused view. 2847 * </p><p> 2848 * See {@link View#onGenericMotionEvent(MotionEvent)} for an example of how to 2849 * handle this event. 2850 * </p> 2851 * 2852 * @param event The generic motion event being processed. 2853 * 2854 * @return Return true if you have consumed the event, false if you haven't. 2855 * The default implementation always returns false. 2856 */ 2857 public boolean onGenericMotionEvent(MotionEvent event) { 2858 return false; 2859 } 2860 2861 /** 2862 * Called whenever a key, touch, or trackball event is dispatched to the 2863 * activity. Implement this method if you wish to know that the user has 2864 * interacted with the device in some way while your activity is running. 2865 * This callback and {@link #onUserLeaveHint} are intended to help 2866 * activities manage status bar notifications intelligently; specifically, 2867 * for helping activities determine the proper time to cancel a notfication. 2868 * 2869 * <p>All calls to your activity's {@link #onUserLeaveHint} callback will 2870 * be accompanied by calls to {@link #onUserInteraction}. This 2871 * ensures that your activity will be told of relevant user activity such 2872 * as pulling down the notification pane and touching an item there. 2873 * 2874 * <p>Note that this callback will be invoked for the touch down action 2875 * that begins a touch gesture, but may not be invoked for the touch-moved 2876 * and touch-up actions that follow. 2877 * 2878 * @see #onUserLeaveHint() 2879 */ 2880 public void onUserInteraction() { 2881 } 2882 2883 public void onWindowAttributesChanged(WindowManager.LayoutParams params) { 2884 // Update window manager if: we have a view, that view is 2885 // attached to its parent (which will be a RootView), and 2886 // this activity is not embedded. 2887 if (mParent == null) { 2888 View decor = mDecor; 2889 if (decor != null && decor.getParent() != null) { 2890 getWindowManager().updateViewLayout(decor, params); 2891 } 2892 } 2893 } 2894 2895 public void onContentChanged() { 2896 } 2897 2898 /** 2899 * Called when the current {@link Window} of the activity gains or loses 2900 * focus. This is the best indicator of whether this activity is visible 2901 * to the user. The default implementation clears the key tracking 2902 * state, so should always be called. 2903 * 2904 * <p>Note that this provides information about global focus state, which 2905 * is managed independently of activity lifecycles. As such, while focus 2906 * changes will generally have some relation to lifecycle changes (an 2907 * activity that is stopped will not generally get window focus), you 2908 * should not rely on any particular order between the callbacks here and 2909 * those in the other lifecycle methods such as {@link #onResume}. 2910 * 2911 * <p>As a general rule, however, a resumed activity will have window 2912 * focus... unless it has displayed other dialogs or popups that take 2913 * input focus, in which case the activity itself will not have focus 2914 * when the other windows have it. Likewise, the system may display 2915 * system-level windows (such as the status bar notification panel or 2916 * a system alert) which will temporarily take window input focus without 2917 * pausing the foreground activity. 2918 * 2919 * @param hasFocus Whether the window of this activity has focus. 2920 * 2921 * @see #hasWindowFocus() 2922 * @see #onResume 2923 * @see View#onWindowFocusChanged(boolean) 2924 */ 2925 public void onWindowFocusChanged(boolean hasFocus) { 2926 } 2927 2928 /** 2929 * Called when the main window associated with the activity has been 2930 * attached to the window manager. 2931 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()} 2932 * for more information. 2933 * @see View#onAttachedToWindow 2934 */ 2935 public void onAttachedToWindow() { 2936 } 2937 2938 /** 2939 * Called when the main window associated with the activity has been 2940 * detached from the window manager. 2941 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()} 2942 * for more information. 2943 * @see View#onDetachedFromWindow 2944 */ 2945 public void onDetachedFromWindow() { 2946 } 2947 2948 /** 2949 * Returns true if this activity's <em>main</em> window currently has window focus. 2950 * Note that this is not the same as the view itself having focus. 2951 * 2952 * @return True if this activity's main window currently has window focus. 2953 * 2954 * @see #onWindowAttributesChanged(android.view.WindowManager.LayoutParams) 2955 */ 2956 public boolean hasWindowFocus() { 2957 Window w = getWindow(); 2958 if (w != null) { 2959 View d = w.getDecorView(); 2960 if (d != null) { 2961 return d.hasWindowFocus(); 2962 } 2963 } 2964 return false; 2965 } 2966 2967 /** 2968 * Called when the main window associated with the activity has been dismissed. 2969 * @hide 2970 */ 2971 @Override 2972 public void onWindowDismissed(boolean finishTask) { 2973 finish(finishTask ? FINISH_TASK_WITH_ACTIVITY : DONT_FINISH_TASK_WITH_ACTIVITY); 2974 } 2975 2976 2977 /** 2978 * Moves the activity from 2979 * {@link android.app.ActivityManager.StackId#FREEFORM_WORKSPACE_STACK_ID} to 2980 * {@link android.app.ActivityManager.StackId#FULLSCREEN_WORKSPACE_STACK_ID} stack. 2981 * 2982 * @hide 2983 */ 2984 @Override 2985 public void exitFreeformMode() throws RemoteException { 2986 ActivityManagerNative.getDefault().exitFreeformMode(mToken); 2987 } 2988 2989 /** Returns the current stack Id for the window. 2990 * @hide 2991 */ 2992 @Override 2993 public int getWindowStackId() throws RemoteException { 2994 return ActivityManagerNative.getDefault().getActivityStackId(mToken); 2995 } 2996 2997 /** 2998 * Puts the activity in picture-in-picture mode if the activity supports. 2999 * @see android.R.attr#supportsPictureInPicture 3000 * @hide 3001 */ 3002 @Override 3003 public void enterPictureInPictureModeIfPossible() { 3004 if (mActivityInfo.resizeMode == ActivityInfo.RESIZE_MODE_RESIZEABLE_AND_PIPABLE) { 3005 enterPictureInPictureMode(); 3006 } 3007 } 3008 3009 /** 3010 * Called to process key events. You can override this to intercept all 3011 * key events before they are dispatched to the window. Be sure to call 3012 * this implementation for key events that should be handled normally. 3013 * 3014 * @param event The key event. 3015 * 3016 * @return boolean Return true if this event was consumed. 3017 */ 3018 public boolean dispatchKeyEvent(KeyEvent event) { 3019 onUserInteraction(); 3020 3021 // Let action bars open menus in response to the menu key prioritized over 3022 // the window handling it 3023 final int keyCode = event.getKeyCode(); 3024 if (keyCode == KeyEvent.KEYCODE_MENU && 3025 mActionBar != null && mActionBar.onMenuKeyEvent(event)) { 3026 return true; 3027 } else if (event.isCtrlPressed() && 3028 event.getUnicodeChar(event.getMetaState() & ~KeyEvent.META_CTRL_MASK) == '<') { 3029 // Capture the Control-< and send focus to the ActionBar 3030 final int action = event.getAction(); 3031 if (action == KeyEvent.ACTION_DOWN) { 3032 final ActionBar actionBar = getActionBar(); 3033 if (actionBar != null && actionBar.isShowing() && actionBar.requestFocus()) { 3034 mEatKeyUpEvent = true; 3035 return true; 3036 } 3037 } else if (action == KeyEvent.ACTION_UP && mEatKeyUpEvent) { 3038 mEatKeyUpEvent = false; 3039 return true; 3040 } 3041 } 3042 3043 Window win = getWindow(); 3044 if (win.superDispatchKeyEvent(event)) { 3045 return true; 3046 } 3047 View decor = mDecor; 3048 if (decor == null) decor = win.getDecorView(); 3049 return event.dispatch(this, decor != null 3050 ? decor.getKeyDispatcherState() : null, this); 3051 } 3052 3053 /** 3054 * Called to process a key shortcut event. 3055 * You can override this to intercept all key shortcut events before they are 3056 * dispatched to the window. Be sure to call this implementation for key shortcut 3057 * events that should be handled normally. 3058 * 3059 * @param event The key shortcut event. 3060 * @return True if this event was consumed. 3061 */ 3062 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 3063 onUserInteraction(); 3064 if (getWindow().superDispatchKeyShortcutEvent(event)) { 3065 return true; 3066 } 3067 return onKeyShortcut(event.getKeyCode(), event); 3068 } 3069 3070 /** 3071 * Called to process touch screen events. You can override this to 3072 * intercept all touch screen events before they are dispatched to the 3073 * window. Be sure to call this implementation for touch screen events 3074 * that should be handled normally. 3075 * 3076 * @param ev The touch screen event. 3077 * 3078 * @return boolean Return true if this event was consumed. 3079 */ 3080 public boolean dispatchTouchEvent(MotionEvent ev) { 3081 if (ev.getAction() == MotionEvent.ACTION_DOWN) { 3082 onUserInteraction(); 3083 } 3084 if (getWindow().superDispatchTouchEvent(ev)) { 3085 return true; 3086 } 3087 return onTouchEvent(ev); 3088 } 3089 3090 /** 3091 * Called to process trackball events. You can override this to 3092 * intercept all trackball events before they are dispatched to the 3093 * window. Be sure to call this implementation for trackball events 3094 * that should be handled normally. 3095 * 3096 * @param ev The trackball event. 3097 * 3098 * @return boolean Return true if this event was consumed. 3099 */ 3100 public boolean dispatchTrackballEvent(MotionEvent ev) { 3101 onUserInteraction(); 3102 if (getWindow().superDispatchTrackballEvent(ev)) { 3103 return true; 3104 } 3105 return onTrackballEvent(ev); 3106 } 3107 3108 /** 3109 * Called to process generic motion events. You can override this to 3110 * intercept all generic motion events before they are dispatched to the 3111 * window. Be sure to call this implementation for generic motion events 3112 * that should be handled normally. 3113 * 3114 * @param ev The generic motion event. 3115 * 3116 * @return boolean Return true if this event was consumed. 3117 */ 3118 public boolean dispatchGenericMotionEvent(MotionEvent ev) { 3119 onUserInteraction(); 3120 if (getWindow().superDispatchGenericMotionEvent(ev)) { 3121 return true; 3122 } 3123 return onGenericMotionEvent(ev); 3124 } 3125 3126 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 3127 event.setClassName(getClass().getName()); 3128 event.setPackageName(getPackageName()); 3129 3130 LayoutParams params = getWindow().getAttributes(); 3131 boolean isFullScreen = (params.width == LayoutParams.MATCH_PARENT) && 3132 (params.height == LayoutParams.MATCH_PARENT); 3133 event.setFullScreen(isFullScreen); 3134 3135 CharSequence title = getTitle(); 3136 if (!TextUtils.isEmpty(title)) { 3137 event.getText().add(title); 3138 } 3139 3140 return true; 3141 } 3142 3143 /** 3144 * Default implementation of 3145 * {@link android.view.Window.Callback#onCreatePanelView} 3146 * for activities. This 3147 * simply returns null so that all panel sub-windows will have the default 3148 * menu behavior. 3149 */ 3150 @Nullable 3151 public View onCreatePanelView(int featureId) { 3152 return null; 3153 } 3154 3155 /** 3156 * Default implementation of 3157 * {@link android.view.Window.Callback#onCreatePanelMenu} 3158 * for activities. This calls through to the new 3159 * {@link #onCreateOptionsMenu} method for the 3160 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel, 3161 * so that subclasses of Activity don't need to deal with feature codes. 3162 */ 3163 public boolean onCreatePanelMenu(int featureId, Menu menu) { 3164 if (featureId == Window.FEATURE_OPTIONS_PANEL) { 3165 boolean show = onCreateOptionsMenu(menu); 3166 show |= mFragments.dispatchCreateOptionsMenu(menu, getMenuInflater()); 3167 return show; 3168 } 3169 return false; 3170 } 3171 3172 /** 3173 * Default implementation of 3174 * {@link android.view.Window.Callback#onPreparePanel} 3175 * for activities. This 3176 * calls through to the new {@link #onPrepareOptionsMenu} method for the 3177 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} 3178 * panel, so that subclasses of 3179 * Activity don't need to deal with feature codes. 3180 */ 3181 public boolean onPreparePanel(int featureId, View view, Menu menu) { 3182 if (featureId == Window.FEATURE_OPTIONS_PANEL && menu != null) { 3183 boolean goforit = onPrepareOptionsMenu(menu); 3184 goforit |= mFragments.dispatchPrepareOptionsMenu(menu); 3185 return goforit; 3186 } 3187 return true; 3188 } 3189 3190 /** 3191 * {@inheritDoc} 3192 * 3193 * @return The default implementation returns true. 3194 */ 3195 public boolean onMenuOpened(int featureId, Menu menu) { 3196 if (featureId == Window.FEATURE_ACTION_BAR) { 3197 initWindowDecorActionBar(); 3198 if (mActionBar != null) { 3199 mActionBar.dispatchMenuVisibilityChanged(true); 3200 } else { 3201 Log.e(TAG, "Tried to open action bar menu with no action bar"); 3202 } 3203 } 3204 return true; 3205 } 3206 3207 /** 3208 * Default implementation of 3209 * {@link android.view.Window.Callback#onMenuItemSelected} 3210 * for activities. This calls through to the new 3211 * {@link #onOptionsItemSelected} method for the 3212 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} 3213 * panel, so that subclasses of 3214 * Activity don't need to deal with feature codes. 3215 */ 3216 public boolean onMenuItemSelected(int featureId, MenuItem item) { 3217 CharSequence titleCondensed = item.getTitleCondensed(); 3218 3219 switch (featureId) { 3220 case Window.FEATURE_OPTIONS_PANEL: 3221 // Put event logging here so it gets called even if subclass 3222 // doesn't call through to superclass's implmeentation of each 3223 // of these methods below 3224 if(titleCondensed != null) { 3225 EventLog.writeEvent(50000, 0, titleCondensed.toString()); 3226 } 3227 if (onOptionsItemSelected(item)) { 3228 return true; 3229 } 3230 if (mFragments.dispatchOptionsItemSelected(item)) { 3231 return true; 3232 } 3233 if (item.getItemId() == android.R.id.home && mActionBar != null && 3234 (mActionBar.getDisplayOptions() & ActionBar.DISPLAY_HOME_AS_UP) != 0) { 3235 if (mParent == null) { 3236 return onNavigateUp(); 3237 } else { 3238 return mParent.onNavigateUpFromChild(this); 3239 } 3240 } 3241 return false; 3242 3243 case Window.FEATURE_CONTEXT_MENU: 3244 if(titleCondensed != null) { 3245 EventLog.writeEvent(50000, 1, titleCondensed.toString()); 3246 } 3247 if (onContextItemSelected(item)) { 3248 return true; 3249 } 3250 return mFragments.dispatchContextItemSelected(item); 3251 3252 default: 3253 return false; 3254 } 3255 } 3256 3257 /** 3258 * Default implementation of 3259 * {@link android.view.Window.Callback#onPanelClosed(int, Menu)} for 3260 * activities. This calls through to {@link #onOptionsMenuClosed(Menu)} 3261 * method for the {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel, 3262 * so that subclasses of Activity don't need to deal with feature codes. 3263 * For context menus ({@link Window#FEATURE_CONTEXT_MENU}), the 3264 * {@link #onContextMenuClosed(Menu)} will be called. 3265 */ 3266 public void onPanelClosed(int featureId, Menu menu) { 3267 switch (featureId) { 3268 case Window.FEATURE_OPTIONS_PANEL: 3269 mFragments.dispatchOptionsMenuClosed(menu); 3270 onOptionsMenuClosed(menu); 3271 break; 3272 3273 case Window.FEATURE_CONTEXT_MENU: 3274 onContextMenuClosed(menu); 3275 break; 3276 3277 case Window.FEATURE_ACTION_BAR: 3278 initWindowDecorActionBar(); 3279 mActionBar.dispatchMenuVisibilityChanged(false); 3280 break; 3281 } 3282 } 3283 3284 /** 3285 * Declare that the options menu has changed, so should be recreated. 3286 * The {@link #onCreateOptionsMenu(Menu)} method will be called the next 3287 * time it needs to be displayed. 3288 */ 3289 public void invalidateOptionsMenu() { 3290 if (mWindow.hasFeature(Window.FEATURE_OPTIONS_PANEL) && 3291 (mActionBar == null || !mActionBar.invalidateOptionsMenu())) { 3292 mWindow.invalidatePanelMenu(Window.FEATURE_OPTIONS_PANEL); 3293 } 3294 } 3295 3296 /** 3297 * Initialize the contents of the Activity's standard options menu. You 3298 * should place your menu items in to <var>menu</var>. 3299 * 3300 * <p>This is only called once, the first time the options menu is 3301 * displayed. To update the menu every time it is displayed, see 3302 * {@link #onPrepareOptionsMenu}. 3303 * 3304 * <p>The default implementation populates the menu with standard system 3305 * menu items. These are placed in the {@link Menu#CATEGORY_SYSTEM} group so that 3306 * they will be correctly ordered with application-defined menu items. 3307 * Deriving classes should always call through to the base implementation. 3308 * 3309 * <p>You can safely hold on to <var>menu</var> (and any items created 3310 * from it), making modifications to it as desired, until the next 3311 * time onCreateOptionsMenu() is called. 3312 * 3313 * <p>When you add items to the menu, you can implement the Activity's 3314 * {@link #onOptionsItemSelected} method to handle them there. 3315 * 3316 * @param menu The options menu in which you place your items. 3317 * 3318 * @return You must return true for the menu to be displayed; 3319 * if you return false it will not be shown. 3320 * 3321 * @see #onPrepareOptionsMenu 3322 * @see #onOptionsItemSelected 3323 */ 3324 public boolean onCreateOptionsMenu(Menu menu) { 3325 if (mParent != null) { 3326 return mParent.onCreateOptionsMenu(menu); 3327 } 3328 return true; 3329 } 3330 3331 /** 3332 * Prepare the Screen's standard options menu to be displayed. This is 3333 * called right before the menu is shown, every time it is shown. You can 3334 * use this method to efficiently enable/disable items or otherwise 3335 * dynamically modify the contents. 3336 * 3337 * <p>The default implementation updates the system menu items based on the 3338 * activity's state. Deriving classes should always call through to the 3339 * base class implementation. 3340 * 3341 * @param menu The options menu as last shown or first initialized by 3342 * onCreateOptionsMenu(). 3343 * 3344 * @return You must return true for the menu to be displayed; 3345 * if you return false it will not be shown. 3346 * 3347 * @see #onCreateOptionsMenu 3348 */ 3349 public boolean onPrepareOptionsMenu(Menu menu) { 3350 if (mParent != null) { 3351 return mParent.onPrepareOptionsMenu(menu); 3352 } 3353 return true; 3354 } 3355 3356 /** 3357 * This hook is called whenever an item in your options menu is selected. 3358 * The default implementation simply returns false to have the normal 3359 * processing happen (calling the item's Runnable or sending a message to 3360 * its Handler as appropriate). You can use this method for any items 3361 * for which you would like to do processing without those other 3362 * facilities. 3363 * 3364 * <p>Derived classes should call through to the base class for it to 3365 * perform the default menu handling.</p> 3366 * 3367 * @param item The menu item that was selected. 3368 * 3369 * @return boolean Return false to allow normal menu processing to 3370 * proceed, true to consume it here. 3371 * 3372 * @see #onCreateOptionsMenu 3373 */ 3374 public boolean onOptionsItemSelected(MenuItem item) { 3375 if (mParent != null) { 3376 return mParent.onOptionsItemSelected(item); 3377 } 3378 return false; 3379 } 3380 3381 /** 3382 * This method is called whenever the user chooses to navigate Up within your application's 3383 * activity hierarchy from the action bar. 3384 * 3385 * <p>If the attribute {@link android.R.attr#parentActivityName parentActivityName} 3386 * was specified in the manifest for this activity or an activity-alias to it, 3387 * default Up navigation will be handled automatically. If any activity 3388 * along the parent chain requires extra Intent arguments, the Activity subclass 3389 * should override the method {@link #onPrepareNavigateUpTaskStack(TaskStackBuilder)} 3390 * to supply those arguments.</p> 3391 * 3392 * <p>See <a href="{@docRoot}guide/components/tasks-and-back-stack.html">Tasks and Back Stack</a> 3393 * from the developer guide and <a href="{@docRoot}design/patterns/navigation.html">Navigation</a> 3394 * from the design guide for more information about navigating within your app.</p> 3395 * 3396 * <p>See the {@link TaskStackBuilder} class and the Activity methods 3397 * {@link #getParentActivityIntent()}, {@link #shouldUpRecreateTask(Intent)}, and 3398 * {@link #navigateUpTo(Intent)} for help implementing custom Up navigation. 3399 * The AppNavigation sample application in the Android SDK is also available for reference.</p> 3400 * 3401 * @return true if Up navigation completed successfully and this Activity was finished, 3402 * false otherwise. 3403 */ 3404 public boolean onNavigateUp() { 3405 // Automatically handle hierarchical Up navigation if the proper 3406 // metadata is available. 3407 Intent upIntent = getParentActivityIntent(); 3408 if (upIntent != null) { 3409 if (mActivityInfo.taskAffinity == null) { 3410 // Activities with a null affinity are special; they really shouldn't 3411 // specify a parent activity intent in the first place. Just finish 3412 // the current activity and call it a day. 3413 finish(); 3414 } else if (shouldUpRecreateTask(upIntent)) { 3415 TaskStackBuilder b = TaskStackBuilder.create(this); 3416 onCreateNavigateUpTaskStack(b); 3417 onPrepareNavigateUpTaskStack(b); 3418 b.startActivities(); 3419 3420 // We can't finishAffinity if we have a result. 3421 // Fall back and simply finish the current activity instead. 3422 if (mResultCode != RESULT_CANCELED || mResultData != null) { 3423 // Tell the developer what's going on to avoid hair-pulling. 3424 Log.i(TAG, "onNavigateUp only finishing topmost activity to return a result"); 3425 finish(); 3426 } else { 3427 finishAffinity(); 3428 } 3429 } else { 3430 navigateUpTo(upIntent); 3431 } 3432 return true; 3433 } 3434 return false; 3435 } 3436 3437 /** 3438 * This is called when a child activity of this one attempts to navigate up. 3439 * The default implementation simply calls onNavigateUp() on this activity (the parent). 3440 * 3441 * @param child The activity making the call. 3442 */ 3443 public boolean onNavigateUpFromChild(Activity child) { 3444 return onNavigateUp(); 3445 } 3446 3447 /** 3448 * Define the synthetic task stack that will be generated during Up navigation from 3449 * a different task. 3450 * 3451 * <p>The default implementation of this method adds the parent chain of this activity 3452 * as specified in the manifest to the supplied {@link TaskStackBuilder}. Applications 3453 * may choose to override this method to construct the desired task stack in a different 3454 * way.</p> 3455 * 3456 * <p>This method will be invoked by the default implementation of {@link #onNavigateUp()} 3457 * if {@link #shouldUpRecreateTask(Intent)} returns true when supplied with the intent 3458 * returned by {@link #getParentActivityIntent()}.</p> 3459 * 3460 * <p>Applications that wish to supply extra Intent parameters to the parent stack defined 3461 * by the manifest should override {@link #onPrepareNavigateUpTaskStack(TaskStackBuilder)}.</p> 3462 * 3463 * @param builder An empty TaskStackBuilder - the application should add intents representing 3464 * the desired task stack 3465 */ 3466 public void onCreateNavigateUpTaskStack(TaskStackBuilder builder) { 3467 builder.addParentStack(this); 3468 } 3469 3470 /** 3471 * Prepare the synthetic task stack that will be generated during Up navigation 3472 * from a different task. 3473 * 3474 * <p>This method receives the {@link TaskStackBuilder} with the constructed series of 3475 * Intents as generated by {@link #onCreateNavigateUpTaskStack(TaskStackBuilder)}. 3476 * If any extra data should be added to these intents before launching the new task, 3477 * the application should override this method and add that data here.</p> 3478 * 3479 * @param builder A TaskStackBuilder that has been populated with Intents by 3480 * onCreateNavigateUpTaskStack. 3481 */ 3482 public void onPrepareNavigateUpTaskStack(TaskStackBuilder builder) { 3483 } 3484 3485 /** 3486 * This hook is called whenever the options menu is being closed (either by the user canceling 3487 * the menu with the back/menu button, or when an item is selected). 3488 * 3489 * @param menu The options menu as last shown or first initialized by 3490 * onCreateOptionsMenu(). 3491 */ 3492 public void onOptionsMenuClosed(Menu menu) { 3493 if (mParent != null) { 3494 mParent.onOptionsMenuClosed(menu); 3495 } 3496 } 3497 3498 /** 3499 * Programmatically opens the options menu. If the options menu is already 3500 * open, this method does nothing. 3501 */ 3502 public void openOptionsMenu() { 3503 if (mWindow.hasFeature(Window.FEATURE_OPTIONS_PANEL) && 3504 (mActionBar == null || !mActionBar.openOptionsMenu())) { 3505 mWindow.openPanel(Window.FEATURE_OPTIONS_PANEL, null); 3506 } 3507 } 3508 3509 /** 3510 * Progammatically closes the options menu. If the options menu is already 3511 * closed, this method does nothing. 3512 */ 3513 public void closeOptionsMenu() { 3514 if (mWindow.hasFeature(Window.FEATURE_OPTIONS_PANEL)) { 3515 mWindow.closePanel(Window.FEATURE_OPTIONS_PANEL); 3516 } 3517 } 3518 3519 /** 3520 * Called when a context menu for the {@code view} is about to be shown. 3521 * Unlike {@link #onCreateOptionsMenu(Menu)}, this will be called every 3522 * time the context menu is about to be shown and should be populated for 3523 * the view (or item inside the view for {@link AdapterView} subclasses, 3524 * this can be found in the {@code menuInfo})). 3525 * <p> 3526 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an 3527 * item has been selected. 3528 * <p> 3529 * It is not safe to hold onto the context menu after this method returns. 3530 * 3531 */ 3532 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { 3533 } 3534 3535 /** 3536 * Registers a context menu to be shown for the given view (multiple views 3537 * can show the context menu). This method will set the 3538 * {@link OnCreateContextMenuListener} on the view to this activity, so 3539 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be 3540 * called when it is time to show the context menu. 3541 * 3542 * @see #unregisterForContextMenu(View) 3543 * @param view The view that should show a context menu. 3544 */ 3545 public void registerForContextMenu(View view) { 3546 view.setOnCreateContextMenuListener(this); 3547 } 3548 3549 /** 3550 * Prevents a context menu to be shown for the given view. This method will remove the 3551 * {@link OnCreateContextMenuListener} on the view. 3552 * 3553 * @see #registerForContextMenu(View) 3554 * @param view The view that should stop showing a context menu. 3555 */ 3556 public void unregisterForContextMenu(View view) { 3557 view.setOnCreateContextMenuListener(null); 3558 } 3559 3560 /** 3561 * Programmatically opens the context menu for a particular {@code view}. 3562 * The {@code view} should have been added via 3563 * {@link #registerForContextMenu(View)}. 3564 * 3565 * @param view The view to show the context menu for. 3566 */ 3567 public void openContextMenu(View view) { 3568 view.showContextMenu(); 3569 } 3570 3571 /** 3572 * Programmatically closes the most recently opened context menu, if showing. 3573 */ 3574 public void closeContextMenu() { 3575 if (mWindow.hasFeature(Window.FEATURE_CONTEXT_MENU)) { 3576 mWindow.closePanel(Window.FEATURE_CONTEXT_MENU); 3577 } 3578 } 3579 3580 /** 3581 * This hook is called whenever an item in a context menu is selected. The 3582 * default implementation simply returns false to have the normal processing 3583 * happen (calling the item's Runnable or sending a message to its Handler 3584 * as appropriate). You can use this method for any items for which you 3585 * would like to do processing without those other facilities. 3586 * <p> 3587 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the 3588 * View that added this menu item. 3589 * <p> 3590 * Derived classes should call through to the base class for it to perform 3591 * the default menu handling. 3592 * 3593 * @param item The context menu item that was selected. 3594 * @return boolean Return false to allow normal context menu processing to 3595 * proceed, true to consume it here. 3596 */ 3597 public boolean onContextItemSelected(MenuItem item) { 3598 if (mParent != null) { 3599 return mParent.onContextItemSelected(item); 3600 } 3601 return false; 3602 } 3603 3604 /** 3605 * This hook is called whenever the context menu is being closed (either by 3606 * the user canceling the menu with the back/menu button, or when an item is 3607 * selected). 3608 * 3609 * @param menu The context menu that is being closed. 3610 */ 3611 public void onContextMenuClosed(Menu menu) { 3612 if (mParent != null) { 3613 mParent.onContextMenuClosed(menu); 3614 } 3615 } 3616 3617 /** 3618 * @deprecated Old no-arguments version of {@link #onCreateDialog(int, Bundle)}. 3619 */ 3620 @Deprecated 3621 protected Dialog onCreateDialog(int id) { 3622 return null; 3623 } 3624 3625 /** 3626 * Callback for creating dialogs that are managed (saved and restored) for you 3627 * by the activity. The default implementation calls through to 3628 * {@link #onCreateDialog(int)} for compatibility. 3629 * 3630 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB} 3631 * or later, consider instead using a {@link DialogFragment} instead.</em> 3632 * 3633 * <p>If you use {@link #showDialog(int)}, the activity will call through to 3634 * this method the first time, and hang onto it thereafter. Any dialog 3635 * that is created by this method will automatically be saved and restored 3636 * for you, including whether it is showing. 3637 * 3638 * <p>If you would like the activity to manage saving and restoring dialogs 3639 * for you, you should override this method and handle any ids that are 3640 * passed to {@link #showDialog}. 3641 * 3642 * <p>If you would like an opportunity to prepare your dialog before it is shown, 3643 * override {@link #onPrepareDialog(int, Dialog, Bundle)}. 3644 * 3645 * @param id The id of the dialog. 3646 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}. 3647 * @return The dialog. If you return null, the dialog will not be created. 3648 * 3649 * @see #onPrepareDialog(int, Dialog, Bundle) 3650 * @see #showDialog(int, Bundle) 3651 * @see #dismissDialog(int) 3652 * @see #removeDialog(int) 3653 * 3654 * @deprecated Use the new {@link DialogFragment} class with 3655 * {@link FragmentManager} instead; this is also 3656 * available on older platforms through the Android compatibility package. 3657 */ 3658 @Nullable 3659 @Deprecated 3660 protected Dialog onCreateDialog(int id, Bundle args) { 3661 return onCreateDialog(id); 3662 } 3663 3664 /** 3665 * @deprecated Old no-arguments version of 3666 * {@link #onPrepareDialog(int, Dialog, Bundle)}. 3667 */ 3668 @Deprecated 3669 protected void onPrepareDialog(int id, Dialog dialog) { 3670 dialog.setOwnerActivity(this); 3671 } 3672 3673 /** 3674 * Provides an opportunity to prepare a managed dialog before it is being 3675 * shown. The default implementation calls through to 3676 * {@link #onPrepareDialog(int, Dialog)} for compatibility. 3677 * 3678 * <p> 3679 * Override this if you need to update a managed dialog based on the state 3680 * of the application each time it is shown. For example, a time picker 3681 * dialog might want to be updated with the current time. You should call 3682 * through to the superclass's implementation. The default implementation 3683 * will set this Activity as the owner activity on the Dialog. 3684 * 3685 * @param id The id of the managed dialog. 3686 * @param dialog The dialog. 3687 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}. 3688 * @see #onCreateDialog(int, Bundle) 3689 * @see #showDialog(int) 3690 * @see #dismissDialog(int) 3691 * @see #removeDialog(int) 3692 * 3693 * @deprecated Use the new {@link DialogFragment} class with 3694 * {@link FragmentManager} instead; this is also 3695 * available on older platforms through the Android compatibility package. 3696 */ 3697 @Deprecated 3698 protected void onPrepareDialog(int id, Dialog dialog, Bundle args) { 3699 onPrepareDialog(id, dialog); 3700 } 3701 3702 /** 3703 * Simple version of {@link #showDialog(int, Bundle)} that does not 3704 * take any arguments. Simply calls {@link #showDialog(int, Bundle)} 3705 * with null arguments. 3706 * 3707 * @deprecated Use the new {@link DialogFragment} class with 3708 * {@link FragmentManager} instead; this is also 3709 * available on older platforms through the Android compatibility package. 3710 */ 3711 @Deprecated 3712 public final void showDialog(int id) { 3713 showDialog(id, null); 3714 } 3715 3716 /** 3717 * Show a dialog managed by this activity. A call to {@link #onCreateDialog(int, Bundle)} 3718 * will be made with the same id the first time this is called for a given 3719 * id. From thereafter, the dialog will be automatically saved and restored. 3720 * 3721 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB} 3722 * or later, consider instead using a {@link DialogFragment} instead.</em> 3723 * 3724 * <p>Each time a dialog is shown, {@link #onPrepareDialog(int, Dialog, Bundle)} will 3725 * be made to provide an opportunity to do any timely preparation. 3726 * 3727 * @param id The id of the managed dialog. 3728 * @param args Arguments to pass through to the dialog. These will be saved 3729 * and restored for you. Note that if the dialog is already created, 3730 * {@link #onCreateDialog(int, Bundle)} will not be called with the new 3731 * arguments but {@link #onPrepareDialog(int, Dialog, Bundle)} will be. 3732 * If you need to rebuild the dialog, call {@link #removeDialog(int)} first. 3733 * @return Returns true if the Dialog was created; false is returned if 3734 * it is not created because {@link #onCreateDialog(int, Bundle)} returns false. 3735 * 3736 * @see Dialog 3737 * @see #onCreateDialog(int, Bundle) 3738 * @see #onPrepareDialog(int, Dialog, Bundle) 3739 * @see #dismissDialog(int) 3740 * @see #removeDialog(int) 3741 * 3742 * @deprecated Use the new {@link DialogFragment} class with 3743 * {@link FragmentManager} instead; this is also 3744 * available on older platforms through the Android compatibility package. 3745 */ 3746 @Deprecated 3747 public final boolean showDialog(int id, Bundle args) { 3748 if (mManagedDialogs == null) { 3749 mManagedDialogs = new SparseArray<ManagedDialog>(); 3750 } 3751 ManagedDialog md = mManagedDialogs.get(id); 3752 if (md == null) { 3753 md = new ManagedDialog(); 3754 md.mDialog = createDialog(id, null, args); 3755 if (md.mDialog == null) { 3756 return false; 3757 } 3758 mManagedDialogs.put(id, md); 3759 } 3760 3761 md.mArgs = args; 3762 onPrepareDialog(id, md.mDialog, args); 3763 md.mDialog.show(); 3764 return true; 3765 } 3766 3767 /** 3768 * Dismiss a dialog that was previously shown via {@link #showDialog(int)}. 3769 * 3770 * @param id The id of the managed dialog. 3771 * 3772 * @throws IllegalArgumentException if the id was not previously shown via 3773 * {@link #showDialog(int)}. 3774 * 3775 * @see #onCreateDialog(int, Bundle) 3776 * @see #onPrepareDialog(int, Dialog, Bundle) 3777 * @see #showDialog(int) 3778 * @see #removeDialog(int) 3779 * 3780 * @deprecated Use the new {@link DialogFragment} class with 3781 * {@link FragmentManager} instead; this is also 3782 * available on older platforms through the Android compatibility package. 3783 */ 3784 @Deprecated 3785 public final void dismissDialog(int id) { 3786 if (mManagedDialogs == null) { 3787 throw missingDialog(id); 3788 } 3789 3790 final ManagedDialog md = mManagedDialogs.get(id); 3791 if (md == null) { 3792 throw missingDialog(id); 3793 } 3794 md.mDialog.dismiss(); 3795 } 3796 3797 /** 3798 * Creates an exception to throw if a user passed in a dialog id that is 3799 * unexpected. 3800 */ 3801 private IllegalArgumentException missingDialog(int id) { 3802 return new IllegalArgumentException("no dialog with id " + id + " was ever " 3803 + "shown via Activity#showDialog"); 3804 } 3805 3806 /** 3807 * Removes any internal references to a dialog managed by this Activity. 3808 * If the dialog is showing, it will dismiss it as part of the clean up. 3809 * 3810 * <p>This can be useful if you know that you will never show a dialog again and 3811 * want to avoid the overhead of saving and restoring it in the future. 3812 * 3813 * <p>As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}, this function 3814 * will not throw an exception if you try to remove an ID that does not 3815 * currently have an associated dialog.</p> 3816 * 3817 * @param id The id of the managed dialog. 3818 * 3819 * @see #onCreateDialog(int, Bundle) 3820 * @see #onPrepareDialog(int, Dialog, Bundle) 3821 * @see #showDialog(int) 3822 * @see #dismissDialog(int) 3823 * 3824 * @deprecated Use the new {@link DialogFragment} class with 3825 * {@link FragmentManager} instead; this is also 3826 * available on older platforms through the Android compatibility package. 3827 */ 3828 @Deprecated 3829 public final void removeDialog(int id) { 3830 if (mManagedDialogs != null) { 3831 final ManagedDialog md = mManagedDialogs.get(id); 3832 if (md != null) { 3833 md.mDialog.dismiss(); 3834 mManagedDialogs.remove(id); 3835 } 3836 } 3837 } 3838 3839 /** 3840 * This hook is called when the user signals the desire to start a search. 3841 * 3842 * <p>You can use this function as a simple way to launch the search UI, in response to a 3843 * menu item, search button, or other widgets within your activity. Unless overidden, 3844 * calling this function is the same as calling 3845 * {@link #startSearch startSearch(null, false, null, false)}, which launches 3846 * search for the current activity as specified in its manifest, see {@link SearchManager}. 3847 * 3848 * <p>You can override this function to force global search, e.g. in response to a dedicated 3849 * search key, or to block search entirely (by simply returning false). 3850 * 3851 * <p>Note: when running in a {@link Configuration#UI_MODE_TYPE_TELEVISION}, the default 3852 * implementation changes to simply return false and you must supply your own custom 3853 * implementation if you want to support search.</p> 3854 * 3855 * @param searchEvent The {@link SearchEvent} that signaled this search. 3856 * @return Returns {@code true} if search launched, and {@code false} if the activity does 3857 * not respond to search. The default implementation always returns {@code true}, except 3858 * when in {@link Configuration#UI_MODE_TYPE_TELEVISION} mode where it returns false. 3859 * 3860 * @see android.app.SearchManager 3861 */ 3862 public boolean onSearchRequested(@Nullable SearchEvent searchEvent) { 3863 mSearchEvent = searchEvent; 3864 boolean result = onSearchRequested(); 3865 mSearchEvent = null; 3866 return result; 3867 } 3868 3869 /** 3870 * @see #onSearchRequested(SearchEvent) 3871 */ 3872 public boolean onSearchRequested() { 3873 if ((getResources().getConfiguration().uiMode&Configuration.UI_MODE_TYPE_MASK) 3874 != Configuration.UI_MODE_TYPE_TELEVISION) { 3875 startSearch(null, false, null, false); 3876 return true; 3877 } else { 3878 return false; 3879 } 3880 } 3881 3882 /** 3883 * During the onSearchRequested() callbacks, this function will return the 3884 * {@link SearchEvent} that triggered the callback, if it exists. 3885 * 3886 * @return SearchEvent The SearchEvent that triggered the {@link 3887 * #onSearchRequested} callback. 3888 */ 3889 public final SearchEvent getSearchEvent() { 3890 return mSearchEvent; 3891 } 3892 3893 /** 3894 * This hook is called to launch the search UI. 3895 * 3896 * <p>It is typically called from onSearchRequested(), either directly from 3897 * Activity.onSearchRequested() or from an overridden version in any given 3898 * Activity. If your goal is simply to activate search, it is preferred to call 3899 * onSearchRequested(), which may have been overridden elsewhere in your Activity. If your goal 3900 * is to inject specific data such as context data, it is preferred to <i>override</i> 3901 * onSearchRequested(), so that any callers to it will benefit from the override. 3902 * 3903 * @param initialQuery Any non-null non-empty string will be inserted as 3904 * pre-entered text in the search query box. 3905 * @param selectInitialQuery If true, the initial query will be preselected, which means that 3906 * any further typing will replace it. This is useful for cases where an entire pre-formed 3907 * query is being inserted. If false, the selection point will be placed at the end of the 3908 * inserted query. This is useful when the inserted query is text that the user entered, 3909 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful 3910 * if initialQuery is a non-empty string.</i> 3911 * @param appSearchData An application can insert application-specific 3912 * context here, in order to improve quality or specificity of its own 3913 * searches. This data will be returned with SEARCH intent(s). Null if 3914 * no extra data is required. 3915 * @param globalSearch If false, this will only launch the search that has been specifically 3916 * defined by the application (which is usually defined as a local search). If no default 3917 * search is defined in the current application or activity, global search will be launched. 3918 * If true, this will always launch a platform-global (e.g. web-based) search instead. 3919 * 3920 * @see android.app.SearchManager 3921 * @see #onSearchRequested 3922 */ 3923 public void startSearch(@Nullable String initialQuery, boolean selectInitialQuery, 3924 @Nullable Bundle appSearchData, boolean globalSearch) { 3925 ensureSearchManager(); 3926 mSearchManager.startSearch(initialQuery, selectInitialQuery, getComponentName(), 3927 appSearchData, globalSearch); 3928 } 3929 3930 /** 3931 * Similar to {@link #startSearch}, but actually fires off the search query after invoking 3932 * the search dialog. Made available for testing purposes. 3933 * 3934 * @param query The query to trigger. If empty, the request will be ignored. 3935 * @param appSearchData An application can insert application-specific 3936 * context here, in order to improve quality or specificity of its own 3937 * searches. This data will be returned with SEARCH intent(s). Null if 3938 * no extra data is required. 3939 */ 3940 public void triggerSearch(String query, @Nullable Bundle appSearchData) { 3941 ensureSearchManager(); 3942 mSearchManager.triggerSearch(query, getComponentName(), appSearchData); 3943 } 3944 3945 /** 3946 * Request that key events come to this activity. Use this if your 3947 * activity has no views with focus, but the activity still wants 3948 * a chance to process key events. 3949 * 3950 * @see android.view.Window#takeKeyEvents 3951 */ 3952 public void takeKeyEvents(boolean get) { 3953 getWindow().takeKeyEvents(get); 3954 } 3955 3956 /** 3957 * Enable extended window features. This is a convenience for calling 3958 * {@link android.view.Window#requestFeature getWindow().requestFeature()}. 3959 * 3960 * @param featureId The desired feature as defined in 3961 * {@link android.view.Window}. 3962 * @return Returns true if the requested feature is supported and now 3963 * enabled. 3964 * 3965 * @see android.view.Window#requestFeature 3966 */ 3967 public final boolean requestWindowFeature(int featureId) { 3968 return getWindow().requestFeature(featureId); 3969 } 3970 3971 /** 3972 * Convenience for calling 3973 * {@link android.view.Window#setFeatureDrawableResource}. 3974 */ 3975 public final void setFeatureDrawableResource(int featureId, @DrawableRes int resId) { 3976 getWindow().setFeatureDrawableResource(featureId, resId); 3977 } 3978 3979 /** 3980 * Convenience for calling 3981 * {@link android.view.Window#setFeatureDrawableUri}. 3982 */ 3983 public final void setFeatureDrawableUri(int featureId, Uri uri) { 3984 getWindow().setFeatureDrawableUri(featureId, uri); 3985 } 3986 3987 /** 3988 * Convenience for calling 3989 * {@link android.view.Window#setFeatureDrawable(int, Drawable)}. 3990 */ 3991 public final void setFeatureDrawable(int featureId, Drawable drawable) { 3992 getWindow().setFeatureDrawable(featureId, drawable); 3993 } 3994 3995 /** 3996 * Convenience for calling 3997 * {@link android.view.Window#setFeatureDrawableAlpha}. 3998 */ 3999 public final void setFeatureDrawableAlpha(int featureId, int alpha) { 4000 getWindow().setFeatureDrawableAlpha(featureId, alpha); 4001 } 4002 4003 /** 4004 * Convenience for calling 4005 * {@link android.view.Window#getLayoutInflater}. 4006 */ 4007 @NonNull 4008 public LayoutInflater getLayoutInflater() { 4009 return getWindow().getLayoutInflater(); 4010 } 4011 4012 /** 4013 * Returns a {@link MenuInflater} with this context. 4014 */ 4015 @NonNull 4016 public MenuInflater getMenuInflater() { 4017 // Make sure that action views can get an appropriate theme. 4018 if (mMenuInflater == null) { 4019 initWindowDecorActionBar(); 4020 if (mActionBar != null) { 4021 mMenuInflater = new MenuInflater(mActionBar.getThemedContext(), this); 4022 } else { 4023 mMenuInflater = new MenuInflater(this); 4024 } 4025 } 4026 return mMenuInflater; 4027 } 4028 4029 @Override 4030 public void setTheme(int resid) { 4031 super.setTheme(resid); 4032 mWindow.setTheme(resid); 4033 } 4034 4035 @Override 4036 protected void onApplyThemeResource(Resources.Theme theme, @StyleRes int resid, 4037 boolean first) { 4038 if (mParent == null) { 4039 super.onApplyThemeResource(theme, resid, first); 4040 } else { 4041 try { 4042 theme.setTo(mParent.getTheme()); 4043 } catch (Exception e) { 4044 // Empty 4045 } 4046 theme.applyStyle(resid, false); 4047 } 4048 4049 // Get the primary color and update the TaskDescription for this activity 4050 TypedArray a = theme.obtainStyledAttributes( 4051 com.android.internal.R.styleable.ActivityTaskDescription); 4052 if (mTaskDescription.getPrimaryColor() == 0) { 4053 int colorPrimary = a.getColor( 4054 com.android.internal.R.styleable.ActivityTaskDescription_colorPrimary, 0); 4055 if (colorPrimary != 0 && Color.alpha(colorPrimary) == 0xFF) { 4056 mTaskDescription.setPrimaryColor(colorPrimary); 4057 } 4058 } 4059 // For dev-preview only. 4060 if (mTaskDescription.getBackgroundColor() == 0) { 4061 int colorBackground = a.getColor( 4062 com.android.internal.R.styleable.ActivityTaskDescription_colorBackground, 0); 4063 if (colorBackground != 0 && Color.alpha(colorBackground) == 0xFF) { 4064 mTaskDescription.setBackgroundColor(colorBackground); 4065 } 4066 } 4067 a.recycle(); 4068 setTaskDescription(mTaskDescription); 4069 } 4070 4071 /** 4072 * Requests permissions to be granted to this application. These permissions 4073 * must be requested in your manifest, they should not be granted to your app, 4074 * and they should have protection level {@link android.content.pm.PermissionInfo 4075 * #PROTECTION_DANGEROUS dangerous}, regardless whether they are declared by 4076 * the platform or a third-party app. 4077 * <p> 4078 * Normal permissions {@link android.content.pm.PermissionInfo#PROTECTION_NORMAL} 4079 * are granted at install time if requested in the manifest. Signature permissions 4080 * {@link android.content.pm.PermissionInfo#PROTECTION_SIGNATURE} are granted at 4081 * install time if requested in the manifest and the signature of your app matches 4082 * the signature of the app declaring the permissions. 4083 * </p> 4084 * <p> 4085 * If your app does not have the requested permissions the user will be presented 4086 * with UI for accepting them. After the user has accepted or rejected the 4087 * requested permissions you will receive a callback on {@link 4088 * #onRequestPermissionsResult(int, String[], int[])} reporting whether the 4089 * permissions were granted or not. 4090 * </p> 4091 * <p> 4092 * Note that requesting a permission does not guarantee it will be granted and 4093 * your app should be able to run without having this permission. 4094 * </p> 4095 * <p> 4096 * This method may start an activity allowing the user to choose which permissions 4097 * to grant and which to reject. Hence, you should be prepared that your activity 4098 * may be paused and resumed. Further, granting some permissions may require 4099 * a restart of you application. In such a case, the system will recreate the 4100 * activity stack before delivering the result to {@link 4101 * #onRequestPermissionsResult(int, String[], int[])}. 4102 * </p> 4103 * <p> 4104 * When checking whether you have a permission you should use {@link 4105 * #checkSelfPermission(String)}. 4106 * </p> 4107 * <p> 4108 * Calling this API for permissions already granted to your app would show UI 4109 * to the user to decide whether the app can still hold these permissions. This 4110 * can be useful if the way your app uses data guarded by the permissions 4111 * changes significantly. 4112 * </p> 4113 * <p> 4114 * You cannot request a permission if your activity sets {@link 4115 * android.R.styleable#AndroidManifestActivity_noHistory noHistory} to 4116 * <code>true</code> because in this case the activity would not receive 4117 * result callbacks including {@link #onRequestPermissionsResult(int, String[], int[])}. 4118 * </p> 4119 * <p> 4120 * The <a href="http://developer.android.com/samples/RuntimePermissions/index.html"> 4121 * RuntimePermissions</a> sample app demonstrates how to use this method to 4122 * request permissions at run time. 4123 * </p> 4124 * 4125 * @param permissions The requested permissions. Must me non-null and not empty. 4126 * @param requestCode Application specific request code to match with a result 4127 * reported to {@link #onRequestPermissionsResult(int, String[], int[])}. 4128 * Should be >= 0. 4129 * 4130 * @throws IllegalArgumentException if requestCode is negative. 4131 * 4132 * @see #onRequestPermissionsResult(int, String[], int[]) 4133 * @see #checkSelfPermission(String) 4134 * @see #shouldShowRequestPermissionRationale(String) 4135 */ 4136 public final void requestPermissions(@NonNull String[] permissions, int requestCode) { 4137 if (requestCode < 0) { 4138 throw new IllegalArgumentException("requestCode should be >= 0"); 4139 } 4140 if (mHasCurrentPermissionsRequest) { 4141 Log.w(TAG, "Can reqeust only one set of permissions at a time"); 4142 // Dispatch the callback with empty arrays which means a cancellation. 4143 onRequestPermissionsResult(requestCode, new String[0], new int[0]); 4144 return; 4145 } 4146 Intent intent = getPackageManager().buildRequestPermissionsIntent(permissions); 4147 startActivityForResult(REQUEST_PERMISSIONS_WHO_PREFIX, intent, requestCode, null); 4148 mHasCurrentPermissionsRequest = true; 4149 } 4150 4151 /** 4152 * Callback for the result from requesting permissions. This method 4153 * is invoked for every call on {@link #requestPermissions(String[], int)}. 4154 * <p> 4155 * <strong>Note:</strong> It is possible that the permissions request interaction 4156 * with the user is interrupted. In this case you will receive empty permissions 4157 * and results arrays which should be treated as a cancellation. 4158 * </p> 4159 * 4160 * @param requestCode The request code passed in {@link #requestPermissions(String[], int)}. 4161 * @param permissions The requested permissions. Never null. 4162 * @param grantResults The grant results for the corresponding permissions 4163 * which is either {@link android.content.pm.PackageManager#PERMISSION_GRANTED} 4164 * or {@link android.content.pm.PackageManager#PERMISSION_DENIED}. Never null. 4165 * 4166 * @see #requestPermissions(String[], int) 4167 */ 4168 public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, 4169 @NonNull int[] grantResults) { 4170 /* callback - no nothing */ 4171 } 4172 4173 /** 4174 * Gets whether you should show UI with rationale for requesting a permission. 4175 * You should do this only if you do not have the permission and the context in 4176 * which the permission is requested does not clearly communicate to the user 4177 * what would be the benefit from granting this permission. 4178 * <p> 4179 * For example, if you write a camera app, requesting the camera permission 4180 * would be expected by the user and no rationale for why it is requested is 4181 * needed. If however, the app needs location for tagging photos then a non-tech 4182 * savvy user may wonder how location is related to taking photos. In this case 4183 * you may choose to show UI with rationale of requesting this permission. 4184 * </p> 4185 * 4186 * @param permission A permission your app wants to request. 4187 * @return Whether you can show permission rationale UI. 4188 * 4189 * @see #checkSelfPermission(String) 4190 * @see #requestPermissions(String[], int) 4191 * @see #onRequestPermissionsResult(int, String[], int[]) 4192 */ 4193 public boolean shouldShowRequestPermissionRationale(@NonNull String permission) { 4194 return getPackageManager().shouldShowRequestPermissionRationale(permission); 4195 } 4196 4197 /** 4198 * Same as calling {@link #startActivityForResult(Intent, int, Bundle)} 4199 * with no options. 4200 * 4201 * @param intent The intent to start. 4202 * @param requestCode If >= 0, this code will be returned in 4203 * onActivityResult() when the activity exits. 4204 * 4205 * @throws android.content.ActivityNotFoundException 4206 * 4207 * @see #startActivity 4208 */ 4209 public void startActivityForResult(@RequiresPermission Intent intent, int requestCode) { 4210 startActivityForResult(intent, requestCode, null); 4211 } 4212 4213 /** 4214 * Launch an activity for which you would like a result when it finished. 4215 * When this activity exits, your 4216 * onActivityResult() method will be called with the given requestCode. 4217 * Using a negative requestCode is the same as calling 4218 * {@link #startActivity} (the activity is not launched as a sub-activity). 4219 * 4220 * <p>Note that this method should only be used with Intent protocols 4221 * that are defined to return a result. In other protocols (such as 4222 * {@link Intent#ACTION_MAIN} or {@link Intent#ACTION_VIEW}), you may 4223 * not get the result when you expect. For example, if the activity you 4224 * are launching uses the singleTask launch mode, it will not run in your 4225 * task and thus you will immediately receive a cancel result. 4226 * 4227 * <p>As a special case, if you call startActivityForResult() with a requestCode 4228 * >= 0 during the initial onCreate(Bundle savedInstanceState)/onResume() of your 4229 * activity, then your window will not be displayed until a result is 4230 * returned back from the started activity. This is to avoid visible 4231 * flickering when redirecting to another activity. 4232 * 4233 * <p>This method throws {@link android.content.ActivityNotFoundException} 4234 * if there was no Activity found to run the given Intent. 4235 * 4236 * @param intent The intent to start. 4237 * @param requestCode If >= 0, this code will be returned in 4238 * onActivityResult() when the activity exits. 4239 * @param options Additional options for how the Activity should be started. 4240 * See {@link android.content.Context#startActivity(Intent, Bundle) 4241 * Context.startActivity(Intent, Bundle)} for more details. 4242 * 4243 * @throws android.content.ActivityNotFoundException 4244 * 4245 * @see #startActivity 4246 */ 4247 public void startActivityForResult(@RequiresPermission Intent intent, int requestCode, 4248 @Nullable Bundle options) { 4249 if (mParent == null) { 4250 options = transferSpringboardActivityOptions(options); 4251 Instrumentation.ActivityResult ar = 4252 mInstrumentation.execStartActivity( 4253 this, mMainThread.getApplicationThread(), mToken, this, 4254 intent, requestCode, options); 4255 if (ar != null) { 4256 mMainThread.sendActivityResult( 4257 mToken, mEmbeddedID, requestCode, ar.getResultCode(), 4258 ar.getResultData()); 4259 } 4260 if (requestCode >= 0) { 4261 // If this start is requesting a result, we can avoid making 4262 // the activity visible until the result is received. Setting 4263 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the 4264 // activity hidden during this time, to avoid flickering. 4265 // This can only be done when a result is requested because 4266 // that guarantees we will get information back when the 4267 // activity is finished, no matter what happens to it. 4268 mStartedActivity = true; 4269 } 4270 4271 cancelInputsAndStartExitTransition(options); 4272 // TODO Consider clearing/flushing other event sources and events for child windows. 4273 } else { 4274 if (options != null) { 4275 mParent.startActivityFromChild(this, intent, requestCode, options); 4276 } else { 4277 // Note we want to go through this method for compatibility with 4278 // existing applications that may have overridden it. 4279 mParent.startActivityFromChild(this, intent, requestCode); 4280 } 4281 } 4282 } 4283 4284 /** 4285 * Cancels pending inputs and if an Activity Transition is to be run, starts the transition. 4286 * 4287 * @param options The ActivityOptions bundle used to start an Activity. 4288 */ 4289 private void cancelInputsAndStartExitTransition(Bundle options) { 4290 final View decor = mWindow != null ? mWindow.peekDecorView() : null; 4291 if (decor != null) { 4292 decor.cancelPendingInputEvents(); 4293 } 4294 if (options != null && !isTopOfTask()) { 4295 mActivityTransitionState.startExitOutTransition(this, options); 4296 } 4297 } 4298 4299 private Bundle transferSpringboardActivityOptions(Bundle options) { 4300 if (options == null && (mWindow != null && !mWindow.isActive())) { 4301 final ActivityOptions activityOptions = getActivityOptions(); 4302 if (activityOptions != null && 4303 activityOptions.getAnimationType() == ActivityOptions.ANIM_SCENE_TRANSITION) { 4304 return activityOptions.toBundle(); 4305 } 4306 } 4307 return options; 4308 } 4309 4310 /** 4311 * @hide Implement to provide correct calling token. 4312 */ 4313 public void startActivityForResultAsUser(Intent intent, int requestCode, UserHandle user) { 4314 startActivityForResultAsUser(intent, requestCode, null, user); 4315 } 4316 4317 /** 4318 * @hide Implement to provide correct calling token. 4319 */ 4320 public void startActivityForResultAsUser(Intent intent, int requestCode, 4321 @Nullable Bundle options, UserHandle user) { 4322 if (mParent != null) { 4323 throw new RuntimeException("Can't be called from a child"); 4324 } 4325 options = transferSpringboardActivityOptions(options); 4326 Instrumentation.ActivityResult ar = mInstrumentation.execStartActivity( 4327 this, mMainThread.getApplicationThread(), mToken, this, intent, requestCode, 4328 options, user); 4329 if (ar != null) { 4330 mMainThread.sendActivityResult( 4331 mToken, mEmbeddedID, requestCode, ar.getResultCode(), ar.getResultData()); 4332 } 4333 if (requestCode >= 0) { 4334 // If this start is requesting a result, we can avoid making 4335 // the activity visible until the result is received. Setting 4336 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the 4337 // activity hidden during this time, to avoid flickering. 4338 // This can only be done when a result is requested because 4339 // that guarantees we will get information back when the 4340 // activity is finished, no matter what happens to it. 4341 mStartedActivity = true; 4342 } 4343 4344 cancelInputsAndStartExitTransition(options); 4345 } 4346 4347 /** 4348 * @hide Implement to provide correct calling token. 4349 */ 4350 public void startActivityAsUser(Intent intent, UserHandle user) { 4351 startActivityAsUser(intent, null, user); 4352 } 4353 4354 /** 4355 * @hide Implement to provide correct calling token. 4356 */ 4357 public void startActivityAsUser(Intent intent, Bundle options, UserHandle user) { 4358 if (mParent != null) { 4359 throw new RuntimeException("Can't be called from a child"); 4360 } 4361 options = transferSpringboardActivityOptions(options); 4362 Instrumentation.ActivityResult ar = 4363 mInstrumentation.execStartActivity( 4364 this, mMainThread.getApplicationThread(), mToken, this, 4365 intent, -1, options, user); 4366 if (ar != null) { 4367 mMainThread.sendActivityResult( 4368 mToken, mEmbeddedID, -1, ar.getResultCode(), 4369 ar.getResultData()); 4370 } 4371 cancelInputsAndStartExitTransition(options); 4372 } 4373 4374 /** 4375 * Start a new activity as if it was started by the activity that started our 4376 * current activity. This is for the resolver and chooser activities, which operate 4377 * as intermediaries that dispatch their intent to the target the user selects -- to 4378 * do this, they must perform all security checks including permission grants as if 4379 * their launch had come from the original activity. 4380 * @param intent The Intent to start. 4381 * @param options ActivityOptions or null. 4382 * @param ignoreTargetSecurity If true, the activity manager will not check whether the 4383 * caller it is doing the start is, is actually allowed to start the target activity. 4384 * If you set this to true, you must set an explicit component in the Intent and do any 4385 * appropriate security checks yourself. 4386 * @param userId The user the new activity should run as. 4387 * @hide 4388 */ 4389 public void startActivityAsCaller(Intent intent, @Nullable Bundle options, 4390 boolean ignoreTargetSecurity, int userId) { 4391 if (mParent != null) { 4392 throw new RuntimeException("Can't be called from a child"); 4393 } 4394 options = transferSpringboardActivityOptions(options); 4395 Instrumentation.ActivityResult ar = 4396 mInstrumentation.execStartActivityAsCaller( 4397 this, mMainThread.getApplicationThread(), mToken, this, 4398 intent, -1, options, ignoreTargetSecurity, userId); 4399 if (ar != null) { 4400 mMainThread.sendActivityResult( 4401 mToken, mEmbeddedID, -1, ar.getResultCode(), 4402 ar.getResultData()); 4403 } 4404 cancelInputsAndStartExitTransition(options); 4405 } 4406 4407 /** 4408 * Same as calling {@link #startIntentSenderForResult(IntentSender, int, 4409 * Intent, int, int, int, Bundle)} with no options. 4410 * 4411 * @param intent The IntentSender to launch. 4412 * @param requestCode If >= 0, this code will be returned in 4413 * onActivityResult() when the activity exits. 4414 * @param fillInIntent If non-null, this will be provided as the 4415 * intent parameter to {@link IntentSender#sendIntent}. 4416 * @param flagsMask Intent flags in the original IntentSender that you 4417 * would like to change. 4418 * @param flagsValues Desired values for any bits set in 4419 * <var>flagsMask</var> 4420 * @param extraFlags Always set to 0. 4421 */ 4422 public void startIntentSenderForResult(IntentSender intent, int requestCode, 4423 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) 4424 throws IntentSender.SendIntentException { 4425 startIntentSenderForResult(intent, requestCode, fillInIntent, flagsMask, 4426 flagsValues, extraFlags, null); 4427 } 4428 4429 /** 4430 * Like {@link #startActivityForResult(Intent, int)}, but allowing you 4431 * to use a IntentSender to describe the activity to be started. If 4432 * the IntentSender is for an activity, that activity will be started 4433 * as if you had called the regular {@link #startActivityForResult(Intent, int)} 4434 * here; otherwise, its associated action will be executed (such as 4435 * sending a broadcast) as if you had called 4436 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it. 4437 * 4438 * @param intent The IntentSender to launch. 4439 * @param requestCode If >= 0, this code will be returned in 4440 * onActivityResult() when the activity exits. 4441 * @param fillInIntent If non-null, this will be provided as the 4442 * intent parameter to {@link IntentSender#sendIntent}. 4443 * @param flagsMask Intent flags in the original IntentSender that you 4444 * would like to change. 4445 * @param flagsValues Desired values for any bits set in 4446 * <var>flagsMask</var> 4447 * @param extraFlags Always set to 0. 4448 * @param options Additional options for how the Activity should be started. 4449 * See {@link android.content.Context#startActivity(Intent, Bundle) 4450 * Context.startActivity(Intent, Bundle)} for more details. If options 4451 * have also been supplied by the IntentSender, options given here will 4452 * override any that conflict with those given by the IntentSender. 4453 */ 4454 public void startIntentSenderForResult(IntentSender intent, int requestCode, 4455 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, 4456 Bundle options) throws IntentSender.SendIntentException { 4457 if (mParent == null) { 4458 startIntentSenderForResultInner(intent, mEmbeddedID, requestCode, fillInIntent, 4459 flagsMask, flagsValues, options); 4460 } else if (options != null) { 4461 mParent.startIntentSenderFromChild(this, intent, requestCode, 4462 fillInIntent, flagsMask, flagsValues, extraFlags, options); 4463 } else { 4464 // Note we want to go through this call for compatibility with 4465 // existing applications that may have overridden the method. 4466 mParent.startIntentSenderFromChild(this, intent, requestCode, 4467 fillInIntent, flagsMask, flagsValues, extraFlags); 4468 } 4469 } 4470 4471 private void startIntentSenderForResultInner(IntentSender intent, String who, int requestCode, 4472 Intent fillInIntent, int flagsMask, int flagsValues, 4473 Bundle options) 4474 throws IntentSender.SendIntentException { 4475 try { 4476 String resolvedType = null; 4477 if (fillInIntent != null) { 4478 fillInIntent.migrateExtraStreamToClipData(); 4479 fillInIntent.prepareToLeaveProcess(this); 4480 resolvedType = fillInIntent.resolveTypeIfNeeded(getContentResolver()); 4481 } 4482 int result = ActivityManagerNative.getDefault() 4483 .startActivityIntentSender(mMainThread.getApplicationThread(), intent, 4484 fillInIntent, resolvedType, mToken, who, 4485 requestCode, flagsMask, flagsValues, options); 4486 if (result == ActivityManager.START_CANCELED) { 4487 throw new IntentSender.SendIntentException(); 4488 } 4489 Instrumentation.checkStartActivityResult(result, null); 4490 } catch (RemoteException e) { 4491 } 4492 if (requestCode >= 0) { 4493 // If this start is requesting a result, we can avoid making 4494 // the activity visible until the result is received. Setting 4495 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the 4496 // activity hidden during this time, to avoid flickering. 4497 // This can only be done when a result is requested because 4498 // that guarantees we will get information back when the 4499 // activity is finished, no matter what happens to it. 4500 mStartedActivity = true; 4501 } 4502 } 4503 4504 /** 4505 * Same as {@link #startActivity(Intent, Bundle)} with no options 4506 * specified. 4507 * 4508 * @param intent The intent to start. 4509 * 4510 * @throws android.content.ActivityNotFoundException 4511 * 4512 * @see #startActivity(Intent, Bundle) 4513 * @see #startActivityForResult 4514 */ 4515 @Override 4516 public void startActivity(Intent intent) { 4517 this.startActivity(intent, null); 4518 } 4519 4520 /** 4521 * Launch a new activity. You will not receive any information about when 4522 * the activity exits. This implementation overrides the base version, 4523 * providing information about 4524 * the activity performing the launch. Because of this additional 4525 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not 4526 * required; if not specified, the new activity will be added to the 4527 * task of the caller. 4528 * 4529 * <p>This method throws {@link android.content.ActivityNotFoundException} 4530 * if there was no Activity found to run the given Intent. 4531 * 4532 * @param intent The intent to start. 4533 * @param options Additional options for how the Activity should be started. 4534 * See {@link android.content.Context#startActivity(Intent, Bundle) 4535 * Context.startActivity(Intent, Bundle)} for more details. 4536 * 4537 * @throws android.content.ActivityNotFoundException 4538 * 4539 * @see #startActivity(Intent) 4540 * @see #startActivityForResult 4541 */ 4542 @Override 4543 public void startActivity(Intent intent, @Nullable Bundle options) { 4544 if (options != null) { 4545 startActivityForResult(intent, -1, options); 4546 } else { 4547 // Note we want to go through this call for compatibility with 4548 // applications that may have overridden the method. 4549 startActivityForResult(intent, -1); 4550 } 4551 } 4552 4553 /** 4554 * Same as {@link #startActivities(Intent[], Bundle)} with no options 4555 * specified. 4556 * 4557 * @param intents The intents to start. 4558 * 4559 * @throws android.content.ActivityNotFoundException 4560 * 4561 * @see #startActivities(Intent[], Bundle) 4562 * @see #startActivityForResult 4563 */ 4564 @Override 4565 public void startActivities(Intent[] intents) { 4566 startActivities(intents, null); 4567 } 4568 4569 /** 4570 * Launch a new activity. You will not receive any information about when 4571 * the activity exits. This implementation overrides the base version, 4572 * providing information about 4573 * the activity performing the launch. Because of this additional 4574 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not 4575 * required; if not specified, the new activity will be added to the 4576 * task of the caller. 4577 * 4578 * <p>This method throws {@link android.content.ActivityNotFoundException} 4579 * if there was no Activity found to run the given Intent. 4580 * 4581 * @param intents The intents to start. 4582 * @param options Additional options for how the Activity should be started. 4583 * See {@link android.content.Context#startActivity(Intent, Bundle) 4584 * Context.startActivity(Intent, Bundle)} for more details. 4585 * 4586 * @throws android.content.ActivityNotFoundException 4587 * 4588 * @see #startActivities(Intent[]) 4589 * @see #startActivityForResult 4590 */ 4591 @Override 4592 public void startActivities(Intent[] intents, @Nullable Bundle options) { 4593 mInstrumentation.execStartActivities(this, mMainThread.getApplicationThread(), 4594 mToken, this, intents, options); 4595 } 4596 4597 /** 4598 * Same as calling {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)} 4599 * with no options. 4600 * 4601 * @param intent The IntentSender to launch. 4602 * @param fillInIntent If non-null, this will be provided as the 4603 * intent parameter to {@link IntentSender#sendIntent}. 4604 * @param flagsMask Intent flags in the original IntentSender that you 4605 * would like to change. 4606 * @param flagsValues Desired values for any bits set in 4607 * <var>flagsMask</var> 4608 * @param extraFlags Always set to 0. 4609 */ 4610 public void startIntentSender(IntentSender intent, 4611 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) 4612 throws IntentSender.SendIntentException { 4613 startIntentSender(intent, fillInIntent, flagsMask, flagsValues, 4614 extraFlags, null); 4615 } 4616 4617 /** 4618 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender 4619 * to start; see 4620 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)} 4621 * for more information. 4622 * 4623 * @param intent The IntentSender to launch. 4624 * @param fillInIntent If non-null, this will be provided as the 4625 * intent parameter to {@link IntentSender#sendIntent}. 4626 * @param flagsMask Intent flags in the original IntentSender that you 4627 * would like to change. 4628 * @param flagsValues Desired values for any bits set in 4629 * <var>flagsMask</var> 4630 * @param extraFlags Always set to 0. 4631 * @param options Additional options for how the Activity should be started. 4632 * See {@link android.content.Context#startActivity(Intent, Bundle) 4633 * Context.startActivity(Intent, Bundle)} for more details. If options 4634 * have also been supplied by the IntentSender, options given here will 4635 * override any that conflict with those given by the IntentSender. 4636 */ 4637 public void startIntentSender(IntentSender intent, 4638 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, 4639 Bundle options) throws IntentSender.SendIntentException { 4640 if (options != null) { 4641 startIntentSenderForResult(intent, -1, fillInIntent, flagsMask, 4642 flagsValues, extraFlags, options); 4643 } else { 4644 // Note we want to go through this call for compatibility with 4645 // applications that may have overridden the method. 4646 startIntentSenderForResult(intent, -1, fillInIntent, flagsMask, 4647 flagsValues, extraFlags); 4648 } 4649 } 4650 4651 /** 4652 * Same as calling {@link #startActivityIfNeeded(Intent, int, Bundle)} 4653 * with no options. 4654 * 4655 * @param intent The intent to start. 4656 * @param requestCode If >= 0, this code will be returned in 4657 * onActivityResult() when the activity exits, as described in 4658 * {@link #startActivityForResult}. 4659 * 4660 * @return If a new activity was launched then true is returned; otherwise 4661 * false is returned and you must handle the Intent yourself. 4662 * 4663 * @see #startActivity 4664 * @see #startActivityForResult 4665 */ 4666 public boolean startActivityIfNeeded(@RequiresPermission @NonNull Intent intent, 4667 int requestCode) { 4668 return startActivityIfNeeded(intent, requestCode, null); 4669 } 4670 4671 /** 4672 * A special variation to launch an activity only if a new activity 4673 * instance is needed to handle the given Intent. In other words, this is 4674 * just like {@link #startActivityForResult(Intent, int)} except: if you are 4675 * using the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} flag, or 4676 * singleTask or singleTop 4677 * {@link android.R.styleable#AndroidManifestActivity_launchMode launchMode}, 4678 * and the activity 4679 * that handles <var>intent</var> is the same as your currently running 4680 * activity, then a new instance is not needed. In this case, instead of 4681 * the normal behavior of calling {@link #onNewIntent} this function will 4682 * return and you can handle the Intent yourself. 4683 * 4684 * <p>This function can only be called from a top-level activity; if it is 4685 * called from a child activity, a runtime exception will be thrown. 4686 * 4687 * @param intent The intent to start. 4688 * @param requestCode If >= 0, this code will be returned in 4689 * onActivityResult() when the activity exits, as described in 4690 * {@link #startActivityForResult}. 4691 * @param options Additional options for how the Activity should be started. 4692 * See {@link android.content.Context#startActivity(Intent, Bundle) 4693 * Context.startActivity(Intent, Bundle)} for more details. 4694 * 4695 * @return If a new activity was launched then true is returned; otherwise 4696 * false is returned and you must handle the Intent yourself. 4697 * 4698 * @see #startActivity 4699 * @see #startActivityForResult 4700 */ 4701 public boolean startActivityIfNeeded(@RequiresPermission @NonNull Intent intent, 4702 int requestCode, @Nullable Bundle options) { 4703 if (mParent == null) { 4704 int result = ActivityManager.START_RETURN_INTENT_TO_CALLER; 4705 try { 4706 Uri referrer = onProvideReferrer(); 4707 if (referrer != null) { 4708 intent.putExtra(Intent.EXTRA_REFERRER, referrer); 4709 } 4710 intent.migrateExtraStreamToClipData(); 4711 intent.prepareToLeaveProcess(this); 4712 result = ActivityManagerNative.getDefault() 4713 .startActivity(mMainThread.getApplicationThread(), getBasePackageName(), 4714 intent, intent.resolveTypeIfNeeded(getContentResolver()), mToken, 4715 mEmbeddedID, requestCode, ActivityManager.START_FLAG_ONLY_IF_NEEDED, 4716 null, options); 4717 } catch (RemoteException e) { 4718 // Empty 4719 } 4720 4721 Instrumentation.checkStartActivityResult(result, intent); 4722 4723 if (requestCode >= 0) { 4724 // If this start is requesting a result, we can avoid making 4725 // the activity visible until the result is received. Setting 4726 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the 4727 // activity hidden during this time, to avoid flickering. 4728 // This can only be done when a result is requested because 4729 // that guarantees we will get information back when the 4730 // activity is finished, no matter what happens to it. 4731 mStartedActivity = true; 4732 } 4733 return result != ActivityManager.START_RETURN_INTENT_TO_CALLER; 4734 } 4735 4736 throw new UnsupportedOperationException( 4737 "startActivityIfNeeded can only be called from a top-level activity"); 4738 } 4739 4740 /** 4741 * Same as calling {@link #startNextMatchingActivity(Intent, Bundle)} with 4742 * no options. 4743 * 4744 * @param intent The intent to dispatch to the next activity. For 4745 * correct behavior, this must be the same as the Intent that started 4746 * your own activity; the only changes you can make are to the extras 4747 * inside of it. 4748 * 4749 * @return Returns a boolean indicating whether there was another Activity 4750 * to start: true if there was a next activity to start, false if there 4751 * wasn't. In general, if true is returned you will then want to call 4752 * finish() on yourself. 4753 */ 4754 public boolean startNextMatchingActivity(@RequiresPermission @NonNull Intent intent) { 4755 return startNextMatchingActivity(intent, null); 4756 } 4757 4758 /** 4759 * Special version of starting an activity, for use when you are replacing 4760 * other activity components. You can use this to hand the Intent off 4761 * to the next Activity that can handle it. You typically call this in 4762 * {@link #onCreate} with the Intent returned by {@link #getIntent}. 4763 * 4764 * @param intent The intent to dispatch to the next activity. For 4765 * correct behavior, this must be the same as the Intent that started 4766 * your own activity; the only changes you can make are to the extras 4767 * inside of it. 4768 * @param options Additional options for how the Activity should be started. 4769 * See {@link android.content.Context#startActivity(Intent, Bundle) 4770 * Context.startActivity(Intent, Bundle)} for more details. 4771 * 4772 * @return Returns a boolean indicating whether there was another Activity 4773 * to start: true if there was a next activity to start, false if there 4774 * wasn't. In general, if true is returned you will then want to call 4775 * finish() on yourself. 4776 */ 4777 public boolean startNextMatchingActivity(@RequiresPermission @NonNull Intent intent, 4778 @Nullable Bundle options) { 4779 if (mParent == null) { 4780 try { 4781 intent.migrateExtraStreamToClipData(); 4782 intent.prepareToLeaveProcess(this); 4783 return ActivityManagerNative.getDefault() 4784 .startNextMatchingActivity(mToken, intent, options); 4785 } catch (RemoteException e) { 4786 // Empty 4787 } 4788 return false; 4789 } 4790 4791 throw new UnsupportedOperationException( 4792 "startNextMatchingActivity can only be called from a top-level activity"); 4793 } 4794 4795 /** 4796 * Same as calling {@link #startActivityFromChild(Activity, Intent, int, Bundle)} 4797 * with no options. 4798 * 4799 * @param child The activity making the call. 4800 * @param intent The intent to start. 4801 * @param requestCode Reply request code. < 0 if reply is not requested. 4802 * 4803 * @throws android.content.ActivityNotFoundException 4804 * 4805 * @see #startActivity 4806 * @see #startActivityForResult 4807 */ 4808 public void startActivityFromChild(@NonNull Activity child, @RequiresPermission Intent intent, 4809 int requestCode) { 4810 startActivityFromChild(child, intent, requestCode, null); 4811 } 4812 4813 /** 4814 * This is called when a child activity of this one calls its 4815 * {@link #startActivity} or {@link #startActivityForResult} method. 4816 * 4817 * <p>This method throws {@link android.content.ActivityNotFoundException} 4818 * if there was no Activity found to run the given Intent. 4819 * 4820 * @param child The activity making the call. 4821 * @param intent The intent to start. 4822 * @param requestCode Reply request code. < 0 if reply is not requested. 4823 * @param options Additional options for how the Activity should be started. 4824 * See {@link android.content.Context#startActivity(Intent, Bundle) 4825 * Context.startActivity(Intent, Bundle)} for more details. 4826 * 4827 * @throws android.content.ActivityNotFoundException 4828 * 4829 * @see #startActivity 4830 * @see #startActivityForResult 4831 */ 4832 public void startActivityFromChild(@NonNull Activity child, @RequiresPermission Intent intent, 4833 int requestCode, @Nullable Bundle options) { 4834 options = transferSpringboardActivityOptions(options); 4835 Instrumentation.ActivityResult ar = 4836 mInstrumentation.execStartActivity( 4837 this, mMainThread.getApplicationThread(), mToken, child, 4838 intent, requestCode, options); 4839 if (ar != null) { 4840 mMainThread.sendActivityResult( 4841 mToken, child.mEmbeddedID, requestCode, 4842 ar.getResultCode(), ar.getResultData()); 4843 } 4844 cancelInputsAndStartExitTransition(options); 4845 } 4846 4847 /** 4848 * Same as calling {@link #startActivityFromFragment(Fragment, Intent, int, Bundle)} 4849 * with no options. 4850 * 4851 * @param fragment The fragment making the call. 4852 * @param intent The intent to start. 4853 * @param requestCode Reply request code. < 0 if reply is not requested. 4854 * 4855 * @throws android.content.ActivityNotFoundException 4856 * 4857 * @see Fragment#startActivity 4858 * @see Fragment#startActivityForResult 4859 */ 4860 public void startActivityFromFragment(@NonNull Fragment fragment, 4861 @RequiresPermission Intent intent, int requestCode) { 4862 startActivityFromFragment(fragment, intent, requestCode, null); 4863 } 4864 4865 /** 4866 * This is called when a Fragment in this activity calls its 4867 * {@link Fragment#startActivity} or {@link Fragment#startActivityForResult} 4868 * method. 4869 * 4870 * <p>This method throws {@link android.content.ActivityNotFoundException} 4871 * if there was no Activity found to run the given Intent. 4872 * 4873 * @param fragment The fragment making the call. 4874 * @param intent The intent to start. 4875 * @param requestCode Reply request code. < 0 if reply is not requested. 4876 * @param options Additional options for how the Activity should be started. 4877 * See {@link android.content.Context#startActivity(Intent, Bundle) 4878 * Context.startActivity(Intent, Bundle)} for more details. 4879 * 4880 * @throws android.content.ActivityNotFoundException 4881 * 4882 * @see Fragment#startActivity 4883 * @see Fragment#startActivityForResult 4884 */ 4885 public void startActivityFromFragment(@NonNull Fragment fragment, 4886 @RequiresPermission Intent intent, int requestCode, @Nullable Bundle options) { 4887 startActivityForResult(fragment.mWho, intent, requestCode, options); 4888 } 4889 4890 /** 4891 * @hide 4892 */ 4893 @Override 4894 public void startActivityForResult( 4895 String who, Intent intent, int requestCode, @Nullable Bundle options) { 4896 Uri referrer = onProvideReferrer(); 4897 if (referrer != null) { 4898 intent.putExtra(Intent.EXTRA_REFERRER, referrer); 4899 } 4900 options = transferSpringboardActivityOptions(options); 4901 Instrumentation.ActivityResult ar = 4902 mInstrumentation.execStartActivity( 4903 this, mMainThread.getApplicationThread(), mToken, who, 4904 intent, requestCode, options); 4905 if (ar != null) { 4906 mMainThread.sendActivityResult( 4907 mToken, who, requestCode, 4908 ar.getResultCode(), ar.getResultData()); 4909 } 4910 cancelInputsAndStartExitTransition(options); 4911 } 4912 4913 /** 4914 * @hide 4915 */ 4916 @Override 4917 public boolean canStartActivityForResult() { 4918 return true; 4919 } 4920 4921 /** 4922 * Same as calling {@link #startIntentSenderFromChild(Activity, IntentSender, 4923 * int, Intent, int, int, int, Bundle)} with no options. 4924 */ 4925 public void startIntentSenderFromChild(Activity child, IntentSender intent, 4926 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, 4927 int extraFlags) 4928 throws IntentSender.SendIntentException { 4929 startIntentSenderFromChild(child, intent, requestCode, fillInIntent, 4930 flagsMask, flagsValues, extraFlags, null); 4931 } 4932 4933 /** 4934 * Like {@link #startActivityFromChild(Activity, Intent, int)}, but 4935 * taking a IntentSender; see 4936 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)} 4937 * for more information. 4938 */ 4939 public void startIntentSenderFromChild(Activity child, IntentSender intent, 4940 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, 4941 int extraFlags, @Nullable Bundle options) 4942 throws IntentSender.SendIntentException { 4943 startIntentSenderForResultInner(intent, child.mEmbeddedID, requestCode, fillInIntent, 4944 flagsMask, flagsValues, options); 4945 } 4946 4947 /** 4948 * Like {@link #startIntentSenderFromChild}, but taking a Fragment; see 4949 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)} 4950 * for more information. 4951 * 4952 * @hide 4953 */ 4954 public void startIntentSenderFromChildFragment(Fragment child, IntentSender intent, 4955 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, 4956 int extraFlags, @Nullable Bundle options) 4957 throws IntentSender.SendIntentException { 4958 startIntentSenderForResultInner(intent, child.mWho, requestCode, fillInIntent, 4959 flagsMask, flagsValues, options); 4960 } 4961 4962 /** 4963 * Call immediately after one of the flavors of {@link #startActivity(Intent)} 4964 * or {@link #finish} to specify an explicit transition animation to 4965 * perform next. 4966 * 4967 * <p>As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN} an alternative 4968 * to using this with starting activities is to supply the desired animation 4969 * information through a {@link ActivityOptions} bundle to 4970 * {@link #startActivity(Intent, Bundle)} or a related function. This allows 4971 * you to specify a custom animation even when starting an activity from 4972 * outside the context of the current top activity. 4973 * 4974 * @param enterAnim A resource ID of the animation resource to use for 4975 * the incoming activity. Use 0 for no animation. 4976 * @param exitAnim A resource ID of the animation resource to use for 4977 * the outgoing activity. Use 0 for no animation. 4978 */ 4979 public void overridePendingTransition(int enterAnim, int exitAnim) { 4980 try { 4981 ActivityManagerNative.getDefault().overridePendingTransition( 4982 mToken, getPackageName(), enterAnim, exitAnim); 4983 } catch (RemoteException e) { 4984 } 4985 } 4986 4987 /** 4988 * Call this to set the result that your activity will return to its 4989 * caller. 4990 * 4991 * @param resultCode The result code to propagate back to the originating 4992 * activity, often RESULT_CANCELED or RESULT_OK 4993 * 4994 * @see #RESULT_CANCELED 4995 * @see #RESULT_OK 4996 * @see #RESULT_FIRST_USER 4997 * @see #setResult(int, Intent) 4998 */ 4999 public final void setResult(int resultCode) { 5000 synchronized (this) { 5001 mResultCode = resultCode; 5002 mResultData = null; 5003 } 5004 } 5005 5006 /** 5007 * Call this to set the result that your activity will return to its 5008 * caller. 5009 * 5010 * <p>As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}, the Intent 5011 * you supply here can have {@link Intent#FLAG_GRANT_READ_URI_PERMISSION 5012 * Intent.FLAG_GRANT_READ_URI_PERMISSION} and/or {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION 5013 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} set. This will grant the 5014 * Activity receiving the result access to the specific URIs in the Intent. 5015 * Access will remain until the Activity has finished (it will remain across the hosting 5016 * process being killed and other temporary destruction) and will be added 5017 * to any existing set of URI permissions it already holds. 5018 * 5019 * @param resultCode The result code to propagate back to the originating 5020 * activity, often RESULT_CANCELED or RESULT_OK 5021 * @param data The data to propagate back to the originating activity. 5022 * 5023 * @see #RESULT_CANCELED 5024 * @see #RESULT_OK 5025 * @see #RESULT_FIRST_USER 5026 * @see #setResult(int) 5027 */ 5028 public final void setResult(int resultCode, Intent data) { 5029 synchronized (this) { 5030 mResultCode = resultCode; 5031 mResultData = data; 5032 } 5033 } 5034 5035 /** 5036 * Return information about who launched this activity. If the launching Intent 5037 * contains an {@link android.content.Intent#EXTRA_REFERRER Intent.EXTRA_REFERRER}, 5038 * that will be returned as-is; otherwise, if known, an 5039 * {@link Intent#URI_ANDROID_APP_SCHEME android-app:} referrer URI containing the 5040 * package name that started the Intent will be returned. This may return null if no 5041 * referrer can be identified -- it is neither explicitly specified, nor is it known which 5042 * application package was involved. 5043 * 5044 * <p>If called while inside the handling of {@link #onNewIntent}, this function will 5045 * return the referrer that submitted that new intent to the activity. Otherwise, it 5046 * always returns the referrer of the original Intent.</p> 5047 * 5048 * <p>Note that this is <em>not</em> a security feature -- you can not trust the 5049 * referrer information, applications can spoof it.</p> 5050 */ 5051 @Nullable 5052 public Uri getReferrer() { 5053 Intent intent = getIntent(); 5054 try { 5055 Uri referrer = intent.getParcelableExtra(Intent.EXTRA_REFERRER); 5056 if (referrer != null) { 5057 return referrer; 5058 } 5059 String referrerName = intent.getStringExtra(Intent.EXTRA_REFERRER_NAME); 5060 if (referrerName != null) { 5061 return Uri.parse(referrerName); 5062 } 5063 } catch (BadParcelableException e) { 5064 Log.w(TAG, "Cannot read referrer from intent;" 5065 + " intent extras contain unknown custom Parcelable objects"); 5066 } 5067 if (mReferrer != null) { 5068 return new Uri.Builder().scheme("android-app").authority(mReferrer).build(); 5069 } 5070 return null; 5071 } 5072 5073 /** 5074 * Override to generate the desired referrer for the content currently being shown 5075 * by the app. The default implementation returns null, meaning the referrer will simply 5076 * be the android-app: of the package name of this activity. Return a non-null Uri to 5077 * have that supplied as the {@link Intent#EXTRA_REFERRER} of any activities started from it. 5078 */ 5079 public Uri onProvideReferrer() { 5080 return null; 5081 } 5082 5083 /** 5084 * Return the name of the package that invoked this activity. This is who 5085 * the data in {@link #setResult setResult()} will be sent to. You can 5086 * use this information to validate that the recipient is allowed to 5087 * receive the data. 5088 * 5089 * <p class="note">Note: if the calling activity is not expecting a result (that is it 5090 * did not use the {@link #startActivityForResult} 5091 * form that includes a request code), then the calling package will be 5092 * null.</p> 5093 * 5094 * <p class="note">Note: prior to {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2}, 5095 * the result from this method was unstable. If the process hosting the calling 5096 * package was no longer running, it would return null instead of the proper package 5097 * name. You can use {@link #getCallingActivity()} and retrieve the package name 5098 * from that instead.</p> 5099 * 5100 * @return The package of the activity that will receive your 5101 * reply, or null if none. 5102 */ 5103 @Nullable 5104 public String getCallingPackage() { 5105 try { 5106 return ActivityManagerNative.getDefault().getCallingPackage(mToken); 5107 } catch (RemoteException e) { 5108 return null; 5109 } 5110 } 5111 5112 /** 5113 * Return the name of the activity that invoked this activity. This is 5114 * who the data in {@link #setResult setResult()} will be sent to. You 5115 * can use this information to validate that the recipient is allowed to 5116 * receive the data. 5117 * 5118 * <p class="note">Note: if the calling activity is not expecting a result (that is it 5119 * did not use the {@link #startActivityForResult} 5120 * form that includes a request code), then the calling package will be 5121 * null. 5122 * 5123 * @return The ComponentName of the activity that will receive your 5124 * reply, or null if none. 5125 */ 5126 @Nullable 5127 public ComponentName getCallingActivity() { 5128 try { 5129 return ActivityManagerNative.getDefault().getCallingActivity(mToken); 5130 } catch (RemoteException e) { 5131 return null; 5132 } 5133 } 5134 5135 /** 5136 * Control whether this activity's main window is visible. This is intended 5137 * only for the special case of an activity that is not going to show a 5138 * UI itself, but can't just finish prior to onResume() because it needs 5139 * to wait for a service binding or such. Setting this to false allows 5140 * you to prevent your UI from being shown during that time. 5141 * 5142 * <p>The default value for this is taken from the 5143 * {@link android.R.attr#windowNoDisplay} attribute of the activity's theme. 5144 */ 5145 public void setVisible(boolean visible) { 5146 if (mVisibleFromClient != visible) { 5147 mVisibleFromClient = visible; 5148 if (mVisibleFromServer) { 5149 if (visible) makeVisible(); 5150 else mDecor.setVisibility(View.INVISIBLE); 5151 } 5152 } 5153 } 5154 5155 void makeVisible() { 5156 if (!mWindowAdded) { 5157 ViewManager wm = getWindowManager(); 5158 wm.addView(mDecor, getWindow().getAttributes()); 5159 mWindowAdded = true; 5160 } 5161 mDecor.setVisibility(View.VISIBLE); 5162 } 5163 5164 /** 5165 * Check to see whether this activity is in the process of finishing, 5166 * either because you called {@link #finish} on it or someone else 5167 * has requested that it finished. This is often used in 5168 * {@link #onPause} to determine whether the activity is simply pausing or 5169 * completely finishing. 5170 * 5171 * @return If the activity is finishing, returns true; else returns false. 5172 * 5173 * @see #finish 5174 */ 5175 public boolean isFinishing() { 5176 return mFinished; 5177 } 5178 5179 /** 5180 * Returns true if the final {@link #onDestroy()} call has been made 5181 * on the Activity, so this instance is now dead. 5182 */ 5183 public boolean isDestroyed() { 5184 return mDestroyed; 5185 } 5186 5187 /** 5188 * Check to see whether this activity is in the process of being destroyed in order to be 5189 * recreated with a new configuration. This is often used in 5190 * {@link #onStop} to determine whether the state needs to be cleaned up or will be passed 5191 * on to the next instance of the activity via {@link #onRetainNonConfigurationInstance()}. 5192 * 5193 * @return If the activity is being torn down in order to be recreated with a new configuration, 5194 * returns true; else returns false. 5195 */ 5196 public boolean isChangingConfigurations() { 5197 return mChangingConfigurations; 5198 } 5199 5200 /** 5201 * Cause this Activity to be recreated with a new instance. This results 5202 * in essentially the same flow as when the Activity is created due to 5203 * a configuration change -- the current instance will go through its 5204 * lifecycle to {@link #onDestroy} and a new instance then created after it. 5205 */ 5206 public void recreate() { 5207 if (mParent != null) { 5208 throw new IllegalStateException("Can only be called on top-level activity"); 5209 } 5210 if (Looper.myLooper() != mMainThread.getLooper()) { 5211 throw new IllegalStateException("Must be called from main thread"); 5212 } 5213 try { 5214 ActivityManagerNative.getDefault().requestActivityRelaunch(mToken); 5215 } catch (RemoteException e) { 5216 } 5217 } 5218 5219 /** 5220 * Finishes the current activity and specifies whether to remove the task associated with this 5221 * activity. 5222 */ 5223 private void finish(int finishTask) { 5224 if (mParent == null) { 5225 int resultCode; 5226 Intent resultData; 5227 synchronized (this) { 5228 resultCode = mResultCode; 5229 resultData = mResultData; 5230 } 5231 if (false) Log.v(TAG, "Finishing self: token=" + mToken); 5232 try { 5233 if (resultData != null) { 5234 resultData.prepareToLeaveProcess(this); 5235 } 5236 if (ActivityManagerNative.getDefault() 5237 .finishActivity(mToken, resultCode, resultData, finishTask)) { 5238 mFinished = true; 5239 } 5240 } catch (RemoteException e) { 5241 // Empty 5242 } 5243 } else { 5244 mParent.finishFromChild(this); 5245 } 5246 } 5247 5248 /** 5249 * Call this when your activity is done and should be closed. The 5250 * ActivityResult is propagated back to whoever launched you via 5251 * onActivityResult(). 5252 */ 5253 public void finish() { 5254 finish(DONT_FINISH_TASK_WITH_ACTIVITY); 5255 } 5256 5257 /** 5258 * Finish this activity as well as all activities immediately below it 5259 * in the current task that have the same affinity. This is typically 5260 * used when an application can be launched on to another task (such as 5261 * from an ACTION_VIEW of a content type it understands) and the user 5262 * has used the up navigation to switch out of the current task and in 5263 * to its own task. In this case, if the user has navigated down into 5264 * any other activities of the second application, all of those should 5265 * be removed from the original task as part of the task switch. 5266 * 5267 * <p>Note that this finish does <em>not</em> allow you to deliver results 5268 * to the previous activity, and an exception will be thrown if you are trying 5269 * to do so.</p> 5270 */ 5271 public void finishAffinity() { 5272 if (mParent != null) { 5273 throw new IllegalStateException("Can not be called from an embedded activity"); 5274 } 5275 if (mResultCode != RESULT_CANCELED || mResultData != null) { 5276 throw new IllegalStateException("Can not be called to deliver a result"); 5277 } 5278 try { 5279 if (ActivityManagerNative.getDefault().finishActivityAffinity(mToken)) { 5280 mFinished = true; 5281 } 5282 } catch (RemoteException e) { 5283 // Empty 5284 } 5285 } 5286 5287 /** 5288 * This is called when a child activity of this one calls its 5289 * {@link #finish} method. The default implementation simply calls 5290 * finish() on this activity (the parent), finishing the entire group. 5291 * 5292 * @param child The activity making the call. 5293 * 5294 * @see #finish 5295 */ 5296 public void finishFromChild(Activity child) { 5297 finish(); 5298 } 5299 5300 /** 5301 * Reverses the Activity Scene entry Transition and triggers the calling Activity 5302 * to reverse its exit Transition. When the exit Transition completes, 5303 * {@link #finish()} is called. If no entry Transition was used, finish() is called 5304 * immediately and the Activity exit Transition is run. 5305 * @see android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, android.util.Pair[]) 5306 */ 5307 public void finishAfterTransition() { 5308 if (!mActivityTransitionState.startExitBackTransition(this)) { 5309 finish(); 5310 } 5311 } 5312 5313 /** 5314 * Force finish another activity that you had previously started with 5315 * {@link #startActivityForResult}. 5316 * 5317 * @param requestCode The request code of the activity that you had 5318 * given to startActivityForResult(). If there are multiple 5319 * activities started with this request code, they 5320 * will all be finished. 5321 */ 5322 public void finishActivity(int requestCode) { 5323 if (mParent == null) { 5324 try { 5325 ActivityManagerNative.getDefault() 5326 .finishSubActivity(mToken, mEmbeddedID, requestCode); 5327 } catch (RemoteException e) { 5328 // Empty 5329 } 5330 } else { 5331 mParent.finishActivityFromChild(this, requestCode); 5332 } 5333 } 5334 5335 /** 5336 * This is called when a child activity of this one calls its 5337 * finishActivity(). 5338 * 5339 * @param child The activity making the call. 5340 * @param requestCode Request code that had been used to start the 5341 * activity. 5342 */ 5343 public void finishActivityFromChild(@NonNull Activity child, int requestCode) { 5344 try { 5345 ActivityManagerNative.getDefault() 5346 .finishSubActivity(mToken, child.mEmbeddedID, requestCode); 5347 } catch (RemoteException e) { 5348 // Empty 5349 } 5350 } 5351 5352 /** 5353 * Call this when your activity is done and should be closed and the task should be completely 5354 * removed as a part of finishing the root activity of the task. 5355 */ 5356 public void finishAndRemoveTask() { 5357 finish(FINISH_TASK_WITH_ROOT_ACTIVITY); 5358 } 5359 5360 /** 5361 * Ask that the local app instance of this activity be released to free up its memory. 5362 * This is asking for the activity to be destroyed, but does <b>not</b> finish the activity -- 5363 * a new instance of the activity will later be re-created if needed due to the user 5364 * navigating back to it. 5365 * 5366 * @return Returns true if the activity was in a state that it has started the process 5367 * of destroying its current instance; returns false if for any reason this could not 5368 * be done: it is currently visible to the user, it is already being destroyed, it is 5369 * being finished, it hasn't yet saved its state, etc. 5370 */ 5371 public boolean releaseInstance() { 5372 try { 5373 return ActivityManagerNative.getDefault().releaseActivityInstance(mToken); 5374 } catch (RemoteException e) { 5375 // Empty 5376 } 5377 return false; 5378 } 5379 5380 /** 5381 * Called when an activity you launched exits, giving you the requestCode 5382 * you started it with, the resultCode it returned, and any additional 5383 * data from it. The <var>resultCode</var> will be 5384 * {@link #RESULT_CANCELED} if the activity explicitly returned that, 5385 * didn't return any result, or crashed during its operation. 5386 * 5387 * <p>You will receive this call immediately before onResume() when your 5388 * activity is re-starting. 5389 * 5390 * <p>This method is never invoked if your activity sets 5391 * {@link android.R.styleable#AndroidManifestActivity_noHistory noHistory} to 5392 * <code>true</code>. 5393 * 5394 * @param requestCode The integer request code originally supplied to 5395 * startActivityForResult(), allowing you to identify who this 5396 * result came from. 5397 * @param resultCode The integer result code returned by the child activity 5398 * through its setResult(). 5399 * @param data An Intent, which can return result data to the caller 5400 * (various data can be attached to Intent "extras"). 5401 * 5402 * @see #startActivityForResult 5403 * @see #createPendingResult 5404 * @see #setResult(int) 5405 */ 5406 protected void onActivityResult(int requestCode, int resultCode, Intent data) { 5407 } 5408 5409 /** 5410 * Called when an activity you launched with an activity transition exposes this 5411 * Activity through a returning activity transition, giving you the resultCode 5412 * and any additional data from it. This method will only be called if the activity 5413 * set a result code other than {@link #RESULT_CANCELED} and it supports activity 5414 * transitions with {@link Window#FEATURE_ACTIVITY_TRANSITIONS}. 5415 * 5416 * <p>The purpose of this function is to let the called Activity send a hint about 5417 * its state so that this underlying Activity can prepare to be exposed. A call to 5418 * this method does not guarantee that the called Activity has or will be exiting soon. 5419 * It only indicates that it will expose this Activity's Window and it has 5420 * some data to pass to prepare it.</p> 5421 * 5422 * @param resultCode The integer result code returned by the child activity 5423 * through its setResult(). 5424 * @param data An Intent, which can return result data to the caller 5425 * (various data can be attached to Intent "extras"). 5426 */ 5427 public void onActivityReenter(int resultCode, Intent data) { 5428 } 5429 5430 /** 5431 * Create a new PendingIntent object which you can hand to others 5432 * for them to use to send result data back to your 5433 * {@link #onActivityResult} callback. The created object will be either 5434 * one-shot (becoming invalid after a result is sent back) or multiple 5435 * (allowing any number of results to be sent through it). 5436 * 5437 * @param requestCode Private request code for the sender that will be 5438 * associated with the result data when it is returned. The sender can not 5439 * modify this value, allowing you to identify incoming results. 5440 * @param data Default data to supply in the result, which may be modified 5441 * by the sender. 5442 * @param flags May be {@link PendingIntent#FLAG_ONE_SHOT PendingIntent.FLAG_ONE_SHOT}, 5443 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE}, 5444 * {@link PendingIntent#FLAG_CANCEL_CURRENT PendingIntent.FLAG_CANCEL_CURRENT}, 5445 * {@link PendingIntent#FLAG_UPDATE_CURRENT PendingIntent.FLAG_UPDATE_CURRENT}, 5446 * or any of the flags as supported by 5447 * {@link Intent#fillIn Intent.fillIn()} to control which unspecified parts 5448 * of the intent that can be supplied when the actual send happens. 5449 * 5450 * @return Returns an existing or new PendingIntent matching the given 5451 * parameters. May return null only if 5452 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE} has been 5453 * supplied. 5454 * 5455 * @see PendingIntent 5456 */ 5457 public PendingIntent createPendingResult(int requestCode, @NonNull Intent data, 5458 @PendingIntent.Flags int flags) { 5459 String packageName = getPackageName(); 5460 try { 5461 data.prepareToLeaveProcess(this); 5462 IIntentSender target = 5463 ActivityManagerNative.getDefault().getIntentSender( 5464 ActivityManager.INTENT_SENDER_ACTIVITY_RESULT, packageName, 5465 mParent == null ? mToken : mParent.mToken, 5466 mEmbeddedID, requestCode, new Intent[] { data }, null, flags, null, 5467 UserHandle.myUserId()); 5468 return target != null ? new PendingIntent(target) : null; 5469 } catch (RemoteException e) { 5470 // Empty 5471 } 5472 return null; 5473 } 5474 5475 /** 5476 * Change the desired orientation of this activity. If the activity 5477 * is currently in the foreground or otherwise impacting the screen 5478 * orientation, the screen will immediately be changed (possibly causing 5479 * the activity to be restarted). Otherwise, this will be used the next 5480 * time the activity is visible. 5481 * 5482 * @param requestedOrientation An orientation constant as used in 5483 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}. 5484 */ 5485 public void setRequestedOrientation(@ActivityInfo.ScreenOrientation int requestedOrientation) { 5486 if (mParent == null) { 5487 try { 5488 ActivityManagerNative.getDefault().setRequestedOrientation( 5489 mToken, requestedOrientation); 5490 } catch (RemoteException e) { 5491 // Empty 5492 } 5493 } else { 5494 mParent.setRequestedOrientation(requestedOrientation); 5495 } 5496 } 5497 5498 /** 5499 * Return the current requested orientation of the activity. This will 5500 * either be the orientation requested in its component's manifest, or 5501 * the last requested orientation given to 5502 * {@link #setRequestedOrientation(int)}. 5503 * 5504 * @return Returns an orientation constant as used in 5505 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}. 5506 */ 5507 @ActivityInfo.ScreenOrientation 5508 public int getRequestedOrientation() { 5509 if (mParent == null) { 5510 try { 5511 return ActivityManagerNative.getDefault() 5512 .getRequestedOrientation(mToken); 5513 } catch (RemoteException e) { 5514 // Empty 5515 } 5516 } else { 5517 return mParent.getRequestedOrientation(); 5518 } 5519 return ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED; 5520 } 5521 5522 /** 5523 * Return the identifier of the task this activity is in. This identifier 5524 * will remain the same for the lifetime of the activity. 5525 * 5526 * @return Task identifier, an opaque integer. 5527 */ 5528 public int getTaskId() { 5529 try { 5530 return ActivityManagerNative.getDefault() 5531 .getTaskForActivity(mToken, false); 5532 } catch (RemoteException e) { 5533 return -1; 5534 } 5535 } 5536 5537 /** 5538 * Return whether this activity is the root of a task. The root is the 5539 * first activity in a task. 5540 * 5541 * @return True if this is the root activity, else false. 5542 */ 5543 public boolean isTaskRoot() { 5544 try { 5545 return ActivityManagerNative.getDefault().getTaskForActivity(mToken, true) >= 0; 5546 } catch (RemoteException e) { 5547 return false; 5548 } 5549 } 5550 5551 /** 5552 * Move the task containing this activity to the back of the activity 5553 * stack. The activity's order within the task is unchanged. 5554 * 5555 * @param nonRoot If false then this only works if the activity is the root 5556 * of a task; if true it will work for any activity in 5557 * a task. 5558 * 5559 * @return If the task was moved (or it was already at the 5560 * back) true is returned, else false. 5561 */ 5562 public boolean moveTaskToBack(boolean nonRoot) { 5563 try { 5564 return ActivityManagerNative.getDefault().moveActivityTaskToBack( 5565 mToken, nonRoot); 5566 } catch (RemoteException e) { 5567 // Empty 5568 } 5569 return false; 5570 } 5571 5572 /** 5573 * Returns class name for this activity with the package prefix removed. 5574 * This is the default name used to read and write settings. 5575 * 5576 * @return The local class name. 5577 */ 5578 @NonNull 5579 public String getLocalClassName() { 5580 final String pkg = getPackageName(); 5581 final String cls = mComponent.getClassName(); 5582 int packageLen = pkg.length(); 5583 if (!cls.startsWith(pkg) || cls.length() <= packageLen 5584 || cls.charAt(packageLen) != '.') { 5585 return cls; 5586 } 5587 return cls.substring(packageLen+1); 5588 } 5589 5590 /** 5591 * Returns complete component name of this activity. 5592 * 5593 * @return Returns the complete component name for this activity 5594 */ 5595 public ComponentName getComponentName() 5596 { 5597 return mComponent; 5598 } 5599 5600 /** 5601 * Retrieve a {@link SharedPreferences} object for accessing preferences 5602 * that are private to this activity. This simply calls the underlying 5603 * {@link #getSharedPreferences(String, int)} method by passing in this activity's 5604 * class name as the preferences name. 5605 * 5606 * @param mode Operating mode. Use {@link #MODE_PRIVATE} for the default 5607 * operation. 5608 * 5609 * @return Returns the single SharedPreferences instance that can be used 5610 * to retrieve and modify the preference values. 5611 */ 5612 public SharedPreferences getPreferences(int mode) { 5613 return getSharedPreferences(getLocalClassName(), mode); 5614 } 5615 5616 private void ensureSearchManager() { 5617 if (mSearchManager != null) { 5618 return; 5619 } 5620 5621 try { 5622 mSearchManager = new SearchManager(this, null); 5623 } catch (ServiceNotFoundException e) { 5624 throw new IllegalStateException(e); 5625 } 5626 } 5627 5628 @Override 5629 public Object getSystemService(@ServiceName @NonNull String name) { 5630 if (getBaseContext() == null) { 5631 throw new IllegalStateException( 5632 "System services not available to Activities before onCreate()"); 5633 } 5634 5635 if (WINDOW_SERVICE.equals(name)) { 5636 return mWindowManager; 5637 } else if (SEARCH_SERVICE.equals(name)) { 5638 ensureSearchManager(); 5639 return mSearchManager; 5640 } 5641 return super.getSystemService(name); 5642 } 5643 5644 /** 5645 * Change the title associated with this activity. If this is a 5646 * top-level activity, the title for its window will change. If it 5647 * is an embedded activity, the parent can do whatever it wants 5648 * with it. 5649 */ 5650 public void setTitle(CharSequence title) { 5651 mTitle = title; 5652 onTitleChanged(title, mTitleColor); 5653 5654 if (mParent != null) { 5655 mParent.onChildTitleChanged(this, title); 5656 } 5657 } 5658 5659 /** 5660 * Change the title associated with this activity. If this is a 5661 * top-level activity, the title for its window will change. If it 5662 * is an embedded activity, the parent can do whatever it wants 5663 * with it. 5664 */ 5665 public void setTitle(int titleId) { 5666 setTitle(getText(titleId)); 5667 } 5668 5669 /** 5670 * Change the color of the title associated with this activity. 5671 * <p> 5672 * This method is deprecated starting in API Level 11 and replaced by action 5673 * bar styles. For information on styling the Action Bar, read the <a 5674 * href="{@docRoot} guide/topics/ui/actionbar.html">Action Bar</a> developer 5675 * guide. 5676 * 5677 * @deprecated Use action bar styles instead. 5678 */ 5679 @Deprecated 5680 public void setTitleColor(int textColor) { 5681 mTitleColor = textColor; 5682 onTitleChanged(mTitle, textColor); 5683 } 5684 5685 public final CharSequence getTitle() { 5686 return mTitle; 5687 } 5688 5689 public final int getTitleColor() { 5690 return mTitleColor; 5691 } 5692 5693 protected void onTitleChanged(CharSequence title, int color) { 5694 if (mTitleReady) { 5695 final Window win = getWindow(); 5696 if (win != null) { 5697 win.setTitle(title); 5698 if (color != 0) { 5699 win.setTitleColor(color); 5700 } 5701 } 5702 if (mActionBar != null) { 5703 mActionBar.setWindowTitle(title); 5704 } 5705 } 5706 } 5707 5708 protected void onChildTitleChanged(Activity childActivity, CharSequence title) { 5709 } 5710 5711 /** 5712 * Sets information describing the task with this activity for presentation inside the Recents 5713 * System UI. When {@link ActivityManager#getRecentTasks} is called, the activities of each task 5714 * are traversed in order from the topmost activity to the bottommost. The traversal continues 5715 * for each property until a suitable value is found. For each task the taskDescription will be 5716 * returned in {@link android.app.ActivityManager.TaskDescription}. 5717 * 5718 * @see ActivityManager#getRecentTasks 5719 * @see android.app.ActivityManager.TaskDescription 5720 * 5721 * @param taskDescription The TaskDescription properties that describe the task with this activity 5722 */ 5723 public void setTaskDescription(ActivityManager.TaskDescription taskDescription) { 5724 if (mTaskDescription != taskDescription) { 5725 mTaskDescription.copyFrom(taskDescription); 5726 // Scale the icon down to something reasonable if it is provided 5727 if (taskDescription.getIconFilename() == null && taskDescription.getIcon() != null) { 5728 final int size = ActivityManager.getLauncherLargeIconSizeInner(this); 5729 final Bitmap icon = Bitmap.createScaledBitmap(taskDescription.getIcon(), size, size, 5730 true); 5731 mTaskDescription.setIcon(icon); 5732 } 5733 } 5734 try { 5735 ActivityManagerNative.getDefault().setTaskDescription(mToken, mTaskDescription); 5736 } catch (RemoteException e) { 5737 } 5738 } 5739 5740 /** 5741 * Sets the visibility of the progress bar in the title. 5742 * <p> 5743 * In order for the progress bar to be shown, the feature must be requested 5744 * via {@link #requestWindowFeature(int)}. 5745 * 5746 * @param visible Whether to show the progress bars in the title. 5747 * @deprecated No longer supported starting in API 21. 5748 */ 5749 @Deprecated 5750 public final void setProgressBarVisibility(boolean visible) { 5751 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, visible ? Window.PROGRESS_VISIBILITY_ON : 5752 Window.PROGRESS_VISIBILITY_OFF); 5753 } 5754 5755 /** 5756 * Sets the visibility of the indeterminate progress bar in the title. 5757 * <p> 5758 * In order for the progress bar to be shown, the feature must be requested 5759 * via {@link #requestWindowFeature(int)}. 5760 * 5761 * @param visible Whether to show the progress bars in the title. 5762 * @deprecated No longer supported starting in API 21. 5763 */ 5764 @Deprecated 5765 public final void setProgressBarIndeterminateVisibility(boolean visible) { 5766 getWindow().setFeatureInt(Window.FEATURE_INDETERMINATE_PROGRESS, 5767 visible ? Window.PROGRESS_VISIBILITY_ON : Window.PROGRESS_VISIBILITY_OFF); 5768 } 5769 5770 /** 5771 * Sets whether the horizontal progress bar in the title should be indeterminate (the circular 5772 * is always indeterminate). 5773 * <p> 5774 * In order for the progress bar to be shown, the feature must be requested 5775 * via {@link #requestWindowFeature(int)}. 5776 * 5777 * @param indeterminate Whether the horizontal progress bar should be indeterminate. 5778 * @deprecated No longer supported starting in API 21. 5779 */ 5780 @Deprecated 5781 public final void setProgressBarIndeterminate(boolean indeterminate) { 5782 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, 5783 indeterminate ? Window.PROGRESS_INDETERMINATE_ON 5784 : Window.PROGRESS_INDETERMINATE_OFF); 5785 } 5786 5787 /** 5788 * Sets the progress for the progress bars in the title. 5789 * <p> 5790 * In order for the progress bar to be shown, the feature must be requested 5791 * via {@link #requestWindowFeature(int)}. 5792 * 5793 * @param progress The progress for the progress bar. Valid ranges are from 5794 * 0 to 10000 (both inclusive). If 10000 is given, the progress 5795 * bar will be completely filled and will fade out. 5796 * @deprecated No longer supported starting in API 21. 5797 */ 5798 @Deprecated 5799 public final void setProgress(int progress) { 5800 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, progress + Window.PROGRESS_START); 5801 } 5802 5803 /** 5804 * Sets the secondary progress for the progress bar in the title. This 5805 * progress is drawn between the primary progress (set via 5806 * {@link #setProgress(int)} and the background. It can be ideal for media 5807 * scenarios such as showing the buffering progress while the default 5808 * progress shows the play progress. 5809 * <p> 5810 * In order for the progress bar to be shown, the feature must be requested 5811 * via {@link #requestWindowFeature(int)}. 5812 * 5813 * @param secondaryProgress The secondary progress for the progress bar. Valid ranges are from 5814 * 0 to 10000 (both inclusive). 5815 * @deprecated No longer supported starting in API 21. 5816 */ 5817 @Deprecated 5818 public final void setSecondaryProgress(int secondaryProgress) { 5819 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, 5820 secondaryProgress + Window.PROGRESS_SECONDARY_START); 5821 } 5822 5823 /** 5824 * Suggests an audio stream whose volume should be changed by the hardware 5825 * volume controls. 5826 * <p> 5827 * The suggested audio stream will be tied to the window of this Activity. 5828 * Volume requests which are received while the Activity is in the 5829 * foreground will affect this stream. 5830 * <p> 5831 * It is not guaranteed that the hardware volume controls will always change 5832 * this stream's volume (for example, if a call is in progress, its stream's 5833 * volume may be changed instead). To reset back to the default, use 5834 * {@link AudioManager#USE_DEFAULT_STREAM_TYPE}. 5835 * 5836 * @param streamType The type of the audio stream whose volume should be 5837 * changed by the hardware volume controls. 5838 */ 5839 public final void setVolumeControlStream(int streamType) { 5840 getWindow().setVolumeControlStream(streamType); 5841 } 5842 5843 /** 5844 * Gets the suggested audio stream whose volume should be changed by the 5845 * hardware volume controls. 5846 * 5847 * @return The suggested audio stream type whose volume should be changed by 5848 * the hardware volume controls. 5849 * @see #setVolumeControlStream(int) 5850 */ 5851 public final int getVolumeControlStream() { 5852 return getWindow().getVolumeControlStream(); 5853 } 5854 5855 /** 5856 * Sets a {@link MediaController} to send media keys and volume changes to. 5857 * <p> 5858 * The controller will be tied to the window of this Activity. Media key and 5859 * volume events which are received while the Activity is in the foreground 5860 * will be forwarded to the controller and used to invoke transport controls 5861 * or adjust the volume. This may be used instead of or in addition to 5862 * {@link #setVolumeControlStream} to affect a specific session instead of a 5863 * specific stream. 5864 * <p> 5865 * It is not guaranteed that the hardware volume controls will always change 5866 * this session's volume (for example, if a call is in progress, its 5867 * stream's volume may be changed instead). To reset back to the default use 5868 * null as the controller. 5869 * 5870 * @param controller The controller for the session which should receive 5871 * media keys and volume changes. 5872 */ 5873 public final void setMediaController(MediaController controller) { 5874 getWindow().setMediaController(controller); 5875 } 5876 5877 /** 5878 * Gets the controller which should be receiving media key and volume events 5879 * while this activity is in the foreground. 5880 * 5881 * @return The controller which should receive events. 5882 * @see #setMediaController(android.media.session.MediaController) 5883 */ 5884 public final MediaController getMediaController() { 5885 return getWindow().getMediaController(); 5886 } 5887 5888 /** 5889 * Runs the specified action on the UI thread. If the current thread is the UI 5890 * thread, then the action is executed immediately. If the current thread is 5891 * not the UI thread, the action is posted to the event queue of the UI thread. 5892 * 5893 * @param action the action to run on the UI thread 5894 */ 5895 public final void runOnUiThread(Runnable action) { 5896 if (Thread.currentThread() != mUiThread) { 5897 mHandler.post(action); 5898 } else { 5899 action.run(); 5900 } 5901 } 5902 5903 /** 5904 * Standard implementation of 5905 * {@link android.view.LayoutInflater.Factory#onCreateView} used when 5906 * inflating with the LayoutInflater returned by {@link #getSystemService}. 5907 * This implementation does nothing and is for 5908 * pre-{@link android.os.Build.VERSION_CODES#HONEYCOMB} apps. Newer apps 5909 * should use {@link #onCreateView(View, String, Context, AttributeSet)}. 5910 * 5911 * @see android.view.LayoutInflater#createView 5912 * @see android.view.Window#getLayoutInflater 5913 */ 5914 @Nullable 5915 public View onCreateView(String name, Context context, AttributeSet attrs) { 5916 return null; 5917 } 5918 5919 /** 5920 * Standard implementation of 5921 * {@link android.view.LayoutInflater.Factory2#onCreateView(View, String, Context, AttributeSet)} 5922 * used when inflating with the LayoutInflater returned by {@link #getSystemService}. 5923 * This implementation handles <fragment> tags to embed fragments inside 5924 * of the activity. 5925 * 5926 * @see android.view.LayoutInflater#createView 5927 * @see android.view.Window#getLayoutInflater 5928 */ 5929 public View onCreateView(View parent, String name, Context context, AttributeSet attrs) { 5930 if (!"fragment".equals(name)) { 5931 return onCreateView(name, context, attrs); 5932 } 5933 5934 return mFragments.onCreateView(parent, name, context, attrs); 5935 } 5936 5937 /** 5938 * Print the Activity's state into the given stream. This gets invoked if 5939 * you run "adb shell dumpsys activity <activity_component_name>". 5940 * 5941 * @param prefix Desired prefix to prepend at each line of output. 5942 * @param fd The raw file descriptor that the dump is being sent to. 5943 * @param writer The PrintWriter to which you should dump your state. This will be 5944 * closed for you after you return. 5945 * @param args additional arguments to the dump request. 5946 */ 5947 public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) { 5948 dumpInner(prefix, fd, writer, args); 5949 } 5950 5951 void dumpInner(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) { 5952 writer.print(prefix); writer.print("Local Activity "); 5953 writer.print(Integer.toHexString(System.identityHashCode(this))); 5954 writer.println(" State:"); 5955 String innerPrefix = prefix + " "; 5956 writer.print(innerPrefix); writer.print("mResumed="); 5957 writer.print(mResumed); writer.print(" mStopped="); 5958 writer.print(mStopped); writer.print(" mFinished="); 5959 writer.println(mFinished); 5960 writer.print(innerPrefix); writer.print("mChangingConfigurations="); 5961 writer.println(mChangingConfigurations); 5962 writer.print(innerPrefix); writer.print("mCurrentConfig="); 5963 writer.println(mCurrentConfig); 5964 5965 mFragments.dumpLoaders(innerPrefix, fd, writer, args); 5966 mFragments.getFragmentManager().dump(innerPrefix, fd, writer, args); 5967 if (mVoiceInteractor != null) { 5968 mVoiceInteractor.dump(innerPrefix, fd, writer, args); 5969 } 5970 5971 if (getWindow() != null && 5972 getWindow().peekDecorView() != null && 5973 getWindow().peekDecorView().getViewRootImpl() != null) { 5974 getWindow().peekDecorView().getViewRootImpl().dump(prefix, fd, writer, args); 5975 } 5976 5977 mHandler.getLooper().dump(new PrintWriterPrinter(writer), prefix); 5978 } 5979 5980 /** 5981 * Bit indicating that this activity is "immersive" and should not be 5982 * interrupted by notifications if possible. 5983 * 5984 * This value is initially set by the manifest property 5985 * <code>android:immersive</code> but may be changed at runtime by 5986 * {@link #setImmersive}. 5987 * 5988 * @see #setImmersive(boolean) 5989 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE 5990 */ 5991 public boolean isImmersive() { 5992 try { 5993 return ActivityManagerNative.getDefault().isImmersive(mToken); 5994 } catch (RemoteException e) { 5995 return false; 5996 } 5997 } 5998 5999 /** 6000 * Indication of whether this is the highest level activity in this task. Can be used to 6001 * determine whether an activity launched by this activity was placed in the same task or 6002 * another task. 6003 * 6004 * @return true if this is the topmost, non-finishing activity in its task. 6005 */ 6006 private boolean isTopOfTask() { 6007 if (mToken == null || mWindow == null) { 6008 return false; 6009 } 6010 try { 6011 return ActivityManagerNative.getDefault().isTopOfTask(getActivityToken()); 6012 } catch (RemoteException e) { 6013 return false; 6014 } 6015 } 6016 6017 /** 6018 * Convert a translucent themed Activity {@link android.R.attr#windowIsTranslucent} to a 6019 * fullscreen opaque Activity. 6020 * <p> 6021 * Call this whenever the background of a translucent Activity has changed to become opaque. 6022 * Doing so will allow the {@link android.view.Surface} of the Activity behind to be released. 6023 * <p> 6024 * This call has no effect on non-translucent activities or on activities with the 6025 * {@link android.R.attr#windowIsFloating} attribute. 6026 * 6027 * @see #convertToTranslucent(android.app.Activity.TranslucentConversionListener, 6028 * ActivityOptions) 6029 * @see TranslucentConversionListener 6030 * 6031 * @hide 6032 */ 6033 @SystemApi 6034 public void convertFromTranslucent() { 6035 try { 6036 mTranslucentCallback = null; 6037 if (ActivityManagerNative.getDefault().convertFromTranslucent(mToken)) { 6038 WindowManagerGlobal.getInstance().changeCanvasOpacity(mToken, true); 6039 } 6040 } catch (RemoteException e) { 6041 // pass 6042 } 6043 } 6044 6045 /** 6046 * Convert a translucent themed Activity {@link android.R.attr#windowIsTranslucent} back from 6047 * opaque to translucent following a call to {@link #convertFromTranslucent()}. 6048 * <p> 6049 * Calling this allows the Activity behind this one to be seen again. Once all such Activities 6050 * have been redrawn {@link TranslucentConversionListener#onTranslucentConversionComplete} will 6051 * be called indicating that it is safe to make this activity translucent again. Until 6052 * {@link TranslucentConversionListener#onTranslucentConversionComplete} is called the image 6053 * behind the frontmost Activity will be indeterminate. 6054 * <p> 6055 * This call has no effect on non-translucent activities or on activities with the 6056 * {@link android.R.attr#windowIsFloating} attribute. 6057 * 6058 * @param callback the method to call when all visible Activities behind this one have been 6059 * drawn and it is safe to make this Activity translucent again. 6060 * @param options activity options delivered to the activity below this one. The options 6061 * are retrieved using {@link #getActivityOptions}. 6062 * @return <code>true</code> if Window was opaque and will become translucent or 6063 * <code>false</code> if window was translucent and no change needed to be made. 6064 * 6065 * @see #convertFromTranslucent() 6066 * @see TranslucentConversionListener 6067 * 6068 * @hide 6069 */ 6070 @SystemApi 6071 public boolean convertToTranslucent(TranslucentConversionListener callback, 6072 ActivityOptions options) { 6073 boolean drawComplete; 6074 try { 6075 mTranslucentCallback = callback; 6076 mChangeCanvasToTranslucent = ActivityManagerNative.getDefault().convertToTranslucent( 6077 mToken, options == null ? null : options.toBundle()); 6078 WindowManagerGlobal.getInstance().changeCanvasOpacity(mToken, false); 6079 drawComplete = true; 6080 } catch (RemoteException e) { 6081 // Make callback return as though it timed out. 6082 mChangeCanvasToTranslucent = false; 6083 drawComplete = false; 6084 } 6085 if (!mChangeCanvasToTranslucent && mTranslucentCallback != null) { 6086 // Window is already translucent. 6087 mTranslucentCallback.onTranslucentConversionComplete(drawComplete); 6088 } 6089 return mChangeCanvasToTranslucent; 6090 } 6091 6092 /** @hide */ 6093 void onTranslucentConversionComplete(boolean drawComplete) { 6094 if (mTranslucentCallback != null) { 6095 mTranslucentCallback.onTranslucentConversionComplete(drawComplete); 6096 mTranslucentCallback = null; 6097 } 6098 if (mChangeCanvasToTranslucent) { 6099 WindowManagerGlobal.getInstance().changeCanvasOpacity(mToken, false); 6100 } 6101 } 6102 6103 /** @hide */ 6104 public void onNewActivityOptions(ActivityOptions options) { 6105 mActivityTransitionState.setEnterActivityOptions(this, options); 6106 if (!mStopped) { 6107 mActivityTransitionState.enterReady(this); 6108 } 6109 } 6110 6111 /** 6112 * Retrieve the ActivityOptions passed in from the launching activity or passed back 6113 * from an activity launched by this activity in its call to {@link 6114 * #convertToTranslucent(TranslucentConversionListener, ActivityOptions)} 6115 * 6116 * @return The ActivityOptions passed to {@link #convertToTranslucent}. 6117 * @hide 6118 */ 6119 ActivityOptions getActivityOptions() { 6120 try { 6121 return ActivityOptions.fromBundle( 6122 ActivityManagerNative.getDefault().getActivityOptions(mToken)); 6123 } catch (RemoteException e) { 6124 } 6125 return null; 6126 } 6127 6128 /** 6129 * Activities that want to remain visible behind a translucent activity above them must call 6130 * this method anytime between the start of {@link #onResume()} and the return from 6131 * {@link #onPause()}. If this call is successful then the activity will remain visible after 6132 * {@link #onPause()} is called, and is allowed to continue playing media in the background. 6133 * 6134 * <p>The actions of this call are reset each time that this activity is brought to the 6135 * front. That is, every time {@link #onResume()} is called the activity will be assumed 6136 * to not have requested visible behind. Therefore, if you want this activity to continue to 6137 * be visible in the background you must call this method again. 6138 * 6139 * <p>Only fullscreen opaque activities may make this call. I.e. this call is a nop 6140 * for dialog and translucent activities. 6141 * 6142 * <p>Under all circumstances, the activity must stop playing and release resources prior to or 6143 * within a call to {@link #onVisibleBehindCanceled()} or if this call returns false. 6144 * 6145 * <p>False will be returned any time this method is called between the return of onPause and 6146 * the next call to onResume. 6147 * 6148 * @param visible true to notify the system that the activity wishes to be visible behind other 6149 * translucent activities, false to indicate otherwise. Resources must be 6150 * released when passing false to this method. 6151 * @return the resulting visibiity state. If true the activity will remain visible beyond 6152 * {@link #onPause()} if the next activity is translucent or not fullscreen. If false 6153 * then the activity may not count on being visible behind other translucent activities, 6154 * and must stop any media playback and release resources. 6155 * Returning false may occur in lieu of a call to {@link #onVisibleBehindCanceled()} so 6156 * the return value must be checked. 6157 * 6158 * @see #onVisibleBehindCanceled() 6159 */ 6160 public boolean requestVisibleBehind(boolean visible) { 6161 if (!mResumed) { 6162 // Do not permit paused or stopped activities to do this. 6163 visible = false; 6164 } 6165 try { 6166 mVisibleBehind = ActivityManagerNative.getDefault() 6167 .requestVisibleBehind(mToken, visible) && visible; 6168 } catch (RemoteException e) { 6169 mVisibleBehind = false; 6170 } 6171 return mVisibleBehind; 6172 } 6173 6174 /** 6175 * Called when a translucent activity over this activity is becoming opaque or another 6176 * activity is being launched. Activities that override this method must call 6177 * <code>super.onVisibleBehindCanceled()</code> or a SuperNotCalledException will be thrown. 6178 * 6179 * <p>When this method is called the activity has 500 msec to release any resources it may be 6180 * using while visible in the background. 6181 * If the activity has not returned from this method in 500 msec the system will destroy 6182 * the activity and kill the process in order to recover the resources for another 6183 * process. Otherwise {@link #onStop()} will be called following return. 6184 * 6185 * @see #requestVisibleBehind(boolean) 6186 */ 6187 @CallSuper 6188 public void onVisibleBehindCanceled() { 6189 mCalled = true; 6190 } 6191 6192 /** 6193 * Translucent activities may call this to determine if there is an activity below them that 6194 * is currently set to be visible in the background. 6195 * 6196 * @return true if an activity below is set to visible according to the most recent call to 6197 * {@link #requestVisibleBehind(boolean)}, false otherwise. 6198 * 6199 * @see #requestVisibleBehind(boolean) 6200 * @see #onVisibleBehindCanceled() 6201 * @see #onBackgroundVisibleBehindChanged(boolean) 6202 * @hide 6203 */ 6204 @SystemApi 6205 public boolean isBackgroundVisibleBehind() { 6206 try { 6207 return ActivityManagerNative.getDefault().isBackgroundVisibleBehind(mToken); 6208 } catch (RemoteException e) { 6209 } 6210 return false; 6211 } 6212 6213 /** 6214 * The topmost foreground activity will receive this call when the background visibility state 6215 * of the activity below it changes. 6216 * 6217 * This call may be a consequence of {@link #requestVisibleBehind(boolean)} or might be 6218 * due to a background activity finishing itself. 6219 * 6220 * @param visible true if a background activity is visible, false otherwise. 6221 * 6222 * @see #requestVisibleBehind(boolean) 6223 * @see #onVisibleBehindCanceled() 6224 * @hide 6225 */ 6226 @SystemApi 6227 public void onBackgroundVisibleBehindChanged(boolean visible) { 6228 } 6229 6230 /** 6231 * Activities cannot draw during the period that their windows are animating in. In order 6232 * to know when it is safe to begin drawing they can override this method which will be 6233 * called when the entering animation has completed. 6234 */ 6235 public void onEnterAnimationComplete() { 6236 } 6237 6238 /** 6239 * @hide 6240 */ 6241 public void dispatchEnterAnimationComplete() { 6242 onEnterAnimationComplete(); 6243 if (getWindow() != null && getWindow().getDecorView() != null) { 6244 getWindow().getDecorView().getViewTreeObserver().dispatchOnEnterAnimationComplete(); 6245 } 6246 } 6247 6248 /** 6249 * Adjust the current immersive mode setting. 6250 * 6251 * Note that changing this value will have no effect on the activity's 6252 * {@link android.content.pm.ActivityInfo} structure; that is, if 6253 * <code>android:immersive</code> is set to <code>true</code> 6254 * in the application's manifest entry for this activity, the {@link 6255 * android.content.pm.ActivityInfo#flags ActivityInfo.flags} member will 6256 * always have its {@link android.content.pm.ActivityInfo#FLAG_IMMERSIVE 6257 * FLAG_IMMERSIVE} bit set. 6258 * 6259 * @see #isImmersive() 6260 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE 6261 */ 6262 public void setImmersive(boolean i) { 6263 try { 6264 ActivityManagerNative.getDefault().setImmersive(mToken, i); 6265 } catch (RemoteException e) { 6266 // pass 6267 } 6268 } 6269 6270 /** 6271 * Enable or disable virtual reality (VR) mode for this Activity. 6272 * 6273 * <p>VR mode is a hint to Android system to switch to a mode optimized for VR applications 6274 * while this Activity has user focus.</p> 6275 * 6276 * <p>It is recommended that applications additionally declare 6277 * {@link android.R.attr#enableVrMode} in their manifest to allow for smooth activity 6278 * transitions when switching between VR activities.</p> 6279 * 6280 * <p>If the requested {@link android.service.vr.VrListenerService} component is not available, 6281 * VR mode will not be started. Developers can handle this case as follows:</p> 6282 * 6283 * <pre> 6284 * String servicePackage = "com.whatever.app"; 6285 * String serviceClass = "com.whatever.app.MyVrListenerService"; 6286 * 6287 * // Name of the component of the VrListenerService to start. 6288 * ComponentName serviceComponent = new ComponentName(servicePackage, serviceClass); 6289 * 6290 * try { 6291 * setVrModeEnabled(true, myComponentName); 6292 * } catch (PackageManager.NameNotFoundException e) { 6293 * List<ApplicationInfo> installed = getPackageManager().getInstalledApplications(0); 6294 * boolean isInstalled = false; 6295 * for (ApplicationInfo app : installed) { 6296 * if (app.packageName.equals(servicePackage)) { 6297 * isInstalled = true; 6298 * break; 6299 * } 6300 * } 6301 * if (isInstalled) { 6302 * // Package is installed, but not enabled in Settings. Let user enable it. 6303 * startActivity(new Intent(Settings.ACTION_VR_LISTENER_SETTINGS)); 6304 * } else { 6305 * // Package is not installed. Send an intent to download this. 6306 * sentIntentToLaunchAppStore(servicePackage); 6307 * } 6308 * } 6309 * </pre> 6310 * 6311 * @param enabled {@code true} to enable this mode. 6312 * @param requestedComponent the name of the component to use as a 6313 * {@link android.service.vr.VrListenerService} while VR mode is enabled. 6314 * 6315 * @throws android.content.pm.PackageManager.NameNotFoundException if the given component 6316 * to run as a {@link android.service.vr.VrListenerService} is not installed, or has 6317 * not been enabled in user settings. 6318 * 6319 * @see android.content.pm.PackageManager#FEATURE_VR_MODE 6320 * @see android.content.pm.PackageManager#FEATURE_VR_MODE_HIGH_PERFORMANCE 6321 * @see android.service.vr.VrListenerService 6322 * @see android.provider.Settings#ACTION_VR_LISTENER_SETTINGS 6323 * @see android.R.attr#enableVrMode 6324 */ 6325 public void setVrModeEnabled(boolean enabled, @NonNull ComponentName requestedComponent) 6326 throws PackageManager.NameNotFoundException { 6327 try { 6328 if (ActivityManagerNative.getDefault().setVrMode(mToken, enabled, requestedComponent) 6329 != 0) { 6330 throw new PackageManager.NameNotFoundException( 6331 requestedComponent.flattenToString()); 6332 } 6333 } catch (RemoteException e) { 6334 // pass 6335 } 6336 } 6337 6338 /** 6339 * Start an action mode of the default type {@link ActionMode#TYPE_PRIMARY}. 6340 * 6341 * @param callback Callback that will manage lifecycle events for this action mode 6342 * @return The ActionMode that was started, or null if it was canceled 6343 * 6344 * @see ActionMode 6345 */ 6346 @Nullable 6347 public ActionMode startActionMode(ActionMode.Callback callback) { 6348 return mWindow.getDecorView().startActionMode(callback); 6349 } 6350 6351 /** 6352 * Start an action mode of the given type. 6353 * 6354 * @param callback Callback that will manage lifecycle events for this action mode 6355 * @param type One of {@link ActionMode#TYPE_PRIMARY} or {@link ActionMode#TYPE_FLOATING}. 6356 * @return The ActionMode that was started, or null if it was canceled 6357 * 6358 * @see ActionMode 6359 */ 6360 @Nullable 6361 public ActionMode startActionMode(ActionMode.Callback callback, int type) { 6362 return mWindow.getDecorView().startActionMode(callback, type); 6363 } 6364 6365 /** 6366 * Give the Activity a chance to control the UI for an action mode requested 6367 * by the system. 6368 * 6369 * <p>Note: If you are looking for a notification callback that an action mode 6370 * has been started for this activity, see {@link #onActionModeStarted(ActionMode)}.</p> 6371 * 6372 * @param callback The callback that should control the new action mode 6373 * @return The new action mode, or <code>null</code> if the activity does not want to 6374 * provide special handling for this action mode. (It will be handled by the system.) 6375 */ 6376 @Nullable 6377 @Override 6378 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback) { 6379 // Only Primary ActionModes are represented in the ActionBar. 6380 if (mActionModeTypeStarting == ActionMode.TYPE_PRIMARY) { 6381 initWindowDecorActionBar(); 6382 if (mActionBar != null) { 6383 return mActionBar.startActionMode(callback); 6384 } 6385 } 6386 return null; 6387 } 6388 6389 /** 6390 * {@inheritDoc} 6391 */ 6392 @Nullable 6393 @Override 6394 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback, int type) { 6395 try { 6396 mActionModeTypeStarting = type; 6397 return onWindowStartingActionMode(callback); 6398 } finally { 6399 mActionModeTypeStarting = ActionMode.TYPE_PRIMARY; 6400 } 6401 } 6402 6403 /** 6404 * Notifies the Activity that an action mode has been started. 6405 * Activity subclasses overriding this method should call the superclass implementation. 6406 * 6407 * @param mode The new action mode. 6408 */ 6409 @CallSuper 6410 @Override 6411 public void onActionModeStarted(ActionMode mode) { 6412 } 6413 6414 /** 6415 * Notifies the activity that an action mode has finished. 6416 * Activity subclasses overriding this method should call the superclass implementation. 6417 * 6418 * @param mode The action mode that just finished. 6419 */ 6420 @CallSuper 6421 @Override 6422 public void onActionModeFinished(ActionMode mode) { 6423 } 6424 6425 /** 6426 * Returns true if the app should recreate the task when navigating 'up' from this activity 6427 * by using targetIntent. 6428 * 6429 * <p>If this method returns false the app can trivially call 6430 * {@link #navigateUpTo(Intent)} using the same parameters to correctly perform 6431 * up navigation. If this method returns false, the app should synthesize a new task stack 6432 * by using {@link TaskStackBuilder} or another similar mechanism to perform up navigation.</p> 6433 * 6434 * @param targetIntent An intent representing the target destination for up navigation 6435 * @return true if navigating up should recreate a new task stack, false if the same task 6436 * should be used for the destination 6437 */ 6438 public boolean shouldUpRecreateTask(Intent targetIntent) { 6439 try { 6440 PackageManager pm = getPackageManager(); 6441 ComponentName cn = targetIntent.getComponent(); 6442 if (cn == null) { 6443 cn = targetIntent.resolveActivity(pm); 6444 } 6445 ActivityInfo info = pm.getActivityInfo(cn, 0); 6446 if (info.taskAffinity == null) { 6447 return false; 6448 } 6449 return ActivityManagerNative.getDefault() 6450 .shouldUpRecreateTask(mToken, info.taskAffinity); 6451 } catch (RemoteException e) { 6452 return false; 6453 } catch (NameNotFoundException e) { 6454 return false; 6455 } 6456 } 6457 6458 /** 6459 * Navigate from this activity to the activity specified by upIntent, finishing this activity 6460 * in the process. If the activity indicated by upIntent already exists in the task's history, 6461 * this activity and all others before the indicated activity in the history stack will be 6462 * finished. 6463 * 6464 * <p>If the indicated activity does not appear in the history stack, this will finish 6465 * each activity in this task until the root activity of the task is reached, resulting in 6466 * an "in-app home" behavior. This can be useful in apps with a complex navigation hierarchy 6467 * when an activity may be reached by a path not passing through a canonical parent 6468 * activity.</p> 6469 * 6470 * <p>This method should be used when performing up navigation from within the same task 6471 * as the destination. If up navigation should cross tasks in some cases, see 6472 * {@link #shouldUpRecreateTask(Intent)}.</p> 6473 * 6474 * @param upIntent An intent representing the target destination for up navigation 6475 * 6476 * @return true if up navigation successfully reached the activity indicated by upIntent and 6477 * upIntent was delivered to it. false if an instance of the indicated activity could 6478 * not be found and this activity was simply finished normally. 6479 */ 6480 public boolean navigateUpTo(Intent upIntent) { 6481 if (mParent == null) { 6482 ComponentName destInfo = upIntent.getComponent(); 6483 if (destInfo == null) { 6484 destInfo = upIntent.resolveActivity(getPackageManager()); 6485 if (destInfo == null) { 6486 return false; 6487 } 6488 upIntent = new Intent(upIntent); 6489 upIntent.setComponent(destInfo); 6490 } 6491 int resultCode; 6492 Intent resultData; 6493 synchronized (this) { 6494 resultCode = mResultCode; 6495 resultData = mResultData; 6496 } 6497 if (resultData != null) { 6498 resultData.prepareToLeaveProcess(this); 6499 } 6500 try { 6501 upIntent.prepareToLeaveProcess(this); 6502 return ActivityManagerNative.getDefault().navigateUpTo(mToken, upIntent, 6503 resultCode, resultData); 6504 } catch (RemoteException e) { 6505 return false; 6506 } 6507 } else { 6508 return mParent.navigateUpToFromChild(this, upIntent); 6509 } 6510 } 6511 6512 /** 6513 * This is called when a child activity of this one calls its 6514 * {@link #navigateUpTo} method. The default implementation simply calls 6515 * navigateUpTo(upIntent) on this activity (the parent). 6516 * 6517 * @param child The activity making the call. 6518 * @param upIntent An intent representing the target destination for up navigation 6519 * 6520 * @return true if up navigation successfully reached the activity indicated by upIntent and 6521 * upIntent was delivered to it. false if an instance of the indicated activity could 6522 * not be found and this activity was simply finished normally. 6523 */ 6524 public boolean navigateUpToFromChild(Activity child, Intent upIntent) { 6525 return navigateUpTo(upIntent); 6526 } 6527 6528 /** 6529 * Obtain an {@link Intent} that will launch an explicit target activity specified by 6530 * this activity's logical parent. The logical parent is named in the application's manifest 6531 * by the {@link android.R.attr#parentActivityName parentActivityName} attribute. 6532 * Activity subclasses may override this method to modify the Intent returned by 6533 * super.getParentActivityIntent() or to implement a different mechanism of retrieving 6534 * the parent intent entirely. 6535 * 6536 * @return a new Intent targeting the defined parent of this activity or null if 6537 * there is no valid parent. 6538 */ 6539 @Nullable 6540 public Intent getParentActivityIntent() { 6541 final String parentName = mActivityInfo.parentActivityName; 6542 if (TextUtils.isEmpty(parentName)) { 6543 return null; 6544 } 6545 6546 // If the parent itself has no parent, generate a main activity intent. 6547 final ComponentName target = new ComponentName(this, parentName); 6548 try { 6549 final ActivityInfo parentInfo = getPackageManager().getActivityInfo(target, 0); 6550 final String parentActivity = parentInfo.parentActivityName; 6551 final Intent parentIntent = parentActivity == null 6552 ? Intent.makeMainActivity(target) 6553 : new Intent().setComponent(target); 6554 return parentIntent; 6555 } catch (NameNotFoundException e) { 6556 Log.e(TAG, "getParentActivityIntent: bad parentActivityName '" + parentName + 6557 "' in manifest"); 6558 return null; 6559 } 6560 } 6561 6562 /** 6563 * When {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, 6564 * android.view.View, String)} was used to start an Activity, <var>callback</var> 6565 * will be called to handle shared elements on the <i>launched</i> Activity. This requires 6566 * {@link Window#FEATURE_ACTIVITY_TRANSITIONS}. 6567 * 6568 * @param callback Used to manipulate shared element transitions on the launched Activity. 6569 */ 6570 public void setEnterSharedElementCallback(SharedElementCallback callback) { 6571 if (callback == null) { 6572 callback = SharedElementCallback.NULL_CALLBACK; 6573 } 6574 mEnterTransitionListener = callback; 6575 } 6576 6577 /** 6578 * When {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, 6579 * android.view.View, String)} was used to start an Activity, <var>callback</var> 6580 * will be called to handle shared elements on the <i>launching</i> Activity. Most 6581 * calls will only come when returning from the started Activity. 6582 * This requires {@link Window#FEATURE_ACTIVITY_TRANSITIONS}. 6583 * 6584 * @param callback Used to manipulate shared element transitions on the launching Activity. 6585 */ 6586 public void setExitSharedElementCallback(SharedElementCallback callback) { 6587 if (callback == null) { 6588 callback = SharedElementCallback.NULL_CALLBACK; 6589 } 6590 mExitTransitionListener = callback; 6591 } 6592 6593 /** 6594 * Postpone the entering activity transition when Activity was started with 6595 * {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, 6596 * android.util.Pair[])}. 6597 * <p>This method gives the Activity the ability to delay starting the entering and 6598 * shared element transitions until all data is loaded. Until then, the Activity won't 6599 * draw into its window, leaving the window transparent. This may also cause the 6600 * returning animation to be delayed until data is ready. This method should be 6601 * called in {@link #onCreate(android.os.Bundle)} or in 6602 * {@link #onActivityReenter(int, android.content.Intent)}. 6603 * {@link #startPostponedEnterTransition()} must be called to allow the Activity to 6604 * start the transitions. If the Activity did not use 6605 * {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, 6606 * android.util.Pair[])}, then this method does nothing.</p> 6607 */ 6608 public void postponeEnterTransition() { 6609 mActivityTransitionState.postponeEnterTransition(); 6610 } 6611 6612 /** 6613 * Begin postponed transitions after {@link #postponeEnterTransition()} was called. 6614 * If postponeEnterTransition() was called, you must call startPostponedEnterTransition() 6615 * to have your Activity start drawing. 6616 */ 6617 public void startPostponedEnterTransition() { 6618 mActivityTransitionState.startPostponedEnterTransition(); 6619 } 6620 6621 /** 6622 * Create {@link DragAndDropPermissions} object bound to this activity and controlling the 6623 * access permissions for content URIs associated with the {@link DragEvent}. 6624 * @param event Drag event 6625 * @return The {@link DragAndDropPermissions} object used to control access to the content URIs. 6626 * Null if no content URIs are associated with the event or if permissions could not be granted. 6627 */ 6628 public DragAndDropPermissions requestDragAndDropPermissions(DragEvent event) { 6629 DragAndDropPermissions dragAndDropPermissions = DragAndDropPermissions.obtain(event); 6630 if (dragAndDropPermissions != null && dragAndDropPermissions.take(getActivityToken())) { 6631 return dragAndDropPermissions; 6632 } 6633 return null; 6634 } 6635 6636 // ------------------ Internal API ------------------ 6637 6638 final void setParent(Activity parent) { 6639 mParent = parent; 6640 } 6641 6642 final void attach(Context context, ActivityThread aThread, 6643 Instrumentation instr, IBinder token, int ident, 6644 Application application, Intent intent, ActivityInfo info, 6645 CharSequence title, Activity parent, String id, 6646 NonConfigurationInstances lastNonConfigurationInstances, 6647 Configuration config, String referrer, IVoiceInteractor voiceInteractor, 6648 Window window) { 6649 attachBaseContext(context); 6650 6651 mFragments.attachHost(null /*parent*/); 6652 6653 mWindow = new PhoneWindow(this, window); 6654 mWindow.setWindowControllerCallback(this); 6655 mWindow.setCallback(this); 6656 mWindow.setOnWindowDismissedCallback(this); 6657 mWindow.getLayoutInflater().setPrivateFactory(this); 6658 if (info.softInputMode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) { 6659 mWindow.setSoftInputMode(info.softInputMode); 6660 } 6661 if (info.uiOptions != 0) { 6662 mWindow.setUiOptions(info.uiOptions); 6663 } 6664 mUiThread = Thread.currentThread(); 6665 6666 mMainThread = aThread; 6667 mInstrumentation = instr; 6668 mToken = token; 6669 mIdent = ident; 6670 mApplication = application; 6671 mIntent = intent; 6672 mReferrer = referrer; 6673 mComponent = intent.getComponent(); 6674 mActivityInfo = info; 6675 mTitle = title; 6676 mParent = parent; 6677 mEmbeddedID = id; 6678 mLastNonConfigurationInstances = lastNonConfigurationInstances; 6679 if (voiceInteractor != null) { 6680 if (lastNonConfigurationInstances != null) { 6681 mVoiceInteractor = lastNonConfigurationInstances.voiceInteractor; 6682 } else { 6683 mVoiceInteractor = new VoiceInteractor(voiceInteractor, this, this, 6684 Looper.myLooper()); 6685 } 6686 } 6687 6688 mWindow.setWindowManager( 6689 (WindowManager)context.getSystemService(Context.WINDOW_SERVICE), 6690 mToken, mComponent.flattenToString(), 6691 (info.flags & ActivityInfo.FLAG_HARDWARE_ACCELERATED) != 0); 6692 if (mParent != null) { 6693 mWindow.setContainer(mParent.getWindow()); 6694 } 6695 mWindowManager = mWindow.getWindowManager(); 6696 mCurrentConfig = config; 6697 } 6698 6699 /** @hide */ 6700 public final IBinder getActivityToken() { 6701 return mParent != null ? mParent.getActivityToken() : mToken; 6702 } 6703 6704 final void performCreateCommon() { 6705 mVisibleFromClient = !mWindow.getWindowStyle().getBoolean( 6706 com.android.internal.R.styleable.Window_windowNoDisplay, false); 6707 mFragments.dispatchActivityCreated(); 6708 mActivityTransitionState.setEnterActivityOptions(this, getActivityOptions()); 6709 } 6710 6711 final void performCreate(Bundle icicle) { 6712 restoreHasCurrentPermissionRequest(icicle); 6713 onCreate(icicle); 6714 mActivityTransitionState.readState(icicle); 6715 performCreateCommon(); 6716 } 6717 6718 final void performCreate(Bundle icicle, PersistableBundle persistentState) { 6719 restoreHasCurrentPermissionRequest(icicle); 6720 onCreate(icicle, persistentState); 6721 mActivityTransitionState.readState(icicle); 6722 performCreateCommon(); 6723 } 6724 6725 final void performStart() { 6726 mActivityTransitionState.setEnterActivityOptions(this, getActivityOptions()); 6727 mFragments.noteStateNotSaved(); 6728 mCalled = false; 6729 mFragments.execPendingActions(); 6730 mInstrumentation.callActivityOnStart(this); 6731 if (!mCalled) { 6732 throw new SuperNotCalledException( 6733 "Activity " + mComponent.toShortString() + 6734 " did not call through to super.onStart()"); 6735 } 6736 mFragments.dispatchStart(); 6737 mFragments.reportLoaderStart(); 6738 6739 // This property is set for all builds except final release 6740 boolean isDlwarningEnabled = SystemProperties.getInt("ro.bionic.ld.warning", 0) == 1; 6741 boolean isAppDebuggable = 6742 (mApplication.getApplicationInfo().flags & ApplicationInfo.FLAG_DEBUGGABLE) != 0; 6743 6744 if (isAppDebuggable || isDlwarningEnabled) { 6745 String dlwarning = getDlWarning(); 6746 if (dlwarning != null) { 6747 String appName = getApplicationInfo().loadLabel(getPackageManager()) 6748 .toString(); 6749 String warning = "Detected problems with app native libraries\n" + 6750 "(please consult log for detail):\n" + dlwarning; 6751 if (isAppDebuggable) { 6752 new AlertDialog.Builder(this). 6753 setTitle(appName). 6754 setMessage(warning). 6755 setPositiveButton(android.R.string.ok, null). 6756 setCancelable(false). 6757 show(); 6758 } else { 6759 Toast.makeText(this, appName + "\n" + warning, Toast.LENGTH_LONG).show(); 6760 } 6761 } 6762 } 6763 6764 mActivityTransitionState.enterReady(this); 6765 } 6766 6767 final void performRestart() { 6768 mFragments.noteStateNotSaved(); 6769 6770 if (mToken != null && mParent == null) { 6771 // No need to check mStopped, the roots will check if they were actually stopped. 6772 WindowManagerGlobal.getInstance().setStoppedState(mToken, false /* stopped */); 6773 } 6774 6775 if (mStopped) { 6776 mStopped = false; 6777 6778 synchronized (mManagedCursors) { 6779 final int N = mManagedCursors.size(); 6780 for (int i=0; i<N; i++) { 6781 ManagedCursor mc = mManagedCursors.get(i); 6782 if (mc.mReleased || mc.mUpdated) { 6783 if (!mc.mCursor.requery()) { 6784 if (getApplicationInfo().targetSdkVersion 6785 >= android.os.Build.VERSION_CODES.ICE_CREAM_SANDWICH) { 6786 throw new IllegalStateException( 6787 "trying to requery an already closed cursor " 6788 + mc.mCursor); 6789 } 6790 } 6791 mc.mReleased = false; 6792 mc.mUpdated = false; 6793 } 6794 } 6795 } 6796 6797 mCalled = false; 6798 mInstrumentation.callActivityOnRestart(this); 6799 if (!mCalled) { 6800 throw new SuperNotCalledException( 6801 "Activity " + mComponent.toShortString() + 6802 " did not call through to super.onRestart()"); 6803 } 6804 performStart(); 6805 } 6806 } 6807 6808 final void performResume() { 6809 performRestart(); 6810 6811 mFragments.execPendingActions(); 6812 6813 mLastNonConfigurationInstances = null; 6814 6815 mCalled = false; 6816 // mResumed is set by the instrumentation 6817 mInstrumentation.callActivityOnResume(this); 6818 if (!mCalled) { 6819 throw new SuperNotCalledException( 6820 "Activity " + mComponent.toShortString() + 6821 " did not call through to super.onResume()"); 6822 } 6823 6824 // invisible activities must be finished before onResume() completes 6825 if (!mVisibleFromClient && !mFinished) { 6826 Log.w(TAG, "An activity without a UI must call finish() before onResume() completes"); 6827 if (getApplicationInfo().targetSdkVersion 6828 > android.os.Build.VERSION_CODES.LOLLIPOP_MR1) { 6829 throw new IllegalStateException( 6830 "Activity " + mComponent.toShortString() + 6831 " did not call finish() prior to onResume() completing"); 6832 } 6833 } 6834 6835 // Now really resume, and install the current status bar and menu. 6836 mCalled = false; 6837 6838 mFragments.dispatchResume(); 6839 mFragments.execPendingActions(); 6840 6841 onPostResume(); 6842 if (!mCalled) { 6843 throw new SuperNotCalledException( 6844 "Activity " + mComponent.toShortString() + 6845 " did not call through to super.onPostResume()"); 6846 } 6847 } 6848 6849 final void performPause() { 6850 mDoReportFullyDrawn = false; 6851 mFragments.dispatchPause(); 6852 mCalled = false; 6853 onPause(); 6854 mResumed = false; 6855 if (!mCalled && getApplicationInfo().targetSdkVersion 6856 >= android.os.Build.VERSION_CODES.GINGERBREAD) { 6857 throw new SuperNotCalledException( 6858 "Activity " + mComponent.toShortString() + 6859 " did not call through to super.onPause()"); 6860 } 6861 mResumed = false; 6862 } 6863 6864 final void performUserLeaving() { 6865 onUserInteraction(); 6866 onUserLeaveHint(); 6867 } 6868 6869 final void performStop(boolean preserveWindow) { 6870 mDoReportFullyDrawn = false; 6871 mFragments.doLoaderStop(mChangingConfigurations /*retain*/); 6872 6873 if (!mStopped) { 6874 if (mWindow != null) { 6875 mWindow.closeAllPanels(); 6876 } 6877 6878 // If we're preserving the window, don't setStoppedState to true, since we 6879 // need the window started immediately again. Stopping the window will 6880 // destroys hardware resources and causes flicker. 6881 if (!preserveWindow && mToken != null && mParent == null) { 6882 WindowManagerGlobal.getInstance().setStoppedState(mToken, true); 6883 } 6884 6885 mFragments.dispatchStop(); 6886 6887 mCalled = false; 6888 mInstrumentation.callActivityOnStop(this); 6889 if (!mCalled) { 6890 throw new SuperNotCalledException( 6891 "Activity " + mComponent.toShortString() + 6892 " did not call through to super.onStop()"); 6893 } 6894 6895 synchronized (mManagedCursors) { 6896 final int N = mManagedCursors.size(); 6897 for (int i=0; i<N; i++) { 6898 ManagedCursor mc = mManagedCursors.get(i); 6899 if (!mc.mReleased) { 6900 mc.mCursor.deactivate(); 6901 mc.mReleased = true; 6902 } 6903 } 6904 } 6905 6906 mStopped = true; 6907 } 6908 mResumed = false; 6909 } 6910 6911 final void performDestroy() { 6912 mDestroyed = true; 6913 mWindow.destroy(); 6914 mFragments.dispatchDestroy(); 6915 onDestroy(); 6916 mFragments.doLoaderDestroy(); 6917 if (mVoiceInteractor != null) { 6918 mVoiceInteractor.detachActivity(); 6919 } 6920 } 6921 6922 final void dispatchMultiWindowModeChanged(boolean isInMultiWindowMode) { 6923 if (DEBUG_LIFECYCLE) Slog.v(TAG, 6924 "dispatchMultiWindowModeChanged " + this + ": " + isInMultiWindowMode); 6925 mFragments.dispatchMultiWindowModeChanged(isInMultiWindowMode); 6926 if (mWindow != null) { 6927 mWindow.onMultiWindowModeChanged(); 6928 } 6929 onMultiWindowModeChanged(isInMultiWindowMode); 6930 } 6931 6932 final void dispatchPictureInPictureModeChanged(boolean isInPictureInPictureMode) { 6933 if (DEBUG_LIFECYCLE) Slog.v(TAG, 6934 "dispatchPictureInPictureModeChanged " + this + ": " + isInPictureInPictureMode); 6935 mFragments.dispatchPictureInPictureModeChanged(isInPictureInPictureMode); 6936 onPictureInPictureModeChanged(isInPictureInPictureMode); 6937 } 6938 6939 /** 6940 * @hide 6941 */ 6942 public final boolean isResumed() { 6943 return mResumed; 6944 } 6945 6946 private void storeHasCurrentPermissionRequest(Bundle bundle) { 6947 if (bundle != null && mHasCurrentPermissionsRequest) { 6948 bundle.putBoolean(HAS_CURENT_PERMISSIONS_REQUEST_KEY, true); 6949 } 6950 } 6951 6952 private void restoreHasCurrentPermissionRequest(Bundle bundle) { 6953 if (bundle != null) { 6954 mHasCurrentPermissionsRequest = bundle.getBoolean( 6955 HAS_CURENT_PERMISSIONS_REQUEST_KEY, false); 6956 } 6957 } 6958 6959 void dispatchActivityResult(String who, int requestCode, 6960 int resultCode, Intent data) { 6961 if (false) Log.v( 6962 TAG, "Dispatching result: who=" + who + ", reqCode=" + requestCode 6963 + ", resCode=" + resultCode + ", data=" + data); 6964 mFragments.noteStateNotSaved(); 6965 if (who == null) { 6966 onActivityResult(requestCode, resultCode, data); 6967 } else if (who.startsWith(REQUEST_PERMISSIONS_WHO_PREFIX)) { 6968 who = who.substring(REQUEST_PERMISSIONS_WHO_PREFIX.length()); 6969 if (TextUtils.isEmpty(who)) { 6970 dispatchRequestPermissionsResult(requestCode, data); 6971 } else { 6972 Fragment frag = mFragments.findFragmentByWho(who); 6973 if (frag != null) { 6974 dispatchRequestPermissionsResultToFragment(requestCode, data, frag); 6975 } 6976 } 6977 } else if (who.startsWith("@android:view:")) { 6978 ArrayList<ViewRootImpl> views = WindowManagerGlobal.getInstance().getRootViews( 6979 getActivityToken()); 6980 for (ViewRootImpl viewRoot : views) { 6981 if (viewRoot.getView() != null 6982 && viewRoot.getView().dispatchActivityResult( 6983 who, requestCode, resultCode, data)) { 6984 return; 6985 } 6986 } 6987 } else { 6988 Fragment frag = mFragments.findFragmentByWho(who); 6989 if (frag != null) { 6990 frag.onActivityResult(requestCode, resultCode, data); 6991 } 6992 } 6993 } 6994 6995 /** 6996 * Request to put this Activity in a mode where the user is locked to the 6997 * current task. 6998 * 6999 * This will prevent the user from launching other apps, going to settings, or reaching the 7000 * home screen. This does not include those apps whose {@link android.R.attr#lockTaskMode} 7001 * values permit launching while locked. 7002 * 7003 * If {@link DevicePolicyManager#isLockTaskPermitted(String)} returns true or 7004 * lockTaskMode=lockTaskModeAlways for this component then the app will go directly into 7005 * Lock Task mode. The user will not be able to exit this mode until 7006 * {@link Activity#stopLockTask()} is called. 7007 * 7008 * If {@link DevicePolicyManager#isLockTaskPermitted(String)} returns false 7009 * then the system will prompt the user with a dialog requesting permission to enter 7010 * this mode. When entered through this method the user can exit at any time through 7011 * an action described by the request dialog. Calling stopLockTask will also exit the 7012 * mode. 7013 * 7014 * @see android.R.attr#lockTaskMode 7015 */ 7016 public void startLockTask() { 7017 try { 7018 ActivityManagerNative.getDefault().startLockTaskModeByToken(mToken); 7019 } catch (RemoteException e) { 7020 } 7021 } 7022 7023 /** 7024 * Allow the user to switch away from the current task. 7025 * 7026 * Called to end the mode started by {@link Activity#startLockTask}. This 7027 * can only be called by activities that have successfully called 7028 * startLockTask previously. 7029 * 7030 * This will allow the user to exit this app and move onto other activities. 7031 * <p>Note: This method should only be called when the activity is user-facing. That is, 7032 * between onResume() and onPause(). 7033 * <p>Note: If there are other tasks below this one that are also locked then calling this 7034 * method will immediately finish this task and resume the previous locked one, remaining in 7035 * lockTask mode. 7036 * 7037 * @see android.R.attr#lockTaskMode 7038 * @see ActivityManager#getLockTaskModeState() 7039 */ 7040 public void stopLockTask() { 7041 try { 7042 ActivityManagerNative.getDefault().stopLockTaskMode(); 7043 } catch (RemoteException e) { 7044 } 7045 } 7046 7047 /** 7048 * Shows the user the system defined message for telling the user how to exit 7049 * lock task mode. The task containing this activity must be in lock task mode at the time 7050 * of this call for the message to be displayed. 7051 */ 7052 public void showLockTaskEscapeMessage() { 7053 try { 7054 ActivityManagerNative.getDefault().showLockTaskEscapeMessage(mToken); 7055 } catch (RemoteException e) { 7056 } 7057 } 7058 7059 /** 7060 * Check whether the caption on freeform windows is displayed directly on the content. 7061 * 7062 * @return True if caption is displayed on content, false if it pushes the content down. 7063 * 7064 * @see {@link #setOverlayWithDecorCaptionEnabled(boolean)} 7065 */ 7066 public boolean isOverlayWithDecorCaptionEnabled() { 7067 return mWindow.isOverlayWithDecorCaptionEnabled(); 7068 } 7069 7070 /** 7071 * Set whether the caption should displayed directly on the content rather than push it down. 7072 * 7073 * This affects only freeform windows since they display the caption and only the main 7074 * window of the activity. The caption is used to drag the window around and also shows 7075 * maximize and close action buttons. 7076 */ 7077 public void setOverlayWithDecorCaptionEnabled(boolean enabled) { 7078 mWindow.setOverlayWithDecorCaptionEnabled(enabled); 7079 } 7080 7081 /** 7082 * Interface for informing a translucent {@link Activity} once all visible activities below it 7083 * have completed drawing. This is necessary only after an {@link Activity} has been made 7084 * opaque using {@link Activity#convertFromTranslucent()} and before it has been drawn 7085 * translucent again following a call to {@link 7086 * Activity#convertToTranslucent(android.app.Activity.TranslucentConversionListener, 7087 * ActivityOptions)} 7088 * 7089 * @hide 7090 */ 7091 @SystemApi 7092 public interface TranslucentConversionListener { 7093 /** 7094 * Callback made following {@link Activity#convertToTranslucent} once all visible Activities 7095 * below the top one have been redrawn. Following this callback it is safe to make the top 7096 * Activity translucent because the underlying Activity has been drawn. 7097 * 7098 * @param drawComplete True if the background Activity has drawn itself. False if a timeout 7099 * occurred waiting for the Activity to complete drawing. 7100 * 7101 * @see Activity#convertFromTranslucent() 7102 * @see Activity#convertToTranslucent(TranslucentConversionListener, ActivityOptions) 7103 */ 7104 public void onTranslucentConversionComplete(boolean drawComplete); 7105 } 7106 7107 private void dispatchRequestPermissionsResult(int requestCode, Intent data) { 7108 mHasCurrentPermissionsRequest = false; 7109 // If the package installer crashed we may have not data - best effort. 7110 String[] permissions = (data != null) ? data.getStringArrayExtra( 7111 PackageManager.EXTRA_REQUEST_PERMISSIONS_NAMES) : new String[0]; 7112 final int[] grantResults = (data != null) ? data.getIntArrayExtra( 7113 PackageManager.EXTRA_REQUEST_PERMISSIONS_RESULTS) : new int[0]; 7114 onRequestPermissionsResult(requestCode, permissions, grantResults); 7115 } 7116 7117 private void dispatchRequestPermissionsResultToFragment(int requestCode, Intent data, 7118 Fragment fragment) { 7119 // If the package installer crashed we may have not data - best effort. 7120 String[] permissions = (data != null) ? data.getStringArrayExtra( 7121 PackageManager.EXTRA_REQUEST_PERMISSIONS_NAMES) : new String[0]; 7122 final int[] grantResults = (data != null) ? data.getIntArrayExtra( 7123 PackageManager.EXTRA_REQUEST_PERMISSIONS_RESULTS) : new int[0]; 7124 fragment.onRequestPermissionsResult(requestCode, permissions, grantResults); 7125 } 7126 7127 class HostCallbacks extends FragmentHostCallback<Activity> { 7128 public HostCallbacks() { 7129 super(Activity.this /*activity*/); 7130 } 7131 7132 @Override 7133 public void onDump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) { 7134 Activity.this.dump(prefix, fd, writer, args); 7135 } 7136 7137 @Override 7138 public boolean onShouldSaveFragmentState(Fragment fragment) { 7139 return !isFinishing(); 7140 } 7141 7142 @Override 7143 public LayoutInflater onGetLayoutInflater() { 7144 final LayoutInflater result = Activity.this.getLayoutInflater(); 7145 if (onUseFragmentManagerInflaterFactory()) { 7146 return result.cloneInContext(Activity.this); 7147 } 7148 return result; 7149 } 7150 7151 @Override 7152 public boolean onUseFragmentManagerInflaterFactory() { 7153 // Newer platform versions use the child fragment manager's LayoutInflaterFactory. 7154 return getApplicationInfo().targetSdkVersion >= Build.VERSION_CODES.LOLLIPOP; 7155 } 7156 7157 @Override 7158 public Activity onGetHost() { 7159 return Activity.this; 7160 } 7161 7162 @Override 7163 public void onInvalidateOptionsMenu() { 7164 Activity.this.invalidateOptionsMenu(); 7165 } 7166 7167 @Override 7168 public void onStartActivityFromFragment(Fragment fragment, Intent intent, int requestCode, 7169 Bundle options) { 7170 Activity.this.startActivityFromFragment(fragment, intent, requestCode, options); 7171 } 7172 7173 @Override 7174 public void onStartIntentSenderFromFragment(Fragment fragment, IntentSender intent, 7175 int requestCode, @Nullable Intent fillInIntent, int flagsMask, int flagsValues, 7176 int extraFlags, Bundle options) throws IntentSender.SendIntentException { 7177 if (mParent == null) { 7178 startIntentSenderForResultInner(intent, fragment.mWho, requestCode, fillInIntent, 7179 flagsMask, flagsValues, options); 7180 } else if (options != null) { 7181 mParent.startIntentSenderFromChildFragment(fragment, intent, requestCode, 7182 fillInIntent, flagsMask, flagsValues, extraFlags, options); 7183 } 7184 } 7185 7186 @Override 7187 public void onRequestPermissionsFromFragment(Fragment fragment, String[] permissions, 7188 int requestCode) { 7189 String who = REQUEST_PERMISSIONS_WHO_PREFIX + fragment.mWho; 7190 Intent intent = getPackageManager().buildRequestPermissionsIntent(permissions); 7191 startActivityForResult(who, intent, requestCode, null); 7192 } 7193 7194 @Override 7195 public boolean onHasWindowAnimations() { 7196 return getWindow() != null; 7197 } 7198 7199 @Override 7200 public int onGetWindowAnimations() { 7201 final Window w = getWindow(); 7202 return (w == null) ? 0 : w.getAttributes().windowAnimations; 7203 } 7204 7205 @Override 7206 public void onAttachFragment(Fragment fragment) { 7207 Activity.this.onAttachFragment(fragment); 7208 } 7209 7210 @Nullable 7211 @Override 7212 public View onFindViewById(int id) { 7213 return Activity.this.findViewById(id); 7214 } 7215 7216 @Override 7217 public boolean onHasView() { 7218 final Window w = getWindow(); 7219 return (w != null && w.peekDecorView() != null); 7220 } 7221 } 7222} 7223