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