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