blob: e95fbfcfeb829bee55a2a258f81ca5ac35f1691d [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
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
Tor Norbyed9273d62013-05-30 15:59:53 -070019import android.annotation.NonNull;
Craig Mautnera0026042014-04-23 11:45:37 -070020import android.os.PersistableBundle;
Adam Powellcfbe9be2013-11-06 14:58:58 -080021import android.transition.Scene;
Adam Powellcfbe9be2013-11-06 14:58:58 -080022import android.transition.TransitionManager;
Dianne Hackborn3e82ba12013-07-16 13:23:55 -070023import android.util.ArrayMap;
Adam Powell14874662013-07-18 19:42:41 -070024import android.util.SuperNotCalledException;
Adam Powelle43340c2014-03-17 19:10:43 -070025import android.widget.Toolbar;
RoboErik55011652014-07-09 15:05:53 -070026
Dianne Hackborn91097de2014-04-04 18:02:06 -070027import com.android.internal.app.IVoiceInteractor;
Adam Powelle43340c2014-03-17 19:10:43 -070028import com.android.internal.app.WindowDecorActionBar;
29import com.android.internal.app.ToolbarActionBar;
svetoslavganov75986cf2009-05-14 22:28:01 -070030
Tor Norbyed9273d62013-05-30 15:59:53 -070031import android.annotation.IntDef;
32import android.annotation.Nullable;
Jose Lima4b6c6692014-08-12 17:41:12 -070033import android.annotation.SystemApi;
Jason Monk62515be2014-05-21 16:06:19 -040034import android.app.admin.DevicePolicyManager;
Dianne Hackbornc68c9132011-07-29 01:25:18 -070035import android.content.ComponentCallbacks2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080036import android.content.ComponentName;
37import android.content.ContentResolver;
38import android.content.Context;
Jason parks6ed50de2010-08-25 10:18:50 -050039import android.content.CursorLoader;
Suchi Amalapurapu1ccac752009-06-12 10:09:58 -070040import android.content.IIntentSender;
Adam Powell33b97432010-04-20 10:01:14 -070041import android.content.Intent;
Dianne Hackbornfa82f222009-09-17 15:14:12 -070042import android.content.IntentSender;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.content.SharedPreferences;
44import android.content.pm.ActivityInfo;
Adam Powelldd8fab22012-03-22 17:47:27 -070045import android.content.pm.PackageManager;
46import android.content.pm.PackageManager.NameNotFoundException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080047import android.content.res.Configuration;
48import android.content.res.Resources;
Dianne Hackbornba51c3d2010-05-05 18:49:48 -070049import android.content.res.TypedArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050import android.database.Cursor;
51import android.graphics.Bitmap;
52import android.graphics.Canvas;
53import android.graphics.drawable.Drawable;
54import android.media.AudioManager;
RoboErik55011652014-07-09 15:05:53 -070055import android.media.session.MediaController;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080056import android.net.Uri;
Dianne Hackborn8d374262009-09-14 21:21:52 -070057import android.os.Build;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080058import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080059import android.os.Handler;
60import android.os.IBinder;
Dianne Hackborn30c9bd82010-12-01 16:07:40 -080061import android.os.Looper;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070062import android.os.Parcelable;
svetoslavganov75986cf2009-05-14 22:28:01 -070063import android.os.RemoteException;
Brad Fitzpatrick75803572011-01-13 14:21:03 -080064import android.os.StrictMode;
Dianne Hackbornf1c26e22012-08-23 13:54:58 -070065import android.os.UserHandle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080066import android.text.Selection;
67import android.text.SpannableStringBuilder;
svetoslavganov75986cf2009-05-14 22:28:01 -070068import android.text.TextUtils;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080069import android.text.method.TextKeyListener;
70import android.util.AttributeSet;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080071import android.util.EventLog;
72import android.util.Log;
Jeff Brown5182c782013-10-15 20:31:52 -070073import android.util.PrintWriterPrinter;
Dianne Hackborn162bc0e2012-04-09 14:06:16 -070074import android.util.Slog;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080075import android.util.SparseArray;
Adam Powell6e346362010-07-23 10:18:23 -070076import android.view.ActionMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080077import android.view.ContextMenu;
Adam Powell6e346362010-07-23 10:18:23 -070078import android.view.ContextMenu.ContextMenuInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080079import android.view.ContextThemeWrapper;
80import android.view.KeyEvent;
81import android.view.LayoutInflater;
82import android.view.Menu;
83import android.view.MenuInflater;
84import android.view.MenuItem;
85import android.view.MotionEvent;
Jorim Jaggib10e33f2015-02-04 21:57:40 +010086import android.view.PhoneWindow;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080087import android.view.View;
Adam Powell6e346362010-07-23 10:18:23 -070088import android.view.View.OnCreateContextMenuListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089import android.view.ViewGroup;
Adam Powell6e346362010-07-23 10:18:23 -070090import android.view.ViewGroup.LayoutParams;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080091import android.view.ViewManager;
92import android.view.Window;
93import android.view.WindowManager;
Jeff Brown98365d72012-08-19 20:30:52 -070094import android.view.WindowManagerGlobal;
svetoslavganov75986cf2009-05-14 22:28:01 -070095import android.view.accessibility.AccessibilityEvent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080096import android.widget.AdapterView;
97
Dianne Hackborn625ac272010-09-17 18:29:22 -070098import java.io.FileDescriptor;
99import java.io.PrintWriter;
Tor Norbyed9273d62013-05-30 15:59:53 -0700100import java.lang.annotation.Retention;
101import java.lang.annotation.RetentionPolicy;
Adam Powell6e346362010-07-23 10:18:23 -0700102import java.util.ArrayList;
103import java.util.HashMap;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800104
105/**
106 * An activity is a single, focused thing that the user can do. Almost all
107 * activities interact with the user, so the Activity class takes care of
108 * creating a window for you in which you can place your UI with
109 * {@link #setContentView}. While activities are often presented to the user
110 * as full-screen windows, they can also be used in other ways: as floating
111 * windows (via a theme with {@link android.R.attr#windowIsFloating} set)
112 * or embedded inside of another activity (using {@link ActivityGroup}).
113 *
114 * There are two methods almost all subclasses of Activity will implement:
RoboErik55011652014-07-09 15:05:53 -0700115 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800116 * <ul>
117 * <li> {@link #onCreate} is where you initialize your activity. Most
118 * importantly, here you will usually call {@link #setContentView(int)}
119 * with a layout resource defining your UI, and using {@link #findViewById}
120 * to retrieve the widgets in that UI that you need to interact with
121 * programmatically.
RoboErik55011652014-07-09 15:05:53 -0700122 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800123 * <li> {@link #onPause} is where you deal with the user leaving your
124 * activity. Most importantly, any changes made by the user should at this
125 * point be committed (usually to the
126 * {@link android.content.ContentProvider} holding the data).
127 * </ul>
128 *
129 * <p>To be of use with {@link android.content.Context#startActivity Context.startActivity()}, all
130 * activity classes must have a corresponding
131 * {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
132 * declaration in their package's <code>AndroidManifest.xml</code>.</p>
RoboErik55011652014-07-09 15:05:53 -0700133 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800134 * <p>Topics covered here:
135 * <ol>
Dianne Hackborn291905e2010-08-17 15:17:15 -0700136 * <li><a href="#Fragments">Fragments</a>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800137 * <li><a href="#ActivityLifecycle">Activity Lifecycle</a>
138 * <li><a href="#ConfigurationChanges">Configuration Changes</a>
139 * <li><a href="#StartingActivities">Starting Activities and Getting Results</a>
140 * <li><a href="#SavingPersistentState">Saving Persistent State</a>
141 * <li><a href="#Permissions">Permissions</a>
142 * <li><a href="#ProcessLifecycle">Process Lifecycle</a>
143 * </ol>
Joe Fernandezb54e7a32011-10-03 15:09:50 -0700144 *
145 * <div class="special reference">
146 * <h3>Developer Guides</h3>
147 * <p>The Activity class is an important part of an application's overall lifecycle,
148 * and the way activities are launched and put together is a fundamental
149 * part of the platform's application model. For a detailed perspective on the structure of an
150 * Android application and how activities behave, please read the
151 * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a> and
152 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back Stack</a>
153 * developer guides.</p>
154 *
155 * <p>You can also find a detailed discussion about how to create activities in the
156 * <a href="{@docRoot}guide/topics/fundamentals/activities.html">Activities</a>
157 * developer guide.</p>
158 * </div>
159 *
Dianne Hackborn291905e2010-08-17 15:17:15 -0700160 * <a name="Fragments"></a>
161 * <h3>Fragments</h3>
162 *
163 * <p>Starting with {@link android.os.Build.VERSION_CODES#HONEYCOMB}, Activity
164 * implementations can make use of the {@link Fragment} class to better
165 * modularize their code, build more sophisticated user interfaces for larger
166 * screens, and help scale their application between small and large screens.
167 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800168 * <a name="ActivityLifecycle"></a>
169 * <h3>Activity Lifecycle</h3>
170 *
171 * <p>Activities in the system are managed as an <em>activity stack</em>.
172 * When a new activity is started, it is placed on the top of the stack
173 * and becomes the running activity -- the previous activity always remains
174 * below it in the stack, and will not come to the foreground again until
175 * the new activity exits.</p>
RoboErik55011652014-07-09 15:05:53 -0700176 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800177 * <p>An activity has essentially four states:</p>
178 * <ul>
179 * <li> If an activity in the foreground of the screen (at the top of
180 * the stack),
181 * it is <em>active</em> or <em>running</em>. </li>
182 * <li>If an activity has lost focus but is still visible (that is, a new non-full-sized
RoboErik55011652014-07-09 15:05:53 -0700183 * or transparent activity has focus on top of your activity), it
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800184 * is <em>paused</em>. A paused activity is completely alive (it
185 * maintains all state and member information and remains attached to
186 * the window manager), but can be killed by the system in extreme
187 * low memory situations.
188 * <li>If an activity is completely obscured by another activity,
189 * it is <em>stopped</em>. It still retains all state and member information,
190 * however, it is no longer visible to the user so its window is hidden
191 * and it will often be killed by the system when memory is needed
192 * elsewhere.</li>
193 * <li>If an activity is paused or stopped, the system can drop the activity
194 * from memory by either asking it to finish, or simply killing its
195 * process. When it is displayed again to the user, it must be
196 * completely restarted and restored to its previous state.</li>
197 * </ul>
198 *
199 * <p>The following diagram shows the important state paths of an Activity.
200 * The square rectangles represent callback methods you can implement to
201 * perform operations when the Activity moves between states. The colored
202 * ovals are major states the Activity can be in.</p>
RoboErik55011652014-07-09 15:05:53 -0700203 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800204 * <p><img src="../../../images/activity_lifecycle.png"
205 * alt="State diagram for an Android Activity Lifecycle." border="0" /></p>
RoboErik55011652014-07-09 15:05:53 -0700206 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800207 * <p>There are three key loops you may be interested in monitoring within your
208 * activity:
RoboErik55011652014-07-09 15:05:53 -0700209 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800210 * <ul>
211 * <li>The <b>entire lifetime</b> of an activity happens between the first call
212 * to {@link android.app.Activity#onCreate} through to a single final call
213 * to {@link android.app.Activity#onDestroy}. An activity will do all setup
214 * of "global" state in onCreate(), and release all remaining resources in
215 * onDestroy(). For example, if it has a thread running in the background
216 * to download data from the network, it may create that thread in onCreate()
217 * and then stop the thread in onDestroy().
RoboErik55011652014-07-09 15:05:53 -0700218 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800219 * <li>The <b>visible lifetime</b> of an activity happens between a call to
220 * {@link android.app.Activity#onStart} until a corresponding call to
221 * {@link android.app.Activity#onStop}. During this time the user can see the
222 * activity on-screen, though it may not be in the foreground and interacting
223 * with the user. Between these two methods you can maintain resources that
224 * are needed to show the activity to the user. For example, you can register
225 * a {@link android.content.BroadcastReceiver} in onStart() to monitor for changes
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900226 * that impact your UI, and unregister it in onStop() when the user no
227 * longer sees what you are displaying. The onStart() and onStop() methods
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800228 * can be called multiple times, as the activity becomes visible and hidden
229 * to the user.
RoboErik55011652014-07-09 15:05:53 -0700230 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800231 * <li>The <b>foreground lifetime</b> of an activity happens between a call to
232 * {@link android.app.Activity#onResume} until a corresponding call to
233 * {@link android.app.Activity#onPause}. During this time the activity is
234 * in front of all other activities and interacting with the user. An activity
235 * can frequently go between the resumed and paused states -- for example when
236 * the device goes to sleep, when an activity result is delivered, when a new
237 * intent is delivered -- so the code in these methods should be fairly
238 * lightweight.
239 * </ul>
RoboErik55011652014-07-09 15:05:53 -0700240 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800241 * <p>The entire lifecycle of an activity is defined by the following
242 * Activity methods. All of these are hooks that you can override
243 * to do appropriate work when the activity changes state. All
244 * activities will implement {@link android.app.Activity#onCreate}
245 * to do their initial setup; many will also implement
246 * {@link android.app.Activity#onPause} to commit changes to data and
247 * otherwise prepare to stop interacting with the user. You should always
248 * call up to your superclass when implementing these methods.</p>
249 *
250 * </p>
251 * <pre class="prettyprint">
252 * public class Activity extends ApplicationContext {
253 * protected void onCreate(Bundle savedInstanceState);
254 *
255 * protected void onStart();
RoboErik55011652014-07-09 15:05:53 -0700256 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800257 * protected void onRestart();
258 *
259 * protected void onResume();
260 *
261 * protected void onPause();
262 *
263 * protected void onStop();
264 *
265 * protected void onDestroy();
266 * }
267 * </pre>
268 *
269 * <p>In general the movement through an activity's lifecycle looks like
270 * this:</p>
271 *
272 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
273 * <colgroup align="left" span="3" />
274 * <colgroup align="left" />
275 * <colgroup align="center" />
276 * <colgroup align="center" />
277 *
278 * <thead>
279 * <tr><th colspan="3">Method</th> <th>Description</th> <th>Killable?</th> <th>Next</th></tr>
280 * </thead>
281 *
282 * <tbody>
283 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onCreate onCreate()}</th>
284 * <td>Called when the activity is first created.
285 * This is where you should do all of your normal static set up:
286 * create views, bind data to lists, etc. This method also
287 * provides you with a Bundle containing the activity's previously
288 * frozen state, if there was one.
289 * <p>Always followed by <code>onStart()</code>.</td>
290 * <td align="center">No</td>
291 * <td align="center"><code>onStart()</code></td>
292 * </tr>
293 *
294 * <tr><td rowspan="5" style="border-left: none; border-right: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
295 * <th colspan="2" align="left" border="0">{@link android.app.Activity#onRestart onRestart()}</th>
296 * <td>Called after your activity has been stopped, prior to it being
297 * started again.
298 * <p>Always followed by <code>onStart()</code></td>
299 * <td align="center">No</td>
300 * <td align="center"><code>onStart()</code></td>
301 * </tr>
302 *
303 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStart onStart()}</th>
304 * <td>Called when the activity is becoming visible to the user.
305 * <p>Followed by <code>onResume()</code> if the activity comes
306 * to the foreground, or <code>onStop()</code> if it becomes hidden.</td>
307 * <td align="center">No</td>
308 * <td align="center"><code>onResume()</code> or <code>onStop()</code></td>
309 * </tr>
310 *
311 * <tr><td rowspan="2" style="border-left: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
312 * <th align="left" border="0">{@link android.app.Activity#onResume onResume()}</th>
313 * <td>Called when the activity will start
314 * interacting with the user. At this point your activity is at
315 * the top of the activity stack, with user input going to it.
316 * <p>Always followed by <code>onPause()</code>.</td>
317 * <td align="center">No</td>
318 * <td align="center"><code>onPause()</code></td>
319 * </tr>
320 *
321 * <tr><th align="left" border="0">{@link android.app.Activity#onPause onPause()}</th>
322 * <td>Called when the system is about to start resuming a previous
323 * activity. This is typically used to commit unsaved changes to
324 * persistent data, stop animations and other things that may be consuming
325 * CPU, etc. Implementations of this method must be very quick because
326 * the next activity will not be resumed until this method returns.
327 * <p>Followed by either <code>onResume()</code> if the activity
328 * returns back to the front, or <code>onStop()</code> if it becomes
329 * invisible to the user.</td>
Dianne Hackborn0aae2d42010-12-07 23:51:29 -0800330 * <td align="center"><font color="#800000"><strong>Pre-{@link android.os.Build.VERSION_CODES#HONEYCOMB}</strong></font></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800331 * <td align="center"><code>onResume()</code> or<br>
332 * <code>onStop()</code></td>
333 * </tr>
334 *
335 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStop onStop()}</th>
336 * <td>Called when the activity is no longer visible to the user, because
337 * another activity has been resumed and is covering this one. This
338 * may happen either because a new activity is being started, an existing
339 * one is being brought in front of this one, or this one is being
340 * destroyed.
341 * <p>Followed by either <code>onRestart()</code> if
342 * this activity is coming back to interact with the user, or
343 * <code>onDestroy()</code> if this activity is going away.</td>
344 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
345 * <td align="center"><code>onRestart()</code> or<br>
346 * <code>onDestroy()</code></td>
347 * </tr>
348 *
349 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onDestroy onDestroy()}</th>
350 * <td>The final call you receive before your
351 * activity is destroyed. This can happen either because the
352 * activity is finishing (someone called {@link Activity#finish} on
353 * it, or because the system is temporarily destroying this
354 * instance of the activity to save space. You can distinguish
355 * between these two scenarios with the {@link
356 * Activity#isFinishing} method.</td>
357 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
358 * <td align="center"><em>nothing</em></td>
359 * </tr>
360 * </tbody>
361 * </table>
362 *
363 * <p>Note the "Killable" column in the above table -- for those methods that
364 * are marked as being killable, after that method returns the process hosting the
Kris Giesing8b6216d2014-12-16 17:23:15 -0800365 * activity may be killed by the system <em>at any time</em> without another line
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800366 * of its code being executed. Because of this, you should use the
367 * {@link #onPause} method to write any persistent data (such as user edits)
368 * to storage. In addition, the method
369 * {@link #onSaveInstanceState(Bundle)} is called before placing the activity
370 * in such a background state, allowing you to save away any dynamic instance
371 * state in your activity into the given Bundle, to be later received in
RoboErik55011652014-07-09 15:05:53 -0700372 * {@link #onCreate} if the activity needs to be re-created.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800373 * See the <a href="#ProcessLifecycle">Process Lifecycle</a>
374 * section for more information on how the lifecycle of a process is tied
375 * to the activities it is hosting. Note that it is important to save
376 * persistent data in {@link #onPause} instead of {@link #onSaveInstanceState}
Daisuke Miyakawa5c40f3f2011-02-15 13:24:36 -0800377 * because the latter is not part of the lifecycle callbacks, so will not
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800378 * be called in every situation as described in its documentation.</p>
379 *
Dianne Hackborn0aae2d42010-12-07 23:51:29 -0800380 * <p class="note">Be aware that these semantics will change slightly between
381 * applications targeting platforms starting with {@link android.os.Build.VERSION_CODES#HONEYCOMB}
382 * vs. those targeting prior platforms. Starting with Honeycomb, an application
383 * is not in the killable state until its {@link #onStop} has returned. This
384 * impacts when {@link #onSaveInstanceState(Bundle)} may be called (it may be
385 * safely called after {@link #onPause()} and allows and application to safely
386 * wait until {@link #onStop()} to save persistent state.</p>
387 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800388 * <p>For those methods that are not marked as being killable, the activity's
389 * process will not be killed by the system starting from the time the method
390 * is called and continuing after it returns. Thus an activity is in the killable
391 * state, for example, between after <code>onPause()</code> to the start of
392 * <code>onResume()</code>.</p>
393 *
394 * <a name="ConfigurationChanges"></a>
395 * <h3>Configuration Changes</h3>
RoboErik55011652014-07-09 15:05:53 -0700396 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800397 * <p>If the configuration of the device (as defined by the
398 * {@link Configuration Resources.Configuration} class) changes,
399 * then anything displaying a user interface will need to update to match that
400 * configuration. Because Activity is the primary mechanism for interacting
401 * with the user, it includes special support for handling configuration
402 * changes.</p>
RoboErik55011652014-07-09 15:05:53 -0700403 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800404 * <p>Unless you specify otherwise, a configuration change (such as a change
405 * in screen orientation, language, input devices, etc) will cause your
406 * current activity to be <em>destroyed</em>, going through the normal activity
407 * lifecycle process of {@link #onPause},
408 * {@link #onStop}, and {@link #onDestroy} as appropriate. If the activity
409 * had been in the foreground or visible to the user, once {@link #onDestroy} is
410 * called in that instance then a new instance of the activity will be
411 * created, with whatever savedInstanceState the previous instance had generated
412 * from {@link #onSaveInstanceState}.</p>
RoboErik55011652014-07-09 15:05:53 -0700413 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800414 * <p>This is done because any application resource,
415 * including layout files, can change based on any configuration value. Thus
416 * the only safe way to handle a configuration change is to re-retrieve all
417 * resources, including layouts, drawables, and strings. Because activities
418 * must already know how to save their state and re-create themselves from
419 * that state, this is a convenient way to have an activity restart itself
420 * with a new configuration.</p>
RoboErik55011652014-07-09 15:05:53 -0700421 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800422 * <p>In some special cases, you may want to bypass restarting of your
423 * activity based on one or more types of configuration changes. This is
424 * done with the {@link android.R.attr#configChanges android:configChanges}
425 * attribute in its manifest. For any types of configuration changes you say
426 * that you handle there, you will receive a call to your current activity's
427 * {@link #onConfigurationChanged} method instead of being restarted. If
428 * a configuration change involves any that you do not handle, however, the
429 * activity will still be restarted and {@link #onConfigurationChanged}
430 * will not be called.</p>
RoboErik55011652014-07-09 15:05:53 -0700431 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800432 * <a name="StartingActivities"></a>
433 * <h3>Starting Activities and Getting Results</h3>
434 *
435 * <p>The {@link android.app.Activity#startActivity}
436 * method is used to start a
437 * new activity, which will be placed at the top of the activity stack. It
438 * takes a single argument, an {@link android.content.Intent Intent},
439 * which describes the activity
440 * to be executed.</p>
441 *
442 * <p>Sometimes you want to get a result back from an activity when it
443 * ends. For example, you may start an activity that lets the user pick
444 * a person in a list of contacts; when it ends, it returns the person
445 * that was selected. To do this, you call the
RoboErik55011652014-07-09 15:05:53 -0700446 * {@link android.app.Activity#startActivityForResult(Intent, int)}
447 * version with a second integer parameter identifying the call. The result
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800448 * will come back through your {@link android.app.Activity#onActivityResult}
RoboErik55011652014-07-09 15:05:53 -0700449 * method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800450 *
451 * <p>When an activity exits, it can call
452 * {@link android.app.Activity#setResult(int)}
453 * to return data back to its parent. It must always supply a result code,
454 * which can be the standard results RESULT_CANCELED, RESULT_OK, or any
455 * custom values starting at RESULT_FIRST_USER. In addition, it can optionally
456 * return back an Intent containing any additional data it wants. All of this
457 * information appears back on the
458 * parent's <code>Activity.onActivityResult()</code>, along with the integer
459 * identifier it originally supplied.</p>
460 *
461 * <p>If a child activity fails for any reason (such as crashing), the parent
462 * activity will receive a result with the code RESULT_CANCELED.</p>
463 *
464 * <pre class="prettyprint">
465 * public class MyActivity extends Activity {
466 * ...
467 *
468 * static final int PICK_CONTACT_REQUEST = 0;
469 *
Michael Wright5438e4e2014-07-25 14:05:42 -0700470 * public boolean onKeyDown(int keyCode, KeyEvent event) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800471 * if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) {
472 * // When the user center presses, let them pick a contact.
473 * startActivityForResult(
474 * new Intent(Intent.ACTION_PICK,
475 * new Uri("content://contacts")),
476 * PICK_CONTACT_REQUEST);
477 * return true;
478 * }
479 * return false;
480 * }
481 *
482 * protected void onActivityResult(int requestCode, int resultCode,
483 * Intent data) {
484 * if (requestCode == PICK_CONTACT_REQUEST) {
485 * if (resultCode == RESULT_OK) {
486 * // A contact was picked. Here we will just display it
487 * // to the user.
488 * startActivity(new Intent(Intent.ACTION_VIEW, data));
489 * }
490 * }
491 * }
492 * }
493 * </pre>
494 *
495 * <a name="SavingPersistentState"></a>
496 * <h3>Saving Persistent State</h3>
497 *
498 * <p>There are generally two kinds of persistent state than an activity
499 * will deal with: shared document-like data (typically stored in a SQLite
500 * database using a {@linkplain android.content.ContentProvider content provider})
501 * and internal state such as user preferences.</p>
502 *
503 * <p>For content provider data, we suggest that activities use a
504 * "edit in place" user model. That is, any edits a user makes are effectively
505 * made immediately without requiring an additional confirmation step.
506 * Supporting this model is generally a simple matter of following two rules:</p>
507 *
508 * <ul>
509 * <li> <p>When creating a new document, the backing database entry or file for
510 * it is created immediately. For example, if the user chooses to write
511 * a new e-mail, a new entry for that e-mail is created as soon as they
512 * start entering data, so that if they go to any other activity after
513 * that point this e-mail will now appear in the list of drafts.</p>
514 * <li> <p>When an activity's <code>onPause()</code> method is called, it should
515 * commit to the backing content provider or file any changes the user
516 * has made. This ensures that those changes will be seen by any other
517 * activity that is about to run. You will probably want to commit
518 * your data even more aggressively at key times during your
519 * activity's lifecycle: for example before starting a new
520 * activity, before finishing your own activity, when the user
521 * switches between input fields, etc.</p>
522 * </ul>
523 *
524 * <p>This model is designed to prevent data loss when a user is navigating
525 * between activities, and allows the system to safely kill an activity (because
526 * system resources are needed somewhere else) at any time after it has been
527 * paused. Note this implies
528 * that the user pressing BACK from your activity does <em>not</em>
529 * mean "cancel" -- it means to leave the activity with its current contents
Dianne Hackborn0aae2d42010-12-07 23:51:29 -0800530 * saved away. Canceling edits in an activity must be provided through
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800531 * some other mechanism, such as an explicit "revert" or "undo" option.</p>
532 *
533 * <p>See the {@linkplain android.content.ContentProvider content package} for
534 * more information about content providers. These are a key aspect of how
535 * different activities invoke and propagate data between themselves.</p>
536 *
537 * <p>The Activity class also provides an API for managing internal persistent state
538 * associated with an activity. This can be used, for example, to remember
539 * the user's preferred initial display in a calendar (day view or week view)
540 * or the user's default home page in a web browser.</p>
541 *
542 * <p>Activity persistent state is managed
543 * with the method {@link #getPreferences},
544 * allowing you to retrieve and
545 * modify a set of name/value pairs associated with the activity. To use
546 * preferences that are shared across multiple application components
547 * (activities, receivers, services, providers), you can use the underlying
548 * {@link Context#getSharedPreferences Context.getSharedPreferences()} method
549 * to retrieve a preferences
550 * object stored under a specific name.
551 * (Note that it is not possible to share settings data across application
552 * packages -- for that you will need a content provider.)</p>
553 *
554 * <p>Here is an excerpt from a calendar activity that stores the user's
555 * preferred view mode in its persistent settings:</p>
556 *
557 * <pre class="prettyprint">
558 * public class CalendarActivity extends Activity {
559 * ...
560 *
561 * static final int DAY_VIEW_MODE = 0;
562 * static final int WEEK_VIEW_MODE = 1;
563 *
564 * private SharedPreferences mPrefs;
565 * private int mCurViewMode;
566 *
567 * protected void onCreate(Bundle savedInstanceState) {
568 * super.onCreate(savedInstanceState);
569 *
570 * SharedPreferences mPrefs = getSharedPreferences();
Quddus Chong3fa98cb2012-04-13 11:17:24 -0700571 * mCurViewMode = mPrefs.getInt("view_mode", DAY_VIEW_MODE);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800572 * }
573 *
574 * protected void onPause() {
575 * super.onPause();
RoboErik55011652014-07-09 15:05:53 -0700576 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800577 * SharedPreferences.Editor ed = mPrefs.edit();
578 * ed.putInt("view_mode", mCurViewMode);
579 * ed.commit();
580 * }
581 * }
582 * </pre>
RoboErik55011652014-07-09 15:05:53 -0700583 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800584 * <a name="Permissions"></a>
585 * <h3>Permissions</h3>
RoboErik55011652014-07-09 15:05:53 -0700586 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800587 * <p>The ability to start a particular Activity can be enforced when it is
588 * declared in its
589 * manifest's {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
590 * tag. By doing so, other applications will need to declare a corresponding
591 * {@link android.R.styleable#AndroidManifestUsesPermission &lt;uses-permission&gt;}
592 * element in their own manifest to be able to start that activity.
Dianne Hackborn21c241e2012-03-08 13:57:23 -0800593 *
594 * <p>When starting an Activity you can set {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
595 * Intent.FLAG_GRANT_READ_URI_PERMISSION} and/or {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
596 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} on the Intent. This will grant the
597 * Activity access to the specific URIs in the Intent. Access will remain
598 * until the Activity has finished (it will remain across the hosting
599 * process being killed and other temporary destruction). As of
600 * {@link android.os.Build.VERSION_CODES#GINGERBREAD}, if the Activity
601 * was already created and a new Intent is being delivered to
602 * {@link #onNewIntent(Intent)}, any newly granted URI permissions will be added
603 * to the existing ones it holds.
604 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800605 * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a>
606 * document for more information on permissions and security in general.
RoboErik55011652014-07-09 15:05:53 -0700607 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800608 * <a name="ProcessLifecycle"></a>
609 * <h3>Process Lifecycle</h3>
RoboErik55011652014-07-09 15:05:53 -0700610 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800611 * <p>The Android system attempts to keep application process around for as
612 * long as possible, but eventually will need to remove old processes when
613 * memory runs low. As described in <a href="#ActivityLifecycle">Activity
614 * Lifecycle</a>, the decision about which process to remove is intimately
615 * tied to the state of the user's interaction with it. In general, there
616 * are four states a process can be in based on the activities running in it,
617 * listed here in order of importance. The system will kill less important
618 * processes (the last ones) before it resorts to killing more important
619 * processes (the first ones).
RoboErik55011652014-07-09 15:05:53 -0700620 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800621 * <ol>
622 * <li> <p>The <b>foreground activity</b> (the activity at the top of the screen
623 * that the user is currently interacting with) is considered the most important.
624 * Its process will only be killed as a last resort, if it uses more memory
625 * than is available on the device. Generally at this point the device has
626 * reached a memory paging state, so this is required in order to keep the user
627 * interface responsive.
628 * <li> <p>A <b>visible activity</b> (an activity that is visible to the user
629 * but not in the foreground, such as one sitting behind a foreground dialog)
630 * is considered extremely important and will not be killed unless that is
631 * required to keep the foreground activity running.
632 * <li> <p>A <b>background activity</b> (an activity that is not visible to
633 * the user and has been paused) is no longer critical, so the system may
634 * safely kill its process to reclaim memory for other foreground or
635 * visible processes. If its process needs to be killed, when the user navigates
636 * back to the activity (making it visible on the screen again), its
637 * {@link #onCreate} method will be called with the savedInstanceState it had previously
638 * supplied in {@link #onSaveInstanceState} so that it can restart itself in the same
639 * state as the user last left it.
640 * <li> <p>An <b>empty process</b> is one hosting no activities or other
641 * application components (such as {@link Service} or
642 * {@link android.content.BroadcastReceiver} classes). These are killed very
643 * quickly by the system as memory becomes low. For this reason, any
644 * background operation you do outside of an activity must be executed in the
645 * context of an activity BroadcastReceiver or Service to ensure that the system
646 * knows it needs to keep your process around.
647 * </ol>
RoboErik55011652014-07-09 15:05:53 -0700648 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800649 * <p>Sometimes an Activity may need to do a long-running operation that exists
650 * independently of the activity lifecycle itself. An example may be a camera
651 * application that allows you to upload a picture to a web site. The upload
652 * may take a long time, and the application should allow the user to leave
653 * the application will it is executing. To accomplish this, your Activity
654 * should start a {@link Service} in which the upload takes place. This allows
655 * the system to properly prioritize your process (considering it to be more
656 * important than other non-visible applications) for the duration of the
657 * upload, independent of whether the original activity is paused, stopped,
658 * or finished.
659 */
660public class Activity extends ContextThemeWrapper
Dianne Hackborn625ac272010-09-17 18:29:22 -0700661 implements LayoutInflater.Factory2,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800662 Window.Callback, KeyEvent.Callback,
Adam Powell117b6952014-05-05 18:14:56 -0700663 OnCreateContextMenuListener, ComponentCallbacks2,
664 Window.OnWindowDismissedCallback {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800665 private static final String TAG = "Activity";
Dianne Hackborn162bc0e2012-04-09 14:06:16 -0700666 private static final boolean DEBUG_LIFECYCLE = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800667
668 /** Standard activity result: operation canceled. */
669 public static final int RESULT_CANCELED = 0;
670 /** Standard activity result: operation succeeded. */
671 public static final int RESULT_OK = -1;
672 /** Start of user-defined activity results. */
673 public static final int RESULT_FIRST_USER = 1;
674
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700675 static final String FRAGMENTS_TAG = "android:fragments";
676
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800677 private static final String WINDOW_HIERARCHY_TAG = "android:viewHierarchyState";
678 private static final String SAVED_DIALOG_IDS_KEY = "android:savedDialogIds";
679 private static final String SAVED_DIALOGS_TAG = "android:savedDialogs";
680 private static final String SAVED_DIALOG_KEY_PREFIX = "android:dialog_";
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800681 private static final String SAVED_DIALOG_ARGS_KEY_PREFIX = "android:dialog_args_";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800682
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800683 private static class ManagedDialog {
684 Dialog mDialog;
685 Bundle mArgs;
686 }
687 private SparseArray<ManagedDialog> mManagedDialogs;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800688
689 // set by the thread after the constructor and before onCreate(Bundle savedInstanceState) is called.
690 private Instrumentation mInstrumentation;
691 private IBinder mToken;
Dianne Hackbornb06ea702009-07-13 13:07:51 -0700692 private int mIdent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800693 /*package*/ String mEmbeddedID;
694 private Application mApplication;
Christopher Tateb70f3df2009-04-07 16:07:59 -0700695 /*package*/ Intent mIntent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -0800696 /*package*/ String mReferrer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800697 private ComponentName mComponent;
698 /*package*/ ActivityInfo mActivityInfo;
699 /*package*/ ActivityThread mMainThread;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800700 Activity mParent;
701 boolean mCalled;
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700702 boolean mCheckedForLoaderManager;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700703 boolean mLoadersStarted;
Jeff Hamilton52d32032011-01-08 15:31:26 -0600704 /*package*/ boolean mResumed;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800705 private boolean mStopped;
706 boolean mFinished;
707 boolean mStartedActivity;
Dianne Hackborn6d9dcbc2012-10-02 17:51:13 -0700708 private boolean mDestroyed;
Dianne Hackborn2286cdc2013-07-01 19:10:06 -0700709 private boolean mDoReportFullyDrawn = true;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700710 /** true if the activity is going through a transient pause */
711 /*package*/ boolean mTemporaryPause = false;
Jeff Hamilton3d32f6e2010-04-01 00:04:16 -0500712 /** true if the activity is being destroyed in order to recreate it with a new configuration */
713 /*package*/ boolean mChangingConfigurations = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800714 /*package*/ int mConfigChangeFlags;
715 /*package*/ Configuration mCurrentConfig;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +0100716 private SearchManager mSearchManager;
Adam Powell88ab6972011-07-28 11:25:01 -0700717 private MenuInflater mMenuInflater;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800718
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700719 static final class NonConfigurationInstances {
720 Object activity;
721 HashMap<String, Object> children;
722 ArrayList<Fragment> fragments;
Dianne Hackborn3e82ba12013-07-16 13:23:55 -0700723 ArrayMap<String, LoaderManagerImpl> loaders;
Dianne Hackborn20d94742014-05-29 18:35:45 -0700724 VoiceInteractor voiceInteractor;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700725 }
726 /* package */ NonConfigurationInstances mLastNonConfigurationInstances;
RoboErik55011652014-07-09 15:05:53 -0700727
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800728 private Window mWindow;
729
730 private WindowManager mWindowManager;
731 /*package*/ View mDecor = null;
732 /*package*/ boolean mWindowAdded = false;
733 /*package*/ boolean mVisibleFromServer = false;
734 /*package*/ boolean mVisibleFromClient = true;
Adam Powelle43340c2014-03-17 19:10:43 -0700735 /*package*/ ActionBar mActionBar = null;
Adam Powelldd8fab22012-03-22 17:47:27 -0700736 private boolean mEnableDefaultActionBarUp;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800737
Dianne Hackborn91097de2014-04-04 18:02:06 -0700738 private VoiceInteractor mVoiceInteractor;
739
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800740 private CharSequence mTitle;
741 private int mTitleColor = 0;
742
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700743 final FragmentManagerImpl mFragments = new FragmentManagerImpl();
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700744 final FragmentContainer mContainer = new FragmentContainer() {
745 @Override
746 public View findViewById(int id) {
747 return Activity.this.findViewById(id);
748 }
George Mount0b26e4d2014-09-17 16:36:42 -0700749 @Override
750 public boolean hasView() {
751 Window window = Activity.this.getWindow();
752 return (window != null && window.peekDecorView() != null);
753 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700754 };
Craig Mautneree2e45a2014-06-27 12:10:03 -0700755
Jose Lima4b6c6692014-08-12 17:41:12 -0700756 // Most recent call to requestVisibleBehind().
757 boolean mVisibleBehind;
Craig Mautneree2e45a2014-06-27 12:10:03 -0700758
Dianne Hackborn3e82ba12013-07-16 13:23:55 -0700759 ArrayMap<String, LoaderManagerImpl> mAllLoaderManagers;
Dianne Hackborn4911b782010-07-15 12:54:39 -0700760 LoaderManagerImpl mLoaderManager;
Craig Mautneree2e45a2014-06-27 12:10:03 -0700761
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800762 private static final class ManagedCursor {
763 ManagedCursor(Cursor cursor) {
764 mCursor = cursor;
765 mReleased = false;
766 mUpdated = false;
767 }
768
769 private final Cursor mCursor;
770 private boolean mReleased;
771 private boolean mUpdated;
772 }
773 private final ArrayList<ManagedCursor> mManagedCursors =
774 new ArrayList<ManagedCursor>();
775
RoboErik55011652014-07-09 15:05:53 -0700776 // protected by synchronized (this)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800777 int mResultCode = RESULT_CANCELED;
778 Intent mResultData = null;
Craig Mautneree2e45a2014-06-27 12:10:03 -0700779
Craig Mautner5eda9b32013-07-02 11:58:16 -0700780 private TranslucentConversionListener mTranslucentCallback;
Craig Mautnerbc57cd12013-08-19 15:47:42 -0700781 private boolean mChangeCanvasToTranslucent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800782
783 private boolean mTitleReady = false;
784
785 private int mDefaultKeyMode = DEFAULT_KEYS_DISABLE;
786 private SpannableStringBuilder mDefaultKeySsb = null;
RoboErik55011652014-07-09 15:05:53 -0700787
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800788 protected static final int[] FOCUSED_STATE_SET = {com.android.internal.R.attr.state_focused};
789
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700790 @SuppressWarnings("unused")
Jeff Brown7e442832011-06-10 18:00:16 -0700791 private final Object mInstanceTracker = StrictMode.trackActivity(this);
792
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800793 private Thread mUiThread;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700794 final Handler mHandler = new Handler();
George Mount62ab9b72014-05-02 13:51:17 -0700795
George Mount1fecfb22014-06-18 14:55:55 -0700796 ActivityTransitionState mActivityTransitionState = new ActivityTransitionState();
George Mount65580562014-08-29 08:15:48 -0700797 SharedElementCallback mEnterTransitionListener = SharedElementCallback.NULL_CALLBACK;
798 SharedElementCallback mExitTransitionListener = SharedElementCallback.NULL_CALLBACK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800799
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800800 /** Return the intent that started this activity. */
801 public Intent getIntent() {
802 return mIntent;
803 }
804
RoboErik55011652014-07-09 15:05:53 -0700805 /**
806 * Change the intent returned by {@link #getIntent}. This holds a
807 * reference to the given intent; it does not copy it. Often used in
808 * conjunction with {@link #onNewIntent}.
809 *
810 * @param newIntent The new Intent object to return from getIntent
811 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800812 * @see #getIntent
813 * @see #onNewIntent
RoboErik55011652014-07-09 15:05:53 -0700814 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800815 public void setIntent(Intent newIntent) {
816 mIntent = newIntent;
817 }
818
819 /** Return the application that owns this activity. */
820 public final Application getApplication() {
821 return mApplication;
822 }
823
824 /** Is this activity embedded inside of another activity? */
825 public final boolean isChild() {
826 return mParent != null;
827 }
RoboErik55011652014-07-09 15:05:53 -0700828
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800829 /** Return the parent activity if this view is an embedded child. */
830 public final Activity getParent() {
831 return mParent;
832 }
833
834 /** Retrieve the window manager for showing custom windows. */
835 public WindowManager getWindowManager() {
836 return mWindowManager;
837 }
838
839 /**
840 * Retrieve the current {@link android.view.Window} for the activity.
841 * This can be used to directly access parts of the Window API that
842 * are not available through Activity/Screen.
RoboErik55011652014-07-09 15:05:53 -0700843 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800844 * @return Window The current window, or null if the activity is not
845 * visual.
846 */
847 public Window getWindow() {
848 return mWindow;
849 }
850
851 /**
Mark Doliner9525f2a2014-01-02 11:17:47 -0800852 * Return the LoaderManager for this activity, creating it if needed.
Dianne Hackbornc8017682010-07-06 13:34:38 -0700853 */
854 public LoaderManager getLoaderManager() {
855 if (mLoaderManager != null) {
856 return mLoaderManager;
857 }
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700858 mCheckedForLoaderManager = true;
Dianne Hackborn3e82ba12013-07-16 13:23:55 -0700859 mLoaderManager = getLoaderManager("(root)", mLoadersStarted, true);
Dianne Hackbornc8017682010-07-06 13:34:38 -0700860 return mLoaderManager;
861 }
RoboErik55011652014-07-09 15:05:53 -0700862
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700863 LoaderManagerImpl getLoaderManager(String who, boolean started, boolean create) {
Dianne Hackbornc8017682010-07-06 13:34:38 -0700864 if (mAllLoaderManagers == null) {
Dianne Hackborn3e82ba12013-07-16 13:23:55 -0700865 mAllLoaderManagers = new ArrayMap<String, LoaderManagerImpl>();
Dianne Hackbornc8017682010-07-06 13:34:38 -0700866 }
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700867 LoaderManagerImpl lm = mAllLoaderManagers.get(who);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700868 if (lm == null) {
869 if (create) {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -0700870 lm = new LoaderManagerImpl(who, this, started);
871 mAllLoaderManagers.put(who, lm);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700872 }
873 } else {
874 lm.updateActivity(this);
Dianne Hackbornc8017682010-07-06 13:34:38 -0700875 }
876 return lm;
877 }
RoboErik55011652014-07-09 15:05:53 -0700878
Dianne Hackbornc8017682010-07-06 13:34:38 -0700879 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800880 * Calls {@link android.view.Window#getCurrentFocus} on the
881 * Window of this Activity to return the currently focused view.
RoboErik55011652014-07-09 15:05:53 -0700882 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800883 * @return View The current View with focus or null.
RoboErik55011652014-07-09 15:05:53 -0700884 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800885 * @see #getWindow
886 * @see android.view.Window#getCurrentFocus
887 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700888 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800889 public View getCurrentFocus() {
890 return mWindow != null ? mWindow.getCurrentFocus() : null;
891 }
892
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800893 /**
894 * Called when the activity is starting. This is where most initialization
895 * should go: calling {@link #setContentView(int)} to inflate the
896 * activity's UI, using {@link #findViewById} to programmatically interact
897 * with widgets in the UI, calling
898 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)} to retrieve
899 * cursors for data being displayed, etc.
RoboErik55011652014-07-09 15:05:53 -0700900 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800901 * <p>You can call {@link #finish} from within this function, in
902 * which case onDestroy() will be immediately called without any of the rest
903 * of the activity lifecycle ({@link #onStart}, {@link #onResume},
904 * {@link #onPause}, etc) executing.
RoboErik55011652014-07-09 15:05:53 -0700905 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800906 * <p><em>Derived classes must call through to the super class's
907 * implementation of this method. If they do not, an exception will be
908 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -0700909 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800910 * @param savedInstanceState If the activity is being re-initialized after
911 * previously being shut down then this Bundle contains the data it most
912 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
RoboErik55011652014-07-09 15:05:53 -0700913 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800914 * @see #onStart
915 * @see #onSaveInstanceState
916 * @see #onRestoreInstanceState
917 * @see #onPostCreate
918 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700919 protected void onCreate(@Nullable Bundle savedInstanceState) {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -0700920 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onCreate " + this + ": " + savedInstanceState);
Dianne Hackborn2707d602010-07-09 18:01:20 -0700921 if (mLastNonConfigurationInstances != null) {
922 mAllLoaderManagers = mLastNonConfigurationInstances.loaders;
923 }
Adam Powelldd8fab22012-03-22 17:47:27 -0700924 if (mActivityInfo.parentActivityName != null) {
925 if (mActionBar == null) {
926 mEnableDefaultActionBarUp = true;
927 } else {
928 mActionBar.setDefaultDisplayHomeAsUpEnabled(true);
929 }
930 }
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700931 if (savedInstanceState != null) {
932 Parcelable p = savedInstanceState.getParcelable(FRAGMENTS_TAG);
933 mFragments.restoreAllState(p, mLastNonConfigurationInstances != null
934 ? mLastNonConfigurationInstances.fragments : null);
935 }
936 mFragments.dispatchCreate();
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700937 getApplication().dispatchActivityCreated(this, savedInstanceState);
Dianne Hackborn20d94742014-05-29 18:35:45 -0700938 if (mVoiceInteractor != null) {
939 mVoiceInteractor.attachActivity(this);
940 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800941 mCalled = true;
942 }
943
944 /**
Craig Mautnera0026042014-04-23 11:45:37 -0700945 * Same as {@link #onCreate(android.os.Bundle)} but called for those activities created with
Craig Mautner43e52ed2014-06-16 17:18:52 -0700946 * the attribute {@link android.R.attr#persistableMode} set to
947 * <code>persistAcrossReboots</code>.
Craig Mautnera0026042014-04-23 11:45:37 -0700948 *
949 * @param savedInstanceState if the activity is being re-initialized after
950 * previously being shut down then this Bundle contains the data it most
951 * recently supplied in {@link #onSaveInstanceState}.
952 * <b><i>Note: Otherwise it is null.</i></b>
953 * @param persistentState if the activity is being re-initialized after
954 * previously being shut down or powered off then this Bundle contains the data it most
955 * recently supplied to outPersistentState in {@link #onSaveInstanceState}.
956 * <b><i>Note: Otherwise it is null.</i></b>
957 *
958 * @see #onCreate(android.os.Bundle)
959 * @see #onStart
960 * @see #onSaveInstanceState
961 * @see #onRestoreInstanceState
962 * @see #onPostCreate
963 */
Craig Mautner7a629c22014-09-04 14:57:04 -0700964 public void onCreate(@Nullable Bundle savedInstanceState,
Craig Mautnera0026042014-04-23 11:45:37 -0700965 @Nullable PersistableBundle persistentState) {
966 onCreate(savedInstanceState);
967 }
968
969 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800970 * The hook for {@link ActivityThread} to restore the state of this activity.
971 *
972 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and
973 * {@link #restoreManagedDialogs(android.os.Bundle)}.
974 *
975 * @param savedInstanceState contains the saved state
976 */
977 final void performRestoreInstanceState(Bundle savedInstanceState) {
978 onRestoreInstanceState(savedInstanceState);
979 restoreManagedDialogs(savedInstanceState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800980 }
981
982 /**
Craig Mautnera0026042014-04-23 11:45:37 -0700983 * The hook for {@link ActivityThread} to restore the state of this activity.
984 *
985 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and
986 * {@link #restoreManagedDialogs(android.os.Bundle)}.
987 *
988 * @param savedInstanceState contains the saved state
989 * @param persistentState contains the persistable saved state
990 */
991 final void performRestoreInstanceState(Bundle savedInstanceState,
992 PersistableBundle persistentState) {
993 onRestoreInstanceState(savedInstanceState, persistentState);
994 if (savedInstanceState != null) {
995 restoreManagedDialogs(savedInstanceState);
996 }
997 }
998
999 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001000 * This method is called after {@link #onStart} when the activity is
1001 * being re-initialized from a previously saved state, given here in
Mike LeBeau305de9d2010-03-11 09:21:08 -08001002 * <var>savedInstanceState</var>. Most implementations will simply use {@link #onCreate}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001003 * to restore their state, but it is sometimes convenient to do it here
1004 * after all of the initialization has been done or to allow subclasses to
1005 * decide whether to use your default implementation. The default
1006 * implementation of this method performs a restore of any view state that
1007 * had previously been frozen by {@link #onSaveInstanceState}.
RoboErik55011652014-07-09 15:05:53 -07001008 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001009 * <p>This method is called between {@link #onStart} and
1010 * {@link #onPostCreate}.
RoboErik55011652014-07-09 15:05:53 -07001011 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001012 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}.
RoboErik55011652014-07-09 15:05:53 -07001013 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001014 * @see #onCreate
1015 * @see #onPostCreate
1016 * @see #onResume
1017 * @see #onSaveInstanceState
1018 */
1019 protected void onRestoreInstanceState(Bundle savedInstanceState) {
1020 if (mWindow != null) {
1021 Bundle windowState = savedInstanceState.getBundle(WINDOW_HIERARCHY_TAG);
1022 if (windowState != null) {
1023 mWindow.restoreHierarchyState(windowState);
1024 }
1025 }
1026 }
Craig Mautnera0026042014-04-23 11:45:37 -07001027
1028 /**
1029 * This is the same as {@link #onRestoreInstanceState(Bundle)} but is called for activities
Craig Mautner43e52ed2014-06-16 17:18:52 -07001030 * created with the attribute {@link android.R.attr#persistableMode} set to
1031 * <code>persistAcrossReboots</code>. The {@link android.os.PersistableBundle} passed
1032 * came from the restored PersistableBundle first
Craig Mautnera0026042014-04-23 11:45:37 -07001033 * saved in {@link #onSaveInstanceState(Bundle, PersistableBundle)}.
1034 *
1035 * <p>This method is called between {@link #onStart} and
1036 * {@link #onPostCreate}.
1037 *
1038 * <p>If this method is called {@link #onRestoreInstanceState(Bundle)} will not be called.
1039 *
1040 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}.
1041 * @param persistentState the data most recently supplied in {@link #onSaveInstanceState}.
1042 *
1043 * @see #onRestoreInstanceState(Bundle)
1044 * @see #onCreate
1045 * @see #onPostCreate
1046 * @see #onResume
1047 * @see #onSaveInstanceState
1048 */
Craig Mautner7a629c22014-09-04 14:57:04 -07001049 public void onRestoreInstanceState(Bundle savedInstanceState,
Craig Mautnera0026042014-04-23 11:45:37 -07001050 PersistableBundle persistentState) {
1051 if (savedInstanceState != null) {
1052 onRestoreInstanceState(savedInstanceState);
1053 }
1054 }
1055
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001056 /**
1057 * Restore the state of any saved managed dialogs.
1058 *
1059 * @param savedInstanceState The bundle to restore from.
1060 */
1061 private void restoreManagedDialogs(Bundle savedInstanceState) {
1062 final Bundle b = savedInstanceState.getBundle(SAVED_DIALOGS_TAG);
1063 if (b == null) {
1064 return;
1065 }
1066
1067 final int[] ids = b.getIntArray(SAVED_DIALOG_IDS_KEY);
1068 final int numDialogs = ids.length;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001069 mManagedDialogs = new SparseArray<ManagedDialog>(numDialogs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001070 for (int i = 0; i < numDialogs; i++) {
1071 final Integer dialogId = ids[i];
1072 Bundle dialogState = b.getBundle(savedDialogKeyFor(dialogId));
1073 if (dialogState != null) {
Romain Guye35c2352009-06-19 13:18:12 -07001074 // Calling onRestoreInstanceState() below will invoke dispatchOnCreate
1075 // so tell createDialog() not to do it, otherwise we get an exception
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001076 final ManagedDialog md = new ManagedDialog();
1077 md.mArgs = b.getBundle(savedDialogArgsKeyFor(dialogId));
1078 md.mDialog = createDialog(dialogId, dialogState, md.mArgs);
1079 if (md.mDialog != null) {
1080 mManagedDialogs.put(dialogId, md);
1081 onPrepareDialog(dialogId, md.mDialog, md.mArgs);
1082 md.mDialog.onRestoreInstanceState(dialogState);
1083 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001084 }
1085 }
1086 }
1087
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001088 private Dialog createDialog(Integer dialogId, Bundle state, Bundle args) {
1089 final Dialog dialog = onCreateDialog(dialogId, args);
Romain Guy764d5332009-06-17 16:52:22 -07001090 if (dialog == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001091 return null;
Romain Guy764d5332009-06-17 16:52:22 -07001092 }
Romain Guy6de4aed2009-07-08 10:54:45 -07001093 dialog.dispatchOnCreate(state);
Romain Guy764d5332009-06-17 16:52:22 -07001094 return dialog;
1095 }
1096
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001097 private static String savedDialogKeyFor(int key) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001098 return SAVED_DIALOG_KEY_PREFIX + key;
1099 }
1100
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001101 private static String savedDialogArgsKeyFor(int key) {
1102 return SAVED_DIALOG_ARGS_KEY_PREFIX + key;
1103 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001104
1105 /**
1106 * Called when activity start-up is complete (after {@link #onStart}
1107 * and {@link #onRestoreInstanceState} have been called). Applications will
1108 * generally not implement this method; it is intended for system
1109 * classes to do final initialization after application code has run.
RoboErik55011652014-07-09 15:05:53 -07001110 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001111 * <p><em>Derived classes must call through to the super class's
1112 * implementation of this method. If they do not, an exception will be
1113 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001114 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001115 * @param savedInstanceState If the activity is being re-initialized after
1116 * previously being shut down then this Bundle contains the data it most
1117 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
1118 * @see #onCreate
1119 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001120 protected void onPostCreate(@Nullable Bundle savedInstanceState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001121 if (!isChild()) {
1122 mTitleReady = true;
1123 onTitleChanged(getTitle(), getTitleColor());
1124 }
1125 mCalled = true;
1126 }
1127
1128 /**
Craig Mautnera0026042014-04-23 11:45:37 -07001129 * This is the same as {@link #onPostCreate(Bundle)} but is called for activities
Craig Mautner43e52ed2014-06-16 17:18:52 -07001130 * created with the attribute {@link android.R.attr#persistableMode} set to
1131 * <code>persistAcrossReboots</code>.
Craig Mautnera0026042014-04-23 11:45:37 -07001132 *
1133 * @param savedInstanceState The data most recently supplied in {@link #onSaveInstanceState}
1134 * @param persistentState The data caming from the PersistableBundle first
1135 * saved in {@link #onSaveInstanceState(Bundle, PersistableBundle)}.
1136 *
1137 * @see #onCreate
1138 */
Craig Mautner7a629c22014-09-04 14:57:04 -07001139 public void onPostCreate(@Nullable Bundle savedInstanceState,
Craig Mautnera0026042014-04-23 11:45:37 -07001140 @Nullable PersistableBundle persistentState) {
1141 onPostCreate(savedInstanceState);
1142 }
1143
1144 /**
RoboErik55011652014-07-09 15:05:53 -07001145 * Called after {@link #onCreate} &mdash; or after {@link #onRestart} when
1146 * the activity had been stopped, but is now again being displayed to the
John Spurlock8a985d22014-02-25 09:40:05 -05001147 * user. It will be followed by {@link #onResume}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001148 *
1149 * <p><em>Derived classes must call through to the super class's
1150 * implementation of this method. If they do not, an exception will be
1151 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001152 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001153 * @see #onCreate
1154 * @see #onStop
1155 * @see #onResume
1156 */
1157 protected void onStart() {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001158 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onStart " + this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001159 mCalled = true;
RoboErik55011652014-07-09 15:05:53 -07001160
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07001161 if (!mLoadersStarted) {
1162 mLoadersStarted = true;
1163 if (mLoaderManager != null) {
1164 mLoaderManager.doStart();
1165 } else if (!mCheckedForLoaderManager) {
Dianne Hackborn3e82ba12013-07-16 13:23:55 -07001166 mLoaderManager = getLoaderManager("(root)", mLoadersStarted, false);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07001167 }
1168 mCheckedForLoaderManager = true;
Dianne Hackborn2707d602010-07-09 18:01:20 -07001169 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001170
1171 getApplication().dispatchActivityStarted(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001172 }
1173
1174 /**
1175 * Called after {@link #onStop} when the current activity is being
1176 * re-displayed to the user (the user has navigated back to it). It will
1177 * be followed by {@link #onStart} and then {@link #onResume}.
1178 *
1179 * <p>For activities that are using raw {@link Cursor} objects (instead of
1180 * creating them through
1181 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)},
1182 * this is usually the place
1183 * where the cursor should be requeried (because you had deactivated it in
1184 * {@link #onStop}.
RoboErik55011652014-07-09 15:05:53 -07001185 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001186 * <p><em>Derived classes must call through to the super class's
1187 * implementation of this method. If they do not, an exception will be
1188 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001189 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001190 * @see #onStop
1191 * @see #onStart
1192 * @see #onResume
1193 */
1194 protected void onRestart() {
1195 mCalled = true;
1196 }
1197
1198 /**
1199 * Called after {@link #onRestoreInstanceState}, {@link #onRestart}, or
1200 * {@link #onPause}, for your activity to start interacting with the user.
1201 * This is a good place to begin animations, open exclusive-access devices
1202 * (such as the camera), etc.
1203 *
1204 * <p>Keep in mind that onResume is not the best indicator that your activity
1205 * is visible to the user; a system window such as the keyguard may be in
1206 * front. Use {@link #onWindowFocusChanged} to know for certain that your
1207 * activity is visible to the user (for example, to resume a game).
1208 *
1209 * <p><em>Derived classes must call through to the super class's
1210 * implementation of this method. If they do not, an exception will be
1211 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001212 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001213 * @see #onRestoreInstanceState
1214 * @see #onRestart
1215 * @see #onPostResume
1216 * @see #onPause
1217 */
1218 protected void onResume() {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001219 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onResume " + this);
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001220 getApplication().dispatchActivityResumed(this);
George Mount8cab50a2014-05-15 09:57:17 -07001221 mActivityTransitionState.onResume();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001222 mCalled = true;
1223 }
1224
1225 /**
1226 * Called when activity resume is complete (after {@link #onResume} has
1227 * been called). Applications will generally not implement this method;
1228 * it is intended for system classes to do final setup after application
1229 * resume code has run.
RoboErik55011652014-07-09 15:05:53 -07001230 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001231 * <p><em>Derived classes must call through to the super class's
1232 * implementation of this method. If they do not, an exception will be
1233 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001234 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001235 * @see #onResume
1236 */
1237 protected void onPostResume() {
1238 final Window win = getWindow();
1239 if (win != null) win.makeActive();
Adam Powell50efbed2011-02-08 16:20:15 -08001240 if (mActionBar != null) mActionBar.setShowHideAnimationEnabled(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001241 mCalled = true;
1242 }
1243
1244 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07001245 * Check whether this activity is running as part of a voice interaction with the user.
1246 * If true, it should perform its interaction with the user through the
1247 * {@link VoiceInteractor} returned by {@link #getVoiceInteractor}.
1248 */
1249 public boolean isVoiceInteraction() {
1250 return mVoiceInteractor != null;
1251 }
1252
1253 /**
1254 * Retrieve the active {@link VoiceInteractor} that the user is going through to
1255 * interact with this activity.
1256 */
1257 public VoiceInteractor getVoiceInteractor() {
1258 return mVoiceInteractor;
1259 }
1260
1261 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001262 * This is called for activities that set launchMode to "singleTop" in
1263 * their package, or if a client used the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP}
1264 * flag when calling {@link #startActivity}. In either case, when the
1265 * activity is re-launched while at the top of the activity stack instead
1266 * of a new instance of the activity being started, onNewIntent() will be
1267 * called on the existing instance with the Intent that was used to
RoboErik55011652014-07-09 15:05:53 -07001268 * re-launch it.
1269 *
1270 * <p>An activity will always be paused before receiving a new intent, so
1271 * you can count on {@link #onResume} being called after this method.
1272 *
1273 * <p>Note that {@link #getIntent} still returns the original Intent. You
1274 * can use {@link #setIntent} to update it to this new Intent.
1275 *
1276 * @param intent The new intent that was started for the activity.
1277 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001278 * @see #getIntent
RoboErik55011652014-07-09 15:05:53 -07001279 * @see #setIntent
1280 * @see #onResume
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001281 */
1282 protected void onNewIntent(Intent intent) {
1283 }
1284
1285 /**
1286 * The hook for {@link ActivityThread} to save the state of this activity.
1287 *
1288 * Calls {@link #onSaveInstanceState(android.os.Bundle)}
1289 * and {@link #saveManagedDialogs(android.os.Bundle)}.
1290 *
1291 * @param outState The bundle to save the state to.
1292 */
1293 final void performSaveInstanceState(Bundle outState) {
1294 onSaveInstanceState(outState);
1295 saveManagedDialogs(outState);
George Mount62ab9b72014-05-02 13:51:17 -07001296 mActivityTransitionState.saveState(outState);
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001297 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onSaveInstanceState " + this + ": " + outState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001298 }
1299
1300 /**
Craig Mautnera0026042014-04-23 11:45:37 -07001301 * The hook for {@link ActivityThread} to save the state of this activity.
1302 *
1303 * Calls {@link #onSaveInstanceState(android.os.Bundle)}
1304 * and {@link #saveManagedDialogs(android.os.Bundle)}.
1305 *
1306 * @param outState The bundle to save the state to.
1307 * @param outPersistentState The bundle to save persistent state to.
1308 */
1309 final void performSaveInstanceState(Bundle outState, PersistableBundle outPersistentState) {
1310 onSaveInstanceState(outState, outPersistentState);
1311 saveManagedDialogs(outState);
1312 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onSaveInstanceState " + this + ": " + outState +
1313 ", " + outPersistentState);
1314 }
1315
1316 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001317 * Called to retrieve per-instance state from an activity before being killed
1318 * so that the state can be restored in {@link #onCreate} or
1319 * {@link #onRestoreInstanceState} (the {@link Bundle} populated by this method
1320 * will be passed to both).
1321 *
1322 * <p>This method is called before an activity may be killed so that when it
1323 * comes back some time in the future it can restore its state. For example,
1324 * if activity B is launched in front of activity A, and at some point activity
1325 * A is killed to reclaim resources, activity A will have a chance to save the
1326 * current state of its user interface via this method so that when the user
1327 * returns to activity A, the state of the user interface can be restored
1328 * via {@link #onCreate} or {@link #onRestoreInstanceState}.
1329 *
1330 * <p>Do not confuse this method with activity lifecycle callbacks such as
1331 * {@link #onPause}, which is always called when an activity is being placed
1332 * in the background or on its way to destruction, or {@link #onStop} which
1333 * is called before destruction. One example of when {@link #onPause} and
1334 * {@link #onStop} is called and not this method is when a user navigates back
1335 * from activity B to activity A: there is no need to call {@link #onSaveInstanceState}
1336 * on B because that particular instance will never be restored, so the
1337 * system avoids calling it. An example when {@link #onPause} is called and
1338 * not {@link #onSaveInstanceState} is when activity B is launched in front of activity A:
1339 * the system may avoid calling {@link #onSaveInstanceState} on activity A if it isn't
1340 * killed during the lifetime of B since the state of the user interface of
1341 * A will stay intact.
1342 *
1343 * <p>The default implementation takes care of most of the UI per-instance
1344 * state for you by calling {@link android.view.View#onSaveInstanceState()} on each
1345 * view in the hierarchy that has an id, and by saving the id of the currently
1346 * focused view (all of which is restored by the default implementation of
1347 * {@link #onRestoreInstanceState}). If you override this method to save additional
1348 * information not captured by each individual view, you will likely want to
1349 * call through to the default implementation, otherwise be prepared to save
1350 * all of the state of each view yourself.
1351 *
1352 * <p>If called, this method will occur before {@link #onStop}. There are
1353 * no guarantees about whether it will occur before or after {@link #onPause}.
RoboErik55011652014-07-09 15:05:53 -07001354 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001355 * @param outState Bundle in which to place your saved state.
RoboErik55011652014-07-09 15:05:53 -07001356 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001357 * @see #onCreate
1358 * @see #onRestoreInstanceState
1359 * @see #onPause
1360 */
1361 protected void onSaveInstanceState(Bundle outState) {
1362 outState.putBundle(WINDOW_HIERARCHY_TAG, mWindow.saveHierarchyState());
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001363 Parcelable p = mFragments.saveAllState();
1364 if (p != null) {
1365 outState.putParcelable(FRAGMENTS_TAG, p);
1366 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001367 getApplication().dispatchActivitySaveInstanceState(this, outState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001368 }
1369
1370 /**
Craig Mautnera0026042014-04-23 11:45:37 -07001371 * This is the same as {@link #onSaveInstanceState} but is called for activities
Craig Mautner43e52ed2014-06-16 17:18:52 -07001372 * created with the attribute {@link android.R.attr#persistableMode} set to
1373 * <code>persistAcrossReboots</code>. The {@link android.os.PersistableBundle} passed
1374 * in will be saved and presented in {@link #onCreate(Bundle, PersistableBundle)}
1375 * the first time that this activity is restarted following the next device reboot.
Craig Mautnera0026042014-04-23 11:45:37 -07001376 *
1377 * @param outState Bundle in which to place your saved state.
1378 * @param outPersistentState State which will be saved across reboots.
1379 *
1380 * @see #onSaveInstanceState(Bundle)
1381 * @see #onCreate
1382 * @see #onRestoreInstanceState(Bundle, PersistableBundle)
1383 * @see #onPause
1384 */
Craig Mautner7a629c22014-09-04 14:57:04 -07001385 public void onSaveInstanceState(Bundle outState, PersistableBundle outPersistentState) {
Craig Mautnera0026042014-04-23 11:45:37 -07001386 onSaveInstanceState(outState);
1387 }
1388
1389 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001390 * Save the state of any managed dialogs.
1391 *
1392 * @param outState place to store the saved state.
1393 */
1394 private void saveManagedDialogs(Bundle outState) {
1395 if (mManagedDialogs == null) {
1396 return;
1397 }
1398
1399 final int numDialogs = mManagedDialogs.size();
1400 if (numDialogs == 0) {
1401 return;
1402 }
1403
1404 Bundle dialogState = new Bundle();
1405
1406 int[] ids = new int[mManagedDialogs.size()];
1407
1408 // save each dialog's bundle, gather the ids
1409 for (int i = 0; i < numDialogs; i++) {
1410 final int key = mManagedDialogs.keyAt(i);
1411 ids[i] = key;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001412 final ManagedDialog md = mManagedDialogs.valueAt(i);
1413 dialogState.putBundle(savedDialogKeyFor(key), md.mDialog.onSaveInstanceState());
1414 if (md.mArgs != null) {
1415 dialogState.putBundle(savedDialogArgsKeyFor(key), md.mArgs);
1416 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001417 }
1418
1419 dialogState.putIntArray(SAVED_DIALOG_IDS_KEY, ids);
1420 outState.putBundle(SAVED_DIALOGS_TAG, dialogState);
1421 }
1422
1423
1424 /**
1425 * Called as part of the activity lifecycle when an activity is going into
1426 * the background, but has not (yet) been killed. The counterpart to
1427 * {@link #onResume}.
1428 *
1429 * <p>When activity B is launched in front of activity A, this callback will
1430 * be invoked on A. B will not be created until A's {@link #onPause} returns,
1431 * so be sure to not do anything lengthy here.
1432 *
1433 * <p>This callback is mostly used for saving any persistent state the
1434 * activity is editing, to present a "edit in place" model to the user and
1435 * making sure nothing is lost if there are not enough resources to start
1436 * the new activity without first killing this one. This is also a good
1437 * place to do things like stop animations and other things that consume a
Pin Ting14a93102012-04-25 11:27:03 +08001438 * noticeable amount of CPU in order to make the switch to the next activity
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001439 * as fast as possible, or to close resources that are exclusive access
1440 * such as the camera.
RoboErik55011652014-07-09 15:05:53 -07001441 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001442 * <p>In situations where the system needs more memory it may kill paused
1443 * processes to reclaim resources. Because of this, you should be sure
1444 * that all of your state is saved by the time you return from
1445 * this function. In general {@link #onSaveInstanceState} is used to save
1446 * per-instance state in the activity and this method is used to store
1447 * global persistent data (in content providers, files, etc.)
RoboErik55011652014-07-09 15:05:53 -07001448 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001449 * <p>After receiving this call you will usually receive a following call
1450 * to {@link #onStop} (after the next activity has been resumed and
1451 * displayed), however in some cases there will be a direct call back to
1452 * {@link #onResume} without going through the stopped state.
RoboErik55011652014-07-09 15:05:53 -07001453 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001454 * <p><em>Derived classes must call through to the super class's
1455 * implementation of this method. If they do not, an exception will be
1456 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001457 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001458 * @see #onResume
1459 * @see #onSaveInstanceState
1460 * @see #onStop
1461 */
1462 protected void onPause() {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001463 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onPause " + this);
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001464 getApplication().dispatchActivityPaused(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001465 mCalled = true;
1466 }
1467
1468 /**
1469 * Called as part of the activity lifecycle when an activity is about to go
1470 * into the background as the result of user choice. For example, when the
1471 * user presses the Home key, {@link #onUserLeaveHint} will be called, but
1472 * when an incoming phone call causes the in-call Activity to be automatically
1473 * brought to the foreground, {@link #onUserLeaveHint} will not be called on
1474 * the activity being interrupted. In cases when it is invoked, this method
1475 * is called right before the activity's {@link #onPause} callback.
RoboErik55011652014-07-09 15:05:53 -07001476 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001477 * <p>This callback and {@link #onUserInteraction} are intended to help
1478 * activities manage status bar notifications intelligently; specifically,
1479 * for helping activities determine the proper time to cancel a notfication.
RoboErik55011652014-07-09 15:05:53 -07001480 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001481 * @see #onUserInteraction()
1482 */
1483 protected void onUserLeaveHint() {
1484 }
RoboErik55011652014-07-09 15:05:53 -07001485
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001486 /**
1487 * Generate a new thumbnail for this activity. This method is called before
1488 * pausing the activity, and should draw into <var>outBitmap</var> the
1489 * imagery for the desired thumbnail in the dimensions of that bitmap. It
1490 * can use the given <var>canvas</var>, which is configured to draw into the
1491 * bitmap, for rendering if desired.
RoboErik55011652014-07-09 15:05:53 -07001492 *
Dianne Hackborn0aae2d42010-12-07 23:51:29 -08001493 * <p>The default implementation returns fails and does not draw a thumbnail;
1494 * this will result in the platform creating its own thumbnail if needed.
RoboErik55011652014-07-09 15:05:53 -07001495 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001496 * @param outBitmap The bitmap to contain the thumbnail.
1497 * @param canvas Can be used to render into the bitmap.
RoboErik55011652014-07-09 15:05:53 -07001498 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001499 * @return Return true if you have drawn into the bitmap; otherwise after
1500 * you return it will be filled with a default thumbnail.
RoboErik55011652014-07-09 15:05:53 -07001501 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001502 * @see #onCreateDescription
1503 * @see #onSaveInstanceState
1504 * @see #onPause
1505 */
1506 public boolean onCreateThumbnail(Bitmap outBitmap, Canvas canvas) {
Dianne Hackborn0aae2d42010-12-07 23:51:29 -08001507 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001508 }
1509
1510 /**
1511 * Generate a new description for this activity. This method is called
1512 * before pausing the activity and can, if desired, return some textual
1513 * description of its current state to be displayed to the user.
RoboErik55011652014-07-09 15:05:53 -07001514 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001515 * <p>The default implementation returns null, which will cause you to
1516 * inherit the description from the previous activity. If all activities
1517 * return null, generally the label of the top activity will be used as the
1518 * description.
RoboErik55011652014-07-09 15:05:53 -07001519 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001520 * @return A description of what the user is doing. It should be short and
1521 * sweet (only a few words).
RoboErik55011652014-07-09 15:05:53 -07001522 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001523 * @see #onCreateThumbnail
1524 * @see #onSaveInstanceState
1525 * @see #onPause
1526 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001527 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001528 public CharSequence onCreateDescription() {
1529 return null;
1530 }
1531
1532 /**
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001533 * This is called when the user is requesting an assist, to build a full
1534 * {@link Intent#ACTION_ASSIST} Intent with all of the context of the current
1535 * application. You can override this method to place into the bundle anything
1536 * you would like to appear in the {@link Intent#EXTRA_ASSIST_CONTEXT} part
Dianne Hackborna7bb6fb2015-02-03 18:13:40 -08001537 * of the assist Intent. The default implementation automatically generates a
1538 * {@link AssistData} from your activity and places it in to the Bundle; if you
1539 * don't want your UI reported to the assistant, don't call this default
1540 * implementation.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001541 *
1542 * <p>This function will be called after any global assist callbacks that had
Ying Wang4e0eb222013-04-18 20:39:48 -07001543 * been registered with {@link Application#registerOnProvideAssistDataListener
1544 * Application.registerOnProvideAssistDataListener}.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001545 */
1546 public void onProvideAssistData(Bundle data) {
Dianne Hackborna7bb6fb2015-02-03 18:13:40 -08001547 data.putParcelable(AssistData.ASSIST_KEY, new AssistData(this));
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001548 }
1549
1550 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 * Called when you are no longer visible to the user. You will next
1552 * receive either {@link #onRestart}, {@link #onDestroy}, or nothing,
1553 * depending on later user activity.
RoboErik55011652014-07-09 15:05:53 -07001554 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001555 * <p>Note that this method may never be called, in low memory situations
1556 * where the system does not have enough memory to keep your activity's
1557 * process running after its {@link #onPause} method is called.
RoboErik55011652014-07-09 15:05:53 -07001558 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001559 * <p><em>Derived classes must call through to the super class's
1560 * implementation of this method. If they do not, an exception will be
1561 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001562 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001563 * @see #onRestart
1564 * @see #onResume
1565 * @see #onSaveInstanceState
1566 * @see #onDestroy
1567 */
1568 protected void onStop() {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001569 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onStop " + this);
Adam Powell50efbed2011-02-08 16:20:15 -08001570 if (mActionBar != null) mActionBar.setShowHideAnimationEnabled(false);
George Mount62ab9b72014-05-02 13:51:17 -07001571 mActivityTransitionState.onStop();
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001572 getApplication().dispatchActivityStopped(this);
Craig Mautner5eda9b32013-07-02 11:58:16 -07001573 mTranslucentCallback = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001574 mCalled = true;
1575 }
1576
1577 /**
1578 * Perform any final cleanup before an activity is destroyed. This can
1579 * happen either because the activity is finishing (someone called
1580 * {@link #finish} on it, or because the system is temporarily destroying
1581 * this instance of the activity to save space. You can distinguish
1582 * between these two scenarios with the {@link #isFinishing} method.
RoboErik55011652014-07-09 15:05:53 -07001583 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001584 * <p><em>Note: do not count on this method being called as a place for
1585 * saving data! For example, if an activity is editing data in a content
1586 * provider, those edits should be committed in either {@link #onPause} or
1587 * {@link #onSaveInstanceState}, not here.</em> This method is usually implemented to
1588 * free resources like threads that are associated with an activity, so
1589 * that a destroyed activity does not leave such things around while the
1590 * rest of its application is still running. There are situations where
1591 * the system will simply kill the activity's hosting process without
1592 * calling this method (or any others) in it, so it should not be used to
1593 * do things that are intended to remain around after the process goes
1594 * away.
RoboErik55011652014-07-09 15:05:53 -07001595 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001596 * <p><em>Derived classes must call through to the super class's
1597 * implementation of this method. If they do not, an exception will be
1598 * thrown.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001599 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001600 * @see #onPause
1601 * @see #onStop
1602 * @see #finish
1603 * @see #isFinishing
1604 */
1605 protected void onDestroy() {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001606 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onDestroy " + this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001607 mCalled = true;
1608
1609 // dismiss any dialogs we are managing.
1610 if (mManagedDialogs != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001611 final int numDialogs = mManagedDialogs.size();
1612 for (int i = 0; i < numDialogs; i++) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001613 final ManagedDialog md = mManagedDialogs.valueAt(i);
1614 if (md.mDialog.isShowing()) {
1615 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001616 }
1617 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001618 mManagedDialogs = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001619 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001620
1621 // close any cursors we are managing.
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001622 synchronized (mManagedCursors) {
1623 int numCursors = mManagedCursors.size();
1624 for (int i = 0; i < numCursors; i++) {
1625 ManagedCursor c = mManagedCursors.get(i);
1626 if (c != null) {
1627 c.mCursor.close();
1628 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001629 }
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001630 mManagedCursors.clear();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001631 }
Amith Yamasani49860442010-03-17 20:54:10 -07001632
1633 // Close any open search dialog
1634 if (mSearchManager != null) {
1635 mSearchManager.stopSearch();
1636 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001637
1638 getApplication().dispatchActivityDestroyed(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001639 }
1640
1641 /**
Dianne Hackbornebc15ef2013-10-09 17:36:57 -07001642 * Report to the system that your app is now fully drawn, purely for diagnostic
1643 * purposes (calling it does not impact the visible behavior of the activity).
1644 * This is only used to help instrument application launch times, so that the
1645 * app can report when it is fully in a usable state; without this, the only thing
1646 * the system itself can determine is the point at which the activity's window
1647 * is <em>first</em> drawn and displayed. To participate in app launch time
Dianne Hackborn2286cdc2013-07-01 19:10:06 -07001648 * measurement, you should always call this method after first launch (when
Dianne Hackbornebc15ef2013-10-09 17:36:57 -07001649 * {@link #onCreate(android.os.Bundle)} is called), at the point where you have
Dianne Hackborn2286cdc2013-07-01 19:10:06 -07001650 * entirely drawn your UI and populated with all of the significant data. You
1651 * can safely call this method any time after first launch as well, in which case
1652 * it will simply be ignored.
1653 */
1654 public void reportFullyDrawn() {
1655 if (mDoReportFullyDrawn) {
1656 mDoReportFullyDrawn = false;
1657 try {
1658 ActivityManagerNative.getDefault().reportActivityFullyDrawn(mToken);
1659 } catch (RemoteException e) {
1660 }
1661 }
1662 }
1663
1664 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001665 * Called by the system when the device configuration changes while your
1666 * activity is running. Note that this will <em>only</em> be called if
1667 * you have selected configurations you would like to handle with the
1668 * {@link android.R.attr#configChanges} attribute in your manifest. If
1669 * any configuration change occurs that is not selected to be reported
1670 * by that attribute, then instead of reporting it the system will stop
1671 * and restart the activity (to have it launched with the new
1672 * configuration).
RoboErik55011652014-07-09 15:05:53 -07001673 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001674 * <p>At the time that this function has been called, your Resources
1675 * object will have been updated to return resource values matching the
1676 * new configuration.
RoboErik55011652014-07-09 15:05:53 -07001677 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001678 * @param newConfig The new device configuration.
1679 */
1680 public void onConfigurationChanged(Configuration newConfig) {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001681 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onConfigurationChanged " + this + ": " + newConfig);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 mCalled = true;
Bjorn Bringert444c7272009-07-06 21:32:50 +01001683
Dianne Hackborn9d071802010-12-08 14:49:15 -08001684 mFragments.dispatchConfigurationChanged(newConfig);
1685
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001686 if (mWindow != null) {
1687 // Pass the configuration changed event to the window
1688 mWindow.onConfigurationChanged(newConfig);
1689 }
Adam Powell45c0b192011-07-28 15:11:57 -07001690
1691 if (mActionBar != null) {
1692 // Do this last; the action bar will need to access
1693 // view changes from above.
1694 mActionBar.onConfigurationChanged(newConfig);
1695 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001696 }
RoboErik55011652014-07-09 15:05:53 -07001697
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001698 /**
1699 * If this activity is being destroyed because it can not handle a
1700 * configuration parameter being changed (and thus its
1701 * {@link #onConfigurationChanged(Configuration)} method is
1702 * <em>not</em> being called), then you can use this method to discover
1703 * the set of changes that have occurred while in the process of being
1704 * destroyed. Note that there is no guarantee that these will be
1705 * accurate (other changes could have happened at any time), so you should
1706 * only use this as an optimization hint.
RoboErik55011652014-07-09 15:05:53 -07001707 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001708 * @return Returns a bit field of the configuration parameters that are
1709 * changing, as defined by the {@link android.content.res.Configuration}
1710 * class.
1711 */
1712 public int getChangingConfigurations() {
1713 return mConfigChangeFlags;
1714 }
RoboErik55011652014-07-09 15:05:53 -07001715
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001716 /**
1717 * Retrieve the non-configuration instance data that was previously
1718 * returned by {@link #onRetainNonConfigurationInstance()}. This will
1719 * be available from the initial {@link #onCreate} and
1720 * {@link #onStart} calls to the new instance, allowing you to extract
1721 * any useful dynamic state from the previous instance.
RoboErik55011652014-07-09 15:05:53 -07001722 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001723 * <p>Note that the data you retrieve here should <em>only</em> be used
1724 * as an optimization for handling configuration changes. You should always
1725 * be able to handle getting a null pointer back, and an activity must
1726 * still be able to restore itself to its previous state (through the
1727 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1728 * function returns null.
RoboErik55011652014-07-09 15:05:53 -07001729 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001730 * @return Returns the object previously returned by
1731 * {@link #onRetainNonConfigurationInstance()}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001732 *
1733 * @deprecated Use the new {@link Fragment} API
1734 * {@link Fragment#setRetainInstance(boolean)} instead; this is also
1735 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001736 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001737 @Nullable
Dianne Hackborn9567a662011-04-19 18:44:03 -07001738 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001739 public Object getLastNonConfigurationInstance() {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001740 return mLastNonConfigurationInstances != null
1741 ? mLastNonConfigurationInstances.activity : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001742 }
RoboErik55011652014-07-09 15:05:53 -07001743
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001744 /**
1745 * Called by the system, as part of destroying an
1746 * activity due to a configuration change, when it is known that a new
1747 * instance will immediately be created for the new configuration. You
1748 * can return any object you like here, including the activity instance
1749 * itself, which can later be retrieved by calling
1750 * {@link #getLastNonConfigurationInstance()} in the new activity
1751 * instance.
RoboErik55011652014-07-09 15:05:53 -07001752 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001753 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1754 * or later, consider instead using a {@link Fragment} with
1755 * {@link Fragment#setRetainInstance(boolean)
1756 * Fragment.setRetainInstance(boolean}.</em>
1757 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001758 * <p>This function is called purely as an optimization, and you must
1759 * not rely on it being called. When it is called, a number of guarantees
1760 * will be made to help optimize configuration switching:
1761 * <ul>
1762 * <li> The function will be called between {@link #onStop} and
1763 * {@link #onDestroy}.
1764 * <li> A new instance of the activity will <em>always</em> be immediately
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001765 * created after this one's {@link #onDestroy()} is called. In particular,
1766 * <em>no</em> messages will be dispatched during this time (when the returned
1767 * object does not have an activity to be associated with).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001768 * <li> The object you return here will <em>always</em> be available from
1769 * the {@link #getLastNonConfigurationInstance()} method of the following
1770 * activity instance as described there.
1771 * </ul>
RoboErik55011652014-07-09 15:05:53 -07001772 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001773 * <p>These guarantees are designed so that an activity can use this API
1774 * to propagate extensive state from the old to new activity instance, from
1775 * loaded bitmaps, to network connections, to evenly actively running
1776 * threads. Note that you should <em>not</em> propagate any data that
1777 * may change based on the configuration, including any data loaded from
1778 * resources such as strings, layouts, or drawables.
RoboErik55011652014-07-09 15:05:53 -07001779 *
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001780 * <p>The guarantee of no message handling during the switch to the next
1781 * activity simplifies use with active objects. For example if your retained
1782 * state is an {@link android.os.AsyncTask} you are guaranteed that its
1783 * call back functions (like {@link android.os.AsyncTask#onPostExecute}) will
1784 * not be called from the call here until you execute the next instance's
1785 * {@link #onCreate(Bundle)}. (Note however that there is of course no such
1786 * guarantee for {@link android.os.AsyncTask#doInBackground} since that is
1787 * running in a separate thread.)
1788 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001789 * @return Return any Object holding the desired state to propagate to the
1790 * next activity instance.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001791 *
1792 * @deprecated Use the new {@link Fragment} API
1793 * {@link Fragment#setRetainInstance(boolean)} instead; this is also
1794 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001795 */
1796 public Object onRetainNonConfigurationInstance() {
1797 return null;
1798 }
RoboErik55011652014-07-09 15:05:53 -07001799
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001800 /**
1801 * Retrieve the non-configuration instance data that was previously
1802 * returned by {@link #onRetainNonConfigurationChildInstances()}. This will
1803 * be available from the initial {@link #onCreate} and
1804 * {@link #onStart} calls to the new instance, allowing you to extract
1805 * any useful dynamic state from the previous instance.
RoboErik55011652014-07-09 15:05:53 -07001806 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001807 * <p>Note that the data you retrieve here should <em>only</em> be used
1808 * as an optimization for handling configuration changes. You should always
1809 * be able to handle getting a null pointer back, and an activity must
1810 * still be able to restore itself to its previous state (through the
1811 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1812 * function returns null.
RoboErik55011652014-07-09 15:05:53 -07001813 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001814 * @return Returns the object previously returned by
1815 * {@link #onRetainNonConfigurationChildInstances()}
1816 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001817 @Nullable
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001818 HashMap<String, Object> getLastNonConfigurationChildInstances() {
1819 return mLastNonConfigurationInstances != null
1820 ? mLastNonConfigurationInstances.children : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001821 }
RoboErik55011652014-07-09 15:05:53 -07001822
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001823 /**
1824 * This method is similar to {@link #onRetainNonConfigurationInstance()} except that
1825 * it should return either a mapping from child activity id strings to arbitrary objects,
1826 * or null. This method is intended to be used by Activity framework subclasses that control a
1827 * set of child activities, such as ActivityGroup. The same guarantees and restrictions apply
1828 * as for {@link #onRetainNonConfigurationInstance()}. The default implementation returns null.
1829 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001830 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001831 HashMap<String,Object> onRetainNonConfigurationChildInstances() {
1832 return null;
1833 }
RoboErik55011652014-07-09 15:05:53 -07001834
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001835 NonConfigurationInstances retainNonConfigurationInstances() {
1836 Object activity = onRetainNonConfigurationInstance();
1837 HashMap<String, Object> children = onRetainNonConfigurationChildInstances();
1838 ArrayList<Fragment> fragments = mFragments.retainNonConfig();
Dianne Hackborn2707d602010-07-09 18:01:20 -07001839 boolean retainLoaders = false;
1840 if (mAllLoaderManagers != null) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001841 // prune out any loader managers that were already stopped and so
Dianne Hackborn2707d602010-07-09 18:01:20 -07001842 // have nothing useful to retain.
Dianne Hackborn3e82ba12013-07-16 13:23:55 -07001843 final int N = mAllLoaderManagers.size();
1844 LoaderManagerImpl loaders[] = new LoaderManagerImpl[N];
1845 for (int i=N-1; i>=0; i--) {
1846 loaders[i] = mAllLoaderManagers.valueAt(i);
1847 }
1848 for (int i=0; i<N; i++) {
1849 LoaderManagerImpl lm = loaders[i];
1850 if (lm.mRetaining) {
1851 retainLoaders = true;
1852 } else {
1853 lm.doDestroy();
1854 mAllLoaderManagers.remove(lm.mWho);
Dianne Hackborn2707d602010-07-09 18:01:20 -07001855 }
1856 }
1857 }
Dianne Hackborn20d94742014-05-29 18:35:45 -07001858 if (activity == null && children == null && fragments == null && !retainLoaders
1859 && mVoiceInteractor == null) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001860 return null;
1861 }
RoboErik55011652014-07-09 15:05:53 -07001862
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001863 NonConfigurationInstances nci = new NonConfigurationInstances();
1864 nci.activity = activity;
1865 nci.children = children;
1866 nci.fragments = fragments;
Dianne Hackborn2707d602010-07-09 18:01:20 -07001867 nci.loaders = mAllLoaderManagers;
Dianne Hackborn20d94742014-05-29 18:35:45 -07001868 nci.voiceInteractor = mVoiceInteractor;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001869 return nci;
1870 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001871
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001872 public void onLowMemory() {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001873 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onLowMemory " + this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001874 mCalled = true;
Dianne Hackborn9d071802010-12-08 14:49:15 -08001875 mFragments.dispatchLowMemory();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001876 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001877
1878 public void onTrimMemory(int level) {
Dianne Hackborn162bc0e2012-04-09 14:06:16 -07001879 if (DEBUG_LIFECYCLE) Slog.v(TAG, "onTrimMemory " + this + ": " + level);
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001880 mCalled = true;
1881 mFragments.dispatchTrimMemory(level);
1882 }
1883
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001884 /**
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07001885 * Return the FragmentManager for interacting with fragments associated
1886 * with this activity.
1887 */
1888 public FragmentManager getFragmentManager() {
1889 return mFragments;
1890 }
1891
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07001892 void invalidateFragment(String who) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001893 //Log.v(TAG, "invalidateFragmentIndex: index=" + index);
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001894 if (mAllLoaderManagers != null) {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07001895 LoaderManagerImpl lm = mAllLoaderManagers.get(who);
Dianne Hackbornd04ad542011-07-25 16:16:15 -07001896 if (lm != null && !lm.mRetaining) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001897 lm.doDestroy();
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07001898 mAllLoaderManagers.remove(who);
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001899 }
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001900 }
1901 }
RoboErik55011652014-07-09 15:05:53 -07001902
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001903 /**
Dianne Hackbornc8017682010-07-06 13:34:38 -07001904 * Called when a Fragment is being attached to this activity, immediately
1905 * after the call to its {@link Fragment#onAttach Fragment.onAttach()}
1906 * method and before {@link Fragment#onCreate Fragment.onCreate()}.
1907 */
1908 public void onAttachFragment(Fragment fragment) {
1909 }
RoboErik55011652014-07-09 15:05:53 -07001910
Dianne Hackbornc8017682010-07-06 13:34:38 -07001911 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001912 * Wrapper around
1913 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1914 * that gives the resulting {@link Cursor} to call
1915 * {@link #startManagingCursor} so that the activity will manage its
1916 * lifecycle for you.
RoboErik55011652014-07-09 15:05:53 -07001917 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001918 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1919 * or later, consider instead using {@link LoaderManager} instead, available
1920 * via {@link #getLoaderManager()}.</em>
1921 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07001922 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on a cursor obtained using
1923 * this method, because the activity will do that for you at the appropriate time. However, if
1924 * you call {@link #stopManagingCursor} on a cursor from a managed query, the system <em>will
1925 * not</em> automatically close the cursor and, in that case, you must call
1926 * {@link Cursor#close()}.</p>
RoboErik55011652014-07-09 15:05:53 -07001927 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001928 * @param uri The URI of the content provider to query.
1929 * @param projection List of columns to return.
1930 * @param selection SQL WHERE clause.
1931 * @param sortOrder SQL ORDER BY clause.
RoboErik55011652014-07-09 15:05:53 -07001932 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001933 * @return The Cursor that was returned by query().
RoboErik55011652014-07-09 15:05:53 -07001934 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001935 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1936 * @see #startManagingCursor
1937 * @hide
Jason parks6ed50de2010-08-25 10:18:50 -05001938 *
1939 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001940 */
Jason parks6ed50de2010-08-25 10:18:50 -05001941 @Deprecated
Dianne Hackborn291905e2010-08-17 15:17:15 -07001942 public final Cursor managedQuery(Uri uri, String[] projection, String selection,
1943 String sortOrder) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001944 Cursor c = getContentResolver().query(uri, projection, selection, null, sortOrder);
1945 if (c != null) {
1946 startManagingCursor(c);
1947 }
1948 return c;
1949 }
1950
1951 /**
1952 * Wrapper around
1953 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1954 * that gives the resulting {@link Cursor} to call
1955 * {@link #startManagingCursor} so that the activity will manage its
1956 * lifecycle for you.
RoboErik55011652014-07-09 15:05:53 -07001957 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001958 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1959 * or later, consider instead using {@link LoaderManager} instead, available
1960 * via {@link #getLoaderManager()}.</em>
1961 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07001962 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on a cursor obtained using
1963 * this method, because the activity will do that for you at the appropriate time. However, if
1964 * you call {@link #stopManagingCursor} on a cursor from a managed query, the system <em>will
1965 * not</em> automatically close the cursor and, in that case, you must call
1966 * {@link Cursor#close()}.</p>
RoboErik55011652014-07-09 15:05:53 -07001967 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001968 * @param uri The URI of the content provider to query.
1969 * @param projection List of columns to return.
1970 * @param selection SQL WHERE clause.
1971 * @param selectionArgs The arguments to selection, if any ?s are pesent
1972 * @param sortOrder SQL ORDER BY clause.
RoboErik55011652014-07-09 15:05:53 -07001973 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001974 * @return The Cursor that was returned by query().
RoboErik55011652014-07-09 15:05:53 -07001975 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001976 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1977 * @see #startManagingCursor
Jason parks6ed50de2010-08-25 10:18:50 -05001978 *
1979 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001980 */
Jason parks6ed50de2010-08-25 10:18:50 -05001981 @Deprecated
Dianne Hackborn291905e2010-08-17 15:17:15 -07001982 public final Cursor managedQuery(Uri uri, String[] projection, String selection,
1983 String[] selectionArgs, String sortOrder) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001984 Cursor c = getContentResolver().query(uri, projection, selection, selectionArgs, sortOrder);
1985 if (c != null) {
1986 startManagingCursor(c);
1987 }
1988 return c;
1989 }
1990
1991 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001992 * This method allows the activity to take care of managing the given
1993 * {@link Cursor}'s lifecycle for you based on the activity's lifecycle.
1994 * That is, when the activity is stopped it will automatically call
1995 * {@link Cursor#deactivate} on the given Cursor, and when it is later restarted
1996 * it will call {@link Cursor#requery} for you. When the activity is
1997 * destroyed, all managed Cursors will be closed automatically.
RoboErik55011652014-07-09 15:05:53 -07001998 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001999 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
2000 * or later, consider instead using {@link LoaderManager} instead, available
2001 * via {@link #getLoaderManager()}.</em>
2002 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07002003 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on cursor obtained from
2004 * {@link #managedQuery}, because the activity will do that for you at the appropriate time.
2005 * However, if you call {@link #stopManagingCursor} on a cursor from a managed query, the system
2006 * <em>will not</em> automatically close the cursor and, in that case, you must call
2007 * {@link Cursor#close()}.</p>
RoboErik55011652014-07-09 15:05:53 -07002008 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002009 * @param c The Cursor to be managed.
RoboErik55011652014-07-09 15:05:53 -07002010 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002011 * @see #managedQuery(android.net.Uri , String[], String, String[], String)
2012 * @see #stopManagingCursor
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002013 *
2014 * @deprecated Use the new {@link android.content.CursorLoader} class with
2015 * {@link LoaderManager} instead; this is also
2016 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002017 */
Jason parks6ed50de2010-08-25 10:18:50 -05002018 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002019 public void startManagingCursor(Cursor c) {
2020 synchronized (mManagedCursors) {
2021 mManagedCursors.add(new ManagedCursor(c));
2022 }
2023 }
2024
2025 /**
2026 * Given a Cursor that was previously given to
2027 * {@link #startManagingCursor}, stop the activity's management of that
2028 * cursor.
RoboErik55011652014-07-09 15:05:53 -07002029 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07002030 * <p><strong>Warning:</strong> After calling this method on a cursor from a managed query,
RoboErik55011652014-07-09 15:05:53 -07002031 * the system <em>will not</em> automatically close the cursor and you must call
Joe Fernandez8ef69702011-09-02 14:32:22 -07002032 * {@link Cursor#close()}.</p>
RoboErik55011652014-07-09 15:05:53 -07002033 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002034 * @param c The Cursor that was being managed.
RoboErik55011652014-07-09 15:05:53 -07002035 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002036 * @see #startManagingCursor
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002037 *
2038 * @deprecated Use the new {@link android.content.CursorLoader} class with
2039 * {@link LoaderManager} instead; this is also
2040 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002041 */
Jason parks6ed50de2010-08-25 10:18:50 -05002042 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002043 public void stopManagingCursor(Cursor c) {
2044 synchronized (mManagedCursors) {
2045 final int N = mManagedCursors.size();
2046 for (int i=0; i<N; i++) {
2047 ManagedCursor mc = mManagedCursors.get(i);
2048 if (mc.mCursor == c) {
2049 mManagedCursors.remove(i);
2050 break;
2051 }
2052 }
2053 }
2054 }
2055
2056 /**
Dianne Hackborn3c4c2b72010-10-05 18:07:54 -07002057 * @deprecated As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}
2058 * this is a no-op.
Dianne Hackborn4f3867e2010-12-14 22:09:51 -08002059 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002060 */
Dianne Hackbornd3efa392010-09-01 17:34:12 -07002061 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002062 public void setPersistent(boolean isPersistent) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002063 }
2064
2065 /**
2066 * Finds a view that was identified by the id attribute from the XML that
2067 * was processed in {@link #onCreate}.
2068 *
2069 * @return The view if found or null otherwise.
2070 */
2071 public View findViewById(int id) {
2072 return getWindow().findViewById(id);
2073 }
RoboErik55011652014-07-09 15:05:53 -07002074
Adam Powell33b97432010-04-20 10:01:14 -07002075 /**
2076 * Retrieve a reference to this activity's ActionBar.
Adam Powell42c0fe82010-08-10 16:36:56 -07002077 *
Adam Powell33b97432010-04-20 10:01:14 -07002078 * @return The Activity's ActionBar, or null if it does not have one.
2079 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002080 @Nullable
Adam Powell33b97432010-04-20 10:01:14 -07002081 public ActionBar getActionBar() {
Adam Powelle43340c2014-03-17 19:10:43 -07002082 initWindowDecorActionBar();
Adam Powell33b97432010-04-20 10:01:14 -07002083 return mActionBar;
2084 }
Adam Powelle43340c2014-03-17 19:10:43 -07002085
2086 /**
2087 * Set a {@link android.widget.Toolbar Toolbar} to act as the {@link ActionBar} for this
2088 * Activity window.
2089 *
2090 * <p>When set to a non-null value the {@link #getActionBar()} method will return
2091 * an {@link ActionBar} object that can be used to control the given toolbar as if it were
2092 * a traditional window decor action bar. The toolbar's menu will be populated with the
2093 * Activity's options menu and the navigation button will be wired through the standard
2094 * {@link android.R.id#home home} menu select action.</p>
2095 *
2096 * <p>In order to use a Toolbar within the Activity's window content the application
2097 * must not request the window feature {@link Window#FEATURE_ACTION_BAR FEATURE_ACTION_BAR}.</p>
2098 *
Adam Powell37780142014-06-01 13:31:00 -07002099 * @param toolbar Toolbar to set as the Activity's action bar
Adam Powelle43340c2014-03-17 19:10:43 -07002100 */
Adam Powell37780142014-06-01 13:31:00 -07002101 public void setActionBar(@Nullable Toolbar toolbar) {
Adam Powelle43340c2014-03-17 19:10:43 -07002102 if (getActionBar() instanceof WindowDecorActionBar) {
2103 throw new IllegalStateException("This Activity already has an action bar supplied " +
2104 "by the window decor. Do not request Window.FEATURE_ACTION_BAR and set " +
2105 "android:windowActionBar to false in your theme to use a Toolbar instead.");
2106 }
Adam Powell14e1afe2014-08-18 15:58:23 -07002107 ToolbarActionBar tbab = new ToolbarActionBar(toolbar, getTitle(), this);
2108 mActionBar = tbab;
2109 mWindow.setCallback(tbab.getWrappedWindowCallback());
Adam Powell07a74542014-05-30 15:52:44 -07002110 mActionBar.invalidateOptionsMenu();
Adam Powelle43340c2014-03-17 19:10:43 -07002111 }
RoboErik55011652014-07-09 15:05:53 -07002112
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002113 /**
Adam Powell33b97432010-04-20 10:01:14 -07002114 * Creates a new ActionBar, locates the inflated ActionBarView,
2115 * initializes the ActionBar with the view, and sets mActionBar.
2116 */
Adam Powelle43340c2014-03-17 19:10:43 -07002117 private void initWindowDecorActionBar() {
Adam Powell89e06452010-06-23 20:24:52 -07002118 Window window = getWindow();
Adam Powella593d982011-05-13 14:09:54 -07002119
2120 // Initializing the window decor can change window feature flags.
2121 // Make sure that we have the correct set before performing the test below.
2122 window.getDecorView();
2123
Adam Powell9b4c8042010-08-10 15:36:44 -07002124 if (isChild() || !window.hasFeature(Window.FEATURE_ACTION_BAR) || mActionBar != null) {
Adam Powell33b97432010-04-20 10:01:14 -07002125 return;
2126 }
Adam Powell04fe6eb2013-05-31 14:39:48 -07002127
Adam Powelle43340c2014-03-17 19:10:43 -07002128 mActionBar = new WindowDecorActionBar(this);
Adam Powelldd8fab22012-03-22 17:47:27 -07002129 mActionBar.setDefaultDisplayHomeAsUpEnabled(mEnableDefaultActionBarUp);
Adam Powell04fe6eb2013-05-31 14:39:48 -07002130
2131 mWindow.setDefaultIcon(mActivityInfo.getIconResource());
2132 mWindow.setDefaultLogo(mActivityInfo.getLogoResource());
Adam Powell33b97432010-04-20 10:01:14 -07002133 }
RoboErik55011652014-07-09 15:05:53 -07002134
Adam Powell33b97432010-04-20 10:01:14 -07002135 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 * Set the activity content from a layout resource. The resource will be
2137 * inflated, adding all top-level views to the activity.
Romain Guy482b34a62011-01-20 10:59:28 -08002138 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002139 * @param layoutResID Resource ID to be inflated.
RoboErik55011652014-07-09 15:05:53 -07002140 *
Romain Guy482b34a62011-01-20 10:59:28 -08002141 * @see #setContentView(android.view.View)
2142 * @see #setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002143 */
2144 public void setContentView(int layoutResID) {
2145 getWindow().setContentView(layoutResID);
Adam Powelle43340c2014-03-17 19:10:43 -07002146 initWindowDecorActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002147 }
2148
2149 /**
2150 * Set the activity content to an explicit view. This view is placed
2151 * directly into the activity's view hierarchy. It can itself be a complex
Romain Guy482b34a62011-01-20 10:59:28 -08002152 * view hierarchy. When calling this method, the layout parameters of the
2153 * specified view are ignored. Both the width and the height of the view are
2154 * set by default to {@link ViewGroup.LayoutParams#MATCH_PARENT}. To use
2155 * your own layout parameters, invoke
2156 * {@link #setContentView(android.view.View, android.view.ViewGroup.LayoutParams)}
2157 * instead.
RoboErik55011652014-07-09 15:05:53 -07002158 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002159 * @param view The desired content to display.
Romain Guy482b34a62011-01-20 10:59:28 -08002160 *
2161 * @see #setContentView(int)
2162 * @see #setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002163 */
2164 public void setContentView(View view) {
2165 getWindow().setContentView(view);
Adam Powelle43340c2014-03-17 19:10:43 -07002166 initWindowDecorActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002167 }
2168
2169 /**
2170 * Set the activity content to an explicit view. This view is placed
2171 * directly into the activity's view hierarchy. It can itself be a complex
Romain Guy482b34a62011-01-20 10:59:28 -08002172 * view hierarchy.
RoboErik55011652014-07-09 15:05:53 -07002173 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002174 * @param view The desired content to display.
2175 * @param params Layout parameters for the view.
Romain Guy482b34a62011-01-20 10:59:28 -08002176 *
2177 * @see #setContentView(android.view.View)
2178 * @see #setContentView(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 */
2180 public void setContentView(View view, ViewGroup.LayoutParams params) {
2181 getWindow().setContentView(view, params);
Adam Powelle43340c2014-03-17 19:10:43 -07002182 initWindowDecorActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002183 }
2184
2185 /**
2186 * Add an additional content view to the activity. Added after any existing
2187 * ones in the activity -- existing views are NOT removed.
RoboErik55011652014-07-09 15:05:53 -07002188 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002189 * @param view The desired content to display.
2190 * @param params Layout parameters for the view.
2191 */
2192 public void addContentView(View view, ViewGroup.LayoutParams params) {
2193 getWindow().addContentView(view, params);
Adam Powelle43340c2014-03-17 19:10:43 -07002194 initWindowDecorActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002195 }
2196
2197 /**
Adam Powellcfbe9be2013-11-06 14:58:58 -08002198 * Retrieve the {@link TransitionManager} responsible for default transitions in this window.
2199 * Requires {@link Window#FEATURE_CONTENT_TRANSITIONS}.
2200 *
2201 * <p>This method will return non-null after content has been initialized (e.g. by using
2202 * {@link #setContentView}) if {@link Window#FEATURE_CONTENT_TRANSITIONS} has been granted.</p>
2203 *
2204 * @return This window's content TransitionManager or null if none is set.
2205 */
2206 public TransitionManager getContentTransitionManager() {
2207 return getWindow().getTransitionManager();
2208 }
2209
2210 /**
2211 * Set the {@link TransitionManager} to use for default transitions in this window.
2212 * Requires {@link Window#FEATURE_CONTENT_TRANSITIONS}.
2213 *
2214 * @param tm The TransitionManager to use for scene changes.
2215 */
2216 public void setContentTransitionManager(TransitionManager tm) {
2217 getWindow().setTransitionManager(tm);
2218 }
2219
2220 /**
2221 * Retrieve the {@link Scene} representing this window's current content.
2222 * Requires {@link Window#FEATURE_CONTENT_TRANSITIONS}.
2223 *
2224 * <p>This method will return null if the current content is not represented by a Scene.</p>
2225 *
2226 * @return Current Scene being shown or null
2227 */
2228 public Scene getContentScene() {
2229 return getWindow().getContentScene();
2230 }
2231
2232 /**
Dianne Hackborncfaf8872011-01-18 13:57:54 -08002233 * Sets whether this activity is finished when touched outside its window's
2234 * bounds.
2235 */
2236 public void setFinishOnTouchOutside(boolean finish) {
2237 mWindow.setCloseOnTouchOutside(finish);
2238 }
Tor Norbyed9273d62013-05-30 15:59:53 -07002239
2240 /** @hide */
2241 @IntDef({
2242 DEFAULT_KEYS_DISABLE,
2243 DEFAULT_KEYS_DIALER,
2244 DEFAULT_KEYS_SHORTCUT,
2245 DEFAULT_KEYS_SEARCH_LOCAL,
2246 DEFAULT_KEYS_SEARCH_GLOBAL})
2247 @Retention(RetentionPolicy.SOURCE)
2248 @interface DefaultKeyMode {}
2249
Dianne Hackborncfaf8872011-01-18 13:57:54 -08002250 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002251 * Use with {@link #setDefaultKeyMode} to turn off default handling of
2252 * keys.
RoboErik55011652014-07-09 15:05:53 -07002253 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002254 * @see #setDefaultKeyMode
2255 */
2256 static public final int DEFAULT_KEYS_DISABLE = 0;
2257 /**
2258 * Use with {@link #setDefaultKeyMode} to launch the dialer during default
2259 * key handling.
RoboErik55011652014-07-09 15:05:53 -07002260 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002261 * @see #setDefaultKeyMode
2262 */
2263 static public final int DEFAULT_KEYS_DIALER = 1;
2264 /**
2265 * Use with {@link #setDefaultKeyMode} to execute a menu shortcut in
2266 * default key handling.
RoboErik55011652014-07-09 15:05:53 -07002267 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002268 * <p>That is, the user does not need to hold down the menu key to execute menu shortcuts.
RoboErik55011652014-07-09 15:05:53 -07002269 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002270 * @see #setDefaultKeyMode
2271 */
2272 static public final int DEFAULT_KEYS_SHORTCUT = 2;
2273 /**
2274 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
2275 * will start an application-defined search. (If the application or activity does not
2276 * actually define a search, the the keys will be ignored.)
RoboErik55011652014-07-09 15:05:53 -07002277 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002278 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
RoboErik55011652014-07-09 15:05:53 -07002279 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002280 * @see #setDefaultKeyMode
2281 */
2282 static public final int DEFAULT_KEYS_SEARCH_LOCAL = 3;
2283
2284 /**
2285 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
2286 * will start a global search (typically web search, but some platforms may define alternate
2287 * methods for global search)
RoboErik55011652014-07-09 15:05:53 -07002288 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002289 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
RoboErik55011652014-07-09 15:05:53 -07002290 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002291 * @see #setDefaultKeyMode
2292 */
2293 static public final int DEFAULT_KEYS_SEARCH_GLOBAL = 4;
2294
2295 /**
2296 * Select the default key handling for this activity. This controls what
2297 * will happen to key events that are not otherwise handled. The default
2298 * mode ({@link #DEFAULT_KEYS_DISABLE}) will simply drop them on the
2299 * floor. Other modes allow you to launch the dialer
2300 * ({@link #DEFAULT_KEYS_DIALER}), execute a shortcut in your options
2301 * menu without requiring the menu key be held down
RoboErik55011652014-07-09 15:05:53 -07002302 * ({@link #DEFAULT_KEYS_SHORTCUT}), or launch a search ({@link #DEFAULT_KEYS_SEARCH_LOCAL}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002303 * and {@link #DEFAULT_KEYS_SEARCH_GLOBAL}).
RoboErik55011652014-07-09 15:05:53 -07002304 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002305 * <p>Note that the mode selected here does not impact the default
2306 * handling of system keys, such as the "back" and "menu" keys, and your
2307 * activity and its views always get a first chance to receive and handle
2308 * all application keys.
RoboErik55011652014-07-09 15:05:53 -07002309 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002310 * @param mode The desired default key mode constant.
RoboErik55011652014-07-09 15:05:53 -07002311 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002312 * @see #DEFAULT_KEYS_DISABLE
2313 * @see #DEFAULT_KEYS_DIALER
2314 * @see #DEFAULT_KEYS_SHORTCUT
2315 * @see #DEFAULT_KEYS_SEARCH_LOCAL
2316 * @see #DEFAULT_KEYS_SEARCH_GLOBAL
2317 * @see #onKeyDown
2318 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002319 public final void setDefaultKeyMode(@DefaultKeyMode int mode) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002320 mDefaultKeyMode = mode;
RoboErik55011652014-07-09 15:05:53 -07002321
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002322 // Some modes use a SpannableStringBuilder to track & dispatch input events
2323 // This list must remain in sync with the switch in onKeyDown()
2324 switch (mode) {
2325 case DEFAULT_KEYS_DISABLE:
2326 case DEFAULT_KEYS_SHORTCUT:
2327 mDefaultKeySsb = null; // not used in these modes
2328 break;
2329 case DEFAULT_KEYS_DIALER:
2330 case DEFAULT_KEYS_SEARCH_LOCAL:
2331 case DEFAULT_KEYS_SEARCH_GLOBAL:
2332 mDefaultKeySsb = new SpannableStringBuilder();
2333 Selection.setSelection(mDefaultKeySsb,0);
2334 break;
2335 default:
2336 throw new IllegalArgumentException();
2337 }
2338 }
2339
2340 /**
2341 * Called when a key was pressed down and not handled by any of the views
RoboErik55011652014-07-09 15:05:53 -07002342 * inside of the activity. So, for example, key presses while the cursor
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002343 * is inside a TextView will not trigger the event (unless it is a navigation
2344 * to another object) because TextView handles its own key presses.
RoboErik55011652014-07-09 15:05:53 -07002345 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002346 * <p>If the focused view didn't want this event, this method is called.
2347 *
Dianne Hackborn8d374262009-09-14 21:21:52 -07002348 * <p>The default implementation takes care of {@link KeyEvent#KEYCODE_BACK}
2349 * by calling {@link #onBackPressed()}, though the behavior varies based
2350 * on the application compatibility mode: for
2351 * {@link android.os.Build.VERSION_CODES#ECLAIR} or later applications,
2352 * it will set up the dispatch to call {@link #onKeyUp} where the action
2353 * will be performed; for earlier applications, it will perform the
2354 * action immediately in on-down, as those versions of the platform
2355 * behaved.
RoboErik55011652014-07-09 15:05:53 -07002356 *
Dianne Hackborn8d374262009-09-14 21:21:52 -07002357 * <p>Other additional default key handling may be performed
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002358 * if configured with {@link #setDefaultKeyMode}.
RoboErik55011652014-07-09 15:05:53 -07002359 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002360 * @return Return <code>true</code> to prevent this event from being propagated
RoboErik55011652014-07-09 15:05:53 -07002361 * further, or <code>false</code> to indicate that you have not handled
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002362 * this event and it should continue to be propagated.
2363 * @see #onKeyUp
2364 * @see android.view.KeyEvent
2365 */
2366 public boolean onKeyDown(int keyCode, KeyEvent event) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002367 if (keyCode == KeyEvent.KEYCODE_BACK) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07002368 if (getApplicationInfo().targetSdkVersion
2369 >= Build.VERSION_CODES.ECLAIR) {
2370 event.startTracking();
2371 } else {
2372 onBackPressed();
2373 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002374 return true;
2375 }
RoboErik55011652014-07-09 15:05:53 -07002376
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002377 if (mDefaultKeyMode == DEFAULT_KEYS_DISABLE) {
2378 return false;
2379 } else if (mDefaultKeyMode == DEFAULT_KEYS_SHORTCUT) {
Jose Lima7a22fc62015-01-23 17:24:22 -08002380 Window w = getWindow();
2381 if (w.hasFeature(Window.FEATURE_OPTIONS_PANEL) &&
2382 w.performPanelShortcut(Window.FEATURE_OPTIONS_PANEL, keyCode, event,
2383 Menu.FLAG_ALWAYS_PERFORM_CLOSE)) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002384 return true;
2385 }
2386 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002387 } else {
2388 // Common code for DEFAULT_KEYS_DIALER & DEFAULT_KEYS_SEARCH_*
2389 boolean clearSpannable = false;
2390 boolean handled;
2391 if ((event.getRepeatCount() != 0) || event.isSystem()) {
2392 clearSpannable = true;
2393 handled = false;
2394 } else {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002395 handled = TextKeyListener.getInstance().onKeyDown(
2396 null, mDefaultKeySsb, keyCode, event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002397 if (handled && mDefaultKeySsb.length() > 0) {
2398 // something useable has been typed - dispatch it now.
2399
2400 final String str = mDefaultKeySsb.toString();
2401 clearSpannable = true;
RoboErik55011652014-07-09 15:05:53 -07002402
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002403 switch (mDefaultKeyMode) {
2404 case DEFAULT_KEYS_DIALER:
2405 Intent intent = new Intent(Intent.ACTION_DIAL, Uri.parse("tel:" + str));
2406 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
RoboErik55011652014-07-09 15:05:53 -07002407 startActivity(intent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002408 break;
2409 case DEFAULT_KEYS_SEARCH_LOCAL:
2410 startSearch(str, false, null, false);
2411 break;
2412 case DEFAULT_KEYS_SEARCH_GLOBAL:
2413 startSearch(str, false, null, true);
2414 break;
2415 }
2416 }
2417 }
2418 if (clearSpannable) {
2419 mDefaultKeySsb.clear();
2420 mDefaultKeySsb.clearSpans();
2421 Selection.setSelection(mDefaultKeySsb,0);
2422 }
2423 return handled;
2424 }
2425 }
2426
2427 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002428 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
2429 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
2430 * the event).
2431 */
2432 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
2433 return false;
2434 }
2435
2436 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002437 * Called when a key was released and not handled by any of the views
RoboErik55011652014-07-09 15:05:53 -07002438 * inside of the activity. So, for example, key presses while the cursor
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002439 * is inside a TextView will not trigger the event (unless it is a navigation
2440 * to another object) because TextView handles its own key presses.
RoboErik55011652014-07-09 15:05:53 -07002441 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002442 * <p>The default implementation handles KEYCODE_BACK to stop the activity
2443 * and go back.
RoboErik55011652014-07-09 15:05:53 -07002444 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002445 * @return Return <code>true</code> to prevent this event from being propagated
RoboErik55011652014-07-09 15:05:53 -07002446 * further, or <code>false</code> to indicate that you have not handled
2447 * this event and it should continue to be propagated.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002448 * @see #onKeyDown
2449 * @see KeyEvent
2450 */
2451 public boolean onKeyUp(int keyCode, KeyEvent event) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07002452 if (getApplicationInfo().targetSdkVersion
2453 >= Build.VERSION_CODES.ECLAIR) {
2454 if (keyCode == KeyEvent.KEYCODE_BACK && event.isTracking()
2455 && !event.isCanceled()) {
2456 onBackPressed();
2457 return true;
2458 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002459 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002460 return false;
2461 }
2462
2463 /**
2464 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
2465 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
2466 * the event).
2467 */
2468 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
2469 return false;
2470 }
RoboErik55011652014-07-09 15:05:53 -07002471
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002472 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002473 * Called when the activity has detected the user's press of the back
2474 * key. The default implementation simply finishes the current activity,
2475 * but you can override this to do whatever you want.
2476 */
2477 public void onBackPressed() {
Adam Powell07a74542014-05-30 15:52:44 -07002478 if (mActionBar != null && mActionBar.collapseActionView()) {
2479 return;
2480 }
2481
Dianne Hackborn3a57fb92010-11-15 17:58:52 -08002482 if (!mFragments.popBackStackImmediate()) {
Craig Mautner73f843d2014-05-19 09:42:28 -07002483 finishAfterTransition();
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07002484 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002485 }
Jeff Brown64da12a2011-01-04 19:57:47 -08002486
2487 /**
2488 * Called when a key shortcut event is not handled by any of the views in the Activity.
2489 * Override this method to implement global key shortcuts for the Activity.
2490 * Key shortcuts can also be implemented by setting the
2491 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
2492 *
2493 * @param keyCode The value in event.getKeyCode().
2494 * @param event Description of the key event.
2495 * @return True if the key shortcut was handled.
2496 */
2497 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
2498 return false;
2499 }
2500
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002501 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002502 * Called when a touch screen event was not handled by any of the views
2503 * under it. This is most useful to process touch events that happen
2504 * outside of your window bounds, where there is no view to receive it.
RoboErik55011652014-07-09 15:05:53 -07002505 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002506 * @param event The touch screen event being processed.
RoboErik55011652014-07-09 15:05:53 -07002507 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002508 * @return Return true if you have consumed the event, false if you haven't.
2509 * The default implementation always returns false.
2510 */
2511 public boolean onTouchEvent(MotionEvent event) {
Dianne Hackborncfaf8872011-01-18 13:57:54 -08002512 if (mWindow.shouldCloseOnTouch(this, event)) {
2513 finish();
2514 return true;
2515 }
RoboErik55011652014-07-09 15:05:53 -07002516
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002517 return false;
2518 }
RoboErik55011652014-07-09 15:05:53 -07002519
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002520 /**
2521 * Called when the trackball was moved and not handled by any of the
2522 * views inside of the activity. So, for example, if the trackball moves
2523 * while focus is on a button, you will receive a call here because
2524 * buttons do not normally do anything with trackball events. The call
2525 * here happens <em>before</em> trackball movements are converted to
2526 * DPAD key events, which then get sent back to the view hierarchy, and
2527 * will be processed at the point for things like focus navigation.
RoboErik55011652014-07-09 15:05:53 -07002528 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002529 * @param event The trackball event being processed.
RoboErik55011652014-07-09 15:05:53 -07002530 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002531 * @return Return true if you have consumed the event, false if you haven't.
2532 * The default implementation always returns false.
2533 */
2534 public boolean onTrackballEvent(MotionEvent event) {
2535 return false;
2536 }
Jeff Browncb1404e2011-01-15 18:14:15 -08002537
2538 /**
2539 * Called when a generic motion event was not handled by any of the
2540 * views inside of the activity.
2541 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08002542 * Generic motion events describe joystick movements, mouse hovers, track pad
2543 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08002544 * {@link MotionEvent#getSource() source} of the motion event specifies
2545 * the class of input that was received. Implementations of this method
2546 * must examine the bits in the source before processing the event.
2547 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08002548 * </p><p>
2549 * Generic motion events with source class
2550 * {@link android.view.InputDevice#SOURCE_CLASS_POINTER}
2551 * are delivered to the view under the pointer. All other generic motion events are
2552 * delivered to the focused view.
2553 * </p><p>
2554 * See {@link View#onGenericMotionEvent(MotionEvent)} for an example of how to
2555 * handle this event.
Jeff Browncb1404e2011-01-15 18:14:15 -08002556 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08002557 *
2558 * @param event The generic motion event being processed.
2559 *
2560 * @return Return true if you have consumed the event, false if you haven't.
2561 * The default implementation always returns false.
2562 */
2563 public boolean onGenericMotionEvent(MotionEvent event) {
2564 return false;
2565 }
2566
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002567 /**
2568 * Called whenever a key, touch, or trackball event is dispatched to the
2569 * activity. Implement this method if you wish to know that the user has
2570 * interacted with the device in some way while your activity is running.
2571 * This callback and {@link #onUserLeaveHint} are intended to help
2572 * activities manage status bar notifications intelligently; specifically,
2573 * for helping activities determine the proper time to cancel a notfication.
RoboErik55011652014-07-09 15:05:53 -07002574 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002575 * <p>All calls to your activity's {@link #onUserLeaveHint} callback will
2576 * be accompanied by calls to {@link #onUserInteraction}. This
2577 * ensures that your activity will be told of relevant user activity such
2578 * as pulling down the notification pane and touching an item there.
RoboErik55011652014-07-09 15:05:53 -07002579 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002580 * <p>Note that this callback will be invoked for the touch down action
2581 * that begins a touch gesture, but may not be invoked for the touch-moved
2582 * and touch-up actions that follow.
RoboErik55011652014-07-09 15:05:53 -07002583 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002584 * @see #onUserLeaveHint()
2585 */
2586 public void onUserInteraction() {
2587 }
RoboErik55011652014-07-09 15:05:53 -07002588
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002589 public void onWindowAttributesChanged(WindowManager.LayoutParams params) {
2590 // Update window manager if: we have a view, that view is
2591 // attached to its parent (which will be a RootView), and
2592 // this activity is not embedded.
2593 if (mParent == null) {
2594 View decor = mDecor;
2595 if (decor != null && decor.getParent() != null) {
2596 getWindowManager().updateViewLayout(decor, params);
2597 }
2598 }
2599 }
2600
2601 public void onContentChanged() {
2602 }
2603
2604 /**
2605 * Called when the current {@link Window} of the activity gains or loses
2606 * focus. This is the best indicator of whether this activity is visible
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002607 * to the user. The default implementation clears the key tracking
2608 * state, so should always be called.
RoboErik55011652014-07-09 15:05:53 -07002609 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002610 * <p>Note that this provides information about global focus state, which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002611 * is managed independently of activity lifecycles. As such, while focus
2612 * changes will generally have some relation to lifecycle changes (an
2613 * activity that is stopped will not generally get window focus), you
2614 * should not rely on any particular order between the callbacks here and
2615 * those in the other lifecycle methods such as {@link #onResume}.
RoboErik55011652014-07-09 15:05:53 -07002616 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002617 * <p>As a general rule, however, a resumed activity will have window
2618 * focus... unless it has displayed other dialogs or popups that take
2619 * input focus, in which case the activity itself will not have focus
2620 * when the other windows have it. Likewise, the system may display
2621 * system-level windows (such as the status bar notification panel or
2622 * a system alert) which will temporarily take window input focus without
2623 * pausing the foreground activity.
2624 *
2625 * @param hasFocus Whether the window of this activity has focus.
RoboErik55011652014-07-09 15:05:53 -07002626 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002627 * @see #hasWindowFocus()
2628 * @see #onResume
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002629 * @see View#onWindowFocusChanged(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002630 */
2631 public void onWindowFocusChanged(boolean hasFocus) {
2632 }
RoboErik55011652014-07-09 15:05:53 -07002633
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002634 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002635 * Called when the main window associated with the activity has been
2636 * attached to the window manager.
2637 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
2638 * for more information.
2639 * @see View#onAttachedToWindow
2640 */
2641 public void onAttachedToWindow() {
2642 }
RoboErik55011652014-07-09 15:05:53 -07002643
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002644 /**
2645 * Called when the main window associated with the activity has been
2646 * detached from the window manager.
2647 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
2648 * for more information.
2649 * @see View#onDetachedFromWindow
2650 */
2651 public void onDetachedFromWindow() {
2652 }
RoboErik55011652014-07-09 15:05:53 -07002653
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002654 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002655 * Returns true if this activity's <em>main</em> window currently has window focus.
2656 * Note that this is not the same as the view itself having focus.
RoboErik55011652014-07-09 15:05:53 -07002657 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002658 * @return True if this activity's main window currently has window focus.
RoboErik55011652014-07-09 15:05:53 -07002659 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002660 * @see #onWindowAttributesChanged(android.view.WindowManager.LayoutParams)
2661 */
2662 public boolean hasWindowFocus() {
2663 Window w = getWindow();
2664 if (w != null) {
2665 View d = w.getDecorView();
2666 if (d != null) {
2667 return d.hasWindowFocus();
2668 }
2669 }
2670 return false;
2671 }
Will Haldean Brownca6234e2014-02-12 10:23:41 -08002672
2673 /**
2674 * Called when the main window associated with the activity has been dismissed.
Adam Powell117b6952014-05-05 18:14:56 -07002675 * @hide
Will Haldean Brownca6234e2014-02-12 10:23:41 -08002676 */
Adam Powell117b6952014-05-05 18:14:56 -07002677 @Override
Will Haldean Brownca6234e2014-02-12 10:23:41 -08002678 public void onWindowDismissed() {
2679 finish();
2680 }
RoboErik55011652014-07-09 15:05:53 -07002681
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002682 /**
RoboErik55011652014-07-09 15:05:53 -07002683 * Called to process key events. You can override this to intercept all
2684 * key events before they are dispatched to the window. Be sure to call
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002685 * this implementation for key events that should be handled normally.
RoboErik55011652014-07-09 15:05:53 -07002686 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002687 * @param event The key event.
RoboErik55011652014-07-09 15:05:53 -07002688 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002689 * @return boolean Return true if this event was consumed.
2690 */
2691 public boolean dispatchKeyEvent(KeyEvent event) {
2692 onUserInteraction();
Adam Powell07a74542014-05-30 15:52:44 -07002693
2694 // Let action bars open menus in response to the menu key prioritized over
2695 // the window handling it
2696 if (event.getKeyCode() == KeyEvent.KEYCODE_MENU &&
2697 mActionBar != null && mActionBar.onMenuKeyEvent(event)) {
2698 return true;
2699 }
2700
Dianne Hackborn8d374262009-09-14 21:21:52 -07002701 Window win = getWindow();
2702 if (win.superDispatchKeyEvent(event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002703 return true;
2704 }
Dianne Hackborn8d374262009-09-14 21:21:52 -07002705 View decor = mDecor;
2706 if (decor == null) decor = win.getDecorView();
2707 return event.dispatch(this, decor != null
2708 ? decor.getKeyDispatcherState() : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002709 }
2710
2711 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08002712 * Called to process a key shortcut event.
2713 * You can override this to intercept all key shortcut events before they are
2714 * dispatched to the window. Be sure to call this implementation for key shortcut
2715 * events that should be handled normally.
2716 *
2717 * @param event The key shortcut event.
2718 * @return True if this event was consumed.
2719 */
2720 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
2721 onUserInteraction();
2722 if (getWindow().superDispatchKeyShortcutEvent(event)) {
2723 return true;
2724 }
2725 return onKeyShortcut(event.getKeyCode(), event);
2726 }
2727
2728 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002729 * Called to process touch screen events. You can override this to
2730 * intercept all touch screen events before they are dispatched to the
2731 * window. Be sure to call this implementation for touch screen events
2732 * that should be handled normally.
RoboErik55011652014-07-09 15:05:53 -07002733 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002734 * @param ev The touch screen event.
RoboErik55011652014-07-09 15:05:53 -07002735 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002736 * @return boolean Return true if this event was consumed.
2737 */
2738 public boolean dispatchTouchEvent(MotionEvent ev) {
2739 if (ev.getAction() == MotionEvent.ACTION_DOWN) {
2740 onUserInteraction();
2741 }
2742 if (getWindow().superDispatchTouchEvent(ev)) {
2743 return true;
2744 }
2745 return onTouchEvent(ev);
2746 }
RoboErik55011652014-07-09 15:05:53 -07002747
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002748 /**
2749 * Called to process trackball events. You can override this to
2750 * intercept all trackball events before they are dispatched to the
2751 * window. Be sure to call this implementation for trackball events
2752 * that should be handled normally.
RoboErik55011652014-07-09 15:05:53 -07002753 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002754 * @param ev The trackball event.
RoboErik55011652014-07-09 15:05:53 -07002755 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002756 * @return boolean Return true if this event was consumed.
2757 */
2758 public boolean dispatchTrackballEvent(MotionEvent ev) {
2759 onUserInteraction();
2760 if (getWindow().superDispatchTrackballEvent(ev)) {
2761 return true;
2762 }
2763 return onTrackballEvent(ev);
2764 }
svetoslavganov75986cf2009-05-14 22:28:01 -07002765
Jeff Browncb1404e2011-01-15 18:14:15 -08002766 /**
2767 * Called to process generic motion events. You can override this to
2768 * intercept all generic motion events before they are dispatched to the
2769 * window. Be sure to call this implementation for generic motion events
2770 * that should be handled normally.
2771 *
2772 * @param ev The generic motion event.
2773 *
2774 * @return boolean Return true if this event was consumed.
2775 */
2776 public boolean dispatchGenericMotionEvent(MotionEvent ev) {
2777 onUserInteraction();
2778 if (getWindow().superDispatchGenericMotionEvent(ev)) {
2779 return true;
2780 }
2781 return onGenericMotionEvent(ev);
2782 }
2783
svetoslavganov75986cf2009-05-14 22:28:01 -07002784 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
2785 event.setClassName(getClass().getName());
2786 event.setPackageName(getPackageName());
2787
2788 LayoutParams params = getWindow().getAttributes();
Romain Guy980a9382010-01-08 15:06:28 -08002789 boolean isFullScreen = (params.width == LayoutParams.MATCH_PARENT) &&
2790 (params.height == LayoutParams.MATCH_PARENT);
svetoslavganov75986cf2009-05-14 22:28:01 -07002791 event.setFullScreen(isFullScreen);
2792
2793 CharSequence title = getTitle();
2794 if (!TextUtils.isEmpty(title)) {
2795 event.getText().add(title);
2796 }
2797
2798 return true;
2799 }
2800
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002801 /**
2802 * Default implementation of
2803 * {@link android.view.Window.Callback#onCreatePanelView}
2804 * for activities. This
2805 * simply returns null so that all panel sub-windows will have the default
2806 * menu behavior.
2807 */
Tor Norbyed9273d62013-05-30 15:59:53 -07002808 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002809 public View onCreatePanelView(int featureId) {
2810 return null;
2811 }
2812
2813 /**
2814 * Default implementation of
2815 * {@link android.view.Window.Callback#onCreatePanelMenu}
2816 * for activities. This calls through to the new
2817 * {@link #onCreateOptionsMenu} method for the
2818 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2819 * so that subclasses of Activity don't need to deal with feature codes.
2820 */
2821 public boolean onCreatePanelMenu(int featureId, Menu menu) {
2822 if (featureId == Window.FEATURE_OPTIONS_PANEL) {
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002823 boolean show = onCreateOptionsMenu(menu);
2824 show |= mFragments.dispatchCreateOptionsMenu(menu, getMenuInflater());
2825 return show;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002826 }
2827 return false;
2828 }
2829
2830 /**
2831 * Default implementation of
2832 * {@link android.view.Window.Callback#onPreparePanel}
2833 * for activities. This
2834 * calls through to the new {@link #onPrepareOptionsMenu} method for the
2835 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2836 * panel, so that subclasses of
2837 * Activity don't need to deal with feature codes.
2838 */
2839 public boolean onPreparePanel(int featureId, View view, Menu menu) {
2840 if (featureId == Window.FEATURE_OPTIONS_PANEL && menu != null) {
2841 boolean goforit = onPrepareOptionsMenu(menu);
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002842 goforit |= mFragments.dispatchPrepareOptionsMenu(menu);
Adam Powellef31e7c2012-05-08 09:59:40 -07002843 return goforit;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002844 }
2845 return true;
2846 }
2847
2848 /**
2849 * {@inheritDoc}
RoboErik55011652014-07-09 15:05:53 -07002850 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002851 * @return The default implementation returns true.
2852 */
2853 public boolean onMenuOpened(int featureId, Menu menu) {
Adam Powell8515ee82010-11-30 14:09:55 -08002854 if (featureId == Window.FEATURE_ACTION_BAR) {
Adam Powelle43340c2014-03-17 19:10:43 -07002855 initWindowDecorActionBar();
Adam Powell049dd3d2010-12-02 13:43:59 -08002856 if (mActionBar != null) {
2857 mActionBar.dispatchMenuVisibilityChanged(true);
2858 } else {
2859 Log.e(TAG, "Tried to open action bar menu with no action bar");
2860 }
Adam Powell8515ee82010-11-30 14:09:55 -08002861 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002862 return true;
2863 }
2864
2865 /**
2866 * Default implementation of
2867 * {@link android.view.Window.Callback#onMenuItemSelected}
2868 * for activities. This calls through to the new
2869 * {@link #onOptionsItemSelected} method for the
2870 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2871 * panel, so that subclasses of
2872 * Activity don't need to deal with feature codes.
2873 */
2874 public boolean onMenuItemSelected(int featureId, MenuItem item) {
zobject686a8052012-12-14 21:11:08 +09002875 CharSequence titleCondensed = item.getTitleCondensed();
2876
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002877 switch (featureId) {
2878 case Window.FEATURE_OPTIONS_PANEL:
2879 // Put event logging here so it gets called even if subclass
2880 // doesn't call through to superclass's implmeentation of each
2881 // of these methods below
zobject686a8052012-12-14 21:11:08 +09002882 if(titleCondensed != null) {
2883 EventLog.writeEvent(50000, 0, titleCondensed.toString());
2884 }
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002885 if (onOptionsItemSelected(item)) {
2886 return true;
2887 }
Adam Powell04d58112012-04-09 10:22:12 -07002888 if (mFragments.dispatchOptionsItemSelected(item)) {
2889 return true;
2890 }
2891 if (item.getItemId() == android.R.id.home && mActionBar != null &&
2892 (mActionBar.getDisplayOptions() & ActionBar.DISPLAY_HOME_AS_UP) != 0) {
2893 if (mParent == null) {
Adam Powell07304f5292012-05-07 17:32:44 -07002894 return onNavigateUp();
Adam Powell04d58112012-04-09 10:22:12 -07002895 } else {
Adam Powell07304f5292012-05-07 17:32:44 -07002896 return mParent.onNavigateUpFromChild(this);
Adam Powell04d58112012-04-09 10:22:12 -07002897 }
Adam Powell04d58112012-04-09 10:22:12 -07002898 }
2899 return false;
RoboErik55011652014-07-09 15:05:53 -07002900
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002901 case Window.FEATURE_CONTEXT_MENU:
zobject686a8052012-12-14 21:11:08 +09002902 if(titleCondensed != null) {
2903 EventLog.writeEvent(50000, 1, titleCondensed.toString());
2904 }
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07002905 if (onContextItemSelected(item)) {
2906 return true;
2907 }
2908 return mFragments.dispatchContextItemSelected(item);
Adam Powell8515ee82010-11-30 14:09:55 -08002909
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002910 default:
2911 return false;
2912 }
2913 }
RoboErik55011652014-07-09 15:05:53 -07002914
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002915 /**
2916 * Default implementation of
2917 * {@link android.view.Window.Callback#onPanelClosed(int, Menu)} for
2918 * activities. This calls through to {@link #onOptionsMenuClosed(Menu)}
2919 * method for the {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2920 * so that subclasses of Activity don't need to deal with feature codes.
2921 * For context menus ({@link Window#FEATURE_CONTEXT_MENU}), the
2922 * {@link #onContextMenuClosed(Menu)} will be called.
2923 */
2924 public void onPanelClosed(int featureId, Menu menu) {
2925 switch (featureId) {
2926 case Window.FEATURE_OPTIONS_PANEL:
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002927 mFragments.dispatchOptionsMenuClosed(menu);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002928 onOptionsMenuClosed(menu);
2929 break;
RoboErik55011652014-07-09 15:05:53 -07002930
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002931 case Window.FEATURE_CONTEXT_MENU:
2932 onContextMenuClosed(menu);
2933 break;
Adam Powell8515ee82010-11-30 14:09:55 -08002934
2935 case Window.FEATURE_ACTION_BAR:
Adam Powelle43340c2014-03-17 19:10:43 -07002936 initWindowDecorActionBar();
Adam Powell8515ee82010-11-30 14:09:55 -08002937 mActionBar.dispatchMenuVisibilityChanged(false);
2938 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002939 }
2940 }
2941
2942 /**
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002943 * Declare that the options menu has changed, so should be recreated.
2944 * The {@link #onCreateOptionsMenu(Menu)} method will be called the next
2945 * time it needs to be displayed.
2946 */
2947 public void invalidateOptionsMenu() {
Jose Lima7a22fc62015-01-23 17:24:22 -08002948 if (mWindow.hasFeature(Window.FEATURE_OPTIONS_PANEL) &&
2949 (mActionBar == null || !mActionBar.invalidateOptionsMenu())) {
Adam Powell07a74542014-05-30 15:52:44 -07002950 mWindow.invalidatePanelMenu(Window.FEATURE_OPTIONS_PANEL);
2951 }
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002952 }
RoboErik55011652014-07-09 15:05:53 -07002953
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002954 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002955 * Initialize the contents of the Activity's standard options menu. You
2956 * should place your menu items in to <var>menu</var>.
RoboErik55011652014-07-09 15:05:53 -07002957 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002958 * <p>This is only called once, the first time the options menu is
2959 * displayed. To update the menu every time it is displayed, see
2960 * {@link #onPrepareOptionsMenu}.
RoboErik55011652014-07-09 15:05:53 -07002961 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002962 * <p>The default implementation populates the menu with standard system
RoboErik55011652014-07-09 15:05:53 -07002963 * menu items. These are placed in the {@link Menu#CATEGORY_SYSTEM} group so that
2964 * they will be correctly ordered with application-defined menu items.
2965 * Deriving classes should always call through to the base implementation.
2966 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002967 * <p>You can safely hold on to <var>menu</var> (and any items created
2968 * from it), making modifications to it as desired, until the next
2969 * time onCreateOptionsMenu() is called.
RoboErik55011652014-07-09 15:05:53 -07002970 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002971 * <p>When you add items to the menu, you can implement the Activity's
2972 * {@link #onOptionsItemSelected} method to handle them there.
RoboErik55011652014-07-09 15:05:53 -07002973 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002974 * @param menu The options menu in which you place your items.
RoboErik55011652014-07-09 15:05:53 -07002975 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002976 * @return You must return true for the menu to be displayed;
2977 * if you return false it will not be shown.
RoboErik55011652014-07-09 15:05:53 -07002978 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002979 * @see #onPrepareOptionsMenu
2980 * @see #onOptionsItemSelected
2981 */
2982 public boolean onCreateOptionsMenu(Menu menu) {
2983 if (mParent != null) {
2984 return mParent.onCreateOptionsMenu(menu);
2985 }
2986 return true;
2987 }
2988
2989 /**
2990 * Prepare the Screen's standard options menu to be displayed. This is
2991 * called right before the menu is shown, every time it is shown. You can
2992 * use this method to efficiently enable/disable items or otherwise
2993 * dynamically modify the contents.
RoboErik55011652014-07-09 15:05:53 -07002994 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002995 * <p>The default implementation updates the system menu items based on the
2996 * activity's state. Deriving classes should always call through to the
2997 * base class implementation.
RoboErik55011652014-07-09 15:05:53 -07002998 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002999 * @param menu The options menu as last shown or first initialized by
3000 * onCreateOptionsMenu().
RoboErik55011652014-07-09 15:05:53 -07003001 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003002 * @return You must return true for the menu to be displayed;
3003 * if you return false it will not be shown.
RoboErik55011652014-07-09 15:05:53 -07003004 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003005 * @see #onCreateOptionsMenu
3006 */
3007 public boolean onPrepareOptionsMenu(Menu menu) {
3008 if (mParent != null) {
3009 return mParent.onPrepareOptionsMenu(menu);
3010 }
3011 return true;
3012 }
3013
3014 /**
3015 * This hook is called whenever an item in your options menu is selected.
3016 * The default implementation simply returns false to have the normal
3017 * processing happen (calling the item's Runnable or sending a message to
3018 * its Handler as appropriate). You can use this method for any items
3019 * for which you would like to do processing without those other
3020 * facilities.
RoboErik55011652014-07-09 15:05:53 -07003021 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003022 * <p>Derived classes should call through to the base class for it to
Adam Powelldd8fab22012-03-22 17:47:27 -07003023 * perform the default menu handling.</p>
RoboErik55011652014-07-09 15:05:53 -07003024 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003025 * @param item The menu item that was selected.
RoboErik55011652014-07-09 15:05:53 -07003026 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003027 * @return boolean Return false to allow normal menu processing to
3028 * proceed, true to consume it here.
RoboErik55011652014-07-09 15:05:53 -07003029 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003030 * @see #onCreateOptionsMenu
3031 */
3032 public boolean onOptionsItemSelected(MenuItem item) {
3033 if (mParent != null) {
3034 return mParent.onOptionsItemSelected(item);
3035 }
3036 return false;
3037 }
3038
3039 /**
Adam Powelldd8fab22012-03-22 17:47:27 -07003040 * This method is called whenever the user chooses to navigate Up within your application's
3041 * activity hierarchy from the action bar.
3042 *
3043 * <p>If the attribute {@link android.R.attr#parentActivityName parentActivityName}
3044 * was specified in the manifest for this activity or an activity-alias to it,
3045 * default Up navigation will be handled automatically. If any activity
3046 * along the parent chain requires extra Intent arguments, the Activity subclass
3047 * should override the method {@link #onPrepareNavigateUpTaskStack(TaskStackBuilder)}
3048 * to supply those arguments.</p>
3049 *
3050 * <p>See <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back Stack</a>
3051 * from the developer guide and <a href="{@docRoot}design/patterns/navigation.html">Navigation</a>
3052 * from the design guide for more information about navigating within your app.</p>
3053 *
3054 * <p>See the {@link TaskStackBuilder} class and the Activity methods
3055 * {@link #getParentActivityIntent()}, {@link #shouldUpRecreateTask(Intent)}, and
3056 * {@link #navigateUpTo(Intent)} for help implementing custom Up navigation.
3057 * The AppNavigation sample application in the Android SDK is also available for reference.</p>
3058 *
3059 * @return true if Up navigation completed successfully and this Activity was finished,
3060 * false otherwise.
3061 */
3062 public boolean onNavigateUp() {
3063 // Automatically handle hierarchical Up navigation if the proper
3064 // metadata is available.
3065 Intent upIntent = getParentActivityIntent();
3066 if (upIntent != null) {
Adam Powell0fc5b2b2012-07-18 18:20:29 -07003067 if (mActivityInfo.taskAffinity == null) {
3068 // Activities with a null affinity are special; they really shouldn't
3069 // specify a parent activity intent in the first place. Just finish
3070 // the current activity and call it a day.
3071 finish();
3072 } else if (shouldUpRecreateTask(upIntent)) {
Adam Powellf78a8442012-05-01 18:09:32 -07003073 TaskStackBuilder b = TaskStackBuilder.create(this);
Adam Powelldd8fab22012-03-22 17:47:27 -07003074 onCreateNavigateUpTaskStack(b);
3075 onPrepareNavigateUpTaskStack(b);
3076 b.startActivities();
Adam Powell3d193d92012-05-15 16:51:55 -07003077
3078 // We can't finishAffinity if we have a result.
3079 // Fall back and simply finish the current activity instead.
3080 if (mResultCode != RESULT_CANCELED || mResultData != null) {
3081 // Tell the developer what's going on to avoid hair-pulling.
3082 Log.i(TAG, "onNavigateUp only finishing topmost activity to return a result");
3083 finish();
3084 } else {
3085 finishAffinity();
3086 }
Adam Powelldd8fab22012-03-22 17:47:27 -07003087 } else {
3088 navigateUpTo(upIntent);
3089 }
3090 return true;
3091 }
3092 return false;
3093 }
3094
3095 /**
3096 * This is called when a child activity of this one attempts to navigate up.
3097 * The default implementation simply calls onNavigateUp() on this activity (the parent).
3098 *
3099 * @param child The activity making the call.
3100 */
3101 public boolean onNavigateUpFromChild(Activity child) {
3102 return onNavigateUp();
3103 }
3104
3105 /**
3106 * Define the synthetic task stack that will be generated during Up navigation from
3107 * a different task.
3108 *
3109 * <p>The default implementation of this method adds the parent chain of this activity
3110 * as specified in the manifest to the supplied {@link TaskStackBuilder}. Applications
3111 * may choose to override this method to construct the desired task stack in a different
3112 * way.</p>
3113 *
Adam Powellf0195952012-05-02 21:38:54 -07003114 * <p>This method will be invoked by the default implementation of {@link #onNavigateUp()}
3115 * if {@link #shouldUpRecreateTask(Intent)} returns true when supplied with the intent
3116 * returned by {@link #getParentActivityIntent()}.</p>
3117 *
Adam Powelldd8fab22012-03-22 17:47:27 -07003118 * <p>Applications that wish to supply extra Intent parameters to the parent stack defined
3119 * by the manifest should override {@link #onPrepareNavigateUpTaskStack(TaskStackBuilder)}.</p>
3120 *
3121 * @param builder An empty TaskStackBuilder - the application should add intents representing
3122 * the desired task stack
3123 */
3124 public void onCreateNavigateUpTaskStack(TaskStackBuilder builder) {
3125 builder.addParentStack(this);
3126 }
3127
3128 /**
3129 * Prepare the synthetic task stack that will be generated during Up navigation
3130 * from a different task.
3131 *
3132 * <p>This method receives the {@link TaskStackBuilder} with the constructed series of
3133 * Intents as generated by {@link #onCreateNavigateUpTaskStack(TaskStackBuilder)}.
3134 * If any extra data should be added to these intents before launching the new task,
3135 * the application should override this method and add that data here.</p>
3136 *
3137 * @param builder A TaskStackBuilder that has been populated with Intents by
3138 * onCreateNavigateUpTaskStack.
3139 */
3140 public void onPrepareNavigateUpTaskStack(TaskStackBuilder builder) {
3141 }
3142
3143 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003144 * This hook is called whenever the options menu is being closed (either by the user canceling
3145 * the menu with the back/menu button, or when an item is selected).
RoboErik55011652014-07-09 15:05:53 -07003146 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003147 * @param menu The options menu as last shown or first initialized by
3148 * onCreateOptionsMenu().
3149 */
3150 public void onOptionsMenuClosed(Menu menu) {
3151 if (mParent != null) {
3152 mParent.onOptionsMenuClosed(menu);
3153 }
3154 }
RoboErik55011652014-07-09 15:05:53 -07003155
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003156 /**
3157 * Programmatically opens the options menu. If the options menu is already
3158 * open, this method does nothing.
3159 */
3160 public void openOptionsMenu() {
Jose Lima7a22fc62015-01-23 17:24:22 -08003161 if (mWindow.hasFeature(Window.FEATURE_OPTIONS_PANEL) &&
3162 (mActionBar == null || !mActionBar.openOptionsMenu())) {
Adam Powell07a74542014-05-30 15:52:44 -07003163 mWindow.openPanel(Window.FEATURE_OPTIONS_PANEL, null);
3164 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003165 }
RoboErik55011652014-07-09 15:05:53 -07003166
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003167 /**
3168 * Progammatically closes the options menu. If the options menu is already
3169 * closed, this method does nothing.
3170 */
3171 public void closeOptionsMenu() {
Jose Lima7a22fc62015-01-23 17:24:22 -08003172 if (mWindow.hasFeature(Window.FEATURE_OPTIONS_PANEL)) {
3173 mWindow.closePanel(Window.FEATURE_OPTIONS_PANEL);
3174 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003175 }
3176
3177 /**
3178 * Called when a context menu for the {@code view} is about to be shown.
3179 * Unlike {@link #onCreateOptionsMenu(Menu)}, this will be called every
3180 * time the context menu is about to be shown and should be populated for
3181 * the view (or item inside the view for {@link AdapterView} subclasses,
3182 * this can be found in the {@code menuInfo})).
3183 * <p>
3184 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an
3185 * item has been selected.
3186 * <p>
3187 * It is not safe to hold onto the context menu after this method returns.
Scott Maincdf51062013-01-08 20:03:05 -08003188 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003189 */
3190 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {
3191 }
3192
3193 /**
3194 * Registers a context menu to be shown for the given view (multiple views
3195 * can show the context menu). This method will set the
3196 * {@link OnCreateContextMenuListener} on the view to this activity, so
3197 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be
3198 * called when it is time to show the context menu.
RoboErik55011652014-07-09 15:05:53 -07003199 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003200 * @see #unregisterForContextMenu(View)
3201 * @param view The view that should show a context menu.
3202 */
3203 public void registerForContextMenu(View view) {
3204 view.setOnCreateContextMenuListener(this);
3205 }
RoboErik55011652014-07-09 15:05:53 -07003206
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003207 /**
3208 * Prevents a context menu to be shown for the given view. This method will remove the
3209 * {@link OnCreateContextMenuListener} on the view.
RoboErik55011652014-07-09 15:05:53 -07003210 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003211 * @see #registerForContextMenu(View)
3212 * @param view The view that should stop showing a context menu.
3213 */
3214 public void unregisterForContextMenu(View view) {
3215 view.setOnCreateContextMenuListener(null);
3216 }
RoboErik55011652014-07-09 15:05:53 -07003217
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003218 /**
3219 * Programmatically opens the context menu for a particular {@code view}.
3220 * The {@code view} should have been added via
3221 * {@link #registerForContextMenu(View)}.
RoboErik55011652014-07-09 15:05:53 -07003222 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003223 * @param view The view to show the context menu for.
3224 */
3225 public void openContextMenu(View view) {
3226 view.showContextMenu();
3227 }
RoboErik55011652014-07-09 15:05:53 -07003228
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003229 /**
3230 * Programmatically closes the most recently opened context menu, if showing.
3231 */
3232 public void closeContextMenu() {
Jose Limabd769a12015-01-28 10:43:15 -08003233 if (mWindow.hasFeature(Window.FEATURE_CONTEXT_MENU)) {
3234 mWindow.closePanel(Window.FEATURE_CONTEXT_MENU);
3235 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003236 }
RoboErik55011652014-07-09 15:05:53 -07003237
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003238 /**
3239 * This hook is called whenever an item in a context menu is selected. The
3240 * default implementation simply returns false to have the normal processing
3241 * happen (calling the item's Runnable or sending a message to its Handler
3242 * as appropriate). You can use this method for any items for which you
3243 * would like to do processing without those other facilities.
3244 * <p>
3245 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the
3246 * View that added this menu item.
3247 * <p>
3248 * Derived classes should call through to the base class for it to perform
3249 * the default menu handling.
RoboErik55011652014-07-09 15:05:53 -07003250 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003251 * @param item The context menu item that was selected.
3252 * @return boolean Return false to allow normal context menu processing to
3253 * proceed, true to consume it here.
3254 */
3255 public boolean onContextItemSelected(MenuItem item) {
3256 if (mParent != null) {
3257 return mParent.onContextItemSelected(item);
3258 }
3259 return false;
3260 }
3261
3262 /**
3263 * This hook is called whenever the context menu is being closed (either by
3264 * the user canceling the menu with the back/menu button, or when an item is
3265 * selected).
RoboErik55011652014-07-09 15:05:53 -07003266 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003267 * @param menu The context menu that is being closed.
3268 */
3269 public void onContextMenuClosed(Menu menu) {
3270 if (mParent != null) {
3271 mParent.onContextMenuClosed(menu);
3272 }
3273 }
3274
3275 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003276 * @deprecated Old no-arguments version of {@link #onCreateDialog(int, Bundle)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003277 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003278 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003279 protected Dialog onCreateDialog(int id) {
3280 return null;
3281 }
3282
3283 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003284 * Callback for creating dialogs that are managed (saved and restored) for you
3285 * by the activity. The default implementation calls through to
3286 * {@link #onCreateDialog(int)} for compatibility.
3287 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07003288 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
3289 * or later, consider instead using a {@link DialogFragment} instead.</em>
3290 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003291 * <p>If you use {@link #showDialog(int)}, the activity will call through to
3292 * this method the first time, and hang onto it thereafter. Any dialog
3293 * that is created by this method will automatically be saved and restored
3294 * for you, including whether it is showing.
3295 *
3296 * <p>If you would like the activity to manage saving and restoring dialogs
3297 * for you, you should override this method and handle any ids that are
3298 * passed to {@link #showDialog}.
3299 *
3300 * <p>If you would like an opportunity to prepare your dialog before it is shown,
3301 * override {@link #onPrepareDialog(int, Dialog, Bundle)}.
3302 *
3303 * @param id The id of the dialog.
3304 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
3305 * @return The dialog. If you return null, the dialog will not be created.
3306 *
3307 * @see #onPrepareDialog(int, Dialog, Bundle)
3308 * @see #showDialog(int, Bundle)
3309 * @see #dismissDialog(int)
3310 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07003311 *
3312 * @deprecated Use the new {@link DialogFragment} class with
3313 * {@link FragmentManager} instead; this is also
3314 * available on older platforms through the Android compatibility package.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003315 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003316 @Nullable
Dianne Hackborn9567a662011-04-19 18:44:03 -07003317 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003318 protected Dialog onCreateDialog(int id, Bundle args) {
3319 return onCreateDialog(id);
3320 }
3321
3322 /**
3323 * @deprecated Old no-arguments version of
3324 * {@link #onPrepareDialog(int, Dialog, Bundle)}.
3325 */
3326 @Deprecated
3327 protected void onPrepareDialog(int id, Dialog dialog) {
3328 dialog.setOwnerActivity(this);
3329 }
3330
3331 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003332 * Provides an opportunity to prepare a managed dialog before it is being
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003333 * shown. The default implementation calls through to
3334 * {@link #onPrepareDialog(int, Dialog)} for compatibility.
RoboErik55011652014-07-09 15:05:53 -07003335 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003336 * <p>
3337 * Override this if you need to update a managed dialog based on the state
3338 * of the application each time it is shown. For example, a time picker
3339 * dialog might want to be updated with the current time. You should call
3340 * through to the superclass's implementation. The default implementation
3341 * will set this Activity as the owner activity on the Dialog.
RoboErik55011652014-07-09 15:05:53 -07003342 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003343 * @param id The id of the managed dialog.
3344 * @param dialog The dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003345 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
3346 * @see #onCreateDialog(int, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003347 * @see #showDialog(int)
3348 * @see #dismissDialog(int)
3349 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07003350 *
3351 * @deprecated Use the new {@link DialogFragment} class with
3352 * {@link FragmentManager} instead; this is also
3353 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003354 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07003355 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003356 protected void onPrepareDialog(int id, Dialog dialog, Bundle args) {
3357 onPrepareDialog(id, dialog);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003358 }
3359
3360 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003361 * Simple version of {@link #showDialog(int, Bundle)} that does not
3362 * take any arguments. Simply calls {@link #showDialog(int, Bundle)}
3363 * with null arguments.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07003364 *
3365 * @deprecated Use the new {@link DialogFragment} class with
3366 * {@link FragmentManager} instead; this is also
3367 * available on older platforms through the Android compatibility package.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003368 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07003369 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003370 public final void showDialog(int id) {
3371 showDialog(id, null);
3372 }
3373
3374 /**
3375 * Show a dialog managed by this activity. A call to {@link #onCreateDialog(int, Bundle)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003376 * will be made with the same id the first time this is called for a given
3377 * id. From thereafter, the dialog will be automatically saved and restored.
3378 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07003379 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
3380 * or later, consider instead using a {@link DialogFragment} instead.</em>
3381 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003382 * <p>Each time a dialog is shown, {@link #onPrepareDialog(int, Dialog, Bundle)} will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003383 * be made to provide an opportunity to do any timely preparation.
3384 *
3385 * @param id The id of the managed dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003386 * @param args Arguments to pass through to the dialog. These will be saved
3387 * and restored for you. Note that if the dialog is already created,
3388 * {@link #onCreateDialog(int, Bundle)} will not be called with the new
3389 * arguments but {@link #onPrepareDialog(int, Dialog, Bundle)} will be.
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08003390 * If you need to rebuild the dialog, call {@link #removeDialog(int)} first.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003391 * @return Returns true if the Dialog was created; false is returned if
3392 * it is not created because {@link #onCreateDialog(int, Bundle)} returns false.
RoboErik55011652014-07-09 15:05:53 -07003393 *
Joe Onorato37296dc2009-07-31 17:58:55 -07003394 * @see Dialog
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003395 * @see #onCreateDialog(int, Bundle)
3396 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003397 * @see #dismissDialog(int)
3398 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07003399 *
3400 * @deprecated Use the new {@link DialogFragment} class with
3401 * {@link FragmentManager} instead; this is also
3402 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003403 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003404 @Nullable
Dianne Hackborn9567a662011-04-19 18:44:03 -07003405 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003406 public final boolean showDialog(int id, Bundle args) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003407 if (mManagedDialogs == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003408 mManagedDialogs = new SparseArray<ManagedDialog>();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003409 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003410 ManagedDialog md = mManagedDialogs.get(id);
3411 if (md == null) {
3412 md = new ManagedDialog();
3413 md.mDialog = createDialog(id, null, args);
3414 if (md.mDialog == null) {
3415 return false;
3416 }
3417 mManagedDialogs.put(id, md);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003418 }
RoboErik55011652014-07-09 15:05:53 -07003419
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003420 md.mArgs = args;
3421 onPrepareDialog(id, md.mDialog, args);
3422 md.mDialog.show();
3423 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003424 }
3425
3426 /**
3427 * Dismiss a dialog that was previously shown via {@link #showDialog(int)}.
3428 *
3429 * @param id The id of the managed dialog.
3430 *
3431 * @throws IllegalArgumentException if the id was not previously shown via
3432 * {@link #showDialog(int)}.
3433 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003434 * @see #onCreateDialog(int, Bundle)
3435 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003436 * @see #showDialog(int)
3437 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07003438 *
3439 * @deprecated Use the new {@link DialogFragment} class with
3440 * {@link FragmentManager} instead; this is also
3441 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003442 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07003443 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003444 public final void dismissDialog(int id) {
3445 if (mManagedDialogs == null) {
3446 throw missingDialog(id);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003447 }
RoboErik55011652014-07-09 15:05:53 -07003448
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003449 final ManagedDialog md = mManagedDialogs.get(id);
3450 if (md == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003451 throw missingDialog(id);
3452 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003453 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003454 }
3455
3456 /**
3457 * Creates an exception to throw if a user passed in a dialog id that is
3458 * unexpected.
3459 */
3460 private IllegalArgumentException missingDialog(int id) {
3461 return new IllegalArgumentException("no dialog with id " + id + " was ever "
3462 + "shown via Activity#showDialog");
3463 }
3464
3465 /**
3466 * Removes any internal references to a dialog managed by this Activity.
3467 * If the dialog is showing, it will dismiss it as part of the clean up.
3468 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003469 * <p>This can be useful if you know that you will never show a dialog again and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003470 * want to avoid the overhead of saving and restoring it in the future.
3471 *
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07003472 * <p>As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}, this function
3473 * will not throw an exception if you try to remove an ID that does not
3474 * currently have an associated dialog.</p>
RoboErik55011652014-07-09 15:05:53 -07003475 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003476 * @param id The id of the managed dialog.
3477 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08003478 * @see #onCreateDialog(int, Bundle)
3479 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003480 * @see #showDialog(int)
3481 * @see #dismissDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07003482 *
3483 * @deprecated Use the new {@link DialogFragment} class with
3484 * {@link FragmentManager} instead; this is also
3485 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003486 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07003487 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003488 public final void removeDialog(int id) {
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07003489 if (mManagedDialogs != null) {
3490 final ManagedDialog md = mManagedDialogs.get(id);
3491 if (md != null) {
3492 md.mDialog.dismiss();
3493 mManagedDialogs.remove(id);
3494 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003495 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003496 }
3497
3498 /**
3499 * This hook is called when the user signals the desire to start a search.
RoboErik55011652014-07-09 15:05:53 -07003500 *
Bjorn Bringert6266e402009-09-25 14:25:41 +01003501 * <p>You can use this function as a simple way to launch the search UI, in response to a
RoboErik55011652014-07-09 15:05:53 -07003502 * menu item, search button, or other widgets within your activity. Unless overidden,
Bjorn Bringert6266e402009-09-25 14:25:41 +01003503 * calling this function is the same as calling
3504 * {@link #startSearch startSearch(null, false, null, false)}, which launches
3505 * search for the current activity as specified in its manifest, see {@link SearchManager}.
RoboErik55011652014-07-09 15:05:53 -07003506 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003507 * <p>You can override this function to force global search, e.g. in response to a dedicated
3508 * search key, or to block search entirely (by simply returning false).
RoboErik55011652014-07-09 15:05:53 -07003509 *
Dianne Hackbornfdf5b352014-10-08 17:43:48 -07003510 * <p>Note: when running in a {@link Configuration#UI_MODE_TYPE_TELEVISION}, the default
3511 * implementation changes to simply return false and you must supply your own custom
3512 * implementation if you want to support search.</p>
3513 *
3514 * @return Returns {@code true} if search launched, and {@code false} if the activity does
3515 * not respond to search. The default implementation always returns {@code true}, except
3516 * when in {@link Configuration#UI_MODE_TYPE_TELEVISION} mode where it returns false.
RoboErik55011652014-07-09 15:05:53 -07003517 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003518 * @see android.app.SearchManager
3519 */
3520 public boolean onSearchRequested() {
Dianne Hackbornfdf5b352014-10-08 17:43:48 -07003521 if ((getResources().getConfiguration().uiMode&Configuration.UI_MODE_TYPE_MASK)
3522 != Configuration.UI_MODE_TYPE_TELEVISION) {
3523 startSearch(null, false, null, false);
3524 return true;
3525 } else {
3526 return false;
3527 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003528 }
RoboErik55011652014-07-09 15:05:53 -07003529
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003530 /**
3531 * This hook is called to launch the search UI.
RoboErik55011652014-07-09 15:05:53 -07003532 *
3533 * <p>It is typically called from onSearchRequested(), either directly from
3534 * Activity.onSearchRequested() or from an overridden version in any given
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003535 * Activity. If your goal is simply to activate search, it is preferred to call
Tor Norbyed9273d62013-05-30 15:59:53 -07003536 * onSearchRequested(), which may have been overridden elsewhere in your Activity. If your goal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003537 * is to inject specific data such as context data, it is preferred to <i>override</i>
3538 * onSearchRequested(), so that any callers to it will benefit from the override.
RoboErik55011652014-07-09 15:05:53 -07003539 *
3540 * @param initialQuery Any non-null non-empty string will be inserted as
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003541 * pre-entered text in the search query box.
Tor Norbyed9273d62013-05-30 15:59:53 -07003542 * @param selectInitialQuery If true, the initial query will be preselected, which means that
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003543 * any further typing will replace it. This is useful for cases where an entire pre-formed
3544 * query is being inserted. If false, the selection point will be placed at the end of the
3545 * inserted query. This is useful when the inserted query is text that the user entered,
3546 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful
3547 * if initialQuery is a non-empty string.</i>
RoboErik55011652014-07-09 15:05:53 -07003548 * @param appSearchData An application can insert application-specific
3549 * context here, in order to improve quality or specificity of its own
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003550 * searches. This data will be returned with SEARCH intent(s). Null if
3551 * no extra data is required.
3552 * @param globalSearch If false, this will only launch the search that has been specifically
RoboErik55011652014-07-09 15:05:53 -07003553 * defined by the application (which is usually defined as a local search). If no default
Mike LeBeaucfa419b2009-08-17 10:56:02 -07003554 * search is defined in the current application or activity, global search will be launched.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003555 * If true, this will always launch a platform-global (e.g. web-based) search instead.
RoboErik55011652014-07-09 15:05:53 -07003556 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003557 * @see android.app.SearchManager
3558 * @see #onSearchRequested
3559 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003560 public void startSearch(@Nullable String initialQuery, boolean selectInitialQuery,
3561 @Nullable Bundle appSearchData, boolean globalSearch) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003562 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003563 mSearchManager.startSearch(initialQuery, selectInitialQuery, getComponentName(),
RoboErik55011652014-07-09 15:05:53 -07003564 appSearchData, globalSearch);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003565 }
3566
3567 /**
krosaend2d60142009-08-17 08:56:48 -07003568 * Similar to {@link #startSearch}, but actually fires off the search query after invoking
3569 * the search dialog. Made available for testing purposes.
3570 *
3571 * @param query The query to trigger. If empty, the request will be ignored.
3572 * @param appSearchData An application can insert application-specific
3573 * context here, in order to improve quality or specificity of its own
3574 * searches. This data will be returned with SEARCH intent(s). Null if
3575 * no extra data is required.
krosaend2d60142009-08-17 08:56:48 -07003576 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003577 public void triggerSearch(String query, @Nullable Bundle appSearchData) {
krosaend2d60142009-08-17 08:56:48 -07003578 ensureSearchManager();
Bjorn Bringertb782a2f2009-10-01 09:57:33 +01003579 mSearchManager.triggerSearch(query, getComponentName(), appSearchData);
krosaend2d60142009-08-17 08:56:48 -07003580 }
3581
3582 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003583 * Request that key events come to this activity. Use this if your
3584 * activity has no views with focus, but the activity still wants
3585 * a chance to process key events.
RoboErik55011652014-07-09 15:05:53 -07003586 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003587 * @see android.view.Window#takeKeyEvents
3588 */
3589 public void takeKeyEvents(boolean get) {
3590 getWindow().takeKeyEvents(get);
3591 }
3592
3593 /**
3594 * Enable extended window features. This is a convenience for calling
3595 * {@link android.view.Window#requestFeature getWindow().requestFeature()}.
RoboErik55011652014-07-09 15:05:53 -07003596 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003597 * @param featureId The desired feature as defined in
3598 * {@link android.view.Window}.
3599 * @return Returns true if the requested feature is supported and now
3600 * enabled.
RoboErik55011652014-07-09 15:05:53 -07003601 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003602 * @see android.view.Window#requestFeature
3603 */
3604 public final boolean requestWindowFeature(int featureId) {
3605 return getWindow().requestFeature(featureId);
3606 }
3607
3608 /**
3609 * Convenience for calling
3610 * {@link android.view.Window#setFeatureDrawableResource}.
3611 */
3612 public final void setFeatureDrawableResource(int featureId, int resId) {
3613 getWindow().setFeatureDrawableResource(featureId, resId);
3614 }
3615
3616 /**
3617 * Convenience for calling
3618 * {@link android.view.Window#setFeatureDrawableUri}.
3619 */
3620 public final void setFeatureDrawableUri(int featureId, Uri uri) {
3621 getWindow().setFeatureDrawableUri(featureId, uri);
3622 }
3623
3624 /**
3625 * Convenience for calling
3626 * {@link android.view.Window#setFeatureDrawable(int, Drawable)}.
3627 */
3628 public final void setFeatureDrawable(int featureId, Drawable drawable) {
3629 getWindow().setFeatureDrawable(featureId, drawable);
3630 }
3631
3632 /**
3633 * Convenience for calling
3634 * {@link android.view.Window#setFeatureDrawableAlpha}.
3635 */
3636 public final void setFeatureDrawableAlpha(int featureId, int alpha) {
3637 getWindow().setFeatureDrawableAlpha(featureId, alpha);
3638 }
3639
3640 /**
3641 * Convenience for calling
3642 * {@link android.view.Window#getLayoutInflater}.
3643 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003644 @NonNull
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003645 public LayoutInflater getLayoutInflater() {
3646 return getWindow().getLayoutInflater();
3647 }
3648
3649 /**
3650 * Returns a {@link MenuInflater} with this context.
3651 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003652 @NonNull
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003653 public MenuInflater getMenuInflater() {
Adam Powell88ab6972011-07-28 11:25:01 -07003654 // Make sure that action views can get an appropriate theme.
3655 if (mMenuInflater == null) {
Adam Powelle43340c2014-03-17 19:10:43 -07003656 initWindowDecorActionBar();
Adam Powell88ab6972011-07-28 11:25:01 -07003657 if (mActionBar != null) {
Dianne Hackborn92751972012-05-18 19:22:14 -07003658 mMenuInflater = new MenuInflater(mActionBar.getThemedContext(), this);
Adam Powell88ab6972011-07-28 11:25:01 -07003659 } else {
3660 mMenuInflater = new MenuInflater(this);
3661 }
3662 }
3663 return mMenuInflater;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003664 }
3665
3666 @Override
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003667 protected void onApplyThemeResource(Resources.Theme theme, int resid,
3668 boolean first) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003669 if (mParent == null) {
3670 super.onApplyThemeResource(theme, resid, first);
3671 } else {
3672 try {
3673 theme.setTo(mParent.getTheme());
3674 } catch (Exception e) {
3675 // Empty
3676 }
3677 theme.applyStyle(resid, false);
3678 }
Winson Chung03a9bae2014-05-02 09:56:12 -07003679
Winson Chunga449dc02014-05-16 11:15:04 -07003680 // Get the primary color and update the TaskDescription for this activity
Winson Chung4d1a4342014-05-09 16:42:00 -07003681 if (theme != null) {
3682 TypedArray a = theme.obtainStyledAttributes(com.android.internal.R.styleable.Theme);
Winson Chungaca96022014-05-09 15:04:08 -07003683 int colorPrimary = a.getColor(com.android.internal.R.styleable.Theme_colorPrimary, 0);
3684 a.recycle();
3685 if (colorPrimary != 0) {
Winson Chunga449dc02014-05-16 11:15:04 -07003686 ActivityManager.TaskDescription v = new ActivityManager.TaskDescription(null, null,
3687 colorPrimary);
3688 setTaskDescription(v);
Winson Chungaca96022014-05-09 15:04:08 -07003689 }
Winson Chung03a9bae2014-05-02 09:56:12 -07003690 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003691 }
3692
3693 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07003694 * Same as calling {@link #startActivityForResult(Intent, int, Bundle)}
3695 * with no options.
3696 *
3697 * @param intent The intent to start.
3698 * @param requestCode If >= 0, this code will be returned in
3699 * onActivityResult() when the activity exits.
3700 *
3701 * @throws android.content.ActivityNotFoundException
3702 *
George Mount0a778ed2013-12-13 13:35:36 -08003703 * @see #startActivity
Dianne Hackborna4972e92012-03-14 10:38:05 -07003704 */
3705 public void startActivityForResult(Intent intent, int requestCode) {
George Mountabb63cb2014-06-23 11:17:58 -07003706 startActivityForResult(intent, requestCode, null);
Dianne Hackborna4972e92012-03-14 10:38:05 -07003707 }
3708
3709 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003710 * Launch an activity for which you would like a result when it finished.
3711 * When this activity exits, your
George Mount0a778ed2013-12-13 13:35:36 -08003712 * onActivityResult() method will be called with the given requestCode.
RoboErik55011652014-07-09 15:05:53 -07003713 * Using a negative requestCode is the same as calling
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003714 * {@link #startActivity} (the activity is not launched as a sub-activity).
Dianne Hackborna4972e92012-03-14 10:38:05 -07003715 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003716 * <p>Note that this method should only be used with Intent protocols
3717 * that are defined to return a result. In other protocols (such as
3718 * {@link Intent#ACTION_MAIN} or {@link Intent#ACTION_VIEW}), you may
3719 * not get the result when you expect. For example, if the activity you
3720 * are launching uses the singleTask launch mode, it will not run in your
3721 * task and thus you will immediately receive a cancel result.
Dianne Hackborna4972e92012-03-14 10:38:05 -07003722 *
RoboErik55011652014-07-09 15:05:53 -07003723 * <p>As a special case, if you call startActivityForResult() with a requestCode
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003724 * >= 0 during the initial onCreate(Bundle savedInstanceState)/onResume() of your
George Mount0a778ed2013-12-13 13:35:36 -08003725 * activity, then your window will not be displayed until a result is
3726 * returned back from the started activity. This is to avoid visible
3727 * flickering when redirecting to another activity.
Dianne Hackborna4972e92012-03-14 10:38:05 -07003728 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003729 * <p>This method throws {@link android.content.ActivityNotFoundException}
3730 * if there was no Activity found to run the given Intent.
Dianne Hackborna4972e92012-03-14 10:38:05 -07003731 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003732 * @param intent The intent to start.
3733 * @param requestCode If >= 0, this code will be returned in
3734 * onActivityResult() when the activity exits.
Dianne Hackborna4972e92012-03-14 10:38:05 -07003735 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07003736 * See {@link android.content.Context#startActivity(Intent, Bundle)
3737 * Context.startActivity(Intent, Bundle)} for more details.
Dianne Hackborna4972e92012-03-14 10:38:05 -07003738 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003739 * @throws android.content.ActivityNotFoundException
Dianne Hackborna4972e92012-03-14 10:38:05 -07003740 *
George Mount0a778ed2013-12-13 13:35:36 -08003741 * @see #startActivity
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003742 */
Tor Norbyed9273d62013-05-30 15:59:53 -07003743 public void startActivityForResult(Intent intent, int requestCode, @Nullable Bundle options) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003744 if (mParent == null) {
3745 Instrumentation.ActivityResult ar =
3746 mInstrumentation.execStartActivity(
3747 this, mMainThread.getApplicationThread(), mToken, this,
Dianne Hackborna4972e92012-03-14 10:38:05 -07003748 intent, requestCode, options);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003749 if (ar != null) {
3750 mMainThread.sendActivityResult(
3751 mToken, mEmbeddedID, requestCode, ar.getResultCode(),
3752 ar.getResultData());
3753 }
3754 if (requestCode >= 0) {
3755 // If this start is requesting a result, we can avoid making
3756 // the activity visible until the result is received. Setting
3757 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3758 // activity hidden during this time, to avoid flickering.
3759 // This can only be done when a result is requested because
3760 // that guarantees we will get information back when the
3761 // activity is finished, no matter what happens to it.
3762 mStartedActivity = true;
3763 }
Adam Powell14874662013-07-18 19:42:41 -07003764
3765 final View decor = mWindow != null ? mWindow.peekDecorView() : null;
3766 if (decor != null) {
3767 decor.cancelPendingInputEvents();
3768 }
3769 // TODO Consider clearing/flushing other event sources and events for child windows.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003770 } else {
Dianne Hackborna4972e92012-03-14 10:38:05 -07003771 if (options != null) {
3772 mParent.startActivityFromChild(this, intent, requestCode, options);
3773 } else {
3774 // Note we want to go through this method for compatibility with
3775 // existing applications that may have overridden it.
3776 mParent.startActivityFromChild(this, intent, requestCode);
3777 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003778 }
George Mountff243282014-07-07 16:12:07 -07003779 if (options != null && !isTopOfTask()) {
3780 mActivityTransitionState.startExitOutTransition(this, options);
3781 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003782 }
3783
3784 /**
Dianne Hackbornf1c26e22012-08-23 13:54:58 -07003785 * @hide Implement to provide correct calling token.
3786 */
Alexandra Gherghina83231452014-07-04 12:05:20 +01003787 public void startActivityForResultAsUser(Intent intent, int requestCode, UserHandle user) {
3788 startActivityForResultAsUser(intent, requestCode, null, user);
3789 }
3790
3791 /**
3792 * @hide Implement to provide correct calling token.
3793 */
3794 public void startActivityForResultAsUser(Intent intent, int requestCode,
3795 @Nullable Bundle options, UserHandle user) {
3796 if (options != null) {
3797 mActivityTransitionState.startExitOutTransition(this, options);
3798 }
3799 if (mParent != null) {
3800 throw new RuntimeException("Can't be called from a child");
3801 }
3802 Instrumentation.ActivityResult ar = mInstrumentation.execStartActivity(
3803 this, mMainThread.getApplicationThread(), mToken, this, intent, requestCode,
3804 options, user);
3805 if (ar != null) {
3806 mMainThread.sendActivityResult(
3807 mToken, mEmbeddedID, requestCode, ar.getResultCode(), ar.getResultData());
3808 }
3809 if (requestCode >= 0) {
3810 // If this start is requesting a result, we can avoid making
3811 // the activity visible until the result is received. Setting
3812 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3813 // activity hidden during this time, to avoid flickering.
3814 // This can only be done when a result is requested because
3815 // that guarantees we will get information back when the
3816 // activity is finished, no matter what happens to it.
3817 mStartedActivity = true;
3818 }
3819
3820 final View decor = mWindow != null ? mWindow.peekDecorView() : null;
3821 if (decor != null) {
3822 decor.cancelPendingInputEvents();
3823 }
3824 }
3825
3826 /**
3827 * @hide Implement to provide correct calling token.
3828 */
Dianne Hackbornf1c26e22012-08-23 13:54:58 -07003829 public void startActivityAsUser(Intent intent, UserHandle user) {
3830 startActivityAsUser(intent, null, user);
3831 }
3832
3833 /**
3834 * @hide Implement to provide correct calling token.
3835 */
3836 public void startActivityAsUser(Intent intent, Bundle options, UserHandle user) {
3837 if (mParent != null) {
Alexandra Gherghina83231452014-07-04 12:05:20 +01003838 throw new RuntimeException("Can't be called from a child");
Dianne Hackbornf1c26e22012-08-23 13:54:58 -07003839 }
3840 Instrumentation.ActivityResult ar =
3841 mInstrumentation.execStartActivity(
3842 this, mMainThread.getApplicationThread(), mToken, this,
3843 intent, -1, options, user);
3844 if (ar != null) {
3845 mMainThread.sendActivityResult(
3846 mToken, mEmbeddedID, -1, ar.getResultCode(),
3847 ar.getResultData());
3848 }
3849 }
3850
3851 /**
Dianne Hackborn028ceeb2014-08-17 17:45:48 -07003852 * Start a new activity as if it was started by the activity that started our
3853 * current activity. This is for the resolver and chooser activities, which operate
3854 * as intermediaries that dispatch their intent to the target the user selects -- to
3855 * do this, they must perform all security checks including permission grants as if
3856 * their launch had come from the original activity.
3857 * @hide
3858 */
Jeff Sharkey97978802014-10-14 10:48:18 -07003859 public void startActivityAsCaller(Intent intent, @Nullable Bundle options, int userId) {
Dianne Hackborn028ceeb2014-08-17 17:45:48 -07003860 if (mParent != null) {
3861 throw new RuntimeException("Can't be called from a child");
3862 }
3863 Instrumentation.ActivityResult ar =
3864 mInstrumentation.execStartActivityAsCaller(
3865 this, mMainThread.getApplicationThread(), mToken, this,
Jeff Sharkey97978802014-10-14 10:48:18 -07003866 intent, -1, options, userId);
Dianne Hackborn028ceeb2014-08-17 17:45:48 -07003867 if (ar != null) {
3868 mMainThread.sendActivityResult(
3869 mToken, mEmbeddedID, -1, ar.getResultCode(),
3870 ar.getResultData());
3871 }
3872 }
3873
3874 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07003875 * Same as calling {@link #startIntentSenderForResult(IntentSender, int,
3876 * Intent, int, int, int, Bundle)} with no options.
3877 *
3878 * @param intent The IntentSender to launch.
3879 * @param requestCode If >= 0, this code will be returned in
3880 * onActivityResult() when the activity exits.
3881 * @param fillInIntent If non-null, this will be provided as the
3882 * intent parameter to {@link IntentSender#sendIntent}.
3883 * @param flagsMask Intent flags in the original IntentSender that you
3884 * would like to change.
3885 * @param flagsValues Desired values for any bits set in
3886 * <var>flagsMask</var>
3887 * @param extraFlags Always set to 0.
3888 */
3889 public void startIntentSenderForResult(IntentSender intent, int requestCode,
Tor Norbyed9273d62013-05-30 15:59:53 -07003890 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
Dianne Hackborna4972e92012-03-14 10:38:05 -07003891 throws IntentSender.SendIntentException {
3892 startIntentSenderForResult(intent, requestCode, fillInIntent, flagsMask,
3893 flagsValues, extraFlags, null);
3894 }
3895
3896 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003897 * Like {@link #startActivityForResult(Intent, int)}, but allowing you
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003898 * to use a IntentSender to describe the activity to be started. If
3899 * the IntentSender is for an activity, that activity will be started
3900 * as if you had called the regular {@link #startActivityForResult(Intent, int)}
3901 * here; otherwise, its associated action will be executed (such as
3902 * sending a broadcast) as if you had called
3903 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
RoboErik55011652014-07-09 15:05:53 -07003904 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003905 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003906 * @param requestCode If >= 0, this code will be returned in
3907 * onActivityResult() when the activity exits.
3908 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003909 * intent parameter to {@link IntentSender#sendIntent}.
3910 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003911 * would like to change.
3912 * @param flagsValues Desired values for any bits set in
3913 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003914 * @param extraFlags Always set to 0.
Dianne Hackborna4972e92012-03-14 10:38:05 -07003915 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07003916 * See {@link android.content.Context#startActivity(Intent, Bundle)
3917 * Context.startActivity(Intent, Bundle)} for more details. If options
3918 * have also been supplied by the IntentSender, options given here will
3919 * override any that conflict with those given by the IntentSender.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003920 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003921 public void startIntentSenderForResult(IntentSender intent, int requestCode,
Tor Norbyed9273d62013-05-30 15:59:53 -07003922 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags,
Dianne Hackborna4972e92012-03-14 10:38:05 -07003923 Bundle options) throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003924 if (mParent == null) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003925 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackborna4972e92012-03-14 10:38:05 -07003926 flagsMask, flagsValues, this, options);
3927 } else if (options != null) {
3928 mParent.startIntentSenderFromChild(this, intent, requestCode,
3929 fillInIntent, flagsMask, flagsValues, extraFlags, options);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003930 } else {
Dianne Hackborna4972e92012-03-14 10:38:05 -07003931 // Note we want to go through this call for compatibility with
3932 // existing applications that may have overridden the method.
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003933 mParent.startIntentSenderFromChild(this, intent, requestCode,
3934 fillInIntent, flagsMask, flagsValues, extraFlags);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003935 }
3936 }
3937
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003938 private void startIntentSenderForResultInner(IntentSender intent, int requestCode,
Dianne Hackborna4972e92012-03-14 10:38:05 -07003939 Intent fillInIntent, int flagsMask, int flagsValues, Activity activity,
3940 Bundle options)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003941 throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003942 try {
3943 String resolvedType = null;
3944 if (fillInIntent != null) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07003945 fillInIntent.migrateExtraStreamToClipData();
3946 fillInIntent.prepareToLeaveProcess();
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003947 resolvedType = fillInIntent.resolveTypeIfNeeded(getContentResolver());
3948 }
3949 int result = ActivityManagerNative.getDefault()
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003950 .startActivityIntentSender(mMainThread.getApplicationThread(), intent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003951 fillInIntent, resolvedType, mToken, activity.mEmbeddedID,
Dianne Hackborna4972e92012-03-14 10:38:05 -07003952 requestCode, flagsMask, flagsValues, options);
3953 if (result == ActivityManager.START_CANCELED) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003954 throw new IntentSender.SendIntentException();
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003955 }
3956 Instrumentation.checkStartActivityResult(result, null);
3957 } catch (RemoteException e) {
3958 }
3959 if (requestCode >= 0) {
3960 // If this start is requesting a result, we can avoid making
3961 // the activity visible until the result is received. Setting
3962 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3963 // activity hidden during this time, to avoid flickering.
3964 // This can only be done when a result is requested because
3965 // that guarantees we will get information back when the
3966 // activity is finished, no matter what happens to it.
3967 mStartedActivity = true;
3968 }
3969 }
3970
3971 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07003972 * Same as {@link #startActivity(Intent, Bundle)} with no options
3973 * specified.
3974 *
3975 * @param intent The intent to start.
3976 *
3977 * @throws android.content.ActivityNotFoundException
3978 *
3979 * @see {@link #startActivity(Intent, Bundle)}
3980 * @see #startActivityForResult
3981 */
3982 @Override
3983 public void startActivity(Intent intent) {
George Mounte1803372014-02-26 19:00:52 +00003984 this.startActivity(intent, null);
Dianne Hackborna4972e92012-03-14 10:38:05 -07003985 }
3986
3987 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003988 * Launch a new activity. You will not receive any information about when
3989 * the activity exits. This implementation overrides the base version,
3990 * providing information about
3991 * the activity performing the launch. Because of this additional
3992 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not
3993 * required; if not specified, the new activity will be added to the
3994 * task of the caller.
RoboErik55011652014-07-09 15:05:53 -07003995 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003996 * <p>This method throws {@link android.content.ActivityNotFoundException}
3997 * if there was no Activity found to run the given Intent.
RoboErik55011652014-07-09 15:05:53 -07003998 *
3999 * @param intent The intent to start.
Dianne Hackborna4972e92012-03-14 10:38:05 -07004000 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004001 * See {@link android.content.Context#startActivity(Intent, Bundle)
4002 * Context.startActivity(Intent, Bundle)} for more details.
RoboErik55011652014-07-09 15:05:53 -07004003 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004004 * @throws android.content.ActivityNotFoundException
Dianne Hackborna4972e92012-03-14 10:38:05 -07004005 *
4006 * @see {@link #startActivity(Intent)}
RoboErik55011652014-07-09 15:05:53 -07004007 * @see #startActivityForResult
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004008 */
4009 @Override
Tor Norbyed9273d62013-05-30 15:59:53 -07004010 public void startActivity(Intent intent, @Nullable Bundle options) {
Dianne Hackborna4972e92012-03-14 10:38:05 -07004011 if (options != null) {
4012 startActivityForResult(intent, -1, options);
4013 } else {
4014 // Note we want to go through this call for compatibility with
4015 // applications that may have overridden the method.
4016 startActivityForResult(intent, -1);
4017 }
4018 }
4019
4020 /**
4021 * Same as {@link #startActivities(Intent[], Bundle)} with no options
4022 * specified.
4023 *
4024 * @param intents The intents to start.
4025 *
4026 * @throws android.content.ActivityNotFoundException
4027 *
4028 * @see {@link #startActivities(Intent[], Bundle)}
4029 * @see #startActivityForResult
4030 */
4031 @Override
4032 public void startActivities(Intent[] intents) {
4033 startActivities(intents, null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004034 }
4035
4036 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004037 * Launch a new activity. You will not receive any information about when
4038 * the activity exits. This implementation overrides the base version,
4039 * providing information about
4040 * the activity performing the launch. Because of this additional
4041 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not
4042 * required; if not specified, the new activity will be added to the
4043 * task of the caller.
4044 *
4045 * <p>This method throws {@link android.content.ActivityNotFoundException}
4046 * if there was no Activity found to run the given Intent.
4047 *
4048 * @param intents The intents to start.
Dianne Hackborna4972e92012-03-14 10:38:05 -07004049 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004050 * See {@link android.content.Context#startActivity(Intent, Bundle)
4051 * Context.startActivity(Intent, Bundle)} for more details.
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004052 *
4053 * @throws android.content.ActivityNotFoundException
4054 *
Dianne Hackborna4972e92012-03-14 10:38:05 -07004055 * @see {@link #startActivities(Intent[])}
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004056 * @see #startActivityForResult
4057 */
4058 @Override
Tor Norbyed9273d62013-05-30 15:59:53 -07004059 public void startActivities(Intent[] intents, @Nullable Bundle options) {
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004060 mInstrumentation.execStartActivities(this, mMainThread.getApplicationThread(),
Dianne Hackborna4972e92012-03-14 10:38:05 -07004061 mToken, this, intents, options);
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004062 }
4063
4064 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07004065 * Same as calling {@link #startIntentSender(IntentSender, Intent, int, int, int, Bundle)}
4066 * with no options.
RoboErik55011652014-07-09 15:05:53 -07004067 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004068 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07004069 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004070 * intent parameter to {@link IntentSender#sendIntent}.
4071 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07004072 * would like to change.
4073 * @param flagsValues Desired values for any bits set in
4074 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004075 * @param extraFlags Always set to 0.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07004076 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004077 public void startIntentSender(IntentSender intent,
Tor Norbyed9273d62013-05-30 15:59:53 -07004078 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004079 throws IntentSender.SendIntentException {
Dianne Hackborna4972e92012-03-14 10:38:05 -07004080 startIntentSender(intent, fillInIntent, flagsMask, flagsValues,
4081 extraFlags, null);
4082 }
4083
4084 /**
4085 * Like {@link #startActivity(Intent, Bundle)}, but taking a IntentSender
4086 * to start; see
4087 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int, Bundle)}
4088 * for more information.
4089 *
4090 * @param intent The IntentSender to launch.
4091 * @param fillInIntent If non-null, this will be provided as the
4092 * intent parameter to {@link IntentSender#sendIntent}.
4093 * @param flagsMask Intent flags in the original IntentSender that you
4094 * would like to change.
4095 * @param flagsValues Desired values for any bits set in
4096 * <var>flagsMask</var>
4097 * @param extraFlags Always set to 0.
4098 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004099 * See {@link android.content.Context#startActivity(Intent, Bundle)
4100 * Context.startActivity(Intent, Bundle)} for more details. If options
4101 * have also been supplied by the IntentSender, options given here will
4102 * override any that conflict with those given by the IntentSender.
Dianne Hackborna4972e92012-03-14 10:38:05 -07004103 */
4104 public void startIntentSender(IntentSender intent,
Tor Norbyed9273d62013-05-30 15:59:53 -07004105 @Nullable Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags,
Dianne Hackborna4972e92012-03-14 10:38:05 -07004106 Bundle options) throws IntentSender.SendIntentException {
4107 if (options != null) {
4108 startIntentSenderForResult(intent, -1, fillInIntent, flagsMask,
4109 flagsValues, extraFlags, options);
4110 } else {
4111 // Note we want to go through this call for compatibility with
4112 // applications that may have overridden the method.
4113 startIntentSenderForResult(intent, -1, fillInIntent, flagsMask,
4114 flagsValues, extraFlags);
4115 }
4116 }
4117
4118 /**
4119 * Same as calling {@link #startActivityIfNeeded(Intent, int, Bundle)}
4120 * with no options.
4121 *
4122 * @param intent The intent to start.
4123 * @param requestCode If >= 0, this code will be returned in
4124 * onActivityResult() when the activity exits, as described in
4125 * {@link #startActivityForResult}.
4126 *
4127 * @return If a new activity was launched then true is returned; otherwise
4128 * false is returned and you must handle the Intent yourself.
4129 *
4130 * @see #startActivity
4131 * @see #startActivityForResult
4132 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004133 public boolean startActivityIfNeeded(@NonNull Intent intent, int requestCode) {
Dianne Hackborna4972e92012-03-14 10:38:05 -07004134 return startActivityIfNeeded(intent, requestCode, null);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07004135 }
4136
4137 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004138 * A special variation to launch an activity only if a new activity
4139 * instance is needed to handle the given Intent. In other words, this is
RoboErik55011652014-07-09 15:05:53 -07004140 * just like {@link #startActivityForResult(Intent, int)} except: if you are
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004141 * using the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} flag, or
RoboErik55011652014-07-09 15:05:53 -07004142 * singleTask or singleTop
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004143 * {@link android.R.styleable#AndroidManifestActivity_launchMode launchMode},
RoboErik55011652014-07-09 15:05:53 -07004144 * and the activity
4145 * that handles <var>intent</var> is the same as your currently running
4146 * activity, then a new instance is not needed. In this case, instead of
4147 * the normal behavior of calling {@link #onNewIntent} this function will
4148 * return and you can handle the Intent yourself.
4149 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004150 * <p>This function can only be called from a top-level activity; if it is
4151 * called from a child activity, a runtime exception will be thrown.
RoboErik55011652014-07-09 15:05:53 -07004152 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004153 * @param intent The intent to start.
4154 * @param requestCode If >= 0, this code will be returned in
4155 * onActivityResult() when the activity exits, as described in
4156 * {@link #startActivityForResult}.
Dianne Hackborna4972e92012-03-14 10:38:05 -07004157 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004158 * See {@link android.content.Context#startActivity(Intent, Bundle)
4159 * Context.startActivity(Intent, Bundle)} for more details.
RoboErik55011652014-07-09 15:05:53 -07004160 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004161 * @return If a new activity was launched then true is returned; otherwise
4162 * false is returned and you must handle the Intent yourself.
RoboErik55011652014-07-09 15:05:53 -07004163 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004164 * @see #startActivity
4165 * @see #startActivityForResult
4166 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004167 public boolean startActivityIfNeeded(@NonNull Intent intent, int requestCode,
4168 @Nullable Bundle options) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004169 if (mParent == null) {
Dianne Hackborna4972e92012-03-14 10:38:05 -07004170 int result = ActivityManager.START_RETURN_INTENT_TO_CALLER;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004171 try {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07004172 intent.migrateExtraStreamToClipData();
4173 intent.prepareToLeaveProcess();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004174 result = ActivityManagerNative.getDefault()
Dianne Hackbornf265ea92013-01-31 15:00:51 -08004175 .startActivity(mMainThread.getApplicationThread(), getBasePackageName(),
Jeff Hao1b012d32014-08-20 10:35:34 -07004176 intent, intent.resolveTypeIfNeeded(getContentResolver()), mToken,
4177 mEmbeddedID, requestCode, ActivityManager.START_FLAG_ONLY_IF_NEEDED,
4178 null, options);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004179 } catch (RemoteException e) {
4180 // Empty
4181 }
Siva Velusamy92a8b222012-03-09 16:24:04 -08004182
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004183 Instrumentation.checkStartActivityResult(result, intent);
Siva Velusamy92a8b222012-03-09 16:24:04 -08004184
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004185 if (requestCode >= 0) {
4186 // If this start is requesting a result, we can avoid making
4187 // the activity visible until the result is received. Setting
4188 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
4189 // activity hidden during this time, to avoid flickering.
4190 // This can only be done when a result is requested because
4191 // that guarantees we will get information back when the
4192 // activity is finished, no matter what happens to it.
4193 mStartedActivity = true;
4194 }
Dianne Hackborna4972e92012-03-14 10:38:05 -07004195 return result != ActivityManager.START_RETURN_INTENT_TO_CALLER;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004196 }
4197
4198 throw new UnsupportedOperationException(
4199 "startActivityIfNeeded can only be called from a top-level activity");
4200 }
4201
4202 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07004203 * Same as calling {@link #startNextMatchingActivity(Intent, Bundle)} with
4204 * no options.
4205 *
4206 * @param intent The intent to dispatch to the next activity. For
4207 * correct behavior, this must be the same as the Intent that started
4208 * your own activity; the only changes you can make are to the extras
4209 * inside of it.
4210 *
4211 * @return Returns a boolean indicating whether there was another Activity
4212 * to start: true if there was a next activity to start, false if there
4213 * wasn't. In general, if true is returned you will then want to call
4214 * finish() on yourself.
4215 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004216 public boolean startNextMatchingActivity(@NonNull Intent intent) {
Dianne Hackborna4972e92012-03-14 10:38:05 -07004217 return startNextMatchingActivity(intent, null);
4218 }
4219
4220 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004221 * Special version of starting an activity, for use when you are replacing
4222 * other activity components. You can use this to hand the Intent off
4223 * to the next Activity that can handle it. You typically call this in
4224 * {@link #onCreate} with the Intent returned by {@link #getIntent}.
RoboErik55011652014-07-09 15:05:53 -07004225 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004226 * @param intent The intent to dispatch to the next activity. For
4227 * correct behavior, this must be the same as the Intent that started
4228 * your own activity; the only changes you can make are to the extras
4229 * inside of it.
Dianne Hackborna4972e92012-03-14 10:38:05 -07004230 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004231 * See {@link android.content.Context#startActivity(Intent, Bundle)
4232 * Context.startActivity(Intent, Bundle)} for more details.
RoboErik55011652014-07-09 15:05:53 -07004233 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004234 * @return Returns a boolean indicating whether there was another Activity
4235 * to start: true if there was a next activity to start, false if there
4236 * wasn't. In general, if true is returned you will then want to call
4237 * finish() on yourself.
4238 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004239 public boolean startNextMatchingActivity(@NonNull Intent intent, @Nullable Bundle options) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004240 if (mParent == null) {
4241 try {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07004242 intent.migrateExtraStreamToClipData();
4243 intent.prepareToLeaveProcess();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004244 return ActivityManagerNative.getDefault()
Dianne Hackborna4972e92012-03-14 10:38:05 -07004245 .startNextMatchingActivity(mToken, intent, options);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004246 } catch (RemoteException e) {
4247 // Empty
4248 }
4249 return false;
4250 }
4251
4252 throw new UnsupportedOperationException(
4253 "startNextMatchingActivity can only be called from a top-level activity");
4254 }
Dianne Hackborna4972e92012-03-14 10:38:05 -07004255
4256 /**
4257 * Same as calling {@link #startActivityFromChild(Activity, Intent, int, Bundle)}
4258 * with no options.
4259 *
4260 * @param child The activity making the call.
4261 * @param intent The intent to start.
4262 * @param requestCode Reply request code. < 0 if reply is not requested.
4263 *
4264 * @throws android.content.ActivityNotFoundException
4265 *
4266 * @see #startActivity
4267 * @see #startActivityForResult
4268 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004269 public void startActivityFromChild(@NonNull Activity child, Intent intent,
Dianne Hackborna4972e92012-03-14 10:38:05 -07004270 int requestCode) {
Dianne Hackborn8078d8c2012-03-20 11:11:26 -07004271 startActivityFromChild(child, intent, requestCode, null);
Dianne Hackborna4972e92012-03-14 10:38:05 -07004272 }
4273
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004274 /**
RoboErik55011652014-07-09 15:05:53 -07004275 * This is called when a child activity of this one calls its
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004276 * {@link #startActivity} or {@link #startActivityForResult} method.
RoboErik55011652014-07-09 15:05:53 -07004277 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004278 * <p>This method throws {@link android.content.ActivityNotFoundException}
4279 * if there was no Activity found to run the given Intent.
RoboErik55011652014-07-09 15:05:53 -07004280 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004281 * @param child The activity making the call.
4282 * @param intent The intent to start.
Dianne Hackborna4972e92012-03-14 10:38:05 -07004283 * @param requestCode Reply request code. < 0 if reply is not requested.
4284 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004285 * See {@link android.content.Context#startActivity(Intent, Bundle)
4286 * Context.startActivity(Intent, Bundle)} for more details.
RoboErik55011652014-07-09 15:05:53 -07004287 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004288 * @throws android.content.ActivityNotFoundException
RoboErik55011652014-07-09 15:05:53 -07004289 *
4290 * @see #startActivity
4291 * @see #startActivityForResult
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004292 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004293 public void startActivityFromChild(@NonNull Activity child, Intent intent,
4294 int requestCode, @Nullable Bundle options) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004295 Instrumentation.ActivityResult ar =
4296 mInstrumentation.execStartActivity(
4297 this, mMainThread.getApplicationThread(), mToken, child,
Dianne Hackborna4972e92012-03-14 10:38:05 -07004298 intent, requestCode, options);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004299 if (ar != null) {
4300 mMainThread.sendActivityResult(
4301 mToken, child.mEmbeddedID, requestCode,
4302 ar.getResultCode(), ar.getResultData());
4303 }
4304 }
4305
4306 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07004307 * Same as calling {@link #startActivityFromFragment(Fragment, Intent, int, Bundle)}
4308 * with no options.
4309 *
4310 * @param fragment The fragment making the call.
4311 * @param intent The intent to start.
4312 * @param requestCode Reply request code. < 0 if reply is not requested.
4313 *
4314 * @throws android.content.ActivityNotFoundException
4315 *
4316 * @see Fragment#startActivity
4317 * @see Fragment#startActivityForResult
4318 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004319 public void startActivityFromFragment(@NonNull Fragment fragment, Intent intent,
Dianne Hackborna4972e92012-03-14 10:38:05 -07004320 int requestCode) {
George Mountabb63cb2014-06-23 11:17:58 -07004321 startActivityFromFragment(fragment, intent, requestCode, null);
Dianne Hackborna4972e92012-03-14 10:38:05 -07004322 }
4323
4324 /**
RoboErik55011652014-07-09 15:05:53 -07004325 * This is called when a Fragment in this activity calls its
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004326 * {@link Fragment#startActivity} or {@link Fragment#startActivityForResult}
4327 * method.
RoboErik55011652014-07-09 15:05:53 -07004328 *
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004329 * <p>This method throws {@link android.content.ActivityNotFoundException}
4330 * if there was no Activity found to run the given Intent.
RoboErik55011652014-07-09 15:05:53 -07004331 *
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004332 * @param fragment The fragment making the call.
4333 * @param intent The intent to start.
RoboErik55011652014-07-09 15:05:53 -07004334 * @param requestCode Reply request code. < 0 if reply is not requested.
Dianne Hackborna4972e92012-03-14 10:38:05 -07004335 * @param options Additional options for how the Activity should be started.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004336 * See {@link android.content.Context#startActivity(Intent, Bundle)
4337 * Context.startActivity(Intent, Bundle)} for more details.
RoboErik55011652014-07-09 15:05:53 -07004338 *
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004339 * @throws android.content.ActivityNotFoundException
RoboErik55011652014-07-09 15:05:53 -07004340 *
4341 * @see Fragment#startActivity
4342 * @see Fragment#startActivityForResult
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004343 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004344 public void startActivityFromFragment(@NonNull Fragment fragment, Intent intent,
4345 int requestCode, @Nullable Bundle options) {
George Mounta8bd9292014-05-21 10:54:17 -07004346 if (options != null) {
4347 mActivityTransitionState.startExitOutTransition(this, options);
4348 }
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004349 Instrumentation.ActivityResult ar =
4350 mInstrumentation.execStartActivity(
4351 this, mMainThread.getApplicationThread(), mToken, fragment,
Dianne Hackborna4972e92012-03-14 10:38:05 -07004352 intent, requestCode, options);
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004353 if (ar != null) {
4354 mMainThread.sendActivityResult(
4355 mToken, fragment.mWho, requestCode,
4356 ar.getResultCode(), ar.getResultData());
4357 }
4358 }
4359
4360 /**
Dianne Hackborna4972e92012-03-14 10:38:05 -07004361 * Same as calling {@link #startIntentSenderFromChild(Activity, IntentSender,
4362 * int, Intent, int, int, int, Bundle)} with no options.
4363 */
4364 public void startIntentSenderFromChild(Activity child, IntentSender intent,
4365 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues,
4366 int extraFlags)
4367 throws IntentSender.SendIntentException {
4368 startIntentSenderFromChild(child, intent, requestCode, fillInIntent,
4369 flagsMask, flagsValues, extraFlags, null);
4370 }
4371
4372 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07004373 * Like {@link #startActivityFromChild(Activity, Intent, int)}, but
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004374 * taking a IntentSender; see
Dianne Hackbornae22c052009-09-17 18:46:22 -07004375 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)}
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07004376 * for more information.
4377 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004378 public void startIntentSenderFromChild(Activity child, IntentSender intent,
4379 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues,
Tor Norbyed9273d62013-05-30 15:59:53 -07004380 int extraFlags, @Nullable Bundle options)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004381 throws IntentSender.SendIntentException {
4382 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackborna4972e92012-03-14 10:38:05 -07004383 flagsMask, flagsValues, child, options);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07004384 }
4385
4386 /**
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07004387 * Call immediately after one of the flavors of {@link #startActivity(Intent)}
4388 * or {@link #finish} to specify an explicit transition animation to
4389 * perform next.
Dianne Hackborn7a2195c2012-03-19 17:38:00 -07004390 *
4391 * <p>As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN} an alternative
4392 * to using this with starting activities is to supply the desired animation
4393 * information through a {@link ActivityOptions} bundle to
4394 * {@link #startActivity(Intent, Bundle) or a related function. This allows
4395 * you to specify a custom animation even when starting an activity from
4396 * outside the context of the current top activity.
4397 *
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07004398 * @param enterAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07004399 * the incoming activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07004400 * @param exitAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07004401 * the outgoing activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07004402 */
4403 public void overridePendingTransition(int enterAnim, int exitAnim) {
4404 try {
4405 ActivityManagerNative.getDefault().overridePendingTransition(
4406 mToken, getPackageName(), enterAnim, exitAnim);
4407 } catch (RemoteException e) {
4408 }
4409 }
RoboErik55011652014-07-09 15:05:53 -07004410
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07004411 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004412 * Call this to set the result that your activity will return to its
4413 * caller.
RoboErik55011652014-07-09 15:05:53 -07004414 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004415 * @param resultCode The result code to propagate back to the originating
4416 * activity, often RESULT_CANCELED or RESULT_OK
RoboErik55011652014-07-09 15:05:53 -07004417 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004418 * @see #RESULT_CANCELED
4419 * @see #RESULT_OK
4420 * @see #RESULT_FIRST_USER
4421 * @see #setResult(int, Intent)
4422 */
4423 public final void setResult(int resultCode) {
4424 synchronized (this) {
4425 mResultCode = resultCode;
4426 mResultData = null;
4427 }
4428 }
4429
4430 /**
4431 * Call this to set the result that your activity will return to its
4432 * caller.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004433 *
4434 * <p>As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}, the Intent
4435 * you supply here can have {@link Intent#FLAG_GRANT_READ_URI_PERMISSION
4436 * Intent.FLAG_GRANT_READ_URI_PERMISSION} and/or {@link Intent#FLAG_GRANT_WRITE_URI_PERMISSION
4437 * Intent.FLAG_GRANT_WRITE_URI_PERMISSION} set. This will grant the
4438 * Activity receiving the result access to the specific URIs in the Intent.
4439 * Access will remain until the Activity has finished (it will remain across the hosting
4440 * process being killed and other temporary destruction) and will be added
4441 * to any existing set of URI permissions it already holds.
4442 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004443 * @param resultCode The result code to propagate back to the originating
4444 * activity, often RESULT_CANCELED or RESULT_OK
4445 * @param data The data to propagate back to the originating activity.
RoboErik55011652014-07-09 15:05:53 -07004446 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004447 * @see #RESULT_CANCELED
4448 * @see #RESULT_OK
4449 * @see #RESULT_FIRST_USER
4450 * @see #setResult(int)
4451 */
4452 public final void setResult(int resultCode, Intent data) {
4453 synchronized (this) {
4454 mResultCode = resultCode;
4455 mResultData = data;
4456 }
4457 }
4458
4459 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004460 * Return information about who launched this activity. If the launching Intent
4461 * contains an {@link android.content.Intent#EXTRA_REFERRER Intent.EXTRA_REFERRER},
4462 * that will be returned as-is; otherwise, if known, an
4463 * {@link Intent#URI_ANDROID_APP_SCHEME android-app:} referrer URI containing the
4464 * package name that started the Intent will be returned. This may return null if no
4465 * referrer can be identified -- it is neither explicitly specified, nor is it known which
4466 * application package was involved.
4467 *
4468 * <p>If called while inside the handling of {@link #onNewIntent}, this function will
4469 * return the referrer that submitted that new intent to the activity. Otherwise, it
4470 * always returns the referrer of the original Intent.</p>
4471 *
4472 * <p>Note that this is <em>not</em> a security feature -- you can not trust the
4473 * referrer information, applications can spoof it.</p>
4474 */
4475 @Nullable
4476 public Uri getReferrer() {
4477 Intent intent = getIntent();
4478 Uri referrer = intent.getParcelableExtra(Intent.EXTRA_REFERRER);
4479 if (referrer != null) {
4480 return referrer;
4481 }
4482 String referrerName = intent.getStringExtra(Intent.EXTRA_REFERRER_NAME);
4483 if (referrerName != null) {
4484 return Uri.parse(referrerName);
4485 }
4486 if (mReferrer != null) {
4487 return new Uri.Builder().scheme("android-app").authority(mReferrer).build();
4488 }
4489 return null;
4490 }
4491
4492 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004493 * Return the name of the package that invoked this activity. This is who
4494 * the data in {@link #setResult setResult()} will be sent to. You can
4495 * use this information to validate that the recipient is allowed to
4496 * receive the data.
RoboErik55011652014-07-09 15:05:53 -07004497 *
Dianne Hackborn7b924672013-04-11 18:08:42 -07004498 * <p class="note">Note: if the calling activity is not expecting a result (that is it
RoboErik55011652014-07-09 15:05:53 -07004499 * did not use the {@link #startActivityForResult}
4500 * form that includes a request code), then the calling package will be
Dianne Hackborn7b924672013-04-11 18:08:42 -07004501 * null.</p>
4502 *
4503 * <p class="note">Note: prior to {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR2},
4504 * the result from this method was unstable. If the process hosting the calling
4505 * package was no longer running, it would return null instead of the proper package
4506 * name. You can use {@link #getCallingActivity()} and retrieve the package name
4507 * from that instead.</p>
RoboErik55011652014-07-09 15:05:53 -07004508 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004509 * @return The package of the activity that will receive your
4510 * reply, or null if none.
4511 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004512 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004513 public String getCallingPackage() {
4514 try {
4515 return ActivityManagerNative.getDefault().getCallingPackage(mToken);
4516 } catch (RemoteException e) {
4517 return null;
4518 }
4519 }
4520
4521 /**
4522 * Return the name of the activity that invoked this activity. This is
4523 * who the data in {@link #setResult setResult()} will be sent to. You
4524 * can use this information to validate that the recipient is allowed to
4525 * receive the data.
RoboErik55011652014-07-09 15:05:53 -07004526 *
Dianne Hackborn7b924672013-04-11 18:08:42 -07004527 * <p class="note">Note: if the calling activity is not expecting a result (that is it
RoboErik55011652014-07-09 15:05:53 -07004528 * did not use the {@link #startActivityForResult}
4529 * form that includes a request code), then the calling package will be
4530 * null.
4531 *
Dianne Hackborn7b924672013-04-11 18:08:42 -07004532 * @return The ComponentName of the activity that will receive your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004533 * reply, or null if none.
4534 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004535 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004536 public ComponentName getCallingActivity() {
4537 try {
4538 return ActivityManagerNative.getDefault().getCallingActivity(mToken);
4539 } catch (RemoteException e) {
4540 return null;
4541 }
4542 }
4543
4544 /**
4545 * Control whether this activity's main window is visible. This is intended
4546 * only for the special case of an activity that is not going to show a
4547 * UI itself, but can't just finish prior to onResume() because it needs
4548 * to wait for a service binding or such. Setting this to false allows
4549 * you to prevent your UI from being shown during that time.
RoboErik55011652014-07-09 15:05:53 -07004550 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004551 * <p>The default value for this is taken from the
4552 * {@link android.R.attr#windowNoDisplay} attribute of the activity's theme.
4553 */
4554 public void setVisible(boolean visible) {
4555 if (mVisibleFromClient != visible) {
4556 mVisibleFromClient = visible;
4557 if (mVisibleFromServer) {
4558 if (visible) makeVisible();
4559 else mDecor.setVisibility(View.INVISIBLE);
4560 }
4561 }
4562 }
RoboErik55011652014-07-09 15:05:53 -07004563
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004564 void makeVisible() {
4565 if (!mWindowAdded) {
4566 ViewManager wm = getWindowManager();
4567 wm.addView(mDecor, getWindow().getAttributes());
4568 mWindowAdded = true;
4569 }
4570 mDecor.setVisibility(View.VISIBLE);
4571 }
RoboErik55011652014-07-09 15:05:53 -07004572
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004573 /**
4574 * Check to see whether this activity is in the process of finishing,
4575 * either because you called {@link #finish} on it or someone else
4576 * has requested that it finished. This is often used in
4577 * {@link #onPause} to determine whether the activity is simply pausing or
4578 * completely finishing.
RoboErik55011652014-07-09 15:05:53 -07004579 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004580 * @return If the activity is finishing, returns true; else returns false.
RoboErik55011652014-07-09 15:05:53 -07004581 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004582 * @see #finish
4583 */
4584 public boolean isFinishing() {
4585 return mFinished;
4586 }
4587
4588 /**
Dianne Hackborn6d9dcbc2012-10-02 17:51:13 -07004589 * Returns true if the final {@link #onDestroy()} call has been made
4590 * on the Activity, so this instance is now dead.
4591 */
4592 public boolean isDestroyed() {
4593 return mDestroyed;
4594 }
4595
4596 /**
Jeff Hamilton3d32f6e2010-04-01 00:04:16 -05004597 * Check to see whether this activity is in the process of being destroyed in order to be
4598 * recreated with a new configuration. This is often used in
4599 * {@link #onStop} to determine whether the state needs to be cleaned up or will be passed
4600 * on to the next instance of the activity via {@link #onRetainNonConfigurationInstance()}.
RoboErik55011652014-07-09 15:05:53 -07004601 *
Jeff Hamilton3d32f6e2010-04-01 00:04:16 -05004602 * @return If the activity is being torn down in order to be recreated with a new configuration,
4603 * returns true; else returns false.
4604 */
4605 public boolean isChangingConfigurations() {
4606 return mChangingConfigurations;
4607 }
4608
4609 /**
Dianne Hackborn30c9bd82010-12-01 16:07:40 -08004610 * Cause this Activity to be recreated with a new instance. This results
4611 * in essentially the same flow as when the Activity is created due to
4612 * a configuration change -- the current instance will go through its
4613 * lifecycle to {@link #onDestroy} and a new instance then created after it.
4614 */
4615 public void recreate() {
4616 if (mParent != null) {
4617 throw new IllegalStateException("Can only be called on top-level activity");
4618 }
4619 if (Looper.myLooper() != mMainThread.getLooper()) {
4620 throw new IllegalStateException("Must be called from main thread");
4621 }
Wale Ogunwale60454db2015-01-23 16:05:07 -08004622 mMainThread.requestRelaunchActivity(mToken, null, null, 0, false, null, null, false);
Dianne Hackborn30c9bd82010-12-01 16:07:40 -08004623 }
4624
4625 /**
Winson Chung3b3f4642014-04-22 10:08:18 -07004626 * Finishes the current activity and specifies whether to remove the task associated with this
4627 * activity.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004628 */
Winson Chung3b3f4642014-04-22 10:08:18 -07004629 private void finish(boolean finishTask) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004630 if (mParent == null) {
4631 int resultCode;
4632 Intent resultData;
4633 synchronized (this) {
4634 resultCode = mResultCode;
4635 resultData = mResultData;
4636 }
Joe Onorato43a17652011-04-06 19:22:23 -07004637 if (false) Log.v(TAG, "Finishing self: token=" + mToken);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004638 try {
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004639 if (resultData != null) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07004640 resultData.prepareToLeaveProcess();
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004641 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004642 if (ActivityManagerNative.getDefault()
Winson Chung3b3f4642014-04-22 10:08:18 -07004643 .finishActivity(mToken, resultCode, resultData, finishTask)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004644 mFinished = true;
4645 }
4646 } catch (RemoteException e) {
4647 // Empty
4648 }
4649 } else {
4650 mParent.finishFromChild(this);
4651 }
4652 }
4653
4654 /**
Winson Chung3b3f4642014-04-22 10:08:18 -07004655 * Call this when your activity is done and should be closed. The
4656 * ActivityResult is propagated back to whoever launched you via
4657 * onActivityResult().
4658 */
4659 public void finish() {
4660 finish(false);
4661 }
4662
4663 /**
Dianne Hackbornecc5a9c2012-04-26 18:56:09 -07004664 * Finish this activity as well as all activities immediately below it
4665 * in the current task that have the same affinity. This is typically
4666 * used when an application can be launched on to another task (such as
4667 * from an ACTION_VIEW of a content type it understands) and the user
4668 * has used the up navigation to switch out of the current task and in
4669 * to its own task. In this case, if the user has navigated down into
4670 * any other activities of the second application, all of those should
4671 * be removed from the original task as part of the task switch.
4672 *
4673 * <p>Note that this finish does <em>not</em> allow you to deliver results
4674 * to the previous activity, and an exception will be thrown if you are trying
4675 * to do so.</p>
4676 */
4677 public void finishAffinity() {
4678 if (mParent != null) {
4679 throw new IllegalStateException("Can not be called from an embedded activity");
4680 }
4681 if (mResultCode != RESULT_CANCELED || mResultData != null) {
4682 throw new IllegalStateException("Can not be called to deliver a result");
4683 }
4684 try {
4685 if (ActivityManagerNative.getDefault().finishActivityAffinity(mToken)) {
4686 mFinished = true;
4687 }
4688 } catch (RemoteException e) {
4689 // Empty
4690 }
4691 }
4692
4693 /**
RoboErik55011652014-07-09 15:05:53 -07004694 * This is called when a child activity of this one calls its
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004695 * {@link #finish} method. The default implementation simply calls
4696 * finish() on this activity (the parent), finishing the entire group.
RoboErik55011652014-07-09 15:05:53 -07004697 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004698 * @param child The activity making the call.
RoboErik55011652014-07-09 15:05:53 -07004699 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004700 * @see #finish
4701 */
4702 public void finishFromChild(Activity child) {
4703 finish();
4704 }
4705
4706 /**
George Mountcb4b7d92014-02-25 10:47:55 -08004707 * Reverses the Activity Scene entry Transition and triggers the calling Activity
4708 * to reverse its exit Transition. When the exit Transition completes,
4709 * {@link #finish()} is called. If no entry Transition was used, finish() is called
4710 * immediately and the Activity exit Transition is run.
George Mount62ab9b72014-05-02 13:51:17 -07004711 * @see android.app.ActivityOptions#makeSceneTransitionAnimation(Activity, android.util.Pair[])
George Mountcb4b7d92014-02-25 10:47:55 -08004712 */
Craig Mautner73f843d2014-05-19 09:42:28 -07004713 public void finishAfterTransition() {
George Mount62ab9b72014-05-02 13:51:17 -07004714 if (!mActivityTransitionState.startExitBackTransition(this)) {
George Mount31a21722014-03-24 17:44:36 -07004715 finish();
4716 }
George Mountcb4b7d92014-02-25 10:47:55 -08004717 }
4718
4719 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004720 * Force finish another activity that you had previously started with
4721 * {@link #startActivityForResult}.
RoboErik55011652014-07-09 15:05:53 -07004722 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004723 * @param requestCode The request code of the activity that you had
4724 * given to startActivityForResult(). If there are multiple
4725 * activities started with this request code, they
4726 * will all be finished.
4727 */
4728 public void finishActivity(int requestCode) {
4729 if (mParent == null) {
4730 try {
4731 ActivityManagerNative.getDefault()
4732 .finishSubActivity(mToken, mEmbeddedID, requestCode);
4733 } catch (RemoteException e) {
4734 // Empty
4735 }
4736 } else {
4737 mParent.finishActivityFromChild(this, requestCode);
4738 }
4739 }
4740
4741 /**
4742 * This is called when a child activity of this one calls its
4743 * finishActivity().
RoboErik55011652014-07-09 15:05:53 -07004744 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004745 * @param child The activity making the call.
4746 * @param requestCode Request code that had been used to start the
4747 * activity.
4748 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004749 public void finishActivityFromChild(@NonNull Activity child, int requestCode) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004750 try {
4751 ActivityManagerNative.getDefault()
4752 .finishSubActivity(mToken, child.mEmbeddedID, requestCode);
4753 } catch (RemoteException e) {
4754 // Empty
4755 }
4756 }
4757
4758 /**
Winson Chung3b3f4642014-04-22 10:08:18 -07004759 * Call this when your activity is done and should be closed and the task should be completely
4760 * removed as a part of finishing the Activity.
4761 */
4762 public void finishAndRemoveTask() {
4763 finish(true);
4764 }
4765
4766 /**
Dianne Hackborn89ad4562014-08-24 16:45:38 -07004767 * Ask that the local app instance of this activity be released to free up its memory.
4768 * This is asking for the activity to be destroyed, but does <b>not</b> finish the activity --
4769 * a new instance of the activity will later be re-created if needed due to the user
4770 * navigating back to it.
4771 *
4772 * @return Returns true if the activity was in a state that it has started the process
4773 * of destroying its current instance; returns false if for any reason this could not
4774 * be done: it is currently visible to the user, it is already being destroyed, it is
4775 * being finished, it hasn't yet saved its state, etc.
4776 */
4777 public boolean releaseInstance() {
4778 try {
4779 return ActivityManagerNative.getDefault().releaseActivityInstance(mToken);
4780 } catch (RemoteException e) {
4781 // Empty
4782 }
4783 return false;
4784 }
4785
4786 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004787 * Called when an activity you launched exits, giving you the requestCode
4788 * you started it with, the resultCode it returned, and any additional
4789 * data from it. The <var>resultCode</var> will be
4790 * {@link #RESULT_CANCELED} if the activity explicitly returned that,
4791 * didn't return any result, or crashed during its operation.
RoboErik55011652014-07-09 15:05:53 -07004792 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004793 * <p>You will receive this call immediately before onResume() when your
4794 * activity is re-starting.
RoboErik55011652014-07-09 15:05:53 -07004795 *
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004796 * <p>This method is never invoked if your activity sets
4797 * {@link android.R.styleable#AndroidManifestActivity_noHistory noHistory} to
4798 * <code>true</code>.
Ricardo Cervera93f94c22015-01-16 09:54:30 -08004799 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004800 * @param requestCode The integer request code originally supplied to
4801 * startActivityForResult(), allowing you to identify who this
4802 * result came from.
4803 * @param resultCode The integer result code returned by the child activity
4804 * through its setResult().
4805 * @param data An Intent, which can return result data to the caller
4806 * (various data can be attached to Intent "extras").
RoboErik55011652014-07-09 15:05:53 -07004807 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004808 * @see #startActivityForResult
4809 * @see #createPendingResult
4810 * @see #setResult(int)
4811 */
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004812 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004813 }
4814
4815 /**
George Mount62ab9b72014-05-02 13:51:17 -07004816 * Called when an activity you launched with an activity transition exposes this
4817 * Activity through a returning activity transition, giving you the resultCode
4818 * and any additional data from it. This method will only be called if the activity
4819 * set a result code other than {@link #RESULT_CANCELED} and it supports activity
George Mount9826f632014-09-11 08:50:09 -07004820 * transitions with {@link Window#FEATURE_ACTIVITY_TRANSITIONS}.
George Mount62ab9b72014-05-02 13:51:17 -07004821 *
4822 * <p>The purpose of this function is to let the called Activity send a hint about
4823 * its state so that this underlying Activity can prepare to be exposed. A call to
4824 * this method does not guarantee that the called Activity has or will be exiting soon.
4825 * It only indicates that it will expose this Activity's Window and it has
4826 * some data to pass to prepare it.</p>
4827 *
4828 * @param resultCode The integer result code returned by the child activity
4829 * through its setResult().
4830 * @param data An Intent, which can return result data to the caller
4831 * (various data can be attached to Intent "extras").
4832 */
Craig Mautner7a629c22014-09-04 14:57:04 -07004833 public void onActivityReenter(int resultCode, Intent data) {
George Mount62ab9b72014-05-02 13:51:17 -07004834 }
4835
4836 /**
RoboErik55011652014-07-09 15:05:53 -07004837 * Create a new PendingIntent object which you can hand to others
4838 * for them to use to send result data back to your
4839 * {@link #onActivityResult} callback. The created object will be either
4840 * one-shot (becoming invalid after a result is sent back) or multiple
4841 * (allowing any number of results to be sent through it).
4842 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004843 * @param requestCode Private request code for the sender that will be
4844 * associated with the result data when it is returned. The sender can not
4845 * modify this value, allowing you to identify incoming results.
4846 * @param data Default data to supply in the result, which may be modified
4847 * by the sender.
4848 * @param flags May be {@link PendingIntent#FLAG_ONE_SHOT PendingIntent.FLAG_ONE_SHOT},
4849 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE},
4850 * {@link PendingIntent#FLAG_CANCEL_CURRENT PendingIntent.FLAG_CANCEL_CURRENT},
4851 * {@link PendingIntent#FLAG_UPDATE_CURRENT PendingIntent.FLAG_UPDATE_CURRENT},
4852 * or any of the flags as supported by
4853 * {@link Intent#fillIn Intent.fillIn()} to control which unspecified parts
4854 * of the intent that can be supplied when the actual send happens.
RoboErik55011652014-07-09 15:05:53 -07004855 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004856 * @return Returns an existing or new PendingIntent matching the given
4857 * parameters. May return null only if
4858 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE} has been
4859 * supplied.
RoboErik55011652014-07-09 15:05:53 -07004860 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004861 * @see PendingIntent
4862 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004863 public PendingIntent createPendingResult(int requestCode, @NonNull Intent data,
4864 @PendingIntent.Flags int flags) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004865 String packageName = getPackageName();
4866 try {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07004867 data.prepareToLeaveProcess();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004868 IIntentSender target =
4869 ActivityManagerNative.getDefault().getIntentSender(
Dianne Hackborna4972e92012-03-14 10:38:05 -07004870 ActivityManager.INTENT_SENDER_ACTIVITY_RESULT, packageName,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004871 mParent == null ? mToken : mParent.mToken,
Dianne Hackborn41203752012-08-31 14:05:51 -07004872 mEmbeddedID, requestCode, new Intent[] { data }, null, flags, null,
4873 UserHandle.myUserId());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004874 return target != null ? new PendingIntent(target) : null;
4875 } catch (RemoteException e) {
4876 // Empty
4877 }
4878 return null;
4879 }
4880
4881 /**
4882 * Change the desired orientation of this activity. If the activity
4883 * is currently in the foreground or otherwise impacting the screen
4884 * orientation, the screen will immediately be changed (possibly causing
4885 * the activity to be restarted). Otherwise, this will be used the next
4886 * time the activity is visible.
RoboErik55011652014-07-09 15:05:53 -07004887 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004888 * @param requestedOrientation An orientation constant as used in
4889 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
4890 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004891 public void setRequestedOrientation(@ActivityInfo.ScreenOrientation int requestedOrientation) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004892 if (mParent == null) {
4893 try {
4894 ActivityManagerNative.getDefault().setRequestedOrientation(
4895 mToken, requestedOrientation);
4896 } catch (RemoteException e) {
4897 // Empty
4898 }
4899 } else {
4900 mParent.setRequestedOrientation(requestedOrientation);
4901 }
4902 }
RoboErik55011652014-07-09 15:05:53 -07004903
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004904 /**
4905 * Return the current requested orientation of the activity. This will
4906 * either be the orientation requested in its component's manifest, or
4907 * the last requested orientation given to
4908 * {@link #setRequestedOrientation(int)}.
RoboErik55011652014-07-09 15:05:53 -07004909 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004910 * @return Returns an orientation constant as used in
4911 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
4912 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004913 @ActivityInfo.ScreenOrientation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004914 public int getRequestedOrientation() {
4915 if (mParent == null) {
4916 try {
4917 return ActivityManagerNative.getDefault()
4918 .getRequestedOrientation(mToken);
4919 } catch (RemoteException e) {
4920 // Empty
4921 }
4922 } else {
4923 return mParent.getRequestedOrientation();
4924 }
4925 return ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED;
4926 }
RoboErik55011652014-07-09 15:05:53 -07004927
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004928 /**
4929 * Return the identifier of the task this activity is in. This identifier
4930 * will remain the same for the lifetime of the activity.
RoboErik55011652014-07-09 15:05:53 -07004931 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004932 * @return Task identifier, an opaque integer.
4933 */
4934 public int getTaskId() {
4935 try {
4936 return ActivityManagerNative.getDefault()
4937 .getTaskForActivity(mToken, false);
4938 } catch (RemoteException e) {
4939 return -1;
4940 }
4941 }
4942
4943 /**
4944 * Return whether this activity is the root of a task. The root is the
4945 * first activity in a task.
RoboErik55011652014-07-09 15:05:53 -07004946 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004947 * @return True if this is the root activity, else false.
4948 */
4949 public boolean isTaskRoot() {
4950 try {
4951 return ActivityManagerNative.getDefault()
4952 .getTaskForActivity(mToken, true) >= 0;
4953 } catch (RemoteException e) {
4954 return false;
4955 }
4956 }
4957
4958 /**
4959 * Move the task containing this activity to the back of the activity
4960 * stack. The activity's order within the task is unchanged.
RoboErik55011652014-07-09 15:05:53 -07004961 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004962 * @param nonRoot If false then this only works if the activity is the root
4963 * of a task; if true it will work for any activity in
4964 * a task.
RoboErik55011652014-07-09 15:05:53 -07004965 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004966 * @return If the task was moved (or it was already at the
4967 * back) true is returned, else false.
4968 */
4969 public boolean moveTaskToBack(boolean nonRoot) {
4970 try {
4971 return ActivityManagerNative.getDefault().moveActivityTaskToBack(
4972 mToken, nonRoot);
4973 } catch (RemoteException e) {
4974 // Empty
4975 }
4976 return false;
4977 }
4978
4979 /**
4980 * Returns class name for this activity with the package prefix removed.
4981 * This is the default name used to read and write settings.
RoboErik55011652014-07-09 15:05:53 -07004982 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004983 * @return The local class name.
4984 */
Tor Norbyed9273d62013-05-30 15:59:53 -07004985 @NonNull
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004986 public String getLocalClassName() {
4987 final String pkg = getPackageName();
4988 final String cls = mComponent.getClassName();
4989 int packageLen = pkg.length();
4990 if (!cls.startsWith(pkg) || cls.length() <= packageLen
4991 || cls.charAt(packageLen) != '.') {
4992 return cls;
4993 }
4994 return cls.substring(packageLen+1);
4995 }
RoboErik55011652014-07-09 15:05:53 -07004996
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004997 /**
4998 * Returns complete component name of this activity.
RoboErik55011652014-07-09 15:05:53 -07004999 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005000 * @return Returns the complete component name for this activity
5001 */
5002 public ComponentName getComponentName()
5003 {
5004 return mComponent;
5005 }
5006
5007 /**
5008 * Retrieve a {@link SharedPreferences} object for accessing preferences
5009 * that are private to this activity. This simply calls the underlying
5010 * {@link #getSharedPreferences(String, int)} method by passing in this activity's
5011 * class name as the preferences name.
RoboErik55011652014-07-09 15:05:53 -07005012 *
5013 * @param mode Operating mode. Use {@link #MODE_PRIVATE} for the default
5014 * operation, {@link #MODE_WORLD_READABLE} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005015 * {@link #MODE_WORLD_WRITEABLE} to control permissions.
5016 *
5017 * @return Returns the single SharedPreferences instance that can be used
5018 * to retrieve and modify the preference values.
5019 */
5020 public SharedPreferences getPreferences(int mode) {
5021 return getSharedPreferences(getLocalClassName(), mode);
5022 }
RoboErik55011652014-07-09 15:05:53 -07005023
Dianne Hackbornb06ea702009-07-13 13:07:51 -07005024 private void ensureSearchManager() {
5025 if (mSearchManager != null) {
5026 return;
5027 }
RoboErik55011652014-07-09 15:05:53 -07005028
Amith Yamasanie9ce3f02010-01-25 09:15:50 -08005029 mSearchManager = new SearchManager(this, null);
Dianne Hackbornb06ea702009-07-13 13:07:51 -07005030 }
Tor Norbyed9273d62013-05-30 15:59:53 -07005031
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005032 @Override
Tor Norbyed9273d62013-05-30 15:59:53 -07005033 public Object getSystemService(@ServiceName @NonNull String name) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005034 if (getBaseContext() == null) {
5035 throw new IllegalStateException(
5036 "System services not available to Activities before onCreate()");
5037 }
5038
5039 if (WINDOW_SERVICE.equals(name)) {
5040 return mWindowManager;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01005041 } else if (SEARCH_SERVICE.equals(name)) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07005042 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01005043 return mSearchManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005044 }
5045 return super.getSystemService(name);
5046 }
5047
5048 /**
5049 * Change the title associated with this activity. If this is a
5050 * top-level activity, the title for its window will change. If it
5051 * is an embedded activity, the parent can do whatever it wants
5052 * with it.
5053 */
5054 public void setTitle(CharSequence title) {
5055 mTitle = title;
5056 onTitleChanged(title, mTitleColor);
5057
5058 if (mParent != null) {
5059 mParent.onChildTitleChanged(this, title);
5060 }
5061 }
5062
5063 /**
5064 * Change the title associated with this activity. If this is a
5065 * top-level activity, the title for its window will change. If it
5066 * is an embedded activity, the parent can do whatever it wants
5067 * with it.
5068 */
5069 public void setTitle(int titleId) {
5070 setTitle(getText(titleId));
5071 }
5072
Alan Viverette2525d9c2013-11-15 14:42:19 -08005073 /**
5074 * Change the color of the title associated with this activity.
5075 * <p>
5076 * This method is deprecated starting in API Level 11 and replaced by action
5077 * bar styles. For information on styling the Action Bar, read the <a
5078 * href="{@docRoot} guide/topics/ui/actionbar.html">Action Bar</a> developer
5079 * guide.
5080 *
5081 * @deprecated Use action bar styles instead.
5082 */
5083 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005084 public void setTitleColor(int textColor) {
5085 mTitleColor = textColor;
5086 onTitleChanged(mTitle, textColor);
5087 }
5088
5089 public final CharSequence getTitle() {
5090 return mTitle;
5091 }
5092
5093 public final int getTitleColor() {
5094 return mTitleColor;
5095 }
5096
5097 protected void onTitleChanged(CharSequence title, int color) {
5098 if (mTitleReady) {
5099 final Window win = getWindow();
5100 if (win != null) {
5101 win.setTitle(title);
5102 if (color != 0) {
5103 win.setTitleColor(color);
5104 }
5105 }
Adam Powellaf2d8592014-08-26 18:06:40 -07005106 if (mActionBar != null) {
5107 mActionBar.setWindowTitle(title);
5108 }
Adam Powella557fdc2014-08-21 18:05:53 -07005109 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005110 }
5111
5112 protected void onChildTitleChanged(Activity childActivity, CharSequence title) {
5113 }
5114
5115 /**
Winson Chunga449dc02014-05-16 11:15:04 -07005116 * Sets information describing the task with this activity for presentation inside the Recents
5117 * System UI. When {@link ActivityManager#getRecentTasks} is called, the activities of each task
5118 * are traversed in order from the topmost activity to the bottommost. The traversal continues
5119 * for each property until a suitable value is found. For each task the taskDescription will be
5120 * returned in {@link android.app.ActivityManager.TaskDescription}.
Craig Mautner2fbd7542014-03-21 09:34:07 -07005121 *
5122 * @see ActivityManager#getRecentTasks
Winson Chunga449dc02014-05-16 11:15:04 -07005123 * @see android.app.ActivityManager.TaskDescription
Craig Mautner2fbd7542014-03-21 09:34:07 -07005124 *
Winson Chunga449dc02014-05-16 11:15:04 -07005125 * @param taskDescription The TaskDescription properties that describe the task with this activity
Craig Mautner2fbd7542014-03-21 09:34:07 -07005126 */
Winson Chunga449dc02014-05-16 11:15:04 -07005127 public void setTaskDescription(ActivityManager.TaskDescription taskDescription) {
5128 ActivityManager.TaskDescription td;
5129 // Scale the icon down to something reasonable if it is provided
Craig Mautner648f69b2014-09-18 14:16:26 -07005130 if (taskDescription.getIconFilename() == null && taskDescription.getIcon() != null) {
Craig Mautner2fbd7542014-03-21 09:34:07 -07005131 final int size = ActivityManager.getLauncherLargeIconSizeInner(this);
Winson Chunga449dc02014-05-16 11:15:04 -07005132 final Bitmap icon = Bitmap.createScaledBitmap(taskDescription.getIcon(), size, size, true);
5133 td = new ActivityManager.TaskDescription(taskDescription.getLabel(), icon,
5134 taskDescription.getPrimaryColor());
5135 } else {
5136 td = taskDescription;
Craig Mautner2fbd7542014-03-21 09:34:07 -07005137 }
5138 try {
Winson Chunga449dc02014-05-16 11:15:04 -07005139 ActivityManagerNative.getDefault().setTaskDescription(mToken, td);
Craig Mautner2fbd7542014-03-21 09:34:07 -07005140 } catch (RemoteException e) {
5141 }
5142 }
5143
5144 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005145 * Sets the visibility of the progress bar in the title.
5146 * <p>
5147 * In order for the progress bar to be shown, the feature must be requested
5148 * via {@link #requestWindowFeature(int)}.
RoboErik55011652014-07-09 15:05:53 -07005149 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005150 * @param visible Whether to show the progress bars in the title.
5151 */
5152 public final void setProgressBarVisibility(boolean visible) {
5153 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, visible ? Window.PROGRESS_VISIBILITY_ON :
5154 Window.PROGRESS_VISIBILITY_OFF);
5155 }
5156
5157 /**
5158 * Sets the visibility of the indeterminate progress bar in the title.
5159 * <p>
5160 * In order for the progress bar to be shown, the feature must be requested
5161 * via {@link #requestWindowFeature(int)}.
5162 *
5163 * @param visible Whether to show the progress bars in the title.
5164 */
5165 public final void setProgressBarIndeterminateVisibility(boolean visible) {
5166 getWindow().setFeatureInt(Window.FEATURE_INDETERMINATE_PROGRESS,
5167 visible ? Window.PROGRESS_VISIBILITY_ON : Window.PROGRESS_VISIBILITY_OFF);
5168 }
RoboErik55011652014-07-09 15:05:53 -07005169
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005170 /**
5171 * Sets whether the horizontal progress bar in the title should be indeterminate (the circular
5172 * is always indeterminate).
5173 * <p>
5174 * In order for the progress bar to be shown, the feature must be requested
5175 * via {@link #requestWindowFeature(int)}.
RoboErik55011652014-07-09 15:05:53 -07005176 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005177 * @param indeterminate Whether the horizontal progress bar should be indeterminate.
5178 */
5179 public final void setProgressBarIndeterminate(boolean indeterminate) {
5180 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
George Mounte1803372014-02-26 19:00:52 +00005181 indeterminate ? Window.PROGRESS_INDETERMINATE_ON
5182 : Window.PROGRESS_INDETERMINATE_OFF);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005183 }
RoboErik55011652014-07-09 15:05:53 -07005184
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005185 /**
5186 * Sets the progress for the progress bars in the title.
5187 * <p>
5188 * In order for the progress bar to be shown, the feature must be requested
5189 * via {@link #requestWindowFeature(int)}.
RoboErik55011652014-07-09 15:05:53 -07005190 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005191 * @param progress The progress for the progress bar. Valid ranges are from
5192 * 0 to 10000 (both inclusive). If 10000 is given, the progress
5193 * bar will be completely filled and will fade out.
5194 */
5195 public final void setProgress(int progress) {
5196 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, progress + Window.PROGRESS_START);
5197 }
RoboErik55011652014-07-09 15:05:53 -07005198
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005199 /**
5200 * Sets the secondary progress for the progress bar in the title. This
5201 * progress is drawn between the primary progress (set via
5202 * {@link #setProgress(int)} and the background. It can be ideal for media
5203 * scenarios such as showing the buffering progress while the default
5204 * progress shows the play progress.
5205 * <p>
5206 * In order for the progress bar to be shown, the feature must be requested
5207 * via {@link #requestWindowFeature(int)}.
RoboErik55011652014-07-09 15:05:53 -07005208 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005209 * @param secondaryProgress The secondary progress for the progress bar. Valid ranges are from
5210 * 0 to 10000 (both inclusive).
5211 */
5212 public final void setSecondaryProgress(int secondaryProgress) {
5213 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
5214 secondaryProgress + Window.PROGRESS_SECONDARY_START);
5215 }
5216
5217 /**
5218 * Suggests an audio stream whose volume should be changed by the hardware
5219 * volume controls.
5220 * <p>
5221 * The suggested audio stream will be tied to the window of this Activity.
RoboErik55011652014-07-09 15:05:53 -07005222 * Volume requests which are received while the Activity is in the
5223 * foreground will affect this stream.
5224 * <p>
5225 * It is not guaranteed that the hardware volume controls will always change
5226 * this stream's volume (for example, if a call is in progress, its stream's
5227 * volume may be changed instead). To reset back to the default, use
5228 * {@link AudioManager#USE_DEFAULT_STREAM_TYPE}.
5229 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005230 * @param streamType The type of the audio stream whose volume should be
RoboErik55011652014-07-09 15:05:53 -07005231 * changed by the hardware volume controls.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005232 */
5233 public final void setVolumeControlStream(int streamType) {
5234 getWindow().setVolumeControlStream(streamType);
5235 }
5236
5237 /**
5238 * Gets the suggested audio stream whose volume should be changed by the
Tor Norbyed9273d62013-05-30 15:59:53 -07005239 * hardware volume controls.
RoboErik55011652014-07-09 15:05:53 -07005240 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005241 * @return The suggested audio stream type whose volume should be changed by
5242 * the hardware volume controls.
5243 * @see #setVolumeControlStream(int)
5244 */
5245 public final int getVolumeControlStream() {
5246 return getWindow().getVolumeControlStream();
5247 }
RoboErik55011652014-07-09 15:05:53 -07005248
5249 /**
5250 * Sets a {@link MediaController} to send media keys and volume changes to.
5251 * <p>
5252 * The controller will be tied to the window of this Activity. Media key and
5253 * volume events which are received while the Activity is in the foreground
5254 * will be forwarded to the controller and used to invoke transport controls
5255 * or adjust the volume. This may be used instead of or in addition to
5256 * {@link #setVolumeControlStream} to affect a specific session instead of a
5257 * specific stream.
5258 * <p>
5259 * It is not guaranteed that the hardware volume controls will always change
5260 * this session's volume (for example, if a call is in progress, its
5261 * stream's volume may be changed instead). To reset back to the default use
5262 * null as the controller.
5263 *
5264 * @param controller The controller for the session which should receive
5265 * media keys and volume changes.
5266 */
5267 public final void setMediaController(MediaController controller) {
5268 getWindow().setMediaController(controller);
5269 }
5270
5271 /**
5272 * Gets the controller which should be receiving media key and volume events
5273 * while this activity is in the foreground.
5274 *
5275 * @return The controller which should receive events.
5276 * @see #setMediaController(android.media.session.MediaController)
5277 */
5278 public final MediaController getMediaController() {
5279 return getWindow().getMediaController();
5280 }
5281
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005282 /**
5283 * Runs the specified action on the UI thread. If the current thread is the UI
5284 * thread, then the action is executed immediately. If the current thread is
5285 * not the UI thread, the action is posted to the event queue of the UI thread.
5286 *
5287 * @param action the action to run on the UI thread
5288 */
5289 public final void runOnUiThread(Runnable action) {
5290 if (Thread.currentThread() != mUiThread) {
5291 mHandler.post(action);
5292 } else {
5293 action.run();
5294 }
5295 }
5296
5297 /**
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07005298 * Standard implementation of
5299 * {@link android.view.LayoutInflater.Factory#onCreateView} used when
5300 * inflating with the LayoutInflater returned by {@link #getSystemService}.
Dianne Hackborn625ac272010-09-17 18:29:22 -07005301 * This implementation does nothing and is for
5302 * pre-{@link android.os.Build.VERSION_CODES#HONEYCOMB} apps. Newer apps
5303 * should use {@link #onCreateView(View, String, Context, AttributeSet)}.
5304 *
5305 * @see android.view.LayoutInflater#createView
5306 * @see android.view.Window#getLayoutInflater
5307 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005308 @Nullable
Dianne Hackborn625ac272010-09-17 18:29:22 -07005309 public View onCreateView(String name, Context context, AttributeSet attrs) {
5310 return null;
5311 }
5312
5313 /**
5314 * Standard implementation of
5315 * {@link android.view.LayoutInflater.Factory2#onCreateView(View, String, Context, AttributeSet)}
5316 * used when inflating with the LayoutInflater returned by {@link #getSystemService}.
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07005317 * This implementation handles <fragment> tags to embed fragments inside
5318 * of the activity.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005319 *
5320 * @see android.view.LayoutInflater#createView
5321 * @see android.view.Window#getLayoutInflater
5322 */
Dianne Hackborn625ac272010-09-17 18:29:22 -07005323 public View onCreateView(View parent, String name, Context context, AttributeSet attrs) {
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07005324 if (!"fragment".equals(name)) {
Dianne Hackborn625ac272010-09-17 18:29:22 -07005325 return onCreateView(name, context, attrs);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07005326 }
RoboErik55011652014-07-09 15:05:53 -07005327
Adam Powell371a8092014-06-20 12:51:12 -07005328 return mFragments.onCreateView(parent, name, context, attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005329 }
5330
Daniel Sandler69a48172010-06-23 16:29:36 -04005331 /**
Dianne Hackborn625ac272010-09-17 18:29:22 -07005332 * Print the Activity's state into the given stream. This gets invoked if
Jeff Sharkey5554b702012-04-11 18:30:51 -07005333 * you run "adb shell dumpsys activity &lt;activity_component_name&gt;".
Dianne Hackborn625ac272010-09-17 18:29:22 -07005334 *
Dianne Hackborn30d71892010-12-11 10:37:55 -08005335 * @param prefix Desired prefix to prepend at each line of output.
Dianne Hackborn625ac272010-09-17 18:29:22 -07005336 * @param fd The raw file descriptor that the dump is being sent to.
5337 * @param writer The PrintWriter to which you should dump your state. This will be
5338 * closed for you after you return.
5339 * @param args additional arguments to the dump request.
5340 */
Dianne Hackborn30d71892010-12-11 10:37:55 -08005341 public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) {
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07005342 dumpInner(prefix, fd, writer, args);
5343 }
5344
5345 void dumpInner(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) {
Dianne Hackborn30d71892010-12-11 10:37:55 -08005346 writer.print(prefix); writer.print("Local Activity ");
5347 writer.print(Integer.toHexString(System.identityHashCode(this)));
5348 writer.println(" State:");
5349 String innerPrefix = prefix + " ";
5350 writer.print(innerPrefix); writer.print("mResumed=");
5351 writer.print(mResumed); writer.print(" mStopped=");
5352 writer.print(mStopped); writer.print(" mFinished=");
5353 writer.println(mFinished);
5354 writer.print(innerPrefix); writer.print("mLoadersStarted=");
5355 writer.println(mLoadersStarted);
5356 writer.print(innerPrefix); writer.print("mChangingConfigurations=");
5357 writer.println(mChangingConfigurations);
5358 writer.print(innerPrefix); writer.print("mCurrentConfig=");
5359 writer.println(mCurrentConfig);
Jeff Brown5182c782013-10-15 20:31:52 -07005360
Dianne Hackborn30d71892010-12-11 10:37:55 -08005361 if (mLoaderManager != null) {
5362 writer.print(prefix); writer.print("Loader Manager ");
5363 writer.print(Integer.toHexString(System.identityHashCode(mLoaderManager)));
5364 writer.println(":");
5365 mLoaderManager.dump(prefix + " ", fd, writer, args);
5366 }
Dianne Hackborn4702a852012-08-17 15:18:29 -07005367
Jeff Brown5182c782013-10-15 20:31:52 -07005368 mFragments.dump(prefix, fd, writer, args);
5369
Michael Wright5f48dc72013-11-01 12:42:49 -07005370 if (getWindow() != null &&
5371 getWindow().peekDecorView() != null &&
5372 getWindow().peekDecorView().getViewRootImpl() != null) {
5373 getWindow().peekDecorView().getViewRootImpl().dump(prefix, fd, writer, args);
5374 }
Jeff Brown5182c782013-10-15 20:31:52 -07005375
5376 mHandler.getLooper().dump(new PrintWriterPrinter(writer), prefix);
Dianne Hackborn625ac272010-09-17 18:29:22 -07005377 }
5378
5379 /**
Daniel Sandler69a48172010-06-23 16:29:36 -04005380 * Bit indicating that this activity is "immersive" and should not be
5381 * interrupted by notifications if possible.
5382 *
5383 * This value is initially set by the manifest property
5384 * <code>android:immersive</code> but may be changed at runtime by
5385 * {@link #setImmersive}.
5386 *
Christopher Tate73c2aee2012-03-15 16:27:14 -07005387 * @see #setImmersive(boolean)
Daniel Sandler69a48172010-06-23 16:29:36 -04005388 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE
5389 */
5390 public boolean isImmersive() {
5391 try {
5392 return ActivityManagerNative.getDefault().isImmersive(mToken);
5393 } catch (RemoteException e) {
5394 return false;
5395 }
5396 }
5397
5398 /**
Craig Mautnerd61dc202014-07-07 11:09:11 -07005399 * Indication of whether this is the highest level activity in this task. Can be used to
5400 * determine whether an activity launched by this activity was placed in the same task or
5401 * another task.
5402 *
5403 * @return true if this is the topmost, non-finishing activity in its task.
Craig Mautnerd61dc202014-07-07 11:09:11 -07005404 */
George Mountff243282014-07-07 16:12:07 -07005405 private boolean isTopOfTask() {
Craig Mautnerd61dc202014-07-07 11:09:11 -07005406 try {
5407 return ActivityManagerNative.getDefault().isTopOfTask(mToken);
5408 } catch (RemoteException e) {
5409 return false;
5410 }
5411 }
5412
5413 /**
Craig Mautner4addfc52013-06-25 08:05:45 -07005414 * Convert a translucent themed Activity {@link android.R.attr#windowIsTranslucent} to a
5415 * fullscreen opaque Activity.
Craig Mautner5eda9b32013-07-02 11:58:16 -07005416 * <p>
Craig Mautner4addfc52013-06-25 08:05:45 -07005417 * Call this whenever the background of a translucent Activity has changed to become opaque.
Craig Mautner5eda9b32013-07-02 11:58:16 -07005418 * Doing so will allow the {@link android.view.Surface} of the Activity behind to be released.
5419 * <p>
Craig Mautner4addfc52013-06-25 08:05:45 -07005420 * This call has no effect on non-translucent activities or on activities with the
5421 * {@link android.R.attr#windowIsFloating} attribute.
Craig Mautner5eda9b32013-07-02 11:58:16 -07005422 *
George Mount62ab9b72014-05-02 13:51:17 -07005423 * @see #convertToTranslucent(android.app.Activity.TranslucentConversionListener,
5424 * ActivityOptions)
Craig Mautner5eda9b32013-07-02 11:58:16 -07005425 * @see TranslucentConversionListener
Chet Haaseabd3d772013-09-11 14:33:05 -07005426 *
5427 * @hide
Craig Mautner4addfc52013-06-25 08:05:45 -07005428 */
Jose Lima4b6c6692014-08-12 17:41:12 -07005429 @SystemApi
Craig Mautner5eda9b32013-07-02 11:58:16 -07005430 public void convertFromTranslucent() {
Craig Mautner4addfc52013-06-25 08:05:45 -07005431 try {
Craig Mautner5eda9b32013-07-02 11:58:16 -07005432 mTranslucentCallback = null;
Craig Mautnerbc57cd12013-08-19 15:47:42 -07005433 if (ActivityManagerNative.getDefault().convertFromTranslucent(mToken)) {
5434 WindowManagerGlobal.getInstance().changeCanvasOpacity(mToken, true);
5435 }
Craig Mautner4addfc52013-06-25 08:05:45 -07005436 } catch (RemoteException e) {
5437 // pass
5438 }
5439 }
5440
5441 /**
Craig Mautner5eda9b32013-07-02 11:58:16 -07005442 * Convert a translucent themed Activity {@link android.R.attr#windowIsTranslucent} back from
5443 * opaque to translucent following a call to {@link #convertFromTranslucent()}.
5444 * <p>
5445 * Calling this allows the Activity behind this one to be seen again. Once all such Activities
5446 * have been redrawn {@link TranslucentConversionListener#onTranslucentConversionComplete} will
5447 * be called indicating that it is safe to make this activity translucent again. Until
5448 * {@link TranslucentConversionListener#onTranslucentConversionComplete} is called the image
5449 * behind the frontmost Activity will be indeterminate.
5450 * <p>
5451 * This call has no effect on non-translucent activities or on activities with the
5452 * {@link android.R.attr#windowIsFloating} attribute.
5453 *
5454 * @param callback the method to call when all visible Activities behind this one have been
5455 * drawn and it is safe to make this Activity translucent again.
Craig Mautner233ceee2014-05-09 17:05:11 -07005456 * @param options activity options delivered to the activity below this one. The options
5457 * are retrieved using {@link #getActivityOptions}.
George Mount3cc716c2014-06-12 16:35:35 -07005458 * @return <code>true</code> if Window was opaque and will become translucent or
5459 * <code>false</code> if window was translucent and no change needed to be made.
Craig Mautner5eda9b32013-07-02 11:58:16 -07005460 *
5461 * @see #convertFromTranslucent()
5462 * @see TranslucentConversionListener
Chet Haaseabd3d772013-09-11 14:33:05 -07005463 *
5464 * @hide
Craig Mautner5eda9b32013-07-02 11:58:16 -07005465 */
Jose Lima4b6c6692014-08-12 17:41:12 -07005466 @SystemApi
George Mount3cc716c2014-06-12 16:35:35 -07005467 public boolean convertToTranslucent(TranslucentConversionListener callback,
Jose Lima5517ea72014-06-10 12:31:43 -07005468 ActivityOptions options) {
Craig Mautner233ceee2014-05-09 17:05:11 -07005469 boolean drawComplete;
Craig Mautner5eda9b32013-07-02 11:58:16 -07005470 try {
5471 mTranslucentCallback = callback;
Craig Mautnerbc57cd12013-08-19 15:47:42 -07005472 mChangeCanvasToTranslucent =
Craig Mautner233ceee2014-05-09 17:05:11 -07005473 ActivityManagerNative.getDefault().convertToTranslucent(mToken, options);
George Mount9e183972014-09-03 12:35:09 -07005474 WindowManagerGlobal.getInstance().changeCanvasOpacity(mToken, false);
Craig Mautner233ceee2014-05-09 17:05:11 -07005475 drawComplete = true;
Craig Mautner5eda9b32013-07-02 11:58:16 -07005476 } catch (RemoteException e) {
Craig Mautner233ceee2014-05-09 17:05:11 -07005477 // Make callback return as though it timed out.
5478 mChangeCanvasToTranslucent = false;
5479 drawComplete = false;
5480 }
5481 if (!mChangeCanvasToTranslucent && mTranslucentCallback != null) {
5482 // Window is already translucent.
5483 mTranslucentCallback.onTranslucentConversionComplete(drawComplete);
Craig Mautner5eda9b32013-07-02 11:58:16 -07005484 }
George Mount3cc716c2014-06-12 16:35:35 -07005485 return mChangeCanvasToTranslucent;
Craig Mautner5eda9b32013-07-02 11:58:16 -07005486 }
5487
5488 /** @hide */
5489 void onTranslucentConversionComplete(boolean drawComplete) {
5490 if (mTranslucentCallback != null) {
5491 mTranslucentCallback.onTranslucentConversionComplete(drawComplete);
5492 mTranslucentCallback = null;
5493 }
Craig Mautnerbc57cd12013-08-19 15:47:42 -07005494 if (mChangeCanvasToTranslucent) {
5495 WindowManagerGlobal.getInstance().changeCanvasOpacity(mToken, false);
5496 }
Craig Mautner5eda9b32013-07-02 11:58:16 -07005497 }
5498
Craig Mautnereb8abf72014-07-02 15:04:09 -07005499 /** @hide */
5500 public void onNewActivityOptions(ActivityOptions options) {
5501 mActivityTransitionState.setEnterActivityOptions(this, options);
5502 if (!mStopped) {
5503 mActivityTransitionState.enterReady(this);
5504 }
5505 }
5506
Craig Mautner5eda9b32013-07-02 11:58:16 -07005507 /**
Craig Mautner233ceee2014-05-09 17:05:11 -07005508 * Retrieve the ActivityOptions passed in from the launching activity or passed back
5509 * from an activity launched by this activity in its call to {@link
5510 * #convertToTranslucent(TranslucentConversionListener, ActivityOptions)}
5511 *
5512 * @return The ActivityOptions passed to {@link #convertToTranslucent}.
5513 * @hide
5514 */
5515 ActivityOptions getActivityOptions() {
5516 try {
5517 return ActivityManagerNative.getDefault().getActivityOptions(mToken);
5518 } catch (RemoteException e) {
5519 }
5520 return null;
5521 }
5522
5523 /**
Jose Lima4b6c6692014-08-12 17:41:12 -07005524 * Activities that want to remain visible behind a translucent activity above them must call
Craig Mautner64ccb702014-10-01 09:38:40 -07005525 * this method anytime between the start of {@link #onResume()} and the return from
5526 * {@link #onPause()}. If this call is successful then the activity will remain visible after
5527 * {@link #onPause()} is called, and is allowed to continue playing media in the background.
5528 *
5529 * <p>The actions of this call are reset each time that this activity is brought to the
5530 * front. That is, every time {@link #onResume()} is called the activity will be assumed
5531 * to not have requested visible behind. Therefore, if you want this activity to continue to
5532 * be visible in the background you must call this method again.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005533 *
5534 * <p>Only fullscreen opaque activities may make this call. I.e. this call is a nop
5535 * for dialog and translucent activities.
5536 *
Craig Mautner64ccb702014-10-01 09:38:40 -07005537 * <p>Under all circumstances, the activity must stop playing and release resources prior to or
5538 * within a call to {@link #onVisibleBehindCanceled()} or if this call returns false.
5539 *
5540 * <p>False will be returned any time this method is called between the return of onPause and
Craig Mautneree2e45a2014-06-27 12:10:03 -07005541 * the next call to onResume.
5542 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005543 * @param visible true to notify the system that the activity wishes to be visible behind other
5544 * translucent activities, false to indicate otherwise. Resources must be
5545 * released when passing false to this method.
Craig Mautner64ccb702014-10-01 09:38:40 -07005546 * @return the resulting visibiity state. If true the activity will remain visible beyond
5547 * {@link #onPause()} if the next activity is translucent or not fullscreen. If false
5548 * then the activity may not count on being visible behind other translucent activities,
5549 * and must stop any media playback and release resources.
5550 * Returning false may occur in lieu of a call to {@link #onVisibleBehindCanceled()} so
5551 * the return value must be checked.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005552 *
Jose Limafcf70832014-08-27 23:09:05 -07005553 * @see #onVisibleBehindCanceled()
Jose Lima4b6c6692014-08-12 17:41:12 -07005554 * @see #onBackgroundVisibleBehindChanged(boolean)
Craig Mautneree2e45a2014-06-27 12:10:03 -07005555 */
Jose Lima4b6c6692014-08-12 17:41:12 -07005556 public boolean requestVisibleBehind(boolean visible) {
Craig Mautneree2e45a2014-06-27 12:10:03 -07005557 if (!mResumed) {
Jose Lima4b6c6692014-08-12 17:41:12 -07005558 // Do not permit paused or stopped activities to do this.
5559 visible = false;
Craig Mautneree2e45a2014-06-27 12:10:03 -07005560 }
5561 try {
Jose Lima4b6c6692014-08-12 17:41:12 -07005562 mVisibleBehind = ActivityManagerNative.getDefault()
5563 .requestVisibleBehind(mToken, visible) && visible;
Craig Mautneree2e45a2014-06-27 12:10:03 -07005564 } catch (RemoteException e) {
Jose Lima4b6c6692014-08-12 17:41:12 -07005565 mVisibleBehind = false;
Craig Mautneree2e45a2014-06-27 12:10:03 -07005566 }
Jose Lima4b6c6692014-08-12 17:41:12 -07005567 return mVisibleBehind;
Craig Mautneree2e45a2014-06-27 12:10:03 -07005568 }
5569
5570 /**
Jose Lima4b6c6692014-08-12 17:41:12 -07005571 * Called when a translucent activity over this activity is becoming opaque or another
5572 * activity is being launched. Activities that override this method must call
Jose Limafcf70832014-08-27 23:09:05 -07005573 * <code>super.onVisibleBehindCanceled()</code> or a SuperNotCalledException will be thrown.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005574 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005575 * <p>When this method is called the activity has 500 msec to release any resources it may be
5576 * using while visible in the background.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005577 * If the activity has not returned from this method in 500 msec the system will destroy
Jose Lima4b6c6692014-08-12 17:41:12 -07005578 * the activity and kill the process in order to recover the resources for another
Craig Mautneree2e45a2014-06-27 12:10:03 -07005579 * process. Otherwise {@link #onStop()} will be called following return.
5580 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005581 * @see #requestVisibleBehind(boolean)
5582 * @see #onBackgroundVisibleBehindChanged(boolean)
Craig Mautneree2e45a2014-06-27 12:10:03 -07005583 */
Jose Limafcf70832014-08-27 23:09:05 -07005584 public void onVisibleBehindCanceled() {
Craig Mautneree2e45a2014-06-27 12:10:03 -07005585 mCalled = true;
5586 }
5587
5588 /**
Jose Lima4b6c6692014-08-12 17:41:12 -07005589 * Translucent activities may call this to determine if there is an activity below them that
5590 * is currently set to be visible in the background.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005591 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005592 * @return true if an activity below is set to visible according to the most recent call to
5593 * {@link #requestVisibleBehind(boolean)}, false otherwise.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005594 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005595 * @see #requestVisibleBehind(boolean)
Jose Limafcf70832014-08-27 23:09:05 -07005596 * @see #onVisibleBehindCanceled()
Jose Lima4b6c6692014-08-12 17:41:12 -07005597 * @see #onBackgroundVisibleBehindChanged(boolean)
Craig Mautneree2e45a2014-06-27 12:10:03 -07005598 * @hide
5599 */
Jose Lima4b6c6692014-08-12 17:41:12 -07005600 @SystemApi
5601 public boolean isBackgroundVisibleBehind() {
Craig Mautneree2e45a2014-06-27 12:10:03 -07005602 try {
Jose Lima4b6c6692014-08-12 17:41:12 -07005603 return ActivityManagerNative.getDefault().isBackgroundVisibleBehind(mToken);
Craig Mautneree2e45a2014-06-27 12:10:03 -07005604 } catch (RemoteException e) {
5605 }
5606 return false;
5607 }
5608
5609 /**
Jose Lima4b6c6692014-08-12 17:41:12 -07005610 * The topmost foreground activity will receive this call when the background visibility state
5611 * of the activity below it changes.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005612 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005613 * This call may be a consequence of {@link #requestVisibleBehind(boolean)} or might be
Craig Mautneree2e45a2014-06-27 12:10:03 -07005614 * due to a background activity finishing itself.
5615 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005616 * @param visible true if a background activity is visible, false otherwise.
Craig Mautneree2e45a2014-06-27 12:10:03 -07005617 *
Jose Lima4b6c6692014-08-12 17:41:12 -07005618 * @see #requestVisibleBehind(boolean)
Jose Limafcf70832014-08-27 23:09:05 -07005619 * @see #onVisibleBehindCanceled()
Jose Lima4b6c6692014-08-12 17:41:12 -07005620 * @hide
Craig Mautneree2e45a2014-06-27 12:10:03 -07005621 */
Jose Lima4b6c6692014-08-12 17:41:12 -07005622 @SystemApi
5623 public void onBackgroundVisibleBehindChanged(boolean visible) {
Craig Mautneree2e45a2014-06-27 12:10:03 -07005624 }
5625
5626 /**
Craig Mautner8746a472014-07-24 15:12:54 -07005627 * Activities cannot draw during the period that their windows are animating in. In order
5628 * to know when it is safe to begin drawing they can override this method which will be
5629 * called when the entering animation has completed.
5630 */
5631 public void onEnterAnimationComplete() {
5632 }
5633
5634 /**
Filip Gruszczynski6eafa902014-11-14 14:24:37 -08005635 * @hide
5636 */
5637 public void dispatchEnterAnimationComplete() {
5638 onEnterAnimationComplete();
5639 if (getWindow() != null && getWindow().getDecorView() != null) {
5640 getWindow().getDecorView().getViewTreeObserver().dispatchOnEnterAnimationComplete();
5641 }
5642 }
5643
5644 /**
Daniel Sandler69a48172010-06-23 16:29:36 -04005645 * Adjust the current immersive mode setting.
Christopher Tate73c2aee2012-03-15 16:27:14 -07005646 *
Daniel Sandler69a48172010-06-23 16:29:36 -04005647 * Note that changing this value will have no effect on the activity's
5648 * {@link android.content.pm.ActivityInfo} structure; that is, if
5649 * <code>android:immersive</code> is set to <code>true</code>
5650 * in the application's manifest entry for this activity, the {@link
5651 * android.content.pm.ActivityInfo#flags ActivityInfo.flags} member will
5652 * always have its {@link android.content.pm.ActivityInfo#FLAG_IMMERSIVE
5653 * FLAG_IMMERSIVE} bit set.
5654 *
Christopher Tate73c2aee2012-03-15 16:27:14 -07005655 * @see #isImmersive()
Daniel Sandler69a48172010-06-23 16:29:36 -04005656 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE
5657 */
5658 public void setImmersive(boolean i) {
5659 try {
5660 ActivityManagerNative.getDefault().setImmersive(mToken, i);
5661 } catch (RemoteException e) {
5662 // pass
5663 }
5664 }
5665
Adam Powell6e346362010-07-23 10:18:23 -07005666 /**
Adam Powelldebf3be2010-11-15 18:58:48 -08005667 * Start an action mode.
Adam Powell6e346362010-07-23 10:18:23 -07005668 *
5669 * @param callback Callback that will manage lifecycle events for this context mode
5670 * @return The ContextMode that was started, or null if it was canceled
5671 *
5672 * @see ActionMode
5673 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005674 @Nullable
Adam Powell5d279772010-07-27 16:34:07 -07005675 public ActionMode startActionMode(ActionMode.Callback callback) {
Adam Powell6e346362010-07-23 10:18:23 -07005676 return mWindow.getDecorView().startActionMode(callback);
5677 }
5678
Adam Powelldebf3be2010-11-15 18:58:48 -08005679 /**
5680 * Give the Activity a chance to control the UI for an action mode requested
5681 * by the system.
5682 *
5683 * <p>Note: If you are looking for a notification callback that an action mode
5684 * has been started for this activity, see {@link #onActionModeStarted(ActionMode)}.</p>
5685 *
5686 * @param callback The callback that should control the new action mode
5687 * @return The new action mode, or <code>null</code> if the activity does not want to
5688 * provide special handling for this action mode. (It will be handled by the system.)
5689 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005690 @Nullable
Craig Mautner5eda9b32013-07-02 11:58:16 -07005691 @Override
Adam Powelldebf3be2010-11-15 18:58:48 -08005692 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback) {
Adam Powelle43340c2014-03-17 19:10:43 -07005693 initWindowDecorActionBar();
Adam Powell6e346362010-07-23 10:18:23 -07005694 if (mActionBar != null) {
Adam Powell5d279772010-07-27 16:34:07 -07005695 return mActionBar.startActionMode(callback);
Adam Powell6e346362010-07-23 10:18:23 -07005696 }
5697 return null;
5698 }
5699
Adam Powelldebf3be2010-11-15 18:58:48 -08005700 /**
5701 * Notifies the Activity that an action mode has been started.
5702 * Activity subclasses overriding this method should call the superclass implementation.
5703 *
5704 * @param mode The new action mode.
5705 */
Craig Mautner5eda9b32013-07-02 11:58:16 -07005706 @Override
Adam Powelldebf3be2010-11-15 18:58:48 -08005707 public void onActionModeStarted(ActionMode mode) {
5708 }
5709
5710 /**
5711 * Notifies the activity that an action mode has finished.
5712 * Activity subclasses overriding this method should call the superclass implementation.
5713 *
5714 * @param mode The action mode that just finished.
5715 */
Craig Mautner5eda9b32013-07-02 11:58:16 -07005716 @Override
Adam Powelldebf3be2010-11-15 18:58:48 -08005717 public void onActionModeFinished(ActionMode mode) {
5718 }
5719
Adam Powelldd8fab22012-03-22 17:47:27 -07005720 /**
5721 * Returns true if the app should recreate the task when navigating 'up' from this activity
5722 * by using targetIntent.
5723 *
5724 * <p>If this method returns false the app can trivially call
5725 * {@link #navigateUpTo(Intent)} using the same parameters to correctly perform
5726 * up navigation. If this method returns false, the app should synthesize a new task stack
5727 * by using {@link TaskStackBuilder} or another similar mechanism to perform up navigation.</p>
5728 *
5729 * @param targetIntent An intent representing the target destination for up navigation
5730 * @return true if navigating up should recreate a new task stack, false if the same task
5731 * should be used for the destination
5732 */
5733 public boolean shouldUpRecreateTask(Intent targetIntent) {
5734 try {
5735 PackageManager pm = getPackageManager();
5736 ComponentName cn = targetIntent.getComponent();
5737 if (cn == null) {
5738 cn = targetIntent.resolveActivity(pm);
5739 }
5740 ActivityInfo info = pm.getActivityInfo(cn, 0);
5741 if (info.taskAffinity == null) {
5742 return false;
5743 }
Dianne Hackborn6f4d61f2014-08-21 17:50:42 -07005744 return ActivityManagerNative.getDefault()
5745 .shouldUpRecreateTask(mToken, info.taskAffinity);
Adam Powelldd8fab22012-03-22 17:47:27 -07005746 } catch (RemoteException e) {
5747 return false;
5748 } catch (NameNotFoundException e) {
5749 return false;
5750 }
5751 }
5752
5753 /**
5754 * Navigate from this activity to the activity specified by upIntent, finishing this activity
5755 * in the process. If the activity indicated by upIntent already exists in the task's history,
5756 * this activity and all others before the indicated activity in the history stack will be
Adam Powell35c064b2012-05-02 11:37:15 -07005757 * finished.
5758 *
5759 * <p>If the indicated activity does not appear in the history stack, this will finish
5760 * each activity in this task until the root activity of the task is reached, resulting in
5761 * an "in-app home" behavior. This can be useful in apps with a complex navigation hierarchy
5762 * when an activity may be reached by a path not passing through a canonical parent
5763 * activity.</p>
Adam Powelldd8fab22012-03-22 17:47:27 -07005764 *
5765 * <p>This method should be used when performing up navigation from within the same task
5766 * as the destination. If up navigation should cross tasks in some cases, see
5767 * {@link #shouldUpRecreateTask(Intent)}.</p>
5768 *
5769 * @param upIntent An intent representing the target destination for up navigation
5770 *
5771 * @return true if up navigation successfully reached the activity indicated by upIntent and
5772 * upIntent was delivered to it. false if an instance of the indicated activity could
5773 * not be found and this activity was simply finished normally.
5774 */
5775 public boolean navigateUpTo(Intent upIntent) {
5776 if (mParent == null) {
5777 ComponentName destInfo = upIntent.getComponent();
5778 if (destInfo == null) {
5779 destInfo = upIntent.resolveActivity(getPackageManager());
5780 if (destInfo == null) {
5781 return false;
5782 }
5783 upIntent = new Intent(upIntent);
5784 upIntent.setComponent(destInfo);
5785 }
5786 int resultCode;
5787 Intent resultData;
5788 synchronized (this) {
5789 resultCode = mResultCode;
5790 resultData = mResultData;
5791 }
5792 if (resultData != null) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07005793 resultData.prepareToLeaveProcess();
Adam Powelldd8fab22012-03-22 17:47:27 -07005794 }
5795 try {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07005796 upIntent.prepareToLeaveProcess();
Adam Powelldd8fab22012-03-22 17:47:27 -07005797 return ActivityManagerNative.getDefault().navigateUpTo(mToken, upIntent,
5798 resultCode, resultData);
5799 } catch (RemoteException e) {
5800 return false;
5801 }
5802 } else {
5803 return mParent.navigateUpToFromChild(this, upIntent);
5804 }
5805 }
5806
5807 /**
5808 * This is called when a child activity of this one calls its
5809 * {@link #navigateUpTo} method. The default implementation simply calls
5810 * navigateUpTo(upIntent) on this activity (the parent).
5811 *
5812 * @param child The activity making the call.
5813 * @param upIntent An intent representing the target destination for up navigation
5814 *
5815 * @return true if up navigation successfully reached the activity indicated by upIntent and
5816 * upIntent was delivered to it. false if an instance of the indicated activity could
5817 * not be found and this activity was simply finished normally.
5818 */
5819 public boolean navigateUpToFromChild(Activity child, Intent upIntent) {
5820 return navigateUpTo(upIntent);
5821 }
5822
5823 /**
5824 * Obtain an {@link Intent} that will launch an explicit target activity specified by
5825 * this activity's logical parent. The logical parent is named in the application's manifest
5826 * by the {@link android.R.attr#parentActivityName parentActivityName} attribute.
Adam Powell04d58112012-04-09 10:22:12 -07005827 * Activity subclasses may override this method to modify the Intent returned by
5828 * super.getParentActivityIntent() or to implement a different mechanism of retrieving
5829 * the parent intent entirely.
Adam Powelldd8fab22012-03-22 17:47:27 -07005830 *
Adam Powell04d58112012-04-09 10:22:12 -07005831 * @return a new Intent targeting the defined parent of this activity or null if
5832 * there is no valid parent.
Adam Powelldd8fab22012-03-22 17:47:27 -07005833 */
Tor Norbyed9273d62013-05-30 15:59:53 -07005834 @Nullable
Adam Powelldd8fab22012-03-22 17:47:27 -07005835 public Intent getParentActivityIntent() {
Adam Powell04d58112012-04-09 10:22:12 -07005836 final String parentName = mActivityInfo.parentActivityName;
5837 if (TextUtils.isEmpty(parentName)) {
5838 return null;
5839 }
Adam Powell5a4010c2012-09-16 15:14:05 -07005840
5841 // If the parent itself has no parent, generate a main activity intent.
5842 final ComponentName target = new ComponentName(this, parentName);
5843 try {
5844 final ActivityInfo parentInfo = getPackageManager().getActivityInfo(target, 0);
5845 final String parentActivity = parentInfo.parentActivityName;
5846 final Intent parentIntent = parentActivity == null
5847 ? Intent.makeMainActivity(target)
5848 : new Intent().setComponent(target);
5849 return parentIntent;
5850 } catch (NameNotFoundException e) {
5851 Log.e(TAG, "getParentActivityIntent: bad parentActivityName '" + parentName +
5852 "' in manifest");
5853 return null;
5854 }
Adam Powelldd8fab22012-03-22 17:47:27 -07005855 }
5856
George Mount31a21722014-03-24 17:44:36 -07005857 /**
George Mount62ab9b72014-05-02 13:51:17 -07005858 * When {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity,
George Mount65580562014-08-29 08:15:48 -07005859 * android.view.View, String)} was used to start an Activity, <var>callback</var>
George Mount800d72b2014-05-19 07:09:00 -07005860 * will be called to handle shared elements on the <i>launched</i> Activity. This requires
George Mount9826f632014-09-11 08:50:09 -07005861 * {@link Window#FEATURE_ACTIVITY_TRANSITIONS}.
George Mount31a21722014-03-24 17:44:36 -07005862 *
George Mount65580562014-08-29 08:15:48 -07005863 * @param callback Used to manipulate shared element transitions on the launched Activity.
George Mount31a21722014-03-24 17:44:36 -07005864 */
George Mount65580562014-08-29 08:15:48 -07005865 public void setEnterSharedElementCallback(SharedElementCallback callback) {
5866 if (callback == null) {
5867 callback = SharedElementCallback.NULL_CALLBACK;
George Mount31a21722014-03-24 17:44:36 -07005868 }
George Mount65580562014-08-29 08:15:48 -07005869 mEnterTransitionListener = callback;
George Mount800d72b2014-05-19 07:09:00 -07005870 }
5871
5872 /**
5873 * When {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity,
George Mount65580562014-08-29 08:15:48 -07005874 * android.view.View, String)} was used to start an Activity, <var>callback</var>
George Mount800d72b2014-05-19 07:09:00 -07005875 * will be called to handle shared elements on the <i>launching</i> Activity. Most
5876 * calls will only come when returning from the started Activity.
George Mount9826f632014-09-11 08:50:09 -07005877 * This requires {@link Window#FEATURE_ACTIVITY_TRANSITIONS}.
George Mount800d72b2014-05-19 07:09:00 -07005878 *
George Mount65580562014-08-29 08:15:48 -07005879 * @param callback Used to manipulate shared element transitions on the launching Activity.
George Mount800d72b2014-05-19 07:09:00 -07005880 */
George Mount65580562014-08-29 08:15:48 -07005881 public void setExitSharedElementCallback(SharedElementCallback callback) {
5882 if (callback == null) {
5883 callback = SharedElementCallback.NULL_CALLBACK;
George Mount800d72b2014-05-19 07:09:00 -07005884 }
George Mount65580562014-08-29 08:15:48 -07005885 mExitTransitionListener = callback;
George Mount31a21722014-03-24 17:44:36 -07005886 }
5887
George Mount8c2614c2014-06-10 11:12:01 -07005888 /**
5889 * Postpone the entering activity transition when Activity was started with
5890 * {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity,
5891 * android.util.Pair[])}.
5892 * <p>This method gives the Activity the ability to delay starting the entering and
5893 * shared element transitions until all data is loaded. Until then, the Activity won't
5894 * draw into its window, leaving the window transparent. This may also cause the
5895 * returning animation to be delayed until data is ready. This method should be
5896 * called in {@link #onCreate(android.os.Bundle)} or in
5897 * {@link #onActivityReenter(int, android.content.Intent)}.
5898 * {@link #startPostponedEnterTransition()} must be called to allow the Activity to
5899 * start the transitions. If the Activity did not use
5900 * {@link android.app.ActivityOptions#makeSceneTransitionAnimation(Activity,
5901 * android.util.Pair[])}, then this method does nothing.</p>
5902 */
5903 public void postponeEnterTransition() {
5904 mActivityTransitionState.postponeEnterTransition();
5905 }
5906
5907 /**
5908 * Begin postponed transitions after {@link #postponeEnterTransition()} was called.
5909 * If postponeEnterTransition() was called, you must call startPostponedEnterTransition()
5910 * to have your Activity start drawing.
5911 */
5912 public void startPostponedEnterTransition() {
5913 mActivityTransitionState.startPostponedEnterTransition();
5914 }
5915
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005916 // ------------------ Internal API ------------------
RoboErik55011652014-07-09 15:05:53 -07005917
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005918 final void setParent(Activity parent) {
5919 mParent = parent;
5920 }
5921
Dianne Hackbornb06ea702009-07-13 13:07:51 -07005922 final void attach(Context context, ActivityThread aThread,
5923 Instrumentation instr, IBinder token, int ident,
5924 Application application, Intent intent, ActivityInfo info,
5925 CharSequence title, Activity parent, String id,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07005926 NonConfigurationInstances lastNonConfigurationInstances,
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005927 Configuration config, String referrer, IVoiceInteractor voiceInteractor) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005928 attachBaseContext(context);
5929
Dianne Hackborn62bea2f2012-09-04 18:48:15 -07005930 mFragments.attachActivity(this, mContainer, null);
RoboErik55011652014-07-09 15:05:53 -07005931
Jorim Jaggib10e33f2015-02-04 21:57:40 +01005932 mWindow = new PhoneWindow(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005933 mWindow.setCallback(this);
Adam Powell117b6952014-05-05 18:14:56 -07005934 mWindow.setOnWindowDismissedCallback(this);
Dianne Hackborn420829e2011-01-28 11:30:35 -08005935 mWindow.getLayoutInflater().setPrivateFactory(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005936 if (info.softInputMode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
5937 mWindow.setSoftInputMode(info.softInputMode);
5938 }
Adam Powell269248d2011-08-02 10:26:54 -07005939 if (info.uiOptions != 0) {
5940 mWindow.setUiOptions(info.uiOptions);
5941 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005942 mUiThread = Thread.currentThread();
George Mount0a778ed2013-12-13 13:35:36 -08005943
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005944 mMainThread = aThread;
5945 mInstrumentation = instr;
5946 mToken = token;
Dianne Hackbornb06ea702009-07-13 13:07:51 -07005947 mIdent = ident;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005948 mApplication = application;
5949 mIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005950 mReferrer = referrer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005951 mComponent = intent.getComponent();
5952 mActivityInfo = info;
5953 mTitle = title;
5954 mParent = parent;
5955 mEmbeddedID = id;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07005956 mLastNonConfigurationInstances = lastNonConfigurationInstances;
Dianne Hackborn20d94742014-05-29 18:35:45 -07005957 if (voiceInteractor != null) {
5958 if (lastNonConfigurationInstances != null) {
5959 mVoiceInteractor = lastNonConfigurationInstances.voiceInteractor;
5960 } else {
5961 mVoiceInteractor = new VoiceInteractor(voiceInteractor, this, this,
5962 Looper.myLooper());
5963 }
5964 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005965
Jeff Brown98365d72012-08-19 20:30:52 -07005966 mWindow.setWindowManager(
5967 (WindowManager)context.getSystemService(Context.WINDOW_SERVICE),
5968 mToken, mComponent.flattenToString(),
Romain Guy529b60a2010-08-03 18:05:47 -07005969 (info.flags & ActivityInfo.FLAG_HARDWARE_ACCELERATED) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005970 if (mParent != null) {
5971 mWindow.setContainer(mParent.getWindow());
5972 }
5973 mWindowManager = mWindow.getWindowManager();
5974 mCurrentConfig = config;
5975 }
5976
Dianne Hackborn5320eb82012-05-18 12:05:04 -07005977 /** @hide */
5978 public final IBinder getActivityToken() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005979 return mParent != null ? mParent.getActivityToken() : mToken;
5980 }
5981
Craig Mautnera0026042014-04-23 11:45:37 -07005982 final void performCreateCommon() {
Dianne Hackborn30c9bd82010-12-01 16:07:40 -08005983 mVisibleFromClient = !mWindow.getWindowStyle().getBoolean(
5984 com.android.internal.R.styleable.Window_windowNoDisplay, false);
Dianne Hackbornc8017682010-07-06 13:34:38 -07005985 mFragments.dispatchActivityCreated();
George Mount62ab9b72014-05-02 13:51:17 -07005986 mActivityTransitionState.setEnterActivityOptions(this, getActivityOptions());
Dianne Hackborn2dedce62010-04-15 14:45:25 -07005987 }
George Mount0a778ed2013-12-13 13:35:36 -08005988
Craig Mautnera0026042014-04-23 11:45:37 -07005989 final void performCreate(Bundle icicle) {
5990 onCreate(icicle);
George Mount62ab9b72014-05-02 13:51:17 -07005991 mActivityTransitionState.readState(icicle);
Craig Mautnera0026042014-04-23 11:45:37 -07005992 performCreateCommon();
5993 }
5994
5995 final void performCreate(Bundle icicle, PersistableBundle persistentState) {
5996 onCreate(icicle, persistentState);
George Mount62ab9b72014-05-02 13:51:17 -07005997 mActivityTransitionState.readState(icicle);
Craig Mautnera0026042014-04-23 11:45:37 -07005998 performCreateCommon();
5999 }
6000
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006001 final void performStart() {
George Mount62ab9b72014-05-02 13:51:17 -07006002 mActivityTransitionState.setEnterActivityOptions(this, getActivityOptions());
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07006003 mFragments.noteStateNotSaved();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006004 mCalled = false;
Dianne Hackborn445646c2010-06-25 15:52:59 -07006005 mFragments.execPendingActions();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006006 mInstrumentation.callActivityOnStart(this);
6007 if (!mCalled) {
6008 throw new SuperNotCalledException(
6009 "Activity " + mComponent.toShortString() +
6010 " did not call through to super.onStart()");
6011 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07006012 mFragments.dispatchStart();
Dianne Hackborn2707d602010-07-09 18:01:20 -07006013 if (mAllLoaderManagers != null) {
Dianne Hackborn3e82ba12013-07-16 13:23:55 -07006014 final int N = mAllLoaderManagers.size();
6015 LoaderManagerImpl loaders[] = new LoaderManagerImpl[N];
6016 for (int i=N-1; i>=0; i--) {
6017 loaders[i] = mAllLoaderManagers.valueAt(i);
6018 }
6019 for (int i=0; i<N; i++) {
6020 LoaderManagerImpl lm = loaders[i];
6021 lm.finishRetain();
6022 lm.doReportStart();
Dianne Hackborn2707d602010-07-09 18:01:20 -07006023 }
6024 }
George Mount62ab9b72014-05-02 13:51:17 -07006025 mActivityTransitionState.enterReady(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006026 }
RoboErik55011652014-07-09 15:05:53 -07006027
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006028 final void performRestart() {
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07006029 mFragments.noteStateNotSaved();
Dianne Hackborna21e3da2010-09-12 19:27:46 -07006030
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006031 if (mStopped) {
6032 mStopped = false;
Dianne Hackbornce418e62011-03-01 14:31:38 -08006033 if (mToken != null && mParent == null) {
Jeff Brown98365d72012-08-19 20:30:52 -07006034 WindowManagerGlobal.getInstance().setStoppedState(mToken, false);
Dianne Hackbornce418e62011-03-01 14:31:38 -08006035 }
Dianne Hackborn185e3e22011-06-03 15:26:01 -07006036
6037 synchronized (mManagedCursors) {
6038 final int N = mManagedCursors.size();
6039 for (int i=0; i<N; i++) {
6040 ManagedCursor mc = mManagedCursors.get(i);
6041 if (mc.mReleased || mc.mUpdated) {
6042 if (!mc.mCursor.requery()) {
Dianne Hackborna5445d32011-09-01 14:38:24 -07006043 if (getApplicationInfo().targetSdkVersion
6044 >= android.os.Build.VERSION_CODES.ICE_CREAM_SANDWICH) {
6045 throw new IllegalStateException(
6046 "trying to requery an already closed cursor "
6047 + mc.mCursor);
6048 }
Dianne Hackborn185e3e22011-06-03 15:26:01 -07006049 }
6050 mc.mReleased = false;
6051 mc.mUpdated = false;
6052 }
6053 }
6054 }
6055
6056 mCalled = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006057 mInstrumentation.callActivityOnRestart(this);
6058 if (!mCalled) {
6059 throw new SuperNotCalledException(
6060 "Activity " + mComponent.toShortString() +
6061 " did not call through to super.onRestart()");
6062 }
6063 performStart();
6064 }
6065 }
RoboErik55011652014-07-09 15:05:53 -07006066
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006067 final void performResume() {
6068 performRestart();
RoboErik55011652014-07-09 15:05:53 -07006069
Dianne Hackborn445646c2010-06-25 15:52:59 -07006070 mFragments.execPendingActions();
RoboErik55011652014-07-09 15:05:53 -07006071
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07006072 mLastNonConfigurationInstances = null;
RoboErik55011652014-07-09 15:05:53 -07006073
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006074 mCalled = false;
Jeff Hamilton52d32032011-01-08 15:31:26 -06006075 // mResumed is set by the instrumentation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006076 mInstrumentation.callActivityOnResume(this);
6077 if (!mCalled) {
6078 throw new SuperNotCalledException(
6079 "Activity " + mComponent.toShortString() +
6080 " did not call through to super.onResume()");
6081 }
6082
Todd Kennedyee8c9c62014-12-10 14:22:59 -08006083 // invisible activities must be finished before onResume() completes
6084 if (!mVisibleFromClient && !mFinished) {
6085 Log.w(TAG, "An activity without a UI must call finish() before onResume() completes");
6086 if (getApplicationInfo().targetSdkVersion
6087 > android.os.Build.VERSION_CODES.LOLLIPOP_MR1) {
6088 throw new IllegalStateException(
6089 "Activity " + mComponent.toShortString() +
6090 " did not call finish() prior to onResume() completing");
6091 }
6092 }
6093
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006094 // Now really resume, and install the current status bar and menu.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006095 mCalled = false;
RoboErik55011652014-07-09 15:05:53 -07006096
Dianne Hackborn2dedce62010-04-15 14:45:25 -07006097 mFragments.dispatchResume();
Dianne Hackborn445646c2010-06-25 15:52:59 -07006098 mFragments.execPendingActions();
RoboErik55011652014-07-09 15:05:53 -07006099
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006100 onPostResume();
6101 if (!mCalled) {
6102 throw new SuperNotCalledException(
6103 "Activity " + mComponent.toShortString() +
6104 " did not call through to super.onPostResume()");
6105 }
6106 }
6107
6108 final void performPause() {
Dianne Hackborn2286cdc2013-07-01 19:10:06 -07006109 mDoReportFullyDrawn = false;
Dianne Hackborn2dedce62010-04-15 14:45:25 -07006110 mFragments.dispatchPause();
Dianne Hackborne794e9f2010-08-24 12:32:10 -07006111 mCalled = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006112 onPause();
Dianne Hackborn4eba96b2011-01-21 13:34:36 -08006113 mResumed = false;
Dianne Hackborne794e9f2010-08-24 12:32:10 -07006114 if (!mCalled && getApplicationInfo().targetSdkVersion
6115 >= android.os.Build.VERSION_CODES.GINGERBREAD) {
6116 throw new SuperNotCalledException(
6117 "Activity " + mComponent.toShortString() +
6118 " did not call through to super.onPause()");
6119 }
Jeff Hamilton52d32032011-01-08 15:31:26 -06006120 mResumed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006121 }
RoboErik55011652014-07-09 15:05:53 -07006122
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006123 final void performUserLeaving() {
6124 onUserInteraction();
6125 onUserLeaveHint();
6126 }
RoboErik55011652014-07-09 15:05:53 -07006127
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006128 final void performStop() {
Dianne Hackborn2286cdc2013-07-01 19:10:06 -07006129 mDoReportFullyDrawn = false;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07006130 if (mLoadersStarted) {
6131 mLoadersStarted = false;
Dianne Hackborn2707d602010-07-09 18:01:20 -07006132 if (mLoaderManager != null) {
6133 if (!mChangingConfigurations) {
6134 mLoaderManager.doStop();
6135 } else {
6136 mLoaderManager.doRetain();
6137 }
6138 }
6139 }
RoboErik55011652014-07-09 15:05:53 -07006140
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006141 if (!mStopped) {
6142 if (mWindow != null) {
6143 mWindow.closeAllPanels();
6144 }
6145
Dianne Hackbornce418e62011-03-01 14:31:38 -08006146 if (mToken != null && mParent == null) {
Jeff Brown98365d72012-08-19 20:30:52 -07006147 WindowManagerGlobal.getInstance().setStoppedState(mToken, true);
Dianne Hackbornce418e62011-03-01 14:31:38 -08006148 }
RoboErik55011652014-07-09 15:05:53 -07006149
Dianne Hackborn2dedce62010-04-15 14:45:25 -07006150 mFragments.dispatchStop();
RoboErik55011652014-07-09 15:05:53 -07006151
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006152 mCalled = false;
6153 mInstrumentation.callActivityOnStop(this);
6154 if (!mCalled) {
6155 throw new SuperNotCalledException(
6156 "Activity " + mComponent.toShortString() +
6157 " did not call through to super.onStop()");
6158 }
RoboErik55011652014-07-09 15:05:53 -07006159
Makoto Onuki2f6a0182010-02-22 13:26:59 -08006160 synchronized (mManagedCursors) {
6161 final int N = mManagedCursors.size();
6162 for (int i=0; i<N; i++) {
6163 ManagedCursor mc = mManagedCursors.get(i);
6164 if (!mc.mReleased) {
6165 mc.mCursor.deactivate();
6166 mc.mReleased = true;
6167 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006168 }
6169 }
George Mount0a778ed2013-12-13 13:35:36 -08006170
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006171 mStopped = true;
6172 }
6173 mResumed = false;
6174 }
6175
Dianne Hackborn2dedce62010-04-15 14:45:25 -07006176 final void performDestroy() {
Dianne Hackborn6d9dcbc2012-10-02 17:51:13 -07006177 mDestroyed = true;
Dianne Hackborn291905e2010-08-17 15:17:15 -07006178 mWindow.destroy();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07006179 mFragments.dispatchDestroy();
6180 onDestroy();
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07006181 if (mLoaderManager != null) {
6182 mLoaderManager.doDestroy();
6183 }
Dianne Hackborn20d94742014-05-29 18:35:45 -07006184 if (mVoiceInteractor != null) {
6185 mVoiceInteractor.detachActivity();
6186 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07006187 }
George Mount0a778ed2013-12-13 13:35:36 -08006188
6189 /**
Jeff Hamilton52d32032011-01-08 15:31:26 -06006190 * @hide
6191 */
6192 public final boolean isResumed() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006193 return mResumed;
6194 }
6195
George Mount0a778ed2013-12-13 13:35:36 -08006196 void dispatchActivityResult(String who, int requestCode,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006197 int resultCode, Intent data) {
Joe Onorato43a17652011-04-06 19:22:23 -07006198 if (false) Log.v(
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006199 TAG, "Dispatching result: who=" + who + ", reqCode=" + requestCode
6200 + ", resCode=" + resultCode + ", data=" + data);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07006201 mFragments.noteStateNotSaved();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006202 if (who == null) {
6203 onActivityResult(requestCode, resultCode, data);
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07006204 } else {
6205 Fragment frag = mFragments.findFragmentByWho(who);
6206 if (frag != null) {
6207 frag.onActivityResult(requestCode, resultCode, data);
6208 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006209 }
6210 }
Craig Mautner5eda9b32013-07-02 11:58:16 -07006211
Jason Monka57e5e02014-05-07 10:06:48 -04006212 /**
Jason Monk62515be2014-05-21 16:06:19 -04006213 * Request to put this Activity in a mode where the user is locked to the
Jason Monka57e5e02014-05-07 10:06:48 -04006214 * current task.
6215 *
6216 * This will prevent the user from launching other apps, going to settings,
6217 * or reaching the home screen.
6218 *
Jason Monk62515be2014-05-21 16:06:19 -04006219 * If {@link DevicePolicyManager#isLockTaskPermitted(String)} returns true
6220 * for this component then the app will go directly into Lock Task mode. The user
6221 * will not be able to exit this mode until {@link Activity#stopLockTask()} is called.
6222 *
6223 * If {@link DevicePolicyManager#isLockTaskPermitted(String)} returns false
6224 * then the system will prompt the user with a dialog requesting permission to enter
Jason Monk8863b572014-07-29 13:49:32 -04006225 * this mode. When entered through this method the user can exit at any time through
6226 * an action described by the request dialog. Calling stopLockTask will also exit the
6227 * mode.
Jason Monka57e5e02014-05-07 10:06:48 -04006228 */
Craig Mautneraea74a52014-03-08 14:23:10 -08006229 public void startLockTask() {
6230 try {
6231 ActivityManagerNative.getDefault().startLockTaskMode(mToken);
6232 } catch (RemoteException e) {
6233 }
6234 }
6235
Jason Monka57e5e02014-05-07 10:06:48 -04006236 /**
6237 * Allow the user to switch away from the current task.
6238 *
6239 * Called to end the mode started by {@link Activity#startLockTask}. This
6240 * can only be called by activities that have successfully called
6241 * startLockTask previously.
6242 *
6243 * This will allow the user to exit this app and move onto other activities.
6244 */
Craig Mautneraea74a52014-03-08 14:23:10 -08006245 public void stopLockTask() {
6246 try {
6247 ActivityManagerNative.getDefault().stopLockTaskMode();
6248 } catch (RemoteException e) {
6249 }
6250 }
6251
Craig Mautner5eda9b32013-07-02 11:58:16 -07006252 /**
6253 * Interface for informing a translucent {@link Activity} once all visible activities below it
6254 * have completed drawing. This is necessary only after an {@link Activity} has been made
6255 * opaque using {@link Activity#convertFromTranslucent()} and before it has been drawn
6256 * translucent again following a call to {@link
George Mount800d72b2014-05-19 07:09:00 -07006257 * Activity#convertToTranslucent(android.app.Activity.TranslucentConversionListener,
6258 * ActivityOptions)}
Chet Haaseabd3d772013-09-11 14:33:05 -07006259 *
6260 * @hide
Craig Mautner5eda9b32013-07-02 11:58:16 -07006261 */
Jose Lima14914852014-08-14 09:14:12 -07006262 @SystemApi
Craig Mautner5eda9b32013-07-02 11:58:16 -07006263 public interface TranslucentConversionListener {
6264 /**
6265 * Callback made following {@link Activity#convertToTranslucent} once all visible Activities
6266 * below the top one have been redrawn. Following this callback it is safe to make the top
6267 * Activity translucent because the underlying Activity has been drawn.
6268 *
6269 * @param drawComplete True if the background Activity has drawn itself. False if a timeout
6270 * occurred waiting for the Activity to complete drawing.
6271 *
6272 * @see Activity#convertFromTranslucent()
Craig Mautner233ceee2014-05-09 17:05:11 -07006273 * @see Activity#convertToTranslucent(TranslucentConversionListener, ActivityOptions)
Craig Mautner5eda9b32013-07-02 11:58:16 -07006274 */
6275 public void onTranslucentConversionComplete(boolean drawComplete);
6276 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006277}