ActivityInfo.java revision 7d19e0242faac8017033dabb872cdf1542fa184c
1/* 2 * Copyright (C) 2007 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.content.pm; 18 19import android.os.Parcel; 20import android.os.Parcelable; 21import android.util.Printer; 22 23/** 24 * Information you can retrieve about a particular application 25 * activity or receiver. This corresponds to information collected 26 * from the AndroidManifest.xml's <activity> and 27 * <receiver> tags. 28 */ 29public class ActivityInfo extends ComponentInfo 30 implements Parcelable { 31 /** 32 * A style resource identifier (in the package's resources) of this 33 * activity's theme. From the "theme" attribute or, if not set, 0. 34 */ 35 public int theme; 36 37 /** 38 * Constant corresponding to <code>standard</code> in 39 * the {@link android.R.attr#launchMode} attribute. 40 */ 41 public static final int LAUNCH_MULTIPLE = 0; 42 /** 43 * Constant corresponding to <code>singleTop</code> in 44 * the {@link android.R.attr#launchMode} attribute. 45 */ 46 public static final int LAUNCH_SINGLE_TOP = 1; 47 /** 48 * Constant corresponding to <code>singleTask</code> in 49 * the {@link android.R.attr#launchMode} attribute. 50 */ 51 public static final int LAUNCH_SINGLE_TASK = 2; 52 /** 53 * Constant corresponding to <code>singleInstance</code> in 54 * the {@link android.R.attr#launchMode} attribute. 55 */ 56 public static final int LAUNCH_SINGLE_INSTANCE = 3; 57 /** 58 * The launch mode style requested by the activity. From the 59 * {@link android.R.attr#launchMode} attribute, one of 60 * {@link #LAUNCH_MULTIPLE}, 61 * {@link #LAUNCH_SINGLE_TOP}, {@link #LAUNCH_SINGLE_TASK}, or 62 * {@link #LAUNCH_SINGLE_INSTANCE}. 63 */ 64 public int launchMode; 65 66 /** 67 * Optional name of a permission required to be able to access this 68 * Activity. From the "permission" attribute. 69 */ 70 public String permission; 71 72 /** 73 * The affinity this activity has for another task in the system. The 74 * string here is the name of the task, often the package name of the 75 * overall package. If null, the activity has no affinity. Set from the 76 * {@link android.R.attr#taskAffinity} attribute. 77 */ 78 public String taskAffinity; 79 80 /** 81 * If this is an activity alias, this is the real activity class to run 82 * for it. Otherwise, this is null. 83 */ 84 public String targetActivity; 85 86 /** 87 * Bit in {@link #flags} indicating whether this activity is able to 88 * run in multiple processes. If 89 * true, the system may instantiate it in the some process as the 90 * process starting it in order to conserve resources. If false, the 91 * default, it always runs in {@link #processName}. Set from the 92 * {@link android.R.attr#multiprocess} attribute. 93 */ 94 public static final int FLAG_MULTIPROCESS = 0x0001; 95 /** 96 * Bit in {@link #flags} indicating that, when the activity's task is 97 * relaunched from home, this activity should be finished. 98 * Set from the 99 * {@link android.R.attr#finishOnTaskLaunch} attribute. 100 */ 101 public static final int FLAG_FINISH_ON_TASK_LAUNCH = 0x0002; 102 /** 103 * Bit in {@link #flags} indicating that, when the activity is the root 104 * of a task, that task's stack should be cleared each time the user 105 * re-launches it from home. As a result, the user will always 106 * return to the original activity at the top of the task. 107 * This flag only applies to activities that 108 * are used to start the root of a new task. Set from the 109 * {@link android.R.attr#clearTaskOnLaunch} attribute. 110 */ 111 public static final int FLAG_CLEAR_TASK_ON_LAUNCH = 0x0004; 112 /** 113 * Bit in {@link #flags} indicating that, when the activity is the root 114 * of a task, that task's stack should never be cleared when it is 115 * relaunched from home. Set from the 116 * {@link android.R.attr#alwaysRetainTaskState} attribute. 117 */ 118 public static final int FLAG_ALWAYS_RETAIN_TASK_STATE = 0x0008; 119 /** 120 * Bit in {@link #flags} indicating that the activity's state 121 * is not required to be saved, so that if there is a failure the 122 * activity will not be removed from the activity stack. Set from the 123 * {@link android.R.attr#stateNotNeeded} attribute. 124 */ 125 public static final int FLAG_STATE_NOT_NEEDED = 0x0010; 126 /** 127 * Bit in {@link #flags} that indicates that the activity should not 128 * appear in the list of recently launched activities. Set from the 129 * {@link android.R.attr#excludeFromRecents} attribute. 130 */ 131 public static final int FLAG_EXCLUDE_FROM_RECENTS = 0x0020; 132 /** 133 * Bit in {@link #flags} that indicates that the activity can be moved 134 * between tasks based on its task affinity. Set from the 135 * {@link android.R.attr#allowTaskReparenting} attribute. 136 */ 137 public static final int FLAG_ALLOW_TASK_REPARENTING = 0x0040; 138 /** 139 * Bit in {@link #flags} indicating that, when the user navigates away 140 * from an activity, it should be finished. 141 * Set from the 142 * {@link android.R.attr#noHistory} attribute. 143 */ 144 public static final int FLAG_NO_HISTORY = 0x0080; 145 /** 146 * Bit in {@link #flags} indicating that, when a request to close system 147 * windows happens, this activity is finished. 148 * Set from the 149 * {@link android.R.attr#finishOnCloseSystemDialogs} attribute. 150 */ 151 public static final int FLAG_FINISH_ON_CLOSE_SYSTEM_DIALOGS = 0x0100; 152 /** 153 * Value for {@link #flags}: true when the application's rendering should 154 * be hardware accelerated. 155 */ 156 public static final int FLAG_HARDWARE_ACCELERATED = 0x0200; 157 /** 158 * @hide 159 * Bit in {@link #flags} corresponding to an immersive activity 160 * that wishes not to be interrupted by notifications. 161 * Applications that hide the system notification bar with 162 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN} 163 * may still be interrupted by high-priority notifications; for example, an 164 * incoming phone call may use 165 * {@link android.app.Notification#fullScreenIntent fullScreenIntent} 166 * to present a full-screen in-call activity to the user, pausing the 167 * current activity as a side-effect. An activity with 168 * {@link #FLAG_IMMERSIVE} set, however, will not be interrupted; the 169 * notification may be shown in some other way (such as a small floating 170 * "toast" window). 171 * {@see android.app.Notification#FLAG_HIGH_PRIORITY} 172 */ 173 public static final int FLAG_IMMERSIVE = 0x0400; 174 /** 175 * Bit in {@link #flags}: If set, a single instance of the receiver will 176 * run for all users on the device. Set from the 177 * {@link android.R.attr#singleUser} attribute. Note that this flag is 178 * only relevent for ActivityInfo structures that are describiner receiver 179 * components; it is not applied to activities. 180 */ 181 public static final int FLAG_SINGLE_USER = 0x40000000; 182 /** 183 * Options that have been set in the activity declaration in the 184 * manifest. 185 * These include: 186 * {@link #FLAG_MULTIPROCESS}, 187 * {@link #FLAG_FINISH_ON_TASK_LAUNCH}, {@link #FLAG_CLEAR_TASK_ON_LAUNCH}, 188 * {@link #FLAG_ALWAYS_RETAIN_TASK_STATE}, 189 * {@link #FLAG_STATE_NOT_NEEDED}, {@link #FLAG_EXCLUDE_FROM_RECENTS}, 190 * {@link #FLAG_ALLOW_TASK_REPARENTING}, {@link #FLAG_NO_HISTORY}, 191 * {@link #FLAG_FINISH_ON_CLOSE_SYSTEM_DIALOGS}, 192 * {@link #FLAG_HARDWARE_ACCELERATED}, {@link #FLAG_SINGLE_USER}. 193 */ 194 public int flags; 195 196 /** 197 * Constant corresponding to <code>unspecified</code> in 198 * the {@link android.R.attr#screenOrientation} attribute. 199 */ 200 public static final int SCREEN_ORIENTATION_UNSPECIFIED = -1; 201 /** 202 * Constant corresponding to <code>landscape</code> in 203 * the {@link android.R.attr#screenOrientation} attribute. 204 */ 205 public static final int SCREEN_ORIENTATION_LANDSCAPE = 0; 206 /** 207 * Constant corresponding to <code>portrait</code> in 208 * the {@link android.R.attr#screenOrientation} attribute. 209 */ 210 public static final int SCREEN_ORIENTATION_PORTRAIT = 1; 211 /** 212 * Constant corresponding to <code>user</code> in 213 * the {@link android.R.attr#screenOrientation} attribute. 214 */ 215 public static final int SCREEN_ORIENTATION_USER = 2; 216 /** 217 * Constant corresponding to <code>behind</code> in 218 * the {@link android.R.attr#screenOrientation} attribute. 219 */ 220 public static final int SCREEN_ORIENTATION_BEHIND = 3; 221 /** 222 * Constant corresponding to <code>sensor</code> in 223 * the {@link android.R.attr#screenOrientation} attribute. 224 */ 225 public static final int SCREEN_ORIENTATION_SENSOR = 4; 226 227 /** 228 * Constant corresponding to <code>nosensor</code> in 229 * the {@link android.R.attr#screenOrientation} attribute. 230 */ 231 public static final int SCREEN_ORIENTATION_NOSENSOR = 5; 232 233 /** 234 * Constant corresponding to <code>sensorLandscape</code> in 235 * the {@link android.R.attr#screenOrientation} attribute. 236 */ 237 public static final int SCREEN_ORIENTATION_SENSOR_LANDSCAPE = 6; 238 239 /** 240 * Constant corresponding to <code>sensorPortrait</code> in 241 * the {@link android.R.attr#screenOrientation} attribute. 242 */ 243 public static final int SCREEN_ORIENTATION_SENSOR_PORTRAIT = 7; 244 245 /** 246 * Constant corresponding to <code>reverseLandscape</code> in 247 * the {@link android.R.attr#screenOrientation} attribute. 248 */ 249 public static final int SCREEN_ORIENTATION_REVERSE_LANDSCAPE = 8; 250 251 /** 252 * Constant corresponding to <code>reversePortrait</code> in 253 * the {@link android.R.attr#screenOrientation} attribute. 254 */ 255 public static final int SCREEN_ORIENTATION_REVERSE_PORTRAIT = 9; 256 257 /** 258 * Constant corresponding to <code>fullSensor</code> in 259 * the {@link android.R.attr#screenOrientation} attribute. 260 */ 261 public static final int SCREEN_ORIENTATION_FULL_SENSOR = 10; 262 263 /** 264 * The preferred screen orientation this activity would like to run in. 265 * From the {@link android.R.attr#screenOrientation} attribute, one of 266 * {@link #SCREEN_ORIENTATION_UNSPECIFIED}, 267 * {@link #SCREEN_ORIENTATION_LANDSCAPE}, 268 * {@link #SCREEN_ORIENTATION_PORTRAIT}, 269 * {@link #SCREEN_ORIENTATION_USER}, 270 * {@link #SCREEN_ORIENTATION_BEHIND}, 271 * {@link #SCREEN_ORIENTATION_SENSOR}, 272 * {@link #SCREEN_ORIENTATION_NOSENSOR}, 273 * {@link #SCREEN_ORIENTATION_SENSOR_LANDSCAPE}, 274 * {@link #SCREEN_ORIENTATION_SENSOR_PORTRAIT}, 275 * {@link #SCREEN_ORIENTATION_REVERSE_LANDSCAPE}, 276 * {@link #SCREEN_ORIENTATION_REVERSE_PORTRAIT}, 277 * {@link #SCREEN_ORIENTATION_FULL_SENSOR}. 278 */ 279 public int screenOrientation = SCREEN_ORIENTATION_UNSPECIFIED; 280 281 /** 282 * Bit in {@link #configChanges} that indicates that the activity 283 * can itself handle changes to the IMSI MCC. Set from the 284 * {@link android.R.attr#configChanges} attribute. 285 */ 286 public static final int CONFIG_MCC = 0x0001; 287 /** 288 * Bit in {@link #configChanges} that indicates that the activity 289 * can itself handle changes to the IMSI MNC. Set from the 290 * {@link android.R.attr#configChanges} attribute. 291 */ 292 public static final int CONFIG_MNC = 0x0002; 293 /** 294 * Bit in {@link #configChanges} that indicates that the activity 295 * can itself handle changes to the locale. Set from the 296 * {@link android.R.attr#configChanges} attribute. 297 */ 298 public static final int CONFIG_LOCALE = 0x0004; 299 /** 300 * Bit in {@link #configChanges} that indicates that the activity 301 * can itself handle changes to the touchscreen type. Set from the 302 * {@link android.R.attr#configChanges} attribute. 303 */ 304 public static final int CONFIG_TOUCHSCREEN = 0x0008; 305 /** 306 * Bit in {@link #configChanges} that indicates that the activity 307 * can itself handle changes to the keyboard type. Set from the 308 * {@link android.R.attr#configChanges} attribute. 309 */ 310 public static final int CONFIG_KEYBOARD = 0x0010; 311 /** 312 * Bit in {@link #configChanges} that indicates that the activity 313 * can itself handle changes to the keyboard or navigation being hidden/exposed. 314 * Note that inspite of the name, this applies to the changes to any 315 * hidden states: keyboard or navigation. 316 * Set from the {@link android.R.attr#configChanges} attribute. 317 */ 318 public static final int CONFIG_KEYBOARD_HIDDEN = 0x0020; 319 /** 320 * Bit in {@link #configChanges} that indicates that the activity 321 * can itself handle changes to the navigation type. Set from the 322 * {@link android.R.attr#configChanges} attribute. 323 */ 324 public static final int CONFIG_NAVIGATION = 0x0040; 325 /** 326 * Bit in {@link #configChanges} that indicates that the activity 327 * can itself handle changes to the screen orientation. Set from the 328 * {@link android.R.attr#configChanges} attribute. 329 */ 330 public static final int CONFIG_ORIENTATION = 0x0080; 331 /** 332 * Bit in {@link #configChanges} that indicates that the activity 333 * can itself handle changes to the screen layout. Set from the 334 * {@link android.R.attr#configChanges} attribute. 335 */ 336 public static final int CONFIG_SCREEN_LAYOUT = 0x0100; 337 /** 338 * Bit in {@link #configChanges} that indicates that the activity 339 * can itself handle the ui mode. Set from the 340 * {@link android.R.attr#configChanges} attribute. 341 */ 342 public static final int CONFIG_UI_MODE = 0x0200; 343 /** 344 * Bit in {@link #configChanges} that indicates that the activity 345 * can itself handle the screen size. Set from the 346 * {@link android.R.attr#configChanges} attribute. This will be 347 * set by default for applications that target an earlier version 348 * than {@link android.os.Build.VERSION_CODES#HONEYCOMB_MR2}... 349 * <b>however</b>, you will not see the bit set here becomes some 350 * applications incorrectly compare {@link #configChanges} against 351 * an absolute value rather than correctly masking out the bits 352 * they are interested in. Please don't do that, thanks. 353 */ 354 public static final int CONFIG_SCREEN_SIZE = 0x0400; 355 /** 356 * Bit in {@link #configChanges} that indicates that the activity 357 * can itself handle the smallest screen size. Set from the 358 * {@link android.R.attr#configChanges} attribute. This will be 359 * set by default for applications that target an earlier version 360 * than {@link android.os.Build.VERSION_CODES#HONEYCOMB_MR2}... 361 * <b>however</b>, you will not see the bit set here becomes some 362 * applications incorrectly compare {@link #configChanges} against 363 * an absolute value rather than correctly masking out the bits 364 * they are interested in. Please don't do that, thanks. 365 */ 366 public static final int CONFIG_SMALLEST_SCREEN_SIZE = 0x0800; 367 /** 368 * Bit in {@link #configChanges} that indicates that the activity 369 * can itself handle density changes. Set from the 370 * {@link android.R.attr#configChanges} attribute. 371 */ 372 public static final int CONFIG_DENSITY = 0x1000; 373 /** 374 * Bit in {@link #configChanges} that indicates that the activity 375 * can itself handle changes to the font scaling factor. Set from the 376 * {@link android.R.attr#configChanges} attribute. This is 377 * not a core resource configutation, but a higher-level value, so its 378 * constant starts at the high bits. 379 */ 380 public static final int CONFIG_FONT_SCALE = 0x40000000; 381 382 /** @hide 383 * Unfortunately the constants for config changes in native code are 384 * different from ActivityInfo. :( Here are the values we should use for the 385 * native side given the bit we have assigned in ActivityInfo. 386 */ 387 public static int[] CONFIG_NATIVE_BITS = new int[] { 388 0x0001, // MNC 389 0x0002, // MCC 390 0x0004, // LOCALE 391 0x0008, // TOUCH SCREEN 392 0x0010, // KEYBOARD 393 0x0020, // KEYBOARD HIDDEN 394 0x0040, // NAVIGATION 395 0x0080, // ORIENTATION 396 0x0800, // SCREEN LAYOUT 397 0x1000, // UI MODE 398 0x0200, // SCREEN SIZE 399 0x2000, // SMALLEST SCREEN SIZE 400 0x0100, // DENSITY 401 }; 402 /** @hide 403 * Convert Java change bits to native. 404 */ 405 public static int activityInfoConfigToNative(int input) { 406 int output = 0; 407 for (int i=0; i<CONFIG_NATIVE_BITS.length; i++) { 408 if ((input&(1<<i)) != 0) { 409 output |= CONFIG_NATIVE_BITS[i]; 410 } 411 } 412 return output; 413 } 414 415 /** 416 * @hide 417 * Unfortunately some developers (OpenFeint I am looking at you) have 418 * compared the configChanges bit field against absolute values, so if we 419 * introduce a new bit they break. To deal with that, we will make sure 420 * the public field will not have a value that breaks them, and let the 421 * framework call here to get the real value. 422 */ 423 public int getRealConfigChanged() { 424 return applicationInfo.targetSdkVersion < android.os.Build.VERSION_CODES.HONEYCOMB_MR2 425 ? (configChanges | ActivityInfo.CONFIG_SCREEN_SIZE 426 | ActivityInfo.CONFIG_SMALLEST_SCREEN_SIZE) 427 : configChanges; 428 } 429 430 /** 431 * Bit mask of kinds of configuration changes that this activity 432 * can handle itself (without being restarted by the system). 433 * Contains any combination of {@link #CONFIG_FONT_SCALE}, 434 * {@link #CONFIG_MCC}, {@link #CONFIG_MNC}, 435 * {@link #CONFIG_LOCALE}, {@link #CONFIG_TOUCHSCREEN}, 436 * {@link #CONFIG_KEYBOARD}, {@link #CONFIG_NAVIGATION}, 437 * {@link #CONFIG_ORIENTATION}, and {@link #CONFIG_SCREEN_LAYOUT}. Set from the 438 * {@link android.R.attr#configChanges} attribute. 439 */ 440 public int configChanges; 441 442 /** 443 * The desired soft input mode for this activity's main window. 444 * Set from the {@link android.R.attr#windowSoftInputMode} attribute 445 * in the activity's manifest. May be any of the same values allowed 446 * for {@link android.view.WindowManager.LayoutParams#softInputMode 447 * WindowManager.LayoutParams.softInputMode}. If 0 (unspecified), 448 * the mode from the theme will be used. 449 */ 450 public int softInputMode; 451 452 /** 453 * The desired extra UI options for this activity and its main window. 454 * Set from the {@link android.R.attr#uiOptions} attribute in the 455 * activity's manifest. 456 */ 457 public int uiOptions = 0; 458 459 /** 460 * Flag for use with {@link #uiOptions}. 461 * Indicates that the action bar should put all action items in a separate bar when 462 * the screen is narrow. 463 * <p>This value corresponds to "splitActionBarWhenNarrow" for the {@link #uiOptions} XML 464 * attribute. 465 */ 466 public static final int UIOPTION_SPLIT_ACTION_BAR_WHEN_NARROW = 1; 467 468 /** 469 * If defined, the activity named here is the logical parent of this activity. 470 */ 471 public String parentActivityName; 472 473 public ActivityInfo() { 474 } 475 476 public ActivityInfo(ActivityInfo orig) { 477 super(orig); 478 theme = orig.theme; 479 launchMode = orig.launchMode; 480 permission = orig.permission; 481 taskAffinity = orig.taskAffinity; 482 targetActivity = orig.targetActivity; 483 flags = orig.flags; 484 screenOrientation = orig.screenOrientation; 485 configChanges = orig.configChanges; 486 softInputMode = orig.softInputMode; 487 uiOptions = orig.uiOptions; 488 parentActivityName = orig.parentActivityName; 489 } 490 491 /** 492 * Return the theme resource identifier to use for this activity. If 493 * the activity defines a theme, that is used; else, the application 494 * theme is used. 495 * 496 * @return The theme associated with this activity. 497 */ 498 public final int getThemeResource() { 499 return theme != 0 ? theme : applicationInfo.theme; 500 } 501 502 public void dump(Printer pw, String prefix) { 503 super.dumpFront(pw, prefix); 504 if (permission != null) { 505 pw.println(prefix + "permission=" + permission); 506 } 507 pw.println(prefix + "taskAffinity=" + taskAffinity 508 + " targetActivity=" + targetActivity); 509 if (launchMode != 0 || flags != 0 || theme != 0) { 510 pw.println(prefix + "launchMode=" + launchMode 511 + " flags=0x" + Integer.toHexString(flags) 512 + " theme=0x" + Integer.toHexString(theme)); 513 } 514 if (screenOrientation != SCREEN_ORIENTATION_UNSPECIFIED 515 || configChanges != 0 || softInputMode != 0) { 516 pw.println(prefix + "screenOrientation=" + screenOrientation 517 + " configChanges=0x" + Integer.toHexString(configChanges) 518 + " softInputMode=0x" + Integer.toHexString(softInputMode)); 519 } 520 if (uiOptions != 0) { 521 pw.println(prefix + " uiOptions=0x" + Integer.toHexString(uiOptions)); 522 } 523 super.dumpBack(pw, prefix); 524 } 525 526 public String toString() { 527 return "ActivityInfo{" 528 + Integer.toHexString(System.identityHashCode(this)) 529 + " " + name + "}"; 530 } 531 532 public int describeContents() { 533 return 0; 534 } 535 536 public void writeToParcel(Parcel dest, int parcelableFlags) { 537 super.writeToParcel(dest, parcelableFlags); 538 dest.writeInt(theme); 539 dest.writeInt(launchMode); 540 dest.writeString(permission); 541 dest.writeString(taskAffinity); 542 dest.writeString(targetActivity); 543 dest.writeInt(flags); 544 dest.writeInt(screenOrientation); 545 dest.writeInt(configChanges); 546 dest.writeInt(softInputMode); 547 dest.writeInt(uiOptions); 548 dest.writeString(parentActivityName); 549 } 550 551 public static final Parcelable.Creator<ActivityInfo> CREATOR 552 = new Parcelable.Creator<ActivityInfo>() { 553 public ActivityInfo createFromParcel(Parcel source) { 554 return new ActivityInfo(source); 555 } 556 public ActivityInfo[] newArray(int size) { 557 return new ActivityInfo[size]; 558 } 559 }; 560 561 private ActivityInfo(Parcel source) { 562 super(source); 563 theme = source.readInt(); 564 launchMode = source.readInt(); 565 permission = source.readString(); 566 taskAffinity = source.readString(); 567 targetActivity = source.readString(); 568 flags = source.readInt(); 569 screenOrientation = source.readInt(); 570 configChanges = source.readInt(); 571 softInputMode = source.readInt(); 572 uiOptions = source.readInt(); 573 parentActivityName = source.readString(); 574 } 575} 576