blob: 4a144a2355b4d0e8eff2c4e07c710e146b58f379 [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
Adam Powell6e346362010-07-23 10:18:23 -070019import com.android.internal.app.ActionBarImpl;
20import com.android.internal.policy.PolicyManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070021
Dianne Hackbornc68c9132011-07-29 01:25:18 -070022import android.content.ComponentCallbacks2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080023import android.content.ComponentName;
24import android.content.ContentResolver;
25import android.content.Context;
Jason parks6ed50de2010-08-25 10:18:50 -050026import android.content.CursorLoader;
Suchi Amalapurapu1ccac752009-06-12 10:09:58 -070027import android.content.IIntentSender;
Adam Powell33b97432010-04-20 10:01:14 -070028import android.content.Intent;
Dianne Hackbornfa82f222009-09-17 15:14:12 -070029import android.content.IntentSender;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.content.SharedPreferences;
31import android.content.pm.ActivityInfo;
32import android.content.res.Configuration;
33import android.content.res.Resources;
Dianne Hackbornba51c3d2010-05-05 18:49:48 -070034import android.content.res.TypedArray;
Adam Powell88ab6972011-07-28 11:25:01 -070035import android.content.res.Resources.Theme;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080036import android.database.Cursor;
37import android.graphics.Bitmap;
38import android.graphics.Canvas;
39import android.graphics.drawable.Drawable;
40import android.media.AudioManager;
41import android.net.Uri;
Dianne Hackborn8d374262009-09-14 21:21:52 -070042import android.os.Build;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080044import android.os.Handler;
45import android.os.IBinder;
Dianne Hackborn30c9bd82010-12-01 16:07:40 -080046import android.os.Looper;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070047import android.os.Parcelable;
svetoslavganov75986cf2009-05-14 22:28:01 -070048import android.os.RemoteException;
Brad Fitzpatrick75803572011-01-13 14:21:03 -080049import android.os.StrictMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050import android.text.Selection;
51import android.text.SpannableStringBuilder;
svetoslavganov75986cf2009-05-14 22:28:01 -070052import android.text.TextUtils;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080053import android.text.method.TextKeyListener;
54import android.util.AttributeSet;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080055import android.util.EventLog;
56import android.util.Log;
57import android.util.SparseArray;
Adam Powell88ab6972011-07-28 11:25:01 -070058import android.util.TypedValue;
Adam Powell6e346362010-07-23 10:18:23 -070059import android.view.ActionMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080060import android.view.ContextMenu;
Adam Powell6e346362010-07-23 10:18:23 -070061import android.view.ContextMenu.ContextMenuInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080062import android.view.ContextThemeWrapper;
63import android.view.KeyEvent;
64import android.view.LayoutInflater;
65import android.view.Menu;
66import android.view.MenuInflater;
67import android.view.MenuItem;
68import android.view.MotionEvent;
69import android.view.View;
Dianne Hackbornce418e62011-03-01 14:31:38 -080070import android.view.WindowManagerImpl;
Adam Powell6e346362010-07-23 10:18:23 -070071import android.view.View.OnCreateContextMenuListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080072import android.view.ViewGroup;
Adam Powell6e346362010-07-23 10:18:23 -070073import android.view.ViewGroup.LayoutParams;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074import android.view.ViewManager;
75import android.view.Window;
76import android.view.WindowManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070077import android.view.accessibility.AccessibilityEvent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080078import android.widget.AdapterView;
79
Dianne Hackborn625ac272010-09-17 18:29:22 -070080import java.io.FileDescriptor;
81import java.io.PrintWriter;
Adam Powell6e346362010-07-23 10:18:23 -070082import java.util.ArrayList;
83import java.util.HashMap;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080084
85/**
86 * An activity is a single, focused thing that the user can do. Almost all
87 * activities interact with the user, so the Activity class takes care of
88 * creating a window for you in which you can place your UI with
89 * {@link #setContentView}. While activities are often presented to the user
90 * as full-screen windows, they can also be used in other ways: as floating
91 * windows (via a theme with {@link android.R.attr#windowIsFloating} set)
92 * or embedded inside of another activity (using {@link ActivityGroup}).
93 *
94 * There are two methods almost all subclasses of Activity will implement:
95 *
96 * <ul>
97 * <li> {@link #onCreate} is where you initialize your activity. Most
98 * importantly, here you will usually call {@link #setContentView(int)}
99 * with a layout resource defining your UI, and using {@link #findViewById}
100 * to retrieve the widgets in that UI that you need to interact with
101 * programmatically.
102 *
103 * <li> {@link #onPause} is where you deal with the user leaving your
104 * activity. Most importantly, any changes made by the user should at this
105 * point be committed (usually to the
106 * {@link android.content.ContentProvider} holding the data).
107 * </ul>
108 *
109 * <p>To be of use with {@link android.content.Context#startActivity Context.startActivity()}, all
110 * activity classes must have a corresponding
111 * {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
112 * declaration in their package's <code>AndroidManifest.xml</code>.</p>
113 *
114 * <p>The Activity class is an important part of an application's overall lifecycle,
115 * and the way activities are launched and put together is a fundamental
Scott Main7aee61f2011-02-08 11:25:01 -0800116 * part of the platform's application model. For a detailed perspective on the structure of an
117 * Android application and how activities behave, please read the
118 * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a> and
119 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back Stack</a>
120 * documents.</p>
121 *
122 * <p>You can also find a detailed discussion about how to create activities in the
123 * <a href="{@docRoot}guide/topics/fundamentals/activities.html">Activities</a>
124 * document.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800125 *
126 * <p>Topics covered here:
127 * <ol>
Dianne Hackborn291905e2010-08-17 15:17:15 -0700128 * <li><a href="#Fragments">Fragments</a>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800129 * <li><a href="#ActivityLifecycle">Activity Lifecycle</a>
130 * <li><a href="#ConfigurationChanges">Configuration Changes</a>
131 * <li><a href="#StartingActivities">Starting Activities and Getting Results</a>
132 * <li><a href="#SavingPersistentState">Saving Persistent State</a>
133 * <li><a href="#Permissions">Permissions</a>
134 * <li><a href="#ProcessLifecycle">Process Lifecycle</a>
135 * </ol>
136 *
Dianne Hackborn291905e2010-08-17 15:17:15 -0700137 * <a name="Fragments"></a>
138 * <h3>Fragments</h3>
139 *
140 * <p>Starting with {@link android.os.Build.VERSION_CODES#HONEYCOMB}, Activity
141 * implementations can make use of the {@link Fragment} class to better
142 * modularize their code, build more sophisticated user interfaces for larger
143 * screens, and help scale their application between small and large screens.
144 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800145 * <a name="ActivityLifecycle"></a>
146 * <h3>Activity Lifecycle</h3>
147 *
148 * <p>Activities in the system are managed as an <em>activity stack</em>.
149 * When a new activity is started, it is placed on the top of the stack
150 * and becomes the running activity -- the previous activity always remains
151 * below it in the stack, and will not come to the foreground again until
152 * the new activity exits.</p>
153 *
154 * <p>An activity has essentially four states:</p>
155 * <ul>
156 * <li> If an activity in the foreground of the screen (at the top of
157 * the stack),
158 * it is <em>active</em> or <em>running</em>. </li>
159 * <li>If an activity has lost focus but is still visible (that is, a new non-full-sized
160 * or transparent activity has focus on top of your activity), it
161 * is <em>paused</em>. A paused activity is completely alive (it
162 * maintains all state and member information and remains attached to
163 * the window manager), but can be killed by the system in extreme
164 * low memory situations.
165 * <li>If an activity is completely obscured by another activity,
166 * it is <em>stopped</em>. It still retains all state and member information,
167 * however, it is no longer visible to the user so its window is hidden
168 * and it will often be killed by the system when memory is needed
169 * elsewhere.</li>
170 * <li>If an activity is paused or stopped, the system can drop the activity
171 * from memory by either asking it to finish, or simply killing its
172 * process. When it is displayed again to the user, it must be
173 * completely restarted and restored to its previous state.</li>
174 * </ul>
175 *
176 * <p>The following diagram shows the important state paths of an Activity.
177 * The square rectangles represent callback methods you can implement to
178 * perform operations when the Activity moves between states. The colored
179 * ovals are major states the Activity can be in.</p>
180 *
181 * <p><img src="../../../images/activity_lifecycle.png"
182 * alt="State diagram for an Android Activity Lifecycle." border="0" /></p>
183 *
184 * <p>There are three key loops you may be interested in monitoring within your
185 * activity:
186 *
187 * <ul>
188 * <li>The <b>entire lifetime</b> of an activity happens between the first call
189 * to {@link android.app.Activity#onCreate} through to a single final call
190 * to {@link android.app.Activity#onDestroy}. An activity will do all setup
191 * of "global" state in onCreate(), and release all remaining resources in
192 * onDestroy(). For example, if it has a thread running in the background
193 * to download data from the network, it may create that thread in onCreate()
194 * and then stop the thread in onDestroy().
195 *
196 * <li>The <b>visible lifetime</b> of an activity happens between a call to
197 * {@link android.app.Activity#onStart} until a corresponding call to
198 * {@link android.app.Activity#onStop}. During this time the user can see the
199 * activity on-screen, though it may not be in the foreground and interacting
200 * with the user. Between these two methods you can maintain resources that
201 * are needed to show the activity to the user. For example, you can register
202 * a {@link android.content.BroadcastReceiver} in onStart() to monitor for changes
203 * that impact your UI, and unregister it in onStop() when the user an no
204 * longer see what you are displaying. The onStart() and onStop() methods
205 * can be called multiple times, as the activity becomes visible and hidden
206 * to the user.
207 *
208 * <li>The <b>foreground lifetime</b> of an activity happens between a call to
209 * {@link android.app.Activity#onResume} until a corresponding call to
210 * {@link android.app.Activity#onPause}. During this time the activity is
211 * in front of all other activities and interacting with the user. An activity
212 * can frequently go between the resumed and paused states -- for example when
213 * the device goes to sleep, when an activity result is delivered, when a new
214 * intent is delivered -- so the code in these methods should be fairly
215 * lightweight.
216 * </ul>
217 *
218 * <p>The entire lifecycle of an activity is defined by the following
219 * Activity methods. All of these are hooks that you can override
220 * to do appropriate work when the activity changes state. All
221 * activities will implement {@link android.app.Activity#onCreate}
222 * to do their initial setup; many will also implement
223 * {@link android.app.Activity#onPause} to commit changes to data and
224 * otherwise prepare to stop interacting with the user. You should always
225 * call up to your superclass when implementing these methods.</p>
226 *
227 * </p>
228 * <pre class="prettyprint">
229 * public class Activity extends ApplicationContext {
230 * protected void onCreate(Bundle savedInstanceState);
231 *
232 * protected void onStart();
233 *
234 * protected void onRestart();
235 *
236 * protected void onResume();
237 *
238 * protected void onPause();
239 *
240 * protected void onStop();
241 *
242 * protected void onDestroy();
243 * }
244 * </pre>
245 *
246 * <p>In general the movement through an activity's lifecycle looks like
247 * this:</p>
248 *
249 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
250 * <colgroup align="left" span="3" />
251 * <colgroup align="left" />
252 * <colgroup align="center" />
253 * <colgroup align="center" />
254 *
255 * <thead>
256 * <tr><th colspan="3">Method</th> <th>Description</th> <th>Killable?</th> <th>Next</th></tr>
257 * </thead>
258 *
259 * <tbody>
260 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onCreate onCreate()}</th>
261 * <td>Called when the activity is first created.
262 * This is where you should do all of your normal static set up:
263 * create views, bind data to lists, etc. This method also
264 * provides you with a Bundle containing the activity's previously
265 * frozen state, if there was one.
266 * <p>Always followed by <code>onStart()</code>.</td>
267 * <td align="center">No</td>
268 * <td align="center"><code>onStart()</code></td>
269 * </tr>
270 *
271 * <tr><td rowspan="5" style="border-left: none; border-right: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
272 * <th colspan="2" align="left" border="0">{@link android.app.Activity#onRestart onRestart()}</th>
273 * <td>Called after your activity has been stopped, prior to it being
274 * started again.
275 * <p>Always followed by <code>onStart()</code></td>
276 * <td align="center">No</td>
277 * <td align="center"><code>onStart()</code></td>
278 * </tr>
279 *
280 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStart onStart()}</th>
281 * <td>Called when the activity is becoming visible to the user.
282 * <p>Followed by <code>onResume()</code> if the activity comes
283 * to the foreground, or <code>onStop()</code> if it becomes hidden.</td>
284 * <td align="center">No</td>
285 * <td align="center"><code>onResume()</code> or <code>onStop()</code></td>
286 * </tr>
287 *
288 * <tr><td rowspan="2" style="border-left: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
289 * <th align="left" border="0">{@link android.app.Activity#onResume onResume()}</th>
290 * <td>Called when the activity will start
291 * interacting with the user. At this point your activity is at
292 * the top of the activity stack, with user input going to it.
293 * <p>Always followed by <code>onPause()</code>.</td>
294 * <td align="center">No</td>
295 * <td align="center"><code>onPause()</code></td>
296 * </tr>
297 *
298 * <tr><th align="left" border="0">{@link android.app.Activity#onPause onPause()}</th>
299 * <td>Called when the system is about to start resuming a previous
300 * activity. This is typically used to commit unsaved changes to
301 * persistent data, stop animations and other things that may be consuming
302 * CPU, etc. Implementations of this method must be very quick because
303 * the next activity will not be resumed until this method returns.
304 * <p>Followed by either <code>onResume()</code> if the activity
305 * returns back to the front, or <code>onStop()</code> if it becomes
306 * invisible to the user.</td>
Dianne Hackborn0aae2d42010-12-07 23:51:29 -0800307 * <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 -0800308 * <td align="center"><code>onResume()</code> or<br>
309 * <code>onStop()</code></td>
310 * </tr>
311 *
312 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStop onStop()}</th>
313 * <td>Called when the activity is no longer visible to the user, because
314 * another activity has been resumed and is covering this one. This
315 * may happen either because a new activity is being started, an existing
316 * one is being brought in front of this one, or this one is being
317 * destroyed.
318 * <p>Followed by either <code>onRestart()</code> if
319 * this activity is coming back to interact with the user, or
320 * <code>onDestroy()</code> if this activity is going away.</td>
321 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
322 * <td align="center"><code>onRestart()</code> or<br>
323 * <code>onDestroy()</code></td>
324 * </tr>
325 *
326 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onDestroy onDestroy()}</th>
327 * <td>The final call you receive before your
328 * activity is destroyed. This can happen either because the
329 * activity is finishing (someone called {@link Activity#finish} on
330 * it, or because the system is temporarily destroying this
331 * instance of the activity to save space. You can distinguish
332 * between these two scenarios with the {@link
333 * Activity#isFinishing} method.</td>
334 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
335 * <td align="center"><em>nothing</em></td>
336 * </tr>
337 * </tbody>
338 * </table>
339 *
340 * <p>Note the "Killable" column in the above table -- for those methods that
341 * are marked as being killable, after that method returns the process hosting the
342 * activity may killed by the system <em>at any time</em> without another line
343 * of its code being executed. Because of this, you should use the
344 * {@link #onPause} method to write any persistent data (such as user edits)
345 * to storage. In addition, the method
346 * {@link #onSaveInstanceState(Bundle)} is called before placing the activity
347 * in such a background state, allowing you to save away any dynamic instance
348 * state in your activity into the given Bundle, to be later received in
349 * {@link #onCreate} if the activity needs to be re-created.
350 * See the <a href="#ProcessLifecycle">Process Lifecycle</a>
351 * section for more information on how the lifecycle of a process is tied
352 * to the activities it is hosting. Note that it is important to save
353 * persistent data in {@link #onPause} instead of {@link #onSaveInstanceState}
Daisuke Miyakawa5c40f3f2011-02-15 13:24:36 -0800354 * because the latter is not part of the lifecycle callbacks, so will not
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800355 * be called in every situation as described in its documentation.</p>
356 *
Dianne Hackborn0aae2d42010-12-07 23:51:29 -0800357 * <p class="note">Be aware that these semantics will change slightly between
358 * applications targeting platforms starting with {@link android.os.Build.VERSION_CODES#HONEYCOMB}
359 * vs. those targeting prior platforms. Starting with Honeycomb, an application
360 * is not in the killable state until its {@link #onStop} has returned. This
361 * impacts when {@link #onSaveInstanceState(Bundle)} may be called (it may be
362 * safely called after {@link #onPause()} and allows and application to safely
363 * wait until {@link #onStop()} to save persistent state.</p>
364 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800365 * <p>For those methods that are not marked as being killable, the activity's
366 * process will not be killed by the system starting from the time the method
367 * is called and continuing after it returns. Thus an activity is in the killable
368 * state, for example, between after <code>onPause()</code> to the start of
369 * <code>onResume()</code>.</p>
370 *
371 * <a name="ConfigurationChanges"></a>
372 * <h3>Configuration Changes</h3>
373 *
374 * <p>If the configuration of the device (as defined by the
375 * {@link Configuration Resources.Configuration} class) changes,
376 * then anything displaying a user interface will need to update to match that
377 * configuration. Because Activity is the primary mechanism for interacting
378 * with the user, it includes special support for handling configuration
379 * changes.</p>
380 *
381 * <p>Unless you specify otherwise, a configuration change (such as a change
382 * in screen orientation, language, input devices, etc) will cause your
383 * current activity to be <em>destroyed</em>, going through the normal activity
384 * lifecycle process of {@link #onPause},
385 * {@link #onStop}, and {@link #onDestroy} as appropriate. If the activity
386 * had been in the foreground or visible to the user, once {@link #onDestroy} is
387 * called in that instance then a new instance of the activity will be
388 * created, with whatever savedInstanceState the previous instance had generated
389 * from {@link #onSaveInstanceState}.</p>
390 *
391 * <p>This is done because any application resource,
392 * including layout files, can change based on any configuration value. Thus
393 * the only safe way to handle a configuration change is to re-retrieve all
394 * resources, including layouts, drawables, and strings. Because activities
395 * must already know how to save their state and re-create themselves from
396 * that state, this is a convenient way to have an activity restart itself
397 * with a new configuration.</p>
398 *
399 * <p>In some special cases, you may want to bypass restarting of your
400 * activity based on one or more types of configuration changes. This is
401 * done with the {@link android.R.attr#configChanges android:configChanges}
402 * attribute in its manifest. For any types of configuration changes you say
403 * that you handle there, you will receive a call to your current activity's
404 * {@link #onConfigurationChanged} method instead of being restarted. If
405 * a configuration change involves any that you do not handle, however, the
406 * activity will still be restarted and {@link #onConfigurationChanged}
407 * will not be called.</p>
408 *
409 * <a name="StartingActivities"></a>
410 * <h3>Starting Activities and Getting Results</h3>
411 *
412 * <p>The {@link android.app.Activity#startActivity}
413 * method is used to start a
414 * new activity, which will be placed at the top of the activity stack. It
415 * takes a single argument, an {@link android.content.Intent Intent},
416 * which describes the activity
417 * to be executed.</p>
418 *
419 * <p>Sometimes you want to get a result back from an activity when it
420 * ends. For example, you may start an activity that lets the user pick
421 * a person in a list of contacts; when it ends, it returns the person
422 * that was selected. To do this, you call the
423 * {@link android.app.Activity#startActivityForResult(Intent, int)}
424 * version with a second integer parameter identifying the call. The result
425 * will come back through your {@link android.app.Activity#onActivityResult}
426 * method.</p>
427 *
428 * <p>When an activity exits, it can call
429 * {@link android.app.Activity#setResult(int)}
430 * to return data back to its parent. It must always supply a result code,
431 * which can be the standard results RESULT_CANCELED, RESULT_OK, or any
432 * custom values starting at RESULT_FIRST_USER. In addition, it can optionally
433 * return back an Intent containing any additional data it wants. All of this
434 * information appears back on the
435 * parent's <code>Activity.onActivityResult()</code>, along with the integer
436 * identifier it originally supplied.</p>
437 *
438 * <p>If a child activity fails for any reason (such as crashing), the parent
439 * activity will receive a result with the code RESULT_CANCELED.</p>
440 *
441 * <pre class="prettyprint">
442 * public class MyActivity extends Activity {
443 * ...
444 *
445 * static final int PICK_CONTACT_REQUEST = 0;
446 *
447 * protected boolean onKeyDown(int keyCode, KeyEvent event) {
448 * if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) {
449 * // When the user center presses, let them pick a contact.
450 * startActivityForResult(
451 * new Intent(Intent.ACTION_PICK,
452 * new Uri("content://contacts")),
453 * PICK_CONTACT_REQUEST);
454 * return true;
455 * }
456 * return false;
457 * }
458 *
459 * protected void onActivityResult(int requestCode, int resultCode,
460 * Intent data) {
461 * if (requestCode == PICK_CONTACT_REQUEST) {
462 * if (resultCode == RESULT_OK) {
463 * // A contact was picked. Here we will just display it
464 * // to the user.
465 * startActivity(new Intent(Intent.ACTION_VIEW, data));
466 * }
467 * }
468 * }
469 * }
470 * </pre>
471 *
472 * <a name="SavingPersistentState"></a>
473 * <h3>Saving Persistent State</h3>
474 *
475 * <p>There are generally two kinds of persistent state than an activity
476 * will deal with: shared document-like data (typically stored in a SQLite
477 * database using a {@linkplain android.content.ContentProvider content provider})
478 * and internal state such as user preferences.</p>
479 *
480 * <p>For content provider data, we suggest that activities use a
481 * "edit in place" user model. That is, any edits a user makes are effectively
482 * made immediately without requiring an additional confirmation step.
483 * Supporting this model is generally a simple matter of following two rules:</p>
484 *
485 * <ul>
486 * <li> <p>When creating a new document, the backing database entry or file for
487 * it is created immediately. For example, if the user chooses to write
488 * a new e-mail, a new entry for that e-mail is created as soon as they
489 * start entering data, so that if they go to any other activity after
490 * that point this e-mail will now appear in the list of drafts.</p>
491 * <li> <p>When an activity's <code>onPause()</code> method is called, it should
492 * commit to the backing content provider or file any changes the user
493 * has made. This ensures that those changes will be seen by any other
494 * activity that is about to run. You will probably want to commit
495 * your data even more aggressively at key times during your
496 * activity's lifecycle: for example before starting a new
497 * activity, before finishing your own activity, when the user
498 * switches between input fields, etc.</p>
499 * </ul>
500 *
501 * <p>This model is designed to prevent data loss when a user is navigating
502 * between activities, and allows the system to safely kill an activity (because
503 * system resources are needed somewhere else) at any time after it has been
504 * paused. Note this implies
505 * that the user pressing BACK from your activity does <em>not</em>
506 * mean "cancel" -- it means to leave the activity with its current contents
Dianne Hackborn0aae2d42010-12-07 23:51:29 -0800507 * saved away. Canceling edits in an activity must be provided through
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800508 * some other mechanism, such as an explicit "revert" or "undo" option.</p>
509 *
510 * <p>See the {@linkplain android.content.ContentProvider content package} for
511 * more information about content providers. These are a key aspect of how
512 * different activities invoke and propagate data between themselves.</p>
513 *
514 * <p>The Activity class also provides an API for managing internal persistent state
515 * associated with an activity. This can be used, for example, to remember
516 * the user's preferred initial display in a calendar (day view or week view)
517 * or the user's default home page in a web browser.</p>
518 *
519 * <p>Activity persistent state is managed
520 * with the method {@link #getPreferences},
521 * allowing you to retrieve and
522 * modify a set of name/value pairs associated with the activity. To use
523 * preferences that are shared across multiple application components
524 * (activities, receivers, services, providers), you can use the underlying
525 * {@link Context#getSharedPreferences Context.getSharedPreferences()} method
526 * to retrieve a preferences
527 * object stored under a specific name.
528 * (Note that it is not possible to share settings data across application
529 * packages -- for that you will need a content provider.)</p>
530 *
531 * <p>Here is an excerpt from a calendar activity that stores the user's
532 * preferred view mode in its persistent settings:</p>
533 *
534 * <pre class="prettyprint">
535 * public class CalendarActivity extends Activity {
536 * ...
537 *
538 * static final int DAY_VIEW_MODE = 0;
539 * static final int WEEK_VIEW_MODE = 1;
540 *
541 * private SharedPreferences mPrefs;
542 * private int mCurViewMode;
543 *
544 * protected void onCreate(Bundle savedInstanceState) {
545 * super.onCreate(savedInstanceState);
546 *
547 * SharedPreferences mPrefs = getSharedPreferences();
548 * mCurViewMode = mPrefs.getInt("view_mode" DAY_VIEW_MODE);
549 * }
550 *
551 * protected void onPause() {
552 * super.onPause();
553 *
554 * SharedPreferences.Editor ed = mPrefs.edit();
555 * ed.putInt("view_mode", mCurViewMode);
556 * ed.commit();
557 * }
558 * }
559 * </pre>
560 *
561 * <a name="Permissions"></a>
562 * <h3>Permissions</h3>
563 *
564 * <p>The ability to start a particular Activity can be enforced when it is
565 * declared in its
566 * manifest's {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
567 * tag. By doing so, other applications will need to declare a corresponding
568 * {@link android.R.styleable#AndroidManifestUsesPermission &lt;uses-permission&gt;}
569 * element in their own manifest to be able to start that activity.
570 *
571 * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a>
572 * document for more information on permissions and security in general.
573 *
574 * <a name="ProcessLifecycle"></a>
575 * <h3>Process Lifecycle</h3>
576 *
577 * <p>The Android system attempts to keep application process around for as
578 * long as possible, but eventually will need to remove old processes when
579 * memory runs low. As described in <a href="#ActivityLifecycle">Activity
580 * Lifecycle</a>, the decision about which process to remove is intimately
581 * tied to the state of the user's interaction with it. In general, there
582 * are four states a process can be in based on the activities running in it,
583 * listed here in order of importance. The system will kill less important
584 * processes (the last ones) before it resorts to killing more important
585 * processes (the first ones).
586 *
587 * <ol>
588 * <li> <p>The <b>foreground activity</b> (the activity at the top of the screen
589 * that the user is currently interacting with) is considered the most important.
590 * Its process will only be killed as a last resort, if it uses more memory
591 * than is available on the device. Generally at this point the device has
592 * reached a memory paging state, so this is required in order to keep the user
593 * interface responsive.
594 * <li> <p>A <b>visible activity</b> (an activity that is visible to the user
595 * but not in the foreground, such as one sitting behind a foreground dialog)
596 * is considered extremely important and will not be killed unless that is
597 * required to keep the foreground activity running.
598 * <li> <p>A <b>background activity</b> (an activity that is not visible to
599 * the user and has been paused) is no longer critical, so the system may
600 * safely kill its process to reclaim memory for other foreground or
601 * visible processes. If its process needs to be killed, when the user navigates
602 * back to the activity (making it visible on the screen again), its
603 * {@link #onCreate} method will be called with the savedInstanceState it had previously
604 * supplied in {@link #onSaveInstanceState} so that it can restart itself in the same
605 * state as the user last left it.
606 * <li> <p>An <b>empty process</b> is one hosting no activities or other
607 * application components (such as {@link Service} or
608 * {@link android.content.BroadcastReceiver} classes). These are killed very
609 * quickly by the system as memory becomes low. For this reason, any
610 * background operation you do outside of an activity must be executed in the
611 * context of an activity BroadcastReceiver or Service to ensure that the system
612 * knows it needs to keep your process around.
613 * </ol>
614 *
615 * <p>Sometimes an Activity may need to do a long-running operation that exists
616 * independently of the activity lifecycle itself. An example may be a camera
617 * application that allows you to upload a picture to a web site. The upload
618 * may take a long time, and the application should allow the user to leave
619 * the application will it is executing. To accomplish this, your Activity
620 * should start a {@link Service} in which the upload takes place. This allows
621 * the system to properly prioritize your process (considering it to be more
622 * important than other non-visible applications) for the duration of the
623 * upload, independent of whether the original activity is paused, stopped,
624 * or finished.
625 */
626public class Activity extends ContextThemeWrapper
Dianne Hackborn625ac272010-09-17 18:29:22 -0700627 implements LayoutInflater.Factory2,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800628 Window.Callback, KeyEvent.Callback,
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700629 OnCreateContextMenuListener, ComponentCallbacks2 {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800630 private static final String TAG = "Activity";
631
632 /** Standard activity result: operation canceled. */
633 public static final int RESULT_CANCELED = 0;
634 /** Standard activity result: operation succeeded. */
635 public static final int RESULT_OK = -1;
636 /** Start of user-defined activity results. */
637 public static final int RESULT_FIRST_USER = 1;
638
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800639 private static final String WINDOW_HIERARCHY_TAG = "android:viewHierarchyState";
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700640 private static final String FRAGMENTS_TAG = "android:fragments";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800641 private static final String SAVED_DIALOG_IDS_KEY = "android:savedDialogIds";
642 private static final String SAVED_DIALOGS_TAG = "android:savedDialogs";
643 private static final String SAVED_DIALOG_KEY_PREFIX = "android:dialog_";
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800644 private static final String SAVED_DIALOG_ARGS_KEY_PREFIX = "android:dialog_args_";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800645
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800646 private static class ManagedDialog {
647 Dialog mDialog;
648 Bundle mArgs;
649 }
650 private SparseArray<ManagedDialog> mManagedDialogs;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800651
652 // set by the thread after the constructor and before onCreate(Bundle savedInstanceState) is called.
653 private Instrumentation mInstrumentation;
654 private IBinder mToken;
Dianne Hackbornb06ea702009-07-13 13:07:51 -0700655 private int mIdent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800656 /*package*/ String mEmbeddedID;
657 private Application mApplication;
Christopher Tateb70f3df2009-04-07 16:07:59 -0700658 /*package*/ Intent mIntent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800659 private ComponentName mComponent;
660 /*package*/ ActivityInfo mActivityInfo;
661 /*package*/ ActivityThread mMainThread;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800662 Activity mParent;
663 boolean mCalled;
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700664 boolean mCheckedForLoaderManager;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700665 boolean mLoadersStarted;
Jeff Hamilton52d32032011-01-08 15:31:26 -0600666 /*package*/ boolean mResumed;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800667 private boolean mStopped;
668 boolean mFinished;
669 boolean mStartedActivity;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700670 /** true if the activity is going through a transient pause */
671 /*package*/ boolean mTemporaryPause = false;
Jeff Hamilton3d32f6e2010-04-01 00:04:16 -0500672 /** true if the activity is being destroyed in order to recreate it with a new configuration */
673 /*package*/ boolean mChangingConfigurations = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800674 /*package*/ int mConfigChangeFlags;
675 /*package*/ Configuration mCurrentConfig;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +0100676 private SearchManager mSearchManager;
Adam Powell88ab6972011-07-28 11:25:01 -0700677 private MenuInflater mMenuInflater;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800678
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700679 static final class NonConfigurationInstances {
680 Object activity;
681 HashMap<String, Object> children;
682 ArrayList<Fragment> fragments;
Dianne Hackborn4911b782010-07-15 12:54:39 -0700683 SparseArray<LoaderManagerImpl> loaders;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700684 }
685 /* package */ NonConfigurationInstances mLastNonConfigurationInstances;
686
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800687 private Window mWindow;
688
689 private WindowManager mWindowManager;
690 /*package*/ View mDecor = null;
691 /*package*/ boolean mWindowAdded = false;
692 /*package*/ boolean mVisibleFromServer = false;
693 /*package*/ boolean mVisibleFromClient = true;
Adam Powellac695c62010-07-20 18:19:27 -0700694 /*package*/ ActionBarImpl mActionBar = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800695
696 private CharSequence mTitle;
697 private int mTitleColor = 0;
698
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700699 final FragmentManagerImpl mFragments = new FragmentManagerImpl();
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700700
Dianne Hackborn4911b782010-07-15 12:54:39 -0700701 SparseArray<LoaderManagerImpl> mAllLoaderManagers;
702 LoaderManagerImpl mLoaderManager;
Dianne Hackbornc8017682010-07-06 13:34:38 -0700703
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800704 private static final class ManagedCursor {
705 ManagedCursor(Cursor cursor) {
706 mCursor = cursor;
707 mReleased = false;
708 mUpdated = false;
709 }
710
711 private final Cursor mCursor;
712 private boolean mReleased;
713 private boolean mUpdated;
714 }
715 private final ArrayList<ManagedCursor> mManagedCursors =
716 new ArrayList<ManagedCursor>();
717
718 // protected by synchronized (this)
719 int mResultCode = RESULT_CANCELED;
720 Intent mResultData = null;
721
722 private boolean mTitleReady = false;
723
724 private int mDefaultKeyMode = DEFAULT_KEYS_DISABLE;
725 private SpannableStringBuilder mDefaultKeySsb = null;
726
727 protected static final int[] FOCUSED_STATE_SET = {com.android.internal.R.attr.state_focused};
728
Jeff Brown7e442832011-06-10 18:00:16 -0700729 private final Object mInstanceTracker = StrictMode.trackActivity(this);
730
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800731 private Thread mUiThread;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700732 final Handler mHandler = new Handler();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800733
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800734 /** Return the intent that started this activity. */
735 public Intent getIntent() {
736 return mIntent;
737 }
738
739 /**
740 * Change the intent returned by {@link #getIntent}. This holds a
741 * reference to the given intent; it does not copy it. Often used in
742 * conjunction with {@link #onNewIntent}.
743 *
744 * @param newIntent The new Intent object to return from getIntent
745 *
746 * @see #getIntent
747 * @see #onNewIntent
748 */
749 public void setIntent(Intent newIntent) {
750 mIntent = newIntent;
751 }
752
753 /** Return the application that owns this activity. */
754 public final Application getApplication() {
755 return mApplication;
756 }
757
758 /** Is this activity embedded inside of another activity? */
759 public final boolean isChild() {
760 return mParent != null;
761 }
762
763 /** Return the parent activity if this view is an embedded child. */
764 public final Activity getParent() {
765 return mParent;
766 }
767
768 /** Retrieve the window manager for showing custom windows. */
769 public WindowManager getWindowManager() {
770 return mWindowManager;
771 }
772
773 /**
774 * Retrieve the current {@link android.view.Window} for the activity.
775 * This can be used to directly access parts of the Window API that
776 * are not available through Activity/Screen.
777 *
778 * @return Window The current window, or null if the activity is not
779 * visual.
780 */
781 public Window getWindow() {
782 return mWindow;
783 }
784
785 /**
Dianne Hackbornc8017682010-07-06 13:34:38 -0700786 * Return the LoaderManager for this fragment, creating it if needed.
787 */
788 public LoaderManager getLoaderManager() {
789 if (mLoaderManager != null) {
790 return mLoaderManager;
791 }
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700792 mCheckedForLoaderManager = true;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700793 mLoaderManager = getLoaderManager(-1, mLoadersStarted, true);
Dianne Hackbornc8017682010-07-06 13:34:38 -0700794 return mLoaderManager;
795 }
796
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700797 LoaderManagerImpl getLoaderManager(int index, boolean started, boolean create) {
Dianne Hackbornc8017682010-07-06 13:34:38 -0700798 if (mAllLoaderManagers == null) {
Dianne Hackborn4911b782010-07-15 12:54:39 -0700799 mAllLoaderManagers = new SparseArray<LoaderManagerImpl>();
Dianne Hackbornc8017682010-07-06 13:34:38 -0700800 }
Dianne Hackborn4911b782010-07-15 12:54:39 -0700801 LoaderManagerImpl lm = mAllLoaderManagers.get(index);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700802 if (lm == null) {
803 if (create) {
804 lm = new LoaderManagerImpl(this, started);
805 mAllLoaderManagers.put(index, lm);
806 }
807 } else {
808 lm.updateActivity(this);
Dianne Hackbornc8017682010-07-06 13:34:38 -0700809 }
810 return lm;
811 }
812
813 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800814 * Calls {@link android.view.Window#getCurrentFocus} on the
815 * Window of this Activity to return the currently focused view.
816 *
817 * @return View The current View with focus or null.
818 *
819 * @see #getWindow
820 * @see android.view.Window#getCurrentFocus
821 */
822 public View getCurrentFocus() {
823 return mWindow != null ? mWindow.getCurrentFocus() : null;
824 }
825
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800826 /**
827 * Called when the activity is starting. This is where most initialization
828 * should go: calling {@link #setContentView(int)} to inflate the
829 * activity's UI, using {@link #findViewById} to programmatically interact
830 * with widgets in the UI, calling
831 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)} to retrieve
832 * cursors for data being displayed, etc.
833 *
834 * <p>You can call {@link #finish} from within this function, in
835 * which case onDestroy() will be immediately called without any of the rest
836 * of the activity lifecycle ({@link #onStart}, {@link #onResume},
837 * {@link #onPause}, etc) executing.
838 *
839 * <p><em>Derived classes must call through to the super class's
840 * implementation of this method. If they do not, an exception will be
841 * thrown.</em></p>
842 *
843 * @param savedInstanceState If the activity is being re-initialized after
844 * previously being shut down then this Bundle contains the data it most
845 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
846 *
847 * @see #onStart
848 * @see #onSaveInstanceState
849 * @see #onRestoreInstanceState
850 * @see #onPostCreate
851 */
852 protected void onCreate(Bundle savedInstanceState) {
Dianne Hackborn2707d602010-07-09 18:01:20 -0700853 if (mLastNonConfigurationInstances != null) {
854 mAllLoaderManagers = mLastNonConfigurationInstances.loaders;
855 }
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700856 if (savedInstanceState != null) {
857 Parcelable p = savedInstanceState.getParcelable(FRAGMENTS_TAG);
858 mFragments.restoreAllState(p, mLastNonConfigurationInstances != null
859 ? mLastNonConfigurationInstances.fragments : null);
860 }
861 mFragments.dispatchCreate();
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700862 getApplication().dispatchActivityCreated(this, savedInstanceState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800863 mCalled = true;
864 }
865
866 /**
867 * The hook for {@link ActivityThread} to restore the state of this activity.
868 *
869 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and
870 * {@link #restoreManagedDialogs(android.os.Bundle)}.
871 *
872 * @param savedInstanceState contains the saved state
873 */
874 final void performRestoreInstanceState(Bundle savedInstanceState) {
875 onRestoreInstanceState(savedInstanceState);
876 restoreManagedDialogs(savedInstanceState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800877 }
878
879 /**
880 * This method is called after {@link #onStart} when the activity is
881 * being re-initialized from a previously saved state, given here in
Mike LeBeau305de9d2010-03-11 09:21:08 -0800882 * <var>savedInstanceState</var>. Most implementations will simply use {@link #onCreate}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800883 * to restore their state, but it is sometimes convenient to do it here
884 * after all of the initialization has been done or to allow subclasses to
885 * decide whether to use your default implementation. The default
886 * implementation of this method performs a restore of any view state that
887 * had previously been frozen by {@link #onSaveInstanceState}.
888 *
889 * <p>This method is called between {@link #onStart} and
890 * {@link #onPostCreate}.
891 *
892 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}.
893 *
894 * @see #onCreate
895 * @see #onPostCreate
896 * @see #onResume
897 * @see #onSaveInstanceState
898 */
899 protected void onRestoreInstanceState(Bundle savedInstanceState) {
900 if (mWindow != null) {
901 Bundle windowState = savedInstanceState.getBundle(WINDOW_HIERARCHY_TAG);
902 if (windowState != null) {
903 mWindow.restoreHierarchyState(windowState);
904 }
905 }
906 }
907
908 /**
909 * Restore the state of any saved managed dialogs.
910 *
911 * @param savedInstanceState The bundle to restore from.
912 */
913 private void restoreManagedDialogs(Bundle savedInstanceState) {
914 final Bundle b = savedInstanceState.getBundle(SAVED_DIALOGS_TAG);
915 if (b == null) {
916 return;
917 }
918
919 final int[] ids = b.getIntArray(SAVED_DIALOG_IDS_KEY);
920 final int numDialogs = ids.length;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800921 mManagedDialogs = new SparseArray<ManagedDialog>(numDialogs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800922 for (int i = 0; i < numDialogs; i++) {
923 final Integer dialogId = ids[i];
924 Bundle dialogState = b.getBundle(savedDialogKeyFor(dialogId));
925 if (dialogState != null) {
Romain Guye35c2352009-06-19 13:18:12 -0700926 // Calling onRestoreInstanceState() below will invoke dispatchOnCreate
927 // so tell createDialog() not to do it, otherwise we get an exception
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800928 final ManagedDialog md = new ManagedDialog();
929 md.mArgs = b.getBundle(savedDialogArgsKeyFor(dialogId));
930 md.mDialog = createDialog(dialogId, dialogState, md.mArgs);
931 if (md.mDialog != null) {
932 mManagedDialogs.put(dialogId, md);
933 onPrepareDialog(dialogId, md.mDialog, md.mArgs);
934 md.mDialog.onRestoreInstanceState(dialogState);
935 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800936 }
937 }
938 }
939
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800940 private Dialog createDialog(Integer dialogId, Bundle state, Bundle args) {
941 final Dialog dialog = onCreateDialog(dialogId, args);
Romain Guy764d5332009-06-17 16:52:22 -0700942 if (dialog == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800943 return null;
Romain Guy764d5332009-06-17 16:52:22 -0700944 }
Romain Guy6de4aed2009-07-08 10:54:45 -0700945 dialog.dispatchOnCreate(state);
Romain Guy764d5332009-06-17 16:52:22 -0700946 return dialog;
947 }
948
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800949 private static String savedDialogKeyFor(int key) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800950 return SAVED_DIALOG_KEY_PREFIX + key;
951 }
952
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800953 private static String savedDialogArgsKeyFor(int key) {
954 return SAVED_DIALOG_ARGS_KEY_PREFIX + key;
955 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800956
957 /**
958 * Called when activity start-up is complete (after {@link #onStart}
959 * and {@link #onRestoreInstanceState} have been called). Applications will
960 * generally not implement this method; it is intended for system
961 * classes to do final initialization after application code has run.
962 *
963 * <p><em>Derived classes must call through to the super class's
964 * implementation of this method. If they do not, an exception will be
965 * thrown.</em></p>
966 *
967 * @param savedInstanceState If the activity is being re-initialized after
968 * previously being shut down then this Bundle contains the data it most
969 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
970 * @see #onCreate
971 */
972 protected void onPostCreate(Bundle savedInstanceState) {
973 if (!isChild()) {
974 mTitleReady = true;
975 onTitleChanged(getTitle(), getTitleColor());
976 }
977 mCalled = true;
978 }
979
980 /**
981 * Called after {@link #onCreate} &mdash; or after {@link #onRestart} when
982 * the activity had been stopped, but is now again being displayed to the
983 * user. It will be followed by {@link #onResume}.
984 *
985 * <p><em>Derived classes must call through to the super class's
986 * implementation of this method. If they do not, an exception will be
987 * thrown.</em></p>
988 *
989 * @see #onCreate
990 * @see #onStop
991 * @see #onResume
992 */
993 protected void onStart() {
994 mCalled = true;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700995
996 if (!mLoadersStarted) {
997 mLoadersStarted = true;
998 if (mLoaderManager != null) {
999 mLoaderManager.doStart();
1000 } else if (!mCheckedForLoaderManager) {
1001 mLoaderManager = getLoaderManager(-1, mLoadersStarted, false);
1002 }
1003 mCheckedForLoaderManager = true;
Dianne Hackborn2707d602010-07-09 18:01:20 -07001004 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001005
1006 getApplication().dispatchActivityStarted(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001007 }
1008
1009 /**
1010 * Called after {@link #onStop} when the current activity is being
1011 * re-displayed to the user (the user has navigated back to it). It will
1012 * be followed by {@link #onStart} and then {@link #onResume}.
1013 *
1014 * <p>For activities that are using raw {@link Cursor} objects (instead of
1015 * creating them through
1016 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)},
1017 * this is usually the place
1018 * where the cursor should be requeried (because you had deactivated it in
1019 * {@link #onStop}.
1020 *
1021 * <p><em>Derived classes must call through to the super class's
1022 * implementation of this method. If they do not, an exception will be
1023 * thrown.</em></p>
1024 *
1025 * @see #onStop
1026 * @see #onStart
1027 * @see #onResume
1028 */
1029 protected void onRestart() {
1030 mCalled = true;
1031 }
1032
1033 /**
1034 * Called after {@link #onRestoreInstanceState}, {@link #onRestart}, or
1035 * {@link #onPause}, for your activity to start interacting with the user.
1036 * This is a good place to begin animations, open exclusive-access devices
1037 * (such as the camera), etc.
1038 *
1039 * <p>Keep in mind that onResume is not the best indicator that your activity
1040 * is visible to the user; a system window such as the keyguard may be in
1041 * front. Use {@link #onWindowFocusChanged} to know for certain that your
1042 * activity is visible to the user (for example, to resume a game).
1043 *
1044 * <p><em>Derived classes must call through to the super class's
1045 * implementation of this method. If they do not, an exception will be
1046 * thrown.</em></p>
1047 *
1048 * @see #onRestoreInstanceState
1049 * @see #onRestart
1050 * @see #onPostResume
1051 * @see #onPause
1052 */
1053 protected void onResume() {
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001054 getApplication().dispatchActivityResumed(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001055 mCalled = true;
1056 }
1057
1058 /**
1059 * Called when activity resume is complete (after {@link #onResume} has
1060 * been called). Applications will generally not implement this method;
1061 * it is intended for system classes to do final setup after application
1062 * resume code has run.
1063 *
1064 * <p><em>Derived classes must call through to the super class's
1065 * implementation of this method. If they do not, an exception will be
1066 * thrown.</em></p>
1067 *
1068 * @see #onResume
1069 */
1070 protected void onPostResume() {
1071 final Window win = getWindow();
1072 if (win != null) win.makeActive();
Adam Powell50efbed2011-02-08 16:20:15 -08001073 if (mActionBar != null) mActionBar.setShowHideAnimationEnabled(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001074 mCalled = true;
1075 }
1076
1077 /**
1078 * This is called for activities that set launchMode to "singleTop" in
1079 * their package, or if a client used the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP}
1080 * flag when calling {@link #startActivity}. In either case, when the
1081 * activity is re-launched while at the top of the activity stack instead
1082 * of a new instance of the activity being started, onNewIntent() will be
1083 * called on the existing instance with the Intent that was used to
1084 * re-launch it.
1085 *
1086 * <p>An activity will always be paused before receiving a new intent, so
1087 * you can count on {@link #onResume} being called after this method.
1088 *
1089 * <p>Note that {@link #getIntent} still returns the original Intent. You
1090 * can use {@link #setIntent} to update it to this new Intent.
1091 *
1092 * @param intent The new intent that was started for the activity.
1093 *
1094 * @see #getIntent
1095 * @see #setIntent
1096 * @see #onResume
1097 */
1098 protected void onNewIntent(Intent intent) {
1099 }
1100
1101 /**
1102 * The hook for {@link ActivityThread} to save the state of this activity.
1103 *
1104 * Calls {@link #onSaveInstanceState(android.os.Bundle)}
1105 * and {@link #saveManagedDialogs(android.os.Bundle)}.
1106 *
1107 * @param outState The bundle to save the state to.
1108 */
1109 final void performSaveInstanceState(Bundle outState) {
1110 onSaveInstanceState(outState);
1111 saveManagedDialogs(outState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001112 }
1113
1114 /**
1115 * Called to retrieve per-instance state from an activity before being killed
1116 * so that the state can be restored in {@link #onCreate} or
1117 * {@link #onRestoreInstanceState} (the {@link Bundle} populated by this method
1118 * will be passed to both).
1119 *
1120 * <p>This method is called before an activity may be killed so that when it
1121 * comes back some time in the future it can restore its state. For example,
1122 * if activity B is launched in front of activity A, and at some point activity
1123 * A is killed to reclaim resources, activity A will have a chance to save the
1124 * current state of its user interface via this method so that when the user
1125 * returns to activity A, the state of the user interface can be restored
1126 * via {@link #onCreate} or {@link #onRestoreInstanceState}.
1127 *
1128 * <p>Do not confuse this method with activity lifecycle callbacks such as
1129 * {@link #onPause}, which is always called when an activity is being placed
1130 * in the background or on its way to destruction, or {@link #onStop} which
1131 * is called before destruction. One example of when {@link #onPause} and
1132 * {@link #onStop} is called and not this method is when a user navigates back
1133 * from activity B to activity A: there is no need to call {@link #onSaveInstanceState}
1134 * on B because that particular instance will never be restored, so the
1135 * system avoids calling it. An example when {@link #onPause} is called and
1136 * not {@link #onSaveInstanceState} is when activity B is launched in front of activity A:
1137 * the system may avoid calling {@link #onSaveInstanceState} on activity A if it isn't
1138 * killed during the lifetime of B since the state of the user interface of
1139 * A will stay intact.
1140 *
1141 * <p>The default implementation takes care of most of the UI per-instance
1142 * state for you by calling {@link android.view.View#onSaveInstanceState()} on each
1143 * view in the hierarchy that has an id, and by saving the id of the currently
1144 * focused view (all of which is restored by the default implementation of
1145 * {@link #onRestoreInstanceState}). If you override this method to save additional
1146 * information not captured by each individual view, you will likely want to
1147 * call through to the default implementation, otherwise be prepared to save
1148 * all of the state of each view yourself.
1149 *
1150 * <p>If called, this method will occur before {@link #onStop}. There are
1151 * no guarantees about whether it will occur before or after {@link #onPause}.
1152 *
1153 * @param outState Bundle in which to place your saved state.
1154 *
1155 * @see #onCreate
1156 * @see #onRestoreInstanceState
1157 * @see #onPause
1158 */
1159 protected void onSaveInstanceState(Bundle outState) {
1160 outState.putBundle(WINDOW_HIERARCHY_TAG, mWindow.saveHierarchyState());
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001161 Parcelable p = mFragments.saveAllState();
1162 if (p != null) {
1163 outState.putParcelable(FRAGMENTS_TAG, p);
1164 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001165 getApplication().dispatchActivitySaveInstanceState(this, outState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001166 }
1167
1168 /**
1169 * Save the state of any managed dialogs.
1170 *
1171 * @param outState place to store the saved state.
1172 */
1173 private void saveManagedDialogs(Bundle outState) {
1174 if (mManagedDialogs == null) {
1175 return;
1176 }
1177
1178 final int numDialogs = mManagedDialogs.size();
1179 if (numDialogs == 0) {
1180 return;
1181 }
1182
1183 Bundle dialogState = new Bundle();
1184
1185 int[] ids = new int[mManagedDialogs.size()];
1186
1187 // save each dialog's bundle, gather the ids
1188 for (int i = 0; i < numDialogs; i++) {
1189 final int key = mManagedDialogs.keyAt(i);
1190 ids[i] = key;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001191 final ManagedDialog md = mManagedDialogs.valueAt(i);
1192 dialogState.putBundle(savedDialogKeyFor(key), md.mDialog.onSaveInstanceState());
1193 if (md.mArgs != null) {
1194 dialogState.putBundle(savedDialogArgsKeyFor(key), md.mArgs);
1195 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001196 }
1197
1198 dialogState.putIntArray(SAVED_DIALOG_IDS_KEY, ids);
1199 outState.putBundle(SAVED_DIALOGS_TAG, dialogState);
1200 }
1201
1202
1203 /**
1204 * Called as part of the activity lifecycle when an activity is going into
1205 * the background, but has not (yet) been killed. The counterpart to
1206 * {@link #onResume}.
1207 *
1208 * <p>When activity B is launched in front of activity A, this callback will
1209 * be invoked on A. B will not be created until A's {@link #onPause} returns,
1210 * so be sure to not do anything lengthy here.
1211 *
1212 * <p>This callback is mostly used for saving any persistent state the
1213 * activity is editing, to present a "edit in place" model to the user and
1214 * making sure nothing is lost if there are not enough resources to start
1215 * the new activity without first killing this one. This is also a good
1216 * place to do things like stop animations and other things that consume a
1217 * noticeable mount of CPU in order to make the switch to the next activity
1218 * as fast as possible, or to close resources that are exclusive access
1219 * such as the camera.
1220 *
1221 * <p>In situations where the system needs more memory it may kill paused
1222 * processes to reclaim resources. Because of this, you should be sure
1223 * that all of your state is saved by the time you return from
1224 * this function. In general {@link #onSaveInstanceState} is used to save
1225 * per-instance state in the activity and this method is used to store
1226 * global persistent data (in content providers, files, etc.)
1227 *
1228 * <p>After receiving this call you will usually receive a following call
1229 * to {@link #onStop} (after the next activity has been resumed and
1230 * displayed), however in some cases there will be a direct call back to
1231 * {@link #onResume} without going through the stopped state.
1232 *
1233 * <p><em>Derived classes must call through to the super class's
1234 * implementation of this method. If they do not, an exception will be
1235 * thrown.</em></p>
1236 *
1237 * @see #onResume
1238 * @see #onSaveInstanceState
1239 * @see #onStop
1240 */
1241 protected void onPause() {
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001242 getApplication().dispatchActivityPaused(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001243 mCalled = true;
1244 }
1245
1246 /**
1247 * Called as part of the activity lifecycle when an activity is about to go
1248 * into the background as the result of user choice. For example, when the
1249 * user presses the Home key, {@link #onUserLeaveHint} will be called, but
1250 * when an incoming phone call causes the in-call Activity to be automatically
1251 * brought to the foreground, {@link #onUserLeaveHint} will not be called on
1252 * the activity being interrupted. In cases when it is invoked, this method
1253 * is called right before the activity's {@link #onPause} callback.
1254 *
1255 * <p>This callback and {@link #onUserInteraction} are intended to help
1256 * activities manage status bar notifications intelligently; specifically,
1257 * for helping activities determine the proper time to cancel a notfication.
1258 *
1259 * @see #onUserInteraction()
1260 */
1261 protected void onUserLeaveHint() {
1262 }
1263
1264 /**
1265 * Generate a new thumbnail for this activity. This method is called before
1266 * pausing the activity, and should draw into <var>outBitmap</var> the
1267 * imagery for the desired thumbnail in the dimensions of that bitmap. It
1268 * can use the given <var>canvas</var>, which is configured to draw into the
1269 * bitmap, for rendering if desired.
1270 *
Dianne Hackborn0aae2d42010-12-07 23:51:29 -08001271 * <p>The default implementation returns fails and does not draw a thumbnail;
1272 * this will result in the platform creating its own thumbnail if needed.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001273 *
1274 * @param outBitmap The bitmap to contain the thumbnail.
1275 * @param canvas Can be used to render into the bitmap.
1276 *
1277 * @return Return true if you have drawn into the bitmap; otherwise after
1278 * you return it will be filled with a default thumbnail.
1279 *
1280 * @see #onCreateDescription
1281 * @see #onSaveInstanceState
1282 * @see #onPause
1283 */
1284 public boolean onCreateThumbnail(Bitmap outBitmap, Canvas canvas) {
Dianne Hackborn0aae2d42010-12-07 23:51:29 -08001285 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001286 }
1287
1288 /**
1289 * Generate a new description for this activity. This method is called
1290 * before pausing the activity and can, if desired, return some textual
1291 * description of its current state to be displayed to the user.
1292 *
1293 * <p>The default implementation returns null, which will cause you to
1294 * inherit the description from the previous activity. If all activities
1295 * return null, generally the label of the top activity will be used as the
1296 * description.
1297 *
1298 * @return A description of what the user is doing. It should be short and
1299 * sweet (only a few words).
1300 *
1301 * @see #onCreateThumbnail
1302 * @see #onSaveInstanceState
1303 * @see #onPause
1304 */
1305 public CharSequence onCreateDescription() {
1306 return null;
1307 }
1308
1309 /**
1310 * Called when you are no longer visible to the user. You will next
1311 * receive either {@link #onRestart}, {@link #onDestroy}, or nothing,
1312 * depending on later user activity.
1313 *
1314 * <p>Note that this method may never be called, in low memory situations
1315 * where the system does not have enough memory to keep your activity's
1316 * process running after its {@link #onPause} method is called.
1317 *
1318 * <p><em>Derived classes must call through to the super class's
1319 * implementation of this method. If they do not, an exception will be
1320 * thrown.</em></p>
1321 *
1322 * @see #onRestart
1323 * @see #onResume
1324 * @see #onSaveInstanceState
1325 * @see #onDestroy
1326 */
1327 protected void onStop() {
Adam Powell50efbed2011-02-08 16:20:15 -08001328 if (mActionBar != null) mActionBar.setShowHideAnimationEnabled(false);
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001329 getApplication().dispatchActivityStopped(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001330 mCalled = true;
1331 }
1332
1333 /**
1334 * Perform any final cleanup before an activity is destroyed. This can
1335 * happen either because the activity is finishing (someone called
1336 * {@link #finish} on it, or because the system is temporarily destroying
1337 * this instance of the activity to save space. You can distinguish
1338 * between these two scenarios with the {@link #isFinishing} method.
1339 *
1340 * <p><em>Note: do not count on this method being called as a place for
1341 * saving data! For example, if an activity is editing data in a content
1342 * provider, those edits should be committed in either {@link #onPause} or
1343 * {@link #onSaveInstanceState}, not here.</em> This method is usually implemented to
1344 * free resources like threads that are associated with an activity, so
1345 * that a destroyed activity does not leave such things around while the
1346 * rest of its application is still running. There are situations where
1347 * the system will simply kill the activity's hosting process without
1348 * calling this method (or any others) in it, so it should not be used to
1349 * do things that are intended to remain around after the process goes
1350 * away.
1351 *
1352 * <p><em>Derived classes must call through to the super class's
1353 * implementation of this method. If they do not, an exception will be
1354 * thrown.</em></p>
1355 *
1356 * @see #onPause
1357 * @see #onStop
1358 * @see #finish
1359 * @see #isFinishing
1360 */
1361 protected void onDestroy() {
1362 mCalled = true;
1363
1364 // dismiss any dialogs we are managing.
1365 if (mManagedDialogs != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001366 final int numDialogs = mManagedDialogs.size();
1367 for (int i = 0; i < numDialogs; i++) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001368 final ManagedDialog md = mManagedDialogs.valueAt(i);
1369 if (md.mDialog.isShowing()) {
1370 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001371 }
1372 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001373 mManagedDialogs = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001374 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001375
1376 // close any cursors we are managing.
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001377 synchronized (mManagedCursors) {
1378 int numCursors = mManagedCursors.size();
1379 for (int i = 0; i < numCursors; i++) {
1380 ManagedCursor c = mManagedCursors.get(i);
1381 if (c != null) {
1382 c.mCursor.close();
1383 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001384 }
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001385 mManagedCursors.clear();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001386 }
Amith Yamasani49860442010-03-17 20:54:10 -07001387
1388 // Close any open search dialog
1389 if (mSearchManager != null) {
1390 mSearchManager.stopSearch();
1391 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001392
1393 getApplication().dispatchActivityDestroyed(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001394 }
1395
1396 /**
1397 * Called by the system when the device configuration changes while your
1398 * activity is running. Note that this will <em>only</em> be called if
1399 * you have selected configurations you would like to handle with the
1400 * {@link android.R.attr#configChanges} attribute in your manifest. If
1401 * any configuration change occurs that is not selected to be reported
1402 * by that attribute, then instead of reporting it the system will stop
1403 * and restart the activity (to have it launched with the new
1404 * configuration).
1405 *
1406 * <p>At the time that this function has been called, your Resources
1407 * object will have been updated to return resource values matching the
1408 * new configuration.
1409 *
1410 * @param newConfig The new device configuration.
1411 */
1412 public void onConfigurationChanged(Configuration newConfig) {
1413 mCalled = true;
Bjorn Bringert444c7272009-07-06 21:32:50 +01001414
Dianne Hackborn9d071802010-12-08 14:49:15 -08001415 mFragments.dispatchConfigurationChanged(newConfig);
1416
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001417 if (mWindow != null) {
1418 // Pass the configuration changed event to the window
1419 mWindow.onConfigurationChanged(newConfig);
1420 }
Adam Powell45c0b192011-07-28 15:11:57 -07001421
1422 if (mActionBar != null) {
1423 // Do this last; the action bar will need to access
1424 // view changes from above.
1425 mActionBar.onConfigurationChanged(newConfig);
1426 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001427 }
1428
1429 /**
1430 * If this activity is being destroyed because it can not handle a
1431 * configuration parameter being changed (and thus its
1432 * {@link #onConfigurationChanged(Configuration)} method is
1433 * <em>not</em> being called), then you can use this method to discover
1434 * the set of changes that have occurred while in the process of being
1435 * destroyed. Note that there is no guarantee that these will be
1436 * accurate (other changes could have happened at any time), so you should
1437 * only use this as an optimization hint.
1438 *
1439 * @return Returns a bit field of the configuration parameters that are
1440 * changing, as defined by the {@link android.content.res.Configuration}
1441 * class.
1442 */
1443 public int getChangingConfigurations() {
1444 return mConfigChangeFlags;
1445 }
1446
1447 /**
1448 * Retrieve the non-configuration instance data that was previously
1449 * returned by {@link #onRetainNonConfigurationInstance()}. This will
1450 * be available from the initial {@link #onCreate} and
1451 * {@link #onStart} calls to the new instance, allowing you to extract
1452 * any useful dynamic state from the previous instance.
1453 *
1454 * <p>Note that the data you retrieve here should <em>only</em> be used
1455 * as an optimization for handling configuration changes. You should always
1456 * be able to handle getting a null pointer back, and an activity must
1457 * still be able to restore itself to its previous state (through the
1458 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1459 * function returns null.
1460 *
1461 * @return Returns the object previously returned by
1462 * {@link #onRetainNonConfigurationInstance()}.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001463 *
1464 * @deprecated Use the new {@link Fragment} API
1465 * {@link Fragment#setRetainInstance(boolean)} instead; this is also
1466 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001467 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07001468 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001469 public Object getLastNonConfigurationInstance() {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001470 return mLastNonConfigurationInstances != null
1471 ? mLastNonConfigurationInstances.activity : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001472 }
1473
1474 /**
1475 * Called by the system, as part of destroying an
1476 * activity due to a configuration change, when it is known that a new
1477 * instance will immediately be created for the new configuration. You
1478 * can return any object you like here, including the activity instance
1479 * itself, which can later be retrieved by calling
1480 * {@link #getLastNonConfigurationInstance()} in the new activity
1481 * instance.
1482 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001483 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1484 * or later, consider instead using a {@link Fragment} with
1485 * {@link Fragment#setRetainInstance(boolean)
1486 * Fragment.setRetainInstance(boolean}.</em>
1487 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001488 * <p>This function is called purely as an optimization, and you must
1489 * not rely on it being called. When it is called, a number of guarantees
1490 * will be made to help optimize configuration switching:
1491 * <ul>
1492 * <li> The function will be called between {@link #onStop} and
1493 * {@link #onDestroy}.
1494 * <li> A new instance of the activity will <em>always</em> be immediately
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001495 * created after this one's {@link #onDestroy()} is called. In particular,
1496 * <em>no</em> messages will be dispatched during this time (when the returned
1497 * object does not have an activity to be associated with).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001498 * <li> The object you return here will <em>always</em> be available from
1499 * the {@link #getLastNonConfigurationInstance()} method of the following
1500 * activity instance as described there.
1501 * </ul>
1502 *
1503 * <p>These guarantees are designed so that an activity can use this API
1504 * to propagate extensive state from the old to new activity instance, from
1505 * loaded bitmaps, to network connections, to evenly actively running
1506 * threads. Note that you should <em>not</em> propagate any data that
1507 * may change based on the configuration, including any data loaded from
1508 * resources such as strings, layouts, or drawables.
1509 *
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001510 * <p>The guarantee of no message handling during the switch to the next
1511 * activity simplifies use with active objects. For example if your retained
1512 * state is an {@link android.os.AsyncTask} you are guaranteed that its
1513 * call back functions (like {@link android.os.AsyncTask#onPostExecute}) will
1514 * not be called from the call here until you execute the next instance's
1515 * {@link #onCreate(Bundle)}. (Note however that there is of course no such
1516 * guarantee for {@link android.os.AsyncTask#doInBackground} since that is
1517 * running in a separate thread.)
1518 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001519 * @return Return any Object holding the desired state to propagate to the
1520 * next activity instance.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001521 *
1522 * @deprecated Use the new {@link Fragment} API
1523 * {@link Fragment#setRetainInstance(boolean)} instead; this is also
1524 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001525 */
1526 public Object onRetainNonConfigurationInstance() {
1527 return null;
1528 }
1529
1530 /**
1531 * Retrieve the non-configuration instance data that was previously
1532 * returned by {@link #onRetainNonConfigurationChildInstances()}. This will
1533 * be available from the initial {@link #onCreate} and
1534 * {@link #onStart} calls to the new instance, allowing you to extract
1535 * any useful dynamic state from the previous instance.
1536 *
1537 * <p>Note that the data you retrieve here should <em>only</em> be used
1538 * as an optimization for handling configuration changes. You should always
1539 * be able to handle getting a null pointer back, and an activity must
1540 * still be able to restore itself to its previous state (through the
1541 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1542 * function returns null.
1543 *
1544 * @return Returns the object previously returned by
1545 * {@link #onRetainNonConfigurationChildInstances()}
1546 */
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001547 HashMap<String, Object> getLastNonConfigurationChildInstances() {
1548 return mLastNonConfigurationInstances != null
1549 ? mLastNonConfigurationInstances.children : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 }
1551
1552 /**
1553 * This method is similar to {@link #onRetainNonConfigurationInstance()} except that
1554 * it should return either a mapping from child activity id strings to arbitrary objects,
1555 * or null. This method is intended to be used by Activity framework subclasses that control a
1556 * set of child activities, such as ActivityGroup. The same guarantees and restrictions apply
1557 * as for {@link #onRetainNonConfigurationInstance()}. The default implementation returns null.
1558 */
1559 HashMap<String,Object> onRetainNonConfigurationChildInstances() {
1560 return null;
1561 }
1562
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001563 NonConfigurationInstances retainNonConfigurationInstances() {
1564 Object activity = onRetainNonConfigurationInstance();
1565 HashMap<String, Object> children = onRetainNonConfigurationChildInstances();
1566 ArrayList<Fragment> fragments = mFragments.retainNonConfig();
Dianne Hackborn2707d602010-07-09 18:01:20 -07001567 boolean retainLoaders = false;
1568 if (mAllLoaderManagers != null) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001569 // prune out any loader managers that were already stopped and so
Dianne Hackborn2707d602010-07-09 18:01:20 -07001570 // have nothing useful to retain.
1571 for (int i=mAllLoaderManagers.size()-1; i>=0; i--) {
Dianne Hackborn4911b782010-07-15 12:54:39 -07001572 LoaderManagerImpl lm = mAllLoaderManagers.valueAt(i);
Dianne Hackborn2707d602010-07-09 18:01:20 -07001573 if (lm.mRetaining) {
1574 retainLoaders = true;
1575 } else {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001576 lm.doDestroy();
Dianne Hackborn2707d602010-07-09 18:01:20 -07001577 mAllLoaderManagers.removeAt(i);
1578 }
1579 }
1580 }
1581 if (activity == null && children == null && fragments == null && !retainLoaders) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001582 return null;
1583 }
1584
1585 NonConfigurationInstances nci = new NonConfigurationInstances();
1586 nci.activity = activity;
1587 nci.children = children;
1588 nci.fragments = fragments;
Dianne Hackborn2707d602010-07-09 18:01:20 -07001589 nci.loaders = mAllLoaderManagers;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001590 return nci;
1591 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001592
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001593 public void onLowMemory() {
1594 mCalled = true;
Dianne Hackborn9d071802010-12-08 14:49:15 -08001595 mFragments.dispatchLowMemory();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001596 }
Dianne Hackbornc68c9132011-07-29 01:25:18 -07001597
1598 public void onTrimMemory(int level) {
1599 mCalled = true;
1600 mFragments.dispatchTrimMemory(level);
1601 }
1602
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001603 /**
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07001604 * Return the FragmentManager for interacting with fragments associated
1605 * with this activity.
1606 */
1607 public FragmentManager getFragmentManager() {
1608 return mFragments;
1609 }
1610
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001611 void invalidateFragmentIndex(int index) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001612 //Log.v(TAG, "invalidateFragmentIndex: index=" + index);
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001613 if (mAllLoaderManagers != null) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001614 LoaderManagerImpl lm = mAllLoaderManagers.get(index);
Dianne Hackbornd04ad542011-07-25 16:16:15 -07001615 if (lm != null && !lm.mRetaining) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001616 lm.doDestroy();
Dianne Hackbornd04ad542011-07-25 16:16:15 -07001617 mAllLoaderManagers.remove(index);
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001618 }
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001619 }
1620 }
1621
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001622 /**
Dianne Hackbornc8017682010-07-06 13:34:38 -07001623 * Called when a Fragment is being attached to this activity, immediately
1624 * after the call to its {@link Fragment#onAttach Fragment.onAttach()}
1625 * method and before {@link Fragment#onCreate Fragment.onCreate()}.
1626 */
1627 public void onAttachFragment(Fragment fragment) {
1628 }
1629
1630 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001631 * Wrapper around
1632 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1633 * that gives the resulting {@link Cursor} to call
1634 * {@link #startManagingCursor} so that the activity will manage its
1635 * lifecycle for you.
1636 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001637 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1638 * or later, consider instead using {@link LoaderManager} instead, available
1639 * via {@link #getLoaderManager()}.</em>
1640 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07001641 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on a cursor obtained using
1642 * this method, because the activity will do that for you at the appropriate time. However, if
1643 * you call {@link #stopManagingCursor} on a cursor from a managed query, the system <em>will
1644 * not</em> automatically close the cursor and, in that case, you must call
1645 * {@link Cursor#close()}.</p>
1646 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001647 * @param uri The URI of the content provider to query.
1648 * @param projection List of columns to return.
1649 * @param selection SQL WHERE clause.
1650 * @param sortOrder SQL ORDER BY clause.
1651 *
1652 * @return The Cursor that was returned by query().
1653 *
1654 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1655 * @see #startManagingCursor
1656 * @hide
Jason parks6ed50de2010-08-25 10:18:50 -05001657 *
1658 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001659 */
Jason parks6ed50de2010-08-25 10:18:50 -05001660 @Deprecated
Dianne Hackborn291905e2010-08-17 15:17:15 -07001661 public final Cursor managedQuery(Uri uri, String[] projection, String selection,
1662 String sortOrder) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001663 Cursor c = getContentResolver().query(uri, projection, selection, null, sortOrder);
1664 if (c != null) {
1665 startManagingCursor(c);
1666 }
1667 return c;
1668 }
1669
1670 /**
1671 * Wrapper around
1672 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1673 * that gives the resulting {@link Cursor} to call
1674 * {@link #startManagingCursor} so that the activity will manage its
1675 * lifecycle for you.
1676 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001677 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1678 * or later, consider instead using {@link LoaderManager} instead, available
1679 * via {@link #getLoaderManager()}.</em>
1680 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07001681 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on a cursor obtained using
1682 * this method, because the activity will do that for you at the appropriate time. However, if
1683 * you call {@link #stopManagingCursor} on a cursor from a managed query, the system <em>will
1684 * not</em> automatically close the cursor and, in that case, you must call
1685 * {@link Cursor#close()}.</p>
1686 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001687 * @param uri The URI of the content provider to query.
1688 * @param projection List of columns to return.
1689 * @param selection SQL WHERE clause.
1690 * @param selectionArgs The arguments to selection, if any ?s are pesent
1691 * @param sortOrder SQL ORDER BY clause.
1692 *
1693 * @return The Cursor that was returned by query().
1694 *
1695 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1696 * @see #startManagingCursor
Jason parks6ed50de2010-08-25 10:18:50 -05001697 *
1698 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001699 */
Jason parks6ed50de2010-08-25 10:18:50 -05001700 @Deprecated
Dianne Hackborn291905e2010-08-17 15:17:15 -07001701 public final Cursor managedQuery(Uri uri, String[] projection, String selection,
1702 String[] selectionArgs, String sortOrder) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001703 Cursor c = getContentResolver().query(uri, projection, selection, selectionArgs, sortOrder);
1704 if (c != null) {
1705 startManagingCursor(c);
1706 }
1707 return c;
1708 }
1709
1710 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001711 * This method allows the activity to take care of managing the given
1712 * {@link Cursor}'s lifecycle for you based on the activity's lifecycle.
1713 * That is, when the activity is stopped it will automatically call
1714 * {@link Cursor#deactivate} on the given Cursor, and when it is later restarted
1715 * it will call {@link Cursor#requery} for you. When the activity is
1716 * destroyed, all managed Cursors will be closed automatically.
1717 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001718 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1719 * or later, consider instead using {@link LoaderManager} instead, available
1720 * via {@link #getLoaderManager()}.</em>
1721 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07001722 * <p><strong>Warning:</strong> Do not call {@link Cursor#close()} on cursor obtained from
1723 * {@link #managedQuery}, because the activity will do that for you at the appropriate time.
1724 * However, if you call {@link #stopManagingCursor} on a cursor from a managed query, the system
1725 * <em>will not</em> automatically close the cursor and, in that case, you must call
1726 * {@link Cursor#close()}.</p>
1727 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001728 * @param c The Cursor to be managed.
1729 *
1730 * @see #managedQuery(android.net.Uri , String[], String, String[], String)
1731 * @see #stopManagingCursor
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001732 *
1733 * @deprecated Use the new {@link android.content.CursorLoader} class with
1734 * {@link LoaderManager} 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 */
Jason parks6ed50de2010-08-25 10:18:50 -05001737 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001738 public void startManagingCursor(Cursor c) {
1739 synchronized (mManagedCursors) {
1740 mManagedCursors.add(new ManagedCursor(c));
1741 }
1742 }
1743
1744 /**
1745 * Given a Cursor that was previously given to
1746 * {@link #startManagingCursor}, stop the activity's management of that
1747 * cursor.
1748 *
Joe Fernandez8ef69702011-09-02 14:32:22 -07001749 * <p><strong>Warning:</strong> After calling this method on a cursor from a managed query,
1750 * the system <em>will not</em> automatically close the cursor and you must call
1751 * {@link Cursor#close()}.</p>
1752 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001753 * @param c The Cursor that was being managed.
1754 *
1755 * @see #startManagingCursor
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001756 *
1757 * @deprecated Use the new {@link android.content.CursorLoader} class with
1758 * {@link LoaderManager} instead; this is also
1759 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001760 */
Jason parks6ed50de2010-08-25 10:18:50 -05001761 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001762 public void stopManagingCursor(Cursor c) {
1763 synchronized (mManagedCursors) {
1764 final int N = mManagedCursors.size();
1765 for (int i=0; i<N; i++) {
1766 ManagedCursor mc = mManagedCursors.get(i);
1767 if (mc.mCursor == c) {
1768 mManagedCursors.remove(i);
1769 break;
1770 }
1771 }
1772 }
1773 }
1774
1775 /**
Dianne Hackborn3c4c2b72010-10-05 18:07:54 -07001776 * @deprecated As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}
1777 * this is a no-op.
Dianne Hackborn4f3867e2010-12-14 22:09:51 -08001778 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001779 */
Dianne Hackbornd3efa392010-09-01 17:34:12 -07001780 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001781 public void setPersistent(boolean isPersistent) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001782 }
1783
1784 /**
1785 * Finds a view that was identified by the id attribute from the XML that
1786 * was processed in {@link #onCreate}.
1787 *
1788 * @return The view if found or null otherwise.
1789 */
1790 public View findViewById(int id) {
1791 return getWindow().findViewById(id);
1792 }
Adam Powell33b97432010-04-20 10:01:14 -07001793
1794 /**
1795 * Retrieve a reference to this activity's ActionBar.
Adam Powell42c0fe82010-08-10 16:36:56 -07001796 *
Adam Powell33b97432010-04-20 10:01:14 -07001797 * @return The Activity's ActionBar, or null if it does not have one.
1798 */
1799 public ActionBar getActionBar() {
Adam Powell42c0fe82010-08-10 16:36:56 -07001800 initActionBar();
Adam Powell33b97432010-04-20 10:01:14 -07001801 return mActionBar;
1802 }
1803
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001804 /**
Adam Powell33b97432010-04-20 10:01:14 -07001805 * Creates a new ActionBar, locates the inflated ActionBarView,
1806 * initializes the ActionBar with the view, and sets mActionBar.
1807 */
1808 private void initActionBar() {
Adam Powell89e06452010-06-23 20:24:52 -07001809 Window window = getWindow();
Adam Powella593d982011-05-13 14:09:54 -07001810
1811 // Initializing the window decor can change window feature flags.
1812 // Make sure that we have the correct set before performing the test below.
1813 window.getDecorView();
1814
Adam Powell9b4c8042010-08-10 15:36:44 -07001815 if (isChild() || !window.hasFeature(Window.FEATURE_ACTION_BAR) || mActionBar != null) {
Adam Powell33b97432010-04-20 10:01:14 -07001816 return;
1817 }
1818
Adam Powell661c9082010-07-02 10:09:44 -07001819 mActionBar = new ActionBarImpl(this);
Adam Powell33b97432010-04-20 10:01:14 -07001820 }
1821
1822 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001823 * Set the activity content from a layout resource. The resource will be
1824 * inflated, adding all top-level views to the activity.
Romain Guy482b34a62011-01-20 10:59:28 -08001825 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001826 * @param layoutResID Resource ID to be inflated.
Romain Guy482b34a62011-01-20 10:59:28 -08001827 *
1828 * @see #setContentView(android.view.View)
1829 * @see #setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001830 */
1831 public void setContentView(int layoutResID) {
1832 getWindow().setContentView(layoutResID);
Adam Powell33b97432010-04-20 10:01:14 -07001833 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001834 }
1835
1836 /**
1837 * Set the activity content to an explicit view. This view is placed
1838 * directly into the activity's view hierarchy. It can itself be a complex
Romain Guy482b34a62011-01-20 10:59:28 -08001839 * view hierarchy. When calling this method, the layout parameters of the
1840 * specified view are ignored. Both the width and the height of the view are
1841 * set by default to {@link ViewGroup.LayoutParams#MATCH_PARENT}. To use
1842 * your own layout parameters, invoke
1843 * {@link #setContentView(android.view.View, android.view.ViewGroup.LayoutParams)}
1844 * instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001845 *
1846 * @param view The desired content to display.
Romain Guy482b34a62011-01-20 10:59:28 -08001847 *
1848 * @see #setContentView(int)
1849 * @see #setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001850 */
1851 public void setContentView(View view) {
1852 getWindow().setContentView(view);
Adam Powell33b97432010-04-20 10:01:14 -07001853 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001854 }
1855
1856 /**
1857 * Set the activity content to an explicit view. This view is placed
1858 * directly into the activity's view hierarchy. It can itself be a complex
Romain Guy482b34a62011-01-20 10:59:28 -08001859 * view hierarchy.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001860 *
1861 * @param view The desired content to display.
1862 * @param params Layout parameters for the view.
Romain Guy482b34a62011-01-20 10:59:28 -08001863 *
1864 * @see #setContentView(android.view.View)
1865 * @see #setContentView(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001866 */
1867 public void setContentView(View view, ViewGroup.LayoutParams params) {
1868 getWindow().setContentView(view, params);
Adam Powell33b97432010-04-20 10:01:14 -07001869 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001870 }
1871
1872 /**
1873 * Add an additional content view to the activity. Added after any existing
1874 * ones in the activity -- existing views are NOT removed.
1875 *
1876 * @param view The desired content to display.
1877 * @param params Layout parameters for the view.
1878 */
1879 public void addContentView(View view, ViewGroup.LayoutParams params) {
1880 getWindow().addContentView(view, params);
Adam Powell33b97432010-04-20 10:01:14 -07001881 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001882 }
1883
1884 /**
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001885 * Sets whether this activity is finished when touched outside its window's
1886 * bounds.
1887 */
1888 public void setFinishOnTouchOutside(boolean finish) {
1889 mWindow.setCloseOnTouchOutside(finish);
1890 }
1891
1892 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001893 * Use with {@link #setDefaultKeyMode} to turn off default handling of
1894 * keys.
1895 *
1896 * @see #setDefaultKeyMode
1897 */
1898 static public final int DEFAULT_KEYS_DISABLE = 0;
1899 /**
1900 * Use with {@link #setDefaultKeyMode} to launch the dialer during default
1901 * key handling.
1902 *
1903 * @see #setDefaultKeyMode
1904 */
1905 static public final int DEFAULT_KEYS_DIALER = 1;
1906 /**
1907 * Use with {@link #setDefaultKeyMode} to execute a menu shortcut in
1908 * default key handling.
1909 *
1910 * <p>That is, the user does not need to hold down the menu key to execute menu shortcuts.
1911 *
1912 * @see #setDefaultKeyMode
1913 */
1914 static public final int DEFAULT_KEYS_SHORTCUT = 2;
1915 /**
1916 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
1917 * will start an application-defined search. (If the application or activity does not
1918 * actually define a search, the the keys will be ignored.)
1919 *
1920 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
1921 *
1922 * @see #setDefaultKeyMode
1923 */
1924 static public final int DEFAULT_KEYS_SEARCH_LOCAL = 3;
1925
1926 /**
1927 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
1928 * will start a global search (typically web search, but some platforms may define alternate
1929 * methods for global search)
1930 *
1931 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
1932 *
1933 * @see #setDefaultKeyMode
1934 */
1935 static public final int DEFAULT_KEYS_SEARCH_GLOBAL = 4;
1936
1937 /**
1938 * Select the default key handling for this activity. This controls what
1939 * will happen to key events that are not otherwise handled. The default
1940 * mode ({@link #DEFAULT_KEYS_DISABLE}) will simply drop them on the
1941 * floor. Other modes allow you to launch the dialer
1942 * ({@link #DEFAULT_KEYS_DIALER}), execute a shortcut in your options
1943 * menu without requiring the menu key be held down
1944 * ({@link #DEFAULT_KEYS_SHORTCUT}), or launch a search ({@link #DEFAULT_KEYS_SEARCH_LOCAL}
1945 * and {@link #DEFAULT_KEYS_SEARCH_GLOBAL}).
1946 *
1947 * <p>Note that the mode selected here does not impact the default
1948 * handling of system keys, such as the "back" and "menu" keys, and your
1949 * activity and its views always get a first chance to receive and handle
1950 * all application keys.
1951 *
1952 * @param mode The desired default key mode constant.
1953 *
1954 * @see #DEFAULT_KEYS_DISABLE
1955 * @see #DEFAULT_KEYS_DIALER
1956 * @see #DEFAULT_KEYS_SHORTCUT
1957 * @see #DEFAULT_KEYS_SEARCH_LOCAL
1958 * @see #DEFAULT_KEYS_SEARCH_GLOBAL
1959 * @see #onKeyDown
1960 */
1961 public final void setDefaultKeyMode(int mode) {
1962 mDefaultKeyMode = mode;
1963
1964 // Some modes use a SpannableStringBuilder to track & dispatch input events
1965 // This list must remain in sync with the switch in onKeyDown()
1966 switch (mode) {
1967 case DEFAULT_KEYS_DISABLE:
1968 case DEFAULT_KEYS_SHORTCUT:
1969 mDefaultKeySsb = null; // not used in these modes
1970 break;
1971 case DEFAULT_KEYS_DIALER:
1972 case DEFAULT_KEYS_SEARCH_LOCAL:
1973 case DEFAULT_KEYS_SEARCH_GLOBAL:
1974 mDefaultKeySsb = new SpannableStringBuilder();
1975 Selection.setSelection(mDefaultKeySsb,0);
1976 break;
1977 default:
1978 throw new IllegalArgumentException();
1979 }
1980 }
1981
1982 /**
1983 * Called when a key was pressed down and not handled by any of the views
1984 * inside of the activity. So, for example, key presses while the cursor
1985 * is inside a TextView will not trigger the event (unless it is a navigation
1986 * to another object) because TextView handles its own key presses.
1987 *
1988 * <p>If the focused view didn't want this event, this method is called.
1989 *
Dianne Hackborn8d374262009-09-14 21:21:52 -07001990 * <p>The default implementation takes care of {@link KeyEvent#KEYCODE_BACK}
1991 * by calling {@link #onBackPressed()}, though the behavior varies based
1992 * on the application compatibility mode: for
1993 * {@link android.os.Build.VERSION_CODES#ECLAIR} or later applications,
1994 * it will set up the dispatch to call {@link #onKeyUp} where the action
1995 * will be performed; for earlier applications, it will perform the
1996 * action immediately in on-down, as those versions of the platform
1997 * behaved.
1998 *
1999 * <p>Other additional default key handling may be performed
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002000 * if configured with {@link #setDefaultKeyMode}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002001 *
2002 * @return Return <code>true</code> to prevent this event from being propagated
2003 * further, or <code>false</code> to indicate that you have not handled
2004 * this event and it should continue to be propagated.
2005 * @see #onKeyUp
2006 * @see android.view.KeyEvent
2007 */
2008 public boolean onKeyDown(int keyCode, KeyEvent event) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002009 if (keyCode == KeyEvent.KEYCODE_BACK) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07002010 if (getApplicationInfo().targetSdkVersion
2011 >= Build.VERSION_CODES.ECLAIR) {
2012 event.startTracking();
2013 } else {
2014 onBackPressed();
2015 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002016 return true;
2017 }
2018
2019 if (mDefaultKeyMode == DEFAULT_KEYS_DISABLE) {
2020 return false;
2021 } else if (mDefaultKeyMode == DEFAULT_KEYS_SHORTCUT) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002022 if (getWindow().performPanelShortcut(Window.FEATURE_OPTIONS_PANEL,
2023 keyCode, event, Menu.FLAG_ALWAYS_PERFORM_CLOSE)) {
2024 return true;
2025 }
2026 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002027 } else {
2028 // Common code for DEFAULT_KEYS_DIALER & DEFAULT_KEYS_SEARCH_*
2029 boolean clearSpannable = false;
2030 boolean handled;
2031 if ((event.getRepeatCount() != 0) || event.isSystem()) {
2032 clearSpannable = true;
2033 handled = false;
2034 } else {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002035 handled = TextKeyListener.getInstance().onKeyDown(
2036 null, mDefaultKeySsb, keyCode, event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002037 if (handled && mDefaultKeySsb.length() > 0) {
2038 // something useable has been typed - dispatch it now.
2039
2040 final String str = mDefaultKeySsb.toString();
2041 clearSpannable = true;
2042
2043 switch (mDefaultKeyMode) {
2044 case DEFAULT_KEYS_DIALER:
2045 Intent intent = new Intent(Intent.ACTION_DIAL, Uri.parse("tel:" + str));
2046 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2047 startActivity(intent);
2048 break;
2049 case DEFAULT_KEYS_SEARCH_LOCAL:
2050 startSearch(str, false, null, false);
2051 break;
2052 case DEFAULT_KEYS_SEARCH_GLOBAL:
2053 startSearch(str, false, null, true);
2054 break;
2055 }
2056 }
2057 }
2058 if (clearSpannable) {
2059 mDefaultKeySsb.clear();
2060 mDefaultKeySsb.clearSpans();
2061 Selection.setSelection(mDefaultKeySsb,0);
2062 }
2063 return handled;
2064 }
2065 }
2066
2067 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002068 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
2069 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
2070 * the event).
2071 */
2072 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
2073 return false;
2074 }
2075
2076 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002077 * Called when a key was released and not handled by any of the views
2078 * inside of the activity. So, for example, key presses while the cursor
2079 * is inside a TextView will not trigger the event (unless it is a navigation
2080 * to another object) because TextView handles its own key presses.
2081 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002082 * <p>The default implementation handles KEYCODE_BACK to stop the activity
2083 * and go back.
2084 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002085 * @return Return <code>true</code> to prevent this event from being propagated
2086 * further, or <code>false</code> to indicate that you have not handled
2087 * this event and it should continue to be propagated.
2088 * @see #onKeyDown
2089 * @see KeyEvent
2090 */
2091 public boolean onKeyUp(int keyCode, KeyEvent event) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07002092 if (getApplicationInfo().targetSdkVersion
2093 >= Build.VERSION_CODES.ECLAIR) {
2094 if (keyCode == KeyEvent.KEYCODE_BACK && event.isTracking()
2095 && !event.isCanceled()) {
2096 onBackPressed();
2097 return true;
2098 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002099 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002100 return false;
2101 }
2102
2103 /**
2104 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
2105 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
2106 * the event).
2107 */
2108 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
2109 return false;
2110 }
2111
2112 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002113 * Called when the activity has detected the user's press of the back
2114 * key. The default implementation simply finishes the current activity,
2115 * but you can override this to do whatever you want.
2116 */
2117 public void onBackPressed() {
Dianne Hackborn3a57fb92010-11-15 17:58:52 -08002118 if (!mFragments.popBackStackImmediate()) {
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07002119 finish();
2120 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002121 }
Jeff Brown64da12a2011-01-04 19:57:47 -08002122
2123 /**
2124 * Called when a key shortcut event is not handled by any of the views in the Activity.
2125 * Override this method to implement global key shortcuts for the Activity.
2126 * Key shortcuts can also be implemented by setting the
2127 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
2128 *
2129 * @param keyCode The value in event.getKeyCode().
2130 * @param event Description of the key event.
2131 * @return True if the key shortcut was handled.
2132 */
2133 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
2134 return false;
2135 }
2136
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002137 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002138 * Called when a touch screen event was not handled by any of the views
2139 * under it. This is most useful to process touch events that happen
2140 * outside of your window bounds, where there is no view to receive it.
2141 *
2142 * @param event The touch screen event being processed.
2143 *
2144 * @return Return true if you have consumed the event, false if you haven't.
2145 * The default implementation always returns false.
2146 */
2147 public boolean onTouchEvent(MotionEvent event) {
Dianne Hackborncfaf8872011-01-18 13:57:54 -08002148 if (mWindow.shouldCloseOnTouch(this, event)) {
2149 finish();
2150 return true;
2151 }
2152
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002153 return false;
2154 }
2155
2156 /**
2157 * Called when the trackball was moved and not handled by any of the
2158 * views inside of the activity. So, for example, if the trackball moves
2159 * while focus is on a button, you will receive a call here because
2160 * buttons do not normally do anything with trackball events. The call
2161 * here happens <em>before</em> trackball movements are converted to
2162 * DPAD key events, which then get sent back to the view hierarchy, and
2163 * will be processed at the point for things like focus navigation.
2164 *
2165 * @param event The trackball event being processed.
2166 *
2167 * @return Return true if you have consumed the event, false if you haven't.
2168 * The default implementation always returns false.
2169 */
2170 public boolean onTrackballEvent(MotionEvent event) {
2171 return false;
2172 }
Jeff Browncb1404e2011-01-15 18:14:15 -08002173
2174 /**
2175 * Called when a generic motion event was not handled by any of the
2176 * views inside of the activity.
2177 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08002178 * Generic motion events describe joystick movements, mouse hovers, track pad
2179 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08002180 * {@link MotionEvent#getSource() source} of the motion event specifies
2181 * the class of input that was received. Implementations of this method
2182 * must examine the bits in the source before processing the event.
2183 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08002184 * </p><p>
2185 * Generic motion events with source class
2186 * {@link android.view.InputDevice#SOURCE_CLASS_POINTER}
2187 * are delivered to the view under the pointer. All other generic motion events are
2188 * delivered to the focused view.
2189 * </p><p>
2190 * See {@link View#onGenericMotionEvent(MotionEvent)} for an example of how to
2191 * handle this event.
Jeff Browncb1404e2011-01-15 18:14:15 -08002192 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08002193 *
2194 * @param event The generic motion event being processed.
2195 *
2196 * @return Return true if you have consumed the event, false if you haven't.
2197 * The default implementation always returns false.
2198 */
2199 public boolean onGenericMotionEvent(MotionEvent event) {
2200 return false;
2201 }
2202
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002203 /**
2204 * Called whenever a key, touch, or trackball event is dispatched to the
2205 * activity. Implement this method if you wish to know that the user has
2206 * interacted with the device in some way while your activity is running.
2207 * This callback and {@link #onUserLeaveHint} are intended to help
2208 * activities manage status bar notifications intelligently; specifically,
2209 * for helping activities determine the proper time to cancel a notfication.
2210 *
2211 * <p>All calls to your activity's {@link #onUserLeaveHint} callback will
2212 * be accompanied by calls to {@link #onUserInteraction}. This
2213 * ensures that your activity will be told of relevant user activity such
2214 * as pulling down the notification pane and touching an item there.
2215 *
2216 * <p>Note that this callback will be invoked for the touch down action
2217 * that begins a touch gesture, but may not be invoked for the touch-moved
2218 * and touch-up actions that follow.
2219 *
2220 * @see #onUserLeaveHint()
2221 */
2222 public void onUserInteraction() {
2223 }
2224
2225 public void onWindowAttributesChanged(WindowManager.LayoutParams params) {
2226 // Update window manager if: we have a view, that view is
2227 // attached to its parent (which will be a RootView), and
2228 // this activity is not embedded.
2229 if (mParent == null) {
2230 View decor = mDecor;
2231 if (decor != null && decor.getParent() != null) {
2232 getWindowManager().updateViewLayout(decor, params);
2233 }
2234 }
2235 }
2236
2237 public void onContentChanged() {
2238 }
2239
2240 /**
2241 * Called when the current {@link Window} of the activity gains or loses
2242 * focus. This is the best indicator of whether this activity is visible
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002243 * to the user. The default implementation clears the key tracking
2244 * state, so should always be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002245 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002246 * <p>Note that this provides information about global focus state, which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002247 * is managed independently of activity lifecycles. As such, while focus
2248 * changes will generally have some relation to lifecycle changes (an
2249 * activity that is stopped will not generally get window focus), you
2250 * should not rely on any particular order between the callbacks here and
2251 * those in the other lifecycle methods such as {@link #onResume}.
2252 *
2253 * <p>As a general rule, however, a resumed activity will have window
2254 * focus... unless it has displayed other dialogs or popups that take
2255 * input focus, in which case the activity itself will not have focus
2256 * when the other windows have it. Likewise, the system may display
2257 * system-level windows (such as the status bar notification panel or
2258 * a system alert) which will temporarily take window input focus without
2259 * pausing the foreground activity.
2260 *
2261 * @param hasFocus Whether the window of this activity has focus.
2262 *
2263 * @see #hasWindowFocus()
2264 * @see #onResume
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002265 * @see View#onWindowFocusChanged(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002266 */
2267 public void onWindowFocusChanged(boolean hasFocus) {
2268 }
2269
2270 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002271 * Called when the main window associated with the activity has been
2272 * attached to the window manager.
2273 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
2274 * for more information.
2275 * @see View#onAttachedToWindow
2276 */
2277 public void onAttachedToWindow() {
2278 }
2279
2280 /**
2281 * Called when the main window associated with the activity has been
2282 * detached from the window manager.
2283 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
2284 * for more information.
2285 * @see View#onDetachedFromWindow
2286 */
2287 public void onDetachedFromWindow() {
2288 }
2289
2290 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002291 * Returns true if this activity's <em>main</em> window currently has window focus.
2292 * Note that this is not the same as the view itself having focus.
2293 *
2294 * @return True if this activity's main window currently has window focus.
2295 *
2296 * @see #onWindowAttributesChanged(android.view.WindowManager.LayoutParams)
2297 */
2298 public boolean hasWindowFocus() {
2299 Window w = getWindow();
2300 if (w != null) {
2301 View d = w.getDecorView();
2302 if (d != null) {
2303 return d.hasWindowFocus();
2304 }
2305 }
2306 return false;
2307 }
2308
2309 /**
2310 * Called to process key events. You can override this to intercept all
2311 * key events before they are dispatched to the window. Be sure to call
2312 * this implementation for key events that should be handled normally.
2313 *
2314 * @param event The key event.
2315 *
2316 * @return boolean Return true if this event was consumed.
2317 */
2318 public boolean dispatchKeyEvent(KeyEvent event) {
2319 onUserInteraction();
Dianne Hackborn8d374262009-09-14 21:21:52 -07002320 Window win = getWindow();
2321 if (win.superDispatchKeyEvent(event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002322 return true;
2323 }
Dianne Hackborn8d374262009-09-14 21:21:52 -07002324 View decor = mDecor;
2325 if (decor == null) decor = win.getDecorView();
2326 return event.dispatch(this, decor != null
2327 ? decor.getKeyDispatcherState() : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002328 }
2329
2330 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08002331 * Called to process a key shortcut event.
2332 * You can override this to intercept all key shortcut events before they are
2333 * dispatched to the window. Be sure to call this implementation for key shortcut
2334 * events that should be handled normally.
2335 *
2336 * @param event The key shortcut event.
2337 * @return True if this event was consumed.
2338 */
2339 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
2340 onUserInteraction();
2341 if (getWindow().superDispatchKeyShortcutEvent(event)) {
2342 return true;
2343 }
2344 return onKeyShortcut(event.getKeyCode(), event);
2345 }
2346
2347 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002348 * Called to process touch screen events. You can override this to
2349 * intercept all touch screen events before they are dispatched to the
2350 * window. Be sure to call this implementation for touch screen events
2351 * that should be handled normally.
2352 *
2353 * @param ev The touch screen event.
2354 *
2355 * @return boolean Return true if this event was consumed.
2356 */
2357 public boolean dispatchTouchEvent(MotionEvent ev) {
2358 if (ev.getAction() == MotionEvent.ACTION_DOWN) {
2359 onUserInteraction();
2360 }
2361 if (getWindow().superDispatchTouchEvent(ev)) {
2362 return true;
2363 }
2364 return onTouchEvent(ev);
2365 }
2366
2367 /**
2368 * Called to process trackball events. You can override this to
2369 * intercept all trackball events before they are dispatched to the
2370 * window. Be sure to call this implementation for trackball events
2371 * that should be handled normally.
2372 *
2373 * @param ev The trackball event.
2374 *
2375 * @return boolean Return true if this event was consumed.
2376 */
2377 public boolean dispatchTrackballEvent(MotionEvent ev) {
2378 onUserInteraction();
2379 if (getWindow().superDispatchTrackballEvent(ev)) {
2380 return true;
2381 }
2382 return onTrackballEvent(ev);
2383 }
svetoslavganov75986cf2009-05-14 22:28:01 -07002384
Jeff Browncb1404e2011-01-15 18:14:15 -08002385 /**
2386 * Called to process generic motion events. You can override this to
2387 * intercept all generic motion events before they are dispatched to the
2388 * window. Be sure to call this implementation for generic motion events
2389 * that should be handled normally.
2390 *
2391 * @param ev The generic motion event.
2392 *
2393 * @return boolean Return true if this event was consumed.
2394 */
2395 public boolean dispatchGenericMotionEvent(MotionEvent ev) {
2396 onUserInteraction();
2397 if (getWindow().superDispatchGenericMotionEvent(ev)) {
2398 return true;
2399 }
2400 return onGenericMotionEvent(ev);
2401 }
2402
svetoslavganov75986cf2009-05-14 22:28:01 -07002403 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
2404 event.setClassName(getClass().getName());
2405 event.setPackageName(getPackageName());
2406
2407 LayoutParams params = getWindow().getAttributes();
Romain Guy980a9382010-01-08 15:06:28 -08002408 boolean isFullScreen = (params.width == LayoutParams.MATCH_PARENT) &&
2409 (params.height == LayoutParams.MATCH_PARENT);
svetoslavganov75986cf2009-05-14 22:28:01 -07002410 event.setFullScreen(isFullScreen);
2411
2412 CharSequence title = getTitle();
2413 if (!TextUtils.isEmpty(title)) {
2414 event.getText().add(title);
2415 }
2416
2417 return true;
2418 }
2419
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002420 /**
2421 * Default implementation of
2422 * {@link android.view.Window.Callback#onCreatePanelView}
2423 * for activities. This
2424 * simply returns null so that all panel sub-windows will have the default
2425 * menu behavior.
2426 */
2427 public View onCreatePanelView(int featureId) {
2428 return null;
2429 }
2430
2431 /**
2432 * Default implementation of
2433 * {@link android.view.Window.Callback#onCreatePanelMenu}
2434 * for activities. This calls through to the new
2435 * {@link #onCreateOptionsMenu} method for the
2436 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2437 * so that subclasses of Activity don't need to deal with feature codes.
2438 */
2439 public boolean onCreatePanelMenu(int featureId, Menu menu) {
2440 if (featureId == Window.FEATURE_OPTIONS_PANEL) {
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002441 boolean show = onCreateOptionsMenu(menu);
2442 show |= mFragments.dispatchCreateOptionsMenu(menu, getMenuInflater());
2443 return show;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002444 }
2445 return false;
2446 }
2447
2448 /**
2449 * Default implementation of
2450 * {@link android.view.Window.Callback#onPreparePanel}
2451 * for activities. This
2452 * calls through to the new {@link #onPrepareOptionsMenu} method for the
2453 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2454 * panel, so that subclasses of
2455 * Activity don't need to deal with feature codes.
2456 */
2457 public boolean onPreparePanel(int featureId, View view, Menu menu) {
2458 if (featureId == Window.FEATURE_OPTIONS_PANEL && menu != null) {
2459 boolean goforit = onPrepareOptionsMenu(menu);
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002460 goforit |= mFragments.dispatchPrepareOptionsMenu(menu);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002461 return goforit && menu.hasVisibleItems();
2462 }
2463 return true;
2464 }
2465
2466 /**
2467 * {@inheritDoc}
2468 *
2469 * @return The default implementation returns true.
2470 */
2471 public boolean onMenuOpened(int featureId, Menu menu) {
Adam Powell8515ee82010-11-30 14:09:55 -08002472 if (featureId == Window.FEATURE_ACTION_BAR) {
Adam Powell763cbb12011-03-01 10:45:34 -08002473 initActionBar();
Adam Powell049dd3d2010-12-02 13:43:59 -08002474 if (mActionBar != null) {
2475 mActionBar.dispatchMenuVisibilityChanged(true);
2476 } else {
2477 Log.e(TAG, "Tried to open action bar menu with no action bar");
2478 }
Adam Powell8515ee82010-11-30 14:09:55 -08002479 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002480 return true;
2481 }
2482
2483 /**
2484 * Default implementation of
2485 * {@link android.view.Window.Callback#onMenuItemSelected}
2486 * for activities. This calls through to the new
2487 * {@link #onOptionsItemSelected} method for the
2488 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2489 * panel, so that subclasses of
2490 * Activity don't need to deal with feature codes.
2491 */
2492 public boolean onMenuItemSelected(int featureId, MenuItem item) {
2493 switch (featureId) {
2494 case Window.FEATURE_OPTIONS_PANEL:
2495 // Put event logging here so it gets called even if subclass
2496 // doesn't call through to superclass's implmeentation of each
2497 // of these methods below
2498 EventLog.writeEvent(50000, 0, item.getTitleCondensed());
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002499 if (onOptionsItemSelected(item)) {
2500 return true;
2501 }
2502 return mFragments.dispatchOptionsItemSelected(item);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002503
2504 case Window.FEATURE_CONTEXT_MENU:
2505 EventLog.writeEvent(50000, 1, item.getTitleCondensed());
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07002506 if (onContextItemSelected(item)) {
2507 return true;
2508 }
2509 return mFragments.dispatchContextItemSelected(item);
Adam Powell8515ee82010-11-30 14:09:55 -08002510
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002511 default:
2512 return false;
2513 }
2514 }
2515
2516 /**
2517 * Default implementation of
2518 * {@link android.view.Window.Callback#onPanelClosed(int, Menu)} for
2519 * activities. This calls through to {@link #onOptionsMenuClosed(Menu)}
2520 * method for the {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2521 * so that subclasses of Activity don't need to deal with feature codes.
2522 * For context menus ({@link Window#FEATURE_CONTEXT_MENU}), the
2523 * {@link #onContextMenuClosed(Menu)} will be called.
2524 */
2525 public void onPanelClosed(int featureId, Menu menu) {
2526 switch (featureId) {
2527 case Window.FEATURE_OPTIONS_PANEL:
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002528 mFragments.dispatchOptionsMenuClosed(menu);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002529 onOptionsMenuClosed(menu);
2530 break;
2531
2532 case Window.FEATURE_CONTEXT_MENU:
2533 onContextMenuClosed(menu);
2534 break;
Adam Powell8515ee82010-11-30 14:09:55 -08002535
2536 case Window.FEATURE_ACTION_BAR:
Adam Powell9b4bee02011-04-27 19:24:47 -07002537 initActionBar();
Adam Powell8515ee82010-11-30 14:09:55 -08002538 mActionBar.dispatchMenuVisibilityChanged(false);
2539 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002540 }
2541 }
2542
2543 /**
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002544 * Declare that the options menu has changed, so should be recreated.
2545 * The {@link #onCreateOptionsMenu(Menu)} method will be called the next
2546 * time it needs to be displayed.
2547 */
2548 public void invalidateOptionsMenu() {
2549 mWindow.invalidatePanelMenu(Window.FEATURE_OPTIONS_PANEL);
2550 }
2551
2552 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002553 * Initialize the contents of the Activity's standard options menu. You
2554 * should place your menu items in to <var>menu</var>.
2555 *
2556 * <p>This is only called once, the first time the options menu is
2557 * displayed. To update the menu every time it is displayed, see
2558 * {@link #onPrepareOptionsMenu}.
2559 *
2560 * <p>The default implementation populates the menu with standard system
2561 * menu items. These are placed in the {@link Menu#CATEGORY_SYSTEM} group so that
2562 * they will be correctly ordered with application-defined menu items.
2563 * Deriving classes should always call through to the base implementation.
2564 *
2565 * <p>You can safely hold on to <var>menu</var> (and any items created
2566 * from it), making modifications to it as desired, until the next
2567 * time onCreateOptionsMenu() is called.
2568 *
2569 * <p>When you add items to the menu, you can implement the Activity's
2570 * {@link #onOptionsItemSelected} method to handle them there.
2571 *
2572 * @param menu The options menu in which you place your items.
2573 *
2574 * @return You must return true for the menu to be displayed;
2575 * if you return false it will not be shown.
2576 *
2577 * @see #onPrepareOptionsMenu
2578 * @see #onOptionsItemSelected
2579 */
2580 public boolean onCreateOptionsMenu(Menu menu) {
2581 if (mParent != null) {
2582 return mParent.onCreateOptionsMenu(menu);
2583 }
2584 return true;
2585 }
2586
2587 /**
2588 * Prepare the Screen's standard options menu to be displayed. This is
2589 * called right before the menu is shown, every time it is shown. You can
2590 * use this method to efficiently enable/disable items or otherwise
2591 * dynamically modify the contents.
2592 *
2593 * <p>The default implementation updates the system menu items based on the
2594 * activity's state. Deriving classes should always call through to the
2595 * base class implementation.
2596 *
2597 * @param menu The options menu as last shown or first initialized by
2598 * onCreateOptionsMenu().
2599 *
2600 * @return You must return true for the menu to be displayed;
2601 * if you return false it will not be shown.
2602 *
2603 * @see #onCreateOptionsMenu
2604 */
2605 public boolean onPrepareOptionsMenu(Menu menu) {
2606 if (mParent != null) {
2607 return mParent.onPrepareOptionsMenu(menu);
2608 }
2609 return true;
2610 }
2611
2612 /**
2613 * This hook is called whenever an item in your options menu is selected.
2614 * The default implementation simply returns false to have the normal
2615 * processing happen (calling the item's Runnable or sending a message to
2616 * its Handler as appropriate). You can use this method for any items
2617 * for which you would like to do processing without those other
2618 * facilities.
2619 *
2620 * <p>Derived classes should call through to the base class for it to
2621 * perform the default menu handling.
2622 *
2623 * @param item The menu item that was selected.
2624 *
2625 * @return boolean Return false to allow normal menu processing to
2626 * proceed, true to consume it here.
2627 *
2628 * @see #onCreateOptionsMenu
2629 */
2630 public boolean onOptionsItemSelected(MenuItem item) {
2631 if (mParent != null) {
2632 return mParent.onOptionsItemSelected(item);
2633 }
2634 return false;
2635 }
2636
2637 /**
2638 * This hook is called whenever the options menu is being closed (either by the user canceling
2639 * the menu with the back/menu button, or when an item is selected).
2640 *
2641 * @param menu The options menu as last shown or first initialized by
2642 * onCreateOptionsMenu().
2643 */
2644 public void onOptionsMenuClosed(Menu menu) {
2645 if (mParent != null) {
2646 mParent.onOptionsMenuClosed(menu);
2647 }
2648 }
2649
2650 /**
2651 * Programmatically opens the options menu. If the options menu is already
2652 * open, this method does nothing.
2653 */
2654 public void openOptionsMenu() {
2655 mWindow.openPanel(Window.FEATURE_OPTIONS_PANEL, null);
2656 }
2657
2658 /**
2659 * Progammatically closes the options menu. If the options menu is already
2660 * closed, this method does nothing.
2661 */
2662 public void closeOptionsMenu() {
2663 mWindow.closePanel(Window.FEATURE_OPTIONS_PANEL);
2664 }
2665
2666 /**
2667 * Called when a context menu for the {@code view} is about to be shown.
2668 * Unlike {@link #onCreateOptionsMenu(Menu)}, this will be called every
2669 * time the context menu is about to be shown and should be populated for
2670 * the view (or item inside the view for {@link AdapterView} subclasses,
2671 * this can be found in the {@code menuInfo})).
2672 * <p>
2673 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an
2674 * item has been selected.
2675 * <p>
2676 * It is not safe to hold onto the context menu after this method returns.
2677 * {@inheritDoc}
2678 */
2679 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {
2680 }
2681
2682 /**
2683 * Registers a context menu to be shown for the given view (multiple views
2684 * can show the context menu). This method will set the
2685 * {@link OnCreateContextMenuListener} on the view to this activity, so
2686 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be
2687 * called when it is time to show the context menu.
2688 *
2689 * @see #unregisterForContextMenu(View)
2690 * @param view The view that should show a context menu.
2691 */
2692 public void registerForContextMenu(View view) {
2693 view.setOnCreateContextMenuListener(this);
2694 }
2695
2696 /**
2697 * Prevents a context menu to be shown for the given view. This method will remove the
2698 * {@link OnCreateContextMenuListener} on the view.
2699 *
2700 * @see #registerForContextMenu(View)
2701 * @param view The view that should stop showing a context menu.
2702 */
2703 public void unregisterForContextMenu(View view) {
2704 view.setOnCreateContextMenuListener(null);
2705 }
2706
2707 /**
2708 * Programmatically opens the context menu for a particular {@code view}.
2709 * The {@code view} should have been added via
2710 * {@link #registerForContextMenu(View)}.
2711 *
2712 * @param view The view to show the context menu for.
2713 */
2714 public void openContextMenu(View view) {
2715 view.showContextMenu();
2716 }
2717
2718 /**
2719 * Programmatically closes the most recently opened context menu, if showing.
2720 */
2721 public void closeContextMenu() {
2722 mWindow.closePanel(Window.FEATURE_CONTEXT_MENU);
2723 }
2724
2725 /**
2726 * This hook is called whenever an item in a context menu is selected. The
2727 * default implementation simply returns false to have the normal processing
2728 * happen (calling the item's Runnable or sending a message to its Handler
2729 * as appropriate). You can use this method for any items for which you
2730 * would like to do processing without those other facilities.
2731 * <p>
2732 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the
2733 * View that added this menu item.
2734 * <p>
2735 * Derived classes should call through to the base class for it to perform
2736 * the default menu handling.
2737 *
2738 * @param item The context menu item that was selected.
2739 * @return boolean Return false to allow normal context menu processing to
2740 * proceed, true to consume it here.
2741 */
2742 public boolean onContextItemSelected(MenuItem item) {
2743 if (mParent != null) {
2744 return mParent.onContextItemSelected(item);
2745 }
2746 return false;
2747 }
2748
2749 /**
2750 * This hook is called whenever the context menu is being closed (either by
2751 * the user canceling the menu with the back/menu button, or when an item is
2752 * selected).
2753 *
2754 * @param menu The context menu that is being closed.
2755 */
2756 public void onContextMenuClosed(Menu menu) {
2757 if (mParent != null) {
2758 mParent.onContextMenuClosed(menu);
2759 }
2760 }
2761
2762 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002763 * @deprecated Old no-arguments version of {@link #onCreateDialog(int, Bundle)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002764 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002765 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002766 protected Dialog onCreateDialog(int id) {
2767 return null;
2768 }
2769
2770 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002771 * Callback for creating dialogs that are managed (saved and restored) for you
2772 * by the activity. The default implementation calls through to
2773 * {@link #onCreateDialog(int)} for compatibility.
2774 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07002775 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
2776 * or later, consider instead using a {@link DialogFragment} instead.</em>
2777 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002778 * <p>If you use {@link #showDialog(int)}, the activity will call through to
2779 * this method the first time, and hang onto it thereafter. Any dialog
2780 * that is created by this method will automatically be saved and restored
2781 * for you, including whether it is showing.
2782 *
2783 * <p>If you would like the activity to manage saving and restoring dialogs
2784 * for you, you should override this method and handle any ids that are
2785 * passed to {@link #showDialog}.
2786 *
2787 * <p>If you would like an opportunity to prepare your dialog before it is shown,
2788 * override {@link #onPrepareDialog(int, Dialog, Bundle)}.
2789 *
2790 * @param id The id of the dialog.
2791 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
2792 * @return The dialog. If you return null, the dialog will not be created.
2793 *
2794 * @see #onPrepareDialog(int, Dialog, Bundle)
2795 * @see #showDialog(int, Bundle)
2796 * @see #dismissDialog(int)
2797 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002798 *
2799 * @deprecated Use the new {@link DialogFragment} class with
2800 * {@link FragmentManager} instead; this is also
2801 * available on older platforms through the Android compatibility package.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002802 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07002803 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002804 protected Dialog onCreateDialog(int id, Bundle args) {
2805 return onCreateDialog(id);
2806 }
2807
2808 /**
2809 * @deprecated Old no-arguments version of
2810 * {@link #onPrepareDialog(int, Dialog, Bundle)}.
2811 */
2812 @Deprecated
2813 protected void onPrepareDialog(int id, Dialog dialog) {
2814 dialog.setOwnerActivity(this);
2815 }
2816
2817 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002818 * Provides an opportunity to prepare a managed dialog before it is being
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002819 * shown. The default implementation calls through to
2820 * {@link #onPrepareDialog(int, Dialog)} for compatibility.
2821 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002822 * <p>
2823 * Override this if you need to update a managed dialog based on the state
2824 * of the application each time it is shown. For example, a time picker
2825 * dialog might want to be updated with the current time. You should call
2826 * through to the superclass's implementation. The default implementation
2827 * will set this Activity as the owner activity on the Dialog.
2828 *
2829 * @param id The id of the managed dialog.
2830 * @param dialog The dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002831 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
2832 * @see #onCreateDialog(int, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002833 * @see #showDialog(int)
2834 * @see #dismissDialog(int)
2835 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002836 *
2837 * @deprecated Use the new {@link DialogFragment} class with
2838 * {@link FragmentManager} instead; this is also
2839 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002840 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07002841 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002842 protected void onPrepareDialog(int id, Dialog dialog, Bundle args) {
2843 onPrepareDialog(id, dialog);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002844 }
2845
2846 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002847 * Simple version of {@link #showDialog(int, Bundle)} that does not
2848 * take any arguments. Simply calls {@link #showDialog(int, Bundle)}
2849 * with null arguments.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002850 *
2851 * @deprecated Use the new {@link DialogFragment} class with
2852 * {@link FragmentManager} instead; this is also
2853 * available on older platforms through the Android compatibility package.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002854 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07002855 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002856 public final void showDialog(int id) {
2857 showDialog(id, null);
2858 }
2859
2860 /**
2861 * Show a dialog managed by this activity. A call to {@link #onCreateDialog(int, Bundle)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002862 * will be made with the same id the first time this is called for a given
2863 * id. From thereafter, the dialog will be automatically saved and restored.
2864 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07002865 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
2866 * or later, consider instead using a {@link DialogFragment} instead.</em>
2867 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002868 * <p>Each time a dialog is shown, {@link #onPrepareDialog(int, Dialog, Bundle)} will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002869 * be made to provide an opportunity to do any timely preparation.
2870 *
2871 * @param id The id of the managed dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002872 * @param args Arguments to pass through to the dialog. These will be saved
2873 * and restored for you. Note that if the dialog is already created,
2874 * {@link #onCreateDialog(int, Bundle)} will not be called with the new
2875 * arguments but {@link #onPrepareDialog(int, Dialog, Bundle)} will be.
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08002876 * If you need to rebuild the dialog, call {@link #removeDialog(int)} first.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002877 * @return Returns true if the Dialog was created; false is returned if
2878 * it is not created because {@link #onCreateDialog(int, Bundle)} returns false.
2879 *
Joe Onorato37296dc2009-07-31 17:58:55 -07002880 * @see Dialog
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002881 * @see #onCreateDialog(int, Bundle)
2882 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002883 * @see #dismissDialog(int)
2884 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002885 *
2886 * @deprecated Use the new {@link DialogFragment} class with
2887 * {@link FragmentManager} instead; this is also
2888 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002889 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07002890 @Deprecated
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002891 public final boolean showDialog(int id, Bundle args) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002892 if (mManagedDialogs == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002893 mManagedDialogs = new SparseArray<ManagedDialog>();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002894 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002895 ManagedDialog md = mManagedDialogs.get(id);
2896 if (md == null) {
2897 md = new ManagedDialog();
2898 md.mDialog = createDialog(id, null, args);
2899 if (md.mDialog == null) {
2900 return false;
2901 }
2902 mManagedDialogs.put(id, md);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002903 }
2904
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002905 md.mArgs = args;
2906 onPrepareDialog(id, md.mDialog, args);
2907 md.mDialog.show();
2908 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002909 }
2910
2911 /**
2912 * Dismiss a dialog that was previously shown via {@link #showDialog(int)}.
2913 *
2914 * @param id The id of the managed dialog.
2915 *
2916 * @throws IllegalArgumentException if the id was not previously shown via
2917 * {@link #showDialog(int)}.
2918 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002919 * @see #onCreateDialog(int, Bundle)
2920 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002921 * @see #showDialog(int)
2922 * @see #removeDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002923 *
2924 * @deprecated Use the new {@link DialogFragment} class with
2925 * {@link FragmentManager} instead; this is also
2926 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002927 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07002928 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002929 public final void dismissDialog(int id) {
2930 if (mManagedDialogs == null) {
2931 throw missingDialog(id);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002932 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002933
2934 final ManagedDialog md = mManagedDialogs.get(id);
2935 if (md == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002936 throw missingDialog(id);
2937 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002938 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002939 }
2940
2941 /**
2942 * Creates an exception to throw if a user passed in a dialog id that is
2943 * unexpected.
2944 */
2945 private IllegalArgumentException missingDialog(int id) {
2946 return new IllegalArgumentException("no dialog with id " + id + " was ever "
2947 + "shown via Activity#showDialog");
2948 }
2949
2950 /**
2951 * Removes any internal references to a dialog managed by this Activity.
2952 * If the dialog is showing, it will dismiss it as part of the clean up.
2953 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002954 * <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 -08002955 * want to avoid the overhead of saving and restoring it in the future.
2956 *
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07002957 * <p>As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}, this function
2958 * will not throw an exception if you try to remove an ID that does not
2959 * currently have an associated dialog.</p>
2960 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002961 * @param id The id of the managed dialog.
2962 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002963 * @see #onCreateDialog(int, Bundle)
2964 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002965 * @see #showDialog(int)
2966 * @see #dismissDialog(int)
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002967 *
2968 * @deprecated Use the new {@link DialogFragment} class with
2969 * {@link FragmentManager} instead; this is also
2970 * available on older platforms through the Android compatibility package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002971 */
Dianne Hackborn9567a662011-04-19 18:44:03 -07002972 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002973 public final void removeDialog(int id) {
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07002974 if (mManagedDialogs != null) {
2975 final ManagedDialog md = mManagedDialogs.get(id);
2976 if (md != null) {
2977 md.mDialog.dismiss();
2978 mManagedDialogs.remove(id);
2979 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002980 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002981 }
2982
2983 /**
2984 * This hook is called when the user signals the desire to start a search.
2985 *
Bjorn Bringert6266e402009-09-25 14:25:41 +01002986 * <p>You can use this function as a simple way to launch the search UI, in response to a
2987 * menu item, search button, or other widgets within your activity. Unless overidden,
2988 * calling this function is the same as calling
2989 * {@link #startSearch startSearch(null, false, null, false)}, which launches
2990 * search for the current activity as specified in its manifest, see {@link SearchManager}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002991 *
2992 * <p>You can override this function to force global search, e.g. in response to a dedicated
2993 * search key, or to block search entirely (by simply returning false).
2994 *
Bjorn Bringert6266e402009-09-25 14:25:41 +01002995 * @return Returns {@code true} if search launched, and {@code false} if activity blocks it.
2996 * The default implementation always returns {@code true}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002997 *
2998 * @see android.app.SearchManager
2999 */
3000 public boolean onSearchRequested() {
3001 startSearch(null, false, null, false);
3002 return true;
3003 }
3004
3005 /**
3006 * This hook is called to launch the search UI.
3007 *
3008 * <p>It is typically called from onSearchRequested(), either directly from
3009 * Activity.onSearchRequested() or from an overridden version in any given
3010 * Activity. If your goal is simply to activate search, it is preferred to call
3011 * onSearchRequested(), which may have been overriden elsewhere in your Activity. If your goal
3012 * is to inject specific data such as context data, it is preferred to <i>override</i>
3013 * onSearchRequested(), so that any callers to it will benefit from the override.
3014 *
3015 * @param initialQuery Any non-null non-empty string will be inserted as
3016 * pre-entered text in the search query box.
3017 * @param selectInitialQuery If true, the intial query will be preselected, which means that
3018 * any further typing will replace it. This is useful for cases where an entire pre-formed
3019 * query is being inserted. If false, the selection point will be placed at the end of the
3020 * inserted query. This is useful when the inserted query is text that the user entered,
3021 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful
3022 * if initialQuery is a non-empty string.</i>
3023 * @param appSearchData An application can insert application-specific
3024 * context here, in order to improve quality or specificity of its own
3025 * searches. This data will be returned with SEARCH intent(s). Null if
3026 * no extra data is required.
3027 * @param globalSearch If false, this will only launch the search that has been specifically
3028 * defined by the application (which is usually defined as a local search). If no default
Mike LeBeaucfa419b2009-08-17 10:56:02 -07003029 * search is defined in the current application or activity, global search will be launched.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003030 * If true, this will always launch a platform-global (e.g. web-based) search instead.
3031 *
3032 * @see android.app.SearchManager
3033 * @see #onSearchRequested
3034 */
3035 public void startSearch(String initialQuery, boolean selectInitialQuery,
3036 Bundle appSearchData, boolean globalSearch) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003037 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003038 mSearchManager.startSearch(initialQuery, selectInitialQuery, getComponentName(),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003039 appSearchData, globalSearch);
3040 }
3041
3042 /**
krosaend2d60142009-08-17 08:56:48 -07003043 * Similar to {@link #startSearch}, but actually fires off the search query after invoking
3044 * the search dialog. Made available for testing purposes.
3045 *
3046 * @param query The query to trigger. If empty, the request will be ignored.
3047 * @param appSearchData An application can insert application-specific
3048 * context here, in order to improve quality or specificity of its own
3049 * searches. This data will be returned with SEARCH intent(s). Null if
3050 * no extra data is required.
krosaend2d60142009-08-17 08:56:48 -07003051 */
Bjorn Bringertb782a2f2009-10-01 09:57:33 +01003052 public void triggerSearch(String query, Bundle appSearchData) {
krosaend2d60142009-08-17 08:56:48 -07003053 ensureSearchManager();
Bjorn Bringertb782a2f2009-10-01 09:57:33 +01003054 mSearchManager.triggerSearch(query, getComponentName(), appSearchData);
krosaend2d60142009-08-17 08:56:48 -07003055 }
3056
3057 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003058 * Request that key events come to this activity. Use this if your
3059 * activity has no views with focus, but the activity still wants
3060 * a chance to process key events.
3061 *
3062 * @see android.view.Window#takeKeyEvents
3063 */
3064 public void takeKeyEvents(boolean get) {
3065 getWindow().takeKeyEvents(get);
3066 }
3067
3068 /**
3069 * Enable extended window features. This is a convenience for calling
3070 * {@link android.view.Window#requestFeature getWindow().requestFeature()}.
3071 *
3072 * @param featureId The desired feature as defined in
3073 * {@link android.view.Window}.
3074 * @return Returns true if the requested feature is supported and now
3075 * enabled.
3076 *
3077 * @see android.view.Window#requestFeature
3078 */
3079 public final boolean requestWindowFeature(int featureId) {
3080 return getWindow().requestFeature(featureId);
3081 }
3082
3083 /**
3084 * Convenience for calling
3085 * {@link android.view.Window#setFeatureDrawableResource}.
3086 */
3087 public final void setFeatureDrawableResource(int featureId, int resId) {
3088 getWindow().setFeatureDrawableResource(featureId, resId);
3089 }
3090
3091 /**
3092 * Convenience for calling
3093 * {@link android.view.Window#setFeatureDrawableUri}.
3094 */
3095 public final void setFeatureDrawableUri(int featureId, Uri uri) {
3096 getWindow().setFeatureDrawableUri(featureId, uri);
3097 }
3098
3099 /**
3100 * Convenience for calling
3101 * {@link android.view.Window#setFeatureDrawable(int, Drawable)}.
3102 */
3103 public final void setFeatureDrawable(int featureId, Drawable drawable) {
3104 getWindow().setFeatureDrawable(featureId, drawable);
3105 }
3106
3107 /**
3108 * Convenience for calling
3109 * {@link android.view.Window#setFeatureDrawableAlpha}.
3110 */
3111 public final void setFeatureDrawableAlpha(int featureId, int alpha) {
3112 getWindow().setFeatureDrawableAlpha(featureId, alpha);
3113 }
3114
3115 /**
3116 * Convenience for calling
3117 * {@link android.view.Window#getLayoutInflater}.
3118 */
3119 public LayoutInflater getLayoutInflater() {
3120 return getWindow().getLayoutInflater();
3121 }
3122
3123 /**
3124 * Returns a {@link MenuInflater} with this context.
3125 */
3126 public MenuInflater getMenuInflater() {
Adam Powell88ab6972011-07-28 11:25:01 -07003127 // Make sure that action views can get an appropriate theme.
3128 if (mMenuInflater == null) {
3129 initActionBar();
3130 if (mActionBar != null) {
3131 mMenuInflater = new MenuInflater(mActionBar.getThemedContext());
3132 } else {
3133 mMenuInflater = new MenuInflater(this);
3134 }
3135 }
3136 return mMenuInflater;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003137 }
3138
3139 @Override
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003140 protected void onApplyThemeResource(Resources.Theme theme, int resid,
3141 boolean first) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003142 if (mParent == null) {
3143 super.onApplyThemeResource(theme, resid, first);
3144 } else {
3145 try {
3146 theme.setTo(mParent.getTheme());
3147 } catch (Exception e) {
3148 // Empty
3149 }
3150 theme.applyStyle(resid, false);
3151 }
3152 }
3153
3154 /**
3155 * Launch an activity for which you would like a result when it finished.
3156 * When this activity exits, your
3157 * onActivityResult() method will be called with the given requestCode.
3158 * Using a negative requestCode is the same as calling
3159 * {@link #startActivity} (the activity is not launched as a sub-activity).
3160 *
3161 * <p>Note that this method should only be used with Intent protocols
3162 * that are defined to return a result. In other protocols (such as
3163 * {@link Intent#ACTION_MAIN} or {@link Intent#ACTION_VIEW}), you may
3164 * not get the result when you expect. For example, if the activity you
3165 * are launching uses the singleTask launch mode, it will not run in your
3166 * task and thus you will immediately receive a cancel result.
3167 *
3168 * <p>As a special case, if you call startActivityForResult() with a requestCode
3169 * >= 0 during the initial onCreate(Bundle savedInstanceState)/onResume() of your
3170 * activity, then your window will not be displayed until a result is
3171 * returned back from the started activity. This is to avoid visible
3172 * flickering when redirecting to another activity.
3173 *
3174 * <p>This method throws {@link android.content.ActivityNotFoundException}
3175 * if there was no Activity found to run the given Intent.
3176 *
3177 * @param intent The intent to start.
3178 * @param requestCode If >= 0, this code will be returned in
3179 * onActivityResult() when the activity exits.
3180 *
3181 * @throws android.content.ActivityNotFoundException
3182 *
3183 * @see #startActivity
3184 */
3185 public void startActivityForResult(Intent intent, int requestCode) {
3186 if (mParent == null) {
3187 Instrumentation.ActivityResult ar =
3188 mInstrumentation.execStartActivity(
3189 this, mMainThread.getApplicationThread(), mToken, this,
3190 intent, requestCode);
3191 if (ar != null) {
3192 mMainThread.sendActivityResult(
3193 mToken, mEmbeddedID, requestCode, ar.getResultCode(),
3194 ar.getResultData());
3195 }
3196 if (requestCode >= 0) {
3197 // If this start is requesting a result, we can avoid making
3198 // the activity visible until the result is received. Setting
3199 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3200 // activity hidden during this time, to avoid flickering.
3201 // This can only be done when a result is requested because
3202 // that guarantees we will get information back when the
3203 // activity is finished, no matter what happens to it.
3204 mStartedActivity = true;
3205 }
3206 } else {
3207 mParent.startActivityFromChild(this, intent, requestCode);
3208 }
3209 }
3210
3211 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003212 * Like {@link #startActivityForResult(Intent, int)}, but allowing you
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003213 * to use a IntentSender to describe the activity to be started. If
3214 * the IntentSender is for an activity, that activity will be started
3215 * as if you had called the regular {@link #startActivityForResult(Intent, int)}
3216 * here; otherwise, its associated action will be executed (such as
3217 * sending a broadcast) as if you had called
3218 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003219 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003220 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003221 * @param requestCode If >= 0, this code will be returned in
3222 * onActivityResult() when the activity exits.
3223 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003224 * intent parameter to {@link IntentSender#sendIntent}.
3225 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003226 * would like to change.
3227 * @param flagsValues Desired values for any bits set in
3228 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003229 * @param extraFlags Always set to 0.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003230 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003231 public void startIntentSenderForResult(IntentSender intent, int requestCode,
3232 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
3233 throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003234 if (mParent == null) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003235 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003236 flagsMask, flagsValues, this);
3237 } else {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003238 mParent.startIntentSenderFromChild(this, intent, requestCode,
3239 fillInIntent, flagsMask, flagsValues, extraFlags);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003240 }
3241 }
3242
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003243 private void startIntentSenderForResultInner(IntentSender intent, int requestCode,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003244 Intent fillInIntent, int flagsMask, int flagsValues, Activity activity)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003245 throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003246 try {
3247 String resolvedType = null;
3248 if (fillInIntent != null) {
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003249 fillInIntent.setAllowFds(false);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003250 resolvedType = fillInIntent.resolveTypeIfNeeded(getContentResolver());
3251 }
3252 int result = ActivityManagerNative.getDefault()
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003253 .startActivityIntentSender(mMainThread.getApplicationThread(), intent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003254 fillInIntent, resolvedType, mToken, activity.mEmbeddedID,
3255 requestCode, flagsMask, flagsValues);
3256 if (result == IActivityManager.START_CANCELED) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003257 throw new IntentSender.SendIntentException();
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003258 }
3259 Instrumentation.checkStartActivityResult(result, null);
3260 } catch (RemoteException e) {
3261 }
3262 if (requestCode >= 0) {
3263 // If this start is requesting a result, we can avoid making
3264 // the activity visible until the result is received. Setting
3265 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3266 // activity hidden during this time, to avoid flickering.
3267 // This can only be done when a result is requested because
3268 // that guarantees we will get information back when the
3269 // activity is finished, no matter what happens to it.
3270 mStartedActivity = true;
3271 }
3272 }
3273
3274 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003275 * Launch a new activity. You will not receive any information about when
3276 * the activity exits. This implementation overrides the base version,
3277 * providing information about
3278 * the activity performing the launch. Because of this additional
3279 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not
3280 * required; if not specified, the new activity will be added to the
3281 * task of the caller.
3282 *
3283 * <p>This method throws {@link android.content.ActivityNotFoundException}
3284 * if there was no Activity found to run the given Intent.
3285 *
3286 * @param intent The intent to start.
3287 *
3288 * @throws android.content.ActivityNotFoundException
3289 *
3290 * @see #startActivityForResult
3291 */
3292 @Override
3293 public void startActivity(Intent intent) {
3294 startActivityForResult(intent, -1);
3295 }
3296
3297 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003298 * Launch a new activity. You will not receive any information about when
3299 * the activity exits. This implementation overrides the base version,
3300 * providing information about
3301 * the activity performing the launch. Because of this additional
3302 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not
3303 * required; if not specified, the new activity will be added to the
3304 * task of the caller.
3305 *
3306 * <p>This method throws {@link android.content.ActivityNotFoundException}
3307 * if there was no Activity found to run the given Intent.
3308 *
3309 * @param intents The intents to start.
3310 *
3311 * @throws android.content.ActivityNotFoundException
3312 *
3313 * @see #startActivityForResult
3314 */
3315 @Override
3316 public void startActivities(Intent[] intents) {
3317 mInstrumentation.execStartActivities(this, mMainThread.getApplicationThread(),
3318 mToken, this, intents);
3319 }
3320
3321 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003322 * Like {@link #startActivity(Intent)}, but taking a IntentSender
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003323 * to start; see
Dianne Hackbornae22c052009-09-17 18:46:22 -07003324 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)}
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003325 * for more information.
3326 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003327 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003328 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003329 * intent parameter to {@link IntentSender#sendIntent}.
3330 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003331 * would like to change.
3332 * @param flagsValues Desired values for any bits set in
3333 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003334 * @param extraFlags Always set to 0.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003335 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003336 public void startIntentSender(IntentSender intent,
3337 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
3338 throws IntentSender.SendIntentException {
3339 startIntentSenderForResult(intent, -1, fillInIntent, flagsMask,
3340 flagsValues, extraFlags);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003341 }
3342
3343 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003344 * A special variation to launch an activity only if a new activity
3345 * instance is needed to handle the given Intent. In other words, this is
3346 * just like {@link #startActivityForResult(Intent, int)} except: if you are
3347 * using the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} flag, or
3348 * singleTask or singleTop
3349 * {@link android.R.styleable#AndroidManifestActivity_launchMode launchMode},
3350 * and the activity
3351 * that handles <var>intent</var> is the same as your currently running
3352 * activity, then a new instance is not needed. In this case, instead of
3353 * the normal behavior of calling {@link #onNewIntent} this function will
3354 * return and you can handle the Intent yourself.
3355 *
3356 * <p>This function can only be called from a top-level activity; if it is
3357 * called from a child activity, a runtime exception will be thrown.
3358 *
3359 * @param intent The intent to start.
3360 * @param requestCode If >= 0, this code will be returned in
3361 * onActivityResult() when the activity exits, as described in
3362 * {@link #startActivityForResult}.
3363 *
3364 * @return If a new activity was launched then true is returned; otherwise
3365 * false is returned and you must handle the Intent yourself.
3366 *
3367 * @see #startActivity
3368 * @see #startActivityForResult
3369 */
3370 public boolean startActivityIfNeeded(Intent intent, int requestCode) {
3371 if (mParent == null) {
3372 int result = IActivityManager.START_RETURN_INTENT_TO_CALLER;
3373 try {
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003374 intent.setAllowFds(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003375 result = ActivityManagerNative.getDefault()
3376 .startActivity(mMainThread.getApplicationThread(),
3377 intent, intent.resolveTypeIfNeeded(
3378 getContentResolver()),
3379 null, 0,
Dianne Hackborn62f20ec2011-08-15 17:40:28 -07003380 mToken, mEmbeddedID, requestCode, true, false,
3381 null, null, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003382 } catch (RemoteException e) {
3383 // Empty
3384 }
3385
3386 Instrumentation.checkStartActivityResult(result, intent);
3387
3388 if (requestCode >= 0) {
3389 // If this start is requesting a result, we can avoid making
3390 // the activity visible until the result is received. Setting
3391 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3392 // activity hidden during this time, to avoid flickering.
3393 // This can only be done when a result is requested because
3394 // that guarantees we will get information back when the
3395 // activity is finished, no matter what happens to it.
3396 mStartedActivity = true;
3397 }
3398 return result != IActivityManager.START_RETURN_INTENT_TO_CALLER;
3399 }
3400
3401 throw new UnsupportedOperationException(
3402 "startActivityIfNeeded can only be called from a top-level activity");
3403 }
3404
3405 /**
3406 * Special version of starting an activity, for use when you are replacing
3407 * other activity components. You can use this to hand the Intent off
3408 * to the next Activity that can handle it. You typically call this in
3409 * {@link #onCreate} with the Intent returned by {@link #getIntent}.
3410 *
3411 * @param intent The intent to dispatch to the next activity. For
3412 * correct behavior, this must be the same as the Intent that started
3413 * your own activity; the only changes you can make are to the extras
3414 * inside of it.
3415 *
3416 * @return Returns a boolean indicating whether there was another Activity
3417 * to start: true if there was a next activity to start, false if there
3418 * wasn't. In general, if true is returned you will then want to call
3419 * finish() on yourself.
3420 */
3421 public boolean startNextMatchingActivity(Intent intent) {
3422 if (mParent == null) {
3423 try {
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003424 intent.setAllowFds(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003425 return ActivityManagerNative.getDefault()
3426 .startNextMatchingActivity(mToken, intent);
3427 } catch (RemoteException e) {
3428 // Empty
3429 }
3430 return false;
3431 }
3432
3433 throw new UnsupportedOperationException(
3434 "startNextMatchingActivity can only be called from a top-level activity");
3435 }
3436
3437 /**
3438 * This is called when a child activity of this one calls its
3439 * {@link #startActivity} or {@link #startActivityForResult} method.
3440 *
3441 * <p>This method throws {@link android.content.ActivityNotFoundException}
3442 * if there was no Activity found to run the given Intent.
3443 *
3444 * @param child The activity making the call.
3445 * @param intent The intent to start.
3446 * @param requestCode Reply request code. < 0 if reply is not requested.
3447 *
3448 * @throws android.content.ActivityNotFoundException
3449 *
3450 * @see #startActivity
3451 * @see #startActivityForResult
3452 */
3453 public void startActivityFromChild(Activity child, Intent intent,
3454 int requestCode) {
3455 Instrumentation.ActivityResult ar =
3456 mInstrumentation.execStartActivity(
3457 this, mMainThread.getApplicationThread(), mToken, child,
3458 intent, requestCode);
3459 if (ar != null) {
3460 mMainThread.sendActivityResult(
3461 mToken, child.mEmbeddedID, requestCode,
3462 ar.getResultCode(), ar.getResultData());
3463 }
3464 }
3465
3466 /**
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07003467 * This is called when a Fragment in this activity calls its
3468 * {@link Fragment#startActivity} or {@link Fragment#startActivityForResult}
3469 * method.
3470 *
3471 * <p>This method throws {@link android.content.ActivityNotFoundException}
3472 * if there was no Activity found to run the given Intent.
3473 *
3474 * @param fragment The fragment making the call.
3475 * @param intent The intent to start.
3476 * @param requestCode Reply request code. < 0 if reply is not requested.
3477 *
3478 * @throws android.content.ActivityNotFoundException
3479 *
3480 * @see Fragment#startActivity
3481 * @see Fragment#startActivityForResult
3482 */
3483 public void startActivityFromFragment(Fragment fragment, Intent intent,
3484 int requestCode) {
3485 Instrumentation.ActivityResult ar =
3486 mInstrumentation.execStartActivity(
3487 this, mMainThread.getApplicationThread(), mToken, fragment,
3488 intent, requestCode);
3489 if (ar != null) {
3490 mMainThread.sendActivityResult(
3491 mToken, fragment.mWho, requestCode,
3492 ar.getResultCode(), ar.getResultData());
3493 }
3494 }
3495
3496 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003497 * Like {@link #startActivityFromChild(Activity, Intent, int)}, but
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003498 * taking a IntentSender; see
Dianne Hackbornae22c052009-09-17 18:46:22 -07003499 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)}
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003500 * for more information.
3501 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003502 public void startIntentSenderFromChild(Activity child, IntentSender intent,
3503 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues,
3504 int extraFlags)
3505 throws IntentSender.SendIntentException {
3506 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003507 flagsMask, flagsValues, child);
3508 }
3509
3510 /**
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003511 * Call immediately after one of the flavors of {@link #startActivity(Intent)}
3512 * or {@link #finish} to specify an explicit transition animation to
3513 * perform next.
3514 * @param enterAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07003515 * the incoming activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003516 * @param exitAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07003517 * the outgoing activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003518 */
3519 public void overridePendingTransition(int enterAnim, int exitAnim) {
3520 try {
3521 ActivityManagerNative.getDefault().overridePendingTransition(
3522 mToken, getPackageName(), enterAnim, exitAnim);
3523 } catch (RemoteException e) {
3524 }
3525 }
3526
3527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003528 * Call this to set the result that your activity will return to its
3529 * caller.
3530 *
3531 * @param resultCode The result code to propagate back to the originating
3532 * activity, often RESULT_CANCELED or RESULT_OK
3533 *
3534 * @see #RESULT_CANCELED
3535 * @see #RESULT_OK
3536 * @see #RESULT_FIRST_USER
3537 * @see #setResult(int, Intent)
3538 */
3539 public final void setResult(int resultCode) {
3540 synchronized (this) {
3541 mResultCode = resultCode;
3542 mResultData = null;
3543 }
3544 }
3545
3546 /**
3547 * Call this to set the result that your activity will return to its
3548 * caller.
3549 *
3550 * @param resultCode The result code to propagate back to the originating
3551 * activity, often RESULT_CANCELED or RESULT_OK
3552 * @param data The data to propagate back to the originating activity.
3553 *
3554 * @see #RESULT_CANCELED
3555 * @see #RESULT_OK
3556 * @see #RESULT_FIRST_USER
3557 * @see #setResult(int)
3558 */
3559 public final void setResult(int resultCode, Intent data) {
3560 synchronized (this) {
3561 mResultCode = resultCode;
3562 mResultData = data;
3563 }
3564 }
3565
3566 /**
3567 * Return the name of the package that invoked this activity. This is who
3568 * the data in {@link #setResult setResult()} will be sent to. You can
3569 * use this information to validate that the recipient is allowed to
3570 * receive the data.
3571 *
3572 * <p>Note: if the calling activity is not expecting a result (that is it
3573 * did not use the {@link #startActivityForResult}
3574 * form that includes a request code), then the calling package will be
3575 * null.
3576 *
3577 * @return The package of the activity that will receive your
3578 * reply, or null if none.
3579 */
3580 public String getCallingPackage() {
3581 try {
3582 return ActivityManagerNative.getDefault().getCallingPackage(mToken);
3583 } catch (RemoteException e) {
3584 return null;
3585 }
3586 }
3587
3588 /**
3589 * Return the name of the activity that invoked this activity. This is
3590 * who the data in {@link #setResult setResult()} will be sent to. You
3591 * can use this information to validate that the recipient is allowed to
3592 * receive the data.
3593 *
3594 * <p>Note: if the calling activity is not expecting a result (that is it
3595 * did not use the {@link #startActivityForResult}
3596 * form that includes a request code), then the calling package will be
3597 * null.
3598 *
3599 * @return String The full name of the activity that will receive your
3600 * reply, or null if none.
3601 */
3602 public ComponentName getCallingActivity() {
3603 try {
3604 return ActivityManagerNative.getDefault().getCallingActivity(mToken);
3605 } catch (RemoteException e) {
3606 return null;
3607 }
3608 }
3609
3610 /**
3611 * Control whether this activity's main window is visible. This is intended
3612 * only for the special case of an activity that is not going to show a
3613 * UI itself, but can't just finish prior to onResume() because it needs
3614 * to wait for a service binding or such. Setting this to false allows
3615 * you to prevent your UI from being shown during that time.
3616 *
3617 * <p>The default value for this is taken from the
3618 * {@link android.R.attr#windowNoDisplay} attribute of the activity's theme.
3619 */
3620 public void setVisible(boolean visible) {
3621 if (mVisibleFromClient != visible) {
3622 mVisibleFromClient = visible;
3623 if (mVisibleFromServer) {
3624 if (visible) makeVisible();
3625 else mDecor.setVisibility(View.INVISIBLE);
3626 }
3627 }
3628 }
3629
3630 void makeVisible() {
3631 if (!mWindowAdded) {
3632 ViewManager wm = getWindowManager();
3633 wm.addView(mDecor, getWindow().getAttributes());
3634 mWindowAdded = true;
3635 }
3636 mDecor.setVisibility(View.VISIBLE);
3637 }
3638
3639 /**
3640 * Check to see whether this activity is in the process of finishing,
3641 * either because you called {@link #finish} on it or someone else
3642 * has requested that it finished. This is often used in
3643 * {@link #onPause} to determine whether the activity is simply pausing or
3644 * completely finishing.
3645 *
3646 * @return If the activity is finishing, returns true; else returns false.
3647 *
3648 * @see #finish
3649 */
3650 public boolean isFinishing() {
3651 return mFinished;
3652 }
3653
3654 /**
Jeff Hamilton3d32f6e2010-04-01 00:04:16 -05003655 * Check to see whether this activity is in the process of being destroyed in order to be
3656 * recreated with a new configuration. This is often used in
3657 * {@link #onStop} to determine whether the state needs to be cleaned up or will be passed
3658 * on to the next instance of the activity via {@link #onRetainNonConfigurationInstance()}.
3659 *
3660 * @return If the activity is being torn down in order to be recreated with a new configuration,
3661 * returns true; else returns false.
3662 */
3663 public boolean isChangingConfigurations() {
3664 return mChangingConfigurations;
3665 }
3666
3667 /**
Dianne Hackborn30c9bd82010-12-01 16:07:40 -08003668 * Cause this Activity to be recreated with a new instance. This results
3669 * in essentially the same flow as when the Activity is created due to
3670 * a configuration change -- the current instance will go through its
3671 * lifecycle to {@link #onDestroy} and a new instance then created after it.
3672 */
3673 public void recreate() {
3674 if (mParent != null) {
3675 throw new IllegalStateException("Can only be called on top-level activity");
3676 }
3677 if (Looper.myLooper() != mMainThread.getLooper()) {
3678 throw new IllegalStateException("Must be called from main thread");
3679 }
3680 mMainThread.requestRelaunchActivity(mToken, null, null, 0, false, null, false);
3681 }
3682
3683 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003684 * Call this when your activity is done and should be closed. The
3685 * ActivityResult is propagated back to whoever launched you via
3686 * onActivityResult().
3687 */
3688 public void finish() {
3689 if (mParent == null) {
3690 int resultCode;
3691 Intent resultData;
3692 synchronized (this) {
3693 resultCode = mResultCode;
3694 resultData = mResultData;
3695 }
Joe Onorato43a17652011-04-06 19:22:23 -07003696 if (false) Log.v(TAG, "Finishing self: token=" + mToken);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003697 try {
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003698 if (resultData != null) {
3699 resultData.setAllowFds(false);
3700 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003701 if (ActivityManagerNative.getDefault()
3702 .finishActivity(mToken, resultCode, resultData)) {
3703 mFinished = true;
3704 }
3705 } catch (RemoteException e) {
3706 // Empty
3707 }
3708 } else {
3709 mParent.finishFromChild(this);
3710 }
3711 }
3712
3713 /**
3714 * This is called when a child activity of this one calls its
3715 * {@link #finish} method. The default implementation simply calls
3716 * finish() on this activity (the parent), finishing the entire group.
3717 *
3718 * @param child The activity making the call.
3719 *
3720 * @see #finish
3721 */
3722 public void finishFromChild(Activity child) {
3723 finish();
3724 }
3725
3726 /**
3727 * Force finish another activity that you had previously started with
3728 * {@link #startActivityForResult}.
3729 *
3730 * @param requestCode The request code of the activity that you had
3731 * given to startActivityForResult(). If there are multiple
3732 * activities started with this request code, they
3733 * will all be finished.
3734 */
3735 public void finishActivity(int requestCode) {
3736 if (mParent == null) {
3737 try {
3738 ActivityManagerNative.getDefault()
3739 .finishSubActivity(mToken, mEmbeddedID, requestCode);
3740 } catch (RemoteException e) {
3741 // Empty
3742 }
3743 } else {
3744 mParent.finishActivityFromChild(this, requestCode);
3745 }
3746 }
3747
3748 /**
3749 * This is called when a child activity of this one calls its
3750 * finishActivity().
3751 *
3752 * @param child The activity making the call.
3753 * @param requestCode Request code that had been used to start the
3754 * activity.
3755 */
3756 public void finishActivityFromChild(Activity child, int requestCode) {
3757 try {
3758 ActivityManagerNative.getDefault()
3759 .finishSubActivity(mToken, child.mEmbeddedID, requestCode);
3760 } catch (RemoteException e) {
3761 // Empty
3762 }
3763 }
3764
3765 /**
3766 * Called when an activity you launched exits, giving you the requestCode
3767 * you started it with, the resultCode it returned, and any additional
3768 * data from it. The <var>resultCode</var> will be
3769 * {@link #RESULT_CANCELED} if the activity explicitly returned that,
3770 * didn't return any result, or crashed during its operation.
3771 *
3772 * <p>You will receive this call immediately before onResume() when your
3773 * activity is re-starting.
3774 *
3775 * @param requestCode The integer request code originally supplied to
3776 * startActivityForResult(), allowing you to identify who this
3777 * result came from.
3778 * @param resultCode The integer result code returned by the child activity
3779 * through its setResult().
3780 * @param data An Intent, which can return result data to the caller
3781 * (various data can be attached to Intent "extras").
3782 *
3783 * @see #startActivityForResult
3784 * @see #createPendingResult
3785 * @see #setResult(int)
3786 */
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07003787 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003788 }
3789
3790 /**
3791 * Create a new PendingIntent object which you can hand to others
3792 * for them to use to send result data back to your
3793 * {@link #onActivityResult} callback. The created object will be either
3794 * one-shot (becoming invalid after a result is sent back) or multiple
3795 * (allowing any number of results to be sent through it).
3796 *
3797 * @param requestCode Private request code for the sender that will be
3798 * associated with the result data when it is returned. The sender can not
3799 * modify this value, allowing you to identify incoming results.
3800 * @param data Default data to supply in the result, which may be modified
3801 * by the sender.
3802 * @param flags May be {@link PendingIntent#FLAG_ONE_SHOT PendingIntent.FLAG_ONE_SHOT},
3803 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE},
3804 * {@link PendingIntent#FLAG_CANCEL_CURRENT PendingIntent.FLAG_CANCEL_CURRENT},
3805 * {@link PendingIntent#FLAG_UPDATE_CURRENT PendingIntent.FLAG_UPDATE_CURRENT},
3806 * or any of the flags as supported by
3807 * {@link Intent#fillIn Intent.fillIn()} to control which unspecified parts
3808 * of the intent that can be supplied when the actual send happens.
3809 *
3810 * @return Returns an existing or new PendingIntent matching the given
3811 * parameters. May return null only if
3812 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE} has been
3813 * supplied.
3814 *
3815 * @see PendingIntent
3816 */
3817 public PendingIntent createPendingResult(int requestCode, Intent data,
3818 int flags) {
3819 String packageName = getPackageName();
3820 try {
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003821 data.setAllowFds(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003822 IIntentSender target =
3823 ActivityManagerNative.getDefault().getIntentSender(
3824 IActivityManager.INTENT_SENDER_ACTIVITY_RESULT, packageName,
3825 mParent == null ? mToken : mParent.mToken,
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003826 mEmbeddedID, requestCode, new Intent[] { data }, null, flags);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003827 return target != null ? new PendingIntent(target) : null;
3828 } catch (RemoteException e) {
3829 // Empty
3830 }
3831 return null;
3832 }
3833
3834 /**
3835 * Change the desired orientation of this activity. If the activity
3836 * is currently in the foreground or otherwise impacting the screen
3837 * orientation, the screen will immediately be changed (possibly causing
3838 * the activity to be restarted). Otherwise, this will be used the next
3839 * time the activity is visible.
3840 *
3841 * @param requestedOrientation An orientation constant as used in
3842 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
3843 */
3844 public void setRequestedOrientation(int requestedOrientation) {
3845 if (mParent == null) {
3846 try {
3847 ActivityManagerNative.getDefault().setRequestedOrientation(
3848 mToken, requestedOrientation);
3849 } catch (RemoteException e) {
3850 // Empty
3851 }
3852 } else {
3853 mParent.setRequestedOrientation(requestedOrientation);
3854 }
3855 }
3856
3857 /**
3858 * Return the current requested orientation of the activity. This will
3859 * either be the orientation requested in its component's manifest, or
3860 * the last requested orientation given to
3861 * {@link #setRequestedOrientation(int)}.
3862 *
3863 * @return Returns an orientation constant as used in
3864 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
3865 */
3866 public int getRequestedOrientation() {
3867 if (mParent == null) {
3868 try {
3869 return ActivityManagerNative.getDefault()
3870 .getRequestedOrientation(mToken);
3871 } catch (RemoteException e) {
3872 // Empty
3873 }
3874 } else {
3875 return mParent.getRequestedOrientation();
3876 }
3877 return ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED;
3878 }
3879
3880 /**
3881 * Return the identifier of the task this activity is in. This identifier
3882 * will remain the same for the lifetime of the activity.
3883 *
3884 * @return Task identifier, an opaque integer.
3885 */
3886 public int getTaskId() {
3887 try {
3888 return ActivityManagerNative.getDefault()
3889 .getTaskForActivity(mToken, false);
3890 } catch (RemoteException e) {
3891 return -1;
3892 }
3893 }
3894
3895 /**
3896 * Return whether this activity is the root of a task. The root is the
3897 * first activity in a task.
3898 *
3899 * @return True if this is the root activity, else false.
3900 */
3901 public boolean isTaskRoot() {
3902 try {
3903 return ActivityManagerNative.getDefault()
3904 .getTaskForActivity(mToken, true) >= 0;
3905 } catch (RemoteException e) {
3906 return false;
3907 }
3908 }
3909
3910 /**
3911 * Move the task containing this activity to the back of the activity
3912 * stack. The activity's order within the task is unchanged.
3913 *
3914 * @param nonRoot If false then this only works if the activity is the root
3915 * of a task; if true it will work for any activity in
3916 * a task.
3917 *
3918 * @return If the task was moved (or it was already at the
3919 * back) true is returned, else false.
3920 */
3921 public boolean moveTaskToBack(boolean nonRoot) {
3922 try {
3923 return ActivityManagerNative.getDefault().moveActivityTaskToBack(
3924 mToken, nonRoot);
3925 } catch (RemoteException e) {
3926 // Empty
3927 }
3928 return false;
3929 }
3930
3931 /**
3932 * Returns class name for this activity with the package prefix removed.
3933 * This is the default name used to read and write settings.
3934 *
3935 * @return The local class name.
3936 */
3937 public String getLocalClassName() {
3938 final String pkg = getPackageName();
3939 final String cls = mComponent.getClassName();
3940 int packageLen = pkg.length();
3941 if (!cls.startsWith(pkg) || cls.length() <= packageLen
3942 || cls.charAt(packageLen) != '.') {
3943 return cls;
3944 }
3945 return cls.substring(packageLen+1);
3946 }
3947
3948 /**
3949 * Returns complete component name of this activity.
3950 *
3951 * @return Returns the complete component name for this activity
3952 */
3953 public ComponentName getComponentName()
3954 {
3955 return mComponent;
3956 }
3957
3958 /**
3959 * Retrieve a {@link SharedPreferences} object for accessing preferences
3960 * that are private to this activity. This simply calls the underlying
3961 * {@link #getSharedPreferences(String, int)} method by passing in this activity's
3962 * class name as the preferences name.
3963 *
3964 * @param mode Operating mode. Use {@link #MODE_PRIVATE} for the default
3965 * operation, {@link #MODE_WORLD_READABLE} and
3966 * {@link #MODE_WORLD_WRITEABLE} to control permissions.
3967 *
3968 * @return Returns the single SharedPreferences instance that can be used
3969 * to retrieve and modify the preference values.
3970 */
3971 public SharedPreferences getPreferences(int mode) {
3972 return getSharedPreferences(getLocalClassName(), mode);
3973 }
3974
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003975 private void ensureSearchManager() {
3976 if (mSearchManager != null) {
3977 return;
3978 }
3979
Amith Yamasanie9ce3f02010-01-25 09:15:50 -08003980 mSearchManager = new SearchManager(this, null);
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003981 }
3982
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003983 @Override
3984 public Object getSystemService(String name) {
3985 if (getBaseContext() == null) {
3986 throw new IllegalStateException(
3987 "System services not available to Activities before onCreate()");
3988 }
3989
3990 if (WINDOW_SERVICE.equals(name)) {
3991 return mWindowManager;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003992 } else if (SEARCH_SERVICE.equals(name)) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003993 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003994 return mSearchManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003995 }
3996 return super.getSystemService(name);
3997 }
3998
3999 /**
4000 * Change the title associated with this activity. If this is a
4001 * top-level activity, the title for its window will change. If it
4002 * is an embedded activity, the parent can do whatever it wants
4003 * with it.
4004 */
4005 public void setTitle(CharSequence title) {
4006 mTitle = title;
4007 onTitleChanged(title, mTitleColor);
4008
4009 if (mParent != null) {
4010 mParent.onChildTitleChanged(this, title);
4011 }
4012 }
4013
4014 /**
4015 * Change the title associated with this activity. If this is a
4016 * top-level activity, the title for its window will change. If it
4017 * is an embedded activity, the parent can do whatever it wants
4018 * with it.
4019 */
4020 public void setTitle(int titleId) {
4021 setTitle(getText(titleId));
4022 }
4023
4024 public void setTitleColor(int textColor) {
4025 mTitleColor = textColor;
4026 onTitleChanged(mTitle, textColor);
4027 }
4028
4029 public final CharSequence getTitle() {
4030 return mTitle;
4031 }
4032
4033 public final int getTitleColor() {
4034 return mTitleColor;
4035 }
4036
4037 protected void onTitleChanged(CharSequence title, int color) {
4038 if (mTitleReady) {
4039 final Window win = getWindow();
4040 if (win != null) {
4041 win.setTitle(title);
4042 if (color != 0) {
4043 win.setTitleColor(color);
4044 }
4045 }
4046 }
4047 }
4048
4049 protected void onChildTitleChanged(Activity childActivity, CharSequence title) {
4050 }
4051
4052 /**
4053 * Sets the visibility of the progress bar in the title.
4054 * <p>
4055 * In order for the progress bar to be shown, the feature must be requested
4056 * via {@link #requestWindowFeature(int)}.
4057 *
4058 * @param visible Whether to show the progress bars in the title.
4059 */
4060 public final void setProgressBarVisibility(boolean visible) {
4061 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, visible ? Window.PROGRESS_VISIBILITY_ON :
4062 Window.PROGRESS_VISIBILITY_OFF);
4063 }
4064
4065 /**
4066 * Sets the visibility of the indeterminate progress bar in the title.
4067 * <p>
4068 * In order for the progress bar to be shown, the feature must be requested
4069 * via {@link #requestWindowFeature(int)}.
4070 *
4071 * @param visible Whether to show the progress bars in the title.
4072 */
4073 public final void setProgressBarIndeterminateVisibility(boolean visible) {
4074 getWindow().setFeatureInt(Window.FEATURE_INDETERMINATE_PROGRESS,
4075 visible ? Window.PROGRESS_VISIBILITY_ON : Window.PROGRESS_VISIBILITY_OFF);
4076 }
4077
4078 /**
4079 * Sets whether the horizontal progress bar in the title should be indeterminate (the circular
4080 * is always indeterminate).
4081 * <p>
4082 * In order for the progress bar to be shown, the feature must be requested
4083 * via {@link #requestWindowFeature(int)}.
4084 *
4085 * @param indeterminate Whether the horizontal progress bar should be indeterminate.
4086 */
4087 public final void setProgressBarIndeterminate(boolean indeterminate) {
4088 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
4089 indeterminate ? Window.PROGRESS_INDETERMINATE_ON : Window.PROGRESS_INDETERMINATE_OFF);
4090 }
4091
4092 /**
4093 * Sets the progress for the progress bars in the title.
4094 * <p>
4095 * In order for the progress bar to be shown, the feature must be requested
4096 * via {@link #requestWindowFeature(int)}.
4097 *
4098 * @param progress The progress for the progress bar. Valid ranges are from
4099 * 0 to 10000 (both inclusive). If 10000 is given, the progress
4100 * bar will be completely filled and will fade out.
4101 */
4102 public final void setProgress(int progress) {
4103 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, progress + Window.PROGRESS_START);
4104 }
4105
4106 /**
4107 * Sets the secondary progress for the progress bar in the title. This
4108 * progress is drawn between the primary progress (set via
4109 * {@link #setProgress(int)} and the background. It can be ideal for media
4110 * scenarios such as showing the buffering progress while the default
4111 * progress shows the play progress.
4112 * <p>
4113 * In order for the progress bar to be shown, the feature must be requested
4114 * via {@link #requestWindowFeature(int)}.
4115 *
4116 * @param secondaryProgress The secondary progress for the progress bar. Valid ranges are from
4117 * 0 to 10000 (both inclusive).
4118 */
4119 public final void setSecondaryProgress(int secondaryProgress) {
4120 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
4121 secondaryProgress + Window.PROGRESS_SECONDARY_START);
4122 }
4123
4124 /**
4125 * Suggests an audio stream whose volume should be changed by the hardware
4126 * volume controls.
4127 * <p>
4128 * The suggested audio stream will be tied to the window of this Activity.
4129 * If the Activity is switched, the stream set here is no longer the
4130 * suggested stream. The client does not need to save and restore the old
4131 * suggested stream value in onPause and onResume.
4132 *
4133 * @param streamType The type of the audio stream whose volume should be
4134 * changed by the hardware volume controls. It is not guaranteed that
4135 * the hardware volume controls will always change this stream's
4136 * volume (for example, if a call is in progress, its stream's volume
4137 * may be changed instead). To reset back to the default, use
4138 * {@link AudioManager#USE_DEFAULT_STREAM_TYPE}.
4139 */
4140 public final void setVolumeControlStream(int streamType) {
4141 getWindow().setVolumeControlStream(streamType);
4142 }
4143
4144 /**
4145 * Gets the suggested audio stream whose volume should be changed by the
4146 * harwdare volume controls.
4147 *
4148 * @return The suggested audio stream type whose volume should be changed by
4149 * the hardware volume controls.
4150 * @see #setVolumeControlStream(int)
4151 */
4152 public final int getVolumeControlStream() {
4153 return getWindow().getVolumeControlStream();
4154 }
4155
4156 /**
4157 * Runs the specified action on the UI thread. If the current thread is the UI
4158 * thread, then the action is executed immediately. If the current thread is
4159 * not the UI thread, the action is posted to the event queue of the UI thread.
4160 *
4161 * @param action the action to run on the UI thread
4162 */
4163 public final void runOnUiThread(Runnable action) {
4164 if (Thread.currentThread() != mUiThread) {
4165 mHandler.post(action);
4166 } else {
4167 action.run();
4168 }
4169 }
4170
4171 /**
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004172 * Standard implementation of
4173 * {@link android.view.LayoutInflater.Factory#onCreateView} used when
4174 * inflating with the LayoutInflater returned by {@link #getSystemService}.
Dianne Hackborn625ac272010-09-17 18:29:22 -07004175 * This implementation does nothing and is for
4176 * pre-{@link android.os.Build.VERSION_CODES#HONEYCOMB} apps. Newer apps
4177 * should use {@link #onCreateView(View, String, Context, AttributeSet)}.
4178 *
4179 * @see android.view.LayoutInflater#createView
4180 * @see android.view.Window#getLayoutInflater
4181 */
4182 public View onCreateView(String name, Context context, AttributeSet attrs) {
4183 return null;
4184 }
4185
4186 /**
4187 * Standard implementation of
4188 * {@link android.view.LayoutInflater.Factory2#onCreateView(View, String, Context, AttributeSet)}
4189 * used when inflating with the LayoutInflater returned by {@link #getSystemService}.
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004190 * This implementation handles <fragment> tags to embed fragments inside
4191 * of the activity.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004192 *
4193 * @see android.view.LayoutInflater#createView
4194 * @see android.view.Window#getLayoutInflater
4195 */
Dianne Hackborn625ac272010-09-17 18:29:22 -07004196 public View onCreateView(View parent, String name, Context context, AttributeSet attrs) {
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004197 if (!"fragment".equals(name)) {
Dianne Hackborn625ac272010-09-17 18:29:22 -07004198 return onCreateView(name, context, attrs);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004199 }
4200
Dianne Hackborndef15372010-08-15 12:43:52 -07004201 String fname = attrs.getAttributeValue(null, "class");
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004202 TypedArray a =
4203 context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.Fragment);
Dianne Hackborndef15372010-08-15 12:43:52 -07004204 if (fname == null) {
4205 fname = a.getString(com.android.internal.R.styleable.Fragment_name);
4206 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004207 int id = a.getResourceId(com.android.internal.R.styleable.Fragment_id, View.NO_ID);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004208 String tag = a.getString(com.android.internal.R.styleable.Fragment_tag);
4209 a.recycle();
4210
Dianne Hackborn625ac272010-09-17 18:29:22 -07004211 int containerId = parent != null ? parent.getId() : 0;
4212 if (containerId == View.NO_ID && id == View.NO_ID && tag == null) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004213 throw new IllegalArgumentException(attrs.getPositionDescription()
Dianne Hackborn625ac272010-09-17 18:29:22 -07004214 + ": Must specify unique android:id, android:tag, or have a parent with an id for " + fname);
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004215 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004216
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004217 // If we restored from a previous state, we may already have
4218 // instantiated this fragment from the state and should use
4219 // that instance instead of making a new one.
Dianne Hackborn625ac272010-09-17 18:29:22 -07004220 Fragment fragment = id != View.NO_ID ? mFragments.findFragmentById(id) : null;
4221 if (fragment == null && tag != null) {
4222 fragment = mFragments.findFragmentByTag(tag);
4223 }
4224 if (fragment == null && containerId != View.NO_ID) {
4225 fragment = mFragments.findFragmentById(containerId);
4226 }
4227
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004228 if (FragmentManagerImpl.DEBUG) Log.v(TAG, "onCreateView: id=0x"
4229 + Integer.toHexString(id) + " fname=" + fname
4230 + " existing=" + fragment);
4231 if (fragment == null) {
4232 fragment = Fragment.instantiate(this, fname);
4233 fragment.mFromLayout = true;
Dianne Hackborn625ac272010-09-17 18:29:22 -07004234 fragment.mFragmentId = id != 0 ? id : containerId;
4235 fragment.mContainerId = containerId;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004236 fragment.mTag = tag;
Dianne Hackborn625ac272010-09-17 18:29:22 -07004237 fragment.mInLayout = true;
Dianne Hackborn3e449ce2010-09-11 20:52:31 -07004238 fragment.mFragmentManager = mFragments;
Dianne Hackborne3a7f622011-03-03 21:48:24 -08004239 fragment.onInflate(this, attrs, fragment.mSavedFragmentState);
Dianne Hackborn625ac272010-09-17 18:29:22 -07004240 mFragments.addFragment(fragment, true);
4241
4242 } else if (fragment.mInLayout) {
4243 // A fragment already exists and it is not one we restored from
4244 // previous state.
4245 throw new IllegalArgumentException(attrs.getPositionDescription()
4246 + ": Duplicate id 0x" + Integer.toHexString(id)
4247 + ", tag " + tag + ", or parent id 0x" + Integer.toHexString(containerId)
4248 + " with another fragment for " + fname);
4249 } else {
4250 // This fragment was retained from a previous instance; get it
4251 // going now.
4252 fragment.mInLayout = true;
Dianne Hackborndef15372010-08-15 12:43:52 -07004253 // If this fragment is newly instantiated (either right now, or
4254 // from last saved state), then give it the attributes to
4255 // initialize itself.
4256 if (!fragment.mRetaining) {
Dianne Hackborne3a7f622011-03-03 21:48:24 -08004257 fragment.onInflate(this, attrs, fragment.mSavedFragmentState);
Dianne Hackborndef15372010-08-15 12:43:52 -07004258 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004259 mFragments.moveToState(fragment);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004260 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004261
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004262 if (fragment.mView == null) {
4263 throw new IllegalStateException("Fragment " + fname
4264 + " did not create a view.");
4265 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004266 if (id != 0) {
4267 fragment.mView.setId(id);
4268 }
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004269 if (fragment.mView.getTag() == null) {
4270 fragment.mView.setTag(tag);
4271 }
4272 return fragment.mView;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004273 }
4274
Daniel Sandler69a48172010-06-23 16:29:36 -04004275 /**
Dianne Hackborn625ac272010-09-17 18:29:22 -07004276 * Print the Activity's state into the given stream. This gets invoked if
Dianne Hackborn30d71892010-12-11 10:37:55 -08004277 * you run "adb shell dumpsys activity <activity_component_name>".
Dianne Hackborn625ac272010-09-17 18:29:22 -07004278 *
Dianne Hackborn30d71892010-12-11 10:37:55 -08004279 * @param prefix Desired prefix to prepend at each line of output.
Dianne Hackborn625ac272010-09-17 18:29:22 -07004280 * @param fd The raw file descriptor that the dump is being sent to.
4281 * @param writer The PrintWriter to which you should dump your state. This will be
4282 * closed for you after you return.
4283 * @param args additional arguments to the dump request.
4284 */
Dianne Hackborn30d71892010-12-11 10:37:55 -08004285 public void dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args) {
4286 writer.print(prefix); writer.print("Local Activity ");
4287 writer.print(Integer.toHexString(System.identityHashCode(this)));
4288 writer.println(" State:");
4289 String innerPrefix = prefix + " ";
4290 writer.print(innerPrefix); writer.print("mResumed=");
4291 writer.print(mResumed); writer.print(" mStopped=");
4292 writer.print(mStopped); writer.print(" mFinished=");
4293 writer.println(mFinished);
4294 writer.print(innerPrefix); writer.print("mLoadersStarted=");
4295 writer.println(mLoadersStarted);
4296 writer.print(innerPrefix); writer.print("mChangingConfigurations=");
4297 writer.println(mChangingConfigurations);
4298 writer.print(innerPrefix); writer.print("mCurrentConfig=");
4299 writer.println(mCurrentConfig);
4300 if (mLoaderManager != null) {
4301 writer.print(prefix); writer.print("Loader Manager ");
4302 writer.print(Integer.toHexString(System.identityHashCode(mLoaderManager)));
4303 writer.println(":");
4304 mLoaderManager.dump(prefix + " ", fd, writer, args);
4305 }
4306 mFragments.dump(prefix, fd, writer, args);
Dianne Hackborn625ac272010-09-17 18:29:22 -07004307 }
4308
4309 /**
Daniel Sandler69a48172010-06-23 16:29:36 -04004310 * Bit indicating that this activity is "immersive" and should not be
4311 * interrupted by notifications if possible.
4312 *
4313 * This value is initially set by the manifest property
4314 * <code>android:immersive</code> but may be changed at runtime by
4315 * {@link #setImmersive}.
4316 *
4317 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE
Dianne Hackborn02486b12010-08-26 14:18:37 -07004318 * @hide
Daniel Sandler69a48172010-06-23 16:29:36 -04004319 */
4320 public boolean isImmersive() {
4321 try {
4322 return ActivityManagerNative.getDefault().isImmersive(mToken);
4323 } catch (RemoteException e) {
4324 return false;
4325 }
4326 }
4327
4328 /**
4329 * Adjust the current immersive mode setting.
4330 *
4331 * Note that changing this value will have no effect on the activity's
4332 * {@link android.content.pm.ActivityInfo} structure; that is, if
4333 * <code>android:immersive</code> is set to <code>true</code>
4334 * in the application's manifest entry for this activity, the {@link
4335 * android.content.pm.ActivityInfo#flags ActivityInfo.flags} member will
4336 * always have its {@link android.content.pm.ActivityInfo#FLAG_IMMERSIVE
4337 * FLAG_IMMERSIVE} bit set.
4338 *
4339 * @see #isImmersive
4340 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE
Dianne Hackborn02486b12010-08-26 14:18:37 -07004341 * @hide
Daniel Sandler69a48172010-06-23 16:29:36 -04004342 */
4343 public void setImmersive(boolean i) {
4344 try {
4345 ActivityManagerNative.getDefault().setImmersive(mToken, i);
4346 } catch (RemoteException e) {
4347 // pass
4348 }
4349 }
4350
Adam Powell6e346362010-07-23 10:18:23 -07004351 /**
Adam Powelldebf3be2010-11-15 18:58:48 -08004352 * Start an action mode.
Adam Powell6e346362010-07-23 10:18:23 -07004353 *
4354 * @param callback Callback that will manage lifecycle events for this context mode
4355 * @return The ContextMode that was started, or null if it was canceled
4356 *
4357 * @see ActionMode
4358 */
Adam Powell5d279772010-07-27 16:34:07 -07004359 public ActionMode startActionMode(ActionMode.Callback callback) {
Adam Powell6e346362010-07-23 10:18:23 -07004360 return mWindow.getDecorView().startActionMode(callback);
4361 }
4362
Adam Powelldebf3be2010-11-15 18:58:48 -08004363 /**
4364 * Give the Activity a chance to control the UI for an action mode requested
4365 * by the system.
4366 *
4367 * <p>Note: If you are looking for a notification callback that an action mode
4368 * has been started for this activity, see {@link #onActionModeStarted(ActionMode)}.</p>
4369 *
4370 * @param callback The callback that should control the new action mode
4371 * @return The new action mode, or <code>null</code> if the activity does not want to
4372 * provide special handling for this action mode. (It will be handled by the system.)
4373 */
4374 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback) {
Adam Powell42c0fe82010-08-10 16:36:56 -07004375 initActionBar();
Adam Powell6e346362010-07-23 10:18:23 -07004376 if (mActionBar != null) {
Adam Powell5d279772010-07-27 16:34:07 -07004377 return mActionBar.startActionMode(callback);
Adam Powell6e346362010-07-23 10:18:23 -07004378 }
4379 return null;
4380 }
4381
Adam Powelldebf3be2010-11-15 18:58:48 -08004382 /**
4383 * Notifies the Activity that an action mode has been started.
4384 * Activity subclasses overriding this method should call the superclass implementation.
4385 *
4386 * @param mode The new action mode.
4387 */
4388 public void onActionModeStarted(ActionMode mode) {
4389 }
4390
4391 /**
4392 * Notifies the activity that an action mode has finished.
4393 * Activity subclasses overriding this method should call the superclass implementation.
4394 *
4395 * @param mode The action mode that just finished.
4396 */
4397 public void onActionModeFinished(ActionMode mode) {
4398 }
4399
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004400 // ------------------ Internal API ------------------
4401
4402 final void setParent(Activity parent) {
4403 mParent = parent;
4404 }
4405
4406 final void attach(Context context, ActivityThread aThread, Instrumentation instr, IBinder token,
4407 Application application, Intent intent, ActivityInfo info, CharSequence title,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004408 Activity parent, String id, NonConfigurationInstances lastNonConfigurationInstances,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004409 Configuration config) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004410 attach(context, aThread, instr, token, 0, application, intent, info, title, parent, id,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004411 lastNonConfigurationInstances, config);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004412 }
4413
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004414 final void attach(Context context, ActivityThread aThread,
4415 Instrumentation instr, IBinder token, int ident,
4416 Application application, Intent intent, ActivityInfo info,
4417 CharSequence title, Activity parent, String id,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004418 NonConfigurationInstances lastNonConfigurationInstances,
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004419 Configuration config) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004420 attachBaseContext(context);
4421
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004422 mFragments.attachActivity(this);
4423
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004424 mWindow = PolicyManager.makeNewWindow(this);
4425 mWindow.setCallback(this);
Dianne Hackborn420829e2011-01-28 11:30:35 -08004426 mWindow.getLayoutInflater().setPrivateFactory(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004427 if (info.softInputMode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
4428 mWindow.setSoftInputMode(info.softInputMode);
4429 }
Adam Powell269248d2011-08-02 10:26:54 -07004430 if (info.uiOptions != 0) {
4431 mWindow.setUiOptions(info.uiOptions);
4432 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004433 mUiThread = Thread.currentThread();
Romain Guy529b60a2010-08-03 18:05:47 -07004434
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004435 mMainThread = aThread;
4436 mInstrumentation = instr;
4437 mToken = token;
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004438 mIdent = ident;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004439 mApplication = application;
4440 mIntent = intent;
4441 mComponent = intent.getComponent();
4442 mActivityInfo = info;
4443 mTitle = title;
4444 mParent = parent;
4445 mEmbeddedID = id;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004446 mLastNonConfigurationInstances = lastNonConfigurationInstances;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004447
Romain Guy529b60a2010-08-03 18:05:47 -07004448 mWindow.setWindowManager(null, mToken, mComponent.flattenToString(),
4449 (info.flags & ActivityInfo.FLAG_HARDWARE_ACCELERATED) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004450 if (mParent != null) {
4451 mWindow.setContainer(mParent.getWindow());
4452 }
4453 mWindowManager = mWindow.getWindowManager();
4454 mCurrentConfig = config;
4455 }
4456
4457 final IBinder getActivityToken() {
4458 return mParent != null ? mParent.getActivityToken() : mToken;
4459 }
4460
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004461 final void performCreate(Bundle icicle) {
4462 onCreate(icicle);
Dianne Hackborn30c9bd82010-12-01 16:07:40 -08004463 mVisibleFromClient = !mWindow.getWindowStyle().getBoolean(
4464 com.android.internal.R.styleable.Window_windowNoDisplay, false);
Dianne Hackbornc8017682010-07-06 13:34:38 -07004465 mFragments.dispatchActivityCreated();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004466 }
4467
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004468 final void performStart() {
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004469 mFragments.noteStateNotSaved();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004470 mCalled = false;
Dianne Hackborn445646c2010-06-25 15:52:59 -07004471 mFragments.execPendingActions();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004472 mInstrumentation.callActivityOnStart(this);
4473 if (!mCalled) {
4474 throw new SuperNotCalledException(
4475 "Activity " + mComponent.toShortString() +
4476 " did not call through to super.onStart()");
4477 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004478 mFragments.dispatchStart();
Dianne Hackborn2707d602010-07-09 18:01:20 -07004479 if (mAllLoaderManagers != null) {
4480 for (int i=mAllLoaderManagers.size()-1; i>=0; i--) {
Dianne Hackbornafc4b282011-06-10 17:03:42 -07004481 LoaderManagerImpl lm = mAllLoaderManagers.valueAt(i);
4482 lm.finishRetain();
4483 lm.doReportStart();
Dianne Hackborn2707d602010-07-09 18:01:20 -07004484 }
4485 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004486 }
4487
4488 final void performRestart() {
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004489 mFragments.noteStateNotSaved();
Dianne Hackborna21e3da2010-09-12 19:27:46 -07004490
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004491 if (mStopped) {
4492 mStopped = false;
Dianne Hackbornce418e62011-03-01 14:31:38 -08004493 if (mToken != null && mParent == null) {
4494 WindowManagerImpl.getDefault().setStoppedState(mToken, false);
4495 }
Dianne Hackborn185e3e22011-06-03 15:26:01 -07004496
4497 synchronized (mManagedCursors) {
4498 final int N = mManagedCursors.size();
4499 for (int i=0; i<N; i++) {
4500 ManagedCursor mc = mManagedCursors.get(i);
4501 if (mc.mReleased || mc.mUpdated) {
4502 if (!mc.mCursor.requery()) {
Dianne Hackborna5445d32011-09-01 14:38:24 -07004503 if (getApplicationInfo().targetSdkVersion
4504 >= android.os.Build.VERSION_CODES.ICE_CREAM_SANDWICH) {
4505 throw new IllegalStateException(
4506 "trying to requery an already closed cursor "
4507 + mc.mCursor);
4508 }
Dianne Hackborn185e3e22011-06-03 15:26:01 -07004509 }
4510 mc.mReleased = false;
4511 mc.mUpdated = false;
4512 }
4513 }
4514 }
4515
4516 mCalled = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004517 mInstrumentation.callActivityOnRestart(this);
4518 if (!mCalled) {
4519 throw new SuperNotCalledException(
4520 "Activity " + mComponent.toShortString() +
4521 " did not call through to super.onRestart()");
4522 }
4523 performStart();
4524 }
4525 }
4526
4527 final void performResume() {
4528 performRestart();
4529
Dianne Hackborn445646c2010-06-25 15:52:59 -07004530 mFragments.execPendingActions();
4531
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004532 mLastNonConfigurationInstances = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004533
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004534 mCalled = false;
Jeff Hamilton52d32032011-01-08 15:31:26 -06004535 // mResumed is set by the instrumentation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004536 mInstrumentation.callActivityOnResume(this);
4537 if (!mCalled) {
4538 throw new SuperNotCalledException(
4539 "Activity " + mComponent.toShortString() +
4540 " did not call through to super.onResume()");
4541 }
4542
4543 // Now really resume, and install the current status bar and menu.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004544 mCalled = false;
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004545
4546 mFragments.dispatchResume();
Dianne Hackborn445646c2010-06-25 15:52:59 -07004547 mFragments.execPendingActions();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004548
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004549 onPostResume();
4550 if (!mCalled) {
4551 throw new SuperNotCalledException(
4552 "Activity " + mComponent.toShortString() +
4553 " did not call through to super.onPostResume()");
4554 }
4555 }
4556
4557 final void performPause() {
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004558 mFragments.dispatchPause();
Dianne Hackborne794e9f2010-08-24 12:32:10 -07004559 mCalled = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004560 onPause();
Dianne Hackborn4eba96b2011-01-21 13:34:36 -08004561 mResumed = false;
Dianne Hackborne794e9f2010-08-24 12:32:10 -07004562 if (!mCalled && getApplicationInfo().targetSdkVersion
4563 >= android.os.Build.VERSION_CODES.GINGERBREAD) {
4564 throw new SuperNotCalledException(
4565 "Activity " + mComponent.toShortString() +
4566 " did not call through to super.onPause()");
4567 }
Jeff Hamilton52d32032011-01-08 15:31:26 -06004568 mResumed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004569 }
4570
4571 final void performUserLeaving() {
4572 onUserInteraction();
4573 onUserLeaveHint();
4574 }
4575
4576 final void performStop() {
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004577 if (mLoadersStarted) {
4578 mLoadersStarted = false;
Dianne Hackborn2707d602010-07-09 18:01:20 -07004579 if (mLoaderManager != null) {
4580 if (!mChangingConfigurations) {
4581 mLoaderManager.doStop();
4582 } else {
4583 mLoaderManager.doRetain();
4584 }
4585 }
4586 }
4587
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004588 if (!mStopped) {
4589 if (mWindow != null) {
4590 mWindow.closeAllPanels();
4591 }
4592
Dianne Hackbornce418e62011-03-01 14:31:38 -08004593 if (mToken != null && mParent == null) {
4594 WindowManagerImpl.getDefault().setStoppedState(mToken, true);
4595 }
4596
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004597 mFragments.dispatchStop();
4598
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004599 mCalled = false;
4600 mInstrumentation.callActivityOnStop(this);
4601 if (!mCalled) {
4602 throw new SuperNotCalledException(
4603 "Activity " + mComponent.toShortString() +
4604 " did not call through to super.onStop()");
4605 }
4606
Makoto Onuki2f6a0182010-02-22 13:26:59 -08004607 synchronized (mManagedCursors) {
4608 final int N = mManagedCursors.size();
4609 for (int i=0; i<N; i++) {
4610 ManagedCursor mc = mManagedCursors.get(i);
4611 if (!mc.mReleased) {
4612 mc.mCursor.deactivate();
4613 mc.mReleased = true;
4614 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004615 }
4616 }
4617
4618 mStopped = true;
4619 }
4620 mResumed = false;
4621 }
4622
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004623 final void performDestroy() {
Dianne Hackborn291905e2010-08-17 15:17:15 -07004624 mWindow.destroy();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004625 mFragments.dispatchDestroy();
4626 onDestroy();
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07004627 if (mLoaderManager != null) {
4628 mLoaderManager.doDestroy();
4629 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004630 }
4631
Jeff Hamilton52d32032011-01-08 15:31:26 -06004632 /**
4633 * @hide
4634 */
4635 public final boolean isResumed() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004636 return mResumed;
4637 }
4638
4639 void dispatchActivityResult(String who, int requestCode,
4640 int resultCode, Intent data) {
Joe Onorato43a17652011-04-06 19:22:23 -07004641 if (false) Log.v(
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004642 TAG, "Dispatching result: who=" + who + ", reqCode=" + requestCode
4643 + ", resCode=" + resultCode + ", data=" + data);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004644 mFragments.noteStateNotSaved();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004645 if (who == null) {
4646 onActivityResult(requestCode, resultCode, data);
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004647 } else {
4648 Fragment frag = mFragments.findFragmentByWho(who);
4649 if (frag != null) {
4650 frag.onActivityResult(requestCode, resultCode, data);
4651 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004652 }
4653 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004654}