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