Window.java revision 33b974393b6fadcefc896ec4a0f9b66724f61e9f
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.content.res.TypedArray; 22import android.graphics.PixelFormat; 23import android.graphics.drawable.Drawable; 24import android.net.Uri; 25import android.os.Bundle; 26import android.os.IBinder; 27import android.view.accessibility.AccessibilityEvent; 28 29/** 30 * Abstract base class for a top-level window look and behavior policy. An 31 * instance of this class should be used as the top-level view added to the 32 * window manager. It provides standard UI policies such as a background, title 33 * area, default key processing, etc. 34 * 35 * <p>The only existing implementation of this abstract class is 36 * android.policy.PhoneWindow, which you should instantiate when needing a 37 * Window. Eventually that class will be refactored and a factory method 38 * added for creating Window instances without knowing about a particular 39 * implementation. 40 */ 41public abstract class Window { 42 /** Flag for the "options panel" feature. This is enabled by default. */ 43 public static final int FEATURE_OPTIONS_PANEL = 0; 44 /** Flag for the "no title" feature, turning off the title at the top 45 * of the screen. */ 46 public static final int FEATURE_NO_TITLE = 1; 47 /** Flag for the progress indicator feature */ 48 public static final int FEATURE_PROGRESS = 2; 49 /** Flag for having an icon on the left side of the title bar */ 50 public static final int FEATURE_LEFT_ICON = 3; 51 /** Flag for having an icon on the right side of the title bar */ 52 public static final int FEATURE_RIGHT_ICON = 4; 53 /** Flag for indeterminate progress */ 54 public static final int FEATURE_INDETERMINATE_PROGRESS = 5; 55 /** Flag for the context menu. This is enabled by default. */ 56 public static final int FEATURE_CONTEXT_MENU = 6; 57 /** Flag for custom title. You cannot combine this feature with other title features. */ 58 public static final int FEATURE_CUSTOM_TITLE = 7; 59 /** Flag for asking for an OpenGL enabled window. 60 All 2D graphics will be handled by OpenGL ES. 61 @hide 62 */ 63 public static final int FEATURE_OPENGL = 8; 64 /** 65 * Flag for enabling the Action Bar. 66 * This is enabled by default for some devices. The Action Bar 67 * replaces the title bar and provides an alternate location 68 * for an on-screen menu button on some devices. 69 */ 70 public static final int FEATURE_ACTION_BAR = 9; 71 /** Flag for setting the progress bar's visibility to VISIBLE */ 72 public static final int PROGRESS_VISIBILITY_ON = -1; 73 /** Flag for setting the progress bar's visibility to GONE */ 74 public static final int PROGRESS_VISIBILITY_OFF = -2; 75 /** Flag for setting the progress bar's indeterminate mode on */ 76 public static final int PROGRESS_INDETERMINATE_ON = -3; 77 /** Flag for setting the progress bar's indeterminate mode off */ 78 public static final int PROGRESS_INDETERMINATE_OFF = -4; 79 /** Starting value for the (primary) progress */ 80 public static final int PROGRESS_START = 0; 81 /** Ending value for the (primary) progress */ 82 public static final int PROGRESS_END = 10000; 83 /** Lowest possible value for the secondary progress */ 84 public static final int PROGRESS_SECONDARY_START = 20000; 85 /** Highest possible value for the secondary progress */ 86 public static final int PROGRESS_SECONDARY_END = 30000; 87 88 /** The default features enabled */ 89 @SuppressWarnings({"PointlessBitwiseExpression"}) 90 protected static final int DEFAULT_FEATURES = (1 << FEATURE_OPTIONS_PANEL) | 91 (1 << FEATURE_CONTEXT_MENU); 92 93 /** 94 * The ID that the main layout in the XML layout file should have. 95 */ 96 public static final int ID_ANDROID_CONTENT = com.android.internal.R.id.content; 97 98 private final Context mContext; 99 100 private TypedArray mWindowStyle; 101 private Callback mCallback; 102 private WindowManager mWindowManager; 103 private IBinder mAppToken; 104 private String mAppName; 105 private Window mContainer; 106 private Window mActiveChild; 107 private boolean mIsActive = false; 108 private boolean mHasChildren = false; 109 private int mForcedWindowFlags = 0; 110 111 private int mFeatures = DEFAULT_FEATURES; 112 private int mLocalFeatures = DEFAULT_FEATURES; 113 114 private boolean mHaveWindowFormat = false; 115 private int mDefaultWindowFormat = PixelFormat.OPAQUE; 116 117 private boolean mHasSoftInputMode = false; 118 119 // The current window attributes. 120 private final WindowManager.LayoutParams mWindowAttributes = 121 new WindowManager.LayoutParams(); 122 123 /** 124 * API from a Window back to its caller. This allows the client to 125 * intercept key dispatching, panels and menus, etc. 126 */ 127 public interface Callback { 128 /** 129 * Called to process key events. At the very least your 130 * implementation must call 131 * {@link android.view.Window#superDispatchKeyEvent} to do the 132 * standard key processing. 133 * 134 * @param event The key event. 135 * 136 * @return boolean Return true if this event was consumed. 137 */ 138 public boolean dispatchKeyEvent(KeyEvent event); 139 140 /** 141 * Called to process touch screen events. At the very least your 142 * implementation must call 143 * {@link android.view.Window#superDispatchTouchEvent} to do the 144 * standard touch screen processing. 145 * 146 * @param event The touch screen event. 147 * 148 * @return boolean Return true if this event was consumed. 149 */ 150 public boolean dispatchTouchEvent(MotionEvent event); 151 152 /** 153 * Called to process trackball events. At the very least your 154 * implementation must call 155 * {@link android.view.Window#superDispatchTrackballEvent} to do the 156 * standard trackball processing. 157 * 158 * @param event The trackball event. 159 * 160 * @return boolean Return true if this event was consumed. 161 */ 162 public boolean dispatchTrackballEvent(MotionEvent event); 163 164 /** 165 * Called to process population of {@link AccessibilityEvent}s. 166 * 167 * @param event The event. 168 * 169 * @return boolean Return true if event population was completed. 170 */ 171 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event); 172 173 /** 174 * Instantiate the view to display in the panel for 'featureId'. 175 * You can return null, in which case the default content (typically 176 * a menu) will be created for you. 177 * 178 * @param featureId Which panel is being created. 179 * 180 * @return view The top-level view to place in the panel. 181 * 182 * @see #onPreparePanel 183 */ 184 public View onCreatePanelView(int featureId); 185 186 /** 187 * Initialize the contents of the menu for panel 'featureId'. This is 188 * called if onCreatePanelView() returns null, giving you a standard 189 * menu in which you can place your items. It is only called once for 190 * the panel, the first time it is shown. 191 * 192 * <p>You can safely hold on to <var>menu</var> (and any items created 193 * from it), making modifications to it as desired, until the next 194 * time onCreatePanelMenu() is called for this feature. 195 * 196 * @param featureId The panel being created. 197 * @param menu The menu inside the panel. 198 * 199 * @return boolean You must return true for the panel to be displayed; 200 * if you return false it will not be shown. 201 */ 202 public boolean onCreatePanelMenu(int featureId, Menu menu); 203 204 /** 205 * Prepare a panel to be displayed. This is called right before the 206 * panel window is shown, every time it is shown. 207 * 208 * @param featureId The panel that is being displayed. 209 * @param view The View that was returned by onCreatePanelView(). 210 * @param menu If onCreatePanelView() returned null, this is the Menu 211 * being displayed in the panel. 212 * 213 * @return boolean You must return true for the panel to be displayed; 214 * if you return false it will not be shown. 215 * 216 * @see #onCreatePanelView 217 */ 218 public boolean onPreparePanel(int featureId, View view, Menu menu); 219 220 /** 221 * Called when a panel's menu is opened by the user. This may also be 222 * called when the menu is changing from one type to another (for 223 * example, from the icon menu to the expanded menu). 224 * 225 * @param featureId The panel that the menu is in. 226 * @param menu The menu that is opened. 227 * @return Return true to allow the menu to open, or false to prevent 228 * the menu from opening. 229 */ 230 public boolean onMenuOpened(int featureId, Menu menu); 231 232 /** 233 * Called when a panel's menu item has been selected by the user. 234 * 235 * @param featureId The panel that the menu is in. 236 * @param item The menu item that was selected. 237 * 238 * @return boolean Return true to finish processing of selection, or 239 * false to perform the normal menu handling (calling its 240 * Runnable or sending a Message to its target Handler). 241 */ 242 public boolean onMenuItemSelected(int featureId, MenuItem item); 243 244 /** 245 * This is called whenever the current window attributes change. 246 * 247 */ 248 public void onWindowAttributesChanged(WindowManager.LayoutParams attrs); 249 250 /** 251 * This hook is called whenever the content view of the screen changes 252 * (due to a call to 253 * {@link Window#setContentView(View, android.view.ViewGroup.LayoutParams) 254 * Window.setContentView} or 255 * {@link Window#addContentView(View, android.view.ViewGroup.LayoutParams) 256 * Window.addContentView}). 257 */ 258 public void onContentChanged(); 259 260 /** 261 * This hook is called whenever the window focus changes. See 262 * {@link View#onWindowFocusChanged(boolean) 263 * View.onWindowFocusChanged(boolean)} for more information. 264 * 265 * @param hasFocus Whether the window now has focus. 266 */ 267 public void onWindowFocusChanged(boolean hasFocus); 268 269 /** 270 * Called when the window has been attached to the window manager. 271 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()} 272 * for more information. 273 */ 274 public void onAttachedToWindow(); 275 276 /** 277 * Called when the window has been attached to the window manager. 278 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()} 279 * for more information. 280 */ 281 public void onDetachedFromWindow(); 282 283 /** 284 * Called when a panel is being closed. If another logical subsequent 285 * panel is being opened (and this panel is being closed to make room for the subsequent 286 * panel), this method will NOT be called. 287 * 288 * @param featureId The panel that is being displayed. 289 * @param menu If onCreatePanelView() returned null, this is the Menu 290 * being displayed in the panel. 291 */ 292 public void onPanelClosed(int featureId, Menu menu); 293 294 /** 295 * Called when the user signals the desire to start a search. 296 * 297 * @return true if search launched, false if activity refuses (blocks) 298 * 299 * @see android.app.Activity#onSearchRequested() 300 */ 301 public boolean onSearchRequested(); 302 } 303 304 public Window(Context context) { 305 mContext = context; 306 } 307 308 /** 309 * Return the Context this window policy is running in, for retrieving 310 * resources and other information. 311 * 312 * @return Context The Context that was supplied to the constructor. 313 */ 314 public final Context getContext() { 315 return mContext; 316 } 317 318 /** 319 * Return the {@link android.R.styleable#Window} attributes from this 320 * window's theme. 321 */ 322 public final TypedArray getWindowStyle() { 323 synchronized (this) { 324 if (mWindowStyle == null) { 325 mWindowStyle = mContext.obtainStyledAttributes( 326 com.android.internal.R.styleable.Window); 327 } 328 return mWindowStyle; 329 } 330 } 331 332 /** 333 * Set the container for this window. If not set, the DecorWindow 334 * operates as a top-level window; otherwise, it negotiates with the 335 * container to display itself appropriately. 336 * 337 * @param container The desired containing Window. 338 */ 339 public void setContainer(Window container) { 340 mContainer = container; 341 if (container != null) { 342 // Embedded screens never have a title. 343 mFeatures |= 1<<FEATURE_NO_TITLE; 344 mLocalFeatures |= 1<<FEATURE_NO_TITLE; 345 container.mHasChildren = true; 346 } 347 } 348 349 /** 350 * Return the container for this Window. 351 * 352 * @return Window The containing window, or null if this is a 353 * top-level window. 354 */ 355 public final Window getContainer() { 356 return mContainer; 357 } 358 359 public final boolean hasChildren() { 360 return mHasChildren; 361 } 362 363 /** 364 * Set the window manager for use by this Window to, for example, 365 * display panels. This is <em>not</em> used for displaying the 366 * Window itself -- that must be done by the client. 367 * 368 * @param wm The ViewManager for adding new windows. 369 */ 370 public void setWindowManager(WindowManager wm, 371 IBinder appToken, String appName) { 372 mAppToken = appToken; 373 mAppName = appName; 374 if (wm == null) { 375 wm = WindowManagerImpl.getDefault(); 376 } 377 mWindowManager = new LocalWindowManager(wm); 378 } 379 380 private class LocalWindowManager implements WindowManager { 381 LocalWindowManager(WindowManager wm) { 382 mWindowManager = wm; 383 mDefaultDisplay = mContext.getResources().getDefaultDisplay( 384 mWindowManager.getDefaultDisplay()); 385 } 386 387 public final void addView(View view, ViewGroup.LayoutParams params) { 388 // Let this throw an exception on a bad params. 389 WindowManager.LayoutParams wp = (WindowManager.LayoutParams)params; 390 CharSequence curTitle = wp.getTitle(); 391 if (wp.type >= WindowManager.LayoutParams.FIRST_SUB_WINDOW && 392 wp.type <= WindowManager.LayoutParams.LAST_SUB_WINDOW) { 393 if (wp.token == null) { 394 View decor = peekDecorView(); 395 if (decor != null) { 396 wp.token = decor.getWindowToken(); 397 } 398 } 399 if (curTitle == null || curTitle.length() == 0) { 400 String title; 401 if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA) { 402 title="Media"; 403 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY) { 404 title="MediaOvr"; 405 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_PANEL) { 406 title="Panel"; 407 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL) { 408 title="SubPanel"; 409 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG) { 410 title="AtchDlg"; 411 } else { 412 title=Integer.toString(wp.type); 413 } 414 if (mAppName != null) { 415 title += ":" + mAppName; 416 } 417 wp.setTitle(title); 418 } 419 } else { 420 if (wp.token == null) { 421 wp.token = mContainer == null ? mAppToken : mContainer.mAppToken; 422 } 423 if ((curTitle == null || curTitle.length() == 0) 424 && mAppName != null) { 425 wp.setTitle(mAppName); 426 } 427 } 428 if (wp.packageName == null) { 429 wp.packageName = mContext.getPackageName(); 430 } 431 mWindowManager.addView(view, params); 432 } 433 434 public void updateViewLayout(View view, ViewGroup.LayoutParams params) { 435 mWindowManager.updateViewLayout(view, params); 436 } 437 438 public final void removeView(View view) { 439 mWindowManager.removeView(view); 440 } 441 442 public final void removeViewImmediate(View view) { 443 mWindowManager.removeViewImmediate(view); 444 } 445 446 public Display getDefaultDisplay() { 447 return mDefaultDisplay; 448 } 449 450 private final WindowManager mWindowManager; 451 452 private final Display mDefaultDisplay; 453 } 454 455 /** 456 * Return the window manager allowing this Window to display its own 457 * windows. 458 * 459 * @return WindowManager The ViewManager. 460 */ 461 public WindowManager getWindowManager() { 462 return mWindowManager; 463 } 464 465 /** 466 * Set the Callback interface for this window, used to intercept key 467 * events and other dynamic operations in the window. 468 * 469 * @param callback The desired Callback interface. 470 */ 471 public void setCallback(Callback callback) { 472 mCallback = callback; 473 } 474 475 /** 476 * Return the current Callback interface for this window. 477 */ 478 public final Callback getCallback() { 479 return mCallback; 480 } 481 482 /** 483 * Return whether this window is being displayed with a floating style 484 * (based on the {@link android.R.attr#windowIsFloating} attribute in 485 * the style/theme). 486 * 487 * @return Returns true if the window is configured to be displayed floating 488 * on top of whatever is behind it. 489 */ 490 public abstract boolean isFloating(); 491 492 /** 493 * Set the width and height layout parameters of the window. The default 494 * for both of these is MATCH_PARENT; you can change them to WRAP_CONTENT to 495 * make a window that is not full-screen. 496 * 497 * @param width The desired layout width of the window. 498 * @param height The desired layout height of the window. 499 */ 500 public void setLayout(int width, int height) 501 { 502 final WindowManager.LayoutParams attrs = getAttributes(); 503 attrs.width = width; 504 attrs.height = height; 505 if (mCallback != null) { 506 mCallback.onWindowAttributesChanged(attrs); 507 } 508 } 509 510 /** 511 * Set the gravity of the window, as per the Gravity constants. This 512 * controls how the window manager is positioned in the overall window; it 513 * is only useful when using WRAP_CONTENT for the layout width or height. 514 * 515 * @param gravity The desired gravity constant. 516 * 517 * @see Gravity 518 * @see #setLayout 519 */ 520 public void setGravity(int gravity) 521 { 522 final WindowManager.LayoutParams attrs = getAttributes(); 523 attrs.gravity = gravity; 524 if (mCallback != null) { 525 mCallback.onWindowAttributesChanged(attrs); 526 } 527 } 528 529 /** 530 * Set the type of the window, as per the WindowManager.LayoutParams 531 * types. 532 * 533 * @param type The new window type (see WindowManager.LayoutParams). 534 */ 535 public void setType(int type) { 536 final WindowManager.LayoutParams attrs = getAttributes(); 537 attrs.type = type; 538 if (mCallback != null) { 539 mCallback.onWindowAttributesChanged(attrs); 540 } 541 } 542 543 /** 544 * Set the format of window, as per the PixelFormat types. This overrides 545 * the default format that is selected by the Window based on its 546 * window decorations. 547 * 548 * @param format The new window format (see PixelFormat). Use 549 * PixelFormat.UNKNOWN to allow the Window to select 550 * the format. 551 * 552 * @see PixelFormat 553 */ 554 public void setFormat(int format) { 555 final WindowManager.LayoutParams attrs = getAttributes(); 556 if (format != PixelFormat.UNKNOWN) { 557 attrs.format = format; 558 mHaveWindowFormat = true; 559 } else { 560 attrs.format = mDefaultWindowFormat; 561 mHaveWindowFormat = false; 562 } 563 if (mCallback != null) { 564 mCallback.onWindowAttributesChanged(attrs); 565 } 566 } 567 568 /** 569 * Specify custom animations to use for the window, as per 570 * {@link WindowManager.LayoutParams#windowAnimations 571 * WindowManager.LayoutParams.windowAnimations}. Providing anything besides 572 * 0 here will override the animations the window would 573 * normally retrieve from its theme. 574 */ 575 public void setWindowAnimations(int resId) { 576 final WindowManager.LayoutParams attrs = getAttributes(); 577 attrs.windowAnimations = resId; 578 if (mCallback != null) { 579 mCallback.onWindowAttributesChanged(attrs); 580 } 581 } 582 583 /** 584 * Specify an explicit soft input mode to use for the window, as per 585 * {@link WindowManager.LayoutParams#softInputMode 586 * WindowManager.LayoutParams.softInputMode}. Providing anything besides 587 * "unspecified" here will override the input mode the window would 588 * normally retrieve from its theme. 589 */ 590 public void setSoftInputMode(int mode) { 591 final WindowManager.LayoutParams attrs = getAttributes(); 592 if (mode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) { 593 attrs.softInputMode = mode; 594 mHasSoftInputMode = true; 595 } else { 596 mHasSoftInputMode = false; 597 } 598 if (mCallback != null) { 599 mCallback.onWindowAttributesChanged(attrs); 600 } 601 } 602 603 /** 604 * Convenience function to set the flag bits as specified in flags, as 605 * per {@link #setFlags}. 606 * @param flags The flag bits to be set. 607 * @see #setFlags 608 */ 609 public void addFlags(int flags) { 610 setFlags(flags, flags); 611 } 612 613 /** 614 * Convenience function to clear the flag bits as specified in flags, as 615 * per {@link #setFlags}. 616 * @param flags The flag bits to be cleared. 617 * @see #setFlags 618 */ 619 public void clearFlags(int flags) { 620 setFlags(0, flags); 621 } 622 623 /** 624 * Set the flags of the window, as per the 625 * {@link WindowManager.LayoutParams WindowManager.LayoutParams} 626 * flags. 627 * 628 * <p>Note that some flags must be set before the window decoration is 629 * created (by the first call to 630 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} or 631 * {@link #getDecorView()}: 632 * {@link WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN} and 633 * {@link WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR}. These 634 * will be set for you based on the {@link android.R.attr#windowIsFloating} 635 * attribute. 636 * 637 * @param flags The new window flags (see WindowManager.LayoutParams). 638 * @param mask Which of the window flag bits to modify. 639 */ 640 public void setFlags(int flags, int mask) { 641 final WindowManager.LayoutParams attrs = getAttributes(); 642 attrs.flags = (attrs.flags&~mask) | (flags&mask); 643 mForcedWindowFlags |= mask; 644 if (mCallback != null) { 645 mCallback.onWindowAttributesChanged(attrs); 646 } 647 } 648 649 /** 650 * Specify custom window attributes. <strong>PLEASE NOTE:</strong> the 651 * layout params you give here should generally be from values previously 652 * retrieved with {@link #getAttributes()}; you probably do not want to 653 * blindly create and apply your own, since this will blow away any values 654 * set by the framework that you are not interested in. 655 * 656 * @param a The new window attributes, which will completely override any 657 * current values. 658 */ 659 public void setAttributes(WindowManager.LayoutParams a) { 660 mWindowAttributes.copyFrom(a); 661 if (mCallback != null) { 662 mCallback.onWindowAttributesChanged(mWindowAttributes); 663 } 664 } 665 666 /** 667 * Retrieve the current window attributes associated with this panel. 668 * 669 * @return WindowManager.LayoutParams Either the existing window 670 * attributes object, or a freshly created one if there is none. 671 */ 672 public final WindowManager.LayoutParams getAttributes() { 673 return mWindowAttributes; 674 } 675 676 /** 677 * Return the window flags that have been explicitly set by the client, 678 * so will not be modified by {@link #getDecorView}. 679 */ 680 protected final int getForcedWindowFlags() { 681 return mForcedWindowFlags; 682 } 683 684 /** 685 * Has the app specified their own soft input mode? 686 */ 687 protected final boolean hasSoftInputMode() { 688 return mHasSoftInputMode; 689 } 690 691 /** 692 * Enable extended screen features. This must be called before 693 * setContentView(). May be called as many times as desired as long as it 694 * is before setContentView(). If not called, no extended features 695 * will be available. You can not turn off a feature once it is requested. 696 * You canot use other title features with {@link #FEATURE_CUSTOM_TITLE}. 697 * 698 * @param featureId The desired features, defined as constants by Window. 699 * @return The features that are now set. 700 */ 701 public boolean requestFeature(int featureId) { 702 final int flag = 1<<featureId; 703 mFeatures |= flag; 704 mLocalFeatures |= mContainer != null ? (flag&~mContainer.mFeatures) : flag; 705 return (mFeatures&flag) != 0; 706 } 707 708 public final void makeActive() { 709 if (mContainer != null) { 710 if (mContainer.mActiveChild != null) { 711 mContainer.mActiveChild.mIsActive = false; 712 } 713 mContainer.mActiveChild = this; 714 } 715 mIsActive = true; 716 onActive(); 717 } 718 719 public final boolean isActive() 720 { 721 return mIsActive; 722 } 723 724 /** 725 * Finds a view that was identified by the id attribute from the XML that 726 * was processed in {@link android.app.Activity#onCreate}. This will 727 * implicitly call {@link #getDecorView} for you, with all of the 728 * associated side-effects. 729 * 730 * @return The view if found or null otherwise. 731 */ 732 public View findViewById(int id) { 733 return getDecorView().findViewById(id); 734 } 735 736 /** 737 * Convenience for 738 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} 739 * to set the screen content from a layout resource. The resource will be 740 * inflated, adding all top-level views to the screen. 741 * 742 * @param layoutResID Resource ID to be inflated. 743 * @see #setContentView(View, android.view.ViewGroup.LayoutParams) 744 */ 745 public abstract void setContentView(int layoutResID); 746 747 /** 748 * Convenience for 749 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} 750 * set the screen content to an explicit view. This view is placed 751 * directly into the screen's view hierarchy. It can itself be a complex 752 * view hierarhcy. 753 * 754 * @param view The desired content to display. 755 * @see #setContentView(View, android.view.ViewGroup.LayoutParams) 756 */ 757 public abstract void setContentView(View view); 758 759 /** 760 * Set the screen content to an explicit view. This view is placed 761 * directly into the screen's view hierarchy. It can itself be a complex 762 * view hierarchy. 763 * 764 * <p>Note that calling this function "locks in" various characteristics 765 * of the window that can not, from this point forward, be changed: the 766 * features that have been requested with {@link #requestFeature(int)}, 767 * and certain window flags as described in {@link #setFlags(int, int)}. 768 * 769 * @param view The desired content to display. 770 * @param params Layout parameters for the view. 771 */ 772 public abstract void setContentView(View view, ViewGroup.LayoutParams params); 773 774 /** 775 * Variation on 776 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} 777 * to add an additional content view to the screen. Added after any existing 778 * ones in the screen -- existing views are NOT removed. 779 * 780 * @param view The desired content to display. 781 * @param params Layout parameters for the view. 782 */ 783 public abstract void addContentView(View view, ViewGroup.LayoutParams params); 784 785 /** 786 * Return the view in this Window that currently has focus, or null if 787 * there are none. Note that this does not look in any containing 788 * Window. 789 * 790 * @return View The current View with focus or null. 791 */ 792 public abstract View getCurrentFocus(); 793 794 /** 795 * Quick access to the {@link LayoutInflater} instance that this Window 796 * retrieved from its Context. 797 * 798 * @return LayoutInflater The shared LayoutInflater. 799 */ 800 public abstract LayoutInflater getLayoutInflater(); 801 802 public abstract void setTitle(CharSequence title); 803 804 public abstract void setTitleColor(int textColor); 805 806 public abstract void openPanel(int featureId, KeyEvent event); 807 808 public abstract void closePanel(int featureId); 809 810 public abstract void togglePanel(int featureId, KeyEvent event); 811 812 public abstract boolean performPanelShortcut(int featureId, 813 int keyCode, 814 KeyEvent event, 815 int flags); 816 public abstract boolean performPanelIdentifierAction(int featureId, 817 int id, 818 int flags); 819 820 public abstract void closeAllPanels(); 821 822 public abstract boolean performContextMenuIdentifierAction(int id, int flags); 823 824 /** 825 * Should be called when the configuration is changed. 826 * 827 * @param newConfig The new configuration. 828 */ 829 public abstract void onConfigurationChanged(Configuration newConfig); 830 831 /** 832 * Change the background of this window to a Drawable resource. Setting the 833 * background to null will make the window be opaque. To make the window 834 * transparent, you can use an empty drawable (for instance a ColorDrawable 835 * with the color 0 or the system drawable android:drawable/empty.) 836 * 837 * @param resid The resource identifier of a drawable resource which will be 838 * installed as the new background. 839 */ 840 public void setBackgroundDrawableResource(int resid) 841 { 842 setBackgroundDrawable(mContext.getResources().getDrawable(resid)); 843 } 844 845 /** 846 * Change the background of this window to a custom Drawable. Setting the 847 * background to null will make the window be opaque. To make the window 848 * transparent, you can use an empty drawable (for instance a ColorDrawable 849 * with the color 0 or the system drawable android:drawable/empty.) 850 * 851 * @param drawable The new Drawable to use for this window's background. 852 */ 853 public abstract void setBackgroundDrawable(Drawable drawable); 854 855 /** 856 * Set the value for a drawable feature of this window, from a resource 857 * identifier. You must have called requestFeauture(featureId) before 858 * calling this function. 859 * 860 * @see android.content.res.Resources#getDrawable(int) 861 * 862 * @param featureId The desired drawable feature to change, defined as a 863 * constant by Window. 864 * @param resId Resource identifier of the desired image. 865 */ 866 public abstract void setFeatureDrawableResource(int featureId, int resId); 867 868 /** 869 * Set the value for a drawable feature of this window, from a URI. You 870 * must have called requestFeature(featureId) before calling this 871 * function. 872 * 873 * <p>The only URI currently supported is "content:", specifying an image 874 * in a content provider. 875 * 876 * @see android.widget.ImageView#setImageURI 877 * 878 * @param featureId The desired drawable feature to change. Features are 879 * constants defined by Window. 880 * @param uri The desired URI. 881 */ 882 public abstract void setFeatureDrawableUri(int featureId, Uri uri); 883 884 /** 885 * Set an explicit Drawable value for feature of this window. You must 886 * have called requestFeature(featureId) before calling this function. 887 * 888 * @param featureId The desired drawable feature to change. 889 * Features are constants defined by Window. 890 * @param drawable A Drawable object to display. 891 */ 892 public abstract void setFeatureDrawable(int featureId, Drawable drawable); 893 894 /** 895 * Set a custom alpha value for the given drawale feature, controlling how 896 * much the background is visible through it. 897 * 898 * @param featureId The desired drawable feature to change. 899 * Features are constants defined by Window. 900 * @param alpha The alpha amount, 0 is completely transparent and 255 is 901 * completely opaque. 902 */ 903 public abstract void setFeatureDrawableAlpha(int featureId, int alpha); 904 905 /** 906 * Set the integer value for a feature. The range of the value depends on 907 * the feature being set. For FEATURE_PROGRESSS, it should go from 0 to 908 * 10000. At 10000 the progress is complete and the indicator hidden. 909 * 910 * @param featureId The desired feature to change. 911 * Features are constants defined by Window. 912 * @param value The value for the feature. The interpretation of this 913 * value is feature-specific. 914 */ 915 public abstract void setFeatureInt(int featureId, int value); 916 917 /** 918 * Request that key events come to this activity. Use this if your 919 * activity has no views with focus, but the activity still wants 920 * a chance to process key events. 921 */ 922 public abstract void takeKeyEvents(boolean get); 923 924 /** 925 * Used by custom windows, such as Dialog, to pass the key press event 926 * further down the view hierarchy. Application developers should 927 * not need to implement or call this. 928 * 929 */ 930 public abstract boolean superDispatchKeyEvent(KeyEvent event); 931 932 /** 933 * Used by custom windows, such as Dialog, to pass the touch screen event 934 * further down the view hierarchy. Application developers should 935 * not need to implement or call this. 936 * 937 */ 938 public abstract boolean superDispatchTouchEvent(MotionEvent event); 939 940 /** 941 * Used by custom windows, such as Dialog, to pass the trackball event 942 * further down the view hierarchy. Application developers should 943 * not need to implement or call this. 944 * 945 */ 946 public abstract boolean superDispatchTrackballEvent(MotionEvent event); 947 948 /** 949 * Retrieve the top-level window decor view (containing the standard 950 * window frame/decorations and the client's content inside of that), which 951 * can be added as a window to the window manager. 952 * 953 * <p><em>Note that calling this function for the first time "locks in" 954 * various window characteristics as described in 955 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}.</em></p> 956 * 957 * @return Returns the top-level window decor view. 958 */ 959 public abstract View getDecorView(); 960 961 /** 962 * Retrieve the current decor view, but only if it has already been created; 963 * otherwise returns null. 964 * 965 * @return Returns the top-level window decor or null. 966 * @see #getDecorView 967 */ 968 public abstract View peekDecorView(); 969 970 public abstract Bundle saveHierarchyState(); 971 972 public abstract void restoreHierarchyState(Bundle savedInstanceState); 973 974 protected abstract void onActive(); 975 976 /** 977 * Return the feature bits that are enabled. This is the set of features 978 * that were given to requestFeature(), and are being handled by this 979 * Window itself or its container. That is, it is the set of 980 * requested features that you can actually use. 981 * 982 * <p>To do: add a public version of this API that allows you to check for 983 * features by their feature ID. 984 * 985 * @return int The feature bits. 986 */ 987 protected final int getFeatures() 988 { 989 return mFeatures; 990 } 991 992 /** 993 * Query for the availability of a certain feature. 994 * 995 * @param feature The feature ID to check 996 * @return true if the feature is enabled, false otherwise. 997 */ 998 public boolean hasFeature(int feature) { 999 return (getFeatures() & (1 << feature)) != 0; 1000 } 1001 1002 /** 1003 * Return the feature bits that are being implemented by this Window. 1004 * This is the set of features that were given to requestFeature(), and are 1005 * being handled by only this Window itself, not by its containers. 1006 * 1007 * @return int The feature bits. 1008 */ 1009 protected final int getLocalFeatures() 1010 { 1011 return mLocalFeatures; 1012 } 1013 1014 /** 1015 * Set the default format of window, as per the PixelFormat types. This 1016 * is the format that will be used unless the client specifies in explicit 1017 * format with setFormat(); 1018 * 1019 * @param format The new window format (see PixelFormat). 1020 * 1021 * @see #setFormat 1022 * @see PixelFormat 1023 */ 1024 protected void setDefaultWindowFormat(int format) { 1025 mDefaultWindowFormat = format; 1026 if (!mHaveWindowFormat) { 1027 final WindowManager.LayoutParams attrs = getAttributes(); 1028 attrs.format = format; 1029 if (mCallback != null) { 1030 mCallback.onWindowAttributesChanged(attrs); 1031 } 1032 } 1033 } 1034 1035 public abstract void setChildDrawable(int featureId, Drawable drawable); 1036 1037 public abstract void setChildInt(int featureId, int value); 1038 1039 /** 1040 * Is a keypress one of the defined shortcut keys for this window. 1041 * @param keyCode the key code from {@link android.view.KeyEvent} to check. 1042 * @param event the {@link android.view.KeyEvent} to use to help check. 1043 */ 1044 public abstract boolean isShortcutKey(int keyCode, KeyEvent event); 1045 1046 /** 1047 * @see android.app.Activity#setVolumeControlStream(int) 1048 */ 1049 public abstract void setVolumeControlStream(int streamType); 1050 1051 /** 1052 * @see android.app.Activity#getVolumeControlStream() 1053 */ 1054 public abstract int getVolumeControlStream(); 1055 1056} 1057