WindowManager.java revision 1ecf5d28817f0a051e77488380dcd5bc622ea169
1/* 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.view; 18 19import android.content.pm.ActivityInfo; 20import android.graphics.PixelFormat; 21import android.os.IBinder; 22import android.os.Parcel; 23import android.os.Parcelable; 24import android.text.TextUtils; 25import android.util.Log; 26 27 28/** 29 * The interface that apps use to talk to the window manager. 30 * <p> 31 * Use <code>Context.getSystemService(Context.WINDOW_SERVICE)</code> to get one of these. 32 * 33 * @see android.content.Context#getSystemService 34 * @see android.content.Context#WINDOW_SERVICE 35 */ 36public interface WindowManager extends ViewManager { 37 /** 38 * Exception that is thrown when trying to add view whose 39 * {@link WindowManager.LayoutParams} {@link WindowManager.LayoutParams#token} 40 * is invalid. 41 */ 42 public static class BadTokenException extends RuntimeException { 43 public BadTokenException() { 44 } 45 46 public BadTokenException(String name) { 47 super(name); 48 } 49 } 50 51 /** 52 * Use this method to get the default Display object. 53 * 54 * @return default Display object 55 */ 56 public Display getDefaultDisplay(); 57 58 /** 59 * Special variation of {@link #removeView} that immediately invokes 60 * the given view hierarchy's {@link View#onDetachedFromWindow() 61 * View.onDetachedFromWindow()} methods before returning. This is not 62 * for normal applications; using it correctly requires great care. 63 * 64 * @param view The view to be removed. 65 */ 66 public void removeViewImmediate(View view); 67 68 public static class LayoutParams extends ViewGroup.LayoutParams 69 implements Parcelable { 70 /** 71 * X position for this window. With the default gravity it is ignored. 72 * When using {@link Gravity#LEFT} or {@link Gravity#RIGHT} it provides 73 * an offset from the given edge. 74 */ 75 public int x; 76 77 /** 78 * Y position for this window. With the default gravity it is ignored. 79 * When using {@link Gravity#TOP} or {@link Gravity#BOTTOM} it provides 80 * an offset from the given edge. 81 */ 82 public int y; 83 84 /** 85 * Indicates how much of the extra space will be allocated horizontally 86 * to the view associated with these LayoutParams. Specify 0 if the view 87 * should not be stretched. Otherwise the extra pixels will be pro-rated 88 * among all views whose weight is greater than 0. 89 */ 90 public float horizontalWeight; 91 92 /** 93 * Indicates how much of the extra space will be allocated vertically 94 * to the view associated with these LayoutParams. Specify 0 if the view 95 * should not be stretched. Otherwise the extra pixels will be pro-rated 96 * among all views whose weight is greater than 0. 97 */ 98 public float verticalWeight; 99 100 /** 101 * The general type of window. There are three main classes of 102 * window types: 103 * <ul> 104 * <li> <strong>Application windows</strong> (ranging from 105 * {@link #FIRST_APPLICATION_WINDOW} to 106 * {@link #LAST_APPLICATION_WINDOW}) are normal top-level application 107 * windows. For these types of windows, the {@link #token} must be 108 * set to the token of the activity they are a part of (this will 109 * normally be done for you if {@link #token} is null). 110 * <li> <strong>Sub-windows</strong> (ranging from 111 * {@link #FIRST_SUB_WINDOW} to 112 * {@link #LAST_SUB_WINDOW}) are associated with another top-level 113 * window. For these types of windows, the {@link #token} must be 114 * the token of the window it is attached to. 115 * <li> <strong>System windows</strong> (ranging from 116 * {@link #FIRST_SYSTEM_WINDOW} to 117 * {@link #LAST_SYSTEM_WINDOW}) are special types of windows for 118 * use by the system for specific purposes. They should not normally 119 * be used by applications, and a special permission is required 120 * to use them. 121 * </ul> 122 * 123 * @see #TYPE_BASE_APPLICATION 124 * @see #TYPE_APPLICATION 125 * @see #TYPE_APPLICATION_STARTING 126 * @see #TYPE_APPLICATION_PANEL 127 * @see #TYPE_APPLICATION_MEDIA 128 * @see #TYPE_APPLICATION_SUB_PANEL 129 * @see #TYPE_APPLICATION_ATTACHED_DIALOG 130 * @see #TYPE_STATUS_BAR 131 * @see #TYPE_SEARCH_BAR 132 * @see #TYPE_PHONE 133 * @see #TYPE_SYSTEM_ALERT 134 * @see #TYPE_KEYGUARD 135 * @see #TYPE_TOAST 136 * @see #TYPE_SYSTEM_OVERLAY 137 * @see #TYPE_PRIORITY_PHONE 138 * @see #TYPE_STATUS_BAR_PANEL 139 * @see #TYPE_SYSTEM_DIALOG 140 * @see #TYPE_KEYGUARD_DIALOG 141 * @see #TYPE_SYSTEM_ERROR 142 * @see #TYPE_INPUT_METHOD 143 * @see #TYPE_INPUT_METHOD_DIALOG 144 */ 145 public int type; 146 147 /** 148 * Start of window types that represent normal application windows. 149 */ 150 public static final int FIRST_APPLICATION_WINDOW = 1; 151 152 /** 153 * Window type: an application window that serves as the "base" window 154 * of the overall application; all other application windows will 155 * appear on top of it. 156 */ 157 public static final int TYPE_BASE_APPLICATION = 1; 158 159 /** 160 * Window type: a normal application window. The {@link #token} must be 161 * an Activity token identifying who the window belongs to. 162 */ 163 public static final int TYPE_APPLICATION = 2; 164 165 /** 166 * Window type: special application window that is displayed while the 167 * application is starting. Not for use by applications themselves; 168 * this is used by the system to display something until the 169 * application can show its own windows. 170 */ 171 public static final int TYPE_APPLICATION_STARTING = 3; 172 173 /** 174 * End of types of application windows. 175 */ 176 public static final int LAST_APPLICATION_WINDOW = 99; 177 178 /** 179 * Start of types of sub-windows. The {@link #token} of these windows 180 * must be set to the window they are attached to. These types of 181 * windows are kept next to their attached window in Z-order, and their 182 * coordinate space is relative to their attached window. 183 */ 184 public static final int FIRST_SUB_WINDOW = 1000; 185 186 /** 187 * Window type: a panel on top of an application window. These windows 188 * appear on top of their attached window. 189 */ 190 public static final int TYPE_APPLICATION_PANEL = FIRST_SUB_WINDOW; 191 192 /** 193 * Window type: window for showing media (e.g. video). These windows 194 * are displayed behind their attached window. 195 */ 196 public static final int TYPE_APPLICATION_MEDIA = FIRST_SUB_WINDOW+1; 197 198 /** 199 * Window type: a sub-panel on top of an application window. These 200 * windows are displayed on top their attached window and any 201 * {@link #TYPE_APPLICATION_PANEL} panels. 202 */ 203 public static final int TYPE_APPLICATION_SUB_PANEL = FIRST_SUB_WINDOW+2; 204 205 /** Window type: like {@link #TYPE_APPLICATION_PANEL}, but layout 206 * of the window happens as that of a top-level window, <em>not</em> 207 * as a child of its container. 208 */ 209 public static final int TYPE_APPLICATION_ATTACHED_DIALOG = FIRST_SUB_WINDOW+3; 210 211 /** 212 * Window type: window for showing overlays on top of media windows. 213 * These windows are displayed between TYPE_APPLICATION_MEDIA and the 214 * application window. They should be translucent to be useful. This 215 * is a big ugly hack so: 216 * @hide 217 */ 218 public static final int TYPE_APPLICATION_MEDIA_OVERLAY = FIRST_SUB_WINDOW+4; 219 220 /** 221 * End of types of sub-windows. 222 */ 223 public static final int LAST_SUB_WINDOW = 1999; 224 225 /** 226 * Start of system-specific window types. These are not normally 227 * created by applications. 228 */ 229 public static final int FIRST_SYSTEM_WINDOW = 2000; 230 231 /** 232 * Window type: the status bar. There can be only one status bar 233 * window; it is placed at the top of the screen, and all other 234 * windows are shifted down so they are below it. 235 */ 236 public static final int TYPE_STATUS_BAR = FIRST_SYSTEM_WINDOW; 237 238 /** 239 * Window type: the search bar. There can be only one search bar 240 * window; it is placed at the top of the screen. 241 */ 242 public static final int TYPE_SEARCH_BAR = FIRST_SYSTEM_WINDOW+1; 243 244 /** 245 * Window type: phone. These are non-application windows providing 246 * user interaction with the phone (in particular incoming calls). 247 * These windows are normally placed above all applications, but behind 248 * the status bar. 249 */ 250 public static final int TYPE_PHONE = FIRST_SYSTEM_WINDOW+2; 251 252 /** 253 * Window type: system window, such as low power alert. These windows 254 * are always on top of application windows. 255 */ 256 public static final int TYPE_SYSTEM_ALERT = FIRST_SYSTEM_WINDOW+3; 257 258 /** 259 * Window type: keyguard window. 260 */ 261 public static final int TYPE_KEYGUARD = FIRST_SYSTEM_WINDOW+4; 262 263 /** 264 * Window type: transient notifications. 265 */ 266 public static final int TYPE_TOAST = FIRST_SYSTEM_WINDOW+5; 267 268 /** 269 * Window type: system overlay windows, which need to be displayed 270 * on top of everything else. These windows must not take input 271 * focus, or they will interfere with the keyguard. 272 */ 273 public static final int TYPE_SYSTEM_OVERLAY = FIRST_SYSTEM_WINDOW+6; 274 275 /** 276 * Window type: priority phone UI, which needs to be displayed even if 277 * the keyguard is active. These windows must not take input 278 * focus, or they will interfere with the keyguard. 279 */ 280 public static final int TYPE_PRIORITY_PHONE = FIRST_SYSTEM_WINDOW+7; 281 282 /** 283 * Window type: panel that slides out from the status bar 284 */ 285 public static final int TYPE_STATUS_BAR_PANEL = FIRST_SYSTEM_WINDOW+8; 286 287 /** 288 * Window type: panel that slides out from the status bar 289 */ 290 public static final int TYPE_SYSTEM_DIALOG = FIRST_SYSTEM_WINDOW+8; 291 292 /** 293 * Window type: dialogs that the keyguard shows 294 */ 295 public static final int TYPE_KEYGUARD_DIALOG = FIRST_SYSTEM_WINDOW+9; 296 297 /** 298 * Window type: internal system error windows, appear on top of 299 * everything they can. 300 */ 301 public static final int TYPE_SYSTEM_ERROR = FIRST_SYSTEM_WINDOW+10; 302 303 /** 304 * Window type: internal input methods windows, which appear above 305 * the normal UI. Application windows may be resized or panned to keep 306 * the input focus visible while this window is displayed. 307 */ 308 public static final int TYPE_INPUT_METHOD = FIRST_SYSTEM_WINDOW+11; 309 310 /** 311 * Window type: internal input methods dialog windows, which appear above 312 * the current input method window. 313 */ 314 public static final int TYPE_INPUT_METHOD_DIALOG= FIRST_SYSTEM_WINDOW+12; 315 316 /** 317 * End of types of system windows. 318 */ 319 public static final int LAST_SYSTEM_WINDOW = 2999; 320 321 /** 322 * Specifies what type of memory buffers should be used by this window. 323 * Default is normal. 324 * 325 * @see #MEMORY_TYPE_NORMAL 326 * @see #MEMORY_TYPE_HARDWARE 327 * @see #MEMORY_TYPE_GPU 328 * @see #MEMORY_TYPE_PUSH_BUFFERS 329 */ 330 public int memoryType; 331 332 /** Memory type: The window's surface is allocated in main memory. */ 333 public static final int MEMORY_TYPE_NORMAL = 0; 334 /** Memory type: The window's surface is configured to be accessible 335 * by DMA engines and hardware accelerators. */ 336 public static final int MEMORY_TYPE_HARDWARE = 1; 337 /** Memory type: The window's surface is configured to be accessible 338 * by graphics accelerators. */ 339 public static final int MEMORY_TYPE_GPU = 2; 340 /** Memory type: The window's surface doesn't own its buffers and 341 * therefore cannot be locked. Instead the buffers are pushed to 342 * it through native binder calls. */ 343 public static final int MEMORY_TYPE_PUSH_BUFFERS = 3; 344 345 /** 346 * Various behavioral options/flags. Default is none. 347 * 348 * @see #FLAG_BLUR_BEHIND 349 * @see #FLAG_DIM_BEHIND 350 * @see #FLAG_NOT_FOCUSABLE 351 * @see #FLAG_NOT_TOUCHABLE 352 * @see #FLAG_NOT_TOUCH_MODAL 353 * @see #FLAG_LAYOUT_IN_SCREEN 354 * @see #FLAG_DITHER 355 * @see #FLAG_KEEP_SCREEN_ON 356 * @see #FLAG_FULLSCREEN 357 * @see #FLAG_FORCE_NOT_FULLSCREEN 358 * @see #FLAG_IGNORE_CHEEK_PRESSES 359 */ 360 public int flags; 361 362 /** Window flag: everything behind this window will be dimmed. 363 * Use {@link #dimAmount} to control the amount of dim. */ 364 public static final int FLAG_DIM_BEHIND = 0x00000002; 365 366 /** Window flag: blur everything behind this window. */ 367 public static final int FLAG_BLUR_BEHIND = 0x00000004; 368 369 /** Window flag: this window won't ever get key input focus, so the 370 * user can not send key or other button events to it. Those will 371 * instead go to whatever focusable window is behind it. This flag 372 * will also enable {@link #FLAG_NOT_TOUCH_MODAL} whether or not that 373 * is explicitly set. 374 * 375 * <p>Setting this flag also implies that the window will not need to 376 * interact with 377 * a soft input method, so it will be Z-ordered and positioned 378 * independently of any active input method (typically this means it 379 * gets Z-ordered on top of the input method, so it can use the full 380 * screen for its content and cover the input method if needed. You 381 * can use {@link #FLAG_ALT_FOCUSABLE_IM} to modify this behavior. */ 382 public static final int FLAG_NOT_FOCUSABLE = 0x00000008; 383 384 /** Window flag: this window can never receive touch events. */ 385 public static final int FLAG_NOT_TOUCHABLE = 0x00000010; 386 387 /** Window flag: Even when this window is focusable (its 388 * {@link #FLAG_NOT_FOCUSABLE is not set), allow any pointer events 389 * outside of the window to be sent to the windows behind it. Otherwise 390 * it will consume all pointer events itself, regardless of whether they 391 * are inside of the window. */ 392 public static final int FLAG_NOT_TOUCH_MODAL = 0x00000020; 393 394 /** Window flag: When set, if the device is asleep when the touch 395 * screen is pressed, you will receive this first touch event. Usually 396 * the first touch event is consumed by the system since the user can 397 * not see what they are pressing on. 398 */ 399 public static final int FLAG_TOUCHABLE_WHEN_WAKING = 0x00000040; 400 401 /** Window flag: as long as this window is visible to the user, keep 402 * the device's screen turned on and bright. */ 403 public static final int FLAG_KEEP_SCREEN_ON = 0x00000080; 404 405 /** Window flag: place the window within the entire screen, ignoring 406 * decorations around the border (a.k.a. the status bar). The 407 * window must correctly position its contents to take the screen 408 * decoration into account. This flag is normally set for you 409 * by Window as described in {@link Window#setFlags}. */ 410 public static final int FLAG_LAYOUT_IN_SCREEN = 0x00000100; 411 412 /** Window flag: allow window to extend outside of the screen. */ 413 public static final int FLAG_LAYOUT_NO_LIMITS = 0x00000200; 414 415 /** Window flag: Hide all screen decorations (e.g. status bar) while 416 * this window is displayed. This allows the window to use the entire 417 * display space for itself -- the status bar will be hidden when 418 * an app window with this flag set is on the top layer. */ 419 public static final int FLAG_FULLSCREEN = 0x00000400; 420 421 /** Window flag: Override {@link #FLAG_FULLSCREEN and force the 422 * screen decorations (such as status bar) to be shown. */ 423 public static final int FLAG_FORCE_NOT_FULLSCREEN = 0x00000800; 424 425 /** Window flag: turn on dithering when compositing this window to 426 * the screen. */ 427 public static final int FLAG_DITHER = 0x00001000; 428 429 /** Window flag: don't allow screen shots while this window is 430 * displayed. */ 431 public static final int FLAG_SECURE = 0x00002000; 432 433 /** Window flag: a special mode where the layout parameters are used 434 * to perform scaling of the surface when it is composited to the 435 * screen. */ 436 public static final int FLAG_SCALED = 0x00004000; 437 438 /** Window flag: intended for windows that will often be used when the user is 439 * holding the screen against their face, it will aggressively filter the event 440 * stream to prevent unintended presses in this situation that may not be 441 * desired for a particular window, when such an event stream is detected, the 442 * application will receive a CANCEL motion event to indicate this so applications 443 * can handle this accordingly by taking no action on the event 444 * until the finger is released. */ 445 public static final int FLAG_IGNORE_CHEEK_PRESSES = 0x00008000; 446 447 /** Window flag: a special option only for use in combination with 448 * {@link #FLAG_LAYOUT_IN_SCREEN}. When requesting layout in the 449 * screen your window may appear on top of or behind screen decorations 450 * such as the status bar. By also including this flag, the window 451 * manager will report the inset rectangle needed to ensure your 452 * content is not covered by screen decorations. This flag is normally 453 * set for you by Window as described in {@link Window#setFlags}.*/ 454 public static final int FLAG_LAYOUT_INSET_DECOR = 0x00010000; 455 456 /** Window flag: invert the state of {@link #FLAG_NOT_FOCUSABLE} with 457 * respect to how this window interacts with the current method. That 458 * is, if FLAG_NOT_FOCUSABLE is set and this flag is set, then the 459 * window will behave as if it needs to interact with the input method 460 * and thus be placed behind/away from it; if FLAG_NOT_FOCUSABLE is 461 * not set and this flag is set, then the window will behave as if it 462 * doesn't need to interact with the input method and can be placed 463 * to use more space and cover the input method. 464 */ 465 public static final int FLAG_ALT_FOCUSABLE_IM = 0x00020000; 466 467 /** Window flag: if you have set {@link #FLAG_NOT_TOUCH_MODAL}, you 468 * can set this flag to receive a single special MotionEvent with 469 * the action 470 * {@link MotionEvent#ACTION_OUTSIDE MotionEvent.ACTION_OUTSIDE} for 471 * touches that occur outside of your window. Note that you will not 472 * receive the full down/move/up gesture, only the location of the 473 * first down as an ACTION_OUTSIDE. 474 */ 475 public static final int FLAG_WATCH_OUTSIDE_TOUCH = 0x00040000; 476 477 /** Window flag: special flag to let windows be shown when the screen 478 * is locked. This will let application windows take precedence over 479 * key guard or any other lock screens. Can be used with 480 * {@link #FLAG_KEEP_SCREEN_ON} to turn screen on and display windows 481 * directly before showing the key guard window 482 * 483 * {@hide} */ 484 public static final int FLAG_SHOW_WHEN_LOCKED = 0x00080000; 485 486 /** Window flag: special flag to let a window ignore the compatibility scaling. 487 * This is used by SurfaceView to pass this info into ViewRoot, and not used 488 * by WindowManager. 489 * 490 * {@hide} */ 491 public static final int FLAG_NO_COMPATIBILITY_SCALING = 0x00100000; 492 493 /** Window flag: special flag to limit the size of the window to be 494 * original size ([320x480] x density). Used to create window for applications 495 * running under compatibility mode. 496 * 497 * {@hide} */ 498 public static final int FLAG_COMPATIBLE_WINDOW = 0x00200000; 499 500 /** Window flag: a special option intended for system dialogs. When 501 * this flag is set, the window will demand focus unconditionally when 502 * it is created. 503 * {@hide} */ 504 public static final int FLAG_SYSTEM_ERROR = 0x40000000; 505 506 /** 507 * Given a particular set of window manager flags, determine whether 508 * such a window may be a target for an input method when it has 509 * focus. In particular, this checks the 510 * {@link #FLAG_NOT_FOCUSABLE} and {@link #FLAG_ALT_FOCUSABLE_IM} 511 * flags and returns true if the combination of the two corresponds 512 * to a window that needs to be behind the input method so that the 513 * user can type into it. 514 * 515 * @param flags The current window manager flags. 516 * 517 * @return Returns true if such a window should be behind/interact 518 * with an input method, false if not. 519 */ 520 public static boolean mayUseInputMethod(int flags) { 521 switch (flags&(FLAG_NOT_FOCUSABLE|FLAG_ALT_FOCUSABLE_IM)) { 522 case 0: 523 case FLAG_NOT_FOCUSABLE|FLAG_ALT_FOCUSABLE_IM: 524 return true; 525 } 526 return false; 527 } 528 529 /** 530 * Mask for {@link #softInputMode} of the bits that determine the 531 * desired visibility state of the soft input area for this window. 532 */ 533 public static final int SOFT_INPUT_MASK_STATE = 0x0f; 534 535 /** 536 * Visibility state for {@link #softInputMode}: no state has been specified. 537 */ 538 public static final int SOFT_INPUT_STATE_UNSPECIFIED = 0; 539 540 /** 541 * Visibility state for {@link #softInputMode}: please don't change the state of 542 * the soft input area. 543 */ 544 public static final int SOFT_INPUT_STATE_UNCHANGED = 1; 545 546 /** 547 * Visibility state for {@link #softInputMode}: please hide any soft input 548 * area when normally appropriate (when the user is navigating 549 * forward to your window). 550 */ 551 public static final int SOFT_INPUT_STATE_HIDDEN = 2; 552 553 /** 554 * Visibility state for {@link #softInputMode}: please always hide any 555 * soft input area when this window receives focus. 556 */ 557 public static final int SOFT_INPUT_STATE_ALWAYS_HIDDEN = 3; 558 559 /** 560 * Visibility state for {@link #softInputMode}: please show the soft 561 * input area when normally appropriate (when the user is navigating 562 * forward to your window). 563 */ 564 public static final int SOFT_INPUT_STATE_VISIBLE = 4; 565 566 /** 567 * Visibility state for {@link #softInputMode}: please always make the 568 * soft input area visible when this window receives input focus. 569 */ 570 public static final int SOFT_INPUT_STATE_ALWAYS_VISIBLE = 5; 571 572 /** 573 * Mask for {@link #softInputMode} of the bits that determine the 574 * way that the window should be adjusted to accommodate the soft 575 * input window. 576 */ 577 public static final int SOFT_INPUT_MASK_ADJUST = 0xf0; 578 579 /** Adjustment option for {@link #softInputMode}: nothing specified. 580 * The system will try to pick one or 581 * the other depending on the contents of the window. 582 */ 583 public static final int SOFT_INPUT_ADJUST_UNSPECIFIED = 0x00; 584 585 /** Adjustment option for {@link #softInputMode}: set to allow the 586 * window to be resized when an input 587 * method is shown, so that its contents are not covered by the input 588 * method. This can <em>not<em> be combined with 589 * {@link #SOFT_INPUT_ADJUST_PAN}; if 590 * neither of these are set, then the system will try to pick one or 591 * the other depending on the contents of the window. 592 */ 593 public static final int SOFT_INPUT_ADJUST_RESIZE = 0x10; 594 595 /** Adjustment option for {@link #softInputMode}: set to have a window 596 * pan when an input method is 597 * shown, so it doesn't need to deal with resizing but just panned 598 * by the framework to ensure the current input focus is visible. This 599 * can <em>not<em> be combined with {@link #SOFT_INPUT_ADJUST_RESIZE}; if 600 * neither of these are set, then the system will try to pick one or 601 * the other depending on the contents of the window. 602 */ 603 public static final int SOFT_INPUT_ADJUST_PAN = 0x20; 604 605 /** 606 * Bit for {@link #softInputMode}: set when the user has navigated 607 * forward to the window. This is normally set automatically for 608 * you by the system, though you may want to set it in certain cases 609 * when you are displaying a window yourself. This flag will always 610 * be cleared automatically after the window is displayed. 611 */ 612 public static final int SOFT_INPUT_IS_FORWARD_NAVIGATION = 0x100; 613 614 /** 615 * Desired operating mode for any soft input area. May any combination 616 * of: 617 * 618 * <ul> 619 * <li> One of the visibility states 620 * {@link #SOFT_INPUT_STATE_UNSPECIFIED}, {@link #SOFT_INPUT_STATE_UNCHANGED}, 621 * {@link #SOFT_INPUT_STATE_HIDDEN}, {@link #SOFT_INPUT_STATE_ALWAYS_VISIBLE}, or 622 * {@link #SOFT_INPUT_STATE_VISIBLE}. 623 * <li> One of the adjustment options 624 * {@link #SOFT_INPUT_ADJUST_UNSPECIFIED}, 625 * {@link #SOFT_INPUT_ADJUST_RESIZE}, or 626 * {@link #SOFT_INPUT_ADJUST_PAN}. 627 */ 628 public int softInputMode; 629 630 /** 631 * Placement of window within the screen as per {@link Gravity} 632 * 633 * @see Gravity 634 */ 635 public int gravity; 636 637 /** 638 * The horizontal margin, as a percentage of the container's width, 639 * between the container and the widget. 640 */ 641 public float horizontalMargin; 642 643 /** 644 * The vertical margin, as a percentage of the container's height, 645 * between the container and the widget. 646 */ 647 public float verticalMargin; 648 649 /** 650 * The desired bitmap format. May be one of the constants in 651 * {@link android.graphics.PixelFormat}. Default is OPAQUE. 652 */ 653 public int format; 654 655 /** 656 * A style resource defining the animations to use for this window. 657 * This must be a system resource; it can not be an application resource 658 * because the window manager does not have access to applications. 659 */ 660 public int windowAnimations; 661 662 /** 663 * An alpha value to apply to this entire window. 664 * An alpha of 1.0 means fully opaque and 0.0 means fully transparent 665 */ 666 public float alpha = 1.0f; 667 668 /** 669 * When {@link #FLAG_DIM_BEHIND} is set, this is the amount of dimming 670 * to apply. Range is from 1.0 for completely opaque to 0.0 for no 671 * dim. 672 */ 673 public float dimAmount = 1.0f; 674 675 /** 676 * This can be used to override the user's preferred brightness of 677 * the screen. A value of less than 0, the default, means to use the 678 * preferred screen brightness. 0 to 1 adjusts the brightness from 679 * dark to full bright. 680 */ 681 public float screenBrightness = -1.0f; 682 683 /** 684 * Identifier for this window. This will usually be filled in for 685 * you. 686 */ 687 public IBinder token = null; 688 689 /** 690 * Name of the package owning this window. 691 */ 692 public String packageName = null; 693 694 /** 695 * Specific orientation value for a window. 696 * May be any of the same values allowed 697 * for {@link android.content.pm.ActivityInfo#screenOrientation}. 698 * If not set, a default value of 699 * {@link android.content.pm.ActivityInfo#SCREEN_ORIENTATION_UNSPECIFIED} 700 * will be used. 701 */ 702 public int screenOrientation = ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED; 703 704 705 public LayoutParams() { 706 super(LayoutParams.FILL_PARENT, LayoutParams.FILL_PARENT); 707 type = TYPE_APPLICATION; 708 format = PixelFormat.OPAQUE; 709 } 710 711 public LayoutParams(int _type) { 712 super(LayoutParams.FILL_PARENT, LayoutParams.FILL_PARENT); 713 type = _type; 714 format = PixelFormat.OPAQUE; 715 } 716 717 public LayoutParams(int _type, int _flags) { 718 super(LayoutParams.FILL_PARENT, LayoutParams.FILL_PARENT); 719 type = _type; 720 flags = _flags; 721 format = PixelFormat.OPAQUE; 722 } 723 724 public LayoutParams(int _type, int _flags, int _format) { 725 super(LayoutParams.FILL_PARENT, LayoutParams.FILL_PARENT); 726 type = _type; 727 flags = _flags; 728 format = _format; 729 } 730 731 public LayoutParams(int w, int h, int _type, int _flags, int _format) { 732 super(w, h); 733 type = _type; 734 flags = _flags; 735 format = _format; 736 } 737 738 public LayoutParams(int w, int h, int xpos, int ypos, int _type, 739 int _flags, int _format) { 740 super(w, h); 741 x = xpos; 742 y = ypos; 743 type = _type; 744 flags = _flags; 745 format = _format; 746 } 747 748 public final void setTitle(CharSequence title) { 749 if (null == title) 750 title = ""; 751 752 mTitle = TextUtils.stringOrSpannedString(title); 753 } 754 755 public final CharSequence getTitle() { 756 return mTitle; 757 } 758 759 public int describeContents() { 760 return 0; 761 } 762 763 public void writeToParcel(Parcel out, int parcelableFlags) { 764 out.writeInt(width); 765 out.writeInt(height); 766 out.writeInt(x); 767 out.writeInt(y); 768 out.writeInt(type); 769 out.writeInt(memoryType); 770 out.writeInt(flags); 771 out.writeInt(softInputMode); 772 out.writeInt(gravity); 773 out.writeFloat(horizontalMargin); 774 out.writeFloat(verticalMargin); 775 out.writeInt(format); 776 out.writeInt(windowAnimations); 777 out.writeFloat(alpha); 778 out.writeFloat(dimAmount); 779 out.writeFloat(screenBrightness); 780 out.writeStrongBinder(token); 781 out.writeString(packageName); 782 TextUtils.writeToParcel(mTitle, out, parcelableFlags); 783 out.writeInt(screenOrientation); 784 } 785 786 public static final Parcelable.Creator<LayoutParams> CREATOR 787 = new Parcelable.Creator<LayoutParams>() { 788 public LayoutParams createFromParcel(Parcel in) { 789 return new LayoutParams(in); 790 } 791 792 public LayoutParams[] newArray(int size) { 793 return new LayoutParams[size]; 794 } 795 }; 796 797 798 public LayoutParams(Parcel in) { 799 width = in.readInt(); 800 height = in.readInt(); 801 x = in.readInt(); 802 y = in.readInt(); 803 type = in.readInt(); 804 memoryType = in.readInt(); 805 flags = in.readInt(); 806 softInputMode = in.readInt(); 807 gravity = in.readInt(); 808 horizontalMargin = in.readFloat(); 809 verticalMargin = in.readFloat(); 810 format = in.readInt(); 811 windowAnimations = in.readInt(); 812 alpha = in.readFloat(); 813 dimAmount = in.readFloat(); 814 screenBrightness = in.readFloat(); 815 token = in.readStrongBinder(); 816 packageName = in.readString(); 817 mTitle = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(in); 818 screenOrientation = in.readInt(); 819 } 820 821 @SuppressWarnings({"PointlessBitwiseExpression"}) 822 public static final int LAYOUT_CHANGED = 1<<0; 823 public static final int TYPE_CHANGED = 1<<1; 824 public static final int FLAGS_CHANGED = 1<<2; 825 public static final int FORMAT_CHANGED = 1<<3; 826 public static final int ANIMATION_CHANGED = 1<<4; 827 public static final int DIM_AMOUNT_CHANGED = 1<<5; 828 public static final int TITLE_CHANGED = 1<<6; 829 public static final int ALPHA_CHANGED = 1<<7; 830 public static final int MEMORY_TYPE_CHANGED = 1<<8; 831 public static final int SOFT_INPUT_MODE_CHANGED = 1<<9; 832 public static final int SCREEN_ORIENTATION_CHANGED = 1<<10; 833 public static final int SCREEN_BRIGHTNESS_CHANGED = 1<<11; 834 835 // internal buffer to backup/restore parameters under compatibility mode. 836 private int[] mCompatibilityParamsBackup = null; 837 838 public final int copyFrom(LayoutParams o) { 839 int changes = 0; 840 841 if (width != o.width) { 842 width = o.width; 843 changes |= LAYOUT_CHANGED; 844 } 845 if (height != o.height) { 846 height = o.height; 847 changes |= LAYOUT_CHANGED; 848 } 849 if (x != o.x) { 850 x = o.x; 851 changes |= LAYOUT_CHANGED; 852 } 853 if (y != o.y) { 854 y = o.y; 855 changes |= LAYOUT_CHANGED; 856 } 857 if (horizontalWeight != o.horizontalWeight) { 858 horizontalWeight = o.horizontalWeight; 859 changes |= LAYOUT_CHANGED; 860 } 861 if (verticalWeight != o.verticalWeight) { 862 verticalWeight = o.verticalWeight; 863 changes |= LAYOUT_CHANGED; 864 } 865 if (horizontalMargin != o.horizontalMargin) { 866 horizontalMargin = o.horizontalMargin; 867 changes |= LAYOUT_CHANGED; 868 } 869 if (verticalMargin != o.verticalMargin) { 870 verticalMargin = o.verticalMargin; 871 changes |= LAYOUT_CHANGED; 872 } 873 if (type != o.type) { 874 type = o.type; 875 changes |= TYPE_CHANGED; 876 } 877 if (memoryType != o.memoryType) { 878 memoryType = o.memoryType; 879 changes |= MEMORY_TYPE_CHANGED; 880 } 881 if (flags != o.flags) { 882 flags = o.flags; 883 changes |= FLAGS_CHANGED; 884 } 885 if (softInputMode != o.softInputMode) { 886 softInputMode = o.softInputMode; 887 changes |= SOFT_INPUT_MODE_CHANGED; 888 } 889 if (gravity != o.gravity) { 890 gravity = o.gravity; 891 changes |= LAYOUT_CHANGED; 892 } 893 if (horizontalMargin != o.horizontalMargin) { 894 horizontalMargin = o.horizontalMargin; 895 changes |= LAYOUT_CHANGED; 896 } 897 if (verticalMargin != o.verticalMargin) { 898 verticalMargin = o.verticalMargin; 899 changes |= LAYOUT_CHANGED; 900 } 901 if (format != o.format) { 902 format = o.format; 903 changes |= FORMAT_CHANGED; 904 } 905 if (windowAnimations != o.windowAnimations) { 906 windowAnimations = o.windowAnimations; 907 changes |= ANIMATION_CHANGED; 908 } 909 if (token == null) { 910 // NOTE: token only copied if the recipient doesn't 911 // already have one. 912 token = o.token; 913 } 914 if (packageName == null) { 915 // NOTE: packageName only copied if the recipient doesn't 916 // already have one. 917 packageName = o.packageName; 918 } 919 if (!mTitle.equals(o.mTitle)) { 920 mTitle = o.mTitle; 921 changes |= TITLE_CHANGED; 922 } 923 if (alpha != o.alpha) { 924 alpha = o.alpha; 925 changes |= ALPHA_CHANGED; 926 } 927 if (dimAmount != o.dimAmount) { 928 dimAmount = o.dimAmount; 929 changes |= DIM_AMOUNT_CHANGED; 930 } 931 if (screenBrightness != o.screenBrightness) { 932 screenBrightness = o.screenBrightness; 933 changes |= SCREEN_BRIGHTNESS_CHANGED; 934 } 935 936 if (screenOrientation != o.screenOrientation) { 937 screenOrientation = o.screenOrientation; 938 changes |= SCREEN_ORIENTATION_CHANGED; 939 } 940 return changes; 941 } 942 943 @Override 944 public String debug(String output) { 945 output += "Contents of " + this + ":"; 946 Log.d("Debug", output); 947 output = super.debug(""); 948 Log.d("Debug", output); 949 Log.d("Debug", ""); 950 Log.d("Debug", "WindowManager.LayoutParams={title=" + mTitle + "}"); 951 return ""; 952 } 953 954 @Override 955 public String toString() { 956 StringBuilder sb = new StringBuilder(256); 957 sb.append("WM.LayoutParams{"); 958 sb.append("("); 959 sb.append(x); 960 sb.append(','); 961 sb.append(y); 962 sb.append(")("); 963 sb.append((width==FILL_PARENT?"fill":(width==WRAP_CONTENT?"wrap":width))); 964 sb.append('x'); 965 sb.append((height==FILL_PARENT?"fill":(height==WRAP_CONTENT?"wrap":height))); 966 sb.append(")"); 967 if (softInputMode != 0) { 968 sb.append(" sim=#"); 969 sb.append(Integer.toHexString(softInputMode)); 970 } 971 if (gravity != 0) { 972 sb.append(" gr=#"); 973 sb.append(Integer.toHexString(gravity)); 974 } 975 sb.append(" ty="); 976 sb.append(type); 977 sb.append(" fl=#"); 978 sb.append(Integer.toHexString(flags)); 979 sb.append(" fmt="); 980 sb.append(format); 981 if (windowAnimations != 0) { 982 sb.append(" wanim=0x"); 983 sb.append(Integer.toHexString(windowAnimations)); 984 } 985 if (screenOrientation != ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED) { 986 sb.append(" or="); 987 sb.append(screenOrientation); 988 } 989 sb.append('}'); 990 return sb.toString(); 991 } 992 993 /** 994 * Scale the layout params' coordinates and size. 995 * @hide 996 */ 997 public void scale(float scale) { 998 x *= scale; 999 y *= scale; 1000 if (width > 0) { 1001 width *= scale; 1002 } 1003 if (height > 0) { 1004 height *= scale; 1005 } 1006 } 1007 1008 /** 1009 * Backup the layout parameters used in compatibility mode. 1010 * @see LayoutParams#restore() 1011 */ 1012 void backup() { 1013 int[] backup = mCompatibilityParamsBackup; 1014 if (backup == null) { 1015 // we backup 4 elements, x, y, width, height 1016 backup = mCompatibilityParamsBackup = new int[4]; 1017 } 1018 backup[0] = x; 1019 backup[1] = y; 1020 backup[2] = width; 1021 backup[3] = height; 1022 } 1023 1024 /** 1025 * Restore the layout params' coordinates, size and gravity 1026 * @see LayoutParams#backup() 1027 */ 1028 void restore() { 1029 int[] backup = mCompatibilityParamsBackup; 1030 if (backup != null) { 1031 x = backup[0]; 1032 y = backup[1]; 1033 width = backup[2]; 1034 height = backup[3]; 1035 } 1036 } 1037 1038 private CharSequence mTitle = ""; 1039 } 1040} 1041