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