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