blob: 78a77eb09997217c9420ec509cea6ddc725e3bd6 [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
svetoslavganov75986cf2009-05-14 22:28:01 -070019import com.android.internal.policy.PolicyManager;
20
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080021import android.content.ComponentCallbacks;
22import android.content.ComponentName;
23import android.content.ContentResolver;
24import android.content.Context;
25import android.content.Intent;
Suchi Amalapurapu1ccac752009-06-12 10:09:58 -070026import android.content.IIntentSender;
Dianne Hackbornfa82f222009-09-17 15:14:12 -070027import android.content.IntentSender;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028import android.content.SharedPreferences;
29import android.content.pm.ActivityInfo;
30import android.content.res.Configuration;
31import android.content.res.Resources;
32import android.database.Cursor;
33import android.graphics.Bitmap;
34import android.graphics.Canvas;
35import android.graphics.drawable.Drawable;
36import android.media.AudioManager;
37import android.net.Uri;
Dianne Hackborn8d374262009-09-14 21:21:52 -070038import android.os.Build;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080039import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080040import android.os.Handler;
41import android.os.IBinder;
svetoslavganov75986cf2009-05-14 22:28:01 -070042import android.os.RemoteException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.text.Selection;
44import android.text.SpannableStringBuilder;
svetoslavganov75986cf2009-05-14 22:28:01 -070045import android.text.TextUtils;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080046import android.text.method.TextKeyListener;
47import android.util.AttributeSet;
48import android.util.Config;
49import android.util.EventLog;
50import android.util.Log;
51import android.util.SparseArray;
52import android.view.ContextMenu;
53import android.view.ContextThemeWrapper;
54import android.view.KeyEvent;
55import android.view.LayoutInflater;
56import android.view.Menu;
57import android.view.MenuInflater;
58import android.view.MenuItem;
59import android.view.MotionEvent;
60import android.view.View;
61import android.view.ViewGroup;
62import android.view.ViewManager;
63import android.view.Window;
64import android.view.WindowManager;
65import android.view.ContextMenu.ContextMenuInfo;
66import android.view.View.OnCreateContextMenuListener;
svetoslavganov75986cf2009-05-14 22:28:01 -070067import android.view.ViewGroup.LayoutParams;
68import android.view.accessibility.AccessibilityEvent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080069import android.widget.AdapterView;
Jim Miller0b2a6d02010-07-13 18:01:29 -070070import android.widget.FrameLayout;
71import android.widget.LinearLayout;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080072
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080073import java.util.ArrayList;
74import java.util.HashMap;
75
76/**
77 * An activity is a single, focused thing that the user can do. Almost all
78 * activities interact with the user, so the Activity class takes care of
79 * creating a window for you in which you can place your UI with
80 * {@link #setContentView}. While activities are often presented to the user
81 * as full-screen windows, they can also be used in other ways: as floating
82 * windows (via a theme with {@link android.R.attr#windowIsFloating} set)
83 * or embedded inside of another activity (using {@link ActivityGroup}).
84 *
85 * There are two methods almost all subclasses of Activity will implement:
86 *
87 * <ul>
88 * <li> {@link #onCreate} is where you initialize your activity. Most
89 * importantly, here you will usually call {@link #setContentView(int)}
90 * with a layout resource defining your UI, and using {@link #findViewById}
91 * to retrieve the widgets in that UI that you need to interact with
92 * programmatically.
93 *
94 * <li> {@link #onPause} is where you deal with the user leaving your
95 * activity. Most importantly, any changes made by the user should at this
96 * point be committed (usually to the
97 * {@link android.content.ContentProvider} holding the data).
98 * </ul>
99 *
100 * <p>To be of use with {@link android.content.Context#startActivity Context.startActivity()}, all
101 * activity classes must have a corresponding
102 * {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
103 * declaration in their package's <code>AndroidManifest.xml</code>.</p>
104 *
105 * <p>The Activity class is an important part of an application's overall lifecycle,
106 * and the way activities are launched and put together is a fundamental
107 * part of the platform's application model. For a detailed perspective on the structure of
108 * Android applications and lifecycles, please read the <em>Dev Guide</em> document on
109 * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a>.</p>
110 *
111 * <p>Topics covered here:
112 * <ol>
113 * <li><a href="#ActivityLifecycle">Activity Lifecycle</a>
114 * <li><a href="#ConfigurationChanges">Configuration Changes</a>
115 * <li><a href="#StartingActivities">Starting Activities and Getting Results</a>
116 * <li><a href="#SavingPersistentState">Saving Persistent State</a>
117 * <li><a href="#Permissions">Permissions</a>
118 * <li><a href="#ProcessLifecycle">Process Lifecycle</a>
119 * </ol>
120 *
121 * <a name="ActivityLifecycle"></a>
122 * <h3>Activity Lifecycle</h3>
123 *
124 * <p>Activities in the system are managed as an <em>activity stack</em>.
125 * When a new activity is started, it is placed on the top of the stack
126 * and becomes the running activity -- the previous activity always remains
127 * below it in the stack, and will not come to the foreground again until
128 * the new activity exits.</p>
129 *
130 * <p>An activity has essentially four states:</p>
131 * <ul>
132 * <li> If an activity in the foreground of the screen (at the top of
133 * the stack),
134 * it is <em>active</em> or <em>running</em>. </li>
135 * <li>If an activity has lost focus but is still visible (that is, a new non-full-sized
136 * or transparent activity has focus on top of your activity), it
137 * is <em>paused</em>. A paused activity is completely alive (it
138 * maintains all state and member information and remains attached to
139 * the window manager), but can be killed by the system in extreme
140 * low memory situations.
141 * <li>If an activity is completely obscured by another activity,
142 * it is <em>stopped</em>. It still retains all state and member information,
143 * however, it is no longer visible to the user so its window is hidden
144 * and it will often be killed by the system when memory is needed
145 * elsewhere.</li>
146 * <li>If an activity is paused or stopped, the system can drop the activity
147 * from memory by either asking it to finish, or simply killing its
148 * process. When it is displayed again to the user, it must be
149 * completely restarted and restored to its previous state.</li>
150 * </ul>
151 *
152 * <p>The following diagram shows the important state paths of an Activity.
153 * The square rectangles represent callback methods you can implement to
154 * perform operations when the Activity moves between states. The colored
155 * ovals are major states the Activity can be in.</p>
156 *
157 * <p><img src="../../../images/activity_lifecycle.png"
158 * alt="State diagram for an Android Activity Lifecycle." border="0" /></p>
159 *
160 * <p>There are three key loops you may be interested in monitoring within your
161 * activity:
162 *
163 * <ul>
164 * <li>The <b>entire lifetime</b> of an activity happens between the first call
165 * to {@link android.app.Activity#onCreate} through to a single final call
166 * to {@link android.app.Activity#onDestroy}. An activity will do all setup
167 * of "global" state in onCreate(), and release all remaining resources in
168 * onDestroy(). For example, if it has a thread running in the background
169 * to download data from the network, it may create that thread in onCreate()
170 * and then stop the thread in onDestroy().
171 *
172 * <li>The <b>visible lifetime</b> of an activity happens between a call to
173 * {@link android.app.Activity#onStart} until a corresponding call to
174 * {@link android.app.Activity#onStop}. During this time the user can see the
175 * activity on-screen, though it may not be in the foreground and interacting
176 * with the user. Between these two methods you can maintain resources that
177 * are needed to show the activity to the user. For example, you can register
178 * a {@link android.content.BroadcastReceiver} in onStart() to monitor for changes
179 * that impact your UI, and unregister it in onStop() when the user an no
180 * longer see what you are displaying. The onStart() and onStop() methods
181 * can be called multiple times, as the activity becomes visible and hidden
182 * to the user.
183 *
184 * <li>The <b>foreground lifetime</b> of an activity happens between a call to
185 * {@link android.app.Activity#onResume} until a corresponding call to
186 * {@link android.app.Activity#onPause}. During this time the activity is
187 * in front of all other activities and interacting with the user. An activity
188 * can frequently go between the resumed and paused states -- for example when
189 * the device goes to sleep, when an activity result is delivered, when a new
190 * intent is delivered -- so the code in these methods should be fairly
191 * lightweight.
192 * </ul>
193 *
194 * <p>The entire lifecycle of an activity is defined by the following
195 * Activity methods. All of these are hooks that you can override
196 * to do appropriate work when the activity changes state. All
197 * activities will implement {@link android.app.Activity#onCreate}
198 * to do their initial setup; many will also implement
199 * {@link android.app.Activity#onPause} to commit changes to data and
200 * otherwise prepare to stop interacting with the user. You should always
201 * call up to your superclass when implementing these methods.</p>
202 *
203 * </p>
204 * <pre class="prettyprint">
205 * public class Activity extends ApplicationContext {
206 * protected void onCreate(Bundle savedInstanceState);
207 *
208 * protected void onStart();
209 *
210 * protected void onRestart();
211 *
212 * protected void onResume();
213 *
214 * protected void onPause();
215 *
216 * protected void onStop();
217 *
218 * protected void onDestroy();
219 * }
220 * </pre>
221 *
222 * <p>In general the movement through an activity's lifecycle looks like
223 * this:</p>
224 *
225 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
226 * <colgroup align="left" span="3" />
227 * <colgroup align="left" />
228 * <colgroup align="center" />
229 * <colgroup align="center" />
230 *
231 * <thead>
232 * <tr><th colspan="3">Method</th> <th>Description</th> <th>Killable?</th> <th>Next</th></tr>
233 * </thead>
234 *
235 * <tbody>
236 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onCreate onCreate()}</th>
237 * <td>Called when the activity is first created.
238 * This is where you should do all of your normal static set up:
239 * create views, bind data to lists, etc. This method also
240 * provides you with a Bundle containing the activity's previously
241 * frozen state, if there was one.
242 * <p>Always followed by <code>onStart()</code>.</td>
243 * <td align="center">No</td>
244 * <td align="center"><code>onStart()</code></td>
245 * </tr>
246 *
247 * <tr><td rowspan="5" style="border-left: none; border-right: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
248 * <th colspan="2" align="left" border="0">{@link android.app.Activity#onRestart onRestart()}</th>
249 * <td>Called after your activity has been stopped, prior to it being
250 * started again.
251 * <p>Always followed by <code>onStart()</code></td>
252 * <td align="center">No</td>
253 * <td align="center"><code>onStart()</code></td>
254 * </tr>
255 *
256 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStart onStart()}</th>
257 * <td>Called when the activity is becoming visible to the user.
258 * <p>Followed by <code>onResume()</code> if the activity comes
259 * to the foreground, or <code>onStop()</code> if it becomes hidden.</td>
260 * <td align="center">No</td>
261 * <td align="center"><code>onResume()</code> or <code>onStop()</code></td>
262 * </tr>
263 *
264 * <tr><td rowspan="2" style="border-left: none;">&nbsp;&nbsp;&nbsp;&nbsp;</td>
265 * <th align="left" border="0">{@link android.app.Activity#onResume onResume()}</th>
266 * <td>Called when the activity will start
267 * interacting with the user. At this point your activity is at
268 * the top of the activity stack, with user input going to it.
269 * <p>Always followed by <code>onPause()</code>.</td>
270 * <td align="center">No</td>
271 * <td align="center"><code>onPause()</code></td>
272 * </tr>
273 *
274 * <tr><th align="left" border="0">{@link android.app.Activity#onPause onPause()}</th>
275 * <td>Called when the system is about to start resuming a previous
276 * activity. This is typically used to commit unsaved changes to
277 * persistent data, stop animations and other things that may be consuming
278 * CPU, etc. Implementations of this method must be very quick because
279 * the next activity will not be resumed until this method returns.
280 * <p>Followed by either <code>onResume()</code> if the activity
281 * returns back to the front, or <code>onStop()</code> if it becomes
282 * invisible to the user.</td>
283 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
284 * <td align="center"><code>onResume()</code> or<br>
285 * <code>onStop()</code></td>
286 * </tr>
287 *
288 * <tr><th colspan="2" align="left" border="0">{@link android.app.Activity#onStop onStop()}</th>
289 * <td>Called when the activity is no longer visible to the user, because
290 * another activity has been resumed and is covering this one. This
291 * may happen either because a new activity is being started, an existing
292 * one is being brought in front of this one, or this one is being
293 * destroyed.
294 * <p>Followed by either <code>onRestart()</code> if
295 * this activity is coming back to interact with the user, or
296 * <code>onDestroy()</code> if this activity is going away.</td>
297 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
298 * <td align="center"><code>onRestart()</code> or<br>
299 * <code>onDestroy()</code></td>
300 * </tr>
301 *
302 * <tr><th colspan="3" align="left" border="0">{@link android.app.Activity#onDestroy onDestroy()}</th>
303 * <td>The final call you receive before your
304 * activity is destroyed. This can happen either because the
305 * activity is finishing (someone called {@link Activity#finish} on
306 * it, or because the system is temporarily destroying this
307 * instance of the activity to save space. You can distinguish
308 * between these two scenarios with the {@link
309 * Activity#isFinishing} method.</td>
310 * <td align="center"><font color="#800000"><strong>Yes</strong></font></td>
311 * <td align="center"><em>nothing</em></td>
312 * </tr>
313 * </tbody>
314 * </table>
315 *
316 * <p>Note the "Killable" column in the above table -- for those methods that
317 * are marked as being killable, after that method returns the process hosting the
318 * activity may killed by the system <em>at any time</em> without another line
319 * of its code being executed. Because of this, you should use the
320 * {@link #onPause} method to write any persistent data (such as user edits)
321 * to storage. In addition, the method
322 * {@link #onSaveInstanceState(Bundle)} is called before placing the activity
323 * in such a background state, allowing you to save away any dynamic instance
324 * state in your activity into the given Bundle, to be later received in
325 * {@link #onCreate} if the activity needs to be re-created.
326 * See the <a href="#ProcessLifecycle">Process Lifecycle</a>
327 * section for more information on how the lifecycle of a process is tied
328 * to the activities it is hosting. Note that it is important to save
329 * persistent data in {@link #onPause} instead of {@link #onSaveInstanceState}
330 * because the later is not part of the lifecycle callbacks, so will not
331 * be called in every situation as described in its documentation.</p>
332 *
333 * <p>For those methods that are not marked as being killable, the activity's
334 * process will not be killed by the system starting from the time the method
335 * is called and continuing after it returns. Thus an activity is in the killable
336 * state, for example, between after <code>onPause()</code> to the start of
337 * <code>onResume()</code>.</p>
338 *
339 * <a name="ConfigurationChanges"></a>
340 * <h3>Configuration Changes</h3>
341 *
342 * <p>If the configuration of the device (as defined by the
343 * {@link Configuration Resources.Configuration} class) changes,
344 * then anything displaying a user interface will need to update to match that
345 * configuration. Because Activity is the primary mechanism for interacting
346 * with the user, it includes special support for handling configuration
347 * changes.</p>
348 *
349 * <p>Unless you specify otherwise, a configuration change (such as a change
350 * in screen orientation, language, input devices, etc) will cause your
351 * current activity to be <em>destroyed</em>, going through the normal activity
352 * lifecycle process of {@link #onPause},
353 * {@link #onStop}, and {@link #onDestroy} as appropriate. If the activity
354 * had been in the foreground or visible to the user, once {@link #onDestroy} is
355 * called in that instance then a new instance of the activity will be
356 * created, with whatever savedInstanceState the previous instance had generated
357 * from {@link #onSaveInstanceState}.</p>
358 *
359 * <p>This is done because any application resource,
360 * including layout files, can change based on any configuration value. Thus
361 * the only safe way to handle a configuration change is to re-retrieve all
362 * resources, including layouts, drawables, and strings. Because activities
363 * must already know how to save their state and re-create themselves from
364 * that state, this is a convenient way to have an activity restart itself
365 * with a new configuration.</p>
366 *
367 * <p>In some special cases, you may want to bypass restarting of your
368 * activity based on one or more types of configuration changes. This is
369 * done with the {@link android.R.attr#configChanges android:configChanges}
370 * attribute in its manifest. For any types of configuration changes you say
371 * that you handle there, you will receive a call to your current activity's
372 * {@link #onConfigurationChanged} method instead of being restarted. If
373 * a configuration change involves any that you do not handle, however, the
374 * activity will still be restarted and {@link #onConfigurationChanged}
375 * will not be called.</p>
376 *
377 * <a name="StartingActivities"></a>
378 * <h3>Starting Activities and Getting Results</h3>
379 *
380 * <p>The {@link android.app.Activity#startActivity}
381 * method is used to start a
382 * new activity, which will be placed at the top of the activity stack. It
383 * takes a single argument, an {@link android.content.Intent Intent},
384 * which describes the activity
385 * to be executed.</p>
386 *
387 * <p>Sometimes you want to get a result back from an activity when it
388 * ends. For example, you may start an activity that lets the user pick
389 * a person in a list of contacts; when it ends, it returns the person
390 * that was selected. To do this, you call the
391 * {@link android.app.Activity#startActivityForResult(Intent, int)}
392 * version with a second integer parameter identifying the call. The result
393 * will come back through your {@link android.app.Activity#onActivityResult}
394 * method.</p>
395 *
396 * <p>When an activity exits, it can call
397 * {@link android.app.Activity#setResult(int)}
398 * to return data back to its parent. It must always supply a result code,
399 * which can be the standard results RESULT_CANCELED, RESULT_OK, or any
400 * custom values starting at RESULT_FIRST_USER. In addition, it can optionally
401 * return back an Intent containing any additional data it wants. All of this
402 * information appears back on the
403 * parent's <code>Activity.onActivityResult()</code>, along with the integer
404 * identifier it originally supplied.</p>
405 *
406 * <p>If a child activity fails for any reason (such as crashing), the parent
407 * activity will receive a result with the code RESULT_CANCELED.</p>
408 *
409 * <pre class="prettyprint">
410 * public class MyActivity extends Activity {
411 * ...
412 *
413 * static final int PICK_CONTACT_REQUEST = 0;
414 *
415 * protected boolean onKeyDown(int keyCode, KeyEvent event) {
416 * if (keyCode == KeyEvent.KEYCODE_DPAD_CENTER) {
417 * // When the user center presses, let them pick a contact.
418 * startActivityForResult(
419 * new Intent(Intent.ACTION_PICK,
420 * new Uri("content://contacts")),
421 * PICK_CONTACT_REQUEST);
422 * return true;
423 * }
424 * return false;
425 * }
426 *
427 * protected void onActivityResult(int requestCode, int resultCode,
428 * Intent data) {
429 * if (requestCode == PICK_CONTACT_REQUEST) {
430 * if (resultCode == RESULT_OK) {
431 * // A contact was picked. Here we will just display it
432 * // to the user.
433 * startActivity(new Intent(Intent.ACTION_VIEW, data));
434 * }
435 * }
436 * }
437 * }
438 * </pre>
439 *
440 * <a name="SavingPersistentState"></a>
441 * <h3>Saving Persistent State</h3>
442 *
443 * <p>There are generally two kinds of persistent state than an activity
444 * will deal with: shared document-like data (typically stored in a SQLite
445 * database using a {@linkplain android.content.ContentProvider content provider})
446 * and internal state such as user preferences.</p>
447 *
448 * <p>For content provider data, we suggest that activities use a
449 * "edit in place" user model. That is, any edits a user makes are effectively
450 * made immediately without requiring an additional confirmation step.
451 * Supporting this model is generally a simple matter of following two rules:</p>
452 *
453 * <ul>
454 * <li> <p>When creating a new document, the backing database entry or file for
455 * it is created immediately. For example, if the user chooses to write
456 * a new e-mail, a new entry for that e-mail is created as soon as they
457 * start entering data, so that if they go to any other activity after
458 * that point this e-mail will now appear in the list of drafts.</p>
459 * <li> <p>When an activity's <code>onPause()</code> method is called, it should
460 * commit to the backing content provider or file any changes the user
461 * has made. This ensures that those changes will be seen by any other
462 * activity that is about to run. You will probably want to commit
463 * your data even more aggressively at key times during your
464 * activity's lifecycle: for example before starting a new
465 * activity, before finishing your own activity, when the user
466 * switches between input fields, etc.</p>
467 * </ul>
468 *
469 * <p>This model is designed to prevent data loss when a user is navigating
470 * between activities, and allows the system to safely kill an activity (because
471 * system resources are needed somewhere else) at any time after it has been
472 * paused. Note this implies
473 * that the user pressing BACK from your activity does <em>not</em>
474 * mean "cancel" -- it means to leave the activity with its current contents
475 * saved away. Cancelling edits in an activity must be provided through
476 * some other mechanism, such as an explicit "revert" or "undo" option.</p>
477 *
478 * <p>See the {@linkplain android.content.ContentProvider content package} for
479 * more information about content providers. These are a key aspect of how
480 * different activities invoke and propagate data between themselves.</p>
481 *
482 * <p>The Activity class also provides an API for managing internal persistent state
483 * associated with an activity. This can be used, for example, to remember
484 * the user's preferred initial display in a calendar (day view or week view)
485 * or the user's default home page in a web browser.</p>
486 *
487 * <p>Activity persistent state is managed
488 * with the method {@link #getPreferences},
489 * allowing you to retrieve and
490 * modify a set of name/value pairs associated with the activity. To use
491 * preferences that are shared across multiple application components
492 * (activities, receivers, services, providers), you can use the underlying
493 * {@link Context#getSharedPreferences Context.getSharedPreferences()} method
494 * to retrieve a preferences
495 * object stored under a specific name.
496 * (Note that it is not possible to share settings data across application
497 * packages -- for that you will need a content provider.)</p>
498 *
499 * <p>Here is an excerpt from a calendar activity that stores the user's
500 * preferred view mode in its persistent settings:</p>
501 *
502 * <pre class="prettyprint">
503 * public class CalendarActivity extends Activity {
504 * ...
505 *
506 * static final int DAY_VIEW_MODE = 0;
507 * static final int WEEK_VIEW_MODE = 1;
508 *
509 * private SharedPreferences mPrefs;
510 * private int mCurViewMode;
511 *
512 * protected void onCreate(Bundle savedInstanceState) {
513 * super.onCreate(savedInstanceState);
514 *
515 * SharedPreferences mPrefs = getSharedPreferences();
516 * mCurViewMode = mPrefs.getInt("view_mode" DAY_VIEW_MODE);
517 * }
518 *
519 * protected void onPause() {
520 * super.onPause();
521 *
522 * SharedPreferences.Editor ed = mPrefs.edit();
523 * ed.putInt("view_mode", mCurViewMode);
524 * ed.commit();
525 * }
526 * }
527 * </pre>
528 *
529 * <a name="Permissions"></a>
530 * <h3>Permissions</h3>
531 *
532 * <p>The ability to start a particular Activity can be enforced when it is
533 * declared in its
534 * manifest's {@link android.R.styleable#AndroidManifestActivity &lt;activity&gt;}
535 * tag. By doing so, other applications will need to declare a corresponding
536 * {@link android.R.styleable#AndroidManifestUsesPermission &lt;uses-permission&gt;}
537 * element in their own manifest to be able to start that activity.
538 *
539 * <p>See the <a href="{@docRoot}guide/topics/security/security.html">Security and Permissions</a>
540 * document for more information on permissions and security in general.
541 *
542 * <a name="ProcessLifecycle"></a>
543 * <h3>Process Lifecycle</h3>
544 *
545 * <p>The Android system attempts to keep application process around for as
546 * long as possible, but eventually will need to remove old processes when
547 * memory runs low. As described in <a href="#ActivityLifecycle">Activity
548 * Lifecycle</a>, the decision about which process to remove is intimately
549 * tied to the state of the user's interaction with it. In general, there
550 * are four states a process can be in based on the activities running in it,
551 * listed here in order of importance. The system will kill less important
552 * processes (the last ones) before it resorts to killing more important
553 * processes (the first ones).
554 *
555 * <ol>
556 * <li> <p>The <b>foreground activity</b> (the activity at the top of the screen
557 * that the user is currently interacting with) is considered the most important.
558 * Its process will only be killed as a last resort, if it uses more memory
559 * than is available on the device. Generally at this point the device has
560 * reached a memory paging state, so this is required in order to keep the user
561 * interface responsive.
562 * <li> <p>A <b>visible activity</b> (an activity that is visible to the user
563 * but not in the foreground, such as one sitting behind a foreground dialog)
564 * is considered extremely important and will not be killed unless that is
565 * required to keep the foreground activity running.
566 * <li> <p>A <b>background activity</b> (an activity that is not visible to
567 * the user and has been paused) is no longer critical, so the system may
568 * safely kill its process to reclaim memory for other foreground or
569 * visible processes. If its process needs to be killed, when the user navigates
570 * back to the activity (making it visible on the screen again), its
571 * {@link #onCreate} method will be called with the savedInstanceState it had previously
572 * supplied in {@link #onSaveInstanceState} so that it can restart itself in the same
573 * state as the user last left it.
574 * <li> <p>An <b>empty process</b> is one hosting no activities or other
575 * application components (such as {@link Service} or
576 * {@link android.content.BroadcastReceiver} classes). These are killed very
577 * quickly by the system as memory becomes low. For this reason, any
578 * background operation you do outside of an activity must be executed in the
579 * context of an activity BroadcastReceiver or Service to ensure that the system
580 * knows it needs to keep your process around.
581 * </ol>
582 *
583 * <p>Sometimes an Activity may need to do a long-running operation that exists
584 * independently of the activity lifecycle itself. An example may be a camera
585 * application that allows you to upload a picture to a web site. The upload
586 * may take a long time, and the application should allow the user to leave
587 * the application will it is executing. To accomplish this, your Activity
588 * should start a {@link Service} in which the upload takes place. This allows
589 * the system to properly prioritize your process (considering it to be more
590 * important than other non-visible applications) for the duration of the
591 * upload, independent of whether the original activity is paused, stopped,
592 * or finished.
593 */
594public class Activity extends ContextThemeWrapper
595 implements LayoutInflater.Factory,
596 Window.Callback, KeyEvent.Callback,
597 OnCreateContextMenuListener, ComponentCallbacks {
598 private static final String TAG = "Activity";
599
600 /** Standard activity result: operation canceled. */
601 public static final int RESULT_CANCELED = 0;
602 /** Standard activity result: operation succeeded. */
603 public static final int RESULT_OK = -1;
604 /** Start of user-defined activity results. */
605 public static final int RESULT_FIRST_USER = 1;
606
607 private static long sInstanceCount = 0;
608
609 private static final String WINDOW_HIERARCHY_TAG = "android:viewHierarchyState";
610 private static final String SAVED_DIALOG_IDS_KEY = "android:savedDialogIds";
611 private static final String SAVED_DIALOGS_TAG = "android:savedDialogs";
612 private static final String SAVED_DIALOG_KEY_PREFIX = "android:dialog_";
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800613 private static final String SAVED_DIALOG_ARGS_KEY_PREFIX = "android:dialog_args_";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800614
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800615 private static class ManagedDialog {
616 Dialog mDialog;
617 Bundle mArgs;
618 }
619 private SparseArray<ManagedDialog> mManagedDialogs;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800620
621 // set by the thread after the constructor and before onCreate(Bundle savedInstanceState) is called.
622 private Instrumentation mInstrumentation;
623 private IBinder mToken;
Dianne Hackbornb06ea702009-07-13 13:07:51 -0700624 private int mIdent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800625 /*package*/ String mEmbeddedID;
626 private Application mApplication;
Christopher Tateb70f3df2009-04-07 16:07:59 -0700627 /*package*/ Intent mIntent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800628 private ComponentName mComponent;
629 /*package*/ ActivityInfo mActivityInfo;
630 /*package*/ ActivityThread mMainThread;
631 /*package*/ Object mLastNonConfigurationInstance;
632 /*package*/ HashMap<String,Object> mLastNonConfigurationChildInstances;
633 Activity mParent;
634 boolean mCalled;
635 private boolean mResumed;
636 private boolean mStopped;
637 boolean mFinished;
638 boolean mStartedActivity;
639 /*package*/ int mConfigChangeFlags;
640 /*package*/ Configuration mCurrentConfig;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +0100641 private SearchManager mSearchManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800642
643 private Window mWindow;
644
645 private WindowManager mWindowManager;
646 /*package*/ View mDecor = null;
647 /*package*/ boolean mWindowAdded = false;
648 /*package*/ boolean mVisibleFromServer = false;
649 /*package*/ boolean mVisibleFromClient = true;
650
651 private CharSequence mTitle;
652 private int mTitleColor = 0;
653
654 private static final class ManagedCursor {
655 ManagedCursor(Cursor cursor) {
656 mCursor = cursor;
657 mReleased = false;
658 mUpdated = false;
659 }
660
661 private final Cursor mCursor;
662 private boolean mReleased;
663 private boolean mUpdated;
664 }
665 private final ArrayList<ManagedCursor> mManagedCursors =
666 new ArrayList<ManagedCursor>();
667
668 // protected by synchronized (this)
669 int mResultCode = RESULT_CANCELED;
670 Intent mResultData = null;
671
672 private boolean mTitleReady = false;
673
674 private int mDefaultKeyMode = DEFAULT_KEYS_DISABLE;
675 private SpannableStringBuilder mDefaultKeySsb = null;
676
677 protected static final int[] FOCUSED_STATE_SET = {com.android.internal.R.attr.state_focused};
678
679 private Thread mUiThread;
680 private final Handler mHandler = new Handler();
681
Carl Shapiro82fe5642010-02-24 00:14:23 -0800682 // Used for debug only
683 /*
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800684 public Activity() {
685 ++sInstanceCount;
686 }
687
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800688 @Override
689 protected void finalize() throws Throwable {
690 super.finalize();
691 --sInstanceCount;
692 }
Carl Shapiro82fe5642010-02-24 00:14:23 -0800693 */
694
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800695 public static long getInstanceCount() {
696 return sInstanceCount;
697 }
698
699 /** Return the intent that started this activity. */
700 public Intent getIntent() {
701 return mIntent;
702 }
703
704 /**
705 * Change the intent returned by {@link #getIntent}. This holds a
706 * reference to the given intent; it does not copy it. Often used in
707 * conjunction with {@link #onNewIntent}.
708 *
709 * @param newIntent The new Intent object to return from getIntent
710 *
711 * @see #getIntent
712 * @see #onNewIntent
713 */
714 public void setIntent(Intent newIntent) {
715 mIntent = newIntent;
716 }
717
718 /** Return the application that owns this activity. */
719 public final Application getApplication() {
720 return mApplication;
721 }
722
723 /** Is this activity embedded inside of another activity? */
724 public final boolean isChild() {
725 return mParent != null;
726 }
727
728 /** Return the parent activity if this view is an embedded child. */
729 public final Activity getParent() {
730 return mParent;
731 }
732
733 /** Retrieve the window manager for showing custom windows. */
734 public WindowManager getWindowManager() {
735 return mWindowManager;
736 }
737
738 /**
739 * Retrieve the current {@link android.view.Window} for the activity.
740 * This can be used to directly access parts of the Window API that
741 * are not available through Activity/Screen.
742 *
743 * @return Window The current window, or null if the activity is not
744 * visual.
745 */
746 public Window getWindow() {
747 return mWindow;
748 }
749
750 /**
751 * Calls {@link android.view.Window#getCurrentFocus} on the
752 * Window of this Activity to return the currently focused view.
753 *
754 * @return View The current View with focus or null.
755 *
756 * @see #getWindow
757 * @see android.view.Window#getCurrentFocus
758 */
759 public View getCurrentFocus() {
760 return mWindow != null ? mWindow.getCurrentFocus() : null;
761 }
762
763 @Override
764 public int getWallpaperDesiredMinimumWidth() {
765 int width = super.getWallpaperDesiredMinimumWidth();
766 return width <= 0 ? getWindowManager().getDefaultDisplay().getWidth() : width;
767 }
768
769 @Override
770 public int getWallpaperDesiredMinimumHeight() {
771 int height = super.getWallpaperDesiredMinimumHeight();
772 return height <= 0 ? getWindowManager().getDefaultDisplay().getHeight() : height;
773 }
774
775 /**
776 * Called when the activity is starting. This is where most initialization
777 * should go: calling {@link #setContentView(int)} to inflate the
778 * activity's UI, using {@link #findViewById} to programmatically interact
779 * with widgets in the UI, calling
780 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)} to retrieve
781 * cursors for data being displayed, etc.
782 *
783 * <p>You can call {@link #finish} from within this function, in
784 * which case onDestroy() will be immediately called without any of the rest
785 * of the activity lifecycle ({@link #onStart}, {@link #onResume},
786 * {@link #onPause}, etc) executing.
787 *
788 * <p><em>Derived classes must call through to the super class's
789 * implementation of this method. If they do not, an exception will be
790 * thrown.</em></p>
791 *
792 * @param savedInstanceState If the activity is being re-initialized after
793 * previously being shut down then this Bundle contains the data it most
794 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
795 *
796 * @see #onStart
797 * @see #onSaveInstanceState
798 * @see #onRestoreInstanceState
799 * @see #onPostCreate
800 */
801 protected void onCreate(Bundle savedInstanceState) {
Dianne Hackbornbfe319e2009-09-21 00:34:05 -0700802 mVisibleFromClient = !mWindow.getWindowStyle().getBoolean(
803 com.android.internal.R.styleable.Window_windowNoDisplay, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800804 mCalled = true;
805 }
806
807 /**
808 * The hook for {@link ActivityThread} to restore the state of this activity.
809 *
810 * Calls {@link #onSaveInstanceState(android.os.Bundle)} and
811 * {@link #restoreManagedDialogs(android.os.Bundle)}.
812 *
813 * @param savedInstanceState contains the saved state
814 */
815 final void performRestoreInstanceState(Bundle savedInstanceState) {
816 onRestoreInstanceState(savedInstanceState);
817 restoreManagedDialogs(savedInstanceState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800818 }
819
820 /**
821 * This method is called after {@link #onStart} when the activity is
822 * being re-initialized from a previously saved state, given here in
Mike LeBeau305de9d2010-03-11 09:21:08 -0800823 * <var>savedInstanceState</var>. Most implementations will simply use {@link #onCreate}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800824 * to restore their state, but it is sometimes convenient to do it here
825 * after all of the initialization has been done or to allow subclasses to
826 * decide whether to use your default implementation. The default
827 * implementation of this method performs a restore of any view state that
828 * had previously been frozen by {@link #onSaveInstanceState}.
829 *
830 * <p>This method is called between {@link #onStart} and
831 * {@link #onPostCreate}.
832 *
833 * @param savedInstanceState the data most recently supplied in {@link #onSaveInstanceState}.
834 *
835 * @see #onCreate
836 * @see #onPostCreate
837 * @see #onResume
838 * @see #onSaveInstanceState
839 */
840 protected void onRestoreInstanceState(Bundle savedInstanceState) {
841 if (mWindow != null) {
842 Bundle windowState = savedInstanceState.getBundle(WINDOW_HIERARCHY_TAG);
843 if (windowState != null) {
844 mWindow.restoreHierarchyState(windowState);
845 }
846 }
847 }
848
849 /**
850 * Restore the state of any saved managed dialogs.
851 *
852 * @param savedInstanceState The bundle to restore from.
853 */
854 private void restoreManagedDialogs(Bundle savedInstanceState) {
855 final Bundle b = savedInstanceState.getBundle(SAVED_DIALOGS_TAG);
856 if (b == null) {
857 return;
858 }
859
860 final int[] ids = b.getIntArray(SAVED_DIALOG_IDS_KEY);
861 final int numDialogs = ids.length;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800862 mManagedDialogs = new SparseArray<ManagedDialog>(numDialogs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800863 for (int i = 0; i < numDialogs; i++) {
864 final Integer dialogId = ids[i];
865 Bundle dialogState = b.getBundle(savedDialogKeyFor(dialogId));
866 if (dialogState != null) {
Romain Guye35c2352009-06-19 13:18:12 -0700867 // Calling onRestoreInstanceState() below will invoke dispatchOnCreate
868 // so tell createDialog() not to do it, otherwise we get an exception
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800869 final ManagedDialog md = new ManagedDialog();
870 md.mArgs = b.getBundle(savedDialogArgsKeyFor(dialogId));
871 md.mDialog = createDialog(dialogId, dialogState, md.mArgs);
872 if (md.mDialog != null) {
873 mManagedDialogs.put(dialogId, md);
874 onPrepareDialog(dialogId, md.mDialog, md.mArgs);
875 md.mDialog.onRestoreInstanceState(dialogState);
876 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800877 }
878 }
879 }
880
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800881 private Dialog createDialog(Integer dialogId, Bundle state, Bundle args) {
882 final Dialog dialog = onCreateDialog(dialogId, args);
Romain Guy764d5332009-06-17 16:52:22 -0700883 if (dialog == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800884 return null;
Romain Guy764d5332009-06-17 16:52:22 -0700885 }
Romain Guy6de4aed2009-07-08 10:54:45 -0700886 dialog.dispatchOnCreate(state);
Romain Guy764d5332009-06-17 16:52:22 -0700887 return dialog;
888 }
889
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800890 private static String savedDialogKeyFor(int key) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800891 return SAVED_DIALOG_KEY_PREFIX + key;
892 }
893
Dianne Hackborn8ea138c2010-01-26 18:01:04 -0800894 private static String savedDialogArgsKeyFor(int key) {
895 return SAVED_DIALOG_ARGS_KEY_PREFIX + key;
896 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800897
898 /**
899 * Called when activity start-up is complete (after {@link #onStart}
900 * and {@link #onRestoreInstanceState} have been called). Applications will
901 * generally not implement this method; it is intended for system
902 * classes to do final initialization after application code has run.
903 *
904 * <p><em>Derived classes must call through to the super class's
905 * implementation of this method. If they do not, an exception will be
906 * thrown.</em></p>
907 *
908 * @param savedInstanceState If the activity is being re-initialized after
909 * previously being shut down then this Bundle contains the data it most
910 * recently supplied in {@link #onSaveInstanceState}. <b><i>Note: Otherwise it is null.</i></b>
911 * @see #onCreate
912 */
913 protected void onPostCreate(Bundle savedInstanceState) {
914 if (!isChild()) {
915 mTitleReady = true;
916 onTitleChanged(getTitle(), getTitleColor());
917 }
918 mCalled = true;
919 }
920
921 /**
922 * Called after {@link #onCreate} &mdash; or after {@link #onRestart} when
923 * the activity had been stopped, but is now again being displayed to the
924 * user. It will be followed by {@link #onResume}.
925 *
926 * <p><em>Derived classes must call through to the super class's
927 * implementation of this method. If they do not, an exception will be
928 * thrown.</em></p>
929 *
930 * @see #onCreate
931 * @see #onStop
932 * @see #onResume
933 */
934 protected void onStart() {
935 mCalled = true;
936 }
937
938 /**
939 * Called after {@link #onStop} when the current activity is being
940 * re-displayed to the user (the user has navigated back to it). It will
941 * be followed by {@link #onStart} and then {@link #onResume}.
942 *
943 * <p>For activities that are using raw {@link Cursor} objects (instead of
944 * creating them through
945 * {@link #managedQuery(android.net.Uri , String[], String, String[], String)},
946 * this is usually the place
947 * where the cursor should be requeried (because you had deactivated it in
948 * {@link #onStop}.
949 *
950 * <p><em>Derived classes must call through to the super class's
951 * implementation of this method. If they do not, an exception will be
952 * thrown.</em></p>
953 *
954 * @see #onStop
955 * @see #onStart
956 * @see #onResume
957 */
958 protected void onRestart() {
959 mCalled = true;
960 }
961
962 /**
963 * Called after {@link #onRestoreInstanceState}, {@link #onRestart}, or
964 * {@link #onPause}, for your activity to start interacting with the user.
965 * This is a good place to begin animations, open exclusive-access devices
966 * (such as the camera), etc.
967 *
968 * <p>Keep in mind that onResume is not the best indicator that your activity
969 * is visible to the user; a system window such as the keyguard may be in
970 * front. Use {@link #onWindowFocusChanged} to know for certain that your
971 * activity is visible to the user (for example, to resume a game).
972 *
973 * <p><em>Derived classes must call through to the super class's
974 * implementation of this method. If they do not, an exception will be
975 * thrown.</em></p>
976 *
977 * @see #onRestoreInstanceState
978 * @see #onRestart
979 * @see #onPostResume
980 * @see #onPause
981 */
982 protected void onResume() {
983 mCalled = true;
984 }
985
986 /**
987 * Called when activity resume is complete (after {@link #onResume} has
988 * been called). Applications will generally not implement this method;
989 * it is intended for system classes to do final setup after application
990 * resume code has run.
991 *
992 * <p><em>Derived classes must call through to the super class's
993 * implementation of this method. If they do not, an exception will be
994 * thrown.</em></p>
995 *
996 * @see #onResume
997 */
998 protected void onPostResume() {
999 final Window win = getWindow();
1000 if (win != null) win.makeActive();
1001 mCalled = true;
1002 }
1003
1004 /**
1005 * This is called for activities that set launchMode to "singleTop" in
1006 * their package, or if a client used the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP}
1007 * flag when calling {@link #startActivity}. In either case, when the
1008 * activity is re-launched while at the top of the activity stack instead
1009 * of a new instance of the activity being started, onNewIntent() will be
1010 * called on the existing instance with the Intent that was used to
1011 * re-launch it.
1012 *
1013 * <p>An activity will always be paused before receiving a new intent, so
1014 * you can count on {@link #onResume} being called after this method.
1015 *
1016 * <p>Note that {@link #getIntent} still returns the original Intent. You
1017 * can use {@link #setIntent} to update it to this new Intent.
1018 *
1019 * @param intent The new intent that was started for the activity.
1020 *
1021 * @see #getIntent
1022 * @see #setIntent
1023 * @see #onResume
1024 */
1025 protected void onNewIntent(Intent intent) {
1026 }
1027
1028 /**
1029 * The hook for {@link ActivityThread} to save the state of this activity.
1030 *
1031 * Calls {@link #onSaveInstanceState(android.os.Bundle)}
1032 * and {@link #saveManagedDialogs(android.os.Bundle)}.
1033 *
1034 * @param outState The bundle to save the state to.
1035 */
1036 final void performSaveInstanceState(Bundle outState) {
1037 onSaveInstanceState(outState);
1038 saveManagedDialogs(outState);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001039 }
1040
1041 /**
1042 * Called to retrieve per-instance state from an activity before being killed
1043 * so that the state can be restored in {@link #onCreate} or
1044 * {@link #onRestoreInstanceState} (the {@link Bundle} populated by this method
1045 * will be passed to both).
1046 *
1047 * <p>This method is called before an activity may be killed so that when it
1048 * comes back some time in the future it can restore its state. For example,
1049 * if activity B is launched in front of activity A, and at some point activity
1050 * A is killed to reclaim resources, activity A will have a chance to save the
1051 * current state of its user interface via this method so that when the user
1052 * returns to activity A, the state of the user interface can be restored
1053 * via {@link #onCreate} or {@link #onRestoreInstanceState}.
1054 *
1055 * <p>Do not confuse this method with activity lifecycle callbacks such as
1056 * {@link #onPause}, which is always called when an activity is being placed
1057 * in the background or on its way to destruction, or {@link #onStop} which
1058 * is called before destruction. One example of when {@link #onPause} and
1059 * {@link #onStop} is called and not this method is when a user navigates back
1060 * from activity B to activity A: there is no need to call {@link #onSaveInstanceState}
1061 * on B because that particular instance will never be restored, so the
1062 * system avoids calling it. An example when {@link #onPause} is called and
1063 * not {@link #onSaveInstanceState} is when activity B is launched in front of activity A:
1064 * the system may avoid calling {@link #onSaveInstanceState} on activity A if it isn't
1065 * killed during the lifetime of B since the state of the user interface of
1066 * A will stay intact.
1067 *
1068 * <p>The default implementation takes care of most of the UI per-instance
1069 * state for you by calling {@link android.view.View#onSaveInstanceState()} on each
1070 * view in the hierarchy that has an id, and by saving the id of the currently
1071 * focused view (all of which is restored by the default implementation of
1072 * {@link #onRestoreInstanceState}). If you override this method to save additional
1073 * information not captured by each individual view, you will likely want to
1074 * call through to the default implementation, otherwise be prepared to save
1075 * all of the state of each view yourself.
1076 *
1077 * <p>If called, this method will occur before {@link #onStop}. There are
1078 * no guarantees about whether it will occur before or after {@link #onPause}.
1079 *
1080 * @param outState Bundle in which to place your saved state.
1081 *
1082 * @see #onCreate
1083 * @see #onRestoreInstanceState
1084 * @see #onPause
1085 */
1086 protected void onSaveInstanceState(Bundle outState) {
1087 outState.putBundle(WINDOW_HIERARCHY_TAG, mWindow.saveHierarchyState());
1088 }
1089
1090 /**
1091 * Save the state of any managed dialogs.
1092 *
1093 * @param outState place to store the saved state.
1094 */
1095 private void saveManagedDialogs(Bundle outState) {
1096 if (mManagedDialogs == null) {
1097 return;
1098 }
1099
1100 final int numDialogs = mManagedDialogs.size();
1101 if (numDialogs == 0) {
1102 return;
1103 }
1104
1105 Bundle dialogState = new Bundle();
1106
1107 int[] ids = new int[mManagedDialogs.size()];
1108
1109 // save each dialog's bundle, gather the ids
1110 for (int i = 0; i < numDialogs; i++) {
1111 final int key = mManagedDialogs.keyAt(i);
1112 ids[i] = key;
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001113 final ManagedDialog md = mManagedDialogs.valueAt(i);
1114 dialogState.putBundle(savedDialogKeyFor(key), md.mDialog.onSaveInstanceState());
1115 if (md.mArgs != null) {
1116 dialogState.putBundle(savedDialogArgsKeyFor(key), md.mArgs);
1117 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001118 }
1119
1120 dialogState.putIntArray(SAVED_DIALOG_IDS_KEY, ids);
1121 outState.putBundle(SAVED_DIALOGS_TAG, dialogState);
1122 }
1123
1124
1125 /**
1126 * Called as part of the activity lifecycle when an activity is going into
1127 * the background, but has not (yet) been killed. The counterpart to
1128 * {@link #onResume}.
1129 *
1130 * <p>When activity B is launched in front of activity A, this callback will
1131 * be invoked on A. B will not be created until A's {@link #onPause} returns,
1132 * so be sure to not do anything lengthy here.
1133 *
1134 * <p>This callback is mostly used for saving any persistent state the
1135 * activity is editing, to present a "edit in place" model to the user and
1136 * making sure nothing is lost if there are not enough resources to start
1137 * the new activity without first killing this one. This is also a good
1138 * place to do things like stop animations and other things that consume a
1139 * noticeable mount of CPU in order to make the switch to the next activity
1140 * as fast as possible, or to close resources that are exclusive access
1141 * such as the camera.
1142 *
1143 * <p>In situations where the system needs more memory it may kill paused
1144 * processes to reclaim resources. Because of this, you should be sure
1145 * that all of your state is saved by the time you return from
1146 * this function. In general {@link #onSaveInstanceState} is used to save
1147 * per-instance state in the activity and this method is used to store
1148 * global persistent data (in content providers, files, etc.)
1149 *
1150 * <p>After receiving this call you will usually receive a following call
1151 * to {@link #onStop} (after the next activity has been resumed and
1152 * displayed), however in some cases there will be a direct call back to
1153 * {@link #onResume} without going through the stopped state.
1154 *
1155 * <p><em>Derived classes must call through to the super class's
1156 * implementation of this method. If they do not, an exception will be
1157 * thrown.</em></p>
1158 *
1159 * @see #onResume
1160 * @see #onSaveInstanceState
1161 * @see #onStop
1162 */
1163 protected void onPause() {
1164 mCalled = true;
Brad Fitzpatrick333b8cb2010-08-26 12:04:57 -07001165 QueuedWork.waitToFinish();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001166 }
1167
1168 /**
1169 * Called as part of the activity lifecycle when an activity is about to go
1170 * into the background as the result of user choice. For example, when the
1171 * user presses the Home key, {@link #onUserLeaveHint} will be called, but
1172 * when an incoming phone call causes the in-call Activity to be automatically
1173 * brought to the foreground, {@link #onUserLeaveHint} will not be called on
1174 * the activity being interrupted. In cases when it is invoked, this method
1175 * is called right before the activity's {@link #onPause} callback.
1176 *
1177 * <p>This callback and {@link #onUserInteraction} are intended to help
1178 * activities manage status bar notifications intelligently; specifically,
1179 * for helping activities determine the proper time to cancel a notfication.
1180 *
1181 * @see #onUserInteraction()
1182 */
1183 protected void onUserLeaveHint() {
1184 }
1185
1186 /**
1187 * Generate a new thumbnail for this activity. This method is called before
1188 * pausing the activity, and should draw into <var>outBitmap</var> the
1189 * imagery for the desired thumbnail in the dimensions of that bitmap. It
1190 * can use the given <var>canvas</var>, which is configured to draw into the
1191 * bitmap, for rendering if desired.
1192 *
1193 * <p>The default implementation renders the Screen's current view
1194 * hierarchy into the canvas to generate a thumbnail.
1195 *
1196 * <p>If you return false, the bitmap will be filled with a default
1197 * thumbnail.
1198 *
1199 * @param outBitmap The bitmap to contain the thumbnail.
1200 * @param canvas Can be used to render into the bitmap.
1201 *
1202 * @return Return true if you have drawn into the bitmap; otherwise after
1203 * you return it will be filled with a default thumbnail.
1204 *
1205 * @see #onCreateDescription
1206 * @see #onSaveInstanceState
1207 * @see #onPause
1208 */
1209 public boolean onCreateThumbnail(Bitmap outBitmap, Canvas canvas) {
Jim Miller0b2a6d02010-07-13 18:01:29 -07001210 if (mDecor == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001211 return false;
1212 }
1213
Jim Miller0b2a6d02010-07-13 18:01:29 -07001214 int paddingLeft = 0;
1215 int paddingRight = 0;
1216 int paddingTop = 0;
1217 int paddingBottom = 0;
1218
1219 // Find System window and use padding so we ignore space reserved for decorations
1220 // like the status bar and such.
1221 final FrameLayout top = (FrameLayout) mDecor;
1222 for (int i = 0; i < top.getChildCount(); i++) {
1223 View child = top.getChildAt(i);
1224 if (child.isFitsSystemWindowsFlagSet()) {
1225 paddingLeft = child.getPaddingLeft();
1226 paddingRight = child.getPaddingRight();
1227 paddingTop = child.getPaddingTop();
1228 paddingBottom = child.getPaddingBottom();
1229 break;
1230 }
1231 }
1232
1233 final int visibleWidth = mDecor.getWidth() - paddingLeft - paddingRight;
1234 final int visibleHeight = mDecor.getHeight() - paddingTop - paddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001235
1236 canvas.save();
Jim Miller0b2a6d02010-07-13 18:01:29 -07001237 canvas.scale( (float) outBitmap.getWidth() / visibleWidth,
1238 (float) outBitmap.getHeight() / visibleHeight);
1239 canvas.translate(-paddingLeft, -paddingTop);
1240 mDecor.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001241 canvas.restore();
1242
1243 return true;
1244 }
1245
1246 /**
1247 * Generate a new description for this activity. This method is called
1248 * before pausing the activity and can, if desired, return some textual
1249 * description of its current state to be displayed to the user.
1250 *
1251 * <p>The default implementation returns null, which will cause you to
1252 * inherit the description from the previous activity. If all activities
1253 * return null, generally the label of the top activity will be used as the
1254 * description.
1255 *
1256 * @return A description of what the user is doing. It should be short and
1257 * sweet (only a few words).
1258 *
1259 * @see #onCreateThumbnail
1260 * @see #onSaveInstanceState
1261 * @see #onPause
1262 */
1263 public CharSequence onCreateDescription() {
1264 return null;
1265 }
1266
1267 /**
1268 * Called when you are no longer visible to the user. You will next
1269 * receive either {@link #onRestart}, {@link #onDestroy}, or nothing,
1270 * depending on later user activity.
1271 *
1272 * <p>Note that this method may never be called, in low memory situations
1273 * where the system does not have enough memory to keep your activity's
1274 * process running after its {@link #onPause} method is called.
1275 *
1276 * <p><em>Derived classes must call through to the super class's
1277 * implementation of this method. If they do not, an exception will be
1278 * thrown.</em></p>
1279 *
1280 * @see #onRestart
1281 * @see #onResume
1282 * @see #onSaveInstanceState
1283 * @see #onDestroy
1284 */
1285 protected void onStop() {
1286 mCalled = true;
1287 }
1288
1289 /**
1290 * Perform any final cleanup before an activity is destroyed. This can
1291 * happen either because the activity is finishing (someone called
1292 * {@link #finish} on it, or because the system is temporarily destroying
1293 * this instance of the activity to save space. You can distinguish
1294 * between these two scenarios with the {@link #isFinishing} method.
1295 *
1296 * <p><em>Note: do not count on this method being called as a place for
1297 * saving data! For example, if an activity is editing data in a content
1298 * provider, those edits should be committed in either {@link #onPause} or
1299 * {@link #onSaveInstanceState}, not here.</em> This method is usually implemented to
1300 * free resources like threads that are associated with an activity, so
1301 * that a destroyed activity does not leave such things around while the
1302 * rest of its application is still running. There are situations where
1303 * the system will simply kill the activity's hosting process without
1304 * calling this method (or any others) in it, so it should not be used to
1305 * do things that are intended to remain around after the process goes
1306 * away.
1307 *
1308 * <p><em>Derived classes must call through to the super class's
1309 * implementation of this method. If they do not, an exception will be
1310 * thrown.</em></p>
1311 *
1312 * @see #onPause
1313 * @see #onStop
1314 * @see #finish
1315 * @see #isFinishing
1316 */
1317 protected void onDestroy() {
1318 mCalled = true;
1319
1320 // dismiss any dialogs we are managing.
1321 if (mManagedDialogs != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001322 final int numDialogs = mManagedDialogs.size();
1323 for (int i = 0; i < numDialogs; i++) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001324 final ManagedDialog md = mManagedDialogs.valueAt(i);
1325 if (md.mDialog.isShowing()) {
1326 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001327 }
1328 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08001329 mManagedDialogs = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001330 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001331
1332 // close any cursors we are managing.
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001333 synchronized (mManagedCursors) {
1334 int numCursors = mManagedCursors.size();
1335 for (int i = 0; i < numCursors; i++) {
1336 ManagedCursor c = mManagedCursors.get(i);
1337 if (c != null) {
1338 c.mCursor.close();
1339 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001340 }
Makoto Onuki2f6a0182010-02-22 13:26:59 -08001341 mManagedCursors.clear();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001342 }
Amith Yamasani49860442010-03-17 20:54:10 -07001343
1344 // Close any open search dialog
1345 if (mSearchManager != null) {
1346 mSearchManager.stopSearch();
1347 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001348 }
1349
1350 /**
1351 * Called by the system when the device configuration changes while your
1352 * activity is running. Note that this will <em>only</em> be called if
1353 * you have selected configurations you would like to handle with the
1354 * {@link android.R.attr#configChanges} attribute in your manifest. If
1355 * any configuration change occurs that is not selected to be reported
1356 * by that attribute, then instead of reporting it the system will stop
1357 * and restart the activity (to have it launched with the new
1358 * configuration).
1359 *
1360 * <p>At the time that this function has been called, your Resources
1361 * object will have been updated to return resource values matching the
1362 * new configuration.
1363 *
1364 * @param newConfig The new device configuration.
1365 */
1366 public void onConfigurationChanged(Configuration newConfig) {
1367 mCalled = true;
Bjorn Bringert444c7272009-07-06 21:32:50 +01001368
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001369 if (mWindow != null) {
1370 // Pass the configuration changed event to the window
1371 mWindow.onConfigurationChanged(newConfig);
1372 }
1373 }
1374
1375 /**
1376 * If this activity is being destroyed because it can not handle a
1377 * configuration parameter being changed (and thus its
1378 * {@link #onConfigurationChanged(Configuration)} method is
1379 * <em>not</em> being called), then you can use this method to discover
1380 * the set of changes that have occurred while in the process of being
1381 * destroyed. Note that there is no guarantee that these will be
1382 * accurate (other changes could have happened at any time), so you should
1383 * only use this as an optimization hint.
1384 *
1385 * @return Returns a bit field of the configuration parameters that are
1386 * changing, as defined by the {@link android.content.res.Configuration}
1387 * class.
1388 */
1389 public int getChangingConfigurations() {
1390 return mConfigChangeFlags;
1391 }
1392
1393 /**
1394 * Retrieve the non-configuration instance data that was previously
1395 * returned by {@link #onRetainNonConfigurationInstance()}. This will
1396 * be available from the initial {@link #onCreate} and
1397 * {@link #onStart} calls to the new instance, allowing you to extract
1398 * any useful dynamic state from the previous instance.
1399 *
1400 * <p>Note that the data you retrieve here should <em>only</em> be used
1401 * as an optimization for handling configuration changes. You should always
1402 * be able to handle getting a null pointer back, and an activity must
1403 * still be able to restore itself to its previous state (through the
1404 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1405 * function returns null.
1406 *
1407 * @return Returns the object previously returned by
1408 * {@link #onRetainNonConfigurationInstance()}.
1409 */
1410 public Object getLastNonConfigurationInstance() {
1411 return mLastNonConfigurationInstance;
1412 }
1413
1414 /**
1415 * Called by the system, as part of destroying an
1416 * activity due to a configuration change, when it is known that a new
1417 * instance will immediately be created for the new configuration. You
1418 * can return any object you like here, including the activity instance
1419 * itself, which can later be retrieved by calling
1420 * {@link #getLastNonConfigurationInstance()} in the new activity
1421 * instance.
1422 *
1423 * <p>This function is called purely as an optimization, and you must
1424 * not rely on it being called. When it is called, a number of guarantees
1425 * will be made to help optimize configuration switching:
1426 * <ul>
1427 * <li> The function will be called between {@link #onStop} and
1428 * {@link #onDestroy}.
1429 * <li> A new instance of the activity will <em>always</em> be immediately
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001430 * created after this one's {@link #onDestroy()} is called. In particular,
1431 * <em>no</em> messages will be dispatched during this time (when the returned
1432 * object does not have an activity to be associated with).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001433 * <li> The object you return here will <em>always</em> be available from
1434 * the {@link #getLastNonConfigurationInstance()} method of the following
1435 * activity instance as described there.
1436 * </ul>
1437 *
1438 * <p>These guarantees are designed so that an activity can use this API
1439 * to propagate extensive state from the old to new activity instance, from
1440 * loaded bitmaps, to network connections, to evenly actively running
1441 * threads. Note that you should <em>not</em> propagate any data that
1442 * may change based on the configuration, including any data loaded from
1443 * resources such as strings, layouts, or drawables.
1444 *
Dianne Hackbornce2ef762010-09-20 11:39:14 -07001445 * <p>The guarantee of no message handling during the switch to the next
1446 * activity simplifies use with active objects. For example if your retained
1447 * state is an {@link android.os.AsyncTask} you are guaranteed that its
1448 * call back functions (like {@link android.os.AsyncTask#onPostExecute}) will
1449 * not be called from the call here until you execute the next instance's
1450 * {@link #onCreate(Bundle)}. (Note however that there is of course no such
1451 * guarantee for {@link android.os.AsyncTask#doInBackground} since that is
1452 * running in a separate thread.)
1453 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001454 * @return Return any Object holding the desired state to propagate to the
1455 * next activity instance.
1456 */
1457 public Object onRetainNonConfigurationInstance() {
1458 return null;
1459 }
1460
1461 /**
1462 * Retrieve the non-configuration instance data that was previously
1463 * returned by {@link #onRetainNonConfigurationChildInstances()}. This will
1464 * be available from the initial {@link #onCreate} and
1465 * {@link #onStart} calls to the new instance, allowing you to extract
1466 * any useful dynamic state from the previous instance.
1467 *
1468 * <p>Note that the data you retrieve here should <em>only</em> be used
1469 * as an optimization for handling configuration changes. You should always
1470 * be able to handle getting a null pointer back, and an activity must
1471 * still be able to restore itself to its previous state (through the
1472 * normal {@link #onSaveInstanceState(Bundle)} mechanism) even if this
1473 * function returns null.
1474 *
1475 * @return Returns the object previously returned by
1476 * {@link #onRetainNonConfigurationChildInstances()}
1477 */
1478 HashMap<String,Object> getLastNonConfigurationChildInstances() {
1479 return mLastNonConfigurationChildInstances;
1480 }
1481
1482 /**
1483 * This method is similar to {@link #onRetainNonConfigurationInstance()} except that
1484 * it should return either a mapping from child activity id strings to arbitrary objects,
1485 * or null. This method is intended to be used by Activity framework subclasses that control a
1486 * set of child activities, such as ActivityGroup. The same guarantees and restrictions apply
1487 * as for {@link #onRetainNonConfigurationInstance()}. The default implementation returns null.
1488 */
1489 HashMap<String,Object> onRetainNonConfigurationChildInstances() {
1490 return null;
1491 }
1492
1493 public void onLowMemory() {
1494 mCalled = true;
1495 }
1496
1497 /**
1498 * Wrapper around
1499 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1500 * that gives the resulting {@link Cursor} to call
1501 * {@link #startManagingCursor} so that the activity will manage its
1502 * lifecycle for you.
1503 *
1504 * @param uri The URI of the content provider to query.
1505 * @param projection List of columns to return.
1506 * @param selection SQL WHERE clause.
1507 * @param sortOrder SQL ORDER BY clause.
1508 *
1509 * @return The Cursor that was returned by query().
1510 *
1511 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1512 * @see #startManagingCursor
1513 * @hide
1514 */
1515 public final Cursor managedQuery(Uri uri,
1516 String[] projection,
1517 String selection,
1518 String sortOrder)
1519 {
1520 Cursor c = getContentResolver().query(uri, projection, selection, null, sortOrder);
1521 if (c != null) {
1522 startManagingCursor(c);
1523 }
1524 return c;
1525 }
1526
1527 /**
1528 * Wrapper around
1529 * {@link ContentResolver#query(android.net.Uri , String[], String, String[], String)}
1530 * that gives the resulting {@link Cursor} to call
1531 * {@link #startManagingCursor} so that the activity will manage its
1532 * lifecycle for you.
1533 *
1534 * @param uri The URI of the content provider to query.
1535 * @param projection List of columns to return.
1536 * @param selection SQL WHERE clause.
1537 * @param selectionArgs The arguments to selection, if any ?s are pesent
1538 * @param sortOrder SQL ORDER BY clause.
1539 *
1540 * @return The Cursor that was returned by query().
1541 *
1542 * @see ContentResolver#query(android.net.Uri , String[], String, String[], String)
1543 * @see #startManagingCursor
1544 */
1545 public final Cursor managedQuery(Uri uri,
1546 String[] projection,
1547 String selection,
1548 String[] selectionArgs,
1549 String sortOrder)
1550 {
1551 Cursor c = getContentResolver().query(uri, projection, selection, selectionArgs, sortOrder);
1552 if (c != null) {
1553 startManagingCursor(c);
1554 }
1555 return c;
1556 }
1557
1558 /**
1559 * Wrapper around {@link Cursor#commitUpdates()} that takes care of noting
1560 * that the Cursor needs to be requeried. You can call this method in
1561 * {@link #onPause} or {@link #onStop} to have the system call
1562 * {@link Cursor#requery} for you if the activity is later resumed. This
1563 * allows you to avoid determing when to do the requery yourself (which is
1564 * required for the Cursor to see any data changes that were committed with
1565 * it).
1566 *
1567 * @param c The Cursor whose changes are to be committed.
1568 *
1569 * @see #managedQuery(android.net.Uri , String[], String, String[], String)
1570 * @see #startManagingCursor
1571 * @see Cursor#commitUpdates()
1572 * @see Cursor#requery
1573 * @hide
1574 */
1575 @Deprecated
1576 public void managedCommitUpdates(Cursor c) {
1577 synchronized (mManagedCursors) {
1578 final int N = mManagedCursors.size();
1579 for (int i=0; i<N; i++) {
1580 ManagedCursor mc = mManagedCursors.get(i);
1581 if (mc.mCursor == c) {
1582 c.commitUpdates();
1583 mc.mUpdated = true;
1584 return;
1585 }
1586 }
1587 throw new RuntimeException(
1588 "Cursor " + c + " is not currently managed");
1589 }
1590 }
1591
1592 /**
1593 * This method allows the activity to take care of managing the given
1594 * {@link Cursor}'s lifecycle for you based on the activity's lifecycle.
1595 * That is, when the activity is stopped it will automatically call
1596 * {@link Cursor#deactivate} on the given Cursor, and when it is later restarted
1597 * it will call {@link Cursor#requery} for you. When the activity is
1598 * destroyed, all managed Cursors will be closed automatically.
1599 *
1600 * @param c The Cursor to be managed.
1601 *
1602 * @see #managedQuery(android.net.Uri , String[], String, String[], String)
1603 * @see #stopManagingCursor
1604 */
1605 public void startManagingCursor(Cursor c) {
1606 synchronized (mManagedCursors) {
1607 mManagedCursors.add(new ManagedCursor(c));
1608 }
1609 }
1610
1611 /**
1612 * Given a Cursor that was previously given to
1613 * {@link #startManagingCursor}, stop the activity's management of that
1614 * cursor.
1615 *
1616 * @param c The Cursor that was being managed.
1617 *
1618 * @see #startManagingCursor
1619 */
1620 public void stopManagingCursor(Cursor c) {
1621 synchronized (mManagedCursors) {
1622 final int N = mManagedCursors.size();
1623 for (int i=0; i<N; i++) {
1624 ManagedCursor mc = mManagedCursors.get(i);
1625 if (mc.mCursor == c) {
1626 mManagedCursors.remove(i);
1627 break;
1628 }
1629 }
1630 }
1631 }
1632
1633 /**
Dianne Hackborn3c4c2b72010-10-05 18:07:54 -07001634 * @deprecated As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}
1635 * this is a no-op.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001636 */
Dianne Hackbornd3efa392010-09-01 17:34:12 -07001637 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001638 public void setPersistent(boolean isPersistent) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001639 }
1640
1641 /**
1642 * Finds a view that was identified by the id attribute from the XML that
1643 * was processed in {@link #onCreate}.
1644 *
1645 * @return The view if found or null otherwise.
1646 */
1647 public View findViewById(int id) {
1648 return getWindow().findViewById(id);
1649 }
1650
1651 /**
1652 * Set the activity content from a layout resource. The resource will be
1653 * inflated, adding all top-level views to the activity.
1654 *
1655 * @param layoutResID Resource ID to be inflated.
1656 */
1657 public void setContentView(int layoutResID) {
1658 getWindow().setContentView(layoutResID);
1659 }
1660
1661 /**
1662 * Set the activity content to an explicit view. This view is placed
1663 * directly into the activity's view hierarchy. It can itself be a complex
1664 * view hierarhcy.
1665 *
1666 * @param view The desired content to display.
1667 */
1668 public void setContentView(View view) {
1669 getWindow().setContentView(view);
1670 }
1671
1672 /**
1673 * Set the activity content to an explicit view. This view is placed
1674 * directly into the activity's view hierarchy. It can itself be a complex
1675 * view hierarhcy.
1676 *
1677 * @param view The desired content to display.
1678 * @param params Layout parameters for the view.
1679 */
1680 public void setContentView(View view, ViewGroup.LayoutParams params) {
1681 getWindow().setContentView(view, params);
1682 }
1683
1684 /**
1685 * Add an additional content view to the activity. Added after any existing
1686 * ones in the activity -- existing views are NOT removed.
1687 *
1688 * @param view The desired content to display.
1689 * @param params Layout parameters for the view.
1690 */
1691 public void addContentView(View view, ViewGroup.LayoutParams params) {
1692 getWindow().addContentView(view, params);
1693 }
1694
1695 /**
1696 * Use with {@link #setDefaultKeyMode} to turn off default handling of
1697 * keys.
1698 *
1699 * @see #setDefaultKeyMode
1700 */
1701 static public final int DEFAULT_KEYS_DISABLE = 0;
1702 /**
1703 * Use with {@link #setDefaultKeyMode} to launch the dialer during default
1704 * key handling.
1705 *
1706 * @see #setDefaultKeyMode
1707 */
1708 static public final int DEFAULT_KEYS_DIALER = 1;
1709 /**
1710 * Use with {@link #setDefaultKeyMode} to execute a menu shortcut in
1711 * default key handling.
1712 *
1713 * <p>That is, the user does not need to hold down the menu key to execute menu shortcuts.
1714 *
1715 * @see #setDefaultKeyMode
1716 */
1717 static public final int DEFAULT_KEYS_SHORTCUT = 2;
1718 /**
1719 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
1720 * will start an application-defined search. (If the application or activity does not
1721 * actually define a search, the the keys will be ignored.)
1722 *
1723 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
1724 *
1725 * @see #setDefaultKeyMode
1726 */
1727 static public final int DEFAULT_KEYS_SEARCH_LOCAL = 3;
1728
1729 /**
1730 * Use with {@link #setDefaultKeyMode} to specify that unhandled keystrokes
1731 * will start a global search (typically web search, but some platforms may define alternate
1732 * methods for global search)
1733 *
1734 * <p>See {@link android.app.SearchManager android.app.SearchManager} for more details.
1735 *
1736 * @see #setDefaultKeyMode
1737 */
1738 static public final int DEFAULT_KEYS_SEARCH_GLOBAL = 4;
1739
1740 /**
1741 * Select the default key handling for this activity. This controls what
1742 * will happen to key events that are not otherwise handled. The default
1743 * mode ({@link #DEFAULT_KEYS_DISABLE}) will simply drop them on the
1744 * floor. Other modes allow you to launch the dialer
1745 * ({@link #DEFAULT_KEYS_DIALER}), execute a shortcut in your options
1746 * menu without requiring the menu key be held down
1747 * ({@link #DEFAULT_KEYS_SHORTCUT}), or launch a search ({@link #DEFAULT_KEYS_SEARCH_LOCAL}
1748 * and {@link #DEFAULT_KEYS_SEARCH_GLOBAL}).
1749 *
1750 * <p>Note that the mode selected here does not impact the default
1751 * handling of system keys, such as the "back" and "menu" keys, and your
1752 * activity and its views always get a first chance to receive and handle
1753 * all application keys.
1754 *
1755 * @param mode The desired default key mode constant.
1756 *
1757 * @see #DEFAULT_KEYS_DISABLE
1758 * @see #DEFAULT_KEYS_DIALER
1759 * @see #DEFAULT_KEYS_SHORTCUT
1760 * @see #DEFAULT_KEYS_SEARCH_LOCAL
1761 * @see #DEFAULT_KEYS_SEARCH_GLOBAL
1762 * @see #onKeyDown
1763 */
1764 public final void setDefaultKeyMode(int mode) {
1765 mDefaultKeyMode = mode;
1766
1767 // Some modes use a SpannableStringBuilder to track & dispatch input events
1768 // This list must remain in sync with the switch in onKeyDown()
1769 switch (mode) {
1770 case DEFAULT_KEYS_DISABLE:
1771 case DEFAULT_KEYS_SHORTCUT:
1772 mDefaultKeySsb = null; // not used in these modes
1773 break;
1774 case DEFAULT_KEYS_DIALER:
1775 case DEFAULT_KEYS_SEARCH_LOCAL:
1776 case DEFAULT_KEYS_SEARCH_GLOBAL:
1777 mDefaultKeySsb = new SpannableStringBuilder();
1778 Selection.setSelection(mDefaultKeySsb,0);
1779 break;
1780 default:
1781 throw new IllegalArgumentException();
1782 }
1783 }
1784
1785 /**
1786 * Called when a key was pressed down and not handled by any of the views
1787 * inside of the activity. So, for example, key presses while the cursor
1788 * is inside a TextView will not trigger the event (unless it is a navigation
1789 * to another object) because TextView handles its own key presses.
1790 *
1791 * <p>If the focused view didn't want this event, this method is called.
1792 *
Dianne Hackborn8d374262009-09-14 21:21:52 -07001793 * <p>The default implementation takes care of {@link KeyEvent#KEYCODE_BACK}
1794 * by calling {@link #onBackPressed()}, though the behavior varies based
1795 * on the application compatibility mode: for
1796 * {@link android.os.Build.VERSION_CODES#ECLAIR} or later applications,
1797 * it will set up the dispatch to call {@link #onKeyUp} where the action
1798 * will be performed; for earlier applications, it will perform the
1799 * action immediately in on-down, as those versions of the platform
1800 * behaved.
1801 *
1802 * <p>Other additional default key handling may be performed
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001803 * if configured with {@link #setDefaultKeyMode}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001804 *
1805 * @return Return <code>true</code> to prevent this event from being propagated
1806 * further, or <code>false</code> to indicate that you have not handled
1807 * this event and it should continue to be propagated.
1808 * @see #onKeyUp
1809 * @see android.view.KeyEvent
1810 */
1811 public boolean onKeyDown(int keyCode, KeyEvent event) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001812 if (keyCode == KeyEvent.KEYCODE_BACK) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07001813 if (getApplicationInfo().targetSdkVersion
1814 >= Build.VERSION_CODES.ECLAIR) {
1815 event.startTracking();
1816 } else {
1817 onBackPressed();
1818 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001819 return true;
1820 }
1821
1822 if (mDefaultKeyMode == DEFAULT_KEYS_DISABLE) {
1823 return false;
1824 } else if (mDefaultKeyMode == DEFAULT_KEYS_SHORTCUT) {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001825 if (getWindow().performPanelShortcut(Window.FEATURE_OPTIONS_PANEL,
1826 keyCode, event, Menu.FLAG_ALWAYS_PERFORM_CLOSE)) {
1827 return true;
1828 }
1829 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001830 } else {
1831 // Common code for DEFAULT_KEYS_DIALER & DEFAULT_KEYS_SEARCH_*
1832 boolean clearSpannable = false;
1833 boolean handled;
1834 if ((event.getRepeatCount() != 0) || event.isSystem()) {
1835 clearSpannable = true;
1836 handled = false;
1837 } else {
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001838 handled = TextKeyListener.getInstance().onKeyDown(
1839 null, mDefaultKeySsb, keyCode, event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001840 if (handled && mDefaultKeySsb.length() > 0) {
1841 // something useable has been typed - dispatch it now.
1842
1843 final String str = mDefaultKeySsb.toString();
1844 clearSpannable = true;
1845
1846 switch (mDefaultKeyMode) {
1847 case DEFAULT_KEYS_DIALER:
1848 Intent intent = new Intent(Intent.ACTION_DIAL, Uri.parse("tel:" + str));
1849 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1850 startActivity(intent);
1851 break;
1852 case DEFAULT_KEYS_SEARCH_LOCAL:
1853 startSearch(str, false, null, false);
1854 break;
1855 case DEFAULT_KEYS_SEARCH_GLOBAL:
1856 startSearch(str, false, null, true);
1857 break;
1858 }
1859 }
1860 }
1861 if (clearSpannable) {
1862 mDefaultKeySsb.clear();
1863 mDefaultKeySsb.clearSpans();
1864 Selection.setSelection(mDefaultKeySsb,0);
1865 }
1866 return handled;
1867 }
1868 }
1869
1870 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001871 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
1872 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
1873 * the event).
1874 */
1875 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
1876 return false;
1877 }
1878
1879 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001880 * Called when a key was released and not handled by any of the views
1881 * inside of the activity. So, for example, key presses while the cursor
1882 * is inside a TextView will not trigger the event (unless it is a navigation
1883 * to another object) because TextView handles its own key presses.
1884 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001885 * <p>The default implementation handles KEYCODE_BACK to stop the activity
1886 * and go back.
1887 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001888 * @return Return <code>true</code> to prevent this event from being propagated
1889 * further, or <code>false</code> to indicate that you have not handled
1890 * this event and it should continue to be propagated.
1891 * @see #onKeyDown
1892 * @see KeyEvent
1893 */
1894 public boolean onKeyUp(int keyCode, KeyEvent event) {
Dianne Hackborn8d374262009-09-14 21:21:52 -07001895 if (getApplicationInfo().targetSdkVersion
1896 >= Build.VERSION_CODES.ECLAIR) {
1897 if (keyCode == KeyEvent.KEYCODE_BACK && event.isTracking()
1898 && !event.isCanceled()) {
1899 onBackPressed();
1900 return true;
1901 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001902 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001903 return false;
1904 }
1905
1906 /**
1907 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
1908 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
1909 * the event).
1910 */
1911 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
1912 return false;
1913 }
1914
1915 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001916 * Called when the activity has detected the user's press of the back
1917 * key. The default implementation simply finishes the current activity,
1918 * but you can override this to do whatever you want.
1919 */
1920 public void onBackPressed() {
1921 finish();
1922 }
1923
1924 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001925 * Called when a touch screen event was not handled by any of the views
1926 * under it. This is most useful to process touch events that happen
1927 * outside of your window bounds, where there is no view to receive it.
1928 *
1929 * @param event The touch screen event being processed.
1930 *
1931 * @return Return true if you have consumed the event, false if you haven't.
1932 * The default implementation always returns false.
1933 */
1934 public boolean onTouchEvent(MotionEvent event) {
1935 return false;
1936 }
1937
1938 /**
1939 * Called when the trackball was moved and not handled by any of the
1940 * views inside of the activity. So, for example, if the trackball moves
1941 * while focus is on a button, you will receive a call here because
1942 * buttons do not normally do anything with trackball events. The call
1943 * here happens <em>before</em> trackball movements are converted to
1944 * DPAD key events, which then get sent back to the view hierarchy, and
1945 * will be processed at the point for things like focus navigation.
1946 *
1947 * @param event The trackball event being processed.
1948 *
1949 * @return Return true if you have consumed the event, false if you haven't.
1950 * The default implementation always returns false.
1951 */
1952 public boolean onTrackballEvent(MotionEvent event) {
1953 return false;
1954 }
1955
1956 /**
1957 * Called whenever a key, touch, or trackball event is dispatched to the
1958 * activity. Implement this method if you wish to know that the user has
1959 * interacted with the device in some way while your activity is running.
1960 * This callback and {@link #onUserLeaveHint} are intended to help
1961 * activities manage status bar notifications intelligently; specifically,
1962 * for helping activities determine the proper time to cancel a notfication.
1963 *
1964 * <p>All calls to your activity's {@link #onUserLeaveHint} callback will
1965 * be accompanied by calls to {@link #onUserInteraction}. This
1966 * ensures that your activity will be told of relevant user activity such
1967 * as pulling down the notification pane and touching an item there.
1968 *
1969 * <p>Note that this callback will be invoked for the touch down action
1970 * that begins a touch gesture, but may not be invoked for the touch-moved
1971 * and touch-up actions that follow.
1972 *
1973 * @see #onUserLeaveHint()
1974 */
1975 public void onUserInteraction() {
1976 }
1977
1978 public void onWindowAttributesChanged(WindowManager.LayoutParams params) {
1979 // Update window manager if: we have a view, that view is
1980 // attached to its parent (which will be a RootView), and
1981 // this activity is not embedded.
1982 if (mParent == null) {
1983 View decor = mDecor;
1984 if (decor != null && decor.getParent() != null) {
1985 getWindowManager().updateViewLayout(decor, params);
1986 }
1987 }
1988 }
1989
1990 public void onContentChanged() {
1991 }
1992
1993 /**
1994 * Called when the current {@link Window} of the activity gains or loses
1995 * focus. This is the best indicator of whether this activity is visible
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001996 * to the user. The default implementation clears the key tracking
1997 * state, so should always be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001998 *
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07001999 * <p>Note that this provides information about global focus state, which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002000 * is managed independently of activity lifecycles. As such, while focus
2001 * changes will generally have some relation to lifecycle changes (an
2002 * activity that is stopped will not generally get window focus), you
2003 * should not rely on any particular order between the callbacks here and
2004 * those in the other lifecycle methods such as {@link #onResume}.
2005 *
2006 * <p>As a general rule, however, a resumed activity will have window
2007 * focus... unless it has displayed other dialogs or popups that take
2008 * input focus, in which case the activity itself will not have focus
2009 * when the other windows have it. Likewise, the system may display
2010 * system-level windows (such as the status bar notification panel or
2011 * a system alert) which will temporarily take window input focus without
2012 * pausing the foreground activity.
2013 *
2014 * @param hasFocus Whether the window of this activity has focus.
2015 *
2016 * @see #hasWindowFocus()
2017 * @see #onResume
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002018 * @see View#onWindowFocusChanged(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002019 */
2020 public void onWindowFocusChanged(boolean hasFocus) {
2021 }
2022
2023 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -07002024 * Called when the main window associated with the activity has been
2025 * attached to the window manager.
2026 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
2027 * for more information.
2028 * @see View#onAttachedToWindow
2029 */
2030 public void onAttachedToWindow() {
2031 }
2032
2033 /**
2034 * Called when the main window associated with the activity has been
2035 * detached from the window manager.
2036 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
2037 * for more information.
2038 * @see View#onDetachedFromWindow
2039 */
2040 public void onDetachedFromWindow() {
2041 }
2042
2043 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002044 * Returns true if this activity's <em>main</em> window currently has window focus.
2045 * Note that this is not the same as the view itself having focus.
2046 *
2047 * @return True if this activity's main window currently has window focus.
2048 *
2049 * @see #onWindowAttributesChanged(android.view.WindowManager.LayoutParams)
2050 */
2051 public boolean hasWindowFocus() {
2052 Window w = getWindow();
2053 if (w != null) {
2054 View d = w.getDecorView();
2055 if (d != null) {
2056 return d.hasWindowFocus();
2057 }
2058 }
2059 return false;
2060 }
2061
2062 /**
2063 * Called to process key events. You can override this to intercept all
2064 * key events before they are dispatched to the window. Be sure to call
2065 * this implementation for key events that should be handled normally.
2066 *
2067 * @param event The key event.
2068 *
2069 * @return boolean Return true if this event was consumed.
2070 */
2071 public boolean dispatchKeyEvent(KeyEvent event) {
2072 onUserInteraction();
Dianne Hackborn8d374262009-09-14 21:21:52 -07002073 Window win = getWindow();
2074 if (win.superDispatchKeyEvent(event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002075 return true;
2076 }
Dianne Hackborn8d374262009-09-14 21:21:52 -07002077 View decor = mDecor;
2078 if (decor == null) decor = win.getDecorView();
2079 return event.dispatch(this, decor != null
2080 ? decor.getKeyDispatcherState() : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002081 }
2082
2083 /**
2084 * Called to process touch screen events. You can override this to
2085 * intercept all touch screen events before they are dispatched to the
2086 * window. Be sure to call this implementation for touch screen events
2087 * that should be handled normally.
2088 *
2089 * @param ev The touch screen event.
2090 *
2091 * @return boolean Return true if this event was consumed.
2092 */
2093 public boolean dispatchTouchEvent(MotionEvent ev) {
2094 if (ev.getAction() == MotionEvent.ACTION_DOWN) {
2095 onUserInteraction();
2096 }
2097 if (getWindow().superDispatchTouchEvent(ev)) {
2098 return true;
2099 }
2100 return onTouchEvent(ev);
2101 }
2102
2103 /**
2104 * Called to process trackball events. You can override this to
2105 * intercept all trackball events before they are dispatched to the
2106 * window. Be sure to call this implementation for trackball events
2107 * that should be handled normally.
2108 *
2109 * @param ev The trackball event.
2110 *
2111 * @return boolean Return true if this event was consumed.
2112 */
2113 public boolean dispatchTrackballEvent(MotionEvent ev) {
2114 onUserInteraction();
2115 if (getWindow().superDispatchTrackballEvent(ev)) {
2116 return true;
2117 }
2118 return onTrackballEvent(ev);
2119 }
svetoslavganov75986cf2009-05-14 22:28:01 -07002120
2121 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
2122 event.setClassName(getClass().getName());
2123 event.setPackageName(getPackageName());
2124
2125 LayoutParams params = getWindow().getAttributes();
Romain Guy980a9382010-01-08 15:06:28 -08002126 boolean isFullScreen = (params.width == LayoutParams.MATCH_PARENT) &&
2127 (params.height == LayoutParams.MATCH_PARENT);
svetoslavganov75986cf2009-05-14 22:28:01 -07002128 event.setFullScreen(isFullScreen);
2129
2130 CharSequence title = getTitle();
2131 if (!TextUtils.isEmpty(title)) {
2132 event.getText().add(title);
2133 }
2134
2135 return true;
2136 }
2137
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002138 /**
2139 * Default implementation of
2140 * {@link android.view.Window.Callback#onCreatePanelView}
2141 * for activities. This
2142 * simply returns null so that all panel sub-windows will have the default
2143 * menu behavior.
2144 */
2145 public View onCreatePanelView(int featureId) {
2146 return null;
2147 }
2148
2149 /**
2150 * Default implementation of
2151 * {@link android.view.Window.Callback#onCreatePanelMenu}
2152 * for activities. This calls through to the new
2153 * {@link #onCreateOptionsMenu} method for the
2154 * {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2155 * so that subclasses of Activity don't need to deal with feature codes.
2156 */
2157 public boolean onCreatePanelMenu(int featureId, Menu menu) {
2158 if (featureId == Window.FEATURE_OPTIONS_PANEL) {
2159 return onCreateOptionsMenu(menu);
2160 }
2161 return false;
2162 }
2163
2164 /**
2165 * Default implementation of
2166 * {@link android.view.Window.Callback#onPreparePanel}
2167 * for activities. This
2168 * calls through to the new {@link #onPrepareOptionsMenu} method for the
2169 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2170 * panel, so that subclasses of
2171 * Activity don't need to deal with feature codes.
2172 */
2173 public boolean onPreparePanel(int featureId, View view, Menu menu) {
2174 if (featureId == Window.FEATURE_OPTIONS_PANEL && menu != null) {
2175 boolean goforit = onPrepareOptionsMenu(menu);
2176 return goforit && menu.hasVisibleItems();
2177 }
2178 return true;
2179 }
2180
2181 /**
2182 * {@inheritDoc}
2183 *
2184 * @return The default implementation returns true.
2185 */
2186 public boolean onMenuOpened(int featureId, Menu menu) {
2187 return true;
2188 }
2189
2190 /**
2191 * Default implementation of
2192 * {@link android.view.Window.Callback#onMenuItemSelected}
2193 * for activities. This calls through to the new
2194 * {@link #onOptionsItemSelected} method for the
2195 * {@link android.view.Window#FEATURE_OPTIONS_PANEL}
2196 * panel, so that subclasses of
2197 * Activity don't need to deal with feature codes.
2198 */
2199 public boolean onMenuItemSelected(int featureId, MenuItem item) {
2200 switch (featureId) {
2201 case Window.FEATURE_OPTIONS_PANEL:
2202 // Put event logging here so it gets called even if subclass
2203 // doesn't call through to superclass's implmeentation of each
2204 // of these methods below
2205 EventLog.writeEvent(50000, 0, item.getTitleCondensed());
2206 return onOptionsItemSelected(item);
2207
2208 case Window.FEATURE_CONTEXT_MENU:
2209 EventLog.writeEvent(50000, 1, item.getTitleCondensed());
2210 return onContextItemSelected(item);
2211
2212 default:
2213 return false;
2214 }
2215 }
2216
2217 /**
2218 * Default implementation of
2219 * {@link android.view.Window.Callback#onPanelClosed(int, Menu)} for
2220 * activities. This calls through to {@link #onOptionsMenuClosed(Menu)}
2221 * method for the {@link android.view.Window#FEATURE_OPTIONS_PANEL} panel,
2222 * so that subclasses of Activity don't need to deal with feature codes.
2223 * For context menus ({@link Window#FEATURE_CONTEXT_MENU}), the
2224 * {@link #onContextMenuClosed(Menu)} will be called.
2225 */
2226 public void onPanelClosed(int featureId, Menu menu) {
2227 switch (featureId) {
2228 case Window.FEATURE_OPTIONS_PANEL:
2229 onOptionsMenuClosed(menu);
2230 break;
2231
2232 case Window.FEATURE_CONTEXT_MENU:
2233 onContextMenuClosed(menu);
2234 break;
2235 }
2236 }
2237
2238 /**
2239 * Initialize the contents of the Activity's standard options menu. You
2240 * should place your menu items in to <var>menu</var>.
2241 *
2242 * <p>This is only called once, the first time the options menu is
2243 * displayed. To update the menu every time it is displayed, see
2244 * {@link #onPrepareOptionsMenu}.
2245 *
2246 * <p>The default implementation populates the menu with standard system
2247 * menu items. These are placed in the {@link Menu#CATEGORY_SYSTEM} group so that
2248 * they will be correctly ordered with application-defined menu items.
2249 * Deriving classes should always call through to the base implementation.
2250 *
2251 * <p>You can safely hold on to <var>menu</var> (and any items created
2252 * from it), making modifications to it as desired, until the next
2253 * time onCreateOptionsMenu() is called.
2254 *
2255 * <p>When you add items to the menu, you can implement the Activity's
2256 * {@link #onOptionsItemSelected} method to handle them there.
2257 *
2258 * @param menu The options menu in which you place your items.
2259 *
2260 * @return You must return true for the menu to be displayed;
2261 * if you return false it will not be shown.
2262 *
2263 * @see #onPrepareOptionsMenu
2264 * @see #onOptionsItemSelected
2265 */
2266 public boolean onCreateOptionsMenu(Menu menu) {
2267 if (mParent != null) {
2268 return mParent.onCreateOptionsMenu(menu);
2269 }
2270 return true;
2271 }
2272
2273 /**
2274 * Prepare the Screen's standard options menu to be displayed. This is
2275 * called right before the menu is shown, every time it is shown. You can
2276 * use this method to efficiently enable/disable items or otherwise
2277 * dynamically modify the contents.
2278 *
2279 * <p>The default implementation updates the system menu items based on the
2280 * activity's state. Deriving classes should always call through to the
2281 * base class implementation.
2282 *
2283 * @param menu The options menu as last shown or first initialized by
2284 * onCreateOptionsMenu().
2285 *
2286 * @return You must return true for the menu to be displayed;
2287 * if you return false it will not be shown.
2288 *
2289 * @see #onCreateOptionsMenu
2290 */
2291 public boolean onPrepareOptionsMenu(Menu menu) {
2292 if (mParent != null) {
2293 return mParent.onPrepareOptionsMenu(menu);
2294 }
2295 return true;
2296 }
2297
2298 /**
2299 * This hook is called whenever an item in your options menu is selected.
2300 * The default implementation simply returns false to have the normal
2301 * processing happen (calling the item's Runnable or sending a message to
2302 * its Handler as appropriate). You can use this method for any items
2303 * for which you would like to do processing without those other
2304 * facilities.
2305 *
2306 * <p>Derived classes should call through to the base class for it to
2307 * perform the default menu handling.
2308 *
2309 * @param item The menu item that was selected.
2310 *
2311 * @return boolean Return false to allow normal menu processing to
2312 * proceed, true to consume it here.
2313 *
2314 * @see #onCreateOptionsMenu
2315 */
2316 public boolean onOptionsItemSelected(MenuItem item) {
2317 if (mParent != null) {
2318 return mParent.onOptionsItemSelected(item);
2319 }
2320 return false;
2321 }
2322
2323 /**
2324 * This hook is called whenever the options menu is being closed (either by the user canceling
2325 * the menu with the back/menu button, or when an item is selected).
2326 *
2327 * @param menu The options menu as last shown or first initialized by
2328 * onCreateOptionsMenu().
2329 */
2330 public void onOptionsMenuClosed(Menu menu) {
2331 if (mParent != null) {
2332 mParent.onOptionsMenuClosed(menu);
2333 }
2334 }
2335
2336 /**
2337 * Programmatically opens the options menu. If the options menu is already
2338 * open, this method does nothing.
2339 */
2340 public void openOptionsMenu() {
2341 mWindow.openPanel(Window.FEATURE_OPTIONS_PANEL, null);
2342 }
2343
2344 /**
2345 * Progammatically closes the options menu. If the options menu is already
2346 * closed, this method does nothing.
2347 */
2348 public void closeOptionsMenu() {
2349 mWindow.closePanel(Window.FEATURE_OPTIONS_PANEL);
2350 }
2351
2352 /**
2353 * Called when a context menu for the {@code view} is about to be shown.
2354 * Unlike {@link #onCreateOptionsMenu(Menu)}, this will be called every
2355 * time the context menu is about to be shown and should be populated for
2356 * the view (or item inside the view for {@link AdapterView} subclasses,
2357 * this can be found in the {@code menuInfo})).
2358 * <p>
2359 * Use {@link #onContextItemSelected(android.view.MenuItem)} to know when an
2360 * item has been selected.
2361 * <p>
2362 * It is not safe to hold onto the context menu after this method returns.
2363 * {@inheritDoc}
2364 */
2365 public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) {
2366 }
2367
2368 /**
2369 * Registers a context menu to be shown for the given view (multiple views
2370 * can show the context menu). This method will set the
2371 * {@link OnCreateContextMenuListener} on the view to this activity, so
2372 * {@link #onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} will be
2373 * called when it is time to show the context menu.
2374 *
2375 * @see #unregisterForContextMenu(View)
2376 * @param view The view that should show a context menu.
2377 */
2378 public void registerForContextMenu(View view) {
2379 view.setOnCreateContextMenuListener(this);
2380 }
2381
2382 /**
2383 * Prevents a context menu to be shown for the given view. This method will remove the
2384 * {@link OnCreateContextMenuListener} on the view.
2385 *
2386 * @see #registerForContextMenu(View)
2387 * @param view The view that should stop showing a context menu.
2388 */
2389 public void unregisterForContextMenu(View view) {
2390 view.setOnCreateContextMenuListener(null);
2391 }
2392
2393 /**
2394 * Programmatically opens the context menu for a particular {@code view}.
2395 * The {@code view} should have been added via
2396 * {@link #registerForContextMenu(View)}.
2397 *
2398 * @param view The view to show the context menu for.
2399 */
2400 public void openContextMenu(View view) {
2401 view.showContextMenu();
2402 }
2403
2404 /**
2405 * Programmatically closes the most recently opened context menu, if showing.
2406 */
2407 public void closeContextMenu() {
2408 mWindow.closePanel(Window.FEATURE_CONTEXT_MENU);
2409 }
2410
2411 /**
2412 * This hook is called whenever an item in a context menu is selected. The
2413 * default implementation simply returns false to have the normal processing
2414 * happen (calling the item's Runnable or sending a message to its Handler
2415 * as appropriate). You can use this method for any items for which you
2416 * would like to do processing without those other facilities.
2417 * <p>
2418 * Use {@link MenuItem#getMenuInfo()} to get extra information set by the
2419 * View that added this menu item.
2420 * <p>
2421 * Derived classes should call through to the base class for it to perform
2422 * the default menu handling.
2423 *
2424 * @param item The context menu item that was selected.
2425 * @return boolean Return false to allow normal context menu processing to
2426 * proceed, true to consume it here.
2427 */
2428 public boolean onContextItemSelected(MenuItem item) {
2429 if (mParent != null) {
2430 return mParent.onContextItemSelected(item);
2431 }
2432 return false;
2433 }
2434
2435 /**
2436 * This hook is called whenever the context menu is being closed (either by
2437 * the user canceling the menu with the back/menu button, or when an item is
2438 * selected).
2439 *
2440 * @param menu The context menu that is being closed.
2441 */
2442 public void onContextMenuClosed(Menu menu) {
2443 if (mParent != null) {
2444 mParent.onContextMenuClosed(menu);
2445 }
2446 }
2447
2448 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002449 * @deprecated Old no-arguments version of {@link #onCreateDialog(int, Bundle)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002450 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002451 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002452 protected Dialog onCreateDialog(int id) {
2453 return null;
2454 }
2455
2456 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002457 * Callback for creating dialogs that are managed (saved and restored) for you
2458 * by the activity. The default implementation calls through to
2459 * {@link #onCreateDialog(int)} for compatibility.
2460 *
2461 * <p>If you use {@link #showDialog(int)}, the activity will call through to
2462 * this method the first time, and hang onto it thereafter. Any dialog
2463 * that is created by this method will automatically be saved and restored
2464 * for you, including whether it is showing.
2465 *
2466 * <p>If you would like the activity to manage saving and restoring dialogs
2467 * for you, you should override this method and handle any ids that are
2468 * passed to {@link #showDialog}.
2469 *
2470 * <p>If you would like an opportunity to prepare your dialog before it is shown,
2471 * override {@link #onPrepareDialog(int, Dialog, Bundle)}.
2472 *
2473 * @param id The id of the dialog.
2474 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
2475 * @return The dialog. If you return null, the dialog will not be created.
2476 *
2477 * @see #onPrepareDialog(int, Dialog, Bundle)
2478 * @see #showDialog(int, Bundle)
2479 * @see #dismissDialog(int)
2480 * @see #removeDialog(int)
2481 */
2482 protected Dialog onCreateDialog(int id, Bundle args) {
2483 return onCreateDialog(id);
2484 }
2485
2486 /**
2487 * @deprecated Old no-arguments version of
2488 * {@link #onPrepareDialog(int, Dialog, Bundle)}.
2489 */
2490 @Deprecated
2491 protected void onPrepareDialog(int id, Dialog dialog) {
2492 dialog.setOwnerActivity(this);
2493 }
2494
2495 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002496 * Provides an opportunity to prepare a managed dialog before it is being
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002497 * shown. The default implementation calls through to
2498 * {@link #onPrepareDialog(int, Dialog)} for compatibility.
2499 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002500 * <p>
2501 * Override this if you need to update a managed dialog based on the state
2502 * of the application each time it is shown. For example, a time picker
2503 * dialog might want to be updated with the current time. You should call
2504 * through to the superclass's implementation. The default implementation
2505 * will set this Activity as the owner activity on the Dialog.
2506 *
2507 * @param id The id of the managed dialog.
2508 * @param dialog The dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002509 * @param args The dialog arguments provided to {@link #showDialog(int, Bundle)}.
2510 * @see #onCreateDialog(int, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002511 * @see #showDialog(int)
2512 * @see #dismissDialog(int)
2513 * @see #removeDialog(int)
2514 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002515 protected void onPrepareDialog(int id, Dialog dialog, Bundle args) {
2516 onPrepareDialog(id, dialog);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002517 }
2518
2519 /**
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002520 * Simple version of {@link #showDialog(int, Bundle)} that does not
2521 * take any arguments. Simply calls {@link #showDialog(int, Bundle)}
2522 * with null arguments.
2523 */
2524 public final void showDialog(int id) {
2525 showDialog(id, null);
2526 }
2527
2528 /**
2529 * Show a dialog managed by this activity. A call to {@link #onCreateDialog(int, Bundle)}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002530 * will be made with the same id the first time this is called for a given
2531 * id. From thereafter, the dialog will be automatically saved and restored.
2532 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002533 * <p>Each time a dialog is shown, {@link #onPrepareDialog(int, Dialog, Bundle)} will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002534 * be made to provide an opportunity to do any timely preparation.
2535 *
2536 * @param id The id of the managed dialog.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002537 * @param args Arguments to pass through to the dialog. These will be saved
2538 * and restored for you. Note that if the dialog is already created,
2539 * {@link #onCreateDialog(int, Bundle)} will not be called with the new
2540 * arguments but {@link #onPrepareDialog(int, Dialog, Bundle)} will be.
Dianne Hackbornd47c6ed2010-01-27 16:21:20 -08002541 * If you need to rebuild the dialog, call {@link #removeDialog(int)} first.
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002542 * @return Returns true if the Dialog was created; false is returned if
2543 * it is not created because {@link #onCreateDialog(int, Bundle)} returns false.
2544 *
Joe Onorato37296dc2009-07-31 17:58:55 -07002545 * @see Dialog
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002546 * @see #onCreateDialog(int, Bundle)
2547 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002548 * @see #dismissDialog(int)
2549 * @see #removeDialog(int)
2550 */
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002551 public final boolean showDialog(int id, Bundle args) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002552 if (mManagedDialogs == null) {
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002553 mManagedDialogs = new SparseArray<ManagedDialog>();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002554 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002555 ManagedDialog md = mManagedDialogs.get(id);
2556 if (md == null) {
2557 md = new ManagedDialog();
2558 md.mDialog = createDialog(id, null, args);
2559 if (md.mDialog == null) {
2560 return false;
2561 }
2562 mManagedDialogs.put(id, md);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002563 }
2564
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002565 md.mArgs = args;
2566 onPrepareDialog(id, md.mDialog, args);
2567 md.mDialog.show();
2568 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002569 }
2570
2571 /**
2572 * Dismiss a dialog that was previously shown via {@link #showDialog(int)}.
2573 *
2574 * @param id The id of the managed dialog.
2575 *
2576 * @throws IllegalArgumentException if the id was not previously shown via
2577 * {@link #showDialog(int)}.
2578 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002579 * @see #onCreateDialog(int, Bundle)
2580 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002581 * @see #showDialog(int)
2582 * @see #removeDialog(int)
2583 */
2584 public final void dismissDialog(int id) {
2585 if (mManagedDialogs == null) {
2586 throw missingDialog(id);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002587 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002588
2589 final ManagedDialog md = mManagedDialogs.get(id);
2590 if (md == null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002591 throw missingDialog(id);
2592 }
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002593 md.mDialog.dismiss();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002594 }
2595
2596 /**
2597 * Creates an exception to throw if a user passed in a dialog id that is
2598 * unexpected.
2599 */
2600 private IllegalArgumentException missingDialog(int id) {
2601 return new IllegalArgumentException("no dialog with id " + id + " was ever "
2602 + "shown via Activity#showDialog");
2603 }
2604
2605 /**
2606 * Removes any internal references to a dialog managed by this Activity.
2607 * If the dialog is showing, it will dismiss it as part of the clean up.
2608 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002609 * <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 -08002610 * want to avoid the overhead of saving and restoring it in the future.
2611 *
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07002612 * <p>As of {@link android.os.Build.VERSION_CODES#GINGERBREAD}, this function
2613 * will not throw an exception if you try to remove an ID that does not
2614 * currently have an associated dialog.</p>
2615 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002616 * @param id The id of the managed dialog.
2617 *
Dianne Hackborn8ea138c2010-01-26 18:01:04 -08002618 * @see #onCreateDialog(int, Bundle)
2619 * @see #onPrepareDialog(int, Dialog, Bundle)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002620 * @see #showDialog(int)
2621 * @see #dismissDialog(int)
2622 */
2623 public final void removeDialog(int id) {
Dianne Hackbornd2ce8bbb2010-10-06 16:46:05 -07002624 if (mManagedDialogs != null) {
2625 final ManagedDialog md = mManagedDialogs.get(id);
2626 if (md != null) {
2627 md.mDialog.dismiss();
2628 mManagedDialogs.remove(id);
2629 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002630 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002631 }
2632
2633 /**
2634 * This hook is called when the user signals the desire to start a search.
2635 *
Bjorn Bringert6266e402009-09-25 14:25:41 +01002636 * <p>You can use this function as a simple way to launch the search UI, in response to a
2637 * menu item, search button, or other widgets within your activity. Unless overidden,
2638 * calling this function is the same as calling
2639 * {@link #startSearch startSearch(null, false, null, false)}, which launches
2640 * search for the current activity as specified in its manifest, see {@link SearchManager}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002641 *
2642 * <p>You can override this function to force global search, e.g. in response to a dedicated
2643 * search key, or to block search entirely (by simply returning false).
2644 *
Bjorn Bringert6266e402009-09-25 14:25:41 +01002645 * @return Returns {@code true} if search launched, and {@code false} if activity blocks it.
2646 * The default implementation always returns {@code true}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002647 *
2648 * @see android.app.SearchManager
2649 */
2650 public boolean onSearchRequested() {
2651 startSearch(null, false, null, false);
2652 return true;
2653 }
2654
2655 /**
2656 * This hook is called to launch the search UI.
2657 *
2658 * <p>It is typically called from onSearchRequested(), either directly from
2659 * Activity.onSearchRequested() or from an overridden version in any given
2660 * Activity. If your goal is simply to activate search, it is preferred to call
2661 * onSearchRequested(), which may have been overriden elsewhere in your Activity. If your goal
2662 * is to inject specific data such as context data, it is preferred to <i>override</i>
2663 * onSearchRequested(), so that any callers to it will benefit from the override.
2664 *
2665 * @param initialQuery Any non-null non-empty string will be inserted as
2666 * pre-entered text in the search query box.
2667 * @param selectInitialQuery If true, the intial query will be preselected, which means that
2668 * any further typing will replace it. This is useful for cases where an entire pre-formed
2669 * query is being inserted. If false, the selection point will be placed at the end of the
2670 * inserted query. This is useful when the inserted query is text that the user entered,
2671 * and the user would expect to be able to keep typing. <i>This parameter is only meaningful
2672 * if initialQuery is a non-empty string.</i>
2673 * @param appSearchData An application can insert application-specific
2674 * context here, in order to improve quality or specificity of its own
2675 * searches. This data will be returned with SEARCH intent(s). Null if
2676 * no extra data is required.
2677 * @param globalSearch If false, this will only launch the search that has been specifically
2678 * defined by the application (which is usually defined as a local search). If no default
Mike LeBeaucfa419b2009-08-17 10:56:02 -07002679 * search is defined in the current application or activity, global search will be launched.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002680 * If true, this will always launch a platform-global (e.g. web-based) search instead.
2681 *
2682 * @see android.app.SearchManager
2683 * @see #onSearchRequested
2684 */
2685 public void startSearch(String initialQuery, boolean selectInitialQuery,
2686 Bundle appSearchData, boolean globalSearch) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07002687 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01002688 mSearchManager.startSearch(initialQuery, selectInitialQuery, getComponentName(),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002689 appSearchData, globalSearch);
2690 }
2691
2692 /**
krosaend2d60142009-08-17 08:56:48 -07002693 * Similar to {@link #startSearch}, but actually fires off the search query after invoking
2694 * the search dialog. Made available for testing purposes.
2695 *
2696 * @param query The query to trigger. If empty, the request will be ignored.
2697 * @param appSearchData An application can insert application-specific
2698 * context here, in order to improve quality or specificity of its own
2699 * searches. This data will be returned with SEARCH intent(s). Null if
2700 * no extra data is required.
krosaend2d60142009-08-17 08:56:48 -07002701 */
Bjorn Bringertb782a2f2009-10-01 09:57:33 +01002702 public void triggerSearch(String query, Bundle appSearchData) {
krosaend2d60142009-08-17 08:56:48 -07002703 ensureSearchManager();
Bjorn Bringertb782a2f2009-10-01 09:57:33 +01002704 mSearchManager.triggerSearch(query, getComponentName(), appSearchData);
krosaend2d60142009-08-17 08:56:48 -07002705 }
2706
2707 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002708 * Request that key events come to this activity. Use this if your
2709 * activity has no views with focus, but the activity still wants
2710 * a chance to process key events.
2711 *
2712 * @see android.view.Window#takeKeyEvents
2713 */
2714 public void takeKeyEvents(boolean get) {
2715 getWindow().takeKeyEvents(get);
2716 }
2717
2718 /**
2719 * Enable extended window features. This is a convenience for calling
2720 * {@link android.view.Window#requestFeature getWindow().requestFeature()}.
2721 *
2722 * @param featureId The desired feature as defined in
2723 * {@link android.view.Window}.
2724 * @return Returns true if the requested feature is supported and now
2725 * enabled.
2726 *
2727 * @see android.view.Window#requestFeature
2728 */
2729 public final boolean requestWindowFeature(int featureId) {
2730 return getWindow().requestFeature(featureId);
2731 }
2732
2733 /**
2734 * Convenience for calling
2735 * {@link android.view.Window#setFeatureDrawableResource}.
2736 */
2737 public final void setFeatureDrawableResource(int featureId, int resId) {
2738 getWindow().setFeatureDrawableResource(featureId, resId);
2739 }
2740
2741 /**
2742 * Convenience for calling
2743 * {@link android.view.Window#setFeatureDrawableUri}.
2744 */
2745 public final void setFeatureDrawableUri(int featureId, Uri uri) {
2746 getWindow().setFeatureDrawableUri(featureId, uri);
2747 }
2748
2749 /**
2750 * Convenience for calling
2751 * {@link android.view.Window#setFeatureDrawable(int, Drawable)}.
2752 */
2753 public final void setFeatureDrawable(int featureId, Drawable drawable) {
2754 getWindow().setFeatureDrawable(featureId, drawable);
2755 }
2756
2757 /**
2758 * Convenience for calling
2759 * {@link android.view.Window#setFeatureDrawableAlpha}.
2760 */
2761 public final void setFeatureDrawableAlpha(int featureId, int alpha) {
2762 getWindow().setFeatureDrawableAlpha(featureId, alpha);
2763 }
2764
2765 /**
2766 * Convenience for calling
2767 * {@link android.view.Window#getLayoutInflater}.
2768 */
2769 public LayoutInflater getLayoutInflater() {
2770 return getWindow().getLayoutInflater();
2771 }
2772
2773 /**
2774 * Returns a {@link MenuInflater} with this context.
2775 */
2776 public MenuInflater getMenuInflater() {
2777 return new MenuInflater(this);
2778 }
2779
2780 @Override
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002781 protected void onApplyThemeResource(Resources.Theme theme, int resid,
2782 boolean first) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002783 if (mParent == null) {
2784 super.onApplyThemeResource(theme, resid, first);
2785 } else {
2786 try {
2787 theme.setTo(mParent.getTheme());
2788 } catch (Exception e) {
2789 // Empty
2790 }
2791 theme.applyStyle(resid, false);
2792 }
2793 }
2794
2795 /**
2796 * Launch an activity for which you would like a result when it finished.
2797 * When this activity exits, your
2798 * onActivityResult() method will be called with the given requestCode.
2799 * Using a negative requestCode is the same as calling
2800 * {@link #startActivity} (the activity is not launched as a sub-activity).
2801 *
2802 * <p>Note that this method should only be used with Intent protocols
2803 * that are defined to return a result. In other protocols (such as
2804 * {@link Intent#ACTION_MAIN} or {@link Intent#ACTION_VIEW}), you may
2805 * not get the result when you expect. For example, if the activity you
2806 * are launching uses the singleTask launch mode, it will not run in your
2807 * task and thus you will immediately receive a cancel result.
2808 *
2809 * <p>As a special case, if you call startActivityForResult() with a requestCode
2810 * >= 0 during the initial onCreate(Bundle savedInstanceState)/onResume() of your
2811 * activity, then your window will not be displayed until a result is
2812 * returned back from the started activity. This is to avoid visible
2813 * flickering when redirecting to another activity.
2814 *
2815 * <p>This method throws {@link android.content.ActivityNotFoundException}
2816 * if there was no Activity found to run the given Intent.
2817 *
2818 * @param intent The intent to start.
2819 * @param requestCode If >= 0, this code will be returned in
2820 * onActivityResult() when the activity exits.
2821 *
2822 * @throws android.content.ActivityNotFoundException
2823 *
2824 * @see #startActivity
2825 */
2826 public void startActivityForResult(Intent intent, int requestCode) {
2827 if (mParent == null) {
2828 Instrumentation.ActivityResult ar =
2829 mInstrumentation.execStartActivity(
2830 this, mMainThread.getApplicationThread(), mToken, this,
2831 intent, requestCode);
2832 if (ar != null) {
2833 mMainThread.sendActivityResult(
2834 mToken, mEmbeddedID, requestCode, ar.getResultCode(),
2835 ar.getResultData());
2836 }
2837 if (requestCode >= 0) {
2838 // If this start is requesting a result, we can avoid making
2839 // the activity visible until the result is received. Setting
2840 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
2841 // activity hidden during this time, to avoid flickering.
2842 // This can only be done when a result is requested because
2843 // that guarantees we will get information back when the
2844 // activity is finished, no matter what happens to it.
2845 mStartedActivity = true;
2846 }
2847 } else {
2848 mParent.startActivityFromChild(this, intent, requestCode);
2849 }
2850 }
2851
2852 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002853 * Like {@link #startActivityForResult(Intent, int)}, but allowing you
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002854 * to use a IntentSender to describe the activity to be started. If
2855 * the IntentSender is for an activity, that activity will be started
2856 * as if you had called the regular {@link #startActivityForResult(Intent, int)}
2857 * here; otherwise, its associated action will be executed (such as
2858 * sending a broadcast) as if you had called
2859 * {@link IntentSender#sendIntent IntentSender.sendIntent} on it.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002860 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002861 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002862 * @param requestCode If >= 0, this code will be returned in
2863 * onActivityResult() when the activity exits.
2864 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002865 * intent parameter to {@link IntentSender#sendIntent}.
2866 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002867 * would like to change.
2868 * @param flagsValues Desired values for any bits set in
2869 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002870 * @param extraFlags Always set to 0.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002871 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002872 public void startIntentSenderForResult(IntentSender intent, int requestCode,
2873 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
2874 throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002875 if (mParent == null) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002876 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002877 flagsMask, flagsValues, this);
2878 } else {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002879 mParent.startIntentSenderFromChild(this, intent, requestCode,
2880 fillInIntent, flagsMask, flagsValues, extraFlags);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002881 }
2882 }
2883
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002884 private void startIntentSenderForResultInner(IntentSender intent, int requestCode,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002885 Intent fillInIntent, int flagsMask, int flagsValues, Activity activity)
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002886 throws IntentSender.SendIntentException {
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002887 try {
2888 String resolvedType = null;
2889 if (fillInIntent != null) {
2890 resolvedType = fillInIntent.resolveTypeIfNeeded(getContentResolver());
2891 }
2892 int result = ActivityManagerNative.getDefault()
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002893 .startActivityIntentSender(mMainThread.getApplicationThread(), intent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002894 fillInIntent, resolvedType, mToken, activity.mEmbeddedID,
2895 requestCode, flagsMask, flagsValues);
2896 if (result == IActivityManager.START_CANCELED) {
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002897 throw new IntentSender.SendIntentException();
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002898 }
2899 Instrumentation.checkStartActivityResult(result, null);
2900 } catch (RemoteException e) {
2901 }
2902 if (requestCode >= 0) {
2903 // If this start is requesting a result, we can avoid making
2904 // the activity visible until the result is received. Setting
2905 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
2906 // activity hidden during this time, to avoid flickering.
2907 // This can only be done when a result is requested because
2908 // that guarantees we will get information back when the
2909 // activity is finished, no matter what happens to it.
2910 mStartedActivity = true;
2911 }
2912 }
2913
2914 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002915 * Launch a new activity. You will not receive any information about when
2916 * the activity exits. This implementation overrides the base version,
2917 * providing information about
2918 * the activity performing the launch. Because of this additional
2919 * information, the {@link Intent#FLAG_ACTIVITY_NEW_TASK} launch flag is not
2920 * required; if not specified, the new activity will be added to the
2921 * task of the caller.
2922 *
2923 * <p>This method throws {@link android.content.ActivityNotFoundException}
2924 * if there was no Activity found to run the given Intent.
2925 *
2926 * @param intent The intent to start.
2927 *
2928 * @throws android.content.ActivityNotFoundException
2929 *
2930 * @see #startActivityForResult
2931 */
2932 @Override
2933 public void startActivity(Intent intent) {
2934 startActivityForResult(intent, -1);
2935 }
2936
2937 /**
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002938 * Like {@link #startActivity(Intent)}, but taking a IntentSender
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002939 * to start; see
Dianne Hackbornae22c052009-09-17 18:46:22 -07002940 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)}
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002941 * for more information.
2942 *
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002943 * @param intent The IntentSender to launch.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002944 * @param fillInIntent If non-null, this will be provided as the
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002945 * intent parameter to {@link IntentSender#sendIntent}.
2946 * @param flagsMask Intent flags in the original IntentSender that you
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002947 * would like to change.
2948 * @param flagsValues Desired values for any bits set in
2949 * <var>flagsMask</var>
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002950 * @param extraFlags Always set to 0.
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002951 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002952 public void startIntentSender(IntentSender intent,
2953 Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags)
2954 throws IntentSender.SendIntentException {
2955 startIntentSenderForResult(intent, -1, fillInIntent, flagsMask,
2956 flagsValues, extraFlags);
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07002957 }
2958
2959 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002960 * A special variation to launch an activity only if a new activity
2961 * instance is needed to handle the given Intent. In other words, this is
2962 * just like {@link #startActivityForResult(Intent, int)} except: if you are
2963 * using the {@link Intent#FLAG_ACTIVITY_SINGLE_TOP} flag, or
2964 * singleTask or singleTop
2965 * {@link android.R.styleable#AndroidManifestActivity_launchMode launchMode},
2966 * and the activity
2967 * that handles <var>intent</var> is the same as your currently running
2968 * activity, then a new instance is not needed. In this case, instead of
2969 * the normal behavior of calling {@link #onNewIntent} this function will
2970 * return and you can handle the Intent yourself.
2971 *
2972 * <p>This function can only be called from a top-level activity; if it is
2973 * called from a child activity, a runtime exception will be thrown.
2974 *
2975 * @param intent The intent to start.
2976 * @param requestCode If >= 0, this code will be returned in
2977 * onActivityResult() when the activity exits, as described in
2978 * {@link #startActivityForResult}.
2979 *
2980 * @return If a new activity was launched then true is returned; otherwise
2981 * false is returned and you must handle the Intent yourself.
2982 *
2983 * @see #startActivity
2984 * @see #startActivityForResult
2985 */
2986 public boolean startActivityIfNeeded(Intent intent, int requestCode) {
2987 if (mParent == null) {
2988 int result = IActivityManager.START_RETURN_INTENT_TO_CALLER;
2989 try {
2990 result = ActivityManagerNative.getDefault()
2991 .startActivity(mMainThread.getApplicationThread(),
2992 intent, intent.resolveTypeIfNeeded(
2993 getContentResolver()),
2994 null, 0,
2995 mToken, mEmbeddedID, requestCode, true, false);
2996 } catch (RemoteException e) {
2997 // Empty
2998 }
2999
3000 Instrumentation.checkStartActivityResult(result, intent);
3001
3002 if (requestCode >= 0) {
3003 // If this start is requesting a result, we can avoid making
3004 // the activity visible until the result is received. Setting
3005 // this code during onCreate(Bundle savedInstanceState) or onResume() will keep the
3006 // activity hidden during this time, to avoid flickering.
3007 // This can only be done when a result is requested because
3008 // that guarantees we will get information back when the
3009 // activity is finished, no matter what happens to it.
3010 mStartedActivity = true;
3011 }
3012 return result != IActivityManager.START_RETURN_INTENT_TO_CALLER;
3013 }
3014
3015 throw new UnsupportedOperationException(
3016 "startActivityIfNeeded can only be called from a top-level activity");
3017 }
3018
3019 /**
3020 * Special version of starting an activity, for use when you are replacing
3021 * other activity components. You can use this to hand the Intent off
3022 * to the next Activity that can handle it. You typically call this in
3023 * {@link #onCreate} with the Intent returned by {@link #getIntent}.
3024 *
3025 * @param intent The intent to dispatch to the next activity. For
3026 * correct behavior, this must be the same as the Intent that started
3027 * your own activity; the only changes you can make are to the extras
3028 * inside of it.
3029 *
3030 * @return Returns a boolean indicating whether there was another Activity
3031 * to start: true if there was a next activity to start, false if there
3032 * wasn't. In general, if true is returned you will then want to call
3033 * finish() on yourself.
3034 */
3035 public boolean startNextMatchingActivity(Intent intent) {
3036 if (mParent == null) {
3037 try {
3038 return ActivityManagerNative.getDefault()
3039 .startNextMatchingActivity(mToken, intent);
3040 } catch (RemoteException e) {
3041 // Empty
3042 }
3043 return false;
3044 }
3045
3046 throw new UnsupportedOperationException(
3047 "startNextMatchingActivity can only be called from a top-level activity");
3048 }
3049
3050 /**
3051 * This is called when a child activity of this one calls its
3052 * {@link #startActivity} or {@link #startActivityForResult} method.
3053 *
3054 * <p>This method throws {@link android.content.ActivityNotFoundException}
3055 * if there was no Activity found to run the given Intent.
3056 *
3057 * @param child The activity making the call.
3058 * @param intent The intent to start.
3059 * @param requestCode Reply request code. < 0 if reply is not requested.
3060 *
3061 * @throws android.content.ActivityNotFoundException
3062 *
3063 * @see #startActivity
3064 * @see #startActivityForResult
3065 */
3066 public void startActivityFromChild(Activity child, Intent intent,
3067 int requestCode) {
3068 Instrumentation.ActivityResult ar =
3069 mInstrumentation.execStartActivity(
3070 this, mMainThread.getApplicationThread(), mToken, child,
3071 intent, requestCode);
3072 if (ar != null) {
3073 mMainThread.sendActivityResult(
3074 mToken, child.mEmbeddedID, requestCode,
3075 ar.getResultCode(), ar.getResultData());
3076 }
3077 }
3078
3079 /**
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003080 * Like {@link #startActivityFromChild(Activity, Intent, int)}, but
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003081 * taking a IntentSender; see
Dianne Hackbornae22c052009-09-17 18:46:22 -07003082 * {@link #startIntentSenderForResult(IntentSender, int, Intent, int, int, int)}
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003083 * for more information.
3084 */
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003085 public void startIntentSenderFromChild(Activity child, IntentSender intent,
3086 int requestCode, Intent fillInIntent, int flagsMask, int flagsValues,
3087 int extraFlags)
3088 throws IntentSender.SendIntentException {
3089 startIntentSenderForResultInner(intent, requestCode, fillInIntent,
Dianne Hackbornbcbcaa72009-09-10 10:54:46 -07003090 flagsMask, flagsValues, child);
3091 }
3092
3093 /**
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003094 * Call immediately after one of the flavors of {@link #startActivity(Intent)}
3095 * or {@link #finish} to specify an explicit transition animation to
3096 * perform next.
3097 * @param enterAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07003098 * the incoming activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003099 * @param exitAnim A resource ID of the animation resource to use for
Dianne Hackborn8b571a82009-09-25 16:09:43 -07003100 * the outgoing activity. Use 0 for no animation.
Dianne Hackborn3b3e1452009-09-24 19:22:12 -07003101 */
3102 public void overridePendingTransition(int enterAnim, int exitAnim) {
3103 try {
3104 ActivityManagerNative.getDefault().overridePendingTransition(
3105 mToken, getPackageName(), enterAnim, exitAnim);
3106 } catch (RemoteException e) {
3107 }
3108 }
3109
3110 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003111 * Call this to set the result that your activity will return to its
3112 * caller.
3113 *
3114 * @param resultCode The result code to propagate back to the originating
3115 * activity, often RESULT_CANCELED or RESULT_OK
3116 *
3117 * @see #RESULT_CANCELED
3118 * @see #RESULT_OK
3119 * @see #RESULT_FIRST_USER
3120 * @see #setResult(int, Intent)
3121 */
3122 public final void setResult(int resultCode) {
3123 synchronized (this) {
3124 mResultCode = resultCode;
3125 mResultData = null;
3126 }
3127 }
3128
3129 /**
3130 * Call this to set the result that your activity will return to its
3131 * caller.
3132 *
3133 * @param resultCode The result code to propagate back to the originating
3134 * activity, often RESULT_CANCELED or RESULT_OK
3135 * @param data The data to propagate back to the originating activity.
3136 *
3137 * @see #RESULT_CANCELED
3138 * @see #RESULT_OK
3139 * @see #RESULT_FIRST_USER
3140 * @see #setResult(int)
3141 */
3142 public final void setResult(int resultCode, Intent data) {
3143 synchronized (this) {
3144 mResultCode = resultCode;
3145 mResultData = data;
3146 }
3147 }
3148
3149 /**
3150 * Return the name of the package that invoked this activity. This is who
3151 * the data in {@link #setResult setResult()} will be sent to. You can
3152 * use this information to validate that the recipient is allowed to
3153 * receive the data.
3154 *
3155 * <p>Note: if the calling activity is not expecting a result (that is it
3156 * did not use the {@link #startActivityForResult}
3157 * form that includes a request code), then the calling package will be
3158 * null.
3159 *
3160 * @return The package of the activity that will receive your
3161 * reply, or null if none.
3162 */
3163 public String getCallingPackage() {
3164 try {
3165 return ActivityManagerNative.getDefault().getCallingPackage(mToken);
3166 } catch (RemoteException e) {
3167 return null;
3168 }
3169 }
3170
3171 /**
3172 * Return the name of the activity that invoked this activity. This is
3173 * who the data in {@link #setResult setResult()} will be sent to. You
3174 * can use this information to validate that the recipient is allowed to
3175 * receive the data.
3176 *
3177 * <p>Note: if the calling activity is not expecting a result (that is it
3178 * did not use the {@link #startActivityForResult}
3179 * form that includes a request code), then the calling package will be
3180 * null.
3181 *
3182 * @return String The full name of the activity that will receive your
3183 * reply, or null if none.
3184 */
3185 public ComponentName getCallingActivity() {
3186 try {
3187 return ActivityManagerNative.getDefault().getCallingActivity(mToken);
3188 } catch (RemoteException e) {
3189 return null;
3190 }
3191 }
3192
3193 /**
3194 * Control whether this activity's main window is visible. This is intended
3195 * only for the special case of an activity that is not going to show a
3196 * UI itself, but can't just finish prior to onResume() because it needs
3197 * to wait for a service binding or such. Setting this to false allows
3198 * you to prevent your UI from being shown during that time.
3199 *
3200 * <p>The default value for this is taken from the
3201 * {@link android.R.attr#windowNoDisplay} attribute of the activity's theme.
3202 */
3203 public void setVisible(boolean visible) {
3204 if (mVisibleFromClient != visible) {
3205 mVisibleFromClient = visible;
3206 if (mVisibleFromServer) {
3207 if (visible) makeVisible();
3208 else mDecor.setVisibility(View.INVISIBLE);
3209 }
3210 }
3211 }
3212
3213 void makeVisible() {
3214 if (!mWindowAdded) {
3215 ViewManager wm = getWindowManager();
3216 wm.addView(mDecor, getWindow().getAttributes());
3217 mWindowAdded = true;
3218 }
3219 mDecor.setVisibility(View.VISIBLE);
3220 }
3221
3222 /**
3223 * Check to see whether this activity is in the process of finishing,
3224 * either because you called {@link #finish} on it or someone else
3225 * has requested that it finished. This is often used in
3226 * {@link #onPause} to determine whether the activity is simply pausing or
3227 * completely finishing.
3228 *
3229 * @return If the activity is finishing, returns true; else returns false.
3230 *
3231 * @see #finish
3232 */
3233 public boolean isFinishing() {
3234 return mFinished;
3235 }
3236
3237 /**
3238 * Call this when your activity is done and should be closed. The
3239 * ActivityResult is propagated back to whoever launched you via
3240 * onActivityResult().
3241 */
3242 public void finish() {
3243 if (mParent == null) {
3244 int resultCode;
3245 Intent resultData;
3246 synchronized (this) {
3247 resultCode = mResultCode;
3248 resultData = mResultData;
3249 }
3250 if (Config.LOGV) Log.v(TAG, "Finishing self: token=" + mToken);
3251 try {
3252 if (ActivityManagerNative.getDefault()
3253 .finishActivity(mToken, resultCode, resultData)) {
3254 mFinished = true;
3255 }
3256 } catch (RemoteException e) {
3257 // Empty
3258 }
3259 } else {
3260 mParent.finishFromChild(this);
3261 }
3262 }
3263
3264 /**
3265 * This is called when a child activity of this one calls its
3266 * {@link #finish} method. The default implementation simply calls
3267 * finish() on this activity (the parent), finishing the entire group.
3268 *
3269 * @param child The activity making the call.
3270 *
3271 * @see #finish
3272 */
3273 public void finishFromChild(Activity child) {
3274 finish();
3275 }
3276
3277 /**
3278 * Force finish another activity that you had previously started with
3279 * {@link #startActivityForResult}.
3280 *
3281 * @param requestCode The request code of the activity that you had
3282 * given to startActivityForResult(). If there are multiple
3283 * activities started with this request code, they
3284 * will all be finished.
3285 */
3286 public void finishActivity(int requestCode) {
3287 if (mParent == null) {
3288 try {
3289 ActivityManagerNative.getDefault()
3290 .finishSubActivity(mToken, mEmbeddedID, requestCode);
3291 } catch (RemoteException e) {
3292 // Empty
3293 }
3294 } else {
3295 mParent.finishActivityFromChild(this, requestCode);
3296 }
3297 }
3298
3299 /**
3300 * This is called when a child activity of this one calls its
3301 * finishActivity().
3302 *
3303 * @param child The activity making the call.
3304 * @param requestCode Request code that had been used to start the
3305 * activity.
3306 */
3307 public void finishActivityFromChild(Activity child, int requestCode) {
3308 try {
3309 ActivityManagerNative.getDefault()
3310 .finishSubActivity(mToken, child.mEmbeddedID, requestCode);
3311 } catch (RemoteException e) {
3312 // Empty
3313 }
3314 }
3315
3316 /**
3317 * Called when an activity you launched exits, giving you the requestCode
3318 * you started it with, the resultCode it returned, and any additional
3319 * data from it. The <var>resultCode</var> will be
3320 * {@link #RESULT_CANCELED} if the activity explicitly returned that,
3321 * didn't return any result, or crashed during its operation.
3322 *
3323 * <p>You will receive this call immediately before onResume() when your
3324 * activity is re-starting.
3325 *
3326 * @param requestCode The integer request code originally supplied to
3327 * startActivityForResult(), allowing you to identify who this
3328 * result came from.
3329 * @param resultCode The integer result code returned by the child activity
3330 * through its setResult().
3331 * @param data An Intent, which can return result data to the caller
3332 * (various data can be attached to Intent "extras").
3333 *
3334 * @see #startActivityForResult
3335 * @see #createPendingResult
3336 * @see #setResult(int)
3337 */
3338 protected void onActivityResult(int requestCode, int resultCode,
3339 Intent data) {
3340 }
3341
3342 /**
3343 * Create a new PendingIntent object which you can hand to others
3344 * for them to use to send result data back to your
3345 * {@link #onActivityResult} callback. The created object will be either
3346 * one-shot (becoming invalid after a result is sent back) or multiple
3347 * (allowing any number of results to be sent through it).
3348 *
3349 * @param requestCode Private request code for the sender that will be
3350 * associated with the result data when it is returned. The sender can not
3351 * modify this value, allowing you to identify incoming results.
3352 * @param data Default data to supply in the result, which may be modified
3353 * by the sender.
3354 * @param flags May be {@link PendingIntent#FLAG_ONE_SHOT PendingIntent.FLAG_ONE_SHOT},
3355 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE},
3356 * {@link PendingIntent#FLAG_CANCEL_CURRENT PendingIntent.FLAG_CANCEL_CURRENT},
3357 * {@link PendingIntent#FLAG_UPDATE_CURRENT PendingIntent.FLAG_UPDATE_CURRENT},
3358 * or any of the flags as supported by
3359 * {@link Intent#fillIn Intent.fillIn()} to control which unspecified parts
3360 * of the intent that can be supplied when the actual send happens.
3361 *
3362 * @return Returns an existing or new PendingIntent matching the given
3363 * parameters. May return null only if
3364 * {@link PendingIntent#FLAG_NO_CREATE PendingIntent.FLAG_NO_CREATE} has been
3365 * supplied.
3366 *
3367 * @see PendingIntent
3368 */
3369 public PendingIntent createPendingResult(int requestCode, Intent data,
3370 int flags) {
3371 String packageName = getPackageName();
3372 try {
3373 IIntentSender target =
3374 ActivityManagerNative.getDefault().getIntentSender(
3375 IActivityManager.INTENT_SENDER_ACTIVITY_RESULT, packageName,
3376 mParent == null ? mToken : mParent.mToken,
3377 mEmbeddedID, requestCode, data, null, flags);
3378 return target != null ? new PendingIntent(target) : null;
3379 } catch (RemoteException e) {
3380 // Empty
3381 }
3382 return null;
3383 }
3384
3385 /**
3386 * Change the desired orientation of this activity. If the activity
3387 * is currently in the foreground or otherwise impacting the screen
3388 * orientation, the screen will immediately be changed (possibly causing
3389 * the activity to be restarted). Otherwise, this will be used the next
3390 * time the activity is visible.
3391 *
3392 * @param requestedOrientation An orientation constant as used in
3393 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
3394 */
3395 public void setRequestedOrientation(int requestedOrientation) {
3396 if (mParent == null) {
3397 try {
3398 ActivityManagerNative.getDefault().setRequestedOrientation(
3399 mToken, requestedOrientation);
3400 } catch (RemoteException e) {
3401 // Empty
3402 }
3403 } else {
3404 mParent.setRequestedOrientation(requestedOrientation);
3405 }
3406 }
3407
3408 /**
3409 * Return the current requested orientation of the activity. This will
3410 * either be the orientation requested in its component's manifest, or
3411 * the last requested orientation given to
3412 * {@link #setRequestedOrientation(int)}.
3413 *
3414 * @return Returns an orientation constant as used in
3415 * {@link ActivityInfo#screenOrientation ActivityInfo.screenOrientation}.
3416 */
3417 public int getRequestedOrientation() {
3418 if (mParent == null) {
3419 try {
3420 return ActivityManagerNative.getDefault()
3421 .getRequestedOrientation(mToken);
3422 } catch (RemoteException e) {
3423 // Empty
3424 }
3425 } else {
3426 return mParent.getRequestedOrientation();
3427 }
3428 return ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED;
3429 }
3430
3431 /**
3432 * Return the identifier of the task this activity is in. This identifier
3433 * will remain the same for the lifetime of the activity.
3434 *
3435 * @return Task identifier, an opaque integer.
3436 */
3437 public int getTaskId() {
3438 try {
3439 return ActivityManagerNative.getDefault()
3440 .getTaskForActivity(mToken, false);
3441 } catch (RemoteException e) {
3442 return -1;
3443 }
3444 }
3445
3446 /**
3447 * Return whether this activity is the root of a task. The root is the
3448 * first activity in a task.
3449 *
3450 * @return True if this is the root activity, else false.
3451 */
3452 public boolean isTaskRoot() {
3453 try {
3454 return ActivityManagerNative.getDefault()
3455 .getTaskForActivity(mToken, true) >= 0;
3456 } catch (RemoteException e) {
3457 return false;
3458 }
3459 }
3460
3461 /**
3462 * Move the task containing this activity to the back of the activity
3463 * stack. The activity's order within the task is unchanged.
3464 *
3465 * @param nonRoot If false then this only works if the activity is the root
3466 * of a task; if true it will work for any activity in
3467 * a task.
3468 *
3469 * @return If the task was moved (or it was already at the
3470 * back) true is returned, else false.
3471 */
3472 public boolean moveTaskToBack(boolean nonRoot) {
3473 try {
3474 return ActivityManagerNative.getDefault().moveActivityTaskToBack(
3475 mToken, nonRoot);
3476 } catch (RemoteException e) {
3477 // Empty
3478 }
3479 return false;
3480 }
3481
3482 /**
3483 * Returns class name for this activity with the package prefix removed.
3484 * This is the default name used to read and write settings.
3485 *
3486 * @return The local class name.
3487 */
3488 public String getLocalClassName() {
3489 final String pkg = getPackageName();
3490 final String cls = mComponent.getClassName();
3491 int packageLen = pkg.length();
3492 if (!cls.startsWith(pkg) || cls.length() <= packageLen
3493 || cls.charAt(packageLen) != '.') {
3494 return cls;
3495 }
3496 return cls.substring(packageLen+1);
3497 }
3498
3499 /**
3500 * Returns complete component name of this activity.
3501 *
3502 * @return Returns the complete component name for this activity
3503 */
3504 public ComponentName getComponentName()
3505 {
3506 return mComponent;
3507 }
3508
3509 /**
3510 * Retrieve a {@link SharedPreferences} object for accessing preferences
3511 * that are private to this activity. This simply calls the underlying
3512 * {@link #getSharedPreferences(String, int)} method by passing in this activity's
3513 * class name as the preferences name.
3514 *
3515 * @param mode Operating mode. Use {@link #MODE_PRIVATE} for the default
3516 * operation, {@link #MODE_WORLD_READABLE} and
3517 * {@link #MODE_WORLD_WRITEABLE} to control permissions.
3518 *
3519 * @return Returns the single SharedPreferences instance that can be used
3520 * to retrieve and modify the preference values.
3521 */
3522 public SharedPreferences getPreferences(int mode) {
3523 return getSharedPreferences(getLocalClassName(), mode);
3524 }
3525
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003526 private void ensureSearchManager() {
3527 if (mSearchManager != null) {
3528 return;
3529 }
3530
Amith Yamasanie9ce3f02010-01-25 09:15:50 -08003531 mSearchManager = new SearchManager(this, null);
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003532 }
3533
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003534 @Override
3535 public Object getSystemService(String name) {
3536 if (getBaseContext() == null) {
3537 throw new IllegalStateException(
3538 "System services not available to Activities before onCreate()");
3539 }
3540
3541 if (WINDOW_SERVICE.equals(name)) {
3542 return mWindowManager;
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003543 } else if (SEARCH_SERVICE.equals(name)) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003544 ensureSearchManager();
Bjorn Bringert8d17f3f2009-06-05 13:22:28 +01003545 return mSearchManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003546 }
3547 return super.getSystemService(name);
3548 }
3549
3550 /**
3551 * Change the title associated with this activity. If this is a
3552 * top-level activity, the title for its window will change. If it
3553 * is an embedded activity, the parent can do whatever it wants
3554 * with it.
3555 */
3556 public void setTitle(CharSequence title) {
3557 mTitle = title;
3558 onTitleChanged(title, mTitleColor);
3559
3560 if (mParent != null) {
3561 mParent.onChildTitleChanged(this, title);
3562 }
3563 }
3564
3565 /**
3566 * Change the title associated with this activity. If this is a
3567 * top-level activity, the title for its window will change. If it
3568 * is an embedded activity, the parent can do whatever it wants
3569 * with it.
3570 */
3571 public void setTitle(int titleId) {
3572 setTitle(getText(titleId));
3573 }
3574
3575 public void setTitleColor(int textColor) {
3576 mTitleColor = textColor;
3577 onTitleChanged(mTitle, textColor);
3578 }
3579
3580 public final CharSequence getTitle() {
3581 return mTitle;
3582 }
3583
3584 public final int getTitleColor() {
3585 return mTitleColor;
3586 }
3587
3588 protected void onTitleChanged(CharSequence title, int color) {
3589 if (mTitleReady) {
3590 final Window win = getWindow();
3591 if (win != null) {
3592 win.setTitle(title);
3593 if (color != 0) {
3594 win.setTitleColor(color);
3595 }
3596 }
3597 }
3598 }
3599
3600 protected void onChildTitleChanged(Activity childActivity, CharSequence title) {
3601 }
3602
3603 /**
3604 * Sets the visibility of the progress bar in the title.
3605 * <p>
3606 * In order for the progress bar to be shown, the feature must be requested
3607 * via {@link #requestWindowFeature(int)}.
3608 *
3609 * @param visible Whether to show the progress bars in the title.
3610 */
3611 public final void setProgressBarVisibility(boolean visible) {
3612 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, visible ? Window.PROGRESS_VISIBILITY_ON :
3613 Window.PROGRESS_VISIBILITY_OFF);
3614 }
3615
3616 /**
3617 * Sets the visibility of the indeterminate progress bar in the title.
3618 * <p>
3619 * In order for the progress bar to be shown, the feature must be requested
3620 * via {@link #requestWindowFeature(int)}.
3621 *
3622 * @param visible Whether to show the progress bars in the title.
3623 */
3624 public final void setProgressBarIndeterminateVisibility(boolean visible) {
3625 getWindow().setFeatureInt(Window.FEATURE_INDETERMINATE_PROGRESS,
3626 visible ? Window.PROGRESS_VISIBILITY_ON : Window.PROGRESS_VISIBILITY_OFF);
3627 }
3628
3629 /**
3630 * Sets whether the horizontal progress bar in the title should be indeterminate (the circular
3631 * is always indeterminate).
3632 * <p>
3633 * In order for the progress bar to be shown, the feature must be requested
3634 * via {@link #requestWindowFeature(int)}.
3635 *
3636 * @param indeterminate Whether the horizontal progress bar should be indeterminate.
3637 */
3638 public final void setProgressBarIndeterminate(boolean indeterminate) {
3639 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
3640 indeterminate ? Window.PROGRESS_INDETERMINATE_ON : Window.PROGRESS_INDETERMINATE_OFF);
3641 }
3642
3643 /**
3644 * Sets the progress for the progress bars in the title.
3645 * <p>
3646 * In order for the progress bar to be shown, the feature must be requested
3647 * via {@link #requestWindowFeature(int)}.
3648 *
3649 * @param progress The progress for the progress bar. Valid ranges are from
3650 * 0 to 10000 (both inclusive). If 10000 is given, the progress
3651 * bar will be completely filled and will fade out.
3652 */
3653 public final void setProgress(int progress) {
3654 getWindow().setFeatureInt(Window.FEATURE_PROGRESS, progress + Window.PROGRESS_START);
3655 }
3656
3657 /**
3658 * Sets the secondary progress for the progress bar in the title. This
3659 * progress is drawn between the primary progress (set via
3660 * {@link #setProgress(int)} and the background. It can be ideal for media
3661 * scenarios such as showing the buffering progress while the default
3662 * progress shows the play progress.
3663 * <p>
3664 * In order for the progress bar to be shown, the feature must be requested
3665 * via {@link #requestWindowFeature(int)}.
3666 *
3667 * @param secondaryProgress The secondary progress for the progress bar. Valid ranges are from
3668 * 0 to 10000 (both inclusive).
3669 */
3670 public final void setSecondaryProgress(int secondaryProgress) {
3671 getWindow().setFeatureInt(Window.FEATURE_PROGRESS,
3672 secondaryProgress + Window.PROGRESS_SECONDARY_START);
3673 }
3674
3675 /**
3676 * Suggests an audio stream whose volume should be changed by the hardware
3677 * volume controls.
3678 * <p>
3679 * The suggested audio stream will be tied to the window of this Activity.
3680 * If the Activity is switched, the stream set here is no longer the
3681 * suggested stream. The client does not need to save and restore the old
3682 * suggested stream value in onPause and onResume.
3683 *
3684 * @param streamType The type of the audio stream whose volume should be
3685 * changed by the hardware volume controls. It is not guaranteed that
3686 * the hardware volume controls will always change this stream's
3687 * volume (for example, if a call is in progress, its stream's volume
3688 * may be changed instead). To reset back to the default, use
3689 * {@link AudioManager#USE_DEFAULT_STREAM_TYPE}.
3690 */
3691 public final void setVolumeControlStream(int streamType) {
3692 getWindow().setVolumeControlStream(streamType);
3693 }
3694
3695 /**
3696 * Gets the suggested audio stream whose volume should be changed by the
3697 * harwdare volume controls.
3698 *
3699 * @return The suggested audio stream type whose volume should be changed by
3700 * the hardware volume controls.
3701 * @see #setVolumeControlStream(int)
3702 */
3703 public final int getVolumeControlStream() {
3704 return getWindow().getVolumeControlStream();
3705 }
3706
3707 /**
3708 * Runs the specified action on the UI thread. If the current thread is the UI
3709 * thread, then the action is executed immediately. If the current thread is
3710 * not the UI thread, the action is posted to the event queue of the UI thread.
3711 *
3712 * @param action the action to run on the UI thread
3713 */
3714 public final void runOnUiThread(Runnable action) {
3715 if (Thread.currentThread() != mUiThread) {
3716 mHandler.post(action);
3717 } else {
3718 action.run();
3719 }
3720 }
3721
3722 /**
3723 * Stub implementation of {@link android.view.LayoutInflater.Factory#onCreateView} used when
3724 * inflating with the LayoutInflater returned by {@link #getSystemService}. This
3725 * implementation simply returns null for all view names.
3726 *
3727 * @see android.view.LayoutInflater#createView
3728 * @see android.view.Window#getLayoutInflater
3729 */
3730 public View onCreateView(String name, Context context, AttributeSet attrs) {
3731 return null;
3732 }
3733
3734 // ------------------ Internal API ------------------
3735
3736 final void setParent(Activity parent) {
3737 mParent = parent;
3738 }
3739
3740 final void attach(Context context, ActivityThread aThread, Instrumentation instr, IBinder token,
3741 Application application, Intent intent, ActivityInfo info, CharSequence title,
3742 Activity parent, String id, Object lastNonConfigurationInstance,
3743 Configuration config) {
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003744 attach(context, aThread, instr, token, 0, application, intent, info, title, parent, id,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003745 lastNonConfigurationInstance, null, config);
3746 }
3747
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003748 final void attach(Context context, ActivityThread aThread,
3749 Instrumentation instr, IBinder token, int ident,
3750 Application application, Intent intent, ActivityInfo info,
3751 CharSequence title, Activity parent, String id,
3752 Object lastNonConfigurationInstance,
3753 HashMap<String,Object> lastNonConfigurationChildInstances,
3754 Configuration config) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003755 attachBaseContext(context);
3756
3757 mWindow = PolicyManager.makeNewWindow(this);
3758 mWindow.setCallback(this);
3759 if (info.softInputMode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
3760 mWindow.setSoftInputMode(info.softInputMode);
3761 }
3762 mUiThread = Thread.currentThread();
3763
3764 mMainThread = aThread;
3765 mInstrumentation = instr;
3766 mToken = token;
Dianne Hackbornb06ea702009-07-13 13:07:51 -07003767 mIdent = ident;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003768 mApplication = application;
3769 mIntent = intent;
3770 mComponent = intent.getComponent();
3771 mActivityInfo = info;
3772 mTitle = title;
3773 mParent = parent;
3774 mEmbeddedID = id;
3775 mLastNonConfigurationInstance = lastNonConfigurationInstance;
3776 mLastNonConfigurationChildInstances = lastNonConfigurationChildInstances;
3777
3778 mWindow.setWindowManager(null, mToken, mComponent.flattenToString());
3779 if (mParent != null) {
3780 mWindow.setContainer(mParent.getWindow());
3781 }
3782 mWindowManager = mWindow.getWindowManager();
3783 mCurrentConfig = config;
3784 }
3785
3786 final IBinder getActivityToken() {
3787 return mParent != null ? mParent.getActivityToken() : mToken;
3788 }
3789
3790 final void performStart() {
3791 mCalled = false;
3792 mInstrumentation.callActivityOnStart(this);
3793 if (!mCalled) {
3794 throw new SuperNotCalledException(
3795 "Activity " + mComponent.toShortString() +
3796 " did not call through to super.onStart()");
3797 }
3798 }
3799
3800 final void performRestart() {
Makoto Onuki2f6a0182010-02-22 13:26:59 -08003801 synchronized (mManagedCursors) {
3802 final int N = mManagedCursors.size();
3803 for (int i=0; i<N; i++) {
3804 ManagedCursor mc = mManagedCursors.get(i);
3805 if (mc.mReleased || mc.mUpdated) {
3806 mc.mCursor.requery();
3807 mc.mReleased = false;
3808 mc.mUpdated = false;
3809 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003810 }
3811 }
3812
3813 if (mStopped) {
3814 mStopped = false;
3815 mCalled = false;
3816 mInstrumentation.callActivityOnRestart(this);
3817 if (!mCalled) {
3818 throw new SuperNotCalledException(
3819 "Activity " + mComponent.toShortString() +
3820 " did not call through to super.onRestart()");
3821 }
3822 performStart();
3823 }
3824 }
3825
3826 final void performResume() {
3827 performRestart();
3828
3829 mLastNonConfigurationInstance = null;
3830
3831 // First call onResume() -before- setting mResumed, so we don't
3832 // send out any status bar / menu notifications the client makes.
3833 mCalled = false;
3834 mInstrumentation.callActivityOnResume(this);
3835 if (!mCalled) {
3836 throw new SuperNotCalledException(
3837 "Activity " + mComponent.toShortString() +
3838 " did not call through to super.onResume()");
3839 }
3840
3841 // Now really resume, and install the current status bar and menu.
3842 mResumed = true;
3843 mCalled = false;
3844 onPostResume();
3845 if (!mCalled) {
3846 throw new SuperNotCalledException(
3847 "Activity " + mComponent.toShortString() +
3848 " did not call through to super.onPostResume()");
3849 }
3850 }
3851
3852 final void performPause() {
Dianne Hackborne794e9f2010-08-24 12:32:10 -07003853 mCalled = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003854 onPause();
Dianne Hackborne794e9f2010-08-24 12:32:10 -07003855 if (!mCalled && getApplicationInfo().targetSdkVersion
3856 >= android.os.Build.VERSION_CODES.GINGERBREAD) {
3857 throw new SuperNotCalledException(
3858 "Activity " + mComponent.toShortString() +
3859 " did not call through to super.onPause()");
3860 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003861 }
3862
3863 final void performUserLeaving() {
3864 onUserInteraction();
3865 onUserLeaveHint();
3866 }
3867
3868 final void performStop() {
3869 if (!mStopped) {
3870 if (mWindow != null) {
3871 mWindow.closeAllPanels();
3872 }
3873
3874 mCalled = false;
3875 mInstrumentation.callActivityOnStop(this);
3876 if (!mCalled) {
3877 throw new SuperNotCalledException(
3878 "Activity " + mComponent.toShortString() +
3879 " did not call through to super.onStop()");
3880 }
3881
Makoto Onuki2f6a0182010-02-22 13:26:59 -08003882 synchronized (mManagedCursors) {
3883 final int N = mManagedCursors.size();
3884 for (int i=0; i<N; i++) {
3885 ManagedCursor mc = mManagedCursors.get(i);
3886 if (!mc.mReleased) {
3887 mc.mCursor.deactivate();
3888 mc.mReleased = true;
3889 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003890 }
3891 }
3892
3893 mStopped = true;
3894 }
3895 mResumed = false;
3896 }
3897
3898 final boolean isResumed() {
3899 return mResumed;
3900 }
3901
3902 void dispatchActivityResult(String who, int requestCode,
3903 int resultCode, Intent data) {
3904 if (Config.LOGV) Log.v(
3905 TAG, "Dispatching result: who=" + who + ", reqCode=" + requestCode
3906 + ", resCode=" + resultCode + ", data=" + data);
3907 if (who == null) {
3908 onActivityResult(requestCode, resultCode, data);
3909 }
3910 }
3911}