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