Home | History | Annotate | Download | only in view
      1 /*
      2  * Copyright (C) 2006 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package android.view;
     18 
     19 import static android.view.WindowManager.LayoutParams.FLAG_HARDWARE_ACCELERATED;
     20 
     21 import android.annotation.ColorInt;
     22 import android.annotation.DrawableRes;
     23 import android.annotation.IdRes;
     24 import android.annotation.LayoutRes;
     25 import android.annotation.NonNull;
     26 import android.annotation.Nullable;
     27 import android.annotation.StyleRes;
     28 import android.annotation.SystemApi;
     29 import android.content.Context;
     30 import android.content.pm.ActivityInfo;
     31 import android.content.res.Configuration;
     32 import android.content.res.Resources;
     33 import android.content.res.TypedArray;
     34 import android.graphics.PixelFormat;
     35 import android.graphics.Rect;
     36 import android.graphics.drawable.Drawable;
     37 import android.media.session.MediaController;
     38 import android.net.Uri;
     39 import android.os.Bundle;
     40 import android.os.Handler;
     41 import android.os.IBinder;
     42 import android.os.RemoteException;
     43 import android.os.SystemProperties;
     44 import android.transition.Scene;
     45 import android.transition.Transition;
     46 import android.transition.TransitionManager;
     47 import android.view.accessibility.AccessibilityEvent;
     48 
     49 import java.util.List;
     50 
     51 /**
     52  * Abstract base class for a top-level window look and behavior policy.  An
     53  * instance of this class should be used as the top-level view added to the
     54  * window manager. It provides standard UI policies such as a background, title
     55  * area, default key processing, etc.
     56  *
     57  * <p>The only existing implementation of this abstract class is
     58  * android.view.PhoneWindow, which you should instantiate when needing a
     59  * Window.
     60  */
     61 public abstract class Window {
     62     /** Flag for the "options panel" feature.  This is enabled by default. */
     63     public static final int FEATURE_OPTIONS_PANEL = 0;
     64     /** Flag for the "no title" feature, turning off the title at the top
     65      *  of the screen. */
     66     public static final int FEATURE_NO_TITLE = 1;
     67 
     68     /**
     69      * Flag for the progress indicator feature.
     70      *
     71      * @deprecated No longer supported starting in API 21.
     72      */
     73     @Deprecated
     74     public static final int FEATURE_PROGRESS = 2;
     75 
     76     /** Flag for having an icon on the left side of the title bar */
     77     public static final int FEATURE_LEFT_ICON = 3;
     78     /** Flag for having an icon on the right side of the title bar */
     79     public static final int FEATURE_RIGHT_ICON = 4;
     80 
     81     /**
     82      * Flag for indeterminate progress.
     83      *
     84      * @deprecated No longer supported starting in API 21.
     85      */
     86     @Deprecated
     87     public static final int FEATURE_INDETERMINATE_PROGRESS = 5;
     88 
     89     /** Flag for the context menu.  This is enabled by default. */
     90     public static final int FEATURE_CONTEXT_MENU = 6;
     91     /** Flag for custom title. You cannot combine this feature with other title features. */
     92     public static final int FEATURE_CUSTOM_TITLE = 7;
     93     /**
     94      * Flag for enabling the Action Bar.
     95      * This is enabled by default for some devices. The Action Bar
     96      * replaces the title bar and provides an alternate location
     97      * for an on-screen menu button on some devices.
     98      */
     99     public static final int FEATURE_ACTION_BAR = 8;
    100     /**
    101      * Flag for requesting an Action Bar that overlays window content.
    102      * Normally an Action Bar will sit in the space above window content, but if this
    103      * feature is requested along with {@link #FEATURE_ACTION_BAR} it will be layered over
    104      * the window content itself. This is useful if you would like your app to have more control
    105      * over how the Action Bar is displayed, such as letting application content scroll beneath
    106      * an Action Bar with a transparent background or otherwise displaying a transparent/translucent
    107      * Action Bar over application content.
    108      *
    109      * <p>This mode is especially useful with {@link View#SYSTEM_UI_FLAG_FULLSCREEN
    110      * View.SYSTEM_UI_FLAG_FULLSCREEN}, which allows you to seamlessly hide the
    111      * action bar in conjunction with other screen decorations.
    112      *
    113      * <p>As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, when an
    114      * ActionBar is in this mode it will adjust the insets provided to
    115      * {@link View#fitSystemWindows(android.graphics.Rect) View.fitSystemWindows(Rect)}
    116      * to include the content covered by the action bar, so you can do layout within
    117      * that space.
    118      */
    119     public static final int FEATURE_ACTION_BAR_OVERLAY = 9;
    120     /**
    121      * Flag for specifying the behavior of action modes when an Action Bar is not present.
    122      * If overlay is enabled, the action mode UI will be allowed to cover existing window content.
    123      */
    124     public static final int FEATURE_ACTION_MODE_OVERLAY = 10;
    125     /**
    126      * Flag for requesting a decoration-free window that is dismissed by swiping from the left.
    127      */
    128     public static final int FEATURE_SWIPE_TO_DISMISS = 11;
    129     /**
    130      * Flag for requesting that window content changes should be animated using a
    131      * TransitionManager.
    132      *
    133      * <p>The TransitionManager is set using
    134      * {@link #setTransitionManager(android.transition.TransitionManager)}. If none is set,
    135      * a default TransitionManager will be used.</p>
    136      *
    137      * @see #setContentView
    138      */
    139     public static final int FEATURE_CONTENT_TRANSITIONS = 12;
    140 
    141     /**
    142      * Enables Activities to run Activity Transitions either through sending or receiving
    143      * ActivityOptions bundle created with
    144      * {@link android.app.ActivityOptions#makeSceneTransitionAnimation(android.app.Activity,
    145      * android.util.Pair[])} or {@link android.app.ActivityOptions#makeSceneTransitionAnimation(
    146      * android.app.Activity, View, String)}.
    147      */
    148     public static final int FEATURE_ACTIVITY_TRANSITIONS = 13;
    149 
    150     /**
    151      * Max value used as a feature ID
    152      * @hide
    153      */
    154     public static final int FEATURE_MAX = FEATURE_ACTIVITY_TRANSITIONS;
    155 
    156     /**
    157      * Flag for setting the progress bar's visibility to VISIBLE.
    158      *
    159      * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
    160      *             supported starting in API 21.
    161      */
    162     @Deprecated
    163     public static final int PROGRESS_VISIBILITY_ON = -1;
    164 
    165     /**
    166      * Flag for setting the progress bar's visibility to GONE.
    167      *
    168      * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
    169      *             supported starting in API 21.
    170      */
    171     @Deprecated
    172     public static final int PROGRESS_VISIBILITY_OFF = -2;
    173 
    174     /**
    175      * Flag for setting the progress bar's indeterminate mode on.
    176      *
    177      * @deprecated {@link #FEATURE_INDETERMINATE_PROGRESS} and related methods
    178      *             are no longer supported starting in API 21.
    179      */
    180     @Deprecated
    181     public static final int PROGRESS_INDETERMINATE_ON = -3;
    182 
    183     /**
    184      * Flag for setting the progress bar's indeterminate mode off.
    185      *
    186      * @deprecated {@link #FEATURE_INDETERMINATE_PROGRESS} and related methods
    187      *             are no longer supported starting in API 21.
    188      */
    189     @Deprecated
    190     public static final int PROGRESS_INDETERMINATE_OFF = -4;
    191 
    192     /**
    193      * Starting value for the (primary) progress.
    194      *
    195      * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
    196      *             supported starting in API 21.
    197      */
    198     @Deprecated
    199     public static final int PROGRESS_START = 0;
    200 
    201     /**
    202      * Ending value for the (primary) progress.
    203      *
    204      * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
    205      *             supported starting in API 21.
    206      */
    207     @Deprecated
    208     public static final int PROGRESS_END = 10000;
    209 
    210     /**
    211      * Lowest possible value for the secondary progress.
    212      *
    213      * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
    214      *             supported starting in API 21.
    215      */
    216     @Deprecated
    217     public static final int PROGRESS_SECONDARY_START = 20000;
    218 
    219     /**
    220      * Highest possible value for the secondary progress.
    221      *
    222      * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
    223      *             supported starting in API 21.
    224      */
    225     @Deprecated
    226     public static final int PROGRESS_SECONDARY_END = 30000;
    227 
    228     /**
    229      * The transitionName for the status bar background View when a custom background is used.
    230      * @see android.view.Window#setStatusBarColor(int)
    231      */
    232     public static final String STATUS_BAR_BACKGROUND_TRANSITION_NAME = "android:status:background";
    233 
    234     /**
    235      * The transitionName for the navigation bar background View when a custom background is used.
    236      * @see android.view.Window#setNavigationBarColor(int)
    237      */
    238     public static final String NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME =
    239             "android:navigation:background";
    240 
    241     /**
    242      * The default features enabled.
    243      * @deprecated use {@link #getDefaultFeatures(android.content.Context)} instead.
    244      */
    245     @Deprecated
    246     @SuppressWarnings({"PointlessBitwiseExpression"})
    247     protected static final int DEFAULT_FEATURES = (1 << FEATURE_OPTIONS_PANEL) |
    248             (1 << FEATURE_CONTEXT_MENU);
    249 
    250     /**
    251      * The ID that the main layout in the XML layout file should have.
    252      */
    253     public static final int ID_ANDROID_CONTENT = com.android.internal.R.id.content;
    254 
    255     private static final String PROPERTY_HARDWARE_UI = "persist.sys.ui.hw";
    256 
    257     /**
    258      * Flag for letting the theme drive the color of the window caption controls. Use with
    259      * {@link #setDecorCaptionShade(int)}. This is the default value.
    260      */
    261     public static final int DECOR_CAPTION_SHADE_AUTO = 0;
    262     /**
    263      * Flag for setting light-color controls on the window caption. Use with
    264      * {@link #setDecorCaptionShade(int)}.
    265      */
    266     public static final int DECOR_CAPTION_SHADE_LIGHT = 1;
    267     /**
    268      * Flag for setting dark-color controls on the window caption. Use with
    269      * {@link #setDecorCaptionShade(int)}.
    270      */
    271     public static final int DECOR_CAPTION_SHADE_DARK = 2;
    272 
    273     private final Context mContext;
    274 
    275     private TypedArray mWindowStyle;
    276     private Callback mCallback;
    277     private OnWindowDismissedCallback mOnWindowDismissedCallback;
    278     private OnWindowSwipeDismissedCallback mOnWindowSwipeDismissedCallback;
    279     private WindowControllerCallback mWindowControllerCallback;
    280     private OnRestrictedCaptionAreaChangedListener mOnRestrictedCaptionAreaChangedListener;
    281     private Rect mRestrictedCaptionAreaRect;
    282     private WindowManager mWindowManager;
    283     private IBinder mAppToken;
    284     private String mAppName;
    285     private boolean mHardwareAccelerated;
    286     private Window mContainer;
    287     private Window mActiveChild;
    288     private boolean mIsActive = false;
    289     private boolean mHasChildren = false;
    290     private boolean mCloseOnTouchOutside = false;
    291     private boolean mSetCloseOnTouchOutside = false;
    292     private int mForcedWindowFlags = 0;
    293 
    294     private int mFeatures;
    295     private int mLocalFeatures;
    296 
    297     private boolean mHaveWindowFormat = false;
    298     private boolean mHaveDimAmount = false;
    299     private int mDefaultWindowFormat = PixelFormat.OPAQUE;
    300 
    301     private boolean mHasSoftInputMode = false;
    302 
    303     private boolean mDestroyed;
    304 
    305     private boolean mOverlayWithDecorCaptionEnabled = false;
    306     private boolean mCloseOnSwipeEnabled = false;
    307 
    308     // The current window attributes.
    309     private final WindowManager.LayoutParams mWindowAttributes =
    310         new WindowManager.LayoutParams();
    311 
    312     /**
    313      * API from a Window back to its caller.  This allows the client to
    314      * intercept key dispatching, panels and menus, etc.
    315      */
    316     public interface Callback {
    317         /**
    318          * Called to process key events.  At the very least your
    319          * implementation must call
    320          * {@link android.view.Window#superDispatchKeyEvent} to do the
    321          * standard key processing.
    322          *
    323          * @param event The key event.
    324          *
    325          * @return boolean Return true if this event was consumed.
    326          */
    327         public boolean dispatchKeyEvent(KeyEvent event);
    328 
    329         /**
    330          * Called to process a key shortcut event.
    331          * At the very least your implementation must call
    332          * {@link android.view.Window#superDispatchKeyShortcutEvent} to do the
    333          * standard key shortcut processing.
    334          *
    335          * @param event The key shortcut event.
    336          * @return True if this event was consumed.
    337          */
    338         public boolean dispatchKeyShortcutEvent(KeyEvent event);
    339 
    340         /**
    341          * Called to process touch screen events.  At the very least your
    342          * implementation must call
    343          * {@link android.view.Window#superDispatchTouchEvent} to do the
    344          * standard touch screen processing.
    345          *
    346          * @param event The touch screen event.
    347          *
    348          * @return boolean Return true if this event was consumed.
    349          */
    350         public boolean dispatchTouchEvent(MotionEvent event);
    351 
    352         /**
    353          * Called to process trackball events.  At the very least your
    354          * implementation must call
    355          * {@link android.view.Window#superDispatchTrackballEvent} to do the
    356          * standard trackball processing.
    357          *
    358          * @param event The trackball event.
    359          *
    360          * @return boolean Return true if this event was consumed.
    361          */
    362         public boolean dispatchTrackballEvent(MotionEvent event);
    363 
    364         /**
    365          * Called to process generic motion events.  At the very least your
    366          * implementation must call
    367          * {@link android.view.Window#superDispatchGenericMotionEvent} to do the
    368          * standard processing.
    369          *
    370          * @param event The generic motion event.
    371          *
    372          * @return boolean Return true if this event was consumed.
    373          */
    374         public boolean dispatchGenericMotionEvent(MotionEvent event);
    375 
    376         /**
    377          * Called to process population of {@link AccessibilityEvent}s.
    378          *
    379          * @param event The event.
    380          *
    381          * @return boolean Return true if event population was completed.
    382          */
    383         public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event);
    384 
    385         /**
    386          * Instantiate the view to display in the panel for 'featureId'.
    387          * You can return null, in which case the default content (typically
    388          * a menu) will be created for you.
    389          *
    390          * @param featureId Which panel is being created.
    391          *
    392          * @return view The top-level view to place in the panel.
    393          *
    394          * @see #onPreparePanel
    395          */
    396         @Nullable
    397         public View onCreatePanelView(int featureId);
    398 
    399         /**
    400          * Initialize the contents of the menu for panel 'featureId'.  This is
    401          * called if onCreatePanelView() returns null, giving you a standard
    402          * menu in which you can place your items.  It is only called once for
    403          * the panel, the first time it is shown.
    404          *
    405          * <p>You can safely hold on to <var>menu</var> (and any items created
    406          * from it), making modifications to it as desired, until the next
    407          * time onCreatePanelMenu() is called for this feature.
    408          *
    409          * @param featureId The panel being created.
    410          * @param menu The menu inside the panel.
    411          *
    412          * @return boolean You must return true for the panel to be displayed;
    413          *         if you return false it will not be shown.
    414          */
    415         public boolean onCreatePanelMenu(int featureId, Menu menu);
    416 
    417         /**
    418          * Prepare a panel to be displayed.  This is called right before the
    419          * panel window is shown, every time it is shown.
    420          *
    421          * @param featureId The panel that is being displayed.
    422          * @param view The View that was returned by onCreatePanelView().
    423          * @param menu If onCreatePanelView() returned null, this is the Menu
    424          *             being displayed in the panel.
    425          *
    426          * @return boolean You must return true for the panel to be displayed;
    427          *         if you return false it will not be shown.
    428          *
    429          * @see #onCreatePanelView
    430          */
    431         public boolean onPreparePanel(int featureId, View view, Menu menu);
    432 
    433         /**
    434          * Called when a panel's menu is opened by the user. This may also be
    435          * called when the menu is changing from one type to another (for
    436          * example, from the icon menu to the expanded menu).
    437          *
    438          * @param featureId The panel that the menu is in.
    439          * @param menu The menu that is opened.
    440          * @return Return true to allow the menu to open, or false to prevent
    441          *         the menu from opening.
    442          */
    443         public boolean onMenuOpened(int featureId, Menu menu);
    444 
    445         /**
    446          * Called when a panel's menu item has been selected by the user.
    447          *
    448          * @param featureId The panel that the menu is in.
    449          * @param item The menu item that was selected.
    450          *
    451          * @return boolean Return true to finish processing of selection, or
    452          *         false to perform the normal menu handling (calling its
    453          *         Runnable or sending a Message to its target Handler).
    454          */
    455         public boolean onMenuItemSelected(int featureId, MenuItem item);
    456 
    457         /**
    458          * This is called whenever the current window attributes change.
    459          *
    460          */
    461         public void onWindowAttributesChanged(WindowManager.LayoutParams attrs);
    462 
    463         /**
    464          * This hook is called whenever the content view of the screen changes
    465          * (due to a call to
    466          * {@link Window#setContentView(View, android.view.ViewGroup.LayoutParams)
    467          * Window.setContentView} or
    468          * {@link Window#addContentView(View, android.view.ViewGroup.LayoutParams)
    469          * Window.addContentView}).
    470          */
    471         public void onContentChanged();
    472 
    473         /**
    474          * This hook is called whenever the window focus changes.  See
    475          * {@link View#onWindowFocusChanged(boolean)
    476          * View.onWindowFocusChangedNotLocked(boolean)} for more information.
    477          *
    478          * @param hasFocus Whether the window now has focus.
    479          */
    480         public void onWindowFocusChanged(boolean hasFocus);
    481 
    482         /**
    483          * Called when the window has been attached to the window manager.
    484          * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
    485          * for more information.
    486          */
    487         public void onAttachedToWindow();
    488 
    489         /**
    490          * Called when the window has been attached to the window manager.
    491          * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
    492          * for more information.
    493          */
    494         public void onDetachedFromWindow();
    495 
    496         /**
    497          * Called when a panel is being closed.  If another logical subsequent
    498          * panel is being opened (and this panel is being closed to make room for the subsequent
    499          * panel), this method will NOT be called.
    500          *
    501          * @param featureId The panel that is being displayed.
    502          * @param menu If onCreatePanelView() returned null, this is the Menu
    503          *            being displayed in the panel.
    504          */
    505         public void onPanelClosed(int featureId, Menu menu);
    506 
    507         /**
    508          * Called when the user signals the desire to start a search.
    509          *
    510          * @return true if search launched, false if activity refuses (blocks)
    511          *
    512          * @see android.app.Activity#onSearchRequested()
    513          */
    514         public boolean onSearchRequested();
    515 
    516         /**
    517          * Called when the user signals the desire to start a search.
    518          *
    519          * @param searchEvent A {@link SearchEvent} describing the signal to
    520          *                   start a search.
    521          * @return true if search launched, false if activity refuses (blocks)
    522          */
    523         public boolean onSearchRequested(SearchEvent searchEvent);
    524 
    525         /**
    526          * Called when an action mode is being started for this window. Gives the
    527          * callback an opportunity to handle the action mode in its own unique and
    528          * beautiful way. If this method returns null the system can choose a way
    529          * to present the mode or choose not to start the mode at all. This is equivalent
    530          * to {@link #onWindowStartingActionMode(android.view.ActionMode.Callback, int)}
    531          * with type {@link ActionMode#TYPE_PRIMARY}.
    532          *
    533          * @param callback Callback to control the lifecycle of this action mode
    534          * @return The ActionMode that was started, or null if the system should present it
    535          */
    536         @Nullable
    537         public ActionMode onWindowStartingActionMode(ActionMode.Callback callback);
    538 
    539         /**
    540          * Called when an action mode is being started for this window. Gives the
    541          * callback an opportunity to handle the action mode in its own unique and
    542          * beautiful way. If this method returns null the system can choose a way
    543          * to present the mode or choose not to start the mode at all.
    544          *
    545          * @param callback Callback to control the lifecycle of this action mode
    546          * @param type One of {@link ActionMode#TYPE_PRIMARY} or {@link ActionMode#TYPE_FLOATING}.
    547          * @return The ActionMode that was started, or null if the system should present it
    548          */
    549         @Nullable
    550         public ActionMode onWindowStartingActionMode(ActionMode.Callback callback, int type);
    551 
    552         /**
    553          * Called when an action mode has been started. The appropriate mode callback
    554          * method will have already been invoked.
    555          *
    556          * @param mode The new mode that has just been started.
    557          */
    558         public void onActionModeStarted(ActionMode mode);
    559 
    560         /**
    561          * Called when an action mode has been finished. The appropriate mode callback
    562          * method will have already been invoked.
    563          *
    564          * @param mode The mode that was just finished.
    565          */
    566         public void onActionModeFinished(ActionMode mode);
    567 
    568         /**
    569          * Called when Keyboard Shortcuts are requested for the current window.
    570          *
    571          * @param data The data list to populate with shortcuts.
    572          * @param menu The current menu, which may be null.
    573          * @param deviceId The id for the connected device the shortcuts should be provided for.
    574          */
    575         default public void onProvideKeyboardShortcuts(
    576                 List<KeyboardShortcutGroup> data, @Nullable Menu menu, int deviceId) { };
    577 
    578         /**
    579          * Called when pointer capture is enabled or disabled for the current window.
    580          *
    581          * @param hasCapture True if the window has pointer capture.
    582          */
    583         default public void onPointerCaptureChanged(boolean hasCapture) { };
    584     }
    585 
    586     /** @hide */
    587     public interface OnWindowDismissedCallback {
    588         /**
    589          * Called when a window is dismissed. This informs the callback that the
    590          * window is gone, and it should finish itself.
    591          * @param finishTask True if the task should also be finished.
    592          * @param suppressWindowTransition True if the resulting exit and enter window transition
    593          * animations should be suppressed.
    594          */
    595         void onWindowDismissed(boolean finishTask, boolean suppressWindowTransition);
    596     }
    597 
    598     /** @hide */
    599     public interface OnWindowSwipeDismissedCallback {
    600         /**
    601          * Called when a window is swipe dismissed. This informs the callback that the
    602          * window is gone, and it should finish itself.
    603          * @param finishTask True if the task should also be finished.
    604          * @param suppressWindowTransition True if the resulting exit and enter window transition
    605          * animations should be suppressed.
    606          */
    607         void onWindowSwipeDismissed();
    608     }
    609 
    610     /** @hide */
    611     public interface WindowControllerCallback {
    612         /**
    613          * Moves the activity from
    614          * {@link android.app.ActivityManager.StackId#FREEFORM_WORKSPACE_STACK_ID} to
    615          * {@link android.app.ActivityManager.StackId#FULLSCREEN_WORKSPACE_STACK_ID} stack.
    616          */
    617         void exitFreeformMode() throws RemoteException;
    618 
    619         /**
    620          * Puts the activity in picture-in-picture mode if the activity supports.
    621          * @see android.R.attr#supportsPictureInPicture
    622          */
    623         void enterPictureInPictureModeIfPossible();
    624 
    625         /** Returns the current stack Id for the window. */
    626         int getWindowStackId() throws RemoteException;
    627 
    628         /** Returns whether the window belongs to the task root. */
    629         boolean isTaskRoot();
    630     }
    631 
    632     /**
    633      * Callback for clients that want to be aware of where caption draws content.
    634      */
    635     public interface OnRestrictedCaptionAreaChangedListener {
    636         /**
    637          * Called when the area where caption draws content changes.
    638          *
    639          * @param rect The area where caption content is positioned, relative to the top view.
    640          */
    641         void onRestrictedCaptionAreaChanged(Rect rect);
    642     }
    643 
    644     /**
    645      * Callback for clients that want frame timing information for each
    646      * frame rendered by the Window.
    647      */
    648     public interface OnFrameMetricsAvailableListener {
    649         /**
    650          * Called when information is available for the previously rendered frame.
    651          *
    652          * Reports can be dropped if this callback takes too
    653          * long to execute, as the report producer cannot wait for the consumer to
    654          * complete.
    655          *
    656          * It is highly recommended that clients copy the passed in FrameMetrics
    657          * via {@link FrameMetrics#FrameMetrics(FrameMetrics)} within this method and defer
    658          * additional computation or storage to another thread to avoid unnecessarily
    659          * dropping reports.
    660          *
    661          * @param window The {@link Window} on which the frame was displayed.
    662          * @param frameMetrics the available metrics. This object is reused on every call
    663          * and thus <strong>this reference is not valid outside the scope of this method</strong>.
    664          * @param dropCountSinceLastInvocation the number of reports dropped since the last time
    665          * this callback was invoked.
    666          */
    667         void onFrameMetricsAvailable(Window window, FrameMetrics frameMetrics,
    668                 int dropCountSinceLastInvocation);
    669     }
    670 
    671 
    672     public Window(Context context) {
    673         mContext = context;
    674         mFeatures = mLocalFeatures = getDefaultFeatures(context);
    675     }
    676 
    677     /**
    678      * Return the Context this window policy is running in, for retrieving
    679      * resources and other information.
    680      *
    681      * @return Context The Context that was supplied to the constructor.
    682      */
    683     public final Context getContext() {
    684         return mContext;
    685     }
    686 
    687     /**
    688      * Return the {@link android.R.styleable#Window} attributes from this
    689      * window's theme.
    690      */
    691     public final TypedArray getWindowStyle() {
    692         synchronized (this) {
    693             if (mWindowStyle == null) {
    694                 mWindowStyle = mContext.obtainStyledAttributes(
    695                         com.android.internal.R.styleable.Window);
    696             }
    697             return mWindowStyle;
    698         }
    699     }
    700 
    701     /**
    702      * Set the container for this window.  If not set, the DecorWindow
    703      * operates as a top-level window; otherwise, it negotiates with the
    704      * container to display itself appropriately.
    705      *
    706      * @param container The desired containing Window.
    707      */
    708     public void setContainer(Window container) {
    709         mContainer = container;
    710         if (container != null) {
    711             // Embedded screens never have a title.
    712             mFeatures |= 1<<FEATURE_NO_TITLE;
    713             mLocalFeatures |= 1<<FEATURE_NO_TITLE;
    714             container.mHasChildren = true;
    715         }
    716     }
    717 
    718     /**
    719      * Return the container for this Window.
    720      *
    721      * @return Window The containing window, or null if this is a
    722      *         top-level window.
    723      */
    724     public final Window getContainer() {
    725         return mContainer;
    726     }
    727 
    728     public final boolean hasChildren() {
    729         return mHasChildren;
    730     }
    731 
    732     /** @hide */
    733     public final void destroy() {
    734         mDestroyed = true;
    735     }
    736 
    737     /** @hide */
    738     public final boolean isDestroyed() {
    739         return mDestroyed;
    740     }
    741 
    742     /**
    743      * Set the window manager for use by this Window to, for example,
    744      * display panels.  This is <em>not</em> used for displaying the
    745      * Window itself -- that must be done by the client.
    746      *
    747      * @param wm The window manager for adding new windows.
    748      */
    749     public void setWindowManager(WindowManager wm, IBinder appToken, String appName) {
    750         setWindowManager(wm, appToken, appName, false);
    751     }
    752 
    753     /**
    754      * Set the window manager for use by this Window to, for example,
    755      * display panels.  This is <em>not</em> used for displaying the
    756      * Window itself -- that must be done by the client.
    757      *
    758      * @param wm The window manager for adding new windows.
    759      */
    760     public void setWindowManager(WindowManager wm, IBinder appToken, String appName,
    761             boolean hardwareAccelerated) {
    762         mAppToken = appToken;
    763         mAppName = appName;
    764         mHardwareAccelerated = hardwareAccelerated
    765                 || SystemProperties.getBoolean(PROPERTY_HARDWARE_UI, false);
    766         if (wm == null) {
    767             wm = (WindowManager)mContext.getSystemService(Context.WINDOW_SERVICE);
    768         }
    769         mWindowManager = ((WindowManagerImpl)wm).createLocalWindowManager(this);
    770     }
    771 
    772     void adjustLayoutParamsForSubWindow(WindowManager.LayoutParams wp) {
    773         CharSequence curTitle = wp.getTitle();
    774         if (wp.type >= WindowManager.LayoutParams.FIRST_SUB_WINDOW &&
    775                 wp.type <= WindowManager.LayoutParams.LAST_SUB_WINDOW) {
    776             if (wp.token == null) {
    777                 View decor = peekDecorView();
    778                 if (decor != null) {
    779                     wp.token = decor.getWindowToken();
    780                 }
    781             }
    782             if (curTitle == null || curTitle.length() == 0) {
    783                 final StringBuilder title = new StringBuilder(32);
    784                 if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA) {
    785                     title.append("Media");
    786                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY) {
    787                     title.append("MediaOvr");
    788                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_PANEL) {
    789                     title.append("Panel");
    790                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL) {
    791                     title.append("SubPanel");
    792                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL) {
    793                     title.append("AboveSubPanel");
    794                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG) {
    795                     title.append("AtchDlg");
    796                 } else {
    797                     title.append(wp.type);
    798                 }
    799                 if (mAppName != null) {
    800                     title.append(":").append(mAppName);
    801                 }
    802                 wp.setTitle(title);
    803             }
    804         } else if (wp.type >= WindowManager.LayoutParams.FIRST_SYSTEM_WINDOW &&
    805                 wp.type <= WindowManager.LayoutParams.LAST_SYSTEM_WINDOW) {
    806             // We don't set the app token to this system window because the life cycles should be
    807             // independent. If an app creates a system window and then the app goes to the stopped
    808             // state, the system window should not be affected (can still show and receive input
    809             // events).
    810             if (curTitle == null || curTitle.length() == 0) {
    811                 final StringBuilder title = new StringBuilder(32);
    812                 title.append("Sys").append(wp.type);
    813                 if (mAppName != null) {
    814                     title.append(":").append(mAppName);
    815                 }
    816                 wp.setTitle(title);
    817             }
    818         } else {
    819             if (wp.token == null) {
    820                 wp.token = mContainer == null ? mAppToken : mContainer.mAppToken;
    821             }
    822             if ((curTitle == null || curTitle.length() == 0)
    823                     && mAppName != null) {
    824                 wp.setTitle(mAppName);
    825             }
    826         }
    827         if (wp.packageName == null) {
    828             wp.packageName = mContext.getPackageName();
    829         }
    830         if (mHardwareAccelerated ||
    831                 (mWindowAttributes.flags & FLAG_HARDWARE_ACCELERATED) != 0) {
    832             wp.flags |= FLAG_HARDWARE_ACCELERATED;
    833         }
    834     }
    835 
    836     /**
    837      * Return the window manager allowing this Window to display its own
    838      * windows.
    839      *
    840      * @return WindowManager The ViewManager.
    841      */
    842     public WindowManager getWindowManager() {
    843         return mWindowManager;
    844     }
    845 
    846     /**
    847      * Set the Callback interface for this window, used to intercept key
    848      * events and other dynamic operations in the window.
    849      *
    850      * @param callback The desired Callback interface.
    851      */
    852     public void setCallback(Callback callback) {
    853         mCallback = callback;
    854     }
    855 
    856     /**
    857      * Return the current Callback interface for this window.
    858      */
    859     public final Callback getCallback() {
    860         return mCallback;
    861     }
    862 
    863     /**
    864      * Set an observer to collect frame stats for each frame rendererd in this window.
    865      *
    866      * Must be in hardware rendering mode.
    867      */
    868     public final void addOnFrameMetricsAvailableListener(
    869             @NonNull OnFrameMetricsAvailableListener listener,
    870             Handler handler) {
    871         final View decorView = getDecorView();
    872         if (decorView == null) {
    873             throw new IllegalStateException("can't observe a Window without an attached view");
    874         }
    875 
    876         if (listener == null) {
    877             throw new NullPointerException("listener cannot be null");
    878         }
    879 
    880         decorView.addFrameMetricsListener(this, listener, handler);
    881     }
    882 
    883     /**
    884      * Remove observer and stop listening to frame stats for this window.
    885      */
    886     public final void removeOnFrameMetricsAvailableListener(OnFrameMetricsAvailableListener listener) {
    887         final View decorView = getDecorView();
    888         if (decorView != null) {
    889             getDecorView().removeFrameMetricsListener(listener);
    890         }
    891     }
    892 
    893     /** @hide */
    894     public final void setOnWindowDismissedCallback(OnWindowDismissedCallback dcb) {
    895         mOnWindowDismissedCallback = dcb;
    896     }
    897 
    898     /** @hide */
    899     public final void dispatchOnWindowDismissed(
    900             boolean finishTask, boolean suppressWindowTransition) {
    901         if (mOnWindowDismissedCallback != null) {
    902             mOnWindowDismissedCallback.onWindowDismissed(finishTask, suppressWindowTransition);
    903         }
    904     }
    905 
    906     /** @hide */
    907     public final void setOnWindowSwipeDismissedCallback(OnWindowSwipeDismissedCallback sdcb) {
    908         mOnWindowSwipeDismissedCallback = sdcb;
    909     }
    910 
    911     /** @hide */
    912     public final void dispatchOnWindowSwipeDismissed() {
    913         if (mOnWindowSwipeDismissedCallback != null) {
    914             mOnWindowSwipeDismissedCallback.onWindowSwipeDismissed();
    915         }
    916     }
    917 
    918     /** @hide */
    919     public final void setWindowControllerCallback(WindowControllerCallback wccb) {
    920         mWindowControllerCallback = wccb;
    921     }
    922 
    923     /** @hide */
    924     public final WindowControllerCallback getWindowControllerCallback() {
    925         return mWindowControllerCallback;
    926     }
    927 
    928     /**
    929      * Set a callback for changes of area where caption will draw its content.
    930      *
    931      * @param listener Callback that will be called when the area changes.
    932      */
    933     public final void setRestrictedCaptionAreaListener(OnRestrictedCaptionAreaChangedListener listener) {
    934         mOnRestrictedCaptionAreaChangedListener = listener;
    935         mRestrictedCaptionAreaRect = listener != null ? new Rect() : null;
    936     }
    937 
    938     /**
    939      * Take ownership of this window's surface.  The window's view hierarchy
    940      * will no longer draw into the surface, though it will otherwise continue
    941      * to operate (such as for receiving input events).  The given SurfaceHolder
    942      * callback will be used to tell you about state changes to the surface.
    943      */
    944     public abstract void takeSurface(SurfaceHolder.Callback2 callback);
    945 
    946     /**
    947      * Take ownership of this window's InputQueue.  The window will no
    948      * longer read and dispatch input events from the queue; it is your
    949      * responsibility to do so.
    950      */
    951     public abstract void takeInputQueue(InputQueue.Callback callback);
    952 
    953     /**
    954      * Return whether this window is being displayed with a floating style
    955      * (based on the {@link android.R.attr#windowIsFloating} attribute in
    956      * the style/theme).
    957      *
    958      * @return Returns true if the window is configured to be displayed floating
    959      * on top of whatever is behind it.
    960      */
    961     public abstract boolean isFloating();
    962 
    963     /**
    964      * Set the width and height layout parameters of the window.  The default
    965      * for both of these is MATCH_PARENT; you can change them to WRAP_CONTENT
    966      * or an absolute value to make a window that is not full-screen.
    967      *
    968      * @param width The desired layout width of the window.
    969      * @param height The desired layout height of the window.
    970      *
    971      * @see ViewGroup.LayoutParams#height
    972      * @see ViewGroup.LayoutParams#width
    973      */
    974     public void setLayout(int width, int height) {
    975         final WindowManager.LayoutParams attrs = getAttributes();
    976         attrs.width = width;
    977         attrs.height = height;
    978         dispatchWindowAttributesChanged(attrs);
    979     }
    980 
    981     /**
    982      * Set the gravity of the window, as per the Gravity constants.  This
    983      * controls how the window manager is positioned in the overall window; it
    984      * is only useful when using WRAP_CONTENT for the layout width or height.
    985      *
    986      * @param gravity The desired gravity constant.
    987      *
    988      * @see Gravity
    989      * @see #setLayout
    990      */
    991     public void setGravity(int gravity)
    992     {
    993         final WindowManager.LayoutParams attrs = getAttributes();
    994         attrs.gravity = gravity;
    995         dispatchWindowAttributesChanged(attrs);
    996     }
    997 
    998     /**
    999      * Set the type of the window, as per the WindowManager.LayoutParams
   1000      * types.
   1001      *
   1002      * @param type The new window type (see WindowManager.LayoutParams).
   1003      */
   1004     public void setType(int type) {
   1005         final WindowManager.LayoutParams attrs = getAttributes();
   1006         attrs.type = type;
   1007         dispatchWindowAttributesChanged(attrs);
   1008     }
   1009 
   1010     /**
   1011      * Set the format of window, as per the PixelFormat types.  This overrides
   1012      * the default format that is selected by the Window based on its
   1013      * window decorations.
   1014      *
   1015      * @param format The new window format (see PixelFormat).  Use
   1016      *               PixelFormat.UNKNOWN to allow the Window to select
   1017      *               the format.
   1018      *
   1019      * @see PixelFormat
   1020      */
   1021     public void setFormat(int format) {
   1022         final WindowManager.LayoutParams attrs = getAttributes();
   1023         if (format != PixelFormat.UNKNOWN) {
   1024             attrs.format = format;
   1025             mHaveWindowFormat = true;
   1026         } else {
   1027             attrs.format = mDefaultWindowFormat;
   1028             mHaveWindowFormat = false;
   1029         }
   1030         dispatchWindowAttributesChanged(attrs);
   1031     }
   1032 
   1033     /**
   1034      * Specify custom animations to use for the window, as per
   1035      * {@link WindowManager.LayoutParams#windowAnimations
   1036      * WindowManager.LayoutParams.windowAnimations}.  Providing anything besides
   1037      * 0 here will override the animations the window would
   1038      * normally retrieve from its theme.
   1039      */
   1040     public void setWindowAnimations(@StyleRes int resId) {
   1041         final WindowManager.LayoutParams attrs = getAttributes();
   1042         attrs.windowAnimations = resId;
   1043         dispatchWindowAttributesChanged(attrs);
   1044     }
   1045 
   1046     /**
   1047      * Specify an explicit soft input mode to use for the window, as per
   1048      * {@link WindowManager.LayoutParams#softInputMode
   1049      * WindowManager.LayoutParams.softInputMode}.  Providing anything besides
   1050      * "unspecified" here will override the input mode the window would
   1051      * normally retrieve from its theme.
   1052      */
   1053     public void setSoftInputMode(int mode) {
   1054         final WindowManager.LayoutParams attrs = getAttributes();
   1055         if (mode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
   1056             attrs.softInputMode = mode;
   1057             mHasSoftInputMode = true;
   1058         } else {
   1059             mHasSoftInputMode = false;
   1060         }
   1061         dispatchWindowAttributesChanged(attrs);
   1062     }
   1063 
   1064     /**
   1065      * Convenience function to set the flag bits as specified in flags, as
   1066      * per {@link #setFlags}.
   1067      * @param flags The flag bits to be set.
   1068      * @see #setFlags
   1069      * @see #clearFlags
   1070      */
   1071     public void addFlags(int flags) {
   1072         setFlags(flags, flags);
   1073     }
   1074 
   1075     /** @hide */
   1076     public void addPrivateFlags(int flags) {
   1077         setPrivateFlags(flags, flags);
   1078     }
   1079 
   1080     /**
   1081      * Convenience function to clear the flag bits as specified in flags, as
   1082      * per {@link #setFlags}.
   1083      * @param flags The flag bits to be cleared.
   1084      * @see #setFlags
   1085      * @see #addFlags
   1086      */
   1087     public void clearFlags(int flags) {
   1088         setFlags(0, flags);
   1089     }
   1090 
   1091     /**
   1092      * Set the flags of the window, as per the
   1093      * {@link WindowManager.LayoutParams WindowManager.LayoutParams}
   1094      * flags.
   1095      *
   1096      * <p>Note that some flags must be set before the window decoration is
   1097      * created (by the first call to
   1098      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} or
   1099      * {@link #getDecorView()}:
   1100      * {@link WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN} and
   1101      * {@link WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR}.  These
   1102      * will be set for you based on the {@link android.R.attr#windowIsFloating}
   1103      * attribute.
   1104      *
   1105      * @param flags The new window flags (see WindowManager.LayoutParams).
   1106      * @param mask Which of the window flag bits to modify.
   1107      * @see #addFlags
   1108      * @see #clearFlags
   1109      */
   1110     public void setFlags(int flags, int mask) {
   1111         final WindowManager.LayoutParams attrs = getAttributes();
   1112         attrs.flags = (attrs.flags&~mask) | (flags&mask);
   1113         mForcedWindowFlags |= mask;
   1114         dispatchWindowAttributesChanged(attrs);
   1115     }
   1116 
   1117     private void setPrivateFlags(int flags, int mask) {
   1118         final WindowManager.LayoutParams attrs = getAttributes();
   1119         attrs.privateFlags = (attrs.privateFlags & ~mask) | (flags & mask);
   1120         dispatchWindowAttributesChanged(attrs);
   1121     }
   1122 
   1123     /**
   1124      * {@hide}
   1125      */
   1126     protected void setNeedsMenuKey(int value) {
   1127         final WindowManager.LayoutParams attrs = getAttributes();
   1128         attrs.needsMenuKey = value;
   1129         dispatchWindowAttributesChanged(attrs);
   1130     }
   1131 
   1132     /**
   1133      * {@hide}
   1134      */
   1135     protected void dispatchWindowAttributesChanged(WindowManager.LayoutParams attrs) {
   1136         if (mCallback != null) {
   1137             mCallback.onWindowAttributesChanged(attrs);
   1138         }
   1139     }
   1140 
   1141     /**
   1142      * <p>Sets the requested color mode of the window. The requested the color mode might
   1143      * override the window's pixel {@link WindowManager.LayoutParams#format format}.</p>
   1144      *
   1145      * <p>The requested color mode must be one of {@link ActivityInfo#COLOR_MODE_DEFAULT},
   1146      * {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT} or {@link ActivityInfo#COLOR_MODE_HDR}.</p>
   1147      *
   1148      * <p>The requested color mode is not guaranteed to be honored. Please refer to
   1149      * {@link #getColorMode()} for more information.</p>
   1150      *
   1151      * @see #getColorMode()
   1152      * @see Display#isWideColorGamut()
   1153      * @see Configuration#isScreenWideColorGamut()
   1154      */
   1155     public void setColorMode(@ActivityInfo.ColorMode int colorMode) {
   1156         final WindowManager.LayoutParams attrs = getAttributes();
   1157         attrs.setColorMode(colorMode);
   1158         dispatchWindowAttributesChanged(attrs);
   1159     }
   1160 
   1161     /**
   1162      * Returns the requested color mode of the window, one of
   1163      * {@link ActivityInfo#COLOR_MODE_DEFAULT}, {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT}
   1164      * or {@link ActivityInfo#COLOR_MODE_HDR}. If {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT}
   1165      * was requested it is possible the window will not be put in wide color gamut mode depending
   1166      * on device and display support for that mode. Use {@link #isWideColorGamut} to determine
   1167      * if the window is currently in wide color gamut mode.
   1168      *
   1169      * @see #setColorMode(int)
   1170      * @see Display#isWideColorGamut()
   1171      * @see Configuration#isScreenWideColorGamut()
   1172      */
   1173     @ActivityInfo.ColorMode
   1174     public int getColorMode() {
   1175         return getAttributes().getColorMode();
   1176     }
   1177 
   1178     /**
   1179      * Returns true if this window's color mode is {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT},
   1180      * the display has a wide color gamut and this device supports wide color gamut rendering.
   1181      *
   1182      * @see Display#isWideColorGamut()
   1183      * @see Configuration#isScreenWideColorGamut()
   1184      */
   1185     public boolean isWideColorGamut() {
   1186         return getColorMode() == ActivityInfo.COLOR_MODE_WIDE_COLOR_GAMUT
   1187                 && getContext().getResources().getConfiguration().isScreenWideColorGamut();
   1188     }
   1189 
   1190     /**
   1191      * Set the amount of dim behind the window when using
   1192      * {@link WindowManager.LayoutParams#FLAG_DIM_BEHIND}.  This overrides
   1193      * the default dim amount of that is selected by the Window based on
   1194      * its theme.
   1195      *
   1196      * @param amount The new dim amount, from 0 for no dim to 1 for full dim.
   1197      */
   1198     public void setDimAmount(float amount) {
   1199         final WindowManager.LayoutParams attrs = getAttributes();
   1200         attrs.dimAmount = amount;
   1201         mHaveDimAmount = true;
   1202         dispatchWindowAttributesChanged(attrs);
   1203     }
   1204 
   1205     /**
   1206      * Specify custom window attributes.  <strong>PLEASE NOTE:</strong> the
   1207      * layout params you give here should generally be from values previously
   1208      * retrieved with {@link #getAttributes()}; you probably do not want to
   1209      * blindly create and apply your own, since this will blow away any values
   1210      * set by the framework that you are not interested in.
   1211      *
   1212      * @param a The new window attributes, which will completely override any
   1213      *          current values.
   1214      */
   1215     public void setAttributes(WindowManager.LayoutParams a) {
   1216         mWindowAttributes.copyFrom(a);
   1217         dispatchWindowAttributesChanged(mWindowAttributes);
   1218     }
   1219 
   1220     /**
   1221      * Retrieve the current window attributes associated with this panel.
   1222      *
   1223      * @return WindowManager.LayoutParams Either the existing window
   1224      *         attributes object, or a freshly created one if there is none.
   1225      */
   1226     public final WindowManager.LayoutParams getAttributes() {
   1227         return mWindowAttributes;
   1228     }
   1229 
   1230     /**
   1231      * Return the window flags that have been explicitly set by the client,
   1232      * so will not be modified by {@link #getDecorView}.
   1233      */
   1234     protected final int getForcedWindowFlags() {
   1235         return mForcedWindowFlags;
   1236     }
   1237 
   1238     /**
   1239      * Has the app specified their own soft input mode?
   1240      */
   1241     protected final boolean hasSoftInputMode() {
   1242         return mHasSoftInputMode;
   1243     }
   1244 
   1245     /** @hide */
   1246     public void setCloseOnTouchOutside(boolean close) {
   1247         mCloseOnTouchOutside = close;
   1248         mSetCloseOnTouchOutside = true;
   1249     }
   1250 
   1251     /** @hide */
   1252     public void setCloseOnTouchOutsideIfNotSet(boolean close) {
   1253         if (!mSetCloseOnTouchOutside) {
   1254             mCloseOnTouchOutside = close;
   1255             mSetCloseOnTouchOutside = true;
   1256         }
   1257     }
   1258 
   1259     /** @hide */
   1260     @SystemApi
   1261     public void setDisableWallpaperTouchEvents(boolean disable) {
   1262         setPrivateFlags(disable
   1263                 ? WindowManager.LayoutParams.PRIVATE_FLAG_DISABLE_WALLPAPER_TOUCH_EVENTS : 0,
   1264                 WindowManager.LayoutParams.PRIVATE_FLAG_DISABLE_WALLPAPER_TOUCH_EVENTS);
   1265     }
   1266 
   1267     /** @hide */
   1268     public abstract void alwaysReadCloseOnTouchAttr();
   1269 
   1270     /** @hide */
   1271     public boolean shouldCloseOnTouch(Context context, MotionEvent event) {
   1272         final boolean isOutside =
   1273                 event.getAction() == MotionEvent.ACTION_DOWN && isOutOfBounds(context, event)
   1274                 || event.getAction() == MotionEvent.ACTION_OUTSIDE;
   1275         if (mCloseOnTouchOutside && peekDecorView() != null && isOutside) {
   1276             return true;
   1277         }
   1278         return false;
   1279     }
   1280 
   1281     /* Sets the Sustained Performance requirement for the calling window.
   1282      * @param enable disables or enables the mode.
   1283      */
   1284     public void setSustainedPerformanceMode(boolean enable) {
   1285         setPrivateFlags(enable
   1286                 ? WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE : 0,
   1287                 WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE);
   1288     }
   1289 
   1290     private boolean isOutOfBounds(Context context, MotionEvent event) {
   1291         final int x = (int) event.getX();
   1292         final int y = (int) event.getY();
   1293         final int slop = ViewConfiguration.get(context).getScaledWindowTouchSlop();
   1294         final View decorView = getDecorView();
   1295         return (x < -slop) || (y < -slop)
   1296                 || (x > (decorView.getWidth()+slop))
   1297                 || (y > (decorView.getHeight()+slop));
   1298     }
   1299 
   1300     /**
   1301      * Enable extended screen features.  This must be called before
   1302      * setContentView().  May be called as many times as desired as long as it
   1303      * is before setContentView().  If not called, no extended features
   1304      * will be available.  You can not turn off a feature once it is requested.
   1305      * You canot use other title features with {@link #FEATURE_CUSTOM_TITLE}.
   1306      *
   1307      * @param featureId The desired features, defined as constants by Window.
   1308      * @return The features that are now set.
   1309      */
   1310     public boolean requestFeature(int featureId) {
   1311         final int flag = 1<<featureId;
   1312         mFeatures |= flag;
   1313         mLocalFeatures |= mContainer != null ? (flag&~mContainer.mFeatures) : flag;
   1314         return (mFeatures&flag) != 0;
   1315     }
   1316 
   1317     /**
   1318      * @hide Used internally to help resolve conflicting features.
   1319      */
   1320     protected void removeFeature(int featureId) {
   1321         final int flag = 1<<featureId;
   1322         mFeatures &= ~flag;
   1323         mLocalFeatures &= ~(mContainer != null ? (flag&~mContainer.mFeatures) : flag);
   1324     }
   1325 
   1326     public final void makeActive() {
   1327         if (mContainer != null) {
   1328             if (mContainer.mActiveChild != null) {
   1329                 mContainer.mActiveChild.mIsActive = false;
   1330             }
   1331             mContainer.mActiveChild = this;
   1332         }
   1333         mIsActive = true;
   1334         onActive();
   1335     }
   1336 
   1337     public final boolean isActive()
   1338     {
   1339         return mIsActive;
   1340     }
   1341 
   1342     /**
   1343      * Finds a view that was identified by the {@code android:id} XML attribute
   1344      * that was processed in {@link android.app.Activity#onCreate}. This will
   1345      * implicitly call {@link #getDecorView} with all of the associated
   1346      * side-effects.
   1347      * <p>
   1348      * <strong>Note:</strong> In most cases -- depending on compiler support --
   1349      * the resulting view is automatically cast to the target class type. If
   1350      * the target class type is unconstrained, an explicit cast may be
   1351      * necessary.
   1352      *
   1353      * @param id the ID to search for
   1354      * @return a view with given ID if found, or {@code null} otherwise
   1355      * @see View#findViewById(int)
   1356      */
   1357     @Nullable
   1358     public <T extends View> T findViewById(@IdRes int id) {
   1359         return getDecorView().findViewById(id);
   1360     }
   1361 
   1362     /**
   1363      * Convenience for
   1364      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
   1365      * to set the screen content from a layout resource.  The resource will be
   1366      * inflated, adding all top-level views to the screen.
   1367      *
   1368      * @param layoutResID Resource ID to be inflated.
   1369      * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
   1370      */
   1371     public abstract void setContentView(@LayoutRes int layoutResID);
   1372 
   1373     /**
   1374      * Convenience for
   1375      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
   1376      * set the screen content to an explicit view.  This view is placed
   1377      * directly into the screen's view hierarchy.  It can itself be a complex
   1378      * view hierarhcy.
   1379      *
   1380      * @param view The desired content to display.
   1381      * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
   1382      */
   1383     public abstract void setContentView(View view);
   1384 
   1385     /**
   1386      * Set the screen content to an explicit view.  This view is placed
   1387      * directly into the screen's view hierarchy.  It can itself be a complex
   1388      * view hierarchy.
   1389      *
   1390      * <p>Note that calling this function "locks in" various characteristics
   1391      * of the window that can not, from this point forward, be changed: the
   1392      * features that have been requested with {@link #requestFeature(int)},
   1393      * and certain window flags as described in {@link #setFlags(int, int)}.</p>
   1394      *
   1395      * <p>If {@link #FEATURE_CONTENT_TRANSITIONS} is set, the window's
   1396      * TransitionManager will be used to animate content from the current
   1397      * content View to view.</p>
   1398      *
   1399      * @param view The desired content to display.
   1400      * @param params Layout parameters for the view.
   1401      * @see #getTransitionManager()
   1402      * @see #setTransitionManager(android.transition.TransitionManager)
   1403      */
   1404     public abstract void setContentView(View view, ViewGroup.LayoutParams params);
   1405 
   1406     /**
   1407      * Variation on
   1408      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
   1409      * to add an additional content view to the screen.  Added after any existing
   1410      * ones in the screen -- existing views are NOT removed.
   1411      *
   1412      * @param view The desired content to display.
   1413      * @param params Layout parameters for the view.
   1414      */
   1415     public abstract void addContentView(View view, ViewGroup.LayoutParams params);
   1416 
   1417     /**
   1418      * Remove the view that was used as the screen content.
   1419      *
   1420      * @hide
   1421      */
   1422     public abstract void clearContentView();
   1423 
   1424     /**
   1425      * Return the view in this Window that currently has focus, or null if
   1426      * there are none.  Note that this does not look in any containing
   1427      * Window.
   1428      *
   1429      * @return View The current View with focus or null.
   1430      */
   1431     @Nullable
   1432     public abstract View getCurrentFocus();
   1433 
   1434     /**
   1435      * Quick access to the {@link LayoutInflater} instance that this Window
   1436      * retrieved from its Context.
   1437      *
   1438      * @return LayoutInflater The shared LayoutInflater.
   1439      */
   1440     @NonNull
   1441     public abstract LayoutInflater getLayoutInflater();
   1442 
   1443     public abstract void setTitle(CharSequence title);
   1444 
   1445     @Deprecated
   1446     public abstract void setTitleColor(@ColorInt int textColor);
   1447 
   1448     public abstract void openPanel(int featureId, KeyEvent event);
   1449 
   1450     public abstract void closePanel(int featureId);
   1451 
   1452     public abstract void togglePanel(int featureId, KeyEvent event);
   1453 
   1454     public abstract void invalidatePanelMenu(int featureId);
   1455 
   1456     public abstract boolean performPanelShortcut(int featureId,
   1457                                                  int keyCode,
   1458                                                  KeyEvent event,
   1459                                                  int flags);
   1460     public abstract boolean performPanelIdentifierAction(int featureId,
   1461                                                  int id,
   1462                                                  int flags);
   1463 
   1464     public abstract void closeAllPanels();
   1465 
   1466     public abstract boolean performContextMenuIdentifierAction(int id, int flags);
   1467 
   1468     /**
   1469      * Should be called when the configuration is changed.
   1470      *
   1471      * @param newConfig The new configuration.
   1472      */
   1473     public abstract void onConfigurationChanged(Configuration newConfig);
   1474 
   1475     /**
   1476      * Sets the window elevation.
   1477      * <p>
   1478      * Changes to this property take effect immediately and will cause the
   1479      * window surface to be recreated. This is an expensive operation and as a
   1480      * result, this property should not be animated.
   1481      *
   1482      * @param elevation The window elevation.
   1483      * @see View#setElevation(float)
   1484      * @see android.R.styleable#Window_windowElevation
   1485      */
   1486     public void setElevation(float elevation) {}
   1487 
   1488     /**
   1489      * Gets the window elevation.
   1490      *
   1491      * @hide
   1492      */
   1493     public float getElevation() {
   1494         return 0.0f;
   1495     }
   1496 
   1497     /**
   1498      * Sets whether window content should be clipped to the outline of the
   1499      * window background.
   1500      *
   1501      * @param clipToOutline Whether window content should be clipped to the
   1502      *                      outline of the window background.
   1503      * @see View#setClipToOutline(boolean)
   1504      * @see android.R.styleable#Window_windowClipToOutline
   1505      */
   1506     public void setClipToOutline(boolean clipToOutline) {}
   1507 
   1508     /**
   1509      * Change the background of this window to a Drawable resource. Setting the
   1510      * background to null will make the window be opaque. To make the window
   1511      * transparent, you can use an empty drawable (for instance a ColorDrawable
   1512      * with the color 0 or the system drawable android:drawable/empty.)
   1513      *
   1514      * @param resId The resource identifier of a drawable resource which will
   1515      *              be installed as the new background.
   1516      */
   1517     public void setBackgroundDrawableResource(@DrawableRes int resId) {
   1518         setBackgroundDrawable(mContext.getDrawable(resId));
   1519     }
   1520 
   1521     /**
   1522      * Change the background of this window to a custom Drawable. Setting the
   1523      * background to null will make the window be opaque. To make the window
   1524      * transparent, you can use an empty drawable (for instance a ColorDrawable
   1525      * with the color 0 or the system drawable android:drawable/empty.)
   1526      *
   1527      * @param drawable The new Drawable to use for this window's background.
   1528      */
   1529     public abstract void setBackgroundDrawable(Drawable drawable);
   1530 
   1531     /**
   1532      * Set the value for a drawable feature of this window, from a resource
   1533      * identifier.  You must have called requestFeature(featureId) before
   1534      * calling this function.
   1535      *
   1536      * @see android.content.res.Resources#getDrawable(int)
   1537      *
   1538      * @param featureId The desired drawable feature to change, defined as a
   1539      * constant by Window.
   1540      * @param resId Resource identifier of the desired image.
   1541      */
   1542     public abstract void setFeatureDrawableResource(int featureId, @DrawableRes int resId);
   1543 
   1544     /**
   1545      * Set the value for a drawable feature of this window, from a URI. You
   1546      * must have called requestFeature(featureId) before calling this
   1547      * function.
   1548      *
   1549      * <p>The only URI currently supported is "content:", specifying an image
   1550      * in a content provider.
   1551      *
   1552      * @see android.widget.ImageView#setImageURI
   1553      *
   1554      * @param featureId The desired drawable feature to change. Features are
   1555      * constants defined by Window.
   1556      * @param uri The desired URI.
   1557      */
   1558     public abstract void setFeatureDrawableUri(int featureId, Uri uri);
   1559 
   1560     /**
   1561      * Set an explicit Drawable value for feature of this window. You must
   1562      * have called requestFeature(featureId) before calling this function.
   1563      *
   1564      * @param featureId The desired drawable feature to change. Features are
   1565      *                  constants defined by Window.
   1566      * @param drawable A Drawable object to display.
   1567      */
   1568     public abstract void setFeatureDrawable(int featureId, Drawable drawable);
   1569 
   1570     /**
   1571      * Set a custom alpha value for the given drawable feature, controlling how
   1572      * much the background is visible through it.
   1573      *
   1574      * @param featureId The desired drawable feature to change. Features are
   1575      *                  constants defined by Window.
   1576      * @param alpha The alpha amount, 0 is completely transparent and 255 is
   1577      *              completely opaque.
   1578      */
   1579     public abstract void setFeatureDrawableAlpha(int featureId, int alpha);
   1580 
   1581     /**
   1582      * Set the integer value for a feature. The range of the value depends on
   1583      * the feature being set. For {@link #FEATURE_PROGRESS}, it should go from
   1584      * 0 to 10000. At 10000 the progress is complete and the indicator hidden.
   1585      *
   1586      * @param featureId The desired feature to change. Features are constants
   1587      *                  defined by Window.
   1588      * @param value The value for the feature. The interpretation of this
   1589      *              value is feature-specific.
   1590      */
   1591     public abstract void setFeatureInt(int featureId, int value);
   1592 
   1593     /**
   1594      * Request that key events come to this activity. Use this if your
   1595      * activity has no views with focus, but the activity still wants
   1596      * a chance to process key events.
   1597      */
   1598     public abstract void takeKeyEvents(boolean get);
   1599 
   1600     /**
   1601      * Used by custom windows, such as Dialog, to pass the key press event
   1602      * further down the view hierarchy. Application developers should
   1603      * not need to implement or call this.
   1604      *
   1605      */
   1606     public abstract boolean superDispatchKeyEvent(KeyEvent event);
   1607 
   1608     /**
   1609      * Used by custom windows, such as Dialog, to pass the key shortcut press event
   1610      * further down the view hierarchy. Application developers should
   1611      * not need to implement or call this.
   1612      *
   1613      */
   1614     public abstract boolean superDispatchKeyShortcutEvent(KeyEvent event);
   1615 
   1616     /**
   1617      * Used by custom windows, such as Dialog, to pass the touch screen event
   1618      * further down the view hierarchy. Application developers should
   1619      * not need to implement or call this.
   1620      *
   1621      */
   1622     public abstract boolean superDispatchTouchEvent(MotionEvent event);
   1623 
   1624     /**
   1625      * Used by custom windows, such as Dialog, to pass the trackball event
   1626      * further down the view hierarchy. Application developers should
   1627      * not need to implement or call this.
   1628      *
   1629      */
   1630     public abstract boolean superDispatchTrackballEvent(MotionEvent event);
   1631 
   1632     /**
   1633      * Used by custom windows, such as Dialog, to pass the generic motion event
   1634      * further down the view hierarchy. Application developers should
   1635      * not need to implement or call this.
   1636      *
   1637      */
   1638     public abstract boolean superDispatchGenericMotionEvent(MotionEvent event);
   1639 
   1640     /**
   1641      * Retrieve the top-level window decor view (containing the standard
   1642      * window frame/decorations and the client's content inside of that), which
   1643      * can be added as a window to the window manager.
   1644      *
   1645      * <p><em>Note that calling this function for the first time "locks in"
   1646      * various window characteristics as described in
   1647      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}.</em></p>
   1648      *
   1649      * @return Returns the top-level window decor view.
   1650      */
   1651     public abstract View getDecorView();
   1652 
   1653     /**
   1654      * Retrieve the current decor view, but only if it has already been created;
   1655      * otherwise returns null.
   1656      *
   1657      * @return Returns the top-level window decor or null.
   1658      * @see #getDecorView
   1659      */
   1660     public abstract View peekDecorView();
   1661 
   1662     public abstract Bundle saveHierarchyState();
   1663 
   1664     public abstract void restoreHierarchyState(Bundle savedInstanceState);
   1665 
   1666     protected abstract void onActive();
   1667 
   1668     /**
   1669      * Return the feature bits that are enabled.  This is the set of features
   1670      * that were given to requestFeature(), and are being handled by this
   1671      * Window itself or its container.  That is, it is the set of
   1672      * requested features that you can actually use.
   1673      *
   1674      * <p>To do: add a public version of this API that allows you to check for
   1675      * features by their feature ID.
   1676      *
   1677      * @return int The feature bits.
   1678      */
   1679     protected final int getFeatures()
   1680     {
   1681         return mFeatures;
   1682     }
   1683 
   1684     /**
   1685      * Return the feature bits set by default on a window.
   1686      * @param context The context used to access resources
   1687      */
   1688     public static int getDefaultFeatures(Context context) {
   1689         int features = 0;
   1690 
   1691         final Resources res = context.getResources();
   1692         if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureOptionsPanel)) {
   1693             features |= 1 << FEATURE_OPTIONS_PANEL;
   1694         }
   1695 
   1696         if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureContextMenu)) {
   1697             features |= 1 << FEATURE_CONTEXT_MENU;
   1698         }
   1699 
   1700         return features;
   1701     }
   1702 
   1703     /**
   1704      * Query for the availability of a certain feature.
   1705      *
   1706      * @param feature The feature ID to check
   1707      * @return true if the feature is enabled, false otherwise.
   1708      */
   1709     public boolean hasFeature(int feature) {
   1710         return (getFeatures() & (1 << feature)) != 0;
   1711     }
   1712 
   1713     /**
   1714      * Return the feature bits that are being implemented by this Window.
   1715      * This is the set of features that were given to requestFeature(), and are
   1716      * being handled by only this Window itself, not by its containers.
   1717      *
   1718      * @return int The feature bits.
   1719      */
   1720     protected final int getLocalFeatures()
   1721     {
   1722         return mLocalFeatures;
   1723     }
   1724 
   1725     /**
   1726      * Set the default format of window, as per the PixelFormat types.  This
   1727      * is the format that will be used unless the client specifies in explicit
   1728      * format with setFormat();
   1729      *
   1730      * @param format The new window format (see PixelFormat).
   1731      *
   1732      * @see #setFormat
   1733      * @see PixelFormat
   1734      */
   1735     protected void setDefaultWindowFormat(int format) {
   1736         mDefaultWindowFormat = format;
   1737         if (!mHaveWindowFormat) {
   1738             final WindowManager.LayoutParams attrs = getAttributes();
   1739             attrs.format = format;
   1740             dispatchWindowAttributesChanged(attrs);
   1741         }
   1742     }
   1743 
   1744     /** @hide */
   1745     protected boolean haveDimAmount() {
   1746         return mHaveDimAmount;
   1747     }
   1748 
   1749     public abstract void setChildDrawable(int featureId, Drawable drawable);
   1750 
   1751     public abstract void setChildInt(int featureId, int value);
   1752 
   1753     /**
   1754      * Is a keypress one of the defined shortcut keys for this window.
   1755      * @param keyCode the key code from {@link android.view.KeyEvent} to check.
   1756      * @param event the {@link android.view.KeyEvent} to use to help check.
   1757      */
   1758     public abstract boolean isShortcutKey(int keyCode, KeyEvent event);
   1759 
   1760     /**
   1761      * @see android.app.Activity#setVolumeControlStream(int)
   1762      */
   1763     public abstract void setVolumeControlStream(int streamType);
   1764 
   1765     /**
   1766      * @see android.app.Activity#getVolumeControlStream()
   1767      */
   1768     public abstract int getVolumeControlStream();
   1769 
   1770     /**
   1771      * Sets a {@link MediaController} to send media keys and volume changes to.
   1772      * If set, this should be preferred for all media keys and volume requests
   1773      * sent to this window.
   1774      *
   1775      * @param controller The controller for the session which should receive
   1776      *            media keys and volume changes.
   1777      * @see android.app.Activity#setMediaController(android.media.session.MediaController)
   1778      */
   1779     public void setMediaController(MediaController controller) {
   1780     }
   1781 
   1782     /**
   1783      * Gets the {@link MediaController} that was previously set.
   1784      *
   1785      * @return The controller which should receive events.
   1786      * @see #setMediaController(android.media.session.MediaController)
   1787      * @see android.app.Activity#getMediaController()
   1788      */
   1789     public MediaController getMediaController() {
   1790         return null;
   1791     }
   1792 
   1793     /**
   1794      * Set extra options that will influence the UI for this window.
   1795      * @param uiOptions Flags specifying extra options for this window.
   1796      */
   1797     public void setUiOptions(int uiOptions) { }
   1798 
   1799     /**
   1800      * Set extra options that will influence the UI for this window.
   1801      * Only the bits filtered by mask will be modified.
   1802      * @param uiOptions Flags specifying extra options for this window.
   1803      * @param mask Flags specifying which options should be modified. Others will remain unchanged.
   1804      */
   1805     public void setUiOptions(int uiOptions, int mask) { }
   1806 
   1807     /**
   1808      * Set the primary icon for this window.
   1809      *
   1810      * @param resId resource ID of a drawable to set
   1811      */
   1812     public void setIcon(@DrawableRes int resId) { }
   1813 
   1814     /**
   1815      * Set the default icon for this window.
   1816      * This will be overridden by any other icon set operation which could come from the
   1817      * theme or another explicit set.
   1818      *
   1819      * @hide
   1820      */
   1821     public void setDefaultIcon(@DrawableRes int resId) { }
   1822 
   1823     /**
   1824      * Set the logo for this window. A logo is often shown in place of an
   1825      * {@link #setIcon(int) icon} but is generally wider and communicates window title information
   1826      * as well.
   1827      *
   1828      * @param resId resource ID of a drawable to set
   1829      */
   1830     public void setLogo(@DrawableRes int resId) { }
   1831 
   1832     /**
   1833      * Set the default logo for this window.
   1834      * This will be overridden by any other logo set operation which could come from the
   1835      * theme or another explicit set.
   1836      *
   1837      * @hide
   1838      */
   1839     public void setDefaultLogo(@DrawableRes int resId) { }
   1840 
   1841     /**
   1842      * Set focus locally. The window should have the
   1843      * {@link WindowManager.LayoutParams#FLAG_LOCAL_FOCUS_MODE} flag set already.
   1844      * @param hasFocus Whether this window has focus or not.
   1845      * @param inTouchMode Whether this window is in touch mode or not.
   1846      */
   1847     public void setLocalFocus(boolean hasFocus, boolean inTouchMode) { }
   1848 
   1849     /**
   1850      * Inject an event to window locally.
   1851      * @param event A key or touch event to inject to this window.
   1852      */
   1853     public void injectInputEvent(InputEvent event) { }
   1854 
   1855     /**
   1856      * Retrieve the {@link TransitionManager} responsible for  for default transitions
   1857      * in this window. Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
   1858      *
   1859      * <p>This method will return non-null after content has been initialized (e.g. by using
   1860      * {@link #setContentView}) if {@link #FEATURE_CONTENT_TRANSITIONS} has been granted.</p>
   1861      *
   1862      * @return This window's content TransitionManager or null if none is set.
   1863      * @attr ref android.R.styleable#Window_windowContentTransitionManager
   1864      */
   1865     public TransitionManager getTransitionManager() {
   1866         return null;
   1867     }
   1868 
   1869     /**
   1870      * Set the {@link TransitionManager} to use for default transitions in this window.
   1871      * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
   1872      *
   1873      * @param tm The TransitionManager to use for scene changes.
   1874      * @attr ref android.R.styleable#Window_windowContentTransitionManager
   1875      */
   1876     public void setTransitionManager(TransitionManager tm) {
   1877         throw new UnsupportedOperationException();
   1878     }
   1879 
   1880     /**
   1881      * Retrieve the {@link Scene} representing this window's current content.
   1882      * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
   1883      *
   1884      * <p>This method will return null if the current content is not represented by a Scene.</p>
   1885      *
   1886      * @return Current Scene being shown or null
   1887      */
   1888     public Scene getContentScene() {
   1889         return null;
   1890     }
   1891 
   1892     /**
   1893      * Sets the Transition that will be used to move Views into the initial scene. The entering
   1894      * Views will be those that are regular Views or ViewGroups that have
   1895      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
   1896      * {@link android.transition.Visibility} as entering is governed by changing visibility from
   1897      * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
   1898      * entering Views will remain unaffected.
   1899      *
   1900      * @param transition The Transition to use to move Views into the initial Scene.
   1901      * @attr ref android.R.styleable#Window_windowEnterTransition
   1902      */
   1903     public void setEnterTransition(Transition transition) {}
   1904 
   1905     /**
   1906      * Sets the Transition that will be used to move Views out of the scene when the Window is
   1907      * preparing to close, for example after a call to
   1908      * {@link android.app.Activity#finishAfterTransition()}. The exiting
   1909      * Views will be those that are regular Views or ViewGroups that have
   1910      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
   1911      * {@link android.transition.Visibility} as entering is governed by changing visibility from
   1912      * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null,
   1913      * entering Views will remain unaffected. If nothing is set, the default will be to
   1914      * use the same value as set in {@link #setEnterTransition(android.transition.Transition)}.
   1915      *
   1916      * @param transition The Transition to use to move Views out of the Scene when the Window
   1917      *                   is preparing to close.
   1918      * @attr ref android.R.styleable#Window_windowReturnTransition
   1919      */
   1920     public void setReturnTransition(Transition transition) {}
   1921 
   1922     /**
   1923      * Sets the Transition that will be used to move Views out of the scene when starting a
   1924      * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
   1925      * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
   1926      * {@link android.transition.Visibility} as exiting is governed by changing visibility
   1927      * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
   1928      * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   1929      *
   1930      * @param transition The Transition to use to move Views out of the scene when calling a
   1931      *                   new Activity.
   1932      * @attr ref android.R.styleable#Window_windowExitTransition
   1933      */
   1934     public void setExitTransition(Transition transition) {}
   1935 
   1936     /**
   1937      * Sets the Transition that will be used to move Views in to the scene when returning from
   1938      * a previously-started Activity. The entering Views will be those that are regular Views
   1939      * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
   1940      * will extend {@link android.transition.Visibility} as exiting is governed by changing
   1941      * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null,
   1942      * the views will remain unaffected. If nothing is set, the default will be to use the same
   1943      * transition as {@link #setExitTransition(android.transition.Transition)}.
   1944      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   1945      *
   1946      * @param transition The Transition to use to move Views into the scene when reentering from a
   1947      *                   previously-started Activity.
   1948      * @attr ref android.R.styleable#Window_windowReenterTransition
   1949      */
   1950     public void setReenterTransition(Transition transition) {}
   1951 
   1952     /**
   1953      * Returns the transition used to move Views into the initial scene. The entering
   1954      * Views will be those that are regular Views or ViewGroups that have
   1955      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
   1956      * {@link android.transition.Visibility} as entering is governed by changing visibility from
   1957      * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
   1958      * entering Views will remain unaffected.  Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   1959      *
   1960      * @return the Transition to use to move Views into the initial Scene.
   1961      * @attr ref android.R.styleable#Window_windowEnterTransition
   1962      */
   1963     public Transition getEnterTransition() { return null; }
   1964 
   1965     /**
   1966      * Returns the Transition that will be used to move Views out of the scene when the Window is
   1967      * preparing to close, for example after a call to
   1968      * {@link android.app.Activity#finishAfterTransition()}. The exiting
   1969      * Views will be those that are regular Views or ViewGroups that have
   1970      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
   1971      * {@link android.transition.Visibility} as entering is governed by changing visibility from
   1972      * {@link View#VISIBLE} to {@link View#INVISIBLE}.
   1973      *
   1974      * @return The Transition to use to move Views out of the Scene when the Window
   1975      *         is preparing to close.
   1976      * @attr ref android.R.styleable#Window_windowReturnTransition
   1977      */
   1978     public Transition getReturnTransition() { return null; }
   1979 
   1980     /**
   1981      * Returns the Transition that will be used to move Views out of the scene when starting a
   1982      * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
   1983      * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
   1984      * {@link android.transition.Visibility} as exiting is governed by changing visibility
   1985      * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
   1986      * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   1987      *
   1988      * @return the Transition to use to move Views out of the scene when calling a
   1989      * new Activity.
   1990      * @attr ref android.R.styleable#Window_windowExitTransition
   1991      */
   1992     public Transition getExitTransition() { return null; }
   1993 
   1994     /**
   1995      * Returns the Transition that will be used to move Views in to the scene when returning from
   1996      * a previously-started Activity. The entering Views will be those that are regular Views
   1997      * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
   1998      * will extend {@link android.transition.Visibility} as exiting is governed by changing
   1999      * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}.
   2000      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2001      *
   2002      * @return The Transition to use to move Views into the scene when reentering from a
   2003      *         previously-started Activity.
   2004      * @attr ref android.R.styleable#Window_windowReenterTransition
   2005      */
   2006     public Transition getReenterTransition() { return null; }
   2007 
   2008     /**
   2009      * Sets the Transition that will be used for shared elements transferred into the content
   2010      * Scene. Typical Transitions will affect size and location, such as
   2011      * {@link android.transition.ChangeBounds}. A null
   2012      * value will cause transferred shared elements to blink to the final position.
   2013      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2014      *
   2015      * @param transition The Transition to use for shared elements transferred into the content
   2016      *                   Scene.
   2017      * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
   2018      */
   2019     public void setSharedElementEnterTransition(Transition transition) {}
   2020 
   2021     /**
   2022      * Sets the Transition that will be used for shared elements transferred back to a
   2023      * calling Activity. Typical Transitions will affect size and location, such as
   2024      * {@link android.transition.ChangeBounds}. A null
   2025      * value will cause transferred shared elements to blink to the final position.
   2026      * If no value is set, the default will be to use the same value as
   2027      * {@link #setSharedElementEnterTransition(android.transition.Transition)}.
   2028      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2029      *
   2030      * @param transition The Transition to use for shared elements transferred out of the content
   2031      *                   Scene.
   2032      * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
   2033      */
   2034     public void setSharedElementReturnTransition(Transition transition) {}
   2035 
   2036     /**
   2037      * Returns the Transition that will be used for shared elements transferred into the content
   2038      * Scene. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2039      *
   2040      * @return Transition to use for sharend elements transferred into the content Scene.
   2041      * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
   2042      */
   2043     public Transition getSharedElementEnterTransition() { return null; }
   2044 
   2045     /**
   2046      * Returns the Transition that will be used for shared elements transferred back to a
   2047      * calling Activity. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2048      *
   2049      * @return Transition to use for sharend elements transferred into the content Scene.
   2050      * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
   2051      */
   2052     public Transition getSharedElementReturnTransition() { return null; }
   2053 
   2054     /**
   2055      * Sets the Transition that will be used for shared elements after starting a new Activity
   2056      * before the shared elements are transferred to the called Activity. If the shared elements
   2057      * must animate during the exit transition, this Transition should be used. Upon completion,
   2058      * the shared elements may be transferred to the started Activity.
   2059      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2060      *
   2061      * @param transition The Transition to use for shared elements in the launching Window
   2062      *                   prior to transferring to the launched Activity's Window.
   2063      * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
   2064      */
   2065     public void setSharedElementExitTransition(Transition transition) {}
   2066 
   2067     /**
   2068      * Sets the Transition that will be used for shared elements reentering from a started
   2069      * Activity after it has returned the shared element to it start location. If no value
   2070      * is set, this will default to
   2071      * {@link #setSharedElementExitTransition(android.transition.Transition)}.
   2072      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2073      *
   2074      * @param transition The Transition to use for shared elements in the launching Window
   2075      *                   after the shared element has returned to the Window.
   2076      * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
   2077      */
   2078     public void setSharedElementReenterTransition(Transition transition) {}
   2079 
   2080     /**
   2081      * Returns the Transition to use for shared elements in the launching Window prior
   2082      * to transferring to the launched Activity's Window.
   2083      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2084      *
   2085      * @return the Transition to use for shared elements in the launching Window prior
   2086      * to transferring to the launched Activity's Window.
   2087      * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
   2088      */
   2089     public Transition getSharedElementExitTransition() { return null; }
   2090 
   2091     /**
   2092      * Returns the Transition that will be used for shared elements reentering from a started
   2093      * Activity after it has returned the shared element to it start location.
   2094      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
   2095      *
   2096      * @return the Transition that will be used for shared elements reentering from a started
   2097      * Activity after it has returned the shared element to it start location.
   2098      * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
   2099      */
   2100     public Transition getSharedElementReenterTransition() { return null; }
   2101 
   2102     /**
   2103      * Controls how the transition set in
   2104      * {@link #setEnterTransition(android.transition.Transition)} overlaps with the exit
   2105      * transition of the calling Activity. When true, the transition will start as soon as possible.
   2106      * When false, the transition will wait until the remote exiting transition completes before
   2107      * starting. The default value is true.
   2108      *
   2109      * @param allow true to start the enter transition when possible or false to
   2110      *              wait until the exiting transition completes.
   2111      * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
   2112      */
   2113     public void setAllowEnterTransitionOverlap(boolean allow) {}
   2114 
   2115     /**
   2116      * Returns how the transition set in
   2117      * {@link #setEnterTransition(android.transition.Transition)} overlaps with the exit
   2118      * transition of the calling Activity. When true, the transition will start as soon as possible.
   2119      * When false, the transition will wait until the remote exiting transition completes before
   2120      * starting. The default value is true.
   2121      *
   2122      * @return true when the enter transition should start as soon as possible or false to
   2123      * when it should wait until the exiting transition completes.
   2124      * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
   2125      */
   2126     public boolean getAllowEnterTransitionOverlap() { return true; }
   2127 
   2128     /**
   2129      * Controls how the transition set in
   2130      * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
   2131      * transition of the called Activity when reentering after if finishes. When true,
   2132      * the transition will start as soon as possible. When false, the transition will wait
   2133      * until the called Activity's exiting transition completes before starting.
   2134      * The default value is true.
   2135      *
   2136      * @param allow true to start the transition when possible or false to wait until the
   2137      *              called Activity's exiting transition completes.
   2138      * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
   2139      */
   2140     public void setAllowReturnTransitionOverlap(boolean allow) {}
   2141 
   2142     /**
   2143      * Returns how the transition set in
   2144      * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
   2145      * transition of the called Activity when reentering after if finishes. When true,
   2146      * the transition will start as soon as possible. When false, the transition will wait
   2147      * until the called Activity's exiting transition completes before starting.
   2148      * The default value is true.
   2149      *
   2150      * @return true when the transition should start when possible or false when it should wait
   2151      * until the called Activity's exiting transition completes.
   2152      * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
   2153      */
   2154     public boolean getAllowReturnTransitionOverlap() { return true; }
   2155 
   2156     /**
   2157      * Returns the duration, in milliseconds, of the window background fade
   2158      * when transitioning into or away from an Activity when called with an Activity Transition.
   2159      * <p>When executing the enter transition, the background starts transparent
   2160      * and fades in. This requires {@link #FEATURE_ACTIVITY_TRANSITIONS}. The default is
   2161      * 300 milliseconds.</p>
   2162      *
   2163      * @return The duration of the window background fade to opaque during enter transition.
   2164      * @see #getEnterTransition()
   2165      * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
   2166      */
   2167     public long getTransitionBackgroundFadeDuration() { return 0; }
   2168 
   2169     /**
   2170      * Sets the duration, in milliseconds, of the window background fade
   2171      * when transitioning into or away from an Activity when called with an Activity Transition.
   2172      * <p>When executing the enter transition, the background starts transparent
   2173      * and fades in. This requires {@link #FEATURE_ACTIVITY_TRANSITIONS}. The default is
   2174      * 300 milliseconds.</p>
   2175      *
   2176      * @param fadeDurationMillis The duration of the window background fade to or from opaque
   2177      *                           during enter transition.
   2178      * @see #setEnterTransition(android.transition.Transition)
   2179      * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
   2180      */
   2181     public void setTransitionBackgroundFadeDuration(long fadeDurationMillis) { }
   2182 
   2183     /**
   2184      * Returns <code>true</code> when shared elements should use an Overlay during
   2185      * shared element transitions or <code>false</code> when they should animate as
   2186      * part of the normal View hierarchy. The default value is true.
   2187      *
   2188      * @return <code>true</code> when shared elements should use an Overlay during
   2189      * shared element transitions or <code>false</code> when they should animate as
   2190      * part of the normal View hierarchy.
   2191      * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
   2192      */
   2193     public boolean getSharedElementsUseOverlay() { return true; }
   2194 
   2195     /**
   2196      * Sets whether or not shared elements should use an Overlay during shared element transitions.
   2197      * The default value is true.
   2198      *
   2199      * @param sharedElementsUseOverlay <code>true</code> indicates that shared elements should
   2200      *                                 be transitioned with an Overlay or <code>false</code>
   2201      *                                 to transition within the normal View hierarchy.
   2202      * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
   2203      */
   2204     public void setSharedElementsUseOverlay(boolean sharedElementsUseOverlay) { }
   2205 
   2206     /**
   2207      * @return the color of the status bar.
   2208      */
   2209     @ColorInt
   2210     public abstract int getStatusBarColor();
   2211 
   2212     /**
   2213      * Sets the color of the status bar to {@code color}.
   2214      *
   2215      * For this to take effect,
   2216      * the window must be drawing the system bar backgrounds with
   2217      * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
   2218      * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_STATUS} must not be set.
   2219      *
   2220      * If {@code color} is not opaque, consider setting
   2221      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
   2222      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
   2223      * <p>
   2224      * The transitionName for the view background will be "android:status:background".
   2225      * </p>
   2226      */
   2227     public abstract void setStatusBarColor(@ColorInt int color);
   2228 
   2229     /**
   2230      * @return the color of the navigation bar.
   2231      */
   2232     @ColorInt
   2233     public abstract int getNavigationBarColor();
   2234 
   2235     /**
   2236      * Sets the color of the navigation bar to {@param color}.
   2237      *
   2238      * For this to take effect,
   2239      * the window must be drawing the system bar backgrounds with
   2240      * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
   2241      * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_NAVIGATION} must not be set.
   2242      *
   2243      * If {@param color} is not opaque, consider setting
   2244      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
   2245      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}.
   2246      * <p>
   2247      * The transitionName for the view background will be "android:navigation:background".
   2248      * </p>
   2249      */
   2250     public abstract void setNavigationBarColor(@ColorInt int color);
   2251 
   2252     /** @hide */
   2253     public void setTheme(int resId) {
   2254     }
   2255 
   2256     /**
   2257      * Whether the caption should be displayed directly on the content rather than push the content
   2258      * down. This affects only freeform windows since they display the caption.
   2259      * @hide
   2260      */
   2261     public void setOverlayWithDecorCaptionEnabled(boolean enabled) {
   2262         mOverlayWithDecorCaptionEnabled = enabled;
   2263     }
   2264 
   2265     /** @hide */
   2266     public boolean isOverlayWithDecorCaptionEnabled() {
   2267         return mOverlayWithDecorCaptionEnabled;
   2268     }
   2269 
   2270     /** @hide */
   2271     public void notifyRestrictedCaptionAreaCallback(int left, int top, int right, int bottom) {
   2272         if (mOnRestrictedCaptionAreaChangedListener != null) {
   2273             mRestrictedCaptionAreaRect.set(left, top, right, bottom);
   2274             mOnRestrictedCaptionAreaChangedListener.onRestrictedCaptionAreaChanged(
   2275                     mRestrictedCaptionAreaRect);
   2276         }
   2277     }
   2278 
   2279     /**
   2280      * Set what color should the caption controls be. By default the system will try to determine
   2281      * the color from the theme. You can overwrite this by using {@link #DECOR_CAPTION_SHADE_DARK},
   2282      * {@link #DECOR_CAPTION_SHADE_LIGHT}, or {@link #DECOR_CAPTION_SHADE_AUTO}.
   2283      * @see #DECOR_CAPTION_SHADE_DARK
   2284      * @see #DECOR_CAPTION_SHADE_LIGHT
   2285      * @see #DECOR_CAPTION_SHADE_AUTO
   2286      */
   2287     public abstract void setDecorCaptionShade(int decorCaptionShade);
   2288 
   2289     /**
   2290      * Set the drawable that is drawn underneath the caption during the resizing.
   2291      *
   2292      * During the resizing the caption might not be drawn fast enough to match the new dimensions.
   2293      * There is a second caption drawn underneath it that will be fast enough. By default the
   2294      * caption is constructed from the theme. You can provide a drawable, that will be drawn instead
   2295      * to better match your application.
   2296      */
   2297     public abstract void setResizingCaptionDrawable(Drawable drawable);
   2298 
   2299     /**
   2300      * Called when the activity changes from fullscreen mode to multi-window mode and visa-versa.
   2301      * @hide
   2302      */
   2303     public abstract void onMultiWindowModeChanged();
   2304 
   2305     /**
   2306      * Called when the activity changes to/from picture-in-picture mode.
   2307      * @hide
   2308      */
   2309     public abstract void onPictureInPictureModeChanged(boolean isInPictureInPictureMode);
   2310 
   2311     /**
   2312      * Called when the activity just relaunched.
   2313      * @hide
   2314      */
   2315     public abstract void reportActivityRelaunched();
   2316 
   2317     /**
   2318      * Called to set flag to check if the close on swipe is enabled. This will only function if
   2319      * FEATURE_SWIPE_TO_DISMISS has been set.
   2320      * @hide
   2321      */
   2322     public void setCloseOnSwipeEnabled(boolean closeOnSwipeEnabled) {
   2323         mCloseOnSwipeEnabled = closeOnSwipeEnabled;
   2324     }
   2325 
   2326     /**
   2327      * @return {@code true} if the close on swipe is enabled.
   2328      * @hide
   2329      */
   2330     public boolean isCloseOnSwipeEnabled() {
   2331         return mCloseOnSwipeEnabled;
   2332     }
   2333 }
   2334