blob: 07d21fbf4e34473b7c761eb90f6ebbd068445d65 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.app;
18
Adam Powell6e346362010-07-23 10:18:23 -070019import com.android.internal.app.ActionBarImpl;
20import com.android.internal.policy.PolicyManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070021
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080022import android.content.ComponentCallbacks;
23import android.content.ComponentName;
24import android.content.ContentResolver;
25import android.content.Context;
Jason parks6ed50de2010-08-25 10:18:50 -050026import android.content.CursorLoader;
Suchi Amalapurapu1ccac752009-06-12 10:09:58 -070027import android.content.IIntentSender;
Adam Powell33b97432010-04-20 10:01:14 -070028import android.content.Intent;
Dianne Hackbornfa82f222009-09-17 15:14:12 -070029import android.content.IntentSender;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.content.SharedPreferences;
31import android.content.pm.ActivityInfo;
32import android.content.res.Configuration;
33import android.content.res.Resources;
Dianne Hackbornba51c3d2010-05-05 18:49:48 -070034import android.content.res.TypedArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080035import android.database.Cursor;
36import android.graphics.Bitmap;
37import android.graphics.Canvas;
38import android.graphics.drawable.Drawable;
39import android.media.AudioManager;
40import android.net.Uri;
Dianne Hackborn8d374262009-09-14 21:21:52 -070041import android.os.Build;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080042import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.os.Handler;
44import android.os.IBinder;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -070045import android.os.Parcelable;
svetoslavganov75986cf2009-05-14 22:28:01 -070046import android.os.RemoteException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080047import android.text.Selection;
48import android.text.SpannableStringBuilder;
svetoslavganov75986cf2009-05-14 22:28:01 -070049import android.text.TextUtils;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050import android.text.method.TextKeyListener;
51import android.util.AttributeSet;
52import android.util.Config;
53import android.util.EventLog;
54import android.util.Log;
55import android.util.SparseArray;
Adam Powell6e346362010-07-23 10:18:23 -070056import android.view.ActionMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080057import android.view.ContextMenu;
Adam Powell6e346362010-07-23 10:18:23 -070058import android.view.ContextMenu.ContextMenuInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080059import android.view.ContextThemeWrapper;
60import 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
Dianne Hackborn625ac272010-09-17 18:29:22 -070077import java.io.FileDescriptor;
78import java.io.PrintWriter;
Adam Powell6e346362010-07-23 10:18:23 -070079import java.util.ArrayList;
80import java.util.HashMap;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080081
82/**
83 * An activity is a single, focused thing that the user can do. Almost all
84 * activities interact with the user, so the Activity class takes care of
85 * creating a window for you in which you can place your UI with
86 * {@link #setContentView}. While activities are often presented to the user
87 * as full-screen windows, they can also be used in other ways: as floating
88 * windows (via a theme with {@link android.R.attr#windowIsFloating} set)
89 * or embedded inside of another activity (using {@link ActivityGroup}).
90 *
91 * There are two methods almost all subclasses of Activity will implement:
92 *
93 * <ul>
94 * <li> {@link #onCreate} is where you initialize your activity. Most
95 * importantly, here you will usually call {@link #setContentView(int)}
96 * with a layout resource defining your UI, and using {@link #findViewById}
97 * to retrieve the widgets in that UI that you need to interact with
98 * programmatically.
99 *
100 * <li> {@link #onPause} is where you deal with the user leaving your
101 * activity. Most importantly, any changes made by the user should at this
102 * point be committed (usually to the
103 * {@link android.content.ContentProvider} holding the data).
104 * </ul>
105 *
106 * <p>To be of use with {@link android.content.Context#startActivity Context.startActivity()}, all
107 * activity classes must have a corresponding
108 * {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
109 * declaration in their package's <code>AndroidManifest.xml</code>.</p>
110 *
111 * <p>The Activity class is an important part of an application's overall lifecycle,
112 * and the way activities are launched and put together is a fundamental
113 * part of the platform's application model. For a detailed perspective on the structure of
114 * Android applications and lifecycles, please read the <em>Dev Guide</em> document on
115 * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a>.</p>
116 *
117 * <p>Topics covered here:
118 * <ol>
Dianne Hackborn291905e2010-08-17 15:17:15 -0700119 * <li><a href="#Fragments">Fragments</a>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800120 * <li><a href="#ActivityLifecycle">Activity Lifecycle</a>
121 * <li><a href="#ConfigurationChanges">Configuration Changes</a>
122 * <li><a href="#StartingActivities">Starting Activities and Getting Results</a>
123 * <li><a href="#SavingPersistentState">Saving Persistent State</a>
124 * <li><a href="#Permissions">Permissions</a>
125 * <li><a href="#ProcessLifecycle">Process Lifecycle</a>
126 * </ol>
127 *
Dianne Hackborn291905e2010-08-17 15:17:15 -0700128 * <a name="Fragments"></a>
129 * <h3>Fragments</h3>
130 *
131 * <p>Starting with {@link android.os.Build.VERSION_CODES#HONEYCOMB}, Activity
132 * implementations can make use of the {@link Fragment} class to better
133 * modularize their code, build more sophisticated user interfaces for larger
134 * screens, and help scale their application between small and large screens.
135 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800136 * <a name="ActivityLifecycle"></a>
137 * <h3>Activity Lifecycle</h3>
138 *
139 * <p>Activities in the system are managed as an <em>activity stack</em>.
140 * When a new activity is started, it is placed on the top of the stack
141 * and becomes the running activity -- the previous activity always remains
142 * below it in the stack, and will not come to the foreground again until
143 * the new activity exits.</p>
144 *
145 * <p>An activity has essentially four states:</p>
146 * <ul>
147 * <li> If an activity in the foreground of the screen (at the top of
148 * the stack),
149 * it is <em>active</em> or <em>running</em>. </li>
150 * <li>If an activity has lost focus but is still visible (that is, a new non-full-sized
151 * or transparent activity has focus on top of your activity), it
152 * is <em>paused</em>. A paused activity is completely alive (it
153 * maintains all state and member information and remains attached to
154 * the window manager), but can be killed by the system in extreme
155 * low memory situations.
156 * <li>If an activity is completely obscured by another activity,
157 * it is <em>stopped</em>. It still retains all state and member information,
158 * however, it is no longer visible to the user so its window is hidden
159 * and it will often be killed by the system when memory is needed
160 * elsewhere.</li>
161 * <li>If an activity is paused or stopped, the system can drop the activity
162 * from memory by either asking it to finish, or simply killing its
163 * process. When it is displayed again to the user, it must be
164 * completely restarted and restored to its previous state.</li>
165 * </ul>
166 *
167 * <p>The following diagram shows the important state paths of an Activity.
168 * The square rectangles represent callback methods you can implement to
169 * perform operations when the Activity moves between states. The colored
170 * ovals are major states the Activity can be in.</p>
171 *
172 * <p><img src="../../../images/activity_lifecycle.png"
173 * alt="State diagram for an Android Activity Lifecycle." border="0" /></p>
174 *
175 * <p>There are three key loops you may be interested in monitoring within your
176 * activity:
177 *
178 * <ul>
179 * <li>The <b>entire lifetime</b> of an activity happens between the first call
180 * to {@link android.app.Activity#onCreate} through to a single final call
181 * to {@link android.app.Activity#onDestroy}. An activity will do all setup
182 * of "global" state in onCreate(), and release all remaining resources in
183 * onDestroy(). For example, if it has a thread running in the background
184 * to download data from the network, it may create that thread in onCreate()
185 * and then stop the thread in onDestroy().
186 *
187 * <li>The <b>visible lifetime</b> of an activity happens between a call to
188 * {@link android.app.Activity#onStart} until a corresponding call to
189 * {@link android.app.Activity#onStop}. During this time the user can see the
190 * activity on-screen, though it may not be in the foreground and interacting
191 * with the user. Between these two methods you can maintain resources that
192 * are needed to show the activity to the user. For example, you can register
193 * a {@link android.content.BroadcastReceiver} in onStart() to monitor for changes
194 * that impact your UI, and unregister it in onStop() when the user an no
195 * longer see what you are displaying. The onStart() and onStop() methods
196 * can be called multiple times, as the activity becomes visible and hidden
197 * to the user.
198 *
199 * <li>The <b>foreground lifetime</b> of an activity happens between a call to
200 * {@link android.app.Activity#onResume} until a corresponding call to
201 * {@link android.app.Activity#onPause}. During this time the activity is
202 * in front of all other activities and interacting with the user. An activity
203 * can frequently go between the resumed and paused states -- for example when
204 * the device goes to sleep, when an activity result is delivered, when a new
205 * intent is delivered -- so the code in these methods should be fairly
206 * lightweight.
207 * </ul>
208 *
209 * <p>The entire lifecycle of an activity is defined by the following
210 * Activity methods. All of these are hooks that you can override
211 * to do appropriate work when the activity changes state. All
212 * activities will implement {@link android.app.Activity#onCreate}
213 * to do their initial setup; many will also implement
214 * {@link android.app.Activity#onPause} to commit changes to data and
215 * otherwise prepare to stop interacting with the user. You should always
216 * call up to your superclass when implementing these methods.</p>
217 *
218 * </p>
219 * <pre class="prettyprint">
220 * public class Activity extends ApplicationContext {
221 * protected void onCreate(Bundle savedInstanceState);
222 *
223 * protected void onStart();
224 *
225 * protected void onRestart();
226 *
227 * protected void onResume();
228 *
229 * protected void onPause();
230 *
231 * protected void onStop();
232 *
233 * protected void onDestroy();
234 * }
235 * </pre>
236 *
237 * <p>In general the movement through an activity's lifecycle looks like
238 * this:</p>
239 *
240 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
241 * <colgroup align="left" span="3" />
242 * <colgroup align="left" />
243 * <colgroup align="center" />
244 * <colgroup align="center" />
245 *
246 * <thead>
247 * <tr><th colspan="3">Method</th> <th>Description</th> <th>Killable?</th> <th>Next</th></tr>
248 * </thead>
249 *
250 * <tbody>
251 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onCreate onCreate()}</th>
252 * <td>Called when the activity is first created.
253 * This is where you should do all of your normal static set up:
254 * create views, bind data to lists, etc. This method also
255 * provides you with a Bundle containing the activity's previously
256 * frozen state, if there was one.
257 * <p>Always followed by <code>onStart()</code>.</td>
258 * <td align="center">No</td>
259 * <td align="center"><code>onStart()</code></td>
260 * </tr>
261 *
262 * <tr><td rowspan="5" style="border-left: none; border-right: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
263 * <th colspan="2" align="left" border="0">{@link android.app.Activity#onRestart onRestart()}</th>
264 * <td>Called after your activity has been stopped, prior to it being
265 * started again.
266 * <p>Always followed by <code>onStart()</code></td>
267 * <td align="center">No</td>
268 * <td align="center"><code>onStart()</code></td>
269 * </tr>
270 *
271 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStart onStart()}</th>
272 * <td>Called when the activity is becoming visible to the user.
273 * <p>Followed by <code>onResume()</code> if the activity comes
274 * to the foreground, or <code>onStop()</code> if it becomes hidden.</td>
275 * <td align="center">No</td>
276 * <td align="center"><code>onResume()</code> or <code>onStop()</code></td>
277 * </tr>
278 *
279 * <tr><td rowspan="2" style="border-left: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
280 * <th align="left" border="0">{@link android.app.Activity#onResume onResume()}</th>
281 * <td>Called when the activity will start
282 * interacting with the user. At this point your activity is at
283 * the top of the activity stack, with user input going to it.
284 * <p>Always followed by <code>onPause()</code>.</td>
285 * <td align="center">No</td>
286 * <td align="center"><code>onPause()</code></td>
287 * </tr>
288 *
289 * <tr><th align="left" border="0">{@link android.app.Activity#onPause onPause()}</th>
290 * <td>Called when the system is about to start resuming a previous
291 * activity. This is typically used to commit unsaved changes to
292 * persistent data, stop animations and other things that may be consuming
293 * CPU, etc. Implementations of this method must be very quick because
294 * the next activity will not be resumed until this method returns.
295 * <p>Followed by either <code>onResume()</code> if the activity
296 * returns back to the front, or <code>onStop()</code> if it becomes
297 * invisible to the user.</td>
298 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
299 * <td align="center"><code>onResume()</code> or<br>
300 * <code>onStop()</code></td>
301 * </tr>
302 *
303 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStop onStop()}</th>
304 * <td>Called when the activity is no longer visible to the user, because
305 * another activity has been resumed and is covering this one. This
306 * may happen either because a new activity is being started, an existing
307 * one is being brought in front of this one, or this one is being
308 * destroyed.
309 * <p>Followed by either <code>onRestart()</code> if
310 * this activity is coming back to interact with the user, or
311 * <code>onDestroy()</code> if this activity is going away.</td>
312 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
313 * <td align="center"><code>onRestart()</code> or<br>
314 * <code>onDestroy()</code></td>
315 * </tr>
316 *
317 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onDestroy onDestroy()}</th>
318 * <td>The final call you receive before your
319 * activity is destroyed. This can happen either because the
320 * activity is finishing (someone called {@link Activity#finish} on
321 * it, or because the system is temporarily destroying this
322 * instance of the activity to save space. You can distinguish
323 * between these two scenarios with the {@link
324 * Activity#isFinishing} method.</td>
325 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
326 * <td align="center"><em>nothing</em></td>
327 * </tr>
328 * </tbody>
329 * </table>
330 *
331 * <p>Note the "Killable" column in the above table -- for those methods that
332 * are marked as being killable, after that method returns the process hosting the
333 * activity may killed by the system <em>at any time</em> without another line
334 * of its code being executed. Because of this, you should use the
335 * {@link #onPause} method to write any persistent data (such as user edits)
336 * to storage. In addition, the method
337 * {@link #onSaveInstanceState(Bundle)} is called before placing the activity
338 * in such a background state, allowing you to save away any dynamic instance
339 * state in your activity into the given Bundle, to be later received in
340 * {@link #onCreate} if the activity needs to be re-created.
341 * See the <a href="#ProcessLifecycle">Process Lifecycle</a>
342 * section for more information on how the lifecycle of a process is tied
343 * to the activities it is hosting. Note that it is important to save
344 * persistent data in {@link #onPause} instead of {@link #onSaveInstanceState}
345 * because the later is not part of the lifecycle callbacks, so will not
346 * be called in every situation as described in its documentation.</p>
347 *
348 * <p>For those methods that are not marked as being killable, the activity's
349 * process will not be killed by the system starting from the time the method
350 * is called and continuing after it returns. Thus an activity is in the killable
351 * state, for example, between after <code>onPause()</code> to the start of
352 * <code>onResume()</code>.</p>
353 *
354 * <a name="ConfigurationChanges"></a>
355 * <h3>Configuration Changes</h3>
356 *
357 * <p>If the configuration of the device (as defined by the
358 * {@link Configuration Resources.Configuration} class) changes,
359 * then anything displaying a user interface will need to update to match that
360 * configuration. Because Activity is the primary mechanism for interacting
361 * with the user, it includes special support for handling configuration
362 * changes.</p>
363 *
364 * <p>Unless you specify otherwise, a configuration change (such as a change
365 * in screen orientation, language, input devices, etc) will cause your
366 * current activity to be <em>destroyed</em>, going through the normal activity
367 * lifecycle process of {@link #onPause},
368 * {@link #onStop}, and {@link #onDestroy} as appropriate. If the activity
369 * had been in the foreground or visible to the user, once {@link #onDestroy} is
370 * called in that instance then a new instance of the activity will be
371 * created, with whatever savedInstanceState the previous instance had generated
372 * from {@link #onSaveInstanceState}.</p>
373 *
374 * <p>This is done because any application resource,
375 * including layout files, can change based on any configuration value. Thus
376 * the only safe way to handle a configuration change is to re-retrieve all
377 * resources, including layouts, drawables, and strings. Because activities
378 * must already know how to save their state and re-create themselves from
379 * that state, this is a convenient way to have an activity restart itself
380 * with a new configuration.</p>
381 *
382 * <p>In some special cases, you may want to bypass restarting of your
383 * activity based on one or more types of configuration changes. This is
384 * done with the {@link android.R.attr#configChanges android:configChanges}
385 * attribute in its manifest. For any types of configuration changes you say
386 * that you handle there, you will receive a call to your current activity's
387 * {@link #onConfigurationChanged} method instead of being restarted. If
388 * a configuration change involves any that you do not handle, however, the
389 * activity will still be restarted and {@link #onConfigurationChanged}
390 * will not be called.</p>
391 *
392 * <a name="StartingActivities"></a>
393 * <h3>Starting Activities and Getting Results</h3>
394 *
395 * <p>The {@link android.app.Activity#startActivity}
396 * method is used to start a
397 * new activity, which will be placed at the top of the activity stack. It
398 * takes a single argument, an {@link android.content.Intent Intent},
399 * which describes the activity
400 * to be executed.</p>
401 *
402 * <p>Sometimes you want to get a result back from an activity when it
403 * ends. For example, you may start an activity that lets the user pick
404 * a person in a list of contacts; when it ends, it returns the person
405 * that was selected. To do this, you call the
406 * {@link android.app.Activity#startActivityForResult(Intent, int)}
407 * version with a second integer parameter identifying the call. The result
408 * will come back through your {@link android.app.Activity#onActivityResult}
409 * method.</p>
410 *
411 * <p>When an activity exits, it can call
412 * {@link android.app.Activity#setResult(int)}
413 * to return data back to its parent. It must always supply a result code,
414 * which can be the standard results RESULT_CANCELED, RESULT_OK, or any
415 * custom values starting at RESULT_FIRST_USER. In addition, it can optionally
416 * return back an Intent containing any additional data it wants. All of this
417 * information appears back on the
418 * parent's <code>Activity.onActivityResult()</code>, along with the integer
419 * identifier it originally supplied.</p>
420 *
421 * <p>If a child activity fails for any reason (such as crashing), the parent
422 * activity will receive a result with the code RESULT_CANCELED.</p>
423 *
424 * <pre class="prettyprint">
425 * public class MyActivity extends Activity {
426 * ...
427 *
428 * static final int PICK_CONTACT_REQUEST = 0;
429 *
430 * protected boolean onKeyDown(int keyCode, KeyEvent event) {
431 * if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) {
432 * // When the user center presses, let them pick a contact.
433 * startActivityForResult(
434 * new Intent(Intent.ACTION_PICK,
435 * new Uri("content://contacts")),
436 * PICK_CONTACT_REQUEST);
437 * return true;
438 * }
439 * return false;
440 * }
441 *
442 * protected void onActivityResult(int requestCode, int resultCode,
443 * Intent data) {
444 * if (requestCode == PICK_CONTACT_REQUEST) {
445 * if (resultCode == RESULT_OK) {
446 * // A contact was picked. Here we will just display it
447 * // to the user.
448 * startActivity(new Intent(Intent.ACTION_VIEW, data));
449 * }
450 * }
451 * }
452 * }
453 * </pre>
454 *
455 * <a name="SavingPersistentState"></a>
456 * <h3>Saving Persistent State</h3>
457 *
458 * <p>There are generally two kinds of persistent state than an activity
459 * will deal with: shared document-like data (typically stored in a SQLite
460 * database using a {@linkplain android.content.ContentProvider content provider})
461 * and internal state such as user preferences.</p>
462 *
463 * <p>For content provider data, we suggest that activities use a
464 * "edit in place" user model. That is, any edits a user makes are effectively
465 * made immediately without requiring an additional confirmation step.
466 * Supporting this model is generally a simple matter of following two rules:</p>
467 *
468 * <ul>
469 * <li> <p>When creating a new document, the backing database entry or file for
470 * it is created immediately. For example, if the user chooses to write
471 * a new e-mail, a new entry for that e-mail is created as soon as they
472 * start entering data, so that if they go to any other activity after
473 * that point this e-mail will now appear in the list of drafts.</p>
474 * <li> <p>When an activity's <code>onPause()</code> method is called, it should
475 * commit to the backing content provider or file any changes the user
476 * has made. This ensures that those changes will be seen by any other
477 * activity that is about to run. You will probably want to commit
478 * your data even more aggressively at key times during your
479 * activity's lifecycle: for example before starting a new
480 * activity, before finishing your own activity, when the user
481 * switches between input fields, etc.</p>
482 * </ul>
483 *
484 * <p>This model is designed to prevent data loss when a user is navigating
485 * between activities, and allows the system to safely kill an activity (because
486 * system resources are needed somewhere else) at any time after it has been
487 * paused. Note this implies
488 * that the user pressing BACK from your activity does <em>not</em>
489 * mean "cancel" -- it means to leave the activity with its current contents
490 * saved away. Cancelling edits in an activity must be provided through
491 * some other mechanism, such as an explicit "revert" or "undo" option.</p>
492 *
493 * <p>See the {@linkplain android.content.ContentProvider content package} for
494 * more information about content providers. These are a key aspect of how
495 * different activities invoke and propagate data between themselves.</p>
496 *
497 * <p>The Activity class also provides an API for managing internal persistent state
498 * associated with an activity. This can be used, for example, to remember
499 * the user's preferred initial display in a calendar (day view or week view)
500 * or the user's default home page in a web browser.</p>
501 *
502 * <p>Activity persistent state is managed
503 * with the method {@link #getPreferences},
504 * allowing you to retrieve and
505 * modify a set of name/value pairs associated with the activity. To use
506 * preferences that are shared across multiple application components
507 * (activities, receivers, services, providers), you can use the underlying
508 * {@link Context#getSharedPreferences Context.getSharedPreferences()} method
509 * to retrieve a preferences
510 * object stored under a specific name.
511 * (Note that it is not possible to share settings data across application
512 * packages -- for that you will need a content provider.)</p>
513 *
514 * <p>Here is an excerpt from a calendar activity that stores the user's
515 * preferred view mode in its persistent settings:</p>
516 *
517 * <pre class="prettyprint">
518 * public class CalendarActivity extends Activity {
519 * ...
520 *
521 * static final int DAY_VIEW_MODE = 0;
522 * static final int WEEK_VIEW_MODE = 1;
523 *
524 * private SharedPreferences mPrefs;
525 * private int mCurViewMode;
526 *
527 * protected void onCreate(Bundle savedInstanceState) {
528 * super.onCreate(savedInstanceState);
529 *
530 * SharedPreferences mPrefs = getSharedPreferences();
531 * mCurViewMode = mPrefs.getInt("view_mode" DAY_VIEW_MODE);
532 * }
533 *
534 * protected void onPause() {
535 * super.onPause();
536 *
537 * SharedPreferences.Editor ed = mPrefs.edit();
538 * ed.putInt("view_mode", mCurViewMode);
539 * ed.commit();
540 * }
541 * }
542 * </pre>
543 *
544 * <a name="Permissions"></a>
545 * <h3>Permissions</h3>
546 *
547 * <p>The ability to start a particular Activity can be enforced when it is
548 * declared in its
549 * manifest's {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
550 * tag. By doing so, other applications will need to declare a corresponding
551 * {@link android.R.styleable#AndroidManifestUsesPermission &lt;uses-permission&gt;}
552 * element in their own manifest to be able to start that activity.
553 *
554 * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a>
555 * document for more information on permissions and security in general.
556 *
557 * <a name="ProcessLifecycle"></a>
558 * <h3>Process Lifecycle</h3>
559 *
560 * <p>The Android system attempts to keep application process around for as
561 * long as possible, but eventually will need to remove old processes when
562 * memory runs low. As described in <a href="#ActivityLifecycle">Activity
563 * Lifecycle</a>, the decision about which process to remove is intimately
564 * tied to the state of the user's interaction with it. In general, there
565 * are four states a process can be in based on the activities running in it,
566 * listed here in order of importance. The system will kill less important
567 * processes (the last ones) before it resorts to killing more important
568 * processes (the first ones).
569 *
570 * <ol>
571 * <li> <p>The <b>foreground activity</b> (the activity at the top of the screen
572 * that the user is currently interacting with) is considered the most important.
573 * Its process will only be killed as a last resort, if it uses more memory
574 * than is available on the device. Generally at this point the device has
575 * reached a memory paging state, so this is required in order to keep the user
576 * interface responsive.
577 * <li> <p>A <b>visible activity</b> (an activity that is visible to the user
578 * but not in the foreground, such as one sitting behind a foreground dialog)
579 * is considered extremely important and will not be killed unless that is
580 * required to keep the foreground activity running.
581 * <li> <p>A <b>background activity</b> (an activity that is not visible to
582 * the user and has been paused) is no longer critical, so the system may
583 * safely kill its process to reclaim memory for other foreground or
584 * visible processes. If its process needs to be killed, when the user navigates
585 * back to the activity (making it visible on the screen again), its
586 * {@link #onCreate} method will be called with the savedInstanceState it had previously
587 * supplied in {@link #onSaveInstanceState} so that it can restart itself in the same
588 * state as the user last left it.
589 * <li> <p>An <b>empty process</b> is one hosting no activities or other
590 * application components (such as {@link Service} or
591 * {@link android.content.BroadcastReceiver} classes). These are killed very
592 * quickly by the system as memory becomes low. For this reason, any
593 * background operation you do outside of an activity must be executed in the
594 * context of an activity BroadcastReceiver or Service to ensure that the system
595 * knows it needs to keep your process around.
596 * </ol>
597 *
598 * <p>Sometimes an Activity may need to do a long-running operation that exists
599 * independently of the activity lifecycle itself. An example may be a camera
600 * application that allows you to upload a picture to a web site. The upload
601 * may take a long time, and the application should allow the user to leave
602 * the application will it is executing. To accomplish this, your Activity
603 * should start a {@link Service} in which the upload takes place. This allows
604 * the system to properly prioritize your process (considering it to be more
605 * important than other non-visible applications) for the duration of the
606 * upload, independent of whether the original activity is paused, stopped,
607 * or finished.
608 */
609public class Activity extends ContextThemeWrapper
Dianne Hackborn625ac272010-09-17 18:29:22 -0700610 implements LayoutInflater.Factory2,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800611 Window.Callback, KeyEvent.Callback,
612 OnCreateContextMenuListener, ComponentCallbacks {
613 private static final String TAG = "Activity";
614
615 /** Standard activity result: operation canceled. */
616 public static final int RESULT_CANCELED = 0;
617 /** Standard activity result: operation succeeded. */
618 public static final int RESULT_OK = -1;
619 /** Start of user-defined activity results. */
620 public static final int RESULT_FIRST_USER = 1;
621
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800622 private static final String WINDOW_HIERARCHY_TAG = "android:viewHierarchyState";
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700623 private static final String FRAGMENTS_TAG = "android:fragments";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800624 private static final String SAVED_DIALOG_IDS_KEY = "android:savedDialogIds";
625 private static final String SAVED_DIALOGS_TAG = "android:savedDialogs";
626 private static final String SAVED_DIALOG_KEY_PREFIX = "android:dialog_";
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800627 private static final String SAVED_DIALOG_ARGS_KEY_PREFIX = "android:dialog_args_";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800628
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800629 private static class ManagedDialog {
630 Dialog mDialog;
631 Bundle mArgs;
632 }
633 private SparseArray<ManagedDialog> mManagedDialogs;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800634
635 // set by the thread after the constructor and before onCreate(Bundle savedInstanceState) is called.
636 private Instrumentation mInstrumentation;
637 private IBinder mToken;
Dianne Hackbornb06ea702009-07-13 13:07:51 -0700638 private int mIdent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800639 /*package*/ String mEmbeddedID;
640 private Application mApplication;
Christopher Tateb70f3df2009-04-07 16:07:59 -0700641 /*package*/ Intent mIntent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800642 private ComponentName mComponent;
643 /*package*/ ActivityInfo mActivityInfo;
644 /*package*/ ActivityThread mMainThread;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800645 Activity mParent;
646 boolean mCalled;
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700647 boolean mCheckedForLoaderManager;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700648 boolean mLoadersStarted;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800649 private boolean mResumed;
650 private boolean mStopped;
651 boolean mFinished;
652 boolean mStartedActivity;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700653 /** true if the activity is going through a transient pause */
654 /*package*/ boolean mTemporaryPause = false;
Jeff Hamilton3d32f6e2010-04-01 00:04:16 -0500655 /** true if the activity is being destroyed in order to recreate it with a new configuration */
656 /*package*/ boolean mChangingConfigurations = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800657 /*package*/ int mConfigChangeFlags;
658 /*package*/ Configuration mCurrentConfig;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +0100659 private SearchManager mSearchManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800660
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700661 static final class NonConfigurationInstances {
662 Object activity;
663 HashMap<String, Object> children;
664 ArrayList<Fragment> fragments;
Dianne Hackborn4911b782010-07-15 12:54:39 -0700665 SparseArray<LoaderManagerImpl> loaders;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700666 }
667 /* package */ NonConfigurationInstances mLastNonConfigurationInstances;
668
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800669 private Window mWindow;
670
671 private WindowManager mWindowManager;
672 /*package*/ View mDecor = null;
673 /*package*/ boolean mWindowAdded = false;
674 /*package*/ boolean mVisibleFromServer = false;
675 /*package*/ boolean mVisibleFromClient = true;
Adam Powellac695c62010-07-20 18:19:27 -0700676 /*package*/ ActionBarImpl mActionBar = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800677
678 private CharSequence mTitle;
679 private int mTitleColor = 0;
680
Dianne Hackbornb7a2e472010-08-12 16:20:42 -0700681 final FragmentManagerImpl mFragments = new FragmentManagerImpl();
Dianne Hackborn2dedce62010-04-15 14:45:25 -0700682
Dianne Hackborn4911b782010-07-15 12:54:39 -0700683 SparseArray<LoaderManagerImpl> mAllLoaderManagers;
684 LoaderManagerImpl mLoaderManager;
Dianne Hackbornc8017682010-07-06 13:34:38 -0700685
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800686 private static final class ManagedCursor {
687 ManagedCursor(Cursor cursor) {
688 mCursor = cursor;
689 mReleased = false;
690 mUpdated = false;
691 }
692
693 private final Cursor mCursor;
694 private boolean mReleased;
695 private boolean mUpdated;
696 }
697 private final ArrayList<ManagedCursor> mManagedCursors =
698 new ArrayList<ManagedCursor>();
699
700 // protected by synchronized (this)
701 int mResultCode = RESULT_CANCELED;
702 Intent mResultData = null;
703
704 private boolean mTitleReady = false;
705
706 private int mDefaultKeyMode = DEFAULT_KEYS_DISABLE;
707 private SpannableStringBuilder mDefaultKeySsb = null;
708
709 protected static final int[] FOCUSED_STATE_SET = {com.android.internal.R.attr.state_focused};
710
711 private Thread mUiThread;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700712 final Handler mHandler = new Handler();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800713
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800714 /** Return the intent that started this activity. */
715 public Intent getIntent() {
716 return mIntent;
717 }
718
719 /**
720 * Change the intent returned by {@link #getIntent}. This holds a
721 * reference to the given intent; it does not copy it. Often used in
722 * conjunction with {@link #onNewIntent}.
723 *
724 * @param newIntent The new Intent object to return from getIntent
725 *
726 * @see #getIntent
727 * @see #onNewIntent
728 */
729 public void setIntent(Intent newIntent) {
730 mIntent = newIntent;
731 }
732
733 /** Return the application that owns this activity. */
734 public final Application getApplication() {
735 return mApplication;
736 }
737
738 /** Is this activity embedded inside of another activity? */
739 public final boolean isChild() {
740 return mParent != null;
741 }
742
743 /** Return the parent activity if this view is an embedded child. */
744 public final Activity getParent() {
745 return mParent;
746 }
747
748 /** Retrieve the window manager for showing custom windows. */
749 public WindowManager getWindowManager() {
750 return mWindowManager;
751 }
752
753 /**
754 * Retrieve the current {@link android.view.Window} for the activity.
755 * This can be used to directly access parts of the Window API that
756 * are not available through Activity/Screen.
757 *
758 * @return Window The current window, or null if the activity is not
759 * visual.
760 */
761 public Window getWindow() {
762 return mWindow;
763 }
764
765 /**
Dianne Hackbornc8017682010-07-06 13:34:38 -0700766 * Return the LoaderManager for this fragment, creating it if needed.
767 */
768 public LoaderManager getLoaderManager() {
769 if (mLoaderManager != null) {
770 return mLoaderManager;
771 }
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700772 mCheckedForLoaderManager = true;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700773 mLoaderManager = getLoaderManager(-1, mLoadersStarted, true);
Dianne Hackbornc8017682010-07-06 13:34:38 -0700774 return mLoaderManager;
775 }
776
Dianne Hackborn5e0d5952010-08-05 13:45:35 -0700777 LoaderManagerImpl getLoaderManager(int index, boolean started, boolean create) {
Dianne Hackbornc8017682010-07-06 13:34:38 -0700778 if (mAllLoaderManagers == null) {
Dianne Hackborn4911b782010-07-15 12:54:39 -0700779 mAllLoaderManagers = new SparseArray<LoaderManagerImpl>();
Dianne Hackbornc8017682010-07-06 13:34:38 -0700780 }
Dianne Hackborn4911b782010-07-15 12:54:39 -0700781 LoaderManagerImpl lm = mAllLoaderManagers.get(index);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700782 if (lm == null) {
783 if (create) {
784 lm = new LoaderManagerImpl(this, started);
785 mAllLoaderManagers.put(index, lm);
786 }
787 } else {
788 lm.updateActivity(this);
Dianne Hackbornc8017682010-07-06 13:34:38 -0700789 }
790 return lm;
791 }
792
793 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800794 * Calls {@link android.view.Window#getCurrentFocus} on the
795 * Window of this Activity to return the currently focused view.
796 *
797 * @return View The current View with focus or null.
798 *
799 * @see #getWindow
800 * @see android.view.Window#getCurrentFocus
801 */
802 public View getCurrentFocus() {
803 return mWindow != null ? mWindow.getCurrentFocus() : null;
804 }
805
806 @Override
807 public int getWallpaperDesiredMinimumWidth() {
808 int width = super.getWallpaperDesiredMinimumWidth();
809 return width <= 0 ? getWindowManager().getDefaultDisplay().getWidth() : width;
810 }
811
812 @Override
813 public int getWallpaperDesiredMinimumHeight() {
814 int height = super.getWallpaperDesiredMinimumHeight();
815 return height <= 0 ? getWindowManager().getDefaultDisplay().getHeight() : height;
816 }
817
818 /**
819 * Called when the activity is starting. This is where most initialization
820 * should go: calling {@link #setContentView(int)} to inflate the
821 * activity's UI, using {@link #findViewById} to programmatically interact
822 * with widgets in the UI, calling
823 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)} to retrieve
824 * cursors for data being displayed, etc.
825 *
826 * <p>You can call {@link #finish} from within this function, in
827 * which case onDestroy() will be immediately called without any of the rest
828 * of the activity lifecycle ({@link #onStart}, {@link #onResume},
829 * {@link #onPause}, etc) executing.
830 *
831 * <p><em>Derived classes must call through to the super class's
832 * implementation of this method. If they do not, an exception will be
833 * thrown.</em></p>
834 *
835 * @param savedInstanceState If the activity is being re-initialized after
836 * previously being shut down then this Bundle contains the data it most
837 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
838 *
839 * @see #onStart
840 * @see #onSaveInstanceState
841 * @see #onRestoreInstanceState
842 * @see #onPostCreate
843 */
844 protected void onCreate(Bundle savedInstanceState) {
Dianne Hackbornbfe319e2009-09-21 00:34:05 -0700845 mVisibleFromClient = !mWindow.getWindowStyle().getBoolean(
846 com.android.internal.R.styleable.Window_windowNoDisplay, false);
Dianne Hackborn2707d602010-07-09 18:01:20 -0700847 if (mLastNonConfigurationInstances != null) {
848 mAllLoaderManagers = mLastNonConfigurationInstances.loaders;
849 }
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700850 if (savedInstanceState != null) {
851 Parcelable p = savedInstanceState.getParcelable(FRAGMENTS_TAG);
852 mFragments.restoreAllState(p, mLastNonConfigurationInstances != null
853 ? mLastNonConfigurationInstances.fragments : null);
854 }
855 mFragments.dispatchCreate();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800856 mCalled = true;
857 }
858
859 /**
860 * The hook for {@link ActivityThread} to restore the state of this activity.
861 *
862 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and
863 * {@link #restoreManagedDialogs(android.os.Bundle)}.
864 *
865 * @param savedInstanceState contains the saved state
866 */
867 final void performRestoreInstanceState(Bundle savedInstanceState) {
868 onRestoreInstanceState(savedInstanceState);
869 restoreManagedDialogs(savedInstanceState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800870 }
871
872 /**
873 * This method is called after {@link #onStart} when the activity is
874 * being re-initialized from a previously saved state, given here in
Mike LeBeau305de9d2010-03-11 09:21:08 -0800875 * <var>savedInstanceState</var>. Most implementations will simply use {@link #onCreate}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800876 * to restore their state, but it is sometimes convenient to do it here
877 * after all of the initialization has been done or to allow subclasses to
878 * decide whether to use your default implementation. The default
879 * implementation of this method performs a restore of any view state that
880 * had previously been frozen by {@link #onSaveInstanceState}.
881 *
882 * <p>This method is called between {@link #onStart} and
883 * {@link #onPostCreate}.
884 *
885 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}.
886 *
887 * @see #onCreate
888 * @see #onPostCreate
889 * @see #onResume
890 * @see #onSaveInstanceState
891 */
892 protected void onRestoreInstanceState(Bundle savedInstanceState) {
893 if (mWindow != null) {
894 Bundle windowState = savedInstanceState.getBundle(WINDOW_HIERARCHY_TAG);
895 if (windowState != null) {
896 mWindow.restoreHierarchyState(windowState);
897 }
898 }
899 }
900
901 /**
902 * Restore the state of any saved managed dialogs.
903 *
904 * @param savedInstanceState The bundle to restore from.
905 */
906 private void restoreManagedDialogs(Bundle savedInstanceState) {
907 final Bundle b = savedInstanceState.getBundle(SAVED_DIALOGS_TAG);
908 if (b == null) {
909 return;
910 }
911
912 final int[] ids = b.getIntArray(SAVED_DIALOG_IDS_KEY);
913 final int numDialogs = ids.length;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800914 mManagedDialogs = new SparseArray<ManagedDialog>(numDialogs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800915 for (int i = 0; i < numDialogs; i++) {
916 final Integer dialogId = ids[i];
917 Bundle dialogState = b.getBundle(savedDialogKeyFor(dialogId));
918 if (dialogState != null) {
Romain Guye35c2352009-06-19 13:18:12 -0700919 // Calling onRestoreInstanceState() below will invoke dispatchOnCreate
920 // so tell createDialog() not to do it, otherwise we get an exception
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800921 final ManagedDialog md = new ManagedDialog();
922 md.mArgs = b.getBundle(savedDialogArgsKeyFor(dialogId));
923 md.mDialog = createDialog(dialogId, dialogState, md.mArgs);
924 if (md.mDialog != null) {
925 mManagedDialogs.put(dialogId, md);
926 onPrepareDialog(dialogId, md.mDialog, md.mArgs);
927 md.mDialog.onRestoreInstanceState(dialogState);
928 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800929 }
930 }
931 }
932
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800933 private Dialog createDialog(Integer dialogId, Bundle state, Bundle args) {
934 final Dialog dialog = onCreateDialog(dialogId, args);
Romain Guy764d5332009-06-17 16:52:22 -0700935 if (dialog == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800936 return null;
Romain Guy764d5332009-06-17 16:52:22 -0700937 }
Romain Guy6de4aed2009-07-08 10:54:45 -0700938 dialog.dispatchOnCreate(state);
Romain Guy764d5332009-06-17 16:52:22 -0700939 return dialog;
940 }
941
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800942 private static String savedDialogKeyFor(int key) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800943 return SAVED_DIALOG_KEY_PREFIX + key;
944 }
945
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800946 private static String savedDialogArgsKeyFor(int key) {
947 return SAVED_DIALOG_ARGS_KEY_PREFIX + key;
948 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800949
950 /**
951 * Called when activity start-up is complete (after {@link #onStart}
952 * and {@link #onRestoreInstanceState} have been called). Applications will
953 * generally not implement this method; it is intended for system
954 * classes to do final initialization after application code has run.
955 *
956 * <p><em>Derived classes must call through to the super class's
957 * implementation of this method. If they do not, an exception will be
958 * thrown.</em></p>
959 *
960 * @param savedInstanceState If the activity is being re-initialized after
961 * previously being shut down then this Bundle contains the data it most
962 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
963 * @see #onCreate
964 */
965 protected void onPostCreate(Bundle savedInstanceState) {
966 if (!isChild()) {
967 mTitleReady = true;
968 onTitleChanged(getTitle(), getTitleColor());
969 }
970 mCalled = true;
971 }
972
973 /**
974 * Called after {@link #onCreate} &mdash; or after {@link #onRestart} when
975 * the activity had been stopped, but is now again being displayed to the
976 * user. It will be followed by {@link #onResume}.
977 *
978 * <p><em>Derived classes must call through to the super class's
979 * implementation of this method. If they do not, an exception will be
980 * thrown.</em></p>
981 *
982 * @see #onCreate
983 * @see #onStop
984 * @see #onResume
985 */
986 protected void onStart() {
987 mCalled = true;
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -0700988
989 if (!mLoadersStarted) {
990 mLoadersStarted = true;
991 if (mLoaderManager != null) {
992 mLoaderManager.doStart();
993 } else if (!mCheckedForLoaderManager) {
994 mLoaderManager = getLoaderManager(-1, mLoadersStarted, false);
995 }
996 mCheckedForLoaderManager = true;
Dianne Hackborn2707d602010-07-09 18:01:20 -0700997 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800998 }
999
1000 /**
1001 * Called after {@link #onStop} when the current activity is being
1002 * re-displayed to the user (the user has navigated back to it). It will
1003 * be followed by {@link #onStart} and then {@link #onResume}.
1004 *
1005 * <p>For activities that are using raw {@link Cursor} objects (instead of
1006 * creating them through
1007 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)},
1008 * this is usually the place
1009 * where the cursor should be requeried (because you had deactivated it in
1010 * {@link #onStop}.
1011 *
1012 * <p><em>Derived classes must call through to the super class's
1013 * implementation of this method. If they do not, an exception will be
1014 * thrown.</em></p>
1015 *
1016 * @see #onStop
1017 * @see #onStart
1018 * @see #onResume
1019 */
1020 protected void onRestart() {
1021 mCalled = true;
1022 }
1023
1024 /**
1025 * Called after {@link #onRestoreInstanceState}, {@link #onRestart}, or
1026 * {@link #onPause}, for your activity to start interacting with the user.
1027 * This is a good place to begin animations, open exclusive-access devices
1028 * (such as the camera), etc.
1029 *
1030 * <p>Keep in mind that onResume is not the best indicator that your activity
1031 * is visible to the user; a system window such as the keyguard may be in
1032 * front. Use {@link #onWindowFocusChanged} to know for certain that your
1033 * activity is visible to the user (for example, to resume a game).
1034 *
1035 * <p><em>Derived classes must call through to the super class's
1036 * implementation of this method. If they do not, an exception will be
1037 * thrown.</em></p>
1038 *
1039 * @see #onRestoreInstanceState
1040 * @see #onRestart
1041 * @see #onPostResume
1042 * @see #onPause
1043 */
1044 protected void onResume() {
1045 mCalled = true;
1046 }
1047
1048 /**
1049 * Called when activity resume is complete (after {@link #onResume} has
1050 * been called). Applications will generally not implement this method;
1051 * it is intended for system classes to do final setup after application
1052 * resume code has run.
1053 *
1054 * <p><em>Derived classes must call through to the super class's
1055 * implementation of this method. If they do not, an exception will be
1056 * thrown.</em></p>
1057 *
1058 * @see #onResume
1059 */
1060 protected void onPostResume() {
1061 final Window win = getWindow();
1062 if (win != null) win.makeActive();
1063 mCalled = true;
1064 }
1065
1066 /**
1067 * This is called for activities that set launchMode to "singleTop" in
1068 * their package, or if a client used the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP}
1069 * flag when calling {@link #startActivity}. In either case, when the
1070 * activity is re-launched while at the top of the activity stack instead
1071 * of a new instance of the activity being started, onNewIntent() will be
1072 * called on the existing instance with the Intent that was used to
1073 * re-launch it.
1074 *
1075 * <p>An activity will always be paused before receiving a new intent, so
1076 * you can count on {@link #onResume} being called after this method.
1077 *
1078 * <p>Note that {@link #getIntent} still returns the original Intent. You
1079 * can use {@link #setIntent} to update it to this new Intent.
1080 *
1081 * @param intent The new intent that was started for the activity.
1082 *
1083 * @see #getIntent
1084 * @see #setIntent
1085 * @see #onResume
1086 */
1087 protected void onNewIntent(Intent intent) {
1088 }
1089
1090 /**
1091 * The hook for {@link ActivityThread} to save the state of this activity.
1092 *
1093 * Calls {@link #onSaveInstanceState(android.os.Bundle)}
1094 * and {@link #saveManagedDialogs(android.os.Bundle)}.
1095 *
1096 * @param outState The bundle to save the state to.
1097 */
1098 final void performSaveInstanceState(Bundle outState) {
1099 onSaveInstanceState(outState);
1100 saveManagedDialogs(outState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001101 }
1102
1103 /**
1104 * Called to retrieve per-instance state from an activity before being killed
1105 * so that the state can be restored in {@link #onCreate} or
1106 * {@link #onRestoreInstanceState} (the {@link Bundle} populated by this method
1107 * will be passed to both).
1108 *
1109 * <p>This method is called before an activity may be killed so that when it
1110 * comes back some time in the future it can restore its state. For example,
1111 * if activity B is launched in front of activity A, and at some point activity
1112 * A is killed to reclaim resources, activity A will have a chance to save the
1113 * current state of its user interface via this method so that when the user
1114 * returns to activity A, the state of the user interface can be restored
1115 * via {@link #onCreate} or {@link #onRestoreInstanceState}.
1116 *
1117 * <p>Do not confuse this method with activity lifecycle callbacks such as
1118 * {@link #onPause}, which is always called when an activity is being placed
1119 * in the background or on its way to destruction, or {@link #onStop} which
1120 * is called before destruction. One example of when {@link #onPause} and
1121 * {@link #onStop} is called and not this method is when a user navigates back
1122 * from activity B to activity A: there is no need to call {@link #onSaveInstanceState}
1123 * on B because that particular instance will never be restored, so the
1124 * system avoids calling it. An example when {@link #onPause} is called and
1125 * not {@link #onSaveInstanceState} is when activity B is launched in front of activity A:
1126 * the system may avoid calling {@link #onSaveInstanceState} on activity A if it isn't
1127 * killed during the lifetime of B since the state of the user interface of
1128 * A will stay intact.
1129 *
1130 * <p>The default implementation takes care of most of the UI per-instance
1131 * state for you by calling {@link android.view.View#onSaveInstanceState()} on each
1132 * view in the hierarchy that has an id, and by saving the id of the currently
1133 * focused view (all of which is restored by the default implementation of
1134 * {@link #onRestoreInstanceState}). If you override this method to save additional
1135 * information not captured by each individual view, you will likely want to
1136 * call through to the default implementation, otherwise be prepared to save
1137 * all of the state of each view yourself.
1138 *
1139 * <p>If called, this method will occur before {@link #onStop}. There are
1140 * no guarantees about whether it will occur before or after {@link #onPause}.
1141 *
1142 * @param outState Bundle in which to place your saved state.
1143 *
1144 * @see #onCreate
1145 * @see #onRestoreInstanceState
1146 * @see #onPause
1147 */
1148 protected void onSaveInstanceState(Bundle outState) {
1149 outState.putBundle(WINDOW_HIERARCHY_TAG, mWindow.saveHierarchyState());
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001150 Parcelable p = mFragments.saveAllState();
1151 if (p != null) {
1152 outState.putParcelable(FRAGMENTS_TAG, p);
1153 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001154 }
1155
1156 /**
1157 * Save the state of any managed dialogs.
1158 *
1159 * @param outState place to store the saved state.
1160 */
1161 private void saveManagedDialogs(Bundle outState) {
1162 if (mManagedDialogs == null) {
1163 return;
1164 }
1165
1166 final int numDialogs = mManagedDialogs.size();
1167 if (numDialogs == 0) {
1168 return;
1169 }
1170
1171 Bundle dialogState = new Bundle();
1172
1173 int[] ids = new int[mManagedDialogs.size()];
1174
1175 // save each dialog's bundle, gather the ids
1176 for (int i = 0; i < numDialogs; i++) {
1177 final int key = mManagedDialogs.keyAt(i);
1178 ids[i] = key;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001179 final ManagedDialog md = mManagedDialogs.valueAt(i);
1180 dialogState.putBundle(savedDialogKeyFor(key), md.mDialog.onSaveInstanceState());
1181 if (md.mArgs != null) {
1182 dialogState.putBundle(savedDialogArgsKeyFor(key), md.mArgs);
1183 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001184 }
1185
1186 dialogState.putIntArray(SAVED_DIALOG_IDS_KEY, ids);
1187 outState.putBundle(SAVED_DIALOGS_TAG, dialogState);
1188 }
1189
1190
1191 /**
1192 * Called as part of the activity lifecycle when an activity is going into
1193 * the background, but has not (yet) been killed. The counterpart to
1194 * {@link #onResume}.
1195 *
1196 * <p>When activity B is launched in front of activity A, this callback will
1197 * be invoked on A. B will not be created until A's {@link #onPause} returns,
1198 * so be sure to not do anything lengthy here.
1199 *
1200 * <p>This callback is mostly used for saving any persistent state the
1201 * activity is editing, to present a "edit in place" model to the user and
1202 * making sure nothing is lost if there are not enough resources to start
1203 * the new activity without first killing this one. This is also a good
1204 * place to do things like stop animations and other things that consume a
1205 * noticeable mount of CPU in order to make the switch to the next activity
1206 * as fast as possible, or to close resources that are exclusive access
1207 * such as the camera.
1208 *
1209 * <p>In situations where the system needs more memory it may kill paused
1210 * processes to reclaim resources. Because of this, you should be sure
1211 * that all of your state is saved by the time you return from
1212 * this function. In general {@link #onSaveInstanceState} is used to save
1213 * per-instance state in the activity and this method is used to store
1214 * global persistent data (in content providers, files, etc.)
1215 *
1216 * <p>After receiving this call you will usually receive a following call
1217 * to {@link #onStop} (after the next activity has been resumed and
1218 * displayed), however in some cases there will be a direct call back to
1219 * {@link #onResume} without going through the stopped state.
1220 *
1221 * <p><em>Derived classes must call through to the super class's
1222 * implementation of this method. If they do not, an exception will be
1223 * thrown.</em></p>
1224 *
1225 * @see #onResume
1226 * @see #onSaveInstanceState
1227 * @see #onStop
1228 */
1229 protected void onPause() {
1230 mCalled = true;
1231 }
1232
1233 /**
1234 * Called as part of the activity lifecycle when an activity is about to go
1235 * into the background as the result of user choice. For example, when the
1236 * user presses the Home key, {@link #onUserLeaveHint} will be called, but
1237 * when an incoming phone call causes the in-call Activity to be automatically
1238 * brought to the foreground, {@link #onUserLeaveHint} will not be called on
1239 * the activity being interrupted. In cases when it is invoked, this method
1240 * is called right before the activity's {@link #onPause} callback.
1241 *
1242 * <p>This callback and {@link #onUserInteraction} are intended to help
1243 * activities manage status bar notifications intelligently; specifically,
1244 * for helping activities determine the proper time to cancel a notfication.
1245 *
1246 * @see #onUserInteraction()
1247 */
1248 protected void onUserLeaveHint() {
1249 }
1250
1251 /**
1252 * Generate a new thumbnail for this activity. This method is called before
1253 * pausing the activity, and should draw into <var>outBitmap</var> the
1254 * imagery for the desired thumbnail in the dimensions of that bitmap. It
1255 * can use the given <var>canvas</var>, which is configured to draw into the
1256 * bitmap, for rendering if desired.
1257 *
1258 * <p>The default implementation renders the Screen's current view
1259 * hierarchy into the canvas to generate a thumbnail.
1260 *
1261 * <p>If you return false, the bitmap will be filled with a default
1262 * thumbnail.
1263 *
1264 * @param outBitmap The bitmap to contain the thumbnail.
1265 * @param canvas Can be used to render into the bitmap.
1266 *
1267 * @return Return true if you have drawn into the bitmap; otherwise after
1268 * you return it will be filled with a default thumbnail.
1269 *
1270 * @see #onCreateDescription
1271 * @see #onSaveInstanceState
1272 * @see #onPause
1273 */
1274 public boolean onCreateThumbnail(Bitmap outBitmap, Canvas canvas) {
Jim Miller0b2a6d02010-07-13 18:01:29 -07001275 if (mDecor == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001276 return false;
1277 }
1278
Jim Miller0b2a6d02010-07-13 18:01:29 -07001279 int paddingLeft = 0;
1280 int paddingRight = 0;
1281 int paddingTop = 0;
1282 int paddingBottom = 0;
1283
1284 // Find System window and use padding so we ignore space reserved for decorations
1285 // like the status bar and such.
1286 final FrameLayout top = (FrameLayout) mDecor;
1287 for (int i = 0; i < top.getChildCount(); i++) {
1288 View child = top.getChildAt(i);
1289 if (child.isFitsSystemWindowsFlagSet()) {
1290 paddingLeft = child.getPaddingLeft();
1291 paddingRight = child.getPaddingRight();
1292 paddingTop = child.getPaddingTop();
1293 paddingBottom = child.getPaddingBottom();
1294 break;
1295 }
1296 }
1297
1298 final int visibleWidth = mDecor.getWidth() - paddingLeft - paddingRight;
1299 final int visibleHeight = mDecor.getHeight() - paddingTop - paddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001300
1301 canvas.save();
Jim Miller0b2a6d02010-07-13 18:01:29 -07001302 canvas.scale( (float) outBitmap.getWidth() / visibleWidth,
1303 (float) outBitmap.getHeight() / visibleHeight);
1304 canvas.translate(-paddingLeft, -paddingTop);
1305 mDecor.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001306 canvas.restore();
1307
1308 return true;
1309 }
1310
1311 /**
1312 * Generate a new description for this activity. This method is called
1313 * before pausing the activity and can, if desired, return some textual
1314 * description of its current state to be displayed to the user.
1315 *
1316 * <p>The default implementation returns null, which will cause you to
1317 * inherit the description from the previous activity. If all activities
1318 * return null, generally the label of the top activity will be used as the
1319 * description.
1320 *
1321 * @return A description of what the user is doing. It should be short and
1322 * sweet (only a few words).
1323 *
1324 * @see #onCreateThumbnail
1325 * @see #onSaveInstanceState
1326 * @see #onPause
1327 */
1328 public CharSequence onCreateDescription() {
1329 return null;
1330 }
1331
1332 /**
1333 * Called when you are no longer visible to the user. You will next
1334 * receive either {@link #onRestart}, {@link #onDestroy}, or nothing,
1335 * depending on later user activity.
1336 *
1337 * <p>Note that this method may never be called, in low memory situations
1338 * where the system does not have enough memory to keep your activity's
1339 * process running after its {@link #onPause} method is called.
1340 *
1341 * <p><em>Derived classes must call through to the super class's
1342 * implementation of this method. If they do not, an exception will be
1343 * thrown.</em></p>
1344 *
1345 * @see #onRestart
1346 * @see #onResume
1347 * @see #onSaveInstanceState
1348 * @see #onDestroy
1349 */
1350 protected void onStop() {
1351 mCalled = true;
1352 }
1353
1354 /**
1355 * Perform any final cleanup before an activity is destroyed. This can
1356 * happen either because the activity is finishing (someone called
1357 * {@link #finish} on it, or because the system is temporarily destroying
1358 * this instance of the activity to save space. You can distinguish
1359 * between these two scenarios with the {@link #isFinishing} method.
1360 *
1361 * <p><em>Note: do not count on this method being called as a place for
1362 * saving data! For example, if an activity is editing data in a content
1363 * provider, those edits should be committed in either {@link #onPause} or
1364 * {@link #onSaveInstanceState}, not here.</em> This method is usually implemented to
1365 * free resources like threads that are associated with an activity, so
1366 * that a destroyed activity does not leave such things around while the
1367 * rest of its application is still running. There are situations where
1368 * the system will simply kill the activity's hosting process without
1369 * calling this method (or any others) in it, so it should not be used to
1370 * do things that are intended to remain around after the process goes
1371 * away.
1372 *
1373 * <p><em>Derived classes must call through to the super class's
1374 * implementation of this method. If they do not, an exception will be
1375 * thrown.</em></p>
1376 *
1377 * @see #onPause
1378 * @see #onStop
1379 * @see #finish
1380 * @see #isFinishing
1381 */
1382 protected void onDestroy() {
1383 mCalled = true;
1384
1385 // dismiss any dialogs we are managing.
1386 if (mManagedDialogs != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001387 final int numDialogs = mManagedDialogs.size();
1388 for (int i = 0; i < numDialogs; i++) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001389 final ManagedDialog md = mManagedDialogs.valueAt(i);
1390 if (md.mDialog.isShowing()) {
1391 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001392 }
1393 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001394 mManagedDialogs = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001395 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001396
1397 // close any cursors we are managing.
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001398 synchronized (mManagedCursors) {
1399 int numCursors = mManagedCursors.size();
1400 for (int i = 0; i < numCursors; i++) {
1401 ManagedCursor c = mManagedCursors.get(i);
1402 if (c != null) {
1403 c.mCursor.close();
1404 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001405 }
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001406 mManagedCursors.clear();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001407 }
Amith Yamasani49860442010-03-17 20:54:10 -07001408
1409 // Close any open search dialog
1410 if (mSearchManager != null) {
1411 mSearchManager.stopSearch();
1412 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001413 }
1414
1415 /**
1416 * Called by the system when the device configuration changes while your
1417 * activity is running. Note that this will <em>only</em> be called if
1418 * you have selected configurations you would like to handle with the
1419 * {@link android.R.attr#configChanges} attribute in your manifest. If
1420 * any configuration change occurs that is not selected to be reported
1421 * by that attribute, then instead of reporting it the system will stop
1422 * and restart the activity (to have it launched with the new
1423 * configuration).
1424 *
1425 * <p>At the time that this function has been called, your Resources
1426 * object will have been updated to return resource values matching the
1427 * new configuration.
1428 *
1429 * @param newConfig The new device configuration.
1430 */
1431 public void onConfigurationChanged(Configuration newConfig) {
1432 mCalled = true;
Bjorn Bringert444c7272009-07-06 21:32:50 +01001433
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001434 if (mWindow != null) {
1435 // Pass the configuration changed event to the window
1436 mWindow.onConfigurationChanged(newConfig);
1437 }
1438 }
1439
1440 /**
1441 * If this activity is being destroyed because it can not handle a
1442 * configuration parameter being changed (and thus its
1443 * {@link #onConfigurationChanged(Configuration)} method is
1444 * <em>not</em> being called), then you can use this method to discover
1445 * the set of changes that have occurred while in the process of being
1446 * destroyed. Note that there is no guarantee that these will be
1447 * accurate (other changes could have happened at any time), so you should
1448 * only use this as an optimization hint.
1449 *
1450 * @return Returns a bit field of the configuration parameters that are
1451 * changing, as defined by the {@link android.content.res.Configuration}
1452 * class.
1453 */
1454 public int getChangingConfigurations() {
1455 return mConfigChangeFlags;
1456 }
1457
1458 /**
1459 * Retrieve the non-configuration instance data that was previously
1460 * returned by {@link #onRetainNonConfigurationInstance()}. This will
1461 * be available from the initial {@link #onCreate} and
1462 * {@link #onStart} calls to the new instance, allowing you to extract
1463 * any useful dynamic state from the previous instance.
1464 *
1465 * <p>Note that the data you retrieve here should <em>only</em> be used
1466 * as an optimization for handling configuration changes. You should always
1467 * be able to handle getting a null pointer back, and an activity must
1468 * still be able to restore itself to its previous state (through the
1469 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1470 * function returns null.
1471 *
1472 * @return Returns the object previously returned by
1473 * {@link #onRetainNonConfigurationInstance()}.
1474 */
1475 public Object getLastNonConfigurationInstance() {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001476 return mLastNonConfigurationInstances != null
1477 ? mLastNonConfigurationInstances.activity : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001478 }
1479
1480 /**
1481 * Called by the system, as part of destroying an
1482 * activity due to a configuration change, when it is known that a new
1483 * instance will immediately be created for the new configuration. You
1484 * can return any object you like here, including the activity instance
1485 * itself, which can later be retrieved by calling
1486 * {@link #getLastNonConfigurationInstance()} in the new activity
1487 * instance.
1488 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001489 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1490 * or later, consider instead using a {@link Fragment} with
1491 * {@link Fragment#setRetainInstance(boolean)
1492 * Fragment.setRetainInstance(boolean}.</em>
1493 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001494 * <p>This function is called purely as an optimization, and you must
1495 * not rely on it being called. When it is called, a number of guarantees
1496 * will be made to help optimize configuration switching:
1497 * <ul>
1498 * <li> The function will be called between {@link #onStop} and
1499 * {@link #onDestroy}.
1500 * <li> A new instance of the activity will <em>always</em> be immediately
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001501 * created after this one's {@link #onDestroy()} is called. In particular,
1502 * <em>no</em> messages will be dispatched during this time (when the returned
1503 * object does not have an activity to be associated with).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001504 * <li> The object you return here will <em>always</em> be available from
1505 * the {@link #getLastNonConfigurationInstance()} method of the following
1506 * activity instance as described there.
1507 * </ul>
1508 *
1509 * <p>These guarantees are designed so that an activity can use this API
1510 * to propagate extensive state from the old to new activity instance, from
1511 * loaded bitmaps, to network connections, to evenly actively running
1512 * threads. Note that you should <em>not</em> propagate any data that
1513 * may change based on the configuration, including any data loaded from
1514 * resources such as strings, layouts, or drawables.
1515 *
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001516 * <p>The guarantee of no message handling during the switch to the next
1517 * activity simplifies use with active objects. For example if your retained
1518 * state is an {@link android.os.AsyncTask} you are guaranteed that its
1519 * call back functions (like {@link android.os.AsyncTask#onPostExecute}) will
1520 * not be called from the call here until you execute the next instance's
1521 * {@link #onCreate(Bundle)}. (Note however that there is of course no such
1522 * guarantee for {@link android.os.AsyncTask#doInBackground} since that is
1523 * running in a separate thread.)
1524 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001525 * @return Return any Object holding the desired state to propagate to the
1526 * next activity instance.
1527 */
1528 public Object onRetainNonConfigurationInstance() {
1529 return null;
1530 }
1531
1532 /**
1533 * Retrieve the non-configuration instance data that was previously
1534 * returned by {@link #onRetainNonConfigurationChildInstances()}. This will
1535 * be available from the initial {@link #onCreate} and
1536 * {@link #onStart} calls to the new instance, allowing you to extract
1537 * any useful dynamic state from the previous instance.
1538 *
1539 * <p>Note that the data you retrieve here should <em>only</em> be used
1540 * as an optimization for handling configuration changes. You should always
1541 * be able to handle getting a null pointer back, and an activity must
1542 * still be able to restore itself to its previous state (through the
1543 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1544 * function returns null.
1545 *
1546 * @return Returns the object previously returned by
1547 * {@link #onRetainNonConfigurationChildInstances()}
1548 */
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001549 HashMap<String, Object> getLastNonConfigurationChildInstances() {
1550 return mLastNonConfigurationInstances != null
1551 ? mLastNonConfigurationInstances.children : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552 }
1553
1554 /**
1555 * This method is similar to {@link #onRetainNonConfigurationInstance()} except that
1556 * it should return either a mapping from child activity id strings to arbitrary objects,
1557 * or null. This method is intended to be used by Activity framework subclasses that control a
1558 * set of child activities, such as ActivityGroup. The same guarantees and restrictions apply
1559 * as for {@link #onRetainNonConfigurationInstance()}. The default implementation returns null.
1560 */
1561 HashMap<String,Object> onRetainNonConfigurationChildInstances() {
1562 return null;
1563 }
1564
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001565 NonConfigurationInstances retainNonConfigurationInstances() {
1566 Object activity = onRetainNonConfigurationInstance();
1567 HashMap<String, Object> children = onRetainNonConfigurationChildInstances();
1568 ArrayList<Fragment> fragments = mFragments.retainNonConfig();
Dianne Hackborn2707d602010-07-09 18:01:20 -07001569 boolean retainLoaders = false;
1570 if (mAllLoaderManagers != null) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001571 // prune out any loader managers that were already stopped and so
Dianne Hackborn2707d602010-07-09 18:01:20 -07001572 // have nothing useful to retain.
1573 for (int i=mAllLoaderManagers.size()-1; i>=0; i--) {
Dianne Hackborn4911b782010-07-15 12:54:39 -07001574 LoaderManagerImpl lm = mAllLoaderManagers.valueAt(i);
Dianne Hackborn2707d602010-07-09 18:01:20 -07001575 if (lm.mRetaining) {
1576 retainLoaders = true;
1577 } else {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001578 lm.doDestroy();
Dianne Hackborn2707d602010-07-09 18:01:20 -07001579 mAllLoaderManagers.removeAt(i);
1580 }
1581 }
1582 }
1583 if (activity == null && children == null && fragments == null && !retainLoaders) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001584 return null;
1585 }
1586
1587 NonConfigurationInstances nci = new NonConfigurationInstances();
1588 nci.activity = activity;
1589 nci.children = children;
1590 nci.fragments = fragments;
Dianne Hackborn2707d602010-07-09 18:01:20 -07001591 nci.loaders = mAllLoaderManagers;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001592 return nci;
1593 }
1594
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001595 public void onLowMemory() {
1596 mCalled = true;
1597 }
1598
1599 /**
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07001600 * Return the FragmentManager for interacting with fragments associated
1601 * with this activity.
1602 */
1603 public FragmentManager getFragmentManager() {
1604 return mFragments;
1605 }
1606
1607 /**
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001608 * Start a series of edit operations on the Fragments associated with
1609 * this activity.
Dianne Hackborndef15372010-08-15 12:43:52 -07001610 * @deprecated use {@link #getFragmentManager}.
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001611 */
Dianne Hackborndef15372010-08-15 12:43:52 -07001612 @Deprecated
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001613 public FragmentTransaction openFragmentTransaction() {
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07001614 return mFragments.openTransaction();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001615 }
1616
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001617 void invalidateFragmentIndex(int index) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001618 //Log.v(TAG, "invalidateFragmentIndex: index=" + index);
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001619 if (mAllLoaderManagers != null) {
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07001620 LoaderManagerImpl lm = mAllLoaderManagers.get(index);
1621 if (lm != null) {
1622 lm.doDestroy();
1623 }
Dianne Hackborn9e14e9f32010-07-14 11:07:38 -07001624 mAllLoaderManagers.remove(index);
1625 }
1626 }
1627
Dianne Hackborn2dedce62010-04-15 14:45:25 -07001628 /**
Dianne Hackbornc8017682010-07-06 13:34:38 -07001629 * Called when a Fragment is being attached to this activity, immediately
1630 * after the call to its {@link Fragment#onAttach Fragment.onAttach()}
1631 * method and before {@link Fragment#onCreate Fragment.onCreate()}.
1632 */
1633 public void onAttachFragment(Fragment fragment) {
1634 }
1635
1636 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001637 * Wrapper around
1638 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1639 * that gives the resulting {@link Cursor} to call
1640 * {@link #startManagingCursor} so that the activity will manage its
1641 * lifecycle for you.
1642 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001643 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1644 * or later, consider instead using {@link LoaderManager} instead, available
1645 * via {@link #getLoaderManager()}.</em>
1646 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001647 * @param uri The URI of the content provider to query.
1648 * @param projection List of columns to return.
1649 * @param selection SQL WHERE clause.
1650 * @param sortOrder SQL ORDER BY clause.
1651 *
1652 * @return The Cursor that was returned by query().
1653 *
1654 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1655 * @see #startManagingCursor
1656 * @hide
Jason parks6ed50de2010-08-25 10:18:50 -05001657 *
1658 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001659 */
Jason parks6ed50de2010-08-25 10:18:50 -05001660 @Deprecated
Dianne Hackborn291905e2010-08-17 15:17:15 -07001661 public final Cursor managedQuery(Uri uri, String[] projection, String selection,
1662 String sortOrder) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001663 Cursor c = getContentResolver().query(uri, projection, selection, null, sortOrder);
1664 if (c != null) {
1665 startManagingCursor(c);
1666 }
1667 return c;
1668 }
1669
1670 /**
1671 * Wrapper around
1672 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1673 * that gives the resulting {@link Cursor} to call
1674 * {@link #startManagingCursor} so that the activity will manage its
1675 * lifecycle for you.
1676 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001677 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1678 * or later, consider instead using {@link LoaderManager} instead, available
1679 * via {@link #getLoaderManager()}.</em>
1680 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001681 * @param uri The URI of the content provider to query.
1682 * @param projection List of columns to return.
1683 * @param selection SQL WHERE clause.
1684 * @param selectionArgs The arguments to selection, if any ?s are pesent
1685 * @param sortOrder SQL ORDER BY clause.
1686 *
1687 * @return The Cursor that was returned by query().
1688 *
1689 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1690 * @see #startManagingCursor
Jason parks6ed50de2010-08-25 10:18:50 -05001691 *
1692 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001693 */
Jason parks6ed50de2010-08-25 10:18:50 -05001694 @Deprecated
Dianne Hackborn291905e2010-08-17 15:17:15 -07001695 public final Cursor managedQuery(Uri uri, String[] projection, String selection,
1696 String[] selectionArgs, String sortOrder) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001697 Cursor c = getContentResolver().query(uri, projection, selection, selectionArgs, sortOrder);
1698 if (c != null) {
1699 startManagingCursor(c);
1700 }
1701 return c;
1702 }
1703
1704 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001705 * This method allows the activity to take care of managing the given
1706 * {@link Cursor}'s lifecycle for you based on the activity's lifecycle.
1707 * That is, when the activity is stopped it will automatically call
1708 * {@link Cursor#deactivate} on the given Cursor, and when it is later restarted
1709 * it will call {@link Cursor#requery} for you. When the activity is
1710 * destroyed, all managed Cursors will be closed automatically.
1711 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07001712 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
1713 * or later, consider instead using {@link LoaderManager} instead, available
1714 * via {@link #getLoaderManager()}.</em>
1715 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001716 * @param c The Cursor to be managed.
1717 *
1718 * @see #managedQuery(android.net.Uri , String[], String, String[], String)
1719 * @see #stopManagingCursor
Jason parks6ed50de2010-08-25 10:18:50 -05001720 *
1721 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001722 */
Jason parks6ed50de2010-08-25 10:18:50 -05001723 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001724 public void startManagingCursor(Cursor c) {
1725 synchronized (mManagedCursors) {
1726 mManagedCursors.add(new ManagedCursor(c));
1727 }
1728 }
1729
1730 /**
1731 * Given a Cursor that was previously given to
1732 * {@link #startManagingCursor}, stop the activity's management of that
1733 * cursor.
1734 *
1735 * @param c The Cursor that was being managed.
1736 *
1737 * @see #startManagingCursor
Jason parks6ed50de2010-08-25 10:18:50 -05001738 *
1739 * @deprecated Use {@link CursorLoader} instead.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001740 */
Jason parks6ed50de2010-08-25 10:18:50 -05001741 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001742 public void stopManagingCursor(Cursor c) {
1743 synchronized (mManagedCursors) {
1744 final int N = mManagedCursors.size();
1745 for (int i=0; i<N; i++) {
1746 ManagedCursor mc = mManagedCursors.get(i);
1747 if (mc.mCursor == c) {
1748 mManagedCursors.remove(i);
1749 break;
1750 }
1751 }
1752 }
1753 }
1754
1755 /**
Dianne Hackborn3c4c2b72010-10-05 18:07:54 -07001756 * @deprecated As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}
1757 * this is a no-op.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001758 */
Dianne Hackbornd3efa392010-09-01 17:34:12 -07001759 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001760 public void setPersistent(boolean isPersistent) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001761 }
1762
1763 /**
1764 * Finds a view that was identified by the id attribute from the XML that
1765 * was processed in {@link #onCreate}.
1766 *
1767 * @return The view if found or null otherwise.
1768 */
1769 public View findViewById(int id) {
1770 return getWindow().findViewById(id);
1771 }
Adam Powell33b97432010-04-20 10:01:14 -07001772
1773 /**
1774 * Retrieve a reference to this activity's ActionBar.
Adam Powell42c0fe82010-08-10 16:36:56 -07001775 *
Adam Powell33b97432010-04-20 10:01:14 -07001776 * @return The Activity's ActionBar, or null if it does not have one.
1777 */
1778 public ActionBar getActionBar() {
Adam Powell42c0fe82010-08-10 16:36:56 -07001779 initActionBar();
Adam Powell33b97432010-04-20 10:01:14 -07001780 return mActionBar;
1781 }
1782
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001783 /**
Adam Powell33b97432010-04-20 10:01:14 -07001784 * Creates a new ActionBar, locates the inflated ActionBarView,
1785 * initializes the ActionBar with the view, and sets mActionBar.
1786 */
1787 private void initActionBar() {
Adam Powell89e06452010-06-23 20:24:52 -07001788 Window window = getWindow();
Adam Powell9b4c8042010-08-10 15:36:44 -07001789 if (isChild() || !window.hasFeature(Window.FEATURE_ACTION_BAR) || mActionBar != null) {
Adam Powell33b97432010-04-20 10:01:14 -07001790 return;
1791 }
1792
Adam Powell661c9082010-07-02 10:09:44 -07001793 mActionBar = new ActionBarImpl(this);
Adam Powell33b97432010-04-20 10:01:14 -07001794 }
1795
1796 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001797 * Finds a fragment that was identified by the given id either when inflated
1798 * from XML or as the container ID when added in a transaction. This only
1799 * returns fragments that are currently added to the activity's content.
1800 * @return The fragment if found or null otherwise.
Dianne Hackborndef15372010-08-15 12:43:52 -07001801 * @deprecated use {@link #getFragmentManager}.
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001802 */
Dianne Hackborndef15372010-08-15 12:43:52 -07001803 @Deprecated
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001804 public Fragment findFragmentById(int id) {
1805 return mFragments.findFragmentById(id);
1806 }
1807
1808 /**
1809 * Finds a fragment that was identified by the given tag either when inflated
1810 * from XML or as supplied when added in a transaction. This only
1811 * returns fragments that are currently added to the activity's content.
1812 * @return The fragment if found or null otherwise.
Dianne Hackborndef15372010-08-15 12:43:52 -07001813 * @deprecated use {@link #getFragmentManager}.
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001814 */
Dianne Hackborndef15372010-08-15 12:43:52 -07001815 @Deprecated
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07001816 public Fragment findFragmentByTag(String tag) {
1817 return mFragments.findFragmentByTag(tag);
1818 }
1819
1820 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001821 * Set the activity content from a layout resource. The resource will be
1822 * inflated, adding all top-level views to the activity.
1823 *
1824 * @param layoutResID Resource ID to be inflated.
1825 */
1826 public void setContentView(int layoutResID) {
1827 getWindow().setContentView(layoutResID);
Adam Powell33b97432010-04-20 10:01:14 -07001828 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001829 }
1830
1831 /**
1832 * Set the activity content to an explicit view. This view is placed
1833 * directly into the activity's view hierarchy. It can itself be a complex
1834 * view hierarhcy.
1835 *
1836 * @param view The desired content to display.
1837 */
1838 public void setContentView(View view) {
1839 getWindow().setContentView(view);
Adam Powell33b97432010-04-20 10:01:14 -07001840 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001841 }
1842
1843 /**
1844 * Set the activity content to an explicit view. This view is placed
1845 * directly into the activity's view hierarchy. It can itself be a complex
1846 * view hierarhcy.
1847 *
1848 * @param view The desired content to display.
1849 * @param params Layout parameters for the view.
1850 */
1851 public void setContentView(View view, ViewGroup.LayoutParams params) {
1852 getWindow().setContentView(view, params);
Adam Powell33b97432010-04-20 10:01:14 -07001853 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001854 }
1855
1856 /**
1857 * Add an additional content view to the activity. Added after any existing
1858 * ones in the activity -- existing views are NOT removed.
1859 *
1860 * @param view The desired content to display.
1861 * @param params Layout parameters for the view.
1862 */
1863 public void addContentView(View view, ViewGroup.LayoutParams params) {
1864 getWindow().addContentView(view, params);
Adam Powell33b97432010-04-20 10:01:14 -07001865 initActionBar();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001866 }
1867
1868 /**
1869 * Use with {@link #setDefaultKeyMode} to turn off default handling of
1870 * keys.
1871 *
1872 * @see #setDefaultKeyMode
1873 */
1874 static public final int DEFAULT_KEYS_DISABLE = 0;
1875 /**
1876 * Use with {@link #setDefaultKeyMode} to launch the dialer during default
1877 * key handling.
1878 *
1879 * @see #setDefaultKeyMode
1880 */
1881 static public final int DEFAULT_KEYS_DIALER = 1;
1882 /**
1883 * Use with {@link #setDefaultKeyMode} to execute a menu shortcut in
1884 * default key handling.
1885 *
1886 * <p>That is, the user does not need to hold down the menu key to execute menu shortcuts.
1887 *
1888 * @see #setDefaultKeyMode
1889 */
1890 static public final int DEFAULT_KEYS_SHORTCUT = 2;
1891 /**
1892 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
1893 * will start an application-defined search. (If the application or activity does not
1894 * actually define a search, the the keys will be ignored.)
1895 *
1896 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
1897 *
1898 * @see #setDefaultKeyMode
1899 */
1900 static public final int DEFAULT_KEYS_SEARCH_LOCAL = 3;
1901
1902 /**
1903 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
1904 * will start a global search (typically web search, but some platforms may define alternate
1905 * methods for global search)
1906 *
1907 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
1908 *
1909 * @see #setDefaultKeyMode
1910 */
1911 static public final int DEFAULT_KEYS_SEARCH_GLOBAL = 4;
1912
1913 /**
1914 * Select the default key handling for this activity. This controls what
1915 * will happen to key events that are not otherwise handled. The default
1916 * mode ({@link #DEFAULT_KEYS_DISABLE}) will simply drop them on the
1917 * floor. Other modes allow you to launch the dialer
1918 * ({@link #DEFAULT_KEYS_DIALER}), execute a shortcut in your options
1919 * menu without requiring the menu key be held down
1920 * ({@link #DEFAULT_KEYS_SHORTCUT}), or launch a search ({@link #DEFAULT_KEYS_SEARCH_LOCAL}
1921 * and {@link #DEFAULT_KEYS_SEARCH_GLOBAL}).
1922 *
1923 * <p>Note that the mode selected here does not impact the default
1924 * handling of system keys, such as the "back" and "menu" keys, and your
1925 * activity and its views always get a first chance to receive and handle
1926 * all application keys.
1927 *
1928 * @param mode The desired default key mode constant.
1929 *
1930 * @see #DEFAULT_KEYS_DISABLE
1931 * @see #DEFAULT_KEYS_DIALER
1932 * @see #DEFAULT_KEYS_SHORTCUT
1933 * @see #DEFAULT_KEYS_SEARCH_LOCAL
1934 * @see #DEFAULT_KEYS_SEARCH_GLOBAL
1935 * @see #onKeyDown
1936 */
1937 public final void setDefaultKeyMode(int mode) {
1938 mDefaultKeyMode = mode;
1939
1940 // Some modes use a SpannableStringBuilder to track & dispatch input events
1941 // This list must remain in sync with the switch in onKeyDown()
1942 switch (mode) {
1943 case DEFAULT_KEYS_DISABLE:
1944 case DEFAULT_KEYS_SHORTCUT:
1945 mDefaultKeySsb = null; // not used in these modes
1946 break;
1947 case DEFAULT_KEYS_DIALER:
1948 case DEFAULT_KEYS_SEARCH_LOCAL:
1949 case DEFAULT_KEYS_SEARCH_GLOBAL:
1950 mDefaultKeySsb = new SpannableStringBuilder();
1951 Selection.setSelection(mDefaultKeySsb,0);
1952 break;
1953 default:
1954 throw new IllegalArgumentException();
1955 }
1956 }
1957
1958 /**
1959 * Called when a key was pressed down and not handled by any of the views
1960 * inside of the activity. So, for example, key presses while the cursor
1961 * is inside a TextView will not trigger the event (unless it is a navigation
1962 * to another object) because TextView handles its own key presses.
1963 *
1964 * <p>If the focused view didn't want this event, this method is called.
1965 *
Dianne Hackborn8d374262009-09-14 21:21:52 -07001966 * <p>The default implementation takes care of {@link KeyEvent#KEYCODE_BACK}
1967 * by calling {@link #onBackPressed()}, though the behavior varies based
1968 * on the application compatibility mode: for
1969 * {@link android.os.Build.VERSION_CODES#ECLAIR} or later applications,
1970 * it will set up the dispatch to call {@link #onKeyUp} where the action
1971 * will be performed; for earlier applications, it will perform the
1972 * action immediately in on-down, as those versions of the platform
1973 * behaved.
1974 *
1975 * <p>Other additional default key handling may be performed
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001976 * if configured with {@link #setDefaultKeyMode}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001977 *
1978 * @return Return <code>true</code> to prevent this event from being propagated
1979 * further, or <code>false</code> to indicate that you have not handled
1980 * this event and it should continue to be propagated.
1981 * @see #onKeyUp
1982 * @see android.view.KeyEvent
1983 */
1984 public boolean onKeyDown(int keyCode, KeyEvent event) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001985 if (keyCode == KeyEvent.KEYCODE_BACK) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07001986 if (getApplicationInfo().targetSdkVersion
1987 >= Build.VERSION_CODES.ECLAIR) {
1988 event.startTracking();
1989 } else {
1990 onBackPressed();
1991 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001992 return true;
1993 }
1994
1995 if (mDefaultKeyMode == DEFAULT_KEYS_DISABLE) {
1996 return false;
1997 } else if (mDefaultKeyMode == DEFAULT_KEYS_SHORTCUT) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001998 if (getWindow().performPanelShortcut(Window.FEATURE_OPTIONS_PANEL,
1999 keyCode, event, Menu.FLAG_ALWAYS_PERFORM_CLOSE)) {
2000 return true;
2001 }
2002 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002003 } else {
2004 // Common code for DEFAULT_KEYS_DIALER & DEFAULT_KEYS_SEARCH_*
2005 boolean clearSpannable = false;
2006 boolean handled;
2007 if ((event.getRepeatCount() != 0) || event.isSystem()) {
2008 clearSpannable = true;
2009 handled = false;
2010 } else {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002011 handled = TextKeyListener.getInstance().onKeyDown(
2012 null, mDefaultKeySsb, keyCode, event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002013 if (handled && mDefaultKeySsb.length() > 0) {
2014 // something useable has been typed - dispatch it now.
2015
2016 final String str = mDefaultKeySsb.toString();
2017 clearSpannable = true;
2018
2019 switch (mDefaultKeyMode) {
2020 case DEFAULT_KEYS_DIALER:
2021 Intent intent = new Intent(Intent.ACTION_DIAL, Uri.parse("tel:" + str));
2022 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2023 startActivity(intent);
2024 break;
2025 case DEFAULT_KEYS_SEARCH_LOCAL:
2026 startSearch(str, false, null, false);
2027 break;
2028 case DEFAULT_KEYS_SEARCH_GLOBAL:
2029 startSearch(str, false, null, true);
2030 break;
2031 }
2032 }
2033 }
2034 if (clearSpannable) {
2035 mDefaultKeySsb.clear();
2036 mDefaultKeySsb.clearSpans();
2037 Selection.setSelection(mDefaultKeySsb,0);
2038 }
2039 return handled;
2040 }
2041 }
2042
2043 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002044 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
2045 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
2046 * the event).
2047 */
2048 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
2049 return false;
2050 }
2051
2052 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002053 * Called when a key was released and not handled by any of the views
2054 * inside of the activity. So, for example, key presses while the cursor
2055 * is inside a TextView will not trigger the event (unless it is a navigation
2056 * to another object) because TextView handles its own key presses.
2057 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002058 * <p>The default implementation handles KEYCODE_BACK to stop the activity
2059 * and go back.
2060 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 * @return Return <code>true</code> to prevent this event from being propagated
2062 * further, or <code>false</code> to indicate that you have not handled
2063 * this event and it should continue to be propagated.
2064 * @see #onKeyDown
2065 * @see KeyEvent
2066 */
2067 public boolean onKeyUp(int keyCode, KeyEvent event) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07002068 if (getApplicationInfo().targetSdkVersion
2069 >= Build.VERSION_CODES.ECLAIR) {
2070 if (keyCode == KeyEvent.KEYCODE_BACK && event.isTracking()
2071 && !event.isCanceled()) {
2072 onBackPressed();
2073 return true;
2074 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002075 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002076 return false;
2077 }
2078
2079 /**
2080 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
2081 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
2082 * the event).
2083 */
2084 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
2085 return false;
2086 }
2087
2088 /**
Dianne Hackborndd913a52010-07-22 12:17:04 -07002089 * Flag for {@link #popBackStack(String, int)}
2090 * and {@link #popBackStack(int, int)}: If set, and the name or ID of
Dianne Hackbornb3cf10f2010-08-03 13:07:11 -07002091 * a back stack entry has been supplied, then all matching entries will
2092 * be consumed until one that doesn't match is found or the bottom of
2093 * the stack is reached. Otherwise, all entries up to but not including that entry
2094 * will be removed.
Dianne Hackborndd913a52010-07-22 12:17:04 -07002095 */
Jean-Baptiste Queru005cb6d2010-07-27 10:54:51 -07002096 public static final int POP_BACK_STACK_INCLUSIVE = 1<<0;
Dianne Hackborndd913a52010-07-22 12:17:04 -07002097
2098 /**
2099 * Pop the top state off the back stack. Returns true if there was one
2100 * to pop, else false.
Dianne Hackborndef15372010-08-15 12:43:52 -07002101 * @deprecated use {@link #getFragmentManager}.
Dianne Hackborndd913a52010-07-22 12:17:04 -07002102 */
Dianne Hackborndef15372010-08-15 12:43:52 -07002103 @Deprecated
Dianne Hackborndd913a52010-07-22 12:17:04 -07002104 public boolean popBackStack() {
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07002105 return mFragments.popBackStack();
Dianne Hackborndd913a52010-07-22 12:17:04 -07002106 }
2107
2108 /**
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07002109 * Pop the last fragment transition from the local activity's fragment
2110 * back stack. If there is nothing to pop, false is returned.
Dianne Hackbornf121be72010-05-06 14:10:32 -07002111 * @param name If non-null, this is the name of a previous back state
Dianne Hackborndd913a52010-07-22 12:17:04 -07002112 * to look for; if found, all states up to that state will be popped. The
2113 * {@link #POP_BACK_STACK_INCLUSIVE} flag can be used to control whether
2114 * the named state itself is popped. If null, only the top state is popped.
2115 * @param flags Either 0 or {@link #POP_BACK_STACK_INCLUSIVE}.
Dianne Hackborndef15372010-08-15 12:43:52 -07002116 * @deprecated use {@link #getFragmentManager}.
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07002117 */
Dianne Hackborndef15372010-08-15 12:43:52 -07002118 @Deprecated
Dianne Hackborndd913a52010-07-22 12:17:04 -07002119 public boolean popBackStack(String name, int flags) {
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07002120 return mFragments.popBackStack(name, flags);
Dianne Hackborndd913a52010-07-22 12:17:04 -07002121 }
2122
2123 /**
2124 * Pop all back stack states up to the one with the given identifier.
2125 * @param id Identifier of the stated to be popped. If no identifier exists,
2126 * false is returned.
2127 * The identifier is the number returned by
2128 * {@link FragmentTransaction#commit() FragmentTransaction.commit()}. The
2129 * {@link #POP_BACK_STACK_INCLUSIVE} flag can be used to control whether
2130 * the named state itself is popped.
2131 * @param flags Either 0 or {@link #POP_BACK_STACK_INCLUSIVE}.
Dianne Hackborndef15372010-08-15 12:43:52 -07002132 * @deprecated use {@link #getFragmentManager}.
Dianne Hackborndd913a52010-07-22 12:17:04 -07002133 */
Dianne Hackborndef15372010-08-15 12:43:52 -07002134 @Deprecated
Dianne Hackborndd913a52010-07-22 12:17:04 -07002135 public boolean popBackStack(int id, int flags) {
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07002136 return mFragments.popBackStack(id, flags);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07002137 }
2138
2139 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002140 * Called when the activity has detected the user's press of the back
2141 * key. The default implementation simply finishes the current activity,
2142 * but you can override this to do whatever you want.
2143 */
2144 public void onBackPressed() {
Dianne Hackborndef15372010-08-15 12:43:52 -07002145 if (!mFragments.popBackStack()) {
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07002146 finish();
2147 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002148 }
2149
2150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002151 * Called when a touch screen event was not handled by any of the views
2152 * under it. This is most useful to process touch events that happen
2153 * outside of your window bounds, where there is no view to receive it.
2154 *
2155 * @param event The touch screen event being processed.
2156 *
2157 * @return Return true if you have consumed the event, false if you haven't.
2158 * The default implementation always returns false.
2159 */
2160 public boolean onTouchEvent(MotionEvent event) {
2161 return false;
2162 }
2163
2164 /**
2165 * Called when the trackball was moved and not handled by any of the
2166 * views inside of the activity. So, for example, if the trackball moves
2167 * while focus is on a button, you will receive a call here because
2168 * buttons do not normally do anything with trackball events. The call
2169 * here happens <em>before</em> trackball movements are converted to
2170 * DPAD key events, which then get sent back to the view hierarchy, and
2171 * will be processed at the point for things like focus navigation.
2172 *
2173 * @param event The trackball event being processed.
2174 *
2175 * @return Return true if you have consumed the event, false if you haven't.
2176 * The default implementation always returns false.
2177 */
2178 public boolean onTrackballEvent(MotionEvent event) {
2179 return false;
2180 }
2181
2182 /**
2183 * Called whenever a key, touch, or trackball event is dispatched to the
2184 * activity. Implement this method if you wish to know that the user has
2185 * interacted with the device in some way while your activity is running.
2186 * This callback and {@link #onUserLeaveHint} are intended to help
2187 * activities manage status bar notifications intelligently; specifically,
2188 * for helping activities determine the proper time to cancel a notfication.
2189 *
2190 * <p>All calls to your activity's {@link #onUserLeaveHint} callback will
2191 * be accompanied by calls to {@link #onUserInteraction}. This
2192 * ensures that your activity will be told of relevant user activity such
2193 * as pulling down the notification pane and touching an item there.
2194 *
2195 * <p>Note that this callback will be invoked for the touch down action
2196 * that begins a touch gesture, but may not be invoked for the touch-moved
2197 * and touch-up actions that follow.
2198 *
2199 * @see #onUserLeaveHint()
2200 */
2201 public void onUserInteraction() {
2202 }
2203
2204 public void onWindowAttributesChanged(WindowManager.LayoutParams params) {
2205 // Update window manager if: we have a view, that view is
2206 // attached to its parent (which will be a RootView), and
2207 // this activity is not embedded.
2208 if (mParent == null) {
2209 View decor = mDecor;
2210 if (decor != null && decor.getParent() != null) {
2211 getWindowManager().updateViewLayout(decor, params);
2212 }
2213 }
2214 }
2215
2216 public void onContentChanged() {
2217 }
2218
2219 /**
2220 * Called when the current {@link Window} of the activity gains or loses
2221 * focus. This is the best indicator of whether this activity is visible
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002222 * to the user. The default implementation clears the key tracking
2223 * state, so should always be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002224 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002225 * <p>Note that this provides information about global focus state, which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002226 * is managed independently of activity lifecycles. As such, while focus
2227 * changes will generally have some relation to lifecycle changes (an
2228 * activity that is stopped will not generally get window focus), you
2229 * should not rely on any particular order between the callbacks here and
2230 * those in the other lifecycle methods such as {@link #onResume}.
2231 *
2232 * <p>As a general rule, however, a resumed activity will have window
2233 * focus... unless it has displayed other dialogs or popups that take
2234 * input focus, in which case the activity itself will not have focus
2235 * when the other windows have it. Likewise, the system may display
2236 * system-level windows (such as the status bar notification panel or
2237 * a system alert) which will temporarily take window input focus without
2238 * pausing the foreground activity.
2239 *
2240 * @param hasFocus Whether the window of this activity has focus.
2241 *
2242 * @see #hasWindowFocus()
2243 * @see #onResume
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002244 * @see View#onWindowFocusChanged(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002245 */
2246 public void onWindowFocusChanged(boolean hasFocus) {
2247 }
2248
2249 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002250 * Called when the main window associated with the activity has been
2251 * attached to the window manager.
2252 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
2253 * for more information.
2254 * @see View#onAttachedToWindow
2255 */
2256 public void onAttachedToWindow() {
2257 }
2258
2259 /**
2260 * Called when the main window associated with the activity has been
2261 * detached from the window manager.
2262 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
2263 * for more information.
2264 * @see View#onDetachedFromWindow
2265 */
2266 public void onDetachedFromWindow() {
2267 }
2268
2269 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002270 * Returns true if this activity's <em>main</em> window currently has window focus.
2271 * Note that this is not the same as the view itself having focus.
2272 *
2273 * @return True if this activity's main window currently has window focus.
2274 *
2275 * @see #onWindowAttributesChanged(android.view.WindowManager.LayoutParams)
2276 */
2277 public boolean hasWindowFocus() {
2278 Window w = getWindow();
2279 if (w != null) {
2280 View d = w.getDecorView();
2281 if (d != null) {
2282 return d.hasWindowFocus();
2283 }
2284 }
2285 return false;
2286 }
2287
2288 /**
2289 * Called to process key events. You can override this to intercept all
2290 * key events before they are dispatched to the window. Be sure to call
2291 * this implementation for key events that should be handled normally.
2292 *
2293 * @param event The key event.
2294 *
2295 * @return boolean Return true if this event was consumed.
2296 */
2297 public boolean dispatchKeyEvent(KeyEvent event) {
2298 onUserInteraction();
Dianne Hackborn8d374262009-09-14 21:21:52 -07002299 Window win = getWindow();
2300 if (win.superDispatchKeyEvent(event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002301 return true;
2302 }
Dianne Hackborn8d374262009-09-14 21:21:52 -07002303 View decor = mDecor;
2304 if (decor == null) decor = win.getDecorView();
2305 return event.dispatch(this, decor != null
2306 ? decor.getKeyDispatcherState() : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002307 }
2308
2309 /**
2310 * Called to process touch screen events. You can override this to
2311 * intercept all touch screen events before they are dispatched to the
2312 * window. Be sure to call this implementation for touch screen events
2313 * that should be handled normally.
2314 *
2315 * @param ev The touch screen event.
2316 *
2317 * @return boolean Return true if this event was consumed.
2318 */
2319 public boolean dispatchTouchEvent(MotionEvent ev) {
2320 if (ev.getAction() == MotionEvent.ACTION_DOWN) {
2321 onUserInteraction();
2322 }
2323 if (getWindow().superDispatchTouchEvent(ev)) {
2324 return true;
2325 }
2326 return onTouchEvent(ev);
2327 }
2328
2329 /**
2330 * Called to process trackball events. You can override this to
2331 * intercept all trackball events before they are dispatched to the
2332 * window. Be sure to call this implementation for trackball events
2333 * that should be handled normally.
2334 *
2335 * @param ev The trackball event.
2336 *
2337 * @return boolean Return true if this event was consumed.
2338 */
2339 public boolean dispatchTrackballEvent(MotionEvent ev) {
2340 onUserInteraction();
2341 if (getWindow().superDispatchTrackballEvent(ev)) {
2342 return true;
2343 }
2344 return onTrackballEvent(ev);
2345 }
svetoslavganov75986cf2009-05-14 22:28:01 -07002346
2347 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
2348 event.setClassName(getClass().getName());
2349 event.setPackageName(getPackageName());
2350
2351 LayoutParams params = getWindow().getAttributes();
Romain Guy980a9382010-01-08 15:06:28 -08002352 boolean isFullScreen = (params.width == LayoutParams.MATCH_PARENT) &&
2353 (params.height == LayoutParams.MATCH_PARENT);
svetoslavganov75986cf2009-05-14 22:28:01 -07002354 event.setFullScreen(isFullScreen);
2355
2356 CharSequence title = getTitle();
2357 if (!TextUtils.isEmpty(title)) {
2358 event.getText().add(title);
2359 }
2360
2361 return true;
2362 }
2363
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002364 /**
2365 * Default implementation of
2366 * {@link android.view.Window.Callback#onCreatePanelView}
2367 * for activities. This
2368 * simply returns null so that all panel sub-windows will have the default
2369 * menu behavior.
2370 */
2371 public View onCreatePanelView(int featureId) {
2372 return null;
2373 }
2374
2375 /**
2376 * Default implementation of
2377 * {@link android.view.Window.Callback#onCreatePanelMenu}
2378 * for activities. This calls through to the new
2379 * {@link #onCreateOptionsMenu} method for the
2380 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2381 * so that subclasses of Activity don't need to deal with feature codes.
2382 */
2383 public boolean onCreatePanelMenu(int featureId, Menu menu) {
2384 if (featureId == Window.FEATURE_OPTIONS_PANEL) {
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002385 boolean show = onCreateOptionsMenu(menu);
2386 show |= mFragments.dispatchCreateOptionsMenu(menu, getMenuInflater());
2387 return show;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002388 }
2389 return false;
2390 }
2391
2392 /**
2393 * Default implementation of
2394 * {@link android.view.Window.Callback#onPreparePanel}
2395 * for activities. This
2396 * calls through to the new {@link #onPrepareOptionsMenu} method for the
2397 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2398 * panel, so that subclasses of
2399 * Activity don't need to deal with feature codes.
2400 */
2401 public boolean onPreparePanel(int featureId, View view, Menu menu) {
2402 if (featureId == Window.FEATURE_OPTIONS_PANEL && menu != null) {
2403 boolean goforit = onPrepareOptionsMenu(menu);
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002404 goforit |= mFragments.dispatchPrepareOptionsMenu(menu);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002405 return goforit && menu.hasVisibleItems();
2406 }
2407 return true;
2408 }
2409
2410 /**
2411 * {@inheritDoc}
2412 *
2413 * @return The default implementation returns true.
2414 */
2415 public boolean onMenuOpened(int featureId, Menu menu) {
2416 return true;
2417 }
2418
2419 /**
2420 * Default implementation of
2421 * {@link android.view.Window.Callback#onMenuItemSelected}
2422 * for activities. This calls through to the new
2423 * {@link #onOptionsItemSelected} method for the
2424 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2425 * panel, so that subclasses of
2426 * Activity don't need to deal with feature codes.
2427 */
2428 public boolean onMenuItemSelected(int featureId, MenuItem item) {
2429 switch (featureId) {
2430 case Window.FEATURE_OPTIONS_PANEL:
2431 // Put event logging here so it gets called even if subclass
2432 // doesn't call through to superclass's implmeentation of each
2433 // of these methods below
2434 EventLog.writeEvent(50000, 0, item.getTitleCondensed());
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002435 if (onOptionsItemSelected(item)) {
2436 return true;
2437 }
2438 return mFragments.dispatchOptionsItemSelected(item);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002439
2440 case Window.FEATURE_CONTEXT_MENU:
2441 EventLog.writeEvent(50000, 1, item.getTitleCondensed());
Dianne Hackborn5ddd1272010-06-12 10:15:28 -07002442 if (onContextItemSelected(item)) {
2443 return true;
2444 }
2445 return mFragments.dispatchContextItemSelected(item);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002446
2447 default:
2448 return false;
2449 }
2450 }
2451
2452 /**
2453 * Default implementation of
2454 * {@link android.view.Window.Callback#onPanelClosed(int, Menu)} for
2455 * activities. This calls through to {@link #onOptionsMenuClosed(Menu)}
2456 * method for the {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2457 * so that subclasses of Activity don't need to deal with feature codes.
2458 * For context menus ({@link Window#FEATURE_CONTEXT_MENU}), the
2459 * {@link #onContextMenuClosed(Menu)} will be called.
2460 */
2461 public void onPanelClosed(int featureId, Menu menu) {
2462 switch (featureId) {
2463 case Window.FEATURE_OPTIONS_PANEL:
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002464 mFragments.dispatchOptionsMenuClosed(menu);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002465 onOptionsMenuClosed(menu);
2466 break;
2467
2468 case Window.FEATURE_CONTEXT_MENU:
2469 onContextMenuClosed(menu);
2470 break;
2471 }
2472 }
2473
2474 /**
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07002475 * Declare that the options menu has changed, so should be recreated.
2476 * The {@link #onCreateOptionsMenu(Menu)} method will be called the next
2477 * time it needs to be displayed.
2478 */
2479 public void invalidateOptionsMenu() {
2480 mWindow.invalidatePanelMenu(Window.FEATURE_OPTIONS_PANEL);
2481 }
2482
2483 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002484 * Initialize the contents of the Activity's standard options menu. You
2485 * should place your menu items in to <var>menu</var>.
2486 *
2487 * <p>This is only called once, the first time the options menu is
2488 * displayed. To update the menu every time it is displayed, see
2489 * {@link #onPrepareOptionsMenu}.
2490 *
2491 * <p>The default implementation populates the menu with standard system
2492 * menu items. These are placed in the {@link Menu#CATEGORY_SYSTEM} group so that
2493 * they will be correctly ordered with application-defined menu items.
2494 * Deriving classes should always call through to the base implementation.
2495 *
2496 * <p>You can safely hold on to <var>menu</var> (and any items created
2497 * from it), making modifications to it as desired, until the next
2498 * time onCreateOptionsMenu() is called.
2499 *
2500 * <p>When you add items to the menu, you can implement the Activity's
2501 * {@link #onOptionsItemSelected} method to handle them there.
2502 *
2503 * @param menu The options menu in which you place your items.
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 #onPrepareOptionsMenu
2509 * @see #onOptionsItemSelected
2510 */
2511 public boolean onCreateOptionsMenu(Menu menu) {
2512 if (mParent != null) {
2513 return mParent.onCreateOptionsMenu(menu);
2514 }
2515 return true;
2516 }
2517
2518 /**
2519 * Prepare the Screen's standard options menu to be displayed. This is
2520 * called right before the menu is shown, every time it is shown. You can
2521 * use this method to efficiently enable/disable items or otherwise
2522 * dynamically modify the contents.
2523 *
2524 * <p>The default implementation updates the system menu items based on the
2525 * activity's state. Deriving classes should always call through to the
2526 * base class implementation.
2527 *
2528 * @param menu The options menu as last shown or first initialized by
2529 * onCreateOptionsMenu().
2530 *
2531 * @return You must return true for the menu to be displayed;
2532 * if you return false it will not be shown.
2533 *
2534 * @see #onCreateOptionsMenu
2535 */
2536 public boolean onPrepareOptionsMenu(Menu menu) {
2537 if (mParent != null) {
2538 return mParent.onPrepareOptionsMenu(menu);
2539 }
2540 return true;
2541 }
2542
2543 /**
2544 * This hook is called whenever an item in your options menu is selected.
2545 * The default implementation simply returns false to have the normal
2546 * processing happen (calling the item's Runnable or sending a message to
2547 * its Handler as appropriate). You can use this method for any items
2548 * for which you would like to do processing without those other
2549 * facilities.
2550 *
2551 * <p>Derived classes should call through to the base class for it to
2552 * perform the default menu handling.
2553 *
2554 * @param item The menu item that was selected.
2555 *
2556 * @return boolean Return false to allow normal menu processing to
2557 * proceed, true to consume it here.
2558 *
2559 * @see #onCreateOptionsMenu
2560 */
2561 public boolean onOptionsItemSelected(MenuItem item) {
2562 if (mParent != null) {
2563 return mParent.onOptionsItemSelected(item);
2564 }
2565 return false;
2566 }
2567
2568 /**
2569 * This hook is called whenever the options menu is being closed (either by the user canceling
2570 * the menu with the back/menu button, or when an item is selected).
2571 *
2572 * @param menu The options menu as last shown or first initialized by
2573 * onCreateOptionsMenu().
2574 */
2575 public void onOptionsMenuClosed(Menu menu) {
2576 if (mParent != null) {
2577 mParent.onOptionsMenuClosed(menu);
2578 }
2579 }
2580
2581 /**
2582 * Programmatically opens the options menu. If the options menu is already
2583 * open, this method does nothing.
2584 */
2585 public void openOptionsMenu() {
2586 mWindow.openPanel(Window.FEATURE_OPTIONS_PANEL, null);
2587 }
2588
2589 /**
2590 * Progammatically closes the options menu. If the options menu is already
2591 * closed, this method does nothing.
2592 */
2593 public void closeOptionsMenu() {
2594 mWindow.closePanel(Window.FEATURE_OPTIONS_PANEL);
2595 }
2596
2597 /**
2598 * Called when a context menu for the {@code view} is about to be shown.
2599 * Unlike {@link #onCreateOptionsMenu(Menu)}, this will be called every
2600 * time the context menu is about to be shown and should be populated for
2601 * the view (or item inside the view for {@link AdapterView} subclasses,
2602 * this can be found in the {@code menuInfo})).
2603 * <p>
2604 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an
2605 * item has been selected.
2606 * <p>
2607 * It is not safe to hold onto the context menu after this method returns.
2608 * {@inheritDoc}
2609 */
2610 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {
2611 }
2612
2613 /**
2614 * Registers a context menu to be shown for the given view (multiple views
2615 * can show the context menu). This method will set the
2616 * {@link OnCreateContextMenuListener} on the view to this activity, so
2617 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be
2618 * called when it is time to show the context menu.
2619 *
2620 * @see #unregisterForContextMenu(View)
2621 * @param view The view that should show a context menu.
2622 */
2623 public void registerForContextMenu(View view) {
2624 view.setOnCreateContextMenuListener(this);
2625 }
2626
2627 /**
2628 * Prevents a context menu to be shown for the given view. This method will remove the
2629 * {@link OnCreateContextMenuListener} on the view.
2630 *
2631 * @see #registerForContextMenu(View)
2632 * @param view The view that should stop showing a context menu.
2633 */
2634 public void unregisterForContextMenu(View view) {
2635 view.setOnCreateContextMenuListener(null);
2636 }
2637
2638 /**
2639 * Programmatically opens the context menu for a particular {@code view}.
2640 * The {@code view} should have been added via
2641 * {@link #registerForContextMenu(View)}.
2642 *
2643 * @param view The view to show the context menu for.
2644 */
2645 public void openContextMenu(View view) {
2646 view.showContextMenu();
2647 }
2648
2649 /**
2650 * Programmatically closes the most recently opened context menu, if showing.
2651 */
2652 public void closeContextMenu() {
2653 mWindow.closePanel(Window.FEATURE_CONTEXT_MENU);
2654 }
2655
2656 /**
2657 * This hook is called whenever an item in a context menu is selected. The
2658 * default implementation simply returns false to have the normal processing
2659 * happen (calling the item's Runnable or sending a message to its Handler
2660 * as appropriate). You can use this method for any items for which you
2661 * would like to do processing without those other facilities.
2662 * <p>
2663 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the
2664 * View that added this menu item.
2665 * <p>
2666 * Derived classes should call through to the base class for it to perform
2667 * the default menu handling.
2668 *
2669 * @param item The context menu item that was selected.
2670 * @return boolean Return false to allow normal context menu processing to
2671 * proceed, true to consume it here.
2672 */
2673 public boolean onContextItemSelected(MenuItem item) {
2674 if (mParent != null) {
2675 return mParent.onContextItemSelected(item);
2676 }
2677 return false;
2678 }
2679
2680 /**
2681 * This hook is called whenever the context menu is being closed (either by
2682 * the user canceling the menu with the back/menu button, or when an item is
2683 * selected).
2684 *
2685 * @param menu The context menu that is being closed.
2686 */
2687 public void onContextMenuClosed(Menu menu) {
2688 if (mParent != null) {
2689 mParent.onContextMenuClosed(menu);
2690 }
2691 }
2692
2693 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002694 * @deprecated Old no-arguments version of {@link #onCreateDialog(int, Bundle)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002695 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002696 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002697 protected Dialog onCreateDialog(int id) {
2698 return null;
2699 }
2700
2701 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002702 * Callback for creating dialogs that are managed (saved and restored) for you
2703 * by the activity. The default implementation calls through to
2704 * {@link #onCreateDialog(int)} for compatibility.
2705 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07002706 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
2707 * or later, consider instead using a {@link DialogFragment} instead.</em>
2708 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002709 * <p>If you use {@link #showDialog(int)}, the activity will call through to
2710 * this method the first time, and hang onto it thereafter. Any dialog
2711 * that is created by this method will automatically be saved and restored
2712 * for you, including whether it is showing.
2713 *
2714 * <p>If you would like the activity to manage saving and restoring dialogs
2715 * for you, you should override this method and handle any ids that are
2716 * passed to {@link #showDialog}.
2717 *
2718 * <p>If you would like an opportunity to prepare your dialog before it is shown,
2719 * override {@link #onPrepareDialog(int, Dialog, Bundle)}.
2720 *
2721 * @param id The id of the dialog.
2722 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
2723 * @return The dialog. If you return null, the dialog will not be created.
2724 *
2725 * @see #onPrepareDialog(int, Dialog, Bundle)
2726 * @see #showDialog(int, Bundle)
2727 * @see #dismissDialog(int)
2728 * @see #removeDialog(int)
2729 */
2730 protected Dialog onCreateDialog(int id, Bundle args) {
2731 return onCreateDialog(id);
2732 }
2733
2734 /**
2735 * @deprecated Old no-arguments version of
2736 * {@link #onPrepareDialog(int, Dialog, Bundle)}.
2737 */
2738 @Deprecated
2739 protected void onPrepareDialog(int id, Dialog dialog) {
2740 dialog.setOwnerActivity(this);
2741 }
2742
2743 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002744 * Provides an opportunity to prepare a managed dialog before it is being
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002745 * shown. The default implementation calls through to
2746 * {@link #onPrepareDialog(int, Dialog)} for compatibility.
2747 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002748 * <p>
2749 * Override this if you need to update a managed dialog based on the state
2750 * of the application each time it is shown. For example, a time picker
2751 * dialog might want to be updated with the current time. You should call
2752 * through to the superclass's implementation. The default implementation
2753 * will set this Activity as the owner activity on the Dialog.
2754 *
2755 * @param id The id of the managed dialog.
2756 * @param dialog The dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002757 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
2758 * @see #onCreateDialog(int, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002759 * @see #showDialog(int)
2760 * @see #dismissDialog(int)
2761 * @see #removeDialog(int)
2762 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002763 protected void onPrepareDialog(int id, Dialog dialog, Bundle args) {
2764 onPrepareDialog(id, dialog);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002765 }
2766
2767 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002768 * Simple version of {@link #showDialog(int, Bundle)} that does not
2769 * take any arguments. Simply calls {@link #showDialog(int, Bundle)}
2770 * with null arguments.
2771 */
2772 public final void showDialog(int id) {
2773 showDialog(id, null);
2774 }
2775
2776 /**
2777 * Show a dialog managed by this activity. A call to {@link #onCreateDialog(int, Bundle)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002778 * will be made with the same id the first time this is called for a given
2779 * id. From thereafter, the dialog will be automatically saved and restored.
2780 *
Dianne Hackborn291905e2010-08-17 15:17:15 -07002781 * <em>If you are targeting {@link android.os.Build.VERSION_CODES#HONEYCOMB}
2782 * or later, consider instead using a {@link DialogFragment} instead.</em>
2783 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002784 * <p>Each time a dialog is shown, {@link #onPrepareDialog(int, Dialog, Bundle)} will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002785 * be made to provide an opportunity to do any timely preparation.
2786 *
2787 * @param id The id of the managed dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002788 * @param args Arguments to pass through to the dialog. These will be saved
2789 * and restored for you. Note that if the dialog is already created,
2790 * {@link #onCreateDialog(int, Bundle)} will not be called with the new
2791 * arguments but {@link #onPrepareDialog(int, Dialog, Bundle)} will be.
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08002792 * If you need to rebuild the dialog, call {@link #removeDialog(int)} first.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002793 * @return Returns true if the Dialog was created; false is returned if
2794 * it is not created because {@link #onCreateDialog(int, Bundle)} returns false.
2795 *
Joe Onorato37296dc2009-07-31 17:58:55 -07002796 * @see Dialog
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002797 * @see #onCreateDialog(int, Bundle)
2798 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002799 * @see #dismissDialog(int)
2800 * @see #removeDialog(int)
2801 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002802 public final boolean showDialog(int id, Bundle args) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002803 if (mManagedDialogs == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002804 mManagedDialogs = new SparseArray<ManagedDialog>();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002805 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002806 ManagedDialog md = mManagedDialogs.get(id);
2807 if (md == null) {
2808 md = new ManagedDialog();
2809 md.mDialog = createDialog(id, null, args);
2810 if (md.mDialog == null) {
2811 return false;
2812 }
2813 mManagedDialogs.put(id, md);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002814 }
2815
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002816 md.mArgs = args;
2817 onPrepareDialog(id, md.mDialog, args);
2818 md.mDialog.show();
2819 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002820 }
2821
2822 /**
2823 * Dismiss a dialog that was previously shown via {@link #showDialog(int)}.
2824 *
2825 * @param id The id of the managed dialog.
2826 *
2827 * @throws IllegalArgumentException if the id was not previously shown via
2828 * {@link #showDialog(int)}.
2829 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002830 * @see #onCreateDialog(int, Bundle)
2831 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002832 * @see #showDialog(int)
2833 * @see #removeDialog(int)
2834 */
2835 public final void dismissDialog(int id) {
2836 if (mManagedDialogs == null) {
2837 throw missingDialog(id);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002838 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002839
2840 final ManagedDialog md = mManagedDialogs.get(id);
2841 if (md == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002842 throw missingDialog(id);
2843 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002844 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002845 }
2846
2847 /**
2848 * Creates an exception to throw if a user passed in a dialog id that is
2849 * unexpected.
2850 */
2851 private IllegalArgumentException missingDialog(int id) {
2852 return new IllegalArgumentException("no dialog with id " + id + " was ever "
2853 + "shown via Activity#showDialog");
2854 }
2855
2856 /**
2857 * Removes any internal references to a dialog managed by this Activity.
2858 * If the dialog is showing, it will dismiss it as part of the clean up.
2859 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002860 * <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 -08002861 * want to avoid the overhead of saving and restoring it in the future.
2862 *
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07002863 * <p>As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}, this function
2864 * will not throw an exception if you try to remove an ID that does not
2865 * currently have an associated dialog.</p>
2866 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002867 * @param id The id of the managed dialog.
2868 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002869 * @see #onCreateDialog(int, Bundle)
2870 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002871 * @see #showDialog(int)
2872 * @see #dismissDialog(int)
2873 */
2874 public final void removeDialog(int id) {
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07002875 if (mManagedDialogs != null) {
2876 final ManagedDialog md = mManagedDialogs.get(id);
2877 if (md != null) {
2878 md.mDialog.dismiss();
2879 mManagedDialogs.remove(id);
2880 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002881 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002882 }
2883
2884 /**
2885 * This hook is called when the user signals the desire to start a search.
2886 *
Bjorn Bringert6266e402009-09-25 14:25:41 +01002887 * <p>You can use this function as a simple way to launch the search UI, in response to a
2888 * menu item, search button, or other widgets within your activity. Unless overidden,
2889 * calling this function is the same as calling
2890 * {@link #startSearch startSearch(null, false, null, false)}, which launches
2891 * search for the current activity as specified in its manifest, see {@link SearchManager}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002892 *
2893 * <p>You can override this function to force global search, e.g. in response to a dedicated
2894 * search key, or to block search entirely (by simply returning false).
2895 *
Bjorn Bringert6266e402009-09-25 14:25:41 +01002896 * @return Returns {@code true} if search launched, and {@code false} if activity blocks it.
2897 * The default implementation always returns {@code true}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002898 *
2899 * @see android.app.SearchManager
2900 */
2901 public boolean onSearchRequested() {
2902 startSearch(null, false, null, false);
2903 return true;
2904 }
2905
2906 /**
2907 * This hook is called to launch the search UI.
2908 *
2909 * <p>It is typically called from onSearchRequested(), either directly from
2910 * Activity.onSearchRequested() or from an overridden version in any given
2911 * Activity. If your goal is simply to activate search, it is preferred to call
2912 * onSearchRequested(), which may have been overriden elsewhere in your Activity. If your goal
2913 * is to inject specific data such as context data, it is preferred to <i>override</i>
2914 * onSearchRequested(), so that any callers to it will benefit from the override.
2915 *
2916 * @param initialQuery Any non-null non-empty string will be inserted as
2917 * pre-entered text in the search query box.
2918 * @param selectInitialQuery If true, the intial query will be preselected, which means that
2919 * any further typing will replace it. This is useful for cases where an entire pre-formed
2920 * query is being inserted. If false, the selection point will be placed at the end of the
2921 * inserted query. This is useful when the inserted query is text that the user entered,
2922 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful
2923 * if initialQuery is a non-empty string.</i>
2924 * @param appSearchData An application can insert application-specific
2925 * context here, in order to improve quality or specificity of its own
2926 * searches. This data will be returned with SEARCH intent(s). Null if
2927 * no extra data is required.
2928 * @param globalSearch If false, this will only launch the search that has been specifically
2929 * defined by the application (which is usually defined as a local search). If no default
Mike LeBeaucfa419b2009-08-17 10:56:02 -07002930 * search is defined in the current application or activity, global search will be launched.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002931 * If true, this will always launch a platform-global (e.g. web-based) search instead.
2932 *
2933 * @see android.app.SearchManager
2934 * @see #onSearchRequested
2935 */
2936 public void startSearch(String initialQuery, boolean selectInitialQuery,
2937 Bundle appSearchData, boolean globalSearch) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07002938 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01002939 mSearchManager.startSearch(initialQuery, selectInitialQuery, getComponentName(),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002940 appSearchData, globalSearch);
2941 }
2942
2943 /**
krosaend2d60142009-08-17 08:56:48 -07002944 * Similar to {@link #startSearch}, but actually fires off the search query after invoking
2945 * the search dialog. Made available for testing purposes.
2946 *
2947 * @param query The query to trigger. If empty, the request will be ignored.
2948 * @param appSearchData An application can insert application-specific
2949 * context here, in order to improve quality or specificity of its own
2950 * searches. This data will be returned with SEARCH intent(s). Null if
2951 * no extra data is required.
krosaend2d60142009-08-17 08:56:48 -07002952 */
Bjorn Bringertb782a2f2009-10-01 09:57:33 +01002953 public void triggerSearch(String query, Bundle appSearchData) {
krosaend2d60142009-08-17 08:56:48 -07002954 ensureSearchManager();
Bjorn Bringertb782a2f2009-10-01 09:57:33 +01002955 mSearchManager.triggerSearch(query, getComponentName(), appSearchData);
krosaend2d60142009-08-17 08:56:48 -07002956 }
2957
2958 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002959 * Request that key events come to this activity. Use this if your
2960 * activity has no views with focus, but the activity still wants
2961 * a chance to process key events.
2962 *
2963 * @see android.view.Window#takeKeyEvents
2964 */
2965 public void takeKeyEvents(boolean get) {
2966 getWindow().takeKeyEvents(get);
2967 }
2968
2969 /**
2970 * Enable extended window features. This is a convenience for calling
2971 * {@link android.view.Window#requestFeature getWindow().requestFeature()}.
2972 *
2973 * @param featureId The desired feature as defined in
2974 * {@link android.view.Window}.
2975 * @return Returns true if the requested feature is supported and now
2976 * enabled.
2977 *
2978 * @see android.view.Window#requestFeature
2979 */
2980 public final boolean requestWindowFeature(int featureId) {
2981 return getWindow().requestFeature(featureId);
2982 }
2983
2984 /**
2985 * Convenience for calling
2986 * {@link android.view.Window#setFeatureDrawableResource}.
2987 */
2988 public final void setFeatureDrawableResource(int featureId, int resId) {
2989 getWindow().setFeatureDrawableResource(featureId, resId);
2990 }
2991
2992 /**
2993 * Convenience for calling
2994 * {@link android.view.Window#setFeatureDrawableUri}.
2995 */
2996 public final void setFeatureDrawableUri(int featureId, Uri uri) {
2997 getWindow().setFeatureDrawableUri(featureId, uri);
2998 }
2999
3000 /**
3001 * Convenience for calling
3002 * {@link android.view.Window#setFeatureDrawable(int, Drawable)}.
3003 */
3004 public final void setFeatureDrawable(int featureId, Drawable drawable) {
3005 getWindow().setFeatureDrawable(featureId, drawable);
3006 }
3007
3008 /**
3009 * Convenience for calling
3010 * {@link android.view.Window#setFeatureDrawableAlpha}.
3011 */
3012 public final void setFeatureDrawableAlpha(int featureId, int alpha) {
3013 getWindow().setFeatureDrawableAlpha(featureId, alpha);
3014 }
3015
3016 /**
3017 * Convenience for calling
3018 * {@link android.view.Window#getLayoutInflater}.
3019 */
3020 public LayoutInflater getLayoutInflater() {
3021 return getWindow().getLayoutInflater();
3022 }
3023
3024 /**
3025 * Returns a {@link MenuInflater} with this context.
3026 */
3027 public MenuInflater getMenuInflater() {
3028 return new MenuInflater(this);
3029 }
3030
3031 @Override
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003032 protected void onApplyThemeResource(Resources.Theme theme, int resid,
3033 boolean first) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003034 if (mParent == null) {
3035 super.onApplyThemeResource(theme, resid, first);
3036 } else {
3037 try {
3038 theme.setTo(mParent.getTheme());
3039 } catch (Exception e) {
3040 // Empty
3041 }
3042 theme.applyStyle(resid, false);
3043 }
3044 }
3045
3046 /**
3047 * Launch an activity for which you would like a result when it finished.
3048 * When this activity exits, your
3049 * onActivityResult() method will be called with the given requestCode.
3050 * Using a negative requestCode is the same as calling
3051 * {@link #startActivity} (the activity is not launched as a sub-activity).
3052 *
3053 * <p>Note that this method should only be used with Intent protocols
3054 * that are defined to return a result. In other protocols (such as
3055 * {@link Intent#ACTION_MAIN} or {@link Intent#ACTION_VIEW}), you may
3056 * not get the result when you expect. For example, if the activity you
3057 * are launching uses the singleTask launch mode, it will not run in your
3058 * task and thus you will immediately receive a cancel result.
3059 *
3060 * <p>As a special case, if you call startActivityForResult() with a requestCode
3061 * >= 0 during the initial onCreate(Bundle savedInstanceState)/onResume() of your
3062 * activity, then your window will not be displayed until a result is
3063 * returned back from the started activity. This is to avoid visible
3064 * flickering when redirecting to another activity.
3065 *
3066 * <p>This method throws {@link android.content.ActivityNotFoundException}
3067 * if there was no Activity found to run the given Intent.
3068 *
3069 * @param intent The intent to start.
3070 * @param requestCode If >= 0, this code will be returned in
3071 * onActivityResult() when the activity exits.
3072 *
3073 * @throws android.content.ActivityNotFoundException
3074 *
3075 * @see #startActivity
3076 */
3077 public void startActivityForResult(Intent intent, int requestCode) {
3078 if (mParent == null) {
3079 Instrumentation.ActivityResult ar =
3080 mInstrumentation.execStartActivity(
3081 this, mMainThread.getApplicationThread(), mToken, this,
3082 intent, requestCode);
3083 if (ar != null) {
3084 mMainThread.sendActivityResult(
3085 mToken, mEmbeddedID, requestCode, ar.getResultCode(),
3086 ar.getResultData());
3087 }
3088 if (requestCode >= 0) {
3089 // If this start is requesting a result, we can avoid making
3090 // the activity visible until the result is received. Setting
3091 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3092 // activity hidden during this time, to avoid flickering.
3093 // This can only be done when a result is requested because
3094 // that guarantees we will get information back when the
3095 // activity is finished, no matter what happens to it.
3096 mStartedActivity = true;
3097 }
3098 } else {
3099 mParent.startActivityFromChild(this, intent, requestCode);
3100 }
3101 }
3102
3103 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003104 * Like {@link #startActivityForResult(Intent, int)}, but allowing you
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003105 * to use a IntentSender to describe the activity to be started. If
3106 * the IntentSender is for an activity, that activity will be started
3107 * as if you had called the regular {@link #startActivityForResult(Intent, int)}
3108 * here; otherwise, its associated action will be executed (such as
3109 * sending a broadcast) as if you had called
3110 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003111 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003112 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003113 * @param requestCode If >= 0, this code will be returned in
3114 * onActivityResult() when the activity exits.
3115 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003116 * intent parameter to {@link IntentSender#sendIntent}.
3117 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003118 * would like to change.
3119 * @param flagsValues Desired values for any bits set in
3120 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003121 * @param extraFlags Always set to 0.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003122 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003123 public void startIntentSenderForResult(IntentSender intent, int requestCode,
3124 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
3125 throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003126 if (mParent == null) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003127 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003128 flagsMask, flagsValues, this);
3129 } else {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003130 mParent.startIntentSenderFromChild(this, intent, requestCode,
3131 fillInIntent, flagsMask, flagsValues, extraFlags);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003132 }
3133 }
3134
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003135 private void startIntentSenderForResultInner(IntentSender intent, int requestCode,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003136 Intent fillInIntent, int flagsMask, int flagsValues, Activity activity)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003137 throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003138 try {
3139 String resolvedType = null;
3140 if (fillInIntent != null) {
3141 resolvedType = fillInIntent.resolveTypeIfNeeded(getContentResolver());
3142 }
3143 int result = ActivityManagerNative.getDefault()
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003144 .startActivityIntentSender(mMainThread.getApplicationThread(), intent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003145 fillInIntent, resolvedType, mToken, activity.mEmbeddedID,
3146 requestCode, flagsMask, flagsValues);
3147 if (result == IActivityManager.START_CANCELED) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003148 throw new IntentSender.SendIntentException();
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003149 }
3150 Instrumentation.checkStartActivityResult(result, null);
3151 } catch (RemoteException e) {
3152 }
3153 if (requestCode >= 0) {
3154 // If this start is requesting a result, we can avoid making
3155 // the activity visible until the result is received. Setting
3156 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3157 // activity hidden during this time, to avoid flickering.
3158 // This can only be done when a result is requested because
3159 // that guarantees we will get information back when the
3160 // activity is finished, no matter what happens to it.
3161 mStartedActivity = true;
3162 }
3163 }
3164
3165 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003166 * Launch a new activity. You will not receive any information about when
3167 * the activity exits. This implementation overrides the base version,
3168 * providing information about
3169 * the activity performing the launch. Because of this additional
3170 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not
3171 * required; if not specified, the new activity will be added to the
3172 * task of the caller.
3173 *
3174 * <p>This method throws {@link android.content.ActivityNotFoundException}
3175 * if there was no Activity found to run the given Intent.
3176 *
3177 * @param intent The intent to start.
3178 *
3179 * @throws android.content.ActivityNotFoundException
3180 *
3181 * @see #startActivityForResult
3182 */
3183 @Override
3184 public void startActivity(Intent intent) {
3185 startActivityForResult(intent, -1);
3186 }
3187
3188 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003189 * Like {@link #startActivity(Intent)}, but taking a IntentSender
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003190 * to start; see
Dianne Hackbornae22c052009-09-17 18:46:22 -07003191 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)}
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003192 * for more information.
3193 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003194 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003195 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003196 * intent parameter to {@link IntentSender#sendIntent}.
3197 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003198 * would like to change.
3199 * @param flagsValues Desired values for any bits set in
3200 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003201 * @param extraFlags Always set to 0.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003202 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003203 public void startIntentSender(IntentSender intent,
3204 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
3205 throws IntentSender.SendIntentException {
3206 startIntentSenderForResult(intent, -1, fillInIntent, flagsMask,
3207 flagsValues, extraFlags);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003208 }
3209
3210 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003211 * A special variation to launch an activity only if a new activity
3212 * instance is needed to handle the given Intent. In other words, this is
3213 * just like {@link #startActivityForResult(Intent, int)} except: if you are
3214 * using the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} flag, or
3215 * singleTask or singleTop
3216 * {@link android.R.styleable#AndroidManifestActivity_launchMode launchMode},
3217 * and the activity
3218 * that handles <var>intent</var> is the same as your currently running
3219 * activity, then a new instance is not needed. In this case, instead of
3220 * the normal behavior of calling {@link #onNewIntent} this function will
3221 * return and you can handle the Intent yourself.
3222 *
3223 * <p>This function can only be called from a top-level activity; if it is
3224 * called from a child activity, a runtime exception will be thrown.
3225 *
3226 * @param intent The intent to start.
3227 * @param requestCode If >= 0, this code will be returned in
3228 * onActivityResult() when the activity exits, as described in
3229 * {@link #startActivityForResult}.
3230 *
3231 * @return If a new activity was launched then true is returned; otherwise
3232 * false is returned and you must handle the Intent yourself.
3233 *
3234 * @see #startActivity
3235 * @see #startActivityForResult
3236 */
3237 public boolean startActivityIfNeeded(Intent intent, int requestCode) {
3238 if (mParent == null) {
3239 int result = IActivityManager.START_RETURN_INTENT_TO_CALLER;
3240 try {
3241 result = ActivityManagerNative.getDefault()
3242 .startActivity(mMainThread.getApplicationThread(),
3243 intent, intent.resolveTypeIfNeeded(
3244 getContentResolver()),
3245 null, 0,
3246 mToken, mEmbeddedID, requestCode, true, false);
3247 } catch (RemoteException e) {
3248 // Empty
3249 }
3250
3251 Instrumentation.checkStartActivityResult(result, intent);
3252
3253 if (requestCode >= 0) {
3254 // If this start is requesting a result, we can avoid making
3255 // the activity visible until the result is received. Setting
3256 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3257 // activity hidden during this time, to avoid flickering.
3258 // This can only be done when a result is requested because
3259 // that guarantees we will get information back when the
3260 // activity is finished, no matter what happens to it.
3261 mStartedActivity = true;
3262 }
3263 return result != IActivityManager.START_RETURN_INTENT_TO_CALLER;
3264 }
3265
3266 throw new UnsupportedOperationException(
3267 "startActivityIfNeeded can only be called from a top-level activity");
3268 }
3269
3270 /**
3271 * Special version of starting an activity, for use when you are replacing
3272 * other activity components. You can use this to hand the Intent off
3273 * to the next Activity that can handle it. You typically call this in
3274 * {@link #onCreate} with the Intent returned by {@link #getIntent}.
3275 *
3276 * @param intent The intent to dispatch to the next activity. For
3277 * correct behavior, this must be the same as the Intent that started
3278 * your own activity; the only changes you can make are to the extras
3279 * inside of it.
3280 *
3281 * @return Returns a boolean indicating whether there was another Activity
3282 * to start: true if there was a next activity to start, false if there
3283 * wasn't. In general, if true is returned you will then want to call
3284 * finish() on yourself.
3285 */
3286 public boolean startNextMatchingActivity(Intent intent) {
3287 if (mParent == null) {
3288 try {
3289 return ActivityManagerNative.getDefault()
3290 .startNextMatchingActivity(mToken, intent);
3291 } catch (RemoteException e) {
3292 // Empty
3293 }
3294 return false;
3295 }
3296
3297 throw new UnsupportedOperationException(
3298 "startNextMatchingActivity can only be called from a top-level activity");
3299 }
3300
3301 /**
3302 * This is called when a child activity of this one calls its
3303 * {@link #startActivity} or {@link #startActivityForResult} method.
3304 *
3305 * <p>This method throws {@link android.content.ActivityNotFoundException}
3306 * if there was no Activity found to run the given Intent.
3307 *
3308 * @param child The activity making the call.
3309 * @param intent The intent to start.
3310 * @param requestCode Reply request code. < 0 if reply is not requested.
3311 *
3312 * @throws android.content.ActivityNotFoundException
3313 *
3314 * @see #startActivity
3315 * @see #startActivityForResult
3316 */
3317 public void startActivityFromChild(Activity child, Intent intent,
3318 int requestCode) {
3319 Instrumentation.ActivityResult ar =
3320 mInstrumentation.execStartActivity(
3321 this, mMainThread.getApplicationThread(), mToken, child,
3322 intent, requestCode);
3323 if (ar != null) {
3324 mMainThread.sendActivityResult(
3325 mToken, child.mEmbeddedID, requestCode,
3326 ar.getResultCode(), ar.getResultData());
3327 }
3328 }
3329
3330 /**
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07003331 * This is called when a Fragment in this activity calls its
3332 * {@link Fragment#startActivity} or {@link Fragment#startActivityForResult}
3333 * method.
3334 *
3335 * <p>This method throws {@link android.content.ActivityNotFoundException}
3336 * if there was no Activity found to run the given Intent.
3337 *
3338 * @param fragment The fragment making the call.
3339 * @param intent The intent to start.
3340 * @param requestCode Reply request code. < 0 if reply is not requested.
3341 *
3342 * @throws android.content.ActivityNotFoundException
3343 *
3344 * @see Fragment#startActivity
3345 * @see Fragment#startActivityForResult
3346 */
3347 public void startActivityFromFragment(Fragment fragment, Intent intent,
3348 int requestCode) {
3349 Instrumentation.ActivityResult ar =
3350 mInstrumentation.execStartActivity(
3351 this, mMainThread.getApplicationThread(), mToken, fragment,
3352 intent, requestCode);
3353 if (ar != null) {
3354 mMainThread.sendActivityResult(
3355 mToken, fragment.mWho, requestCode,
3356 ar.getResultCode(), ar.getResultData());
3357 }
3358 }
3359
3360 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003361 * Like {@link #startActivityFromChild(Activity, Intent, int)}, but
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003362 * taking a IntentSender; see
Dianne Hackbornae22c052009-09-17 18:46:22 -07003363 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)}
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003364 * for more information.
3365 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003366 public void startIntentSenderFromChild(Activity child, IntentSender intent,
3367 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues,
3368 int extraFlags)
3369 throws IntentSender.SendIntentException {
3370 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003371 flagsMask, flagsValues, child);
3372 }
3373
3374 /**
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003375 * Call immediately after one of the flavors of {@link #startActivity(Intent)}
3376 * or {@link #finish} to specify an explicit transition animation to
3377 * perform next.
3378 * @param enterAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07003379 * the incoming activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003380 * @param exitAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07003381 * the outgoing activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003382 */
3383 public void overridePendingTransition(int enterAnim, int exitAnim) {
3384 try {
3385 ActivityManagerNative.getDefault().overridePendingTransition(
3386 mToken, getPackageName(), enterAnim, exitAnim);
3387 } catch (RemoteException e) {
3388 }
3389 }
3390
3391 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003392 * Call this to set the result that your activity will return to its
3393 * caller.
3394 *
3395 * @param resultCode The result code to propagate back to the originating
3396 * activity, often RESULT_CANCELED or RESULT_OK
3397 *
3398 * @see #RESULT_CANCELED
3399 * @see #RESULT_OK
3400 * @see #RESULT_FIRST_USER
3401 * @see #setResult(int, Intent)
3402 */
3403 public final void setResult(int resultCode) {
3404 synchronized (this) {
3405 mResultCode = resultCode;
3406 mResultData = null;
3407 }
3408 }
3409
3410 /**
3411 * Call this to set the result that your activity will return to its
3412 * caller.
3413 *
3414 * @param resultCode The result code to propagate back to the originating
3415 * activity, often RESULT_CANCELED or RESULT_OK
3416 * @param data The data to propagate back to the originating activity.
3417 *
3418 * @see #RESULT_CANCELED
3419 * @see #RESULT_OK
3420 * @see #RESULT_FIRST_USER
3421 * @see #setResult(int)
3422 */
3423 public final void setResult(int resultCode, Intent data) {
3424 synchronized (this) {
3425 mResultCode = resultCode;
3426 mResultData = data;
3427 }
3428 }
3429
3430 /**
3431 * Return the name of the package that invoked this activity. This is who
3432 * the data in {@link #setResult setResult()} will be sent to. You can
3433 * use this information to validate that the recipient is allowed to
3434 * receive the data.
3435 *
3436 * <p>Note: if the calling activity is not expecting a result (that is it
3437 * did not use the {@link #startActivityForResult}
3438 * form that includes a request code), then the calling package will be
3439 * null.
3440 *
3441 * @return The package of the activity that will receive your
3442 * reply, or null if none.
3443 */
3444 public String getCallingPackage() {
3445 try {
3446 return ActivityManagerNative.getDefault().getCallingPackage(mToken);
3447 } catch (RemoteException e) {
3448 return null;
3449 }
3450 }
3451
3452 /**
3453 * Return the name of the activity that invoked this activity. This is
3454 * who the data in {@link #setResult setResult()} will be sent to. You
3455 * can use this information to validate that the recipient is allowed to
3456 * receive the data.
3457 *
3458 * <p>Note: if the calling activity is not expecting a result (that is it
3459 * did not use the {@link #startActivityForResult}
3460 * form that includes a request code), then the calling package will be
3461 * null.
3462 *
3463 * @return String The full name of the activity that will receive your
3464 * reply, or null if none.
3465 */
3466 public ComponentName getCallingActivity() {
3467 try {
3468 return ActivityManagerNative.getDefault().getCallingActivity(mToken);
3469 } catch (RemoteException e) {
3470 return null;
3471 }
3472 }
3473
3474 /**
3475 * Control whether this activity's main window is visible. This is intended
3476 * only for the special case of an activity that is not going to show a
3477 * UI itself, but can't just finish prior to onResume() because it needs
3478 * to wait for a service binding or such. Setting this to false allows
3479 * you to prevent your UI from being shown during that time.
3480 *
3481 * <p>The default value for this is taken from the
3482 * {@link android.R.attr#windowNoDisplay} attribute of the activity's theme.
3483 */
3484 public void setVisible(boolean visible) {
3485 if (mVisibleFromClient != visible) {
3486 mVisibleFromClient = visible;
3487 if (mVisibleFromServer) {
3488 if (visible) makeVisible();
3489 else mDecor.setVisibility(View.INVISIBLE);
3490 }
3491 }
3492 }
3493
3494 void makeVisible() {
3495 if (!mWindowAdded) {
3496 ViewManager wm = getWindowManager();
3497 wm.addView(mDecor, getWindow().getAttributes());
3498 mWindowAdded = true;
3499 }
3500 mDecor.setVisibility(View.VISIBLE);
3501 }
3502
3503 /**
3504 * Check to see whether this activity is in the process of finishing,
3505 * either because you called {@link #finish} on it or someone else
3506 * has requested that it finished. This is often used in
3507 * {@link #onPause} to determine whether the activity is simply pausing or
3508 * completely finishing.
3509 *
3510 * @return If the activity is finishing, returns true; else returns false.
3511 *
3512 * @see #finish
3513 */
3514 public boolean isFinishing() {
3515 return mFinished;
3516 }
3517
3518 /**
Jeff Hamilton3d32f6e2010-04-01 00:04:16 -05003519 * Check to see whether this activity is in the process of being destroyed in order to be
3520 * recreated with a new configuration. This is often used in
3521 * {@link #onStop} to determine whether the state needs to be cleaned up or will be passed
3522 * on to the next instance of the activity via {@link #onRetainNonConfigurationInstance()}.
3523 *
3524 * @return If the activity is being torn down in order to be recreated with a new configuration,
3525 * returns true; else returns false.
3526 */
3527 public boolean isChangingConfigurations() {
3528 return mChangingConfigurations;
3529 }
3530
3531 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003532 * Call this when your activity is done and should be closed. The
3533 * ActivityResult is propagated back to whoever launched you via
3534 * onActivityResult().
3535 */
3536 public void finish() {
3537 if (mParent == null) {
3538 int resultCode;
3539 Intent resultData;
3540 synchronized (this) {
3541 resultCode = mResultCode;
3542 resultData = mResultData;
3543 }
3544 if (Config.LOGV) Log.v(TAG, "Finishing self: token=" + mToken);
3545 try {
3546 if (ActivityManagerNative.getDefault()
3547 .finishActivity(mToken, resultCode, resultData)) {
3548 mFinished = true;
3549 }
3550 } catch (RemoteException e) {
3551 // Empty
3552 }
3553 } else {
3554 mParent.finishFromChild(this);
3555 }
3556 }
3557
3558 /**
3559 * This is called when a child activity of this one calls its
3560 * {@link #finish} method. The default implementation simply calls
3561 * finish() on this activity (the parent), finishing the entire group.
3562 *
3563 * @param child The activity making the call.
3564 *
3565 * @see #finish
3566 */
3567 public void finishFromChild(Activity child) {
3568 finish();
3569 }
3570
3571 /**
3572 * Force finish another activity that you had previously started with
3573 * {@link #startActivityForResult}.
3574 *
3575 * @param requestCode The request code of the activity that you had
3576 * given to startActivityForResult(). If there are multiple
3577 * activities started with this request code, they
3578 * will all be finished.
3579 */
3580 public void finishActivity(int requestCode) {
3581 if (mParent == null) {
3582 try {
3583 ActivityManagerNative.getDefault()
3584 .finishSubActivity(mToken, mEmbeddedID, requestCode);
3585 } catch (RemoteException e) {
3586 // Empty
3587 }
3588 } else {
3589 mParent.finishActivityFromChild(this, requestCode);
3590 }
3591 }
3592
3593 /**
3594 * This is called when a child activity of this one calls its
3595 * finishActivity().
3596 *
3597 * @param child The activity making the call.
3598 * @param requestCode Request code that had been used to start the
3599 * activity.
3600 */
3601 public void finishActivityFromChild(Activity child, int requestCode) {
3602 try {
3603 ActivityManagerNative.getDefault()
3604 .finishSubActivity(mToken, child.mEmbeddedID, requestCode);
3605 } catch (RemoteException e) {
3606 // Empty
3607 }
3608 }
3609
3610 /**
3611 * Called when an activity you launched exits, giving you the requestCode
3612 * you started it with, the resultCode it returned, and any additional
3613 * data from it. The <var>resultCode</var> will be
3614 * {@link #RESULT_CANCELED} if the activity explicitly returned that,
3615 * didn't return any result, or crashed during its operation.
3616 *
3617 * <p>You will receive this call immediately before onResume() when your
3618 * activity is re-starting.
3619 *
3620 * @param requestCode The integer request code originally supplied to
3621 * startActivityForResult(), allowing you to identify who this
3622 * result came from.
3623 * @param resultCode The integer result code returned by the child activity
3624 * through its setResult().
3625 * @param data An Intent, which can return result data to the caller
3626 * (various data can be attached to Intent "extras").
3627 *
3628 * @see #startActivityForResult
3629 * @see #createPendingResult
3630 * @see #setResult(int)
3631 */
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07003632 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003633 }
3634
3635 /**
3636 * Create a new PendingIntent object which you can hand to others
3637 * for them to use to send result data back to your
3638 * {@link #onActivityResult} callback. The created object will be either
3639 * one-shot (becoming invalid after a result is sent back) or multiple
3640 * (allowing any number of results to be sent through it).
3641 *
3642 * @param requestCode Private request code for the sender that will be
3643 * associated with the result data when it is returned. The sender can not
3644 * modify this value, allowing you to identify incoming results.
3645 * @param data Default data to supply in the result, which may be modified
3646 * by the sender.
3647 * @param flags May be {@link PendingIntent#FLAG_ONE_SHOT PendingIntent.FLAG_ONE_SHOT},
3648 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE},
3649 * {@link PendingIntent#FLAG_CANCEL_CURRENT PendingIntent.FLAG_CANCEL_CURRENT},
3650 * {@link PendingIntent#FLAG_UPDATE_CURRENT PendingIntent.FLAG_UPDATE_CURRENT},
3651 * or any of the flags as supported by
3652 * {@link Intent#fillIn Intent.fillIn()} to control which unspecified parts
3653 * of the intent that can be supplied when the actual send happens.
3654 *
3655 * @return Returns an existing or new PendingIntent matching the given
3656 * parameters. May return null only if
3657 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE} has been
3658 * supplied.
3659 *
3660 * @see PendingIntent
3661 */
3662 public PendingIntent createPendingResult(int requestCode, Intent data,
3663 int flags) {
3664 String packageName = getPackageName();
3665 try {
3666 IIntentSender target =
3667 ActivityManagerNative.getDefault().getIntentSender(
3668 IActivityManager.INTENT_SENDER_ACTIVITY_RESULT, packageName,
3669 mParent == null ? mToken : mParent.mToken,
3670 mEmbeddedID, requestCode, data, null, flags);
3671 return target != null ? new PendingIntent(target) : null;
3672 } catch (RemoteException e) {
3673 // Empty
3674 }
3675 return null;
3676 }
3677
3678 /**
3679 * Change the desired orientation of this activity. If the activity
3680 * is currently in the foreground or otherwise impacting the screen
3681 * orientation, the screen will immediately be changed (possibly causing
3682 * the activity to be restarted). Otherwise, this will be used the next
3683 * time the activity is visible.
3684 *
3685 * @param requestedOrientation An orientation constant as used in
3686 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
3687 */
3688 public void setRequestedOrientation(int requestedOrientation) {
3689 if (mParent == null) {
3690 try {
3691 ActivityManagerNative.getDefault().setRequestedOrientation(
3692 mToken, requestedOrientation);
3693 } catch (RemoteException e) {
3694 // Empty
3695 }
3696 } else {
3697 mParent.setRequestedOrientation(requestedOrientation);
3698 }
3699 }
3700
3701 /**
3702 * Return the current requested orientation of the activity. This will
3703 * either be the orientation requested in its component's manifest, or
3704 * the last requested orientation given to
3705 * {@link #setRequestedOrientation(int)}.
3706 *
3707 * @return Returns an orientation constant as used in
3708 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
3709 */
3710 public int getRequestedOrientation() {
3711 if (mParent == null) {
3712 try {
3713 return ActivityManagerNative.getDefault()
3714 .getRequestedOrientation(mToken);
3715 } catch (RemoteException e) {
3716 // Empty
3717 }
3718 } else {
3719 return mParent.getRequestedOrientation();
3720 }
3721 return ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED;
3722 }
3723
3724 /**
3725 * Return the identifier of the task this activity is in. This identifier
3726 * will remain the same for the lifetime of the activity.
3727 *
3728 * @return Task identifier, an opaque integer.
3729 */
3730 public int getTaskId() {
3731 try {
3732 return ActivityManagerNative.getDefault()
3733 .getTaskForActivity(mToken, false);
3734 } catch (RemoteException e) {
3735 return -1;
3736 }
3737 }
3738
3739 /**
3740 * Return whether this activity is the root of a task. The root is the
3741 * first activity in a task.
3742 *
3743 * @return True if this is the root activity, else false.
3744 */
3745 public boolean isTaskRoot() {
3746 try {
3747 return ActivityManagerNative.getDefault()
3748 .getTaskForActivity(mToken, true) >= 0;
3749 } catch (RemoteException e) {
3750 return false;
3751 }
3752 }
3753
3754 /**
3755 * Move the task containing this activity to the back of the activity
3756 * stack. The activity's order within the task is unchanged.
3757 *
3758 * @param nonRoot If false then this only works if the activity is the root
3759 * of a task; if true it will work for any activity in
3760 * a task.
3761 *
3762 * @return If the task was moved (or it was already at the
3763 * back) true is returned, else false.
3764 */
3765 public boolean moveTaskToBack(boolean nonRoot) {
3766 try {
3767 return ActivityManagerNative.getDefault().moveActivityTaskToBack(
3768 mToken, nonRoot);
3769 } catch (RemoteException e) {
3770 // Empty
3771 }
3772 return false;
3773 }
3774
3775 /**
3776 * Returns class name for this activity with the package prefix removed.
3777 * This is the default name used to read and write settings.
3778 *
3779 * @return The local class name.
3780 */
3781 public String getLocalClassName() {
3782 final String pkg = getPackageName();
3783 final String cls = mComponent.getClassName();
3784 int packageLen = pkg.length();
3785 if (!cls.startsWith(pkg) || cls.length() <= packageLen
3786 || cls.charAt(packageLen) != '.') {
3787 return cls;
3788 }
3789 return cls.substring(packageLen+1);
3790 }
3791
3792 /**
3793 * Returns complete component name of this activity.
3794 *
3795 * @return Returns the complete component name for this activity
3796 */
3797 public ComponentName getComponentName()
3798 {
3799 return mComponent;
3800 }
3801
3802 /**
3803 * Retrieve a {@link SharedPreferences} object for accessing preferences
3804 * that are private to this activity. This simply calls the underlying
3805 * {@link #getSharedPreferences(String, int)} method by passing in this activity's
3806 * class name as the preferences name.
3807 *
3808 * @param mode Operating mode. Use {@link #MODE_PRIVATE} for the default
3809 * operation, {@link #MODE_WORLD_READABLE} and
3810 * {@link #MODE_WORLD_WRITEABLE} to control permissions.
3811 *
3812 * @return Returns the single SharedPreferences instance that can be used
3813 * to retrieve and modify the preference values.
3814 */
3815 public SharedPreferences getPreferences(int mode) {
3816 return getSharedPreferences(getLocalClassName(), mode);
3817 }
3818
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003819 private void ensureSearchManager() {
3820 if (mSearchManager != null) {
3821 return;
3822 }
3823
Amith Yamasanie9ce3f02010-01-25 09:15:50 -08003824 mSearchManager = new SearchManager(this, null);
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003825 }
3826
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003827 @Override
3828 public Object getSystemService(String name) {
3829 if (getBaseContext() == null) {
3830 throw new IllegalStateException(
3831 "System services not available to Activities before onCreate()");
3832 }
3833
3834 if (WINDOW_SERVICE.equals(name)) {
3835 return mWindowManager;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003836 } else if (SEARCH_SERVICE.equals(name)) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003837 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003838 return mSearchManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003839 }
3840 return super.getSystemService(name);
3841 }
3842
3843 /**
3844 * Change the title associated with this activity. If this is a
3845 * top-level activity, the title for its window will change. If it
3846 * is an embedded activity, the parent can do whatever it wants
3847 * with it.
3848 */
3849 public void setTitle(CharSequence title) {
3850 mTitle = title;
3851 onTitleChanged(title, mTitleColor);
3852
3853 if (mParent != null) {
3854 mParent.onChildTitleChanged(this, title);
3855 }
3856 }
3857
3858 /**
3859 * Change the title associated with this activity. If this is a
3860 * top-level activity, the title for its window will change. If it
3861 * is an embedded activity, the parent can do whatever it wants
3862 * with it.
3863 */
3864 public void setTitle(int titleId) {
3865 setTitle(getText(titleId));
3866 }
3867
3868 public void setTitleColor(int textColor) {
3869 mTitleColor = textColor;
3870 onTitleChanged(mTitle, textColor);
3871 }
3872
3873 public final CharSequence getTitle() {
3874 return mTitle;
3875 }
3876
3877 public final int getTitleColor() {
3878 return mTitleColor;
3879 }
3880
3881 protected void onTitleChanged(CharSequence title, int color) {
3882 if (mTitleReady) {
3883 final Window win = getWindow();
3884 if (win != null) {
3885 win.setTitle(title);
3886 if (color != 0) {
3887 win.setTitleColor(color);
3888 }
3889 }
3890 }
3891 }
3892
3893 protected void onChildTitleChanged(Activity childActivity, CharSequence title) {
3894 }
3895
3896 /**
3897 * Sets the visibility of the progress bar in the title.
3898 * <p>
3899 * In order for the progress bar to be shown, the feature must be requested
3900 * via {@link #requestWindowFeature(int)}.
3901 *
3902 * @param visible Whether to show the progress bars in the title.
3903 */
3904 public final void setProgressBarVisibility(boolean visible) {
3905 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, visible ? Window.PROGRESS_VISIBILITY_ON :
3906 Window.PROGRESS_VISIBILITY_OFF);
3907 }
3908
3909 /**
3910 * Sets the visibility of the indeterminate progress bar in the title.
3911 * <p>
3912 * In order for the progress bar to be shown, the feature must be requested
3913 * via {@link #requestWindowFeature(int)}.
3914 *
3915 * @param visible Whether to show the progress bars in the title.
3916 */
3917 public final void setProgressBarIndeterminateVisibility(boolean visible) {
3918 getWindow().setFeatureInt(Window.FEATURE_INDETERMINATE_PROGRESS,
3919 visible ? Window.PROGRESS_VISIBILITY_ON : Window.PROGRESS_VISIBILITY_OFF);
3920 }
3921
3922 /**
3923 * Sets whether the horizontal progress bar in the title should be indeterminate (the circular
3924 * is always indeterminate).
3925 * <p>
3926 * In order for the progress bar to be shown, the feature must be requested
3927 * via {@link #requestWindowFeature(int)}.
3928 *
3929 * @param indeterminate Whether the horizontal progress bar should be indeterminate.
3930 */
3931 public final void setProgressBarIndeterminate(boolean indeterminate) {
3932 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
3933 indeterminate ? Window.PROGRESS_INDETERMINATE_ON : Window.PROGRESS_INDETERMINATE_OFF);
3934 }
3935
3936 /**
3937 * Sets the progress for the progress bars in the title.
3938 * <p>
3939 * In order for the progress bar to be shown, the feature must be requested
3940 * via {@link #requestWindowFeature(int)}.
3941 *
3942 * @param progress The progress for the progress bar. Valid ranges are from
3943 * 0 to 10000 (both inclusive). If 10000 is given, the progress
3944 * bar will be completely filled and will fade out.
3945 */
3946 public final void setProgress(int progress) {
3947 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, progress + Window.PROGRESS_START);
3948 }
3949
3950 /**
3951 * Sets the secondary progress for the progress bar in the title. This
3952 * progress is drawn between the primary progress (set via
3953 * {@link #setProgress(int)} and the background. It can be ideal for media
3954 * scenarios such as showing the buffering progress while the default
3955 * progress shows the play progress.
3956 * <p>
3957 * In order for the progress bar to be shown, the feature must be requested
3958 * via {@link #requestWindowFeature(int)}.
3959 *
3960 * @param secondaryProgress The secondary progress for the progress bar. Valid ranges are from
3961 * 0 to 10000 (both inclusive).
3962 */
3963 public final void setSecondaryProgress(int secondaryProgress) {
3964 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
3965 secondaryProgress + Window.PROGRESS_SECONDARY_START);
3966 }
3967
3968 /**
3969 * Suggests an audio stream whose volume should be changed by the hardware
3970 * volume controls.
3971 * <p>
3972 * The suggested audio stream will be tied to the window of this Activity.
3973 * If the Activity is switched, the stream set here is no longer the
3974 * suggested stream. The client does not need to save and restore the old
3975 * suggested stream value in onPause and onResume.
3976 *
3977 * @param streamType The type of the audio stream whose volume should be
3978 * changed by the hardware volume controls. It is not guaranteed that
3979 * the hardware volume controls will always change this stream's
3980 * volume (for example, if a call is in progress, its stream's volume
3981 * may be changed instead). To reset back to the default, use
3982 * {@link AudioManager#USE_DEFAULT_STREAM_TYPE}.
3983 */
3984 public final void setVolumeControlStream(int streamType) {
3985 getWindow().setVolumeControlStream(streamType);
3986 }
3987
3988 /**
3989 * Gets the suggested audio stream whose volume should be changed by the
3990 * harwdare volume controls.
3991 *
3992 * @return The suggested audio stream type whose volume should be changed by
3993 * the hardware volume controls.
3994 * @see #setVolumeControlStream(int)
3995 */
3996 public final int getVolumeControlStream() {
3997 return getWindow().getVolumeControlStream();
3998 }
3999
4000 /**
4001 * Runs the specified action on the UI thread. If the current thread is the UI
4002 * thread, then the action is executed immediately. If the current thread is
4003 * not the UI thread, the action is posted to the event queue of the UI thread.
4004 *
4005 * @param action the action to run on the UI thread
4006 */
4007 public final void runOnUiThread(Runnable action) {
4008 if (Thread.currentThread() != mUiThread) {
4009 mHandler.post(action);
4010 } else {
4011 action.run();
4012 }
4013 }
4014
4015 /**
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004016 * Standard implementation of
4017 * {@link android.view.LayoutInflater.Factory#onCreateView} used when
4018 * inflating with the LayoutInflater returned by {@link #getSystemService}.
Dianne Hackborn625ac272010-09-17 18:29:22 -07004019 * This implementation does nothing and is for
4020 * pre-{@link android.os.Build.VERSION_CODES#HONEYCOMB} apps. Newer apps
4021 * should use {@link #onCreateView(View, String, Context, AttributeSet)}.
4022 *
4023 * @see android.view.LayoutInflater#createView
4024 * @see android.view.Window#getLayoutInflater
4025 */
4026 public View onCreateView(String name, Context context, AttributeSet attrs) {
4027 return null;
4028 }
4029
4030 /**
4031 * Standard implementation of
4032 * {@link android.view.LayoutInflater.Factory2#onCreateView(View, String, Context, AttributeSet)}
4033 * used when inflating with the LayoutInflater returned by {@link #getSystemService}.
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004034 * This implementation handles <fragment> tags to embed fragments inside
4035 * of the activity.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004036 *
4037 * @see android.view.LayoutInflater#createView
4038 * @see android.view.Window#getLayoutInflater
4039 */
Dianne Hackborn625ac272010-09-17 18:29:22 -07004040 public View onCreateView(View parent, String name, Context context, AttributeSet attrs) {
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004041 if (!"fragment".equals(name)) {
Dianne Hackborn625ac272010-09-17 18:29:22 -07004042 return onCreateView(name, context, attrs);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004043 }
4044
Dianne Hackborndef15372010-08-15 12:43:52 -07004045 String fname = attrs.getAttributeValue(null, "class");
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004046 TypedArray a =
4047 context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.Fragment);
Dianne Hackborndef15372010-08-15 12:43:52 -07004048 if (fname == null) {
4049 fname = a.getString(com.android.internal.R.styleable.Fragment_name);
4050 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004051 int id = a.getResourceId(com.android.internal.R.styleable.Fragment_id, View.NO_ID);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004052 String tag = a.getString(com.android.internal.R.styleable.Fragment_tag);
4053 a.recycle();
4054
Dianne Hackborn625ac272010-09-17 18:29:22 -07004055 int containerId = parent != null ? parent.getId() : 0;
4056 if (containerId == View.NO_ID && id == View.NO_ID && tag == null) {
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004057 throw new IllegalArgumentException(attrs.getPositionDescription()
Dianne Hackborn625ac272010-09-17 18:29:22 -07004058 + ": Must specify unique android:id, android:tag, or have a parent with an id for " + fname);
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004059 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004060
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004061 // If we restored from a previous state, we may already have
4062 // instantiated this fragment from the state and should use
4063 // that instance instead of making a new one.
Dianne Hackborn625ac272010-09-17 18:29:22 -07004064 Fragment fragment = id != View.NO_ID ? mFragments.findFragmentById(id) : null;
4065 if (fragment == null && tag != null) {
4066 fragment = mFragments.findFragmentByTag(tag);
4067 }
4068 if (fragment == null && containerId != View.NO_ID) {
4069 fragment = mFragments.findFragmentById(containerId);
4070 }
4071
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004072 if (FragmentManagerImpl.DEBUG) Log.v(TAG, "onCreateView: id=0x"
4073 + Integer.toHexString(id) + " fname=" + fname
4074 + " existing=" + fragment);
4075 if (fragment == null) {
4076 fragment = Fragment.instantiate(this, fname);
4077 fragment.mFromLayout = true;
Dianne Hackborn625ac272010-09-17 18:29:22 -07004078 fragment.mFragmentId = id != 0 ? id : containerId;
4079 fragment.mContainerId = containerId;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004080 fragment.mTag = tag;
Dianne Hackborn625ac272010-09-17 18:29:22 -07004081 fragment.mInLayout = true;
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004082 fragment.mImmediateActivity = this;
Dianne Hackborn3e449ce2010-09-11 20:52:31 -07004083 fragment.mFragmentManager = mFragments;
Dianne Hackborn625ac272010-09-17 18:29:22 -07004084 fragment.onInflate(attrs, fragment.mSavedFragmentState);
4085 mFragments.addFragment(fragment, true);
4086
4087 } else if (fragment.mInLayout) {
4088 // A fragment already exists and it is not one we restored from
4089 // previous state.
4090 throw new IllegalArgumentException(attrs.getPositionDescription()
4091 + ": Duplicate id 0x" + Integer.toHexString(id)
4092 + ", tag " + tag + ", or parent id 0x" + Integer.toHexString(containerId)
4093 + " with another fragment for " + fname);
4094 } else {
4095 // This fragment was retained from a previous instance; get it
4096 // going now.
4097 fragment.mInLayout = true;
4098 fragment.mImmediateActivity = this;
Dianne Hackborndef15372010-08-15 12:43:52 -07004099 // If this fragment is newly instantiated (either right now, or
4100 // from last saved state), then give it the attributes to
4101 // initialize itself.
4102 if (!fragment.mRetaining) {
4103 fragment.onInflate(attrs, fragment.mSavedFragmentState);
4104 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004105 mFragments.moveToState(fragment);
Dianne Hackbornba51c3d2010-05-05 18:49:48 -07004106 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004107
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004108 if (fragment.mView == null) {
4109 throw new IllegalStateException("Fragment " + fname
4110 + " did not create a view.");
4111 }
Dianne Hackborn625ac272010-09-17 18:29:22 -07004112 if (id != 0) {
4113 fragment.mView.setId(id);
4114 }
Dianne Hackbornb7a2e472010-08-12 16:20:42 -07004115 if (fragment.mView.getTag() == null) {
4116 fragment.mView.setTag(tag);
4117 }
4118 return fragment.mView;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004119 }
4120
Daniel Sandler69a48172010-06-23 16:29:36 -04004121 /**
Dianne Hackborn625ac272010-09-17 18:29:22 -07004122 * Print the Activity's state into the given stream. This gets invoked if
4123 * you run "adb shell dumpsys activity <youractivityname>".
4124 *
4125 * @param fd The raw file descriptor that the dump is being sent to.
4126 * @param writer The PrintWriter to which you should dump your state. This will be
4127 * closed for you after you return.
4128 * @param args additional arguments to the dump request.
4129 */
4130 public void dump(FileDescriptor fd, PrintWriter writer, String[] args) {
4131 mFragments.dump("", fd, writer, args);
4132 }
4133
4134 /**
Daniel Sandler69a48172010-06-23 16:29:36 -04004135 * Bit indicating that this activity is "immersive" and should not be
4136 * interrupted by notifications if possible.
4137 *
4138 * This value is initially set by the manifest property
4139 * <code>android:immersive</code> but may be changed at runtime by
4140 * {@link #setImmersive}.
4141 *
4142 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE
Dianne Hackborn02486b12010-08-26 14:18:37 -07004143 * @hide
Daniel Sandler69a48172010-06-23 16:29:36 -04004144 */
4145 public boolean isImmersive() {
4146 try {
4147 return ActivityManagerNative.getDefault().isImmersive(mToken);
4148 } catch (RemoteException e) {
4149 return false;
4150 }
4151 }
4152
4153 /**
4154 * Adjust the current immersive mode setting.
4155 *
4156 * Note that changing this value will have no effect on the activity's
4157 * {@link android.content.pm.ActivityInfo} structure; that is, if
4158 * <code>android:immersive</code> is set to <code>true</code>
4159 * in the application's manifest entry for this activity, the {@link
4160 * android.content.pm.ActivityInfo#flags ActivityInfo.flags} member will
4161 * always have its {@link android.content.pm.ActivityInfo#FLAG_IMMERSIVE
4162 * FLAG_IMMERSIVE} bit set.
4163 *
4164 * @see #isImmersive
4165 * @see android.content.pm.ActivityInfo#FLAG_IMMERSIVE
Dianne Hackborn02486b12010-08-26 14:18:37 -07004166 * @hide
Daniel Sandler69a48172010-06-23 16:29:36 -04004167 */
4168 public void setImmersive(boolean i) {
4169 try {
4170 ActivityManagerNative.getDefault().setImmersive(mToken, i);
4171 } catch (RemoteException e) {
4172 // pass
4173 }
4174 }
4175
Adam Powell6e346362010-07-23 10:18:23 -07004176 /**
Adam Powelldebf3be2010-11-15 18:58:48 -08004177 * Start an action mode.
Adam Powell6e346362010-07-23 10:18:23 -07004178 *
4179 * @param callback Callback that will manage lifecycle events for this context mode
4180 * @return The ContextMode that was started, or null if it was canceled
4181 *
4182 * @see ActionMode
4183 */
Adam Powell5d279772010-07-27 16:34:07 -07004184 public ActionMode startActionMode(ActionMode.Callback callback) {
Adam Powell6e346362010-07-23 10:18:23 -07004185 return mWindow.getDecorView().startActionMode(callback);
4186 }
4187
Adam Powelldebf3be2010-11-15 18:58:48 -08004188 /**
4189 * Give the Activity a chance to control the UI for an action mode requested
4190 * by the system.
4191 *
4192 * <p>Note: If you are looking for a notification callback that an action mode
4193 * has been started for this activity, see {@link #onActionModeStarted(ActionMode)}.</p>
4194 *
4195 * @param callback The callback that should control the new action mode
4196 * @return The new action mode, or <code>null</code> if the activity does not want to
4197 * provide special handling for this action mode. (It will be handled by the system.)
4198 */
4199 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback) {
Adam Powell42c0fe82010-08-10 16:36:56 -07004200 initActionBar();
Adam Powell6e346362010-07-23 10:18:23 -07004201 if (mActionBar != null) {
Adam Powell5d279772010-07-27 16:34:07 -07004202 return mActionBar.startActionMode(callback);
Adam Powell6e346362010-07-23 10:18:23 -07004203 }
4204 return null;
4205 }
4206
Adam Powelldebf3be2010-11-15 18:58:48 -08004207 /**
4208 * Notifies the Activity that an action mode has been started.
4209 * Activity subclasses overriding this method should call the superclass implementation.
4210 *
4211 * @param mode The new action mode.
4212 */
4213 public void onActionModeStarted(ActionMode mode) {
4214 }
4215
4216 /**
4217 * Notifies the activity that an action mode has finished.
4218 * Activity subclasses overriding this method should call the superclass implementation.
4219 *
4220 * @param mode The action mode that just finished.
4221 */
4222 public void onActionModeFinished(ActionMode mode) {
4223 }
4224
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004225 // ------------------ Internal API ------------------
4226
4227 final void setParent(Activity parent) {
4228 mParent = parent;
4229 }
4230
4231 final void attach(Context context, ActivityThread aThread, Instrumentation instr, IBinder token,
4232 Application application, Intent intent, ActivityInfo info, CharSequence title,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004233 Activity parent, String id, NonConfigurationInstances lastNonConfigurationInstances,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004234 Configuration config) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004235 attach(context, aThread, instr, token, 0, application, intent, info, title, parent, id,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004236 lastNonConfigurationInstances, config);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004237 }
4238
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004239 final void attach(Context context, ActivityThread aThread,
4240 Instrumentation instr, IBinder token, int ident,
4241 Application application, Intent intent, ActivityInfo info,
4242 CharSequence title, Activity parent, String id,
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004243 NonConfigurationInstances lastNonConfigurationInstances,
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004244 Configuration config) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004245 attachBaseContext(context);
4246
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004247 mFragments.attachActivity(this);
4248
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004249 mWindow = PolicyManager.makeNewWindow(this);
4250 mWindow.setCallback(this);
Dianne Hackborn625ac272010-09-17 18:29:22 -07004251 mWindow.getLayoutInflater().setFactory2(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004252 if (info.softInputMode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
4253 mWindow.setSoftInputMode(info.softInputMode);
4254 }
4255 mUiThread = Thread.currentThread();
Romain Guy529b60a2010-08-03 18:05:47 -07004256
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004257 mMainThread = aThread;
4258 mInstrumentation = instr;
4259 mToken = token;
Dianne Hackbornb06ea702009-07-13 13:07:51 -07004260 mIdent = ident;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004261 mApplication = application;
4262 mIntent = intent;
4263 mComponent = intent.getComponent();
4264 mActivityInfo = info;
4265 mTitle = title;
4266 mParent = parent;
4267 mEmbeddedID = id;
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004268 mLastNonConfigurationInstances = lastNonConfigurationInstances;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004269
Romain Guy529b60a2010-08-03 18:05:47 -07004270 mWindow.setWindowManager(null, mToken, mComponent.flattenToString(),
4271 (info.flags & ActivityInfo.FLAG_HARDWARE_ACCELERATED) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004272 if (mParent != null) {
4273 mWindow.setContainer(mParent.getWindow());
4274 }
4275 mWindowManager = mWindow.getWindowManager();
4276 mCurrentConfig = config;
4277 }
4278
4279 final IBinder getActivityToken() {
4280 return mParent != null ? mParent.getActivityToken() : mToken;
4281 }
4282
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004283 final void performCreate(Bundle icicle) {
4284 onCreate(icicle);
Dianne Hackbornc8017682010-07-06 13:34:38 -07004285 mFragments.dispatchActivityCreated();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004286 }
4287
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004288 final void performStart() {
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004289 mFragments.noteStateNotSaved();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004290 mCalled = false;
Dianne Hackborn445646c2010-06-25 15:52:59 -07004291 mFragments.execPendingActions();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004292 mInstrumentation.callActivityOnStart(this);
4293 if (!mCalled) {
4294 throw new SuperNotCalledException(
4295 "Activity " + mComponent.toShortString() +
4296 " did not call through to super.onStart()");
4297 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004298 mFragments.dispatchStart();
Dianne Hackborn2707d602010-07-09 18:01:20 -07004299 if (mAllLoaderManagers != null) {
4300 for (int i=mAllLoaderManagers.size()-1; i>=0; i--) {
4301 mAllLoaderManagers.valueAt(i).finishRetain();
4302 }
4303 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004304 }
4305
4306 final void performRestart() {
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004307 mFragments.noteStateNotSaved();
Dianne Hackborna21e3da2010-09-12 19:27:46 -07004308
Makoto Onuki2f6a0182010-02-22 13:26:59 -08004309 synchronized (mManagedCursors) {
4310 final int N = mManagedCursors.size();
4311 for (int i=0; i<N; i++) {
4312 ManagedCursor mc = mManagedCursors.get(i);
4313 if (mc.mReleased || mc.mUpdated) {
Vasu Noria7dd5ea2010-08-04 11:57:51 -07004314 if (!mc.mCursor.requery()) {
4315 throw new IllegalStateException(
4316 "trying to requery an already closed cursor");
4317 }
Makoto Onuki2f6a0182010-02-22 13:26:59 -08004318 mc.mReleased = false;
4319 mc.mUpdated = false;
4320 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004321 }
4322 }
4323
4324 if (mStopped) {
4325 mStopped = false;
4326 mCalled = false;
4327 mInstrumentation.callActivityOnRestart(this);
4328 if (!mCalled) {
4329 throw new SuperNotCalledException(
4330 "Activity " + mComponent.toShortString() +
4331 " did not call through to super.onRestart()");
4332 }
4333 performStart();
4334 }
4335 }
4336
4337 final void performResume() {
4338 performRestart();
4339
Dianne Hackborn445646c2010-06-25 15:52:59 -07004340 mFragments.execPendingActions();
4341
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004342 mLastNonConfigurationInstances = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004343
4344 // First call onResume() -before- setting mResumed, so we don't
4345 // send out any status bar / menu notifications the client makes.
4346 mCalled = false;
4347 mInstrumentation.callActivityOnResume(this);
4348 if (!mCalled) {
4349 throw new SuperNotCalledException(
4350 "Activity " + mComponent.toShortString() +
4351 " did not call through to super.onResume()");
4352 }
4353
4354 // Now really resume, and install the current status bar and menu.
4355 mResumed = true;
4356 mCalled = false;
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004357
4358 mFragments.dispatchResume();
Dianne Hackborn445646c2010-06-25 15:52:59 -07004359 mFragments.execPendingActions();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004360
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004361 onPostResume();
4362 if (!mCalled) {
4363 throw new SuperNotCalledException(
4364 "Activity " + mComponent.toShortString() +
4365 " did not call through to super.onPostResume()");
4366 }
4367 }
4368
4369 final void performPause() {
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004370 mFragments.dispatchPause();
Dianne Hackborne794e9f2010-08-24 12:32:10 -07004371 mCalled = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004372 onPause();
Dianne Hackborne794e9f2010-08-24 12:32:10 -07004373 if (!mCalled && getApplicationInfo().targetSdkVersion
4374 >= android.os.Build.VERSION_CODES.GINGERBREAD) {
4375 throw new SuperNotCalledException(
4376 "Activity " + mComponent.toShortString() +
4377 " did not call through to super.onPause()");
4378 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004379 }
4380
4381 final void performUserLeaving() {
4382 onUserInteraction();
4383 onUserLeaveHint();
4384 }
4385
4386 final void performStop() {
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004387 if (mLoadersStarted) {
4388 mLoadersStarted = false;
Dianne Hackborn2707d602010-07-09 18:01:20 -07004389 if (mLoaderManager != null) {
4390 if (!mChangingConfigurations) {
4391 mLoaderManager.doStop();
4392 } else {
4393 mLoaderManager.doRetain();
4394 }
4395 }
4396 }
4397
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004398 if (!mStopped) {
4399 if (mWindow != null) {
4400 mWindow.closeAllPanels();
4401 }
4402
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004403 mFragments.dispatchStop();
4404
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004405 mCalled = false;
4406 mInstrumentation.callActivityOnStop(this);
4407 if (!mCalled) {
4408 throw new SuperNotCalledException(
4409 "Activity " + mComponent.toShortString() +
4410 " did not call through to super.onStop()");
4411 }
4412
Makoto Onuki2f6a0182010-02-22 13:26:59 -08004413 synchronized (mManagedCursors) {
4414 final int N = mManagedCursors.size();
4415 for (int i=0; i<N; i++) {
4416 ManagedCursor mc = mManagedCursors.get(i);
4417 if (!mc.mReleased) {
4418 mc.mCursor.deactivate();
4419 mc.mReleased = true;
4420 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004421 }
4422 }
4423
4424 mStopped = true;
4425 }
4426 mResumed = false;
4427 }
4428
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004429 final void performDestroy() {
Dianne Hackborn291905e2010-08-17 15:17:15 -07004430 mWindow.destroy();
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004431 mFragments.dispatchDestroy();
4432 onDestroy();
Dianne Hackborn5e0d5952010-08-05 13:45:35 -07004433 if (mLoaderManager != null) {
4434 mLoaderManager.doDestroy();
4435 }
Dianne Hackborn2dedce62010-04-15 14:45:25 -07004436 }
4437
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004438 final boolean isResumed() {
4439 return mResumed;
4440 }
4441
4442 void dispatchActivityResult(String who, int requestCode,
4443 int resultCode, Intent data) {
4444 if (Config.LOGV) Log.v(
4445 TAG, "Dispatching result: who=" + who + ", reqCode=" + requestCode
4446 + ", resCode=" + resultCode + ", data=" + data);
Dianne Hackbornfb3cffe2010-10-25 17:08:56 -07004447 mFragments.noteStateNotSaved();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004448 if (who == null) {
4449 onActivityResult(requestCode, resultCode, data);
Dianne Hackborn6e8304e2010-05-14 00:42:53 -07004450 } else {
4451 Fragment frag = mFragments.findFragmentByWho(who);
4452 if (frag != null) {
4453 frag.onActivityResult(requestCode, resultCode, data);
4454 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004455 }
4456 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004457}