WindowManagerPolicy.java revision 9a538ee7bde42ad36f43edc48594282d98e191a4
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.Context; 20import android.content.res.CompatibilityInfo; 21import android.content.res.Configuration; 22import android.graphics.Rect; 23import android.graphics.RectF; 24import android.os.IBinder; 25import android.os.Looper; 26import android.view.animation.Animation; 27 28import java.io.PrintWriter; 29 30/** 31 * This interface supplies all UI-specific behavior of the window manager. An 32 * instance of it is created by the window manager when it starts up, and allows 33 * customization of window layering, special window types, key dispatching, and 34 * layout. 35 * 36 * <p>Because this provides deep interaction with the system window manager, 37 * specific methods on this interface can be called from a variety of contexts 38 * with various restrictions on what they can do. These are encoded through 39 * a suffixes at the end of a method encoding the thread the method is called 40 * from and any locks that are held when it is being called; if no suffix 41 * is attached to a method, then it is not called with any locks and may be 42 * called from the main window manager thread or another thread calling into 43 * the window manager. 44 * 45 * <p>The current suffixes are: 46 * 47 * <dl> 48 * <dt> Ti <dd> Called from the input thread. This is the thread that 49 * collects pending input events and dispatches them to the appropriate window. 50 * It may block waiting for events to be processed, so that the input stream is 51 * properly serialized. 52 * <dt> Tq <dd> Called from the low-level input queue thread. This is the 53 * thread that reads events out of the raw input devices and places them 54 * into the global input queue that is read by the <var>Ti</var> thread. 55 * This thread should not block for a long period of time on anything but the 56 * key driver. 57 * <dt> Lw <dd> Called with the main window manager lock held. Because the 58 * window manager is a very low-level system service, there are few other 59 * system services you can call with this lock held. It is explicitly okay to 60 * make calls into the package manager and power manager; it is explicitly not 61 * okay to make calls into the activity manager or most other services. Note that 62 * {@link android.content.Context#checkPermission(String, int, int)} and 63 * variations require calling into the activity manager. 64 * <dt> Li <dd> Called with the input thread lock held. This lock can be 65 * acquired by the window manager while it holds the window lock, so this is 66 * even more restrictive than <var>Lw</var>. 67 * </dl> 68 * 69 * @hide 70 */ 71public interface WindowManagerPolicy { 72 // Policy flags. These flags are also defined in frameworks/base/include/ui/Input.h. 73 public final static int FLAG_WAKE = 0x00000001; 74 public final static int FLAG_WAKE_DROPPED = 0x00000002; 75 public final static int FLAG_SHIFT = 0x00000004; 76 public final static int FLAG_CAPS_LOCK = 0x00000008; 77 public final static int FLAG_ALT = 0x00000010; 78 public final static int FLAG_ALT_GR = 0x00000020; 79 public final static int FLAG_MENU = 0x00000040; 80 public final static int FLAG_LAUNCHER = 0x00000080; 81 public final static int FLAG_VIRTUAL = 0x00000100; 82 83 public final static int FLAG_INJECTED = 0x01000000; 84 public final static int FLAG_TRUSTED = 0x02000000; 85 public final static int FLAG_FILTERED = 0x04000000; 86 public final static int FLAG_DISABLE_KEY_REPEAT = 0x08000000; 87 88 public final static int FLAG_WOKE_HERE = 0x10000000; 89 public final static int FLAG_BRIGHT_HERE = 0x20000000; 90 public final static int FLAG_PASS_TO_USER = 0x40000000; 91 92 // Flags used for indicating whether the internal and/or external input devices 93 // of some type are available. 94 public final static int PRESENCE_INTERNAL = 1 << 0; 95 public final static int PRESENCE_EXTERNAL = 1 << 1; 96 97 public final static boolean WATCH_POINTER = false; 98 99 /** 100 * Sticky broadcast of the current HDMI plugged state. 101 */ 102 public final static String ACTION_HDMI_PLUGGED = "android.intent.action.HDMI_PLUGGED"; 103 104 /** 105 * Extra in {@link #ACTION_HDMI_PLUGGED} indicating the state: true if 106 * plugged in to HDMI, false if not. 107 */ 108 public final static String EXTRA_HDMI_PLUGGED_STATE = "state"; 109 110 /** 111 * Pass this event to the user / app. To be returned from 112 * {@link #interceptKeyBeforeQueueing}. 113 */ 114 public final static int ACTION_PASS_TO_USER = 0x00000001; 115 116 /** 117 * This key event should wake the device. 118 * To be returned from {@link #interceptKeyBeforeQueueing}. 119 * Do not return this and {@link #ACTION_GO_TO_SLEEP} or {@link #ACTION_PASS_TO_USER}. 120 */ 121 public final static int ACTION_WAKE_UP = 0x00000002; 122 123 /** 124 * This key event should put the device to sleep (and engage keyguard if necessary) 125 * To be returned from {@link #interceptKeyBeforeQueueing}. 126 * Do not return this and {@link #ACTION_POKE_USER_ACTIVITY} or {@link #ACTION_PASS_TO_USER}. 127 */ 128 public final static int ACTION_GO_TO_SLEEP = 0x00000004; 129 130 /** 131 * Interface to the Window Manager state associated with a particular 132 * window. You can hold on to an instance of this interface from the call 133 * to prepareAddWindow() until removeWindow(). 134 */ 135 public interface WindowState { 136 /** 137 * Perform standard frame computation. The result can be obtained with 138 * getFrame() if so desired. Must be called with the window manager 139 * lock held. 140 * 141 * @param parentFrame The frame of the parent container this window 142 * is in, used for computing its basic position. 143 * @param displayFrame The frame of the overall display in which this 144 * window can appear, used for constraining the overall dimensions 145 * of the window. 146 * @param contentFrame The frame within the display in which we would 147 * like active content to appear. This will cause windows behind to 148 * be resized to match the given content frame. 149 * @param visibleFrame The frame within the display that the window 150 * is actually visible, used for computing its visible insets to be 151 * given to windows behind. 152 * This can be used as a hint for scrolling (avoiding resizing) 153 * the window to make certain that parts of its content 154 * are visible. 155 */ 156 public void computeFrameLw(Rect parentFrame, Rect displayFrame, 157 Rect contentFrame, Rect visibleFrame); 158 159 /** 160 * Retrieve the current frame of the window that has been assigned by 161 * the window manager. Must be called with the window manager lock held. 162 * 163 * @return Rect The rectangle holding the window frame. 164 */ 165 public Rect getFrameLw(); 166 167 /** 168 * Retrieve the current frame of the window that is actually shown. 169 * Must be called with the window manager lock held. 170 * 171 * @return Rect The rectangle holding the shown window frame. 172 */ 173 public RectF getShownFrameLw(); 174 175 /** 176 * Retrieve the frame of the display that this window was last 177 * laid out in. Must be called with the 178 * window manager lock held. 179 * 180 * @return Rect The rectangle holding the display frame. 181 */ 182 public Rect getDisplayFrameLw(); 183 184 /** 185 * Retrieve the frame of the content area that this window was last 186 * laid out in. This is the area in which the content of the window 187 * should be placed. It will be smaller than the display frame to 188 * account for screen decorations such as a status bar or soft 189 * keyboard. Must be called with the 190 * window manager lock held. 191 * 192 * @return Rect The rectangle holding the content frame. 193 */ 194 public Rect getContentFrameLw(); 195 196 /** 197 * Retrieve the frame of the visible area that this window was last 198 * laid out in. This is the area of the screen in which the window 199 * will actually be fully visible. It will be smaller than the 200 * content frame to account for transient UI elements blocking it 201 * such as an input method's candidates UI. Must be called with the 202 * window manager lock held. 203 * 204 * @return Rect The rectangle holding the visible frame. 205 */ 206 public Rect getVisibleFrameLw(); 207 208 /** 209 * Returns true if this window is waiting to receive its given 210 * internal insets from the client app, and so should not impact the 211 * layout of other windows. 212 */ 213 public boolean getGivenInsetsPendingLw(); 214 215 /** 216 * Retrieve the insets given by this window's client for the content 217 * area of windows behind it. Must be called with the 218 * window manager lock held. 219 * 220 * @return Rect The left, top, right, and bottom insets, relative 221 * to the window's frame, of the actual contents. 222 */ 223 public Rect getGivenContentInsetsLw(); 224 225 /** 226 * Retrieve the insets given by this window's client for the visible 227 * area of windows behind it. Must be called with the 228 * window manager lock held. 229 * 230 * @return Rect The left, top, right, and bottom insets, relative 231 * to the window's frame, of the actual visible area. 232 */ 233 public Rect getGivenVisibleInsetsLw(); 234 235 /** 236 * Retrieve the current LayoutParams of the window. 237 * 238 * @return WindowManager.LayoutParams The window's internal LayoutParams 239 * instance. 240 */ 241 public WindowManager.LayoutParams getAttrs(); 242 243 /** 244 * Return whether this window needs the menu key shown. Must be called 245 * with window lock held, because it may need to traverse down through 246 * window list to determine the result. 247 * @param bottom The bottom-most window to consider when determining this. 248 */ 249 public boolean getNeedsMenuLw(WindowState bottom); 250 251 /** 252 * Retrieve the current system UI visibility flags associated with 253 * this window. 254 */ 255 public int getSystemUiVisibility(); 256 257 /** 258 * Get the layer at which this window's surface will be Z-ordered. 259 */ 260 public int getSurfaceLayer(); 261 262 /** 263 * Return the token for the application (actually activity) that owns 264 * this window. May return null for system windows. 265 * 266 * @return An IApplicationToken identifying the owning activity. 267 */ 268 public IApplicationToken getAppToken(); 269 270 /** 271 * Return true if, at any point, the application token associated with 272 * this window has actually displayed any windows. This is most useful 273 * with the "starting up" window to determine if any windows were 274 * displayed when it is closed. 275 * 276 * @return Returns true if one or more windows have been displayed, 277 * else false. 278 */ 279 public boolean hasAppShownWindows(); 280 281 /** 282 * Is this window visible? It is not visible if there is no 283 * surface, or we are in the process of running an exit animation 284 * that will remove the surface. 285 */ 286 boolean isVisibleLw(); 287 288 /** 289 * Like {@link #isVisibleLw}, but also counts a window that is currently 290 * "hidden" behind the keyguard as visible. This allows us to apply 291 * things like window flags that impact the keyguard. 292 */ 293 boolean isVisibleOrBehindKeyguardLw(); 294 295 /** 296 * Is this window currently visible to the user on-screen? It is 297 * displayed either if it is visible or it is currently running an 298 * animation before no longer being visible. Must be called with the 299 * window manager lock held. 300 */ 301 boolean isDisplayedLw(); 302 303 /** 304 * Return true if this window (or a window it is attached to, but not 305 * considering its app token) is currently animating. 306 */ 307 public boolean isAnimatingLw(); 308 309 /** 310 * Is this window considered to be gone for purposes of layout? 311 */ 312 boolean isGoneForLayoutLw(); 313 314 /** 315 * Returns true if this window has been shown on screen at some time in 316 * the past. Must be called with the window manager lock held. 317 */ 318 public boolean hasDrawnLw(); 319 320 /** 321 * Can be called by the policy to force a window to be hidden, 322 * regardless of whether the client or window manager would like 323 * it shown. Must be called with the window manager lock held. 324 * Returns true if {@link #showLw} was last called for the window. 325 */ 326 public boolean hideLw(boolean doAnimation); 327 328 /** 329 * Can be called to undo the effect of {@link #hideLw}, allowing a 330 * window to be shown as long as the window manager and client would 331 * also like it to be shown. Must be called with the window manager 332 * lock held. 333 * Returns true if {@link #hideLw} was last called for the window. 334 */ 335 public boolean showLw(boolean doAnimation); 336 337 /** 338 * Check whether the process hosting this window is currently alive. 339 */ 340 public boolean isAlive(); 341 } 342 343 /** 344 * Representation of a "fake window" that the policy has added to the 345 * window manager to consume events. 346 */ 347 public interface FakeWindow { 348 /** 349 * Remove the fake window from the window manager. 350 */ 351 void dismiss(); 352 } 353 354 /** 355 * Interface for calling back in to the window manager that is private 356 * between it and the policy. 357 */ 358 public interface WindowManagerFuncs { 359 public static final int LID_ABSENT = -1; 360 public static final int LID_CLOSED = 0; 361 public static final int LID_OPEN = 1; 362 363 /** 364 * Ask the window manager to re-evaluate the system UI flags. 365 */ 366 public void reevaluateStatusBarVisibility(); 367 368 /** 369 * Add a fake window to the window manager. This window sits 370 * at the top of the other windows and consumes events. 371 */ 372 public FakeWindow addFakeWindow(Looper looper, 373 InputEventReceiver.Factory inputEventReceiverFactory, 374 String name, int windowType, int layoutParamsFlags, boolean canReceiveKeys, 375 boolean hasFocus, boolean touchFullscreen); 376 377 /** 378 * Returns a code that describes the current state of the lid switch. 379 */ 380 public int getLidState(); 381 382 /** 383 * Creates an input channel that will receive all input from the input dispatcher. 384 */ 385 public InputChannel monitorInput(String name); 386 387 /** 388 * Switch the keyboard layout for the given device. 389 * Direction should be +1 or -1 to go to the next or previous keyboard layout. 390 */ 391 public void switchKeyboardLayout(int deviceId, int direction); 392 393 public void shutdown(boolean confirm); 394 public void rebootSafeMode(boolean confirm); 395 } 396 397 /** 398 * Bit mask that is set for all enter transition. 399 */ 400 public final int TRANSIT_ENTER_MASK = 0x1000; 401 402 /** 403 * Bit mask that is set for all exit transitions. 404 */ 405 public final int TRANSIT_EXIT_MASK = 0x2000; 406 407 /** Not set up for a transition. */ 408 public final int TRANSIT_UNSET = -1; 409 /** No animation for transition. */ 410 public final int TRANSIT_NONE = 0; 411 /** Window has been added to the screen. */ 412 public final int TRANSIT_ENTER = 1 | TRANSIT_ENTER_MASK; 413 /** Window has been removed from the screen. */ 414 public final int TRANSIT_EXIT = 2 | TRANSIT_EXIT_MASK; 415 /** Window has been made visible. */ 416 public final int TRANSIT_SHOW = 3 | TRANSIT_ENTER_MASK; 417 /** Window has been made invisible. */ 418 public final int TRANSIT_HIDE = 4 | TRANSIT_EXIT_MASK; 419 /** The "application starting" preview window is no longer needed, and will 420 * animate away to show the real window. */ 421 public final int TRANSIT_PREVIEW_DONE = 5; 422 /** A window in a new activity is being opened on top of an existing one 423 * in the same task. */ 424 public final int TRANSIT_ACTIVITY_OPEN = 6 | TRANSIT_ENTER_MASK; 425 /** The window in the top-most activity is being closed to reveal the 426 * previous activity in the same task. */ 427 public final int TRANSIT_ACTIVITY_CLOSE = 7 | TRANSIT_EXIT_MASK; 428 /** A window in a new task is being opened on top of an existing one 429 * in another activity's task. */ 430 public final int TRANSIT_TASK_OPEN = 8 | TRANSIT_ENTER_MASK; 431 /** A window in the top-most activity is being closed to reveal the 432 * previous activity in a different task. */ 433 public final int TRANSIT_TASK_CLOSE = 9 | TRANSIT_EXIT_MASK; 434 /** A window in an existing task is being displayed on top of an existing one 435 * in another activity's task. */ 436 public final int TRANSIT_TASK_TO_FRONT = 10 | TRANSIT_ENTER_MASK; 437 /** A window in an existing task is being put below all other tasks. */ 438 public final int TRANSIT_TASK_TO_BACK = 11 | TRANSIT_EXIT_MASK; 439 /** A window in a new activity that doesn't have a wallpaper is being 440 * opened on top of one that does, effectively closing the wallpaper. */ 441 public final int TRANSIT_WALLPAPER_CLOSE = 12 | TRANSIT_EXIT_MASK; 442 /** A window in a new activity that does have a wallpaper is being 443 * opened on one that didn't, effectively opening the wallpaper. */ 444 public final int TRANSIT_WALLPAPER_OPEN = 13 | TRANSIT_ENTER_MASK; 445 /** A window in a new activity is being opened on top of an existing one, 446 * and both are on top of the wallpaper. */ 447 public final int TRANSIT_WALLPAPER_INTRA_OPEN = 14 | TRANSIT_ENTER_MASK; 448 /** The window in the top-most activity is being closed to reveal the 449 * previous activity, and both are on top of he wallpaper. */ 450 public final int TRANSIT_WALLPAPER_INTRA_CLOSE = 15 | TRANSIT_EXIT_MASK; 451 452 // NOTE: screen off reasons are in order of significance, with more 453 // important ones lower than less important ones. 454 455 /** Screen turned off because of a device admin */ 456 public final int OFF_BECAUSE_OF_ADMIN = 1; 457 /** Screen turned off because of power button */ 458 public final int OFF_BECAUSE_OF_USER = 2; 459 /** Screen turned off because of timeout */ 460 public final int OFF_BECAUSE_OF_TIMEOUT = 3; 461 /** Screen turned off because of proximity sensor */ 462 public final int OFF_BECAUSE_OF_PROX_SENSOR = 4; 463 464 /** When not otherwise specified by the activity's screenOrientation, rotation should be 465 * determined by the system (that is, using sensors). */ 466 public final int USER_ROTATION_FREE = 0; 467 /** When not otherwise specified by the activity's screenOrientation, rotation is set by 468 * the user. */ 469 public final int USER_ROTATION_LOCKED = 1; 470 471 /** 472 * Perform initialization of the policy. 473 * 474 * @param context The system context we are running in. 475 */ 476 public void init(Context context, IWindowManager windowManager, 477 WindowManagerFuncs windowManagerFuncs); 478 479 /** 480 * Called by window manager once it has the initial, default native 481 * display dimensions. 482 */ 483 public void setInitialDisplaySize(Display display, int width, int height, int density); 484 485 /** 486 * Check permissions when adding a window. 487 * 488 * @param attrs The window's LayoutParams. 489 * 490 * @return {@link WindowManagerGlobal#ADD_OKAY} if the add can proceed; 491 * else an error code, usually 492 * {@link WindowManagerGlobal#ADD_PERMISSION_DENIED}, to abort the add. 493 */ 494 public int checkAddPermission(WindowManager.LayoutParams attrs); 495 496 /** 497 * Sanitize the layout parameters coming from a client. Allows the policy 498 * to do things like ensure that windows of a specific type can't take 499 * input focus. 500 * 501 * @param attrs The window layout parameters to be modified. These values 502 * are modified in-place. 503 */ 504 public void adjustWindowParamsLw(WindowManager.LayoutParams attrs); 505 506 /** 507 * After the window manager has computed the current configuration based 508 * on its knowledge of the display and input devices, it gives the policy 509 * a chance to adjust the information contained in it. If you want to 510 * leave it as-is, simply do nothing. 511 * 512 * <p>This method may be called by any thread in the window manager, but 513 * no internal locks in the window manager will be held. 514 * 515 * @param config The Configuration being computed, for you to change as 516 * desired. 517 * @param keyboardPresence Flags that indicate whether internal or external 518 * keyboards are present. 519 * @param navigationPresence Flags that indicate whether internal or external 520 * navigation devices are present. 521 */ 522 public void adjustConfigurationLw(Configuration config, int keyboardPresence, 523 int navigationPresence); 524 525 /** 526 * Assign a window type to a layer. Allows you to control how different 527 * kinds of windows are ordered on-screen. 528 * 529 * @param type The type of window being assigned. 530 * 531 * @return int An arbitrary integer used to order windows, with lower 532 * numbers below higher ones. 533 */ 534 public int windowTypeToLayerLw(int type); 535 536 /** 537 * Return how to Z-order sub-windows in relation to the window they are 538 * attached to. Return positive to have them ordered in front, negative for 539 * behind. 540 * 541 * @param type The sub-window type code. 542 * 543 * @return int Layer in relation to the attached window, where positive is 544 * above and negative is below. 545 */ 546 public int subWindowTypeToLayerLw(int type); 547 548 /** 549 * Get the highest layer (actually one more than) that the wallpaper is 550 * allowed to be in. 551 */ 552 public int getMaxWallpaperLayer(); 553 554 /** 555 * Return the window layer at which windows appear above the normal 556 * universe (that is no longer impacted by the universe background 557 * transform). 558 */ 559 public int getAboveUniverseLayer(); 560 561 /** 562 * Return true if the policy desires a full unified system nav bar. Otherwise, 563 * it is a phone-style status bar with optional nav bar. 564 */ 565 public boolean hasSystemNavBar(); 566 567 /** 568 * Return the display width available after excluding any screen 569 * decorations that can never be removed. That is, system bar or 570 * button bar. 571 */ 572 public int getNonDecorDisplayWidth(int fullWidth, int fullHeight, int rotation); 573 574 /** 575 * Return the display height available after excluding any screen 576 * decorations that can never be removed. That is, system bar or 577 * button bar. 578 */ 579 public int getNonDecorDisplayHeight(int fullWidth, int fullHeight, int rotation); 580 581 /** 582 * Return the available screen width that we should report for the 583 * configuration. This must be no larger than 584 * {@link #getNonDecorDisplayWidth(int, int, int)}; it may be smaller than 585 * that to account for more transient decoration like a status bar. 586 */ 587 public int getConfigDisplayWidth(int fullWidth, int fullHeight, int rotation); 588 589 /** 590 * Return the available screen height that we should report for the 591 * configuration. This must be no larger than 592 * {@link #getNonDecorDisplayHeight(int, int, int)}; it may be smaller than 593 * that to account for more transient decoration like a status bar. 594 */ 595 public int getConfigDisplayHeight(int fullWidth, int fullHeight, int rotation); 596 597 /** 598 * Return whether the given window should forcibly hide everything 599 * behind it. Typically returns true for the keyguard. 600 */ 601 public boolean doesForceHide(WindowState win, WindowManager.LayoutParams attrs); 602 603 /** 604 * Determine if a window that is behind one that is force hiding 605 * (as determined by {@link #doesForceHide}) should actually be hidden. 606 * For example, typically returns false for the status bar. Be careful 607 * to return false for any window that you may hide yourself, since this 608 * will conflict with what you set. 609 */ 610 public boolean canBeForceHidden(WindowState win, WindowManager.LayoutParams attrs); 611 612 /** 613 * Called when the system would like to show a UI to indicate that an 614 * application is starting. You can use this to add a 615 * APPLICATION_STARTING_TYPE window with the given appToken to the window 616 * manager (using the normal window manager APIs) that will be shown until 617 * the application displays its own window. This is called without the 618 * window manager locked so that you can call back into it. 619 * 620 * @param appToken Token of the application being started. 621 * @param packageName The name of the application package being started. 622 * @param theme Resource defining the application's overall visual theme. 623 * @param nonLocalizedLabel The default title label of the application if 624 * no data is found in the resource. 625 * @param labelRes The resource ID the application would like to use as its name. 626 * @param icon The resource ID the application would like to use as its icon. 627 * @param windowFlags Window layout flags. 628 * 629 * @return Optionally you can return the View that was used to create the 630 * window, for easy removal in removeStartingWindow. 631 * 632 * @see #removeStartingWindow 633 */ 634 public View addStartingWindow(IBinder appToken, String packageName, 635 int theme, CompatibilityInfo compatInfo, CharSequence nonLocalizedLabel, 636 int labelRes, int icon, int windowFlags); 637 638 /** 639 * Called when the first window of an application has been displayed, while 640 * {@link #addStartingWindow} has created a temporary initial window for 641 * that application. You should at this point remove the window from the 642 * window manager. This is called without the window manager locked so 643 * that you can call back into it. 644 * 645 * <p>Note: due to the nature of these functions not being called with the 646 * window manager locked, you must be prepared for this function to be 647 * called multiple times and/or an initial time with a null View window 648 * even if you previously returned one. 649 * 650 * @param appToken Token of the application that has started. 651 * @param window Window View that was returned by createStartingWindow. 652 * 653 * @see #addStartingWindow 654 */ 655 public void removeStartingWindow(IBinder appToken, View window); 656 657 /** 658 * Prepare for a window being added to the window manager. You can throw an 659 * exception here to prevent the window being added, or do whatever setup 660 * you need to keep track of the window. 661 * 662 * @param win The window being added. 663 * @param attrs The window's LayoutParams. 664 * 665 * @return {@link WindowManagerGlobal#ADD_OKAY} if the add can proceed, else an 666 * error code to abort the add. 667 */ 668 public int prepareAddWindowLw(WindowState win, 669 WindowManager.LayoutParams attrs); 670 671 /** 672 * Called when a window is being removed from a window manager. Must not 673 * throw an exception -- clean up as much as possible. 674 * 675 * @param win The window being removed. 676 */ 677 public void removeWindowLw(WindowState win); 678 679 /** 680 * Control the animation to run when a window's state changes. Return a 681 * non-0 number to force the animation to a specific resource ID, or 0 682 * to use the default animation. 683 * 684 * @param win The window that is changing. 685 * @param transit What is happening to the window: {@link #TRANSIT_ENTER}, 686 * {@link #TRANSIT_EXIT}, {@link #TRANSIT_SHOW}, or 687 * {@link #TRANSIT_HIDE}. 688 * 689 * @return Resource ID of the actual animation to use, or 0 for none. 690 */ 691 public int selectAnimationLw(WindowState win, int transit); 692 693 /** 694 * Create and return an animation to re-display a force hidden window. 695 */ 696 public Animation createForceHideEnterAnimation(boolean onWallpaper); 697 698 /** 699 * Called from the input reader thread before a key is enqueued. 700 * 701 * <p>There are some actions that need to be handled here because they 702 * affect the power state of the device, for example, the power keys. 703 * Generally, it's best to keep as little as possible in the queue thread 704 * because it's the most fragile. 705 * @param event The key event. 706 * @param policyFlags The policy flags associated with the key. 707 * @param isScreenOn True if the screen is already on 708 * 709 * @return The bitwise or of the {@link #ACTION_PASS_TO_USER}, 710 * {@link #ACTION_POKE_USER_ACTIVITY} and {@link #ACTION_GO_TO_SLEEP} flags. 711 */ 712 public int interceptKeyBeforeQueueing(KeyEvent event, int policyFlags, boolean isScreenOn); 713 714 /** 715 * Called from the input reader thread before a motion is enqueued when the screen is off. 716 * 717 * <p>There are some actions that need to be handled here because they 718 * affect the power state of the device, for example, waking on motions. 719 * Generally, it's best to keep as little as possible in the queue thread 720 * because it's the most fragile. 721 * @param policyFlags The policy flags associated with the motion. 722 * 723 * @return The bitwise or of the {@link #ACTION_PASS_TO_USER}, 724 * {@link #ACTION_POKE_USER_ACTIVITY} and {@link #ACTION_GO_TO_SLEEP} flags. 725 */ 726 public int interceptMotionBeforeQueueingWhenScreenOff(int policyFlags); 727 728 /** 729 * Called from the input dispatcher thread before a key is dispatched to a window. 730 * 731 * <p>Allows you to define 732 * behavior for keys that can not be overridden by applications. 733 * This method is called from the input thread, with no locks held. 734 * 735 * @param win The window that currently has focus. This is where the key 736 * event will normally go. 737 * @param event The key event. 738 * @param policyFlags The policy flags associated with the key. 739 * @return 0 if the key should be dispatched immediately, -1 if the key should 740 * not be dispatched ever, or a positive value indicating the number of 741 * milliseconds by which the key dispatch should be delayed before trying 742 * again. 743 */ 744 public long interceptKeyBeforeDispatching(WindowState win, KeyEvent event, int policyFlags); 745 746 /** 747 * Called from the input dispatcher thread when an application did not handle 748 * a key that was dispatched to it. 749 * 750 * <p>Allows you to define default global behavior for keys that were not handled 751 * by applications. This method is called from the input thread, with no locks held. 752 * 753 * @param win The window that currently has focus. This is where the key 754 * event will normally go. 755 * @param event The key event. 756 * @param policyFlags The policy flags associated with the key. 757 * @return Returns an alternate key event to redispatch as a fallback, or null to give up. 758 * The caller is responsible for recycling the key event. 759 */ 760 public KeyEvent dispatchUnhandledKey(WindowState win, KeyEvent event, int policyFlags); 761 762 /** 763 * Called when layout of the windows is about to start. 764 * 765 * @param displayWidth The current full width of the screen. 766 * @param displayHeight The current full height of the screen. 767 * @param displayRotation The current rotation being applied to the base 768 * window. 769 */ 770 public void beginLayoutLw(int displayWidth, int displayHeight, int displayRotation); 771 772 /** 773 * Return the rectangle of the screen currently covered by system decorations. 774 * This will be called immediately after {@link #layoutWindowLw}. It can 775 * fill in the rectangle to indicate any part of the screen that it knows 776 * for sure is covered by system decor such as the status bar. The rectangle 777 * is initially set to the actual size of the screen, indicating nothing is 778 * covered. 779 * 780 * @param systemRect The rectangle of the screen that is not covered by 781 * system decoration. 782 * @return Returns the layer above which the system rectangle should 783 * not be applied. 784 */ 785 public int getSystemDecorRectLw(Rect systemRect); 786 787 /** 788 * Called for each window attached to the window manager as layout is 789 * proceeding. The implementation of this function must take care of 790 * setting the window's frame, either here or in finishLayout(). 791 * 792 * @param win The window being positioned. 793 * @param attrs The LayoutParams of the window. 794 * @param attached For sub-windows, the window it is attached to; this 795 * window will already have had layoutWindow() called on it 796 * so you can use its Rect. Otherwise null. 797 */ 798 public void layoutWindowLw(WindowState win, 799 WindowManager.LayoutParams attrs, WindowState attached); 800 801 802 /** 803 * Return the insets for the areas covered by system windows. These values 804 * are computed on the most recent layout, so they are not guaranteed to 805 * be correct. 806 * 807 * @param attrs The LayoutParams of the window. 808 * @param contentInset The areas covered by system windows, expressed as positive insets 809 * 810 */ 811 public void getContentInsetHintLw(WindowManager.LayoutParams attrs, Rect contentInset); 812 813 /** 814 * Called when layout of the windows is finished. After this function has 815 * returned, all windows given to layoutWindow() <em>must</em> have had a 816 * frame assigned. 817 */ 818 public void finishLayoutLw(); 819 820 /** Layout state may have changed (so another layout will be performed) */ 821 static final int FINISH_LAYOUT_REDO_LAYOUT = 0x0001; 822 /** Configuration state may have changed */ 823 static final int FINISH_LAYOUT_REDO_CONFIG = 0x0002; 824 /** Wallpaper may need to move */ 825 static final int FINISH_LAYOUT_REDO_WALLPAPER = 0x0004; 826 /** Need to recompute animations */ 827 static final int FINISH_LAYOUT_REDO_ANIM = 0x0008; 828 829 /** 830 * Called when animation of the windows is about to start. 831 * 832 * @param displayWidth The current full width of the screen. 833 * @param displayHeight The current full height of the screen. 834 */ 835 public void beginAnimationLw(int displayWidth, int displayHeight); 836 837 /** 838 * Called each time a window is animating. 839 * 840 * @param win The window being positioned. 841 * @param attrs The LayoutParams of the window. 842 */ 843 public void animatingWindowLw(WindowState win, 844 WindowManager.LayoutParams attrs); 845 846 /** 847 * Called when animation of the windows is finished. If in this function you do 848 * something that may have modified the animation state of another window, 849 * be sure to return true in order to perform another animation frame. 850 * 851 * @return Return any bit set of {@link #FINISH_LAYOUT_REDO_LAYOUT}, 852 * {@link #FINISH_LAYOUT_REDO_CONFIG}, {@link #FINISH_LAYOUT_REDO_WALLPAPER}, 853 * or {@link #FINISH_LAYOUT_REDO_ANIM}. 854 */ 855 public int finishAnimationLw(); 856 857 /** 858 * Return true if it is okay to perform animations for an app transition 859 * that is about to occur. You may return false for this if, for example, 860 * the lock screen is currently displayed so the switch should happen 861 * immediately. 862 */ 863 public boolean allowAppAnimationsLw(); 864 865 866 /** 867 * A new window has been focused. 868 */ 869 public int focusChangedLw(WindowState lastFocus, WindowState newFocus); 870 871 /** 872 * Called after the screen turns off. 873 * 874 * @param why {@link #OFF_BECAUSE_OF_USER} or 875 * {@link #OFF_BECAUSE_OF_TIMEOUT}. 876 */ 877 public void screenTurnedOff(int why); 878 879 public interface ScreenOnListener { 880 void onScreenOn(); 881 } 882 883 /** 884 * Called when the power manager would like to turn the screen on. 885 * Must call back on the listener to tell it when the higher-level system 886 * is ready for the screen to go on (i.e. the lock screen is shown). 887 */ 888 public void screenTurningOn(ScreenOnListener screenOnListener); 889 890 /** 891 * Return whether the screen is about to turn on or is currently on. 892 */ 893 public boolean isScreenOnEarly(); 894 895 /** 896 * Return whether the screen is fully turned on. 897 */ 898 public boolean isScreenOnFully(); 899 900 /** 901 * Tell the policy that the lid switch has changed state. 902 * @param whenNanos The time when the change occurred in uptime nanoseconds. 903 * @param lidOpen True if the lid is now open. 904 */ 905 public void notifyLidSwitchChanged(long whenNanos, boolean lidOpen); 906 907 /** 908 * Tell the policy if anyone is requesting that keyguard not come on. 909 * 910 * @param enabled Whether keyguard can be on or not. does not actually 911 * turn it on, unless it was previously disabled with this function. 912 * 913 * @see android.app.KeyguardManager.KeyguardLock#disableKeyguard() 914 * @see android.app.KeyguardManager.KeyguardLock#reenableKeyguard() 915 */ 916 public void enableKeyguard(boolean enabled); 917 918 /** 919 * Callback used by {@link WindowManagerPolicy#exitKeyguardSecurely} 920 */ 921 interface OnKeyguardExitResult { 922 void onKeyguardExitResult(boolean success); 923 } 924 925 /** 926 * Tell the policy if anyone is requesting the keyguard to exit securely 927 * (this would be called after the keyguard was disabled) 928 * @param callback Callback to send the result back. 929 * @see android.app.KeyguardManager#exitKeyguardSecurely(android.app.KeyguardManager.OnKeyguardExitResult) 930 */ 931 void exitKeyguardSecurely(OnKeyguardExitResult callback); 932 933 /** 934 * isKeyguardLocked 935 * 936 * Return whether the keyguard is currently locked. 937 * 938 * @return true if in keyguard is locked. 939 */ 940 public boolean isKeyguardLocked(); 941 942 /** 943 * isKeyguardSecure 944 * 945 * Return whether the keyguard requires a password to unlock. 946 * 947 * @return true if in keyguard is secure. 948 */ 949 public boolean isKeyguardSecure(); 950 951 /** 952 * inKeyguardRestrictedKeyInputMode 953 * 954 * if keyguard screen is showing or in restricted key input mode (i.e. in 955 * keyguard password emergency screen). When in such mode, certain keys, 956 * such as the Home key and the right soft keys, don't work. 957 * 958 * @return true if in keyguard restricted input mode. 959 */ 960 public boolean inKeyguardRestrictedKeyInputMode(); 961 962 /** 963 * Ask the policy to dismiss the keyguard, if it is currently shown. 964 */ 965 public void dismissKeyguardLw(); 966 967 /** 968 * Given an orientation constant, returns the appropriate surface rotation, 969 * taking into account sensors, docking mode, rotation lock, and other factors. 970 * 971 * @param orientation An orientation constant, such as 972 * {@link android.content.pm.ActivityInfo#SCREEN_ORIENTATION_LANDSCAPE}. 973 * @param lastRotation The most recently used rotation. 974 * @return The surface rotation to use. 975 */ 976 public int rotationForOrientationLw(int orientation, int lastRotation); 977 978 /** 979 * Given an orientation constant and a rotation, returns true if the rotation 980 * has compatible metrics to the requested orientation. For example, if 981 * the application requested landscape and got seascape, then the rotation 982 * has compatible metrics; if the application requested portrait and got landscape, 983 * then the rotation has incompatible metrics; if the application did not specify 984 * a preference, then anything goes. 985 * 986 * @param orientation An orientation constant, such as 987 * {@link android.content.pm.ActivityInfo#SCREEN_ORIENTATION_LANDSCAPE}. 988 * @param rotation The rotation to check. 989 * @return True if the rotation is compatible with the requested orientation. 990 */ 991 public boolean rotationHasCompatibleMetricsLw(int orientation, int rotation); 992 993 /** 994 * Called by the window manager when the rotation changes. 995 * 996 * @param rotation The new rotation. 997 */ 998 public void setRotationLw(int rotation); 999 1000 /** 1001 * Called when the system is mostly done booting to set whether 1002 * the system should go into safe mode. 1003 */ 1004 public void setSafeMode(boolean safeMode); 1005 1006 /** 1007 * Called when the system is mostly done booting. 1008 */ 1009 public void systemReady(); 1010 1011 /** 1012 * Called when the system is done booting to the point where the 1013 * user can start interacting with it. 1014 */ 1015 public void systemBooted(); 1016 1017 /** 1018 * Show boot time message to the user. 1019 */ 1020 public void showBootMessage(final CharSequence msg, final boolean always); 1021 1022 /** 1023 * Hide the UI for showing boot messages, never to be displayed again. 1024 */ 1025 public void hideBootMessages(); 1026 1027 /** 1028 * Called when userActivity is signalled in the power manager. 1029 * This is safe to call from any thread, with any window manager locks held or not. 1030 */ 1031 public void userActivity(); 1032 1033 /** 1034 * Called when we have finished booting and can now display the home 1035 * screen to the user. This will happen after systemReady(), and at 1036 * this point the display is active. 1037 */ 1038 public void enableScreenAfterBoot(); 1039 1040 public void setCurrentOrientationLw(int newOrientation); 1041 1042 /** 1043 * Call from application to perform haptic feedback on its window. 1044 */ 1045 public boolean performHapticFeedbackLw(WindowState win, int effectId, boolean always); 1046 1047 /** 1048 * Called when we have started keeping the screen on because a window 1049 * requesting this has become visible. 1050 */ 1051 public void screenOnStartedLw(); 1052 1053 /** 1054 * Called when we have stopped keeping the screen on because the last window 1055 * requesting this is no longer visible. 1056 */ 1057 public void screenOnStoppedLw(); 1058 1059 /** 1060 * Return false to disable key repeat events from being generated. 1061 */ 1062 public boolean allowKeyRepeat(); 1063 1064 /** 1065 * Inform the policy that the user has chosen a preferred orientation ("rotation lock"). 1066 * 1067 * @param mode One of {@link WindowManagerPolicy#USER_ROTATION_LOCKED} or 1068 * {@link * WindowManagerPolicy#USER_ROTATION_FREE}. 1069 * @param rotation One of {@link Surface#ROTATION_0}, {@link Surface#ROTATION_90}, 1070 * {@link Surface#ROTATION_180}, {@link Surface#ROTATION_270}. 1071 */ 1072 public void setUserRotationMode(int mode, int rotation); 1073 1074 /** 1075 * Called when a new system UI visibility is being reported, allowing 1076 * the policy to adjust what is actually reported. 1077 * @param visibility The raw visiblity reported by the status bar. 1078 * @return The new desired visibility. 1079 */ 1080 public int adjustSystemUiVisibilityLw(int visibility); 1081 1082 /** 1083 * Specifies whether there is an on-screen navigation bar separate from the status bar. 1084 */ 1085 public boolean hasNavigationBar(); 1086 1087 /** 1088 * Lock the device now. 1089 */ 1090 public void lockNow(); 1091 1092 /** 1093 * Set the last used input method window state. This state is used to make IME transition 1094 * smooth. 1095 * @hide 1096 */ 1097 public void setLastInputMethodWindowLw(WindowState ime, WindowState target); 1098 1099 /** 1100 * Print the WindowManagerPolicy's state into the given stream. 1101 * 1102 * @param prefix Text to print at the front of each line. 1103 * @param writer The PrintWriter to which you should dump your state. This will be 1104 * closed for you after you return. 1105 * @param args additional arguments to the dump request. 1106 */ 1107 public void dump(String prefix, PrintWriter writer, String[] args); 1108} 1109