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.app.WindowConfiguration;
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          */
dispatchKeyEvent(KeyEvent event)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          */
dispatchKeyShortcutEvent(KeyEvent event)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          */
dispatchTouchEvent(MotionEvent event)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          */
dispatchTrackballEvent(MotionEvent event)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          */
dispatchGenericMotionEvent(MotionEvent event)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          */
dispatchPopulateAccessibilityEvent(AccessibilityEvent event)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
onCreatePanelView(int featureId)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          */
onCreatePanelMenu(int featureId, Menu menu)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          */
onPreparePanel(int featureId, View view, Menu menu)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          */
onMenuOpened(int featureId, Menu menu)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          */
onMenuItemSelected(int featureId, MenuItem item)455         public boolean onMenuItemSelected(int featureId, MenuItem item);
456 
457         /**
458          * This is called whenever the current window attributes change.
459          *
460          */
onWindowAttributesChanged(WindowManager.LayoutParams attrs)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          */
onContentChanged()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          */
onWindowFocusChanged(boolean hasFocus)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          */
onAttachedToWindow()487         public void onAttachedToWindow();
488 
489         /**
490          * Called when the window has been detached from the window manager.
491          * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
492          * for more information.
493          */
onDetachedFromWindow()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          */
onPanelClosed(int featureId, Menu menu)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          */
onSearchRequested()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          */
onSearchRequested(SearchEvent searchEvent)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
onWindowStartingActionMode(ActionMode.Callback callback)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
onWindowStartingActionMode(ActionMode.Callback callback, int type)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          */
onActionModeStarted(ActionMode mode)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          */
onActionModeFinished(ActionMode mode)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          */
onProvideKeyboardShortcuts( List<KeyboardShortcutGroup> data, @Nullable Menu menu, int deviceId)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          */
onPointerCaptureChanged(boolean hasCapture)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          */
onWindowDismissed(boolean finishTask, boolean suppressWindowTransition)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          */
onWindowSwipeDismissed()607         void onWindowSwipeDismissed();
608     }
609 
610     /** @hide */
611     public interface WindowControllerCallback {
612         /**
613          * Moves the activity from
614          * Moves the activity from {@link WindowConfiguration#WINDOWING_MODE_FREEFORM} windowing
615          * mode to {@link WindowConfiguration#WINDOWING_MODE_FULLSCREEN}.
616          */
exitFreeformMode()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          */
enterPictureInPictureModeIfPossible()623         void enterPictureInPictureModeIfPossible();
624 
625         /** Returns whether the window belongs to the task root. */
isTaskRoot()626         boolean isTaskRoot();
627     }
628 
629     /**
630      * Callback for clients that want to be aware of where caption draws content.
631      */
632     public interface OnRestrictedCaptionAreaChangedListener {
633         /**
634          * Called when the area where caption draws content changes.
635          *
636          * @param rect The area where caption content is positioned, relative to the top view.
637          */
onRestrictedCaptionAreaChanged(Rect rect)638         void onRestrictedCaptionAreaChanged(Rect rect);
639     }
640 
641     /**
642      * Callback for clients that want frame timing information for each
643      * frame rendered by the Window.
644      */
645     public interface OnFrameMetricsAvailableListener {
646         /**
647          * Called when information is available for the previously rendered frame.
648          *
649          * Reports can be dropped if this callback takes too
650          * long to execute, as the report producer cannot wait for the consumer to
651          * complete.
652          *
653          * It is highly recommended that clients copy the passed in FrameMetrics
654          * via {@link FrameMetrics#FrameMetrics(FrameMetrics)} within this method and defer
655          * additional computation or storage to another thread to avoid unnecessarily
656          * dropping reports.
657          *
658          * @param window The {@link Window} on which the frame was displayed.
659          * @param frameMetrics the available metrics. This object is reused on every call
660          * and thus <strong>this reference is not valid outside the scope of this method</strong>.
661          * @param dropCountSinceLastInvocation the number of reports dropped since the last time
662          * this callback was invoked.
663          */
onFrameMetricsAvailable(Window window, FrameMetrics frameMetrics, int dropCountSinceLastInvocation)664         void onFrameMetricsAvailable(Window window, FrameMetrics frameMetrics,
665                 int dropCountSinceLastInvocation);
666     }
667 
668 
Window(Context context)669     public Window(Context context) {
670         mContext = context;
671         mFeatures = mLocalFeatures = getDefaultFeatures(context);
672     }
673 
674     /**
675      * Return the Context this window policy is running in, for retrieving
676      * resources and other information.
677      *
678      * @return Context The Context that was supplied to the constructor.
679      */
getContext()680     public final Context getContext() {
681         return mContext;
682     }
683 
684     /**
685      * Return the {@link android.R.styleable#Window} attributes from this
686      * window's theme.
687      */
getWindowStyle()688     public final TypedArray getWindowStyle() {
689         synchronized (this) {
690             if (mWindowStyle == null) {
691                 mWindowStyle = mContext.obtainStyledAttributes(
692                         com.android.internal.R.styleable.Window);
693             }
694             return mWindowStyle;
695         }
696     }
697 
698     /**
699      * Set the container for this window.  If not set, the DecorWindow
700      * operates as a top-level window; otherwise, it negotiates with the
701      * container to display itself appropriately.
702      *
703      * @param container The desired containing Window.
704      */
setContainer(Window container)705     public void setContainer(Window container) {
706         mContainer = container;
707         if (container != null) {
708             // Embedded screens never have a title.
709             mFeatures |= 1<<FEATURE_NO_TITLE;
710             mLocalFeatures |= 1<<FEATURE_NO_TITLE;
711             container.mHasChildren = true;
712         }
713     }
714 
715     /**
716      * Return the container for this Window.
717      *
718      * @return Window The containing window, or null if this is a
719      *         top-level window.
720      */
getContainer()721     public final Window getContainer() {
722         return mContainer;
723     }
724 
hasChildren()725     public final boolean hasChildren() {
726         return mHasChildren;
727     }
728 
729     /** @hide */
destroy()730     public final void destroy() {
731         mDestroyed = true;
732     }
733 
734     /** @hide */
isDestroyed()735     public final boolean isDestroyed() {
736         return mDestroyed;
737     }
738 
739     /**
740      * Set the window manager for use by this Window to, for example,
741      * display panels.  This is <em>not</em> used for displaying the
742      * Window itself -- that must be done by the client.
743      *
744      * @param wm The window manager for adding new windows.
745      */
setWindowManager(WindowManager wm, IBinder appToken, String appName)746     public void setWindowManager(WindowManager wm, IBinder appToken, String appName) {
747         setWindowManager(wm, appToken, appName, false);
748     }
749 
750     /**
751      * Set the window manager for use by this Window to, for example,
752      * display panels.  This is <em>not</em> used for displaying the
753      * Window itself -- that must be done by the client.
754      *
755      * @param wm The window manager for adding new windows.
756      */
setWindowManager(WindowManager wm, IBinder appToken, String appName, boolean hardwareAccelerated)757     public void setWindowManager(WindowManager wm, IBinder appToken, String appName,
758             boolean hardwareAccelerated) {
759         mAppToken = appToken;
760         mAppName = appName;
761         mHardwareAccelerated = hardwareAccelerated
762                 || SystemProperties.getBoolean(PROPERTY_HARDWARE_UI, false);
763         if (wm == null) {
764             wm = (WindowManager)mContext.getSystemService(Context.WINDOW_SERVICE);
765         }
766         mWindowManager = ((WindowManagerImpl)wm).createLocalWindowManager(this);
767     }
768 
adjustLayoutParamsForSubWindow(WindowManager.LayoutParams wp)769     void adjustLayoutParamsForSubWindow(WindowManager.LayoutParams wp) {
770         CharSequence curTitle = wp.getTitle();
771         if (wp.type >= WindowManager.LayoutParams.FIRST_SUB_WINDOW &&
772                 wp.type <= WindowManager.LayoutParams.LAST_SUB_WINDOW) {
773             if (wp.token == null) {
774                 View decor = peekDecorView();
775                 if (decor != null) {
776                     wp.token = decor.getWindowToken();
777                 }
778             }
779             if (curTitle == null || curTitle.length() == 0) {
780                 final StringBuilder title = new StringBuilder(32);
781                 if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA) {
782                     title.append("Media");
783                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY) {
784                     title.append("MediaOvr");
785                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_PANEL) {
786                     title.append("Panel");
787                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL) {
788                     title.append("SubPanel");
789                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL) {
790                     title.append("AboveSubPanel");
791                 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG) {
792                     title.append("AtchDlg");
793                 } else {
794                     title.append(wp.type);
795                 }
796                 if (mAppName != null) {
797                     title.append(":").append(mAppName);
798                 }
799                 wp.setTitle(title);
800             }
801         } else if (wp.type >= WindowManager.LayoutParams.FIRST_SYSTEM_WINDOW &&
802                 wp.type <= WindowManager.LayoutParams.LAST_SYSTEM_WINDOW) {
803             // We don't set the app token to this system window because the life cycles should be
804             // independent. If an app creates a system window and then the app goes to the stopped
805             // state, the system window should not be affected (can still show and receive input
806             // events).
807             if (curTitle == null || curTitle.length() == 0) {
808                 final StringBuilder title = new StringBuilder(32);
809                 title.append("Sys").append(wp.type);
810                 if (mAppName != null) {
811                     title.append(":").append(mAppName);
812                 }
813                 wp.setTitle(title);
814             }
815         } else {
816             if (wp.token == null) {
817                 wp.token = mContainer == null ? mAppToken : mContainer.mAppToken;
818             }
819             if ((curTitle == null || curTitle.length() == 0)
820                     && mAppName != null) {
821                 wp.setTitle(mAppName);
822             }
823         }
824         if (wp.packageName == null) {
825             wp.packageName = mContext.getPackageName();
826         }
827         if (mHardwareAccelerated ||
828                 (mWindowAttributes.flags & FLAG_HARDWARE_ACCELERATED) != 0) {
829             wp.flags |= FLAG_HARDWARE_ACCELERATED;
830         }
831     }
832 
833     /**
834      * Return the window manager allowing this Window to display its own
835      * windows.
836      *
837      * @return WindowManager The ViewManager.
838      */
getWindowManager()839     public WindowManager getWindowManager() {
840         return mWindowManager;
841     }
842 
843     /**
844      * Set the Callback interface for this window, used to intercept key
845      * events and other dynamic operations in the window.
846      *
847      * @param callback The desired Callback interface.
848      */
setCallback(Callback callback)849     public void setCallback(Callback callback) {
850         mCallback = callback;
851     }
852 
853     /**
854      * Return the current Callback interface for this window.
855      */
getCallback()856     public final Callback getCallback() {
857         return mCallback;
858     }
859 
860     /**
861      * Set an observer to collect frame stats for each frame rendererd in this window.
862      *
863      * Must be in hardware rendering mode.
864      */
addOnFrameMetricsAvailableListener( @onNull OnFrameMetricsAvailableListener listener, Handler handler)865     public final void addOnFrameMetricsAvailableListener(
866             @NonNull OnFrameMetricsAvailableListener listener,
867             Handler handler) {
868         final View decorView = getDecorView();
869         if (decorView == null) {
870             throw new IllegalStateException("can't observe a Window without an attached view");
871         }
872 
873         if (listener == null) {
874             throw new NullPointerException("listener cannot be null");
875         }
876 
877         decorView.addFrameMetricsListener(this, listener, handler);
878     }
879 
880     /**
881      * Remove observer and stop listening to frame stats for this window.
882      */
removeOnFrameMetricsAvailableListener(OnFrameMetricsAvailableListener listener)883     public final void removeOnFrameMetricsAvailableListener(OnFrameMetricsAvailableListener listener) {
884         final View decorView = getDecorView();
885         if (decorView != null) {
886             getDecorView().removeFrameMetricsListener(listener);
887         }
888     }
889 
890     /** @hide */
setOnWindowDismissedCallback(OnWindowDismissedCallback dcb)891     public final void setOnWindowDismissedCallback(OnWindowDismissedCallback dcb) {
892         mOnWindowDismissedCallback = dcb;
893     }
894 
895     /** @hide */
dispatchOnWindowDismissed( boolean finishTask, boolean suppressWindowTransition)896     public final void dispatchOnWindowDismissed(
897             boolean finishTask, boolean suppressWindowTransition) {
898         if (mOnWindowDismissedCallback != null) {
899             mOnWindowDismissedCallback.onWindowDismissed(finishTask, suppressWindowTransition);
900         }
901     }
902 
903     /** @hide */
setOnWindowSwipeDismissedCallback(OnWindowSwipeDismissedCallback sdcb)904     public final void setOnWindowSwipeDismissedCallback(OnWindowSwipeDismissedCallback sdcb) {
905         mOnWindowSwipeDismissedCallback = sdcb;
906     }
907 
908     /** @hide */
dispatchOnWindowSwipeDismissed()909     public final void dispatchOnWindowSwipeDismissed() {
910         if (mOnWindowSwipeDismissedCallback != null) {
911             mOnWindowSwipeDismissedCallback.onWindowSwipeDismissed();
912         }
913     }
914 
915     /** @hide */
setWindowControllerCallback(WindowControllerCallback wccb)916     public final void setWindowControllerCallback(WindowControllerCallback wccb) {
917         mWindowControllerCallback = wccb;
918     }
919 
920     /** @hide */
getWindowControllerCallback()921     public final WindowControllerCallback getWindowControllerCallback() {
922         return mWindowControllerCallback;
923     }
924 
925     /**
926      * Set a callback for changes of area where caption will draw its content.
927      *
928      * @param listener Callback that will be called when the area changes.
929      */
setRestrictedCaptionAreaListener(OnRestrictedCaptionAreaChangedListener listener)930     public final void setRestrictedCaptionAreaListener(OnRestrictedCaptionAreaChangedListener listener) {
931         mOnRestrictedCaptionAreaChangedListener = listener;
932         mRestrictedCaptionAreaRect = listener != null ? new Rect() : null;
933     }
934 
935     /**
936      * Take ownership of this window's surface.  The window's view hierarchy
937      * will no longer draw into the surface, though it will otherwise continue
938      * to operate (such as for receiving input events).  The given SurfaceHolder
939      * callback will be used to tell you about state changes to the surface.
940      */
takeSurface(SurfaceHolder.Callback2 callback)941     public abstract void takeSurface(SurfaceHolder.Callback2 callback);
942 
943     /**
944      * Take ownership of this window's InputQueue.  The window will no
945      * longer read and dispatch input events from the queue; it is your
946      * responsibility to do so.
947      */
takeInputQueue(InputQueue.Callback callback)948     public abstract void takeInputQueue(InputQueue.Callback callback);
949 
950     /**
951      * Return whether this window is being displayed with a floating style
952      * (based on the {@link android.R.attr#windowIsFloating} attribute in
953      * the style/theme).
954      *
955      * @return Returns true if the window is configured to be displayed floating
956      * on top of whatever is behind it.
957      */
isFloating()958     public abstract boolean isFloating();
959 
960     /**
961      * Set the width and height layout parameters of the window.  The default
962      * for both of these is MATCH_PARENT; you can change them to WRAP_CONTENT
963      * or an absolute value to make a window that is not full-screen.
964      *
965      * @param width The desired layout width of the window.
966      * @param height The desired layout height of the window.
967      *
968      * @see ViewGroup.LayoutParams#height
969      * @see ViewGroup.LayoutParams#width
970      */
setLayout(int width, int height)971     public void setLayout(int width, int height) {
972         final WindowManager.LayoutParams attrs = getAttributes();
973         attrs.width = width;
974         attrs.height = height;
975         dispatchWindowAttributesChanged(attrs);
976     }
977 
978     /**
979      * Set the gravity of the window, as per the Gravity constants.  This
980      * controls how the window manager is positioned in the overall window; it
981      * is only useful when using WRAP_CONTENT for the layout width or height.
982      *
983      * @param gravity The desired gravity constant.
984      *
985      * @see Gravity
986      * @see #setLayout
987      */
setGravity(int gravity)988     public void setGravity(int gravity)
989     {
990         final WindowManager.LayoutParams attrs = getAttributes();
991         attrs.gravity = gravity;
992         dispatchWindowAttributesChanged(attrs);
993     }
994 
995     /**
996      * Set the type of the window, as per the WindowManager.LayoutParams
997      * types.
998      *
999      * @param type The new window type (see WindowManager.LayoutParams).
1000      */
setType(int type)1001     public void setType(int type) {
1002         final WindowManager.LayoutParams attrs = getAttributes();
1003         attrs.type = type;
1004         dispatchWindowAttributesChanged(attrs);
1005     }
1006 
1007     /**
1008      * Set the format of window, as per the PixelFormat types.  This overrides
1009      * the default format that is selected by the Window based on its
1010      * window decorations.
1011      *
1012      * @param format The new window format (see PixelFormat).  Use
1013      *               PixelFormat.UNKNOWN to allow the Window to select
1014      *               the format.
1015      *
1016      * @see PixelFormat
1017      */
setFormat(int format)1018     public void setFormat(int format) {
1019         final WindowManager.LayoutParams attrs = getAttributes();
1020         if (format != PixelFormat.UNKNOWN) {
1021             attrs.format = format;
1022             mHaveWindowFormat = true;
1023         } else {
1024             attrs.format = mDefaultWindowFormat;
1025             mHaveWindowFormat = false;
1026         }
1027         dispatchWindowAttributesChanged(attrs);
1028     }
1029 
1030     /**
1031      * Specify custom animations to use for the window, as per
1032      * {@link WindowManager.LayoutParams#windowAnimations
1033      * WindowManager.LayoutParams.windowAnimations}.  Providing anything besides
1034      * 0 here will override the animations the window would
1035      * normally retrieve from its theme.
1036      */
setWindowAnimations(@tyleRes int resId)1037     public void setWindowAnimations(@StyleRes int resId) {
1038         final WindowManager.LayoutParams attrs = getAttributes();
1039         attrs.windowAnimations = resId;
1040         dispatchWindowAttributesChanged(attrs);
1041     }
1042 
1043     /**
1044      * Specify an explicit soft input mode to use for the window, as per
1045      * {@link WindowManager.LayoutParams#softInputMode
1046      * WindowManager.LayoutParams.softInputMode}.  Providing anything besides
1047      * "unspecified" here will override the input mode the window would
1048      * normally retrieve from its theme.
1049      */
setSoftInputMode(int mode)1050     public void setSoftInputMode(int mode) {
1051         final WindowManager.LayoutParams attrs = getAttributes();
1052         if (mode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
1053             attrs.softInputMode = mode;
1054             mHasSoftInputMode = true;
1055         } else {
1056             mHasSoftInputMode = false;
1057         }
1058         dispatchWindowAttributesChanged(attrs);
1059     }
1060 
1061     /**
1062      * Convenience function to set the flag bits as specified in flags, as
1063      * per {@link #setFlags}.
1064      * @param flags The flag bits to be set.
1065      * @see #setFlags
1066      * @see #clearFlags
1067      */
addFlags(int flags)1068     public void addFlags(int flags) {
1069         setFlags(flags, flags);
1070     }
1071 
1072     /** @hide */
addPrivateFlags(int flags)1073     public void addPrivateFlags(int flags) {
1074         setPrivateFlags(flags, flags);
1075     }
1076 
1077     /**
1078      * Convenience function to clear the flag bits as specified in flags, as
1079      * per {@link #setFlags}.
1080      * @param flags The flag bits to be cleared.
1081      * @see #setFlags
1082      * @see #addFlags
1083      */
clearFlags(int flags)1084     public void clearFlags(int flags) {
1085         setFlags(0, flags);
1086     }
1087 
1088     /**
1089      * Set the flags of the window, as per the
1090      * {@link WindowManager.LayoutParams WindowManager.LayoutParams}
1091      * flags.
1092      *
1093      * <p>Note that some flags must be set before the window decoration is
1094      * created (by the first call to
1095      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} or
1096      * {@link #getDecorView()}:
1097      * {@link WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN} and
1098      * {@link WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR}.  These
1099      * will be set for you based on the {@link android.R.attr#windowIsFloating}
1100      * attribute.
1101      *
1102      * @param flags The new window flags (see WindowManager.LayoutParams).
1103      * @param mask Which of the window flag bits to modify.
1104      * @see #addFlags
1105      * @see #clearFlags
1106      */
setFlags(int flags, int mask)1107     public void setFlags(int flags, int mask) {
1108         final WindowManager.LayoutParams attrs = getAttributes();
1109         attrs.flags = (attrs.flags&~mask) | (flags&mask);
1110         mForcedWindowFlags |= mask;
1111         dispatchWindowAttributesChanged(attrs);
1112     }
1113 
setPrivateFlags(int flags, int mask)1114     private void setPrivateFlags(int flags, int mask) {
1115         final WindowManager.LayoutParams attrs = getAttributes();
1116         attrs.privateFlags = (attrs.privateFlags & ~mask) | (flags & mask);
1117         dispatchWindowAttributesChanged(attrs);
1118     }
1119 
1120     /**
1121      * {@hide}
1122      */
setNeedsMenuKey(int value)1123     protected void setNeedsMenuKey(int value) {
1124         final WindowManager.LayoutParams attrs = getAttributes();
1125         attrs.needsMenuKey = value;
1126         dispatchWindowAttributesChanged(attrs);
1127     }
1128 
1129     /**
1130      * {@hide}
1131      */
dispatchWindowAttributesChanged(WindowManager.LayoutParams attrs)1132     protected void dispatchWindowAttributesChanged(WindowManager.LayoutParams attrs) {
1133         if (mCallback != null) {
1134             mCallback.onWindowAttributesChanged(attrs);
1135         }
1136     }
1137 
1138     /**
1139      * <p>Sets the requested color mode of the window. The requested the color mode might
1140      * override the window's pixel {@link WindowManager.LayoutParams#format format}.</p>
1141      *
1142      * <p>The requested color mode must be one of {@link ActivityInfo#COLOR_MODE_DEFAULT},
1143      * {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT} or {@link ActivityInfo#COLOR_MODE_HDR}.</p>
1144      *
1145      * <p>The requested color mode is not guaranteed to be honored. Please refer to
1146      * {@link #getColorMode()} for more information.</p>
1147      *
1148      * @see #getColorMode()
1149      * @see Display#isWideColorGamut()
1150      * @see Configuration#isScreenWideColorGamut()
1151      */
setColorMode(@ctivityInfo.ColorMode int colorMode)1152     public void setColorMode(@ActivityInfo.ColorMode int colorMode) {
1153         final WindowManager.LayoutParams attrs = getAttributes();
1154         attrs.setColorMode(colorMode);
1155         dispatchWindowAttributesChanged(attrs);
1156     }
1157 
1158     /**
1159      * Returns the requested color mode of the window, one of
1160      * {@link ActivityInfo#COLOR_MODE_DEFAULT}, {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT}
1161      * or {@link ActivityInfo#COLOR_MODE_HDR}. If {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT}
1162      * was requested it is possible the window will not be put in wide color gamut mode depending
1163      * on device and display support for that mode. Use {@link #isWideColorGamut} to determine
1164      * if the window is currently in wide color gamut mode.
1165      *
1166      * @see #setColorMode(int)
1167      * @see Display#isWideColorGamut()
1168      * @see Configuration#isScreenWideColorGamut()
1169      */
1170     @ActivityInfo.ColorMode
getColorMode()1171     public int getColorMode() {
1172         return getAttributes().getColorMode();
1173     }
1174 
1175     /**
1176      * Returns true if this window's color mode is {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT},
1177      * the display has a wide color gamut and this device supports wide color gamut rendering.
1178      *
1179      * @see Display#isWideColorGamut()
1180      * @see Configuration#isScreenWideColorGamut()
1181      */
isWideColorGamut()1182     public boolean isWideColorGamut() {
1183         return getColorMode() == ActivityInfo.COLOR_MODE_WIDE_COLOR_GAMUT
1184                 && getContext().getResources().getConfiguration().isScreenWideColorGamut();
1185     }
1186 
1187     /**
1188      * Set the amount of dim behind the window when using
1189      * {@link WindowManager.LayoutParams#FLAG_DIM_BEHIND}.  This overrides
1190      * the default dim amount of that is selected by the Window based on
1191      * its theme.
1192      *
1193      * @param amount The new dim amount, from 0 for no dim to 1 for full dim.
1194      */
setDimAmount(float amount)1195     public void setDimAmount(float amount) {
1196         final WindowManager.LayoutParams attrs = getAttributes();
1197         attrs.dimAmount = amount;
1198         mHaveDimAmount = true;
1199         dispatchWindowAttributesChanged(attrs);
1200     }
1201 
1202     /**
1203      * Specify custom window attributes.  <strong>PLEASE NOTE:</strong> the
1204      * layout params you give here should generally be from values previously
1205      * retrieved with {@link #getAttributes()}; you probably do not want to
1206      * blindly create and apply your own, since this will blow away any values
1207      * set by the framework that you are not interested in.
1208      *
1209      * @param a The new window attributes, which will completely override any
1210      *          current values.
1211      */
setAttributes(WindowManager.LayoutParams a)1212     public void setAttributes(WindowManager.LayoutParams a) {
1213         mWindowAttributes.copyFrom(a);
1214         dispatchWindowAttributesChanged(mWindowAttributes);
1215     }
1216 
1217     /**
1218      * Retrieve the current window attributes associated with this panel.
1219      *
1220      * @return WindowManager.LayoutParams Either the existing window
1221      *         attributes object, or a freshly created one if there is none.
1222      */
getAttributes()1223     public final WindowManager.LayoutParams getAttributes() {
1224         return mWindowAttributes;
1225     }
1226 
1227     /**
1228      * Return the window flags that have been explicitly set by the client,
1229      * so will not be modified by {@link #getDecorView}.
1230      */
getForcedWindowFlags()1231     protected final int getForcedWindowFlags() {
1232         return mForcedWindowFlags;
1233     }
1234 
1235     /**
1236      * Has the app specified their own soft input mode?
1237      */
hasSoftInputMode()1238     protected final boolean hasSoftInputMode() {
1239         return mHasSoftInputMode;
1240     }
1241 
1242     /** @hide */
setCloseOnTouchOutside(boolean close)1243     public void setCloseOnTouchOutside(boolean close) {
1244         mCloseOnTouchOutside = close;
1245         mSetCloseOnTouchOutside = true;
1246     }
1247 
1248     /** @hide */
setCloseOnTouchOutsideIfNotSet(boolean close)1249     public void setCloseOnTouchOutsideIfNotSet(boolean close) {
1250         if (!mSetCloseOnTouchOutside) {
1251             mCloseOnTouchOutside = close;
1252             mSetCloseOnTouchOutside = true;
1253         }
1254     }
1255 
1256     /** @hide */
alwaysReadCloseOnTouchAttr()1257     public abstract void alwaysReadCloseOnTouchAttr();
1258 
1259     /** @hide */
shouldCloseOnTouch(Context context, MotionEvent event)1260     public boolean shouldCloseOnTouch(Context context, MotionEvent event) {
1261         final boolean isOutside =
1262                 event.getAction() == MotionEvent.ACTION_DOWN && isOutOfBounds(context, event)
1263                 || event.getAction() == MotionEvent.ACTION_OUTSIDE;
1264         if (mCloseOnTouchOutside && peekDecorView() != null && isOutside) {
1265             return true;
1266         }
1267         return false;
1268     }
1269 
1270     /* Sets the Sustained Performance requirement for the calling window.
1271      * @param enable disables or enables the mode.
1272      */
setSustainedPerformanceMode(boolean enable)1273     public void setSustainedPerformanceMode(boolean enable) {
1274         setPrivateFlags(enable
1275                 ? WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE : 0,
1276                 WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE);
1277     }
1278 
isOutOfBounds(Context context, MotionEvent event)1279     private boolean isOutOfBounds(Context context, MotionEvent event) {
1280         final int x = (int) event.getX();
1281         final int y = (int) event.getY();
1282         final int slop = ViewConfiguration.get(context).getScaledWindowTouchSlop();
1283         final View decorView = getDecorView();
1284         return (x < -slop) || (y < -slop)
1285                 || (x > (decorView.getWidth()+slop))
1286                 || (y > (decorView.getHeight()+slop));
1287     }
1288 
1289     /**
1290      * Enable extended screen features.  This must be called before
1291      * setContentView().  May be called as many times as desired as long as it
1292      * is before setContentView().  If not called, no extended features
1293      * will be available.  You can not turn off a feature once it is requested.
1294      * You canot use other title features with {@link #FEATURE_CUSTOM_TITLE}.
1295      *
1296      * @param featureId The desired features, defined as constants by Window.
1297      * @return The features that are now set.
1298      */
requestFeature(int featureId)1299     public boolean requestFeature(int featureId) {
1300         final int flag = 1<<featureId;
1301         mFeatures |= flag;
1302         mLocalFeatures |= mContainer != null ? (flag&~mContainer.mFeatures) : flag;
1303         return (mFeatures&flag) != 0;
1304     }
1305 
1306     /**
1307      * @hide Used internally to help resolve conflicting features.
1308      */
removeFeature(int featureId)1309     protected void removeFeature(int featureId) {
1310         final int flag = 1<<featureId;
1311         mFeatures &= ~flag;
1312         mLocalFeatures &= ~(mContainer != null ? (flag&~mContainer.mFeatures) : flag);
1313     }
1314 
makeActive()1315     public final void makeActive() {
1316         if (mContainer != null) {
1317             if (mContainer.mActiveChild != null) {
1318                 mContainer.mActiveChild.mIsActive = false;
1319             }
1320             mContainer.mActiveChild = this;
1321         }
1322         mIsActive = true;
1323         onActive();
1324     }
1325 
isActive()1326     public final boolean isActive()
1327     {
1328         return mIsActive;
1329     }
1330 
1331     /**
1332      * Finds a view that was identified by the {@code android:id} XML attribute
1333      * that was processed in {@link android.app.Activity#onCreate}.
1334      * <p>
1335      * This will implicitly call {@link #getDecorView} with all of the associated side-effects.
1336      * <p>
1337      * <strong>Note:</strong> In most cases -- depending on compiler support --
1338      * the resulting view is automatically cast to the target class type. If
1339      * the target class type is unconstrained, an explicit cast may be
1340      * necessary.
1341      *
1342      * @param id the ID to search for
1343      * @return a view with given ID if found, or {@code null} otherwise
1344      * @see View#findViewById(int)
1345      * @see Window#requireViewById(int)
1346      */
1347     @Nullable
findViewById(@dRes int id)1348     public <T extends View> T findViewById(@IdRes int id) {
1349         return getDecorView().findViewById(id);
1350     }
1351     /**
1352      * Finds a view that was identified by the {@code android:id} XML attribute
1353      * that was processed in {@link android.app.Activity#onCreate}, or throws an
1354      * IllegalArgumentException if the ID is invalid, or there is no matching view in the hierarchy.
1355      * <p>
1356      * <strong>Note:</strong> In most cases -- depending on compiler support --
1357      * the resulting view is automatically cast to the target class type. If
1358      * the target class type is unconstrained, an explicit cast may be
1359      * necessary.
1360      *
1361      * @param id the ID to search for
1362      * @return a view with given ID
1363      * @see View#requireViewById(int)
1364      * @see Window#findViewById(int)
1365      */
1366     @NonNull
requireViewById(@dRes int id)1367     public final <T extends View> T requireViewById(@IdRes int id) {
1368         T view = findViewById(id);
1369         if (view == null) {
1370             throw new IllegalArgumentException("ID does not reference a View inside this Window");
1371         }
1372         return view;
1373     }
1374 
1375     /**
1376      * Convenience for
1377      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1378      * to set the screen content from a layout resource.  The resource will be
1379      * inflated, adding all top-level views to the screen.
1380      *
1381      * @param layoutResID Resource ID to be inflated.
1382      * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
1383      */
setContentView(@ayoutRes int layoutResID)1384     public abstract void setContentView(@LayoutRes int layoutResID);
1385 
1386     /**
1387      * Convenience for
1388      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1389      * set the screen content to an explicit view.  This view is placed
1390      * directly into the screen's view hierarchy.  It can itself be a complex
1391      * view hierarhcy.
1392      *
1393      * @param view The desired content to display.
1394      * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
1395      */
setContentView(View view)1396     public abstract void setContentView(View view);
1397 
1398     /**
1399      * Set the screen content to an explicit view.  This view is placed
1400      * directly into the screen's view hierarchy.  It can itself be a complex
1401      * view hierarchy.
1402      *
1403      * <p>Note that calling this function "locks in" various characteristics
1404      * of the window that can not, from this point forward, be changed: the
1405      * features that have been requested with {@link #requestFeature(int)},
1406      * and certain window flags as described in {@link #setFlags(int, int)}.</p>
1407      *
1408      * <p>If {@link #FEATURE_CONTENT_TRANSITIONS} is set, the window's
1409      * TransitionManager will be used to animate content from the current
1410      * content View to view.</p>
1411      *
1412      * @param view The desired content to display.
1413      * @param params Layout parameters for the view.
1414      * @see #getTransitionManager()
1415      * @see #setTransitionManager(android.transition.TransitionManager)
1416      */
setContentView(View view, ViewGroup.LayoutParams params)1417     public abstract void setContentView(View view, ViewGroup.LayoutParams params);
1418 
1419     /**
1420      * Variation on
1421      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1422      * to add an additional content view to the screen.  Added after any existing
1423      * ones in the screen -- existing views are NOT removed.
1424      *
1425      * @param view The desired content to display.
1426      * @param params Layout parameters for the view.
1427      */
addContentView(View view, ViewGroup.LayoutParams params)1428     public abstract void addContentView(View view, ViewGroup.LayoutParams params);
1429 
1430     /**
1431      * Remove the view that was used as the screen content.
1432      *
1433      * @hide
1434      */
clearContentView()1435     public abstract void clearContentView();
1436 
1437     /**
1438      * Return the view in this Window that currently has focus, or null if
1439      * there are none.  Note that this does not look in any containing
1440      * Window.
1441      *
1442      * @return View The current View with focus or null.
1443      */
1444     @Nullable
getCurrentFocus()1445     public abstract View getCurrentFocus();
1446 
1447     /**
1448      * Quick access to the {@link LayoutInflater} instance that this Window
1449      * retrieved from its Context.
1450      *
1451      * @return LayoutInflater The shared LayoutInflater.
1452      */
1453     @NonNull
getLayoutInflater()1454     public abstract LayoutInflater getLayoutInflater();
1455 
setTitle(CharSequence title)1456     public abstract void setTitle(CharSequence title);
1457 
1458     @Deprecated
setTitleColor(@olorInt int textColor)1459     public abstract void setTitleColor(@ColorInt int textColor);
1460 
openPanel(int featureId, KeyEvent event)1461     public abstract void openPanel(int featureId, KeyEvent event);
1462 
closePanel(int featureId)1463     public abstract void closePanel(int featureId);
1464 
togglePanel(int featureId, KeyEvent event)1465     public abstract void togglePanel(int featureId, KeyEvent event);
1466 
invalidatePanelMenu(int featureId)1467     public abstract void invalidatePanelMenu(int featureId);
1468 
performPanelShortcut(int featureId, int keyCode, KeyEvent event, int flags)1469     public abstract boolean performPanelShortcut(int featureId,
1470                                                  int keyCode,
1471                                                  KeyEvent event,
1472                                                  int flags);
performPanelIdentifierAction(int featureId, int id, int flags)1473     public abstract boolean performPanelIdentifierAction(int featureId,
1474                                                  int id,
1475                                                  int flags);
1476 
closeAllPanels()1477     public abstract void closeAllPanels();
1478 
performContextMenuIdentifierAction(int id, int flags)1479     public abstract boolean performContextMenuIdentifierAction(int id, int flags);
1480 
1481     /**
1482      * Should be called when the configuration is changed.
1483      *
1484      * @param newConfig The new configuration.
1485      */
onConfigurationChanged(Configuration newConfig)1486     public abstract void onConfigurationChanged(Configuration newConfig);
1487 
1488     /**
1489      * Sets the window elevation.
1490      * <p>
1491      * Changes to this property take effect immediately and will cause the
1492      * window surface to be recreated. This is an expensive operation and as a
1493      * result, this property should not be animated.
1494      *
1495      * @param elevation The window elevation.
1496      * @see View#setElevation(float)
1497      * @see android.R.styleable#Window_windowElevation
1498      */
setElevation(float elevation)1499     public void setElevation(float elevation) {}
1500 
1501     /**
1502      * Gets the window elevation.
1503      *
1504      * @hide
1505      */
getElevation()1506     public float getElevation() {
1507         return 0.0f;
1508     }
1509 
1510     /**
1511      * Sets whether window content should be clipped to the outline of the
1512      * window background.
1513      *
1514      * @param clipToOutline Whether window content should be clipped to the
1515      *                      outline of the window background.
1516      * @see View#setClipToOutline(boolean)
1517      * @see android.R.styleable#Window_windowClipToOutline
1518      */
setClipToOutline(boolean clipToOutline)1519     public void setClipToOutline(boolean clipToOutline) {}
1520 
1521     /**
1522      * Change the background of this window to a Drawable resource. 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 resId The resource identifier of a drawable resource which will
1528      *              be installed as the new background.
1529      */
setBackgroundDrawableResource(@rawableRes int resId)1530     public void setBackgroundDrawableResource(@DrawableRes int resId) {
1531         setBackgroundDrawable(mContext.getDrawable(resId));
1532     }
1533 
1534     /**
1535      * Change the background of this window to a custom Drawable. Setting the
1536      * background to null will make the window be opaque. To make the window
1537      * transparent, you can use an empty drawable (for instance a ColorDrawable
1538      * with the color 0 or the system drawable android:drawable/empty.)
1539      *
1540      * @param drawable The new Drawable to use for this window's background.
1541      */
setBackgroundDrawable(Drawable drawable)1542     public abstract void setBackgroundDrawable(Drawable drawable);
1543 
1544     /**
1545      * Set the value for a drawable feature of this window, from a resource
1546      * identifier.  You must have called requestFeature(featureId) before
1547      * calling this function.
1548      *
1549      * @see android.content.res.Resources#getDrawable(int)
1550      *
1551      * @param featureId The desired drawable feature to change, defined as a
1552      * constant by Window.
1553      * @param resId Resource identifier of the desired image.
1554      */
setFeatureDrawableResource(int featureId, @DrawableRes int resId)1555     public abstract void setFeatureDrawableResource(int featureId, @DrawableRes int resId);
1556 
1557     /**
1558      * Set the value for a drawable feature of this window, from a URI. You
1559      * must have called requestFeature(featureId) before calling this
1560      * function.
1561      *
1562      * <p>The only URI currently supported is "content:", specifying an image
1563      * in a content provider.
1564      *
1565      * @see android.widget.ImageView#setImageURI
1566      *
1567      * @param featureId The desired drawable feature to change. Features are
1568      * constants defined by Window.
1569      * @param uri The desired URI.
1570      */
setFeatureDrawableUri(int featureId, Uri uri)1571     public abstract void setFeatureDrawableUri(int featureId, Uri uri);
1572 
1573     /**
1574      * Set an explicit Drawable value for feature of this window. You must
1575      * have called requestFeature(featureId) before calling this function.
1576      *
1577      * @param featureId The desired drawable feature to change. Features are
1578      *                  constants defined by Window.
1579      * @param drawable A Drawable object to display.
1580      */
setFeatureDrawable(int featureId, Drawable drawable)1581     public abstract void setFeatureDrawable(int featureId, Drawable drawable);
1582 
1583     /**
1584      * Set a custom alpha value for the given drawable feature, controlling how
1585      * much the background is visible through it.
1586      *
1587      * @param featureId The desired drawable feature to change. Features are
1588      *                  constants defined by Window.
1589      * @param alpha The alpha amount, 0 is completely transparent and 255 is
1590      *              completely opaque.
1591      */
setFeatureDrawableAlpha(int featureId, int alpha)1592     public abstract void setFeatureDrawableAlpha(int featureId, int alpha);
1593 
1594     /**
1595      * Set the integer value for a feature. The range of the value depends on
1596      * the feature being set. For {@link #FEATURE_PROGRESS}, it should go from
1597      * 0 to 10000. At 10000 the progress is complete and the indicator hidden.
1598      *
1599      * @param featureId The desired feature to change. Features are constants
1600      *                  defined by Window.
1601      * @param value The value for the feature. The interpretation of this
1602      *              value is feature-specific.
1603      */
setFeatureInt(int featureId, int value)1604     public abstract void setFeatureInt(int featureId, int value);
1605 
1606     /**
1607      * Request that key events come to this activity. Use this if your
1608      * activity has no views with focus, but the activity still wants
1609      * a chance to process key events.
1610      */
takeKeyEvents(boolean get)1611     public abstract void takeKeyEvents(boolean get);
1612 
1613     /**
1614      * Used by custom windows, such as Dialog, to pass the key press event
1615      * further down the view hierarchy. Application developers should
1616      * not need to implement or call this.
1617      *
1618      */
superDispatchKeyEvent(KeyEvent event)1619     public abstract boolean superDispatchKeyEvent(KeyEvent event);
1620 
1621     /**
1622      * Used by custom windows, such as Dialog, to pass the key shortcut press event
1623      * further down the view hierarchy. Application developers should
1624      * not need to implement or call this.
1625      *
1626      */
superDispatchKeyShortcutEvent(KeyEvent event)1627     public abstract boolean superDispatchKeyShortcutEvent(KeyEvent event);
1628 
1629     /**
1630      * Used by custom windows, such as Dialog, to pass the touch screen event
1631      * further down the view hierarchy. Application developers should
1632      * not need to implement or call this.
1633      *
1634      */
superDispatchTouchEvent(MotionEvent event)1635     public abstract boolean superDispatchTouchEvent(MotionEvent event);
1636 
1637     /**
1638      * Used by custom windows, such as Dialog, to pass the trackball event
1639      * further down the view hierarchy. Application developers should
1640      * not need to implement or call this.
1641      *
1642      */
superDispatchTrackballEvent(MotionEvent event)1643     public abstract boolean superDispatchTrackballEvent(MotionEvent event);
1644 
1645     /**
1646      * Used by custom windows, such as Dialog, to pass the generic motion event
1647      * further down the view hierarchy. Application developers should
1648      * not need to implement or call this.
1649      *
1650      */
superDispatchGenericMotionEvent(MotionEvent event)1651     public abstract boolean superDispatchGenericMotionEvent(MotionEvent event);
1652 
1653     /**
1654      * Retrieve the top-level window decor view (containing the standard
1655      * window frame/decorations and the client's content inside of that), which
1656      * can be added as a window to the window manager.
1657      *
1658      * <p><em>Note that calling this function for the first time "locks in"
1659      * various window characteristics as described in
1660      * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}.</em></p>
1661      *
1662      * @return Returns the top-level window decor view.
1663      */
getDecorView()1664     public abstract View getDecorView();
1665 
1666     /**
1667      * Retrieve the current decor view, but only if it has already been created;
1668      * otherwise returns null.
1669      *
1670      * @return Returns the top-level window decor or null.
1671      * @see #getDecorView
1672      */
peekDecorView()1673     public abstract View peekDecorView();
1674 
saveHierarchyState()1675     public abstract Bundle saveHierarchyState();
1676 
restoreHierarchyState(Bundle savedInstanceState)1677     public abstract void restoreHierarchyState(Bundle savedInstanceState);
1678 
onActive()1679     protected abstract void onActive();
1680 
1681     /**
1682      * Return the feature bits that are enabled.  This is the set of features
1683      * that were given to requestFeature(), and are being handled by this
1684      * Window itself or its container.  That is, it is the set of
1685      * requested features that you can actually use.
1686      *
1687      * <p>To do: add a public version of this API that allows you to check for
1688      * features by their feature ID.
1689      *
1690      * @return int The feature bits.
1691      */
getFeatures()1692     protected final int getFeatures()
1693     {
1694         return mFeatures;
1695     }
1696 
1697     /**
1698      * Return the feature bits set by default on a window.
1699      * @param context The context used to access resources
1700      */
getDefaultFeatures(Context context)1701     public static int getDefaultFeatures(Context context) {
1702         int features = 0;
1703 
1704         final Resources res = context.getResources();
1705         if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureOptionsPanel)) {
1706             features |= 1 << FEATURE_OPTIONS_PANEL;
1707         }
1708 
1709         if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureContextMenu)) {
1710             features |= 1 << FEATURE_CONTEXT_MENU;
1711         }
1712 
1713         return features;
1714     }
1715 
1716     /**
1717      * Query for the availability of a certain feature.
1718      *
1719      * @param feature The feature ID to check
1720      * @return true if the feature is enabled, false otherwise.
1721      */
hasFeature(int feature)1722     public boolean hasFeature(int feature) {
1723         return (getFeatures() & (1 << feature)) != 0;
1724     }
1725 
1726     /**
1727      * Return the feature bits that are being implemented by this Window.
1728      * This is the set of features that were given to requestFeature(), and are
1729      * being handled by only this Window itself, not by its containers.
1730      *
1731      * @return int The feature bits.
1732      */
getLocalFeatures()1733     protected final int getLocalFeatures()
1734     {
1735         return mLocalFeatures;
1736     }
1737 
1738     /**
1739      * Set the default format of window, as per the PixelFormat types.  This
1740      * is the format that will be used unless the client specifies in explicit
1741      * format with setFormat();
1742      *
1743      * @param format The new window format (see PixelFormat).
1744      *
1745      * @see #setFormat
1746      * @see PixelFormat
1747      */
setDefaultWindowFormat(int format)1748     protected void setDefaultWindowFormat(int format) {
1749         mDefaultWindowFormat = format;
1750         if (!mHaveWindowFormat) {
1751             final WindowManager.LayoutParams attrs = getAttributes();
1752             attrs.format = format;
1753             dispatchWindowAttributesChanged(attrs);
1754         }
1755     }
1756 
1757     /** @hide */
haveDimAmount()1758     protected boolean haveDimAmount() {
1759         return mHaveDimAmount;
1760     }
1761 
setChildDrawable(int featureId, Drawable drawable)1762     public abstract void setChildDrawable(int featureId, Drawable drawable);
1763 
setChildInt(int featureId, int value)1764     public abstract void setChildInt(int featureId, int value);
1765 
1766     /**
1767      * Is a keypress one of the defined shortcut keys for this window.
1768      * @param keyCode the key code from {@link android.view.KeyEvent} to check.
1769      * @param event the {@link android.view.KeyEvent} to use to help check.
1770      */
isShortcutKey(int keyCode, KeyEvent event)1771     public abstract boolean isShortcutKey(int keyCode, KeyEvent event);
1772 
1773     /**
1774      * @see android.app.Activity#setVolumeControlStream(int)
1775      */
setVolumeControlStream(int streamType)1776     public abstract void setVolumeControlStream(int streamType);
1777 
1778     /**
1779      * @see android.app.Activity#getVolumeControlStream()
1780      */
getVolumeControlStream()1781     public abstract int getVolumeControlStream();
1782 
1783     /**
1784      * Sets a {@link MediaController} to send media keys and volume changes to.
1785      * If set, this should be preferred for all media keys and volume requests
1786      * sent to this window.
1787      *
1788      * @param controller The controller for the session which should receive
1789      *            media keys and volume changes.
1790      * @see android.app.Activity#setMediaController(android.media.session.MediaController)
1791      */
setMediaController(MediaController controller)1792     public void setMediaController(MediaController controller) {
1793     }
1794 
1795     /**
1796      * Gets the {@link MediaController} that was previously set.
1797      *
1798      * @return The controller which should receive events.
1799      * @see #setMediaController(android.media.session.MediaController)
1800      * @see android.app.Activity#getMediaController()
1801      */
getMediaController()1802     public MediaController getMediaController() {
1803         return null;
1804     }
1805 
1806     /**
1807      * Set extra options that will influence the UI for this window.
1808      * @param uiOptions Flags specifying extra options for this window.
1809      */
setUiOptions(int uiOptions)1810     public void setUiOptions(int uiOptions) { }
1811 
1812     /**
1813      * Set extra options that will influence the UI for this window.
1814      * Only the bits filtered by mask will be modified.
1815      * @param uiOptions Flags specifying extra options for this window.
1816      * @param mask Flags specifying which options should be modified. Others will remain unchanged.
1817      */
setUiOptions(int uiOptions, int mask)1818     public void setUiOptions(int uiOptions, int mask) { }
1819 
1820     /**
1821      * Set the primary icon for this window.
1822      *
1823      * @param resId resource ID of a drawable to set
1824      */
setIcon(@rawableRes int resId)1825     public void setIcon(@DrawableRes int resId) { }
1826 
1827     /**
1828      * Set the default icon for this window.
1829      * This will be overridden by any other icon set operation which could come from the
1830      * theme or another explicit set.
1831      *
1832      * @hide
1833      */
setDefaultIcon(@rawableRes int resId)1834     public void setDefaultIcon(@DrawableRes int resId) { }
1835 
1836     /**
1837      * Set the logo for this window. A logo is often shown in place of an
1838      * {@link #setIcon(int) icon} but is generally wider and communicates window title information
1839      * as well.
1840      *
1841      * @param resId resource ID of a drawable to set
1842      */
setLogo(@rawableRes int resId)1843     public void setLogo(@DrawableRes int resId) { }
1844 
1845     /**
1846      * Set the default logo for this window.
1847      * This will be overridden by any other logo set operation which could come from the
1848      * theme or another explicit set.
1849      *
1850      * @hide
1851      */
setDefaultLogo(@rawableRes int resId)1852     public void setDefaultLogo(@DrawableRes int resId) { }
1853 
1854     /**
1855      * Set focus locally. The window should have the
1856      * {@link WindowManager.LayoutParams#FLAG_LOCAL_FOCUS_MODE} flag set already.
1857      * @param hasFocus Whether this window has focus or not.
1858      * @param inTouchMode Whether this window is in touch mode or not.
1859      */
setLocalFocus(boolean hasFocus, boolean inTouchMode)1860     public void setLocalFocus(boolean hasFocus, boolean inTouchMode) { }
1861 
1862     /**
1863      * Inject an event to window locally.
1864      * @param event A key or touch event to inject to this window.
1865      */
injectInputEvent(InputEvent event)1866     public void injectInputEvent(InputEvent event) { }
1867 
1868     /**
1869      * Retrieve the {@link TransitionManager} responsible for  for default transitions
1870      * in this window. Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1871      *
1872      * <p>This method will return non-null after content has been initialized (e.g. by using
1873      * {@link #setContentView}) if {@link #FEATURE_CONTENT_TRANSITIONS} has been granted.</p>
1874      *
1875      * @return This window's content TransitionManager or null if none is set.
1876      * @attr ref android.R.styleable#Window_windowContentTransitionManager
1877      */
getTransitionManager()1878     public TransitionManager getTransitionManager() {
1879         return null;
1880     }
1881 
1882     /**
1883      * Set the {@link TransitionManager} to use for default transitions in this window.
1884      * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1885      *
1886      * @param tm The TransitionManager to use for scene changes.
1887      * @attr ref android.R.styleable#Window_windowContentTransitionManager
1888      */
setTransitionManager(TransitionManager tm)1889     public void setTransitionManager(TransitionManager tm) {
1890         throw new UnsupportedOperationException();
1891     }
1892 
1893     /**
1894      * Retrieve the {@link Scene} representing this window's current content.
1895      * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1896      *
1897      * <p>This method will return null if the current content is not represented by a Scene.</p>
1898      *
1899      * @return Current Scene being shown or null
1900      */
getContentScene()1901     public Scene getContentScene() {
1902         return null;
1903     }
1904 
1905     /**
1906      * Sets the Transition that will be used to move Views into the initial scene. The entering
1907      * Views will be those that are regular Views or ViewGroups that have
1908      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1909      * {@link android.transition.Visibility} as entering is governed by changing visibility from
1910      * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
1911      * entering Views will remain unaffected.
1912      *
1913      * @param transition The Transition to use to move Views into the initial Scene.
1914      * @attr ref android.R.styleable#Window_windowEnterTransition
1915      */
setEnterTransition(Transition transition)1916     public void setEnterTransition(Transition transition) {}
1917 
1918     /**
1919      * Sets the Transition that will be used to move Views out of the scene when the Window is
1920      * preparing to close, for example after a call to
1921      * {@link android.app.Activity#finishAfterTransition()}. The exiting
1922      * Views will be those that are regular Views or ViewGroups that have
1923      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1924      * {@link android.transition.Visibility} as entering is governed by changing visibility from
1925      * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null,
1926      * entering Views will remain unaffected. If nothing is set, the default will be to
1927      * use the same value as set in {@link #setEnterTransition(android.transition.Transition)}.
1928      *
1929      * @param transition The Transition to use to move Views out of the Scene when the Window
1930      *                   is preparing to close.
1931      * @attr ref android.R.styleable#Window_windowReturnTransition
1932      */
setReturnTransition(Transition transition)1933     public void setReturnTransition(Transition transition) {}
1934 
1935     /**
1936      * Sets the Transition that will be used to move Views out of the scene when starting a
1937      * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
1938      * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1939      * {@link android.transition.Visibility} as exiting is governed by changing visibility
1940      * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
1941      * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
1942      *
1943      * @param transition The Transition to use to move Views out of the scene when calling a
1944      *                   new Activity.
1945      * @attr ref android.R.styleable#Window_windowExitTransition
1946      */
setExitTransition(Transition transition)1947     public void setExitTransition(Transition transition) {}
1948 
1949     /**
1950      * Sets the Transition that will be used to move Views in to the scene when returning from
1951      * a previously-started Activity. The entering Views will be those that are regular Views
1952      * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
1953      * will extend {@link android.transition.Visibility} as exiting is governed by changing
1954      * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null,
1955      * the views will remain unaffected. If nothing is set, the default will be to use the same
1956      * transition as {@link #setExitTransition(android.transition.Transition)}.
1957      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
1958      *
1959      * @param transition The Transition to use to move Views into the scene when reentering from a
1960      *                   previously-started Activity.
1961      * @attr ref android.R.styleable#Window_windowReenterTransition
1962      */
setReenterTransition(Transition transition)1963     public void setReenterTransition(Transition transition) {}
1964 
1965     /**
1966      * Returns the transition used to move Views into the initial scene. The entering
1967      * Views will be those that are regular Views or ViewGroups that have
1968      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1969      * {@link android.transition.Visibility} as entering is governed by changing visibility from
1970      * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
1971      * entering Views will remain unaffected.  Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
1972      *
1973      * @return the Transition to use to move Views into the initial Scene.
1974      * @attr ref android.R.styleable#Window_windowEnterTransition
1975      */
getEnterTransition()1976     public Transition getEnterTransition() { return null; }
1977 
1978     /**
1979      * Returns the Transition that will be used to move Views out of the scene when the Window is
1980      * preparing to close, for example after a call to
1981      * {@link android.app.Activity#finishAfterTransition()}. The exiting
1982      * Views will be those that are regular Views or ViewGroups that have
1983      * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1984      * {@link android.transition.Visibility} as entering is governed by changing visibility from
1985      * {@link View#VISIBLE} to {@link View#INVISIBLE}.
1986      *
1987      * @return The Transition to use to move Views out of the Scene when the Window
1988      *         is preparing to close.
1989      * @attr ref android.R.styleable#Window_windowReturnTransition
1990      */
getReturnTransition()1991     public Transition getReturnTransition() { return null; }
1992 
1993     /**
1994      * Returns the Transition that will be used to move Views out of the scene when starting a
1995      * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
1996      * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1997      * {@link android.transition.Visibility} as exiting is governed by changing visibility
1998      * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
1999      * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2000      *
2001      * @return the Transition to use to move Views out of the scene when calling a
2002      * new Activity.
2003      * @attr ref android.R.styleable#Window_windowExitTransition
2004      */
getExitTransition()2005     public Transition getExitTransition() { return null; }
2006 
2007     /**
2008      * Returns the Transition that will be used to move Views in to the scene when returning from
2009      * a previously-started Activity. The entering Views will be those that are regular Views
2010      * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
2011      * will extend {@link android.transition.Visibility} as exiting is governed by changing
2012      * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}.
2013      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2014      *
2015      * @return The Transition to use to move Views into the scene when reentering from a
2016      *         previously-started Activity.
2017      * @attr ref android.R.styleable#Window_windowReenterTransition
2018      */
getReenterTransition()2019     public Transition getReenterTransition() { return null; }
2020 
2021     /**
2022      * Sets the Transition that will be used for shared elements transferred into the content
2023      * Scene. 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      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2027      *
2028      * @param transition The Transition to use for shared elements transferred into the content
2029      *                   Scene.
2030      * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
2031      */
setSharedElementEnterTransition(Transition transition)2032     public void setSharedElementEnterTransition(Transition transition) {}
2033 
2034     /**
2035      * Sets the Transition that will be used for shared elements transferred back to a
2036      * calling Activity. Typical Transitions will affect size and location, such as
2037      * {@link android.transition.ChangeBounds}. A null
2038      * value will cause transferred shared elements to blink to the final position.
2039      * If no value is set, the default will be to use the same value as
2040      * {@link #setSharedElementEnterTransition(android.transition.Transition)}.
2041      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2042      *
2043      * @param transition The Transition to use for shared elements transferred out of the content
2044      *                   Scene.
2045      * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
2046      */
setSharedElementReturnTransition(Transition transition)2047     public void setSharedElementReturnTransition(Transition transition) {}
2048 
2049     /**
2050      * Returns the Transition that will be used for shared elements transferred into the content
2051      * Scene. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2052      *
2053      * @return Transition to use for sharend elements transferred into the content Scene.
2054      * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
2055      */
getSharedElementEnterTransition()2056     public Transition getSharedElementEnterTransition() { return null; }
2057 
2058     /**
2059      * Returns the Transition that will be used for shared elements transferred back to a
2060      * calling Activity. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2061      *
2062      * @return Transition to use for sharend elements transferred into the content Scene.
2063      * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
2064      */
getSharedElementReturnTransition()2065     public Transition getSharedElementReturnTransition() { return null; }
2066 
2067     /**
2068      * Sets the Transition that will be used for shared elements after starting a new Activity
2069      * before the shared elements are transferred to the called Activity. If the shared elements
2070      * must animate during the exit transition, this Transition should be used. Upon completion,
2071      * the shared elements may be transferred to the started Activity.
2072      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2073      *
2074      * @param transition The Transition to use for shared elements in the launching Window
2075      *                   prior to transferring to the launched Activity's Window.
2076      * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
2077      */
setSharedElementExitTransition(Transition transition)2078     public void setSharedElementExitTransition(Transition transition) {}
2079 
2080     /**
2081      * Sets the Transition that will be used for shared elements reentering from a started
2082      * Activity after it has returned the shared element to it start location. If no value
2083      * is set, this will default to
2084      * {@link #setSharedElementExitTransition(android.transition.Transition)}.
2085      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2086      *
2087      * @param transition The Transition to use for shared elements in the launching Window
2088      *                   after the shared element has returned to the Window.
2089      * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
2090      */
setSharedElementReenterTransition(Transition transition)2091     public void setSharedElementReenterTransition(Transition transition) {}
2092 
2093     /**
2094      * Returns the Transition to use for shared elements in the launching Window prior
2095      * to transferring to the launched Activity's Window.
2096      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2097      *
2098      * @return the Transition to use for shared elements in the launching Window prior
2099      * to transferring to the launched Activity's Window.
2100      * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
2101      */
getSharedElementExitTransition()2102     public Transition getSharedElementExitTransition() { return null; }
2103 
2104     /**
2105      * Returns the Transition that will be used for shared elements reentering from a started
2106      * Activity after it has returned the shared element to it start location.
2107      * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
2108      *
2109      * @return the Transition that will be used for shared elements reentering from a started
2110      * Activity after it has returned the shared element to it start location.
2111      * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
2112      */
getSharedElementReenterTransition()2113     public Transition getSharedElementReenterTransition() { return null; }
2114 
2115     /**
2116      * Controls 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      * @param allow true to start the enter transition when possible or false to
2123      *              wait until the exiting transition completes.
2124      * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
2125      */
setAllowEnterTransitionOverlap(boolean allow)2126     public void setAllowEnterTransitionOverlap(boolean allow) {}
2127 
2128     /**
2129      * Returns how the transition set in
2130      * {@link #setEnterTransition(android.transition.Transition)} overlaps with the exit
2131      * transition of the calling Activity. When true, the transition will start as soon as possible.
2132      * When false, the transition will wait until the remote exiting transition completes before
2133      * starting. The default value is true.
2134      *
2135      * @return true when the enter transition should start as soon as possible or false to
2136      * when it should wait until the exiting transition completes.
2137      * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
2138      */
getAllowEnterTransitionOverlap()2139     public boolean getAllowEnterTransitionOverlap() { return true; }
2140 
2141     /**
2142      * Controls how the transition set in
2143      * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
2144      * transition of the called Activity when reentering after if finishes. When true,
2145      * the transition will start as soon as possible. When false, the transition will wait
2146      * until the called Activity's exiting transition completes before starting.
2147      * The default value is true.
2148      *
2149      * @param allow true to start the transition when possible or false to wait until the
2150      *              called Activity's exiting transition completes.
2151      * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
2152      */
setAllowReturnTransitionOverlap(boolean allow)2153     public void setAllowReturnTransitionOverlap(boolean allow) {}
2154 
2155     /**
2156      * Returns how the transition set in
2157      * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
2158      * transition of the called Activity when reentering after if finishes. When true,
2159      * the transition will start as soon as possible. When false, the transition will wait
2160      * until the called Activity's exiting transition completes before starting.
2161      * The default value is true.
2162      *
2163      * @return true when the transition should start when possible or false when it should wait
2164      * until the called Activity's exiting transition completes.
2165      * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
2166      */
getAllowReturnTransitionOverlap()2167     public boolean getAllowReturnTransitionOverlap() { return true; }
2168 
2169     /**
2170      * Returns 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      * @return The duration of the window background fade to opaque during enter transition.
2177      * @see #getEnterTransition()
2178      * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
2179      */
getTransitionBackgroundFadeDuration()2180     public long getTransitionBackgroundFadeDuration() { return 0; }
2181 
2182     /**
2183      * Sets the duration, in milliseconds, of the window background fade
2184      * when transitioning into or away from an Activity when called with an Activity Transition.
2185      * <p>When executing the enter transition, the background starts transparent
2186      * and fades in. This requires {@link #FEATURE_ACTIVITY_TRANSITIONS}. The default is
2187      * 300 milliseconds.</p>
2188      *
2189      * @param fadeDurationMillis The duration of the window background fade to or from opaque
2190      *                           during enter transition.
2191      * @see #setEnterTransition(android.transition.Transition)
2192      * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
2193      */
setTransitionBackgroundFadeDuration(long fadeDurationMillis)2194     public void setTransitionBackgroundFadeDuration(long fadeDurationMillis) { }
2195 
2196     /**
2197      * Returns <code>true</code> when shared elements should use an Overlay during
2198      * shared element transitions or <code>false</code> when they should animate as
2199      * part of the normal View hierarchy. The default value is true.
2200      *
2201      * @return <code>true</code> when shared elements should use an Overlay during
2202      * shared element transitions or <code>false</code> when they should animate as
2203      * part of the normal View hierarchy.
2204      * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
2205      */
getSharedElementsUseOverlay()2206     public boolean getSharedElementsUseOverlay() { return true; }
2207 
2208     /**
2209      * Sets whether or not shared elements should use an Overlay during shared element transitions.
2210      * The default value is true.
2211      *
2212      * @param sharedElementsUseOverlay <code>true</code> indicates that shared elements should
2213      *                                 be transitioned with an Overlay or <code>false</code>
2214      *                                 to transition within the normal View hierarchy.
2215      * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
2216      */
setSharedElementsUseOverlay(boolean sharedElementsUseOverlay)2217     public void setSharedElementsUseOverlay(boolean sharedElementsUseOverlay) { }
2218 
2219     /**
2220      * @return the color of the status bar.
2221      */
2222     @ColorInt
getStatusBarColor()2223     public abstract int getStatusBarColor();
2224 
2225     /**
2226      * Sets the color of the status bar to {@code color}.
2227      *
2228      * For this to take effect,
2229      * the window must be drawing the system bar backgrounds with
2230      * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2231      * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_STATUS} must not be set.
2232      *
2233      * If {@code color} is not opaque, consider setting
2234      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
2235      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
2236      * <p>
2237      * The transitionName for the view background will be "android:status:background".
2238      * </p>
2239      */
setStatusBarColor(@olorInt int color)2240     public abstract void setStatusBarColor(@ColorInt int color);
2241 
2242     /**
2243      * @return the color of the navigation bar.
2244      */
2245     @ColorInt
getNavigationBarColor()2246     public abstract int getNavigationBarColor();
2247 
2248     /**
2249      * Sets the color of the navigation bar to {@param color}.
2250      *
2251      * For this to take effect,
2252      * the window must be drawing the system bar backgrounds with
2253      * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2254      * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_NAVIGATION} must not be set.
2255      *
2256      * If {@param color} is not opaque, consider setting
2257      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
2258      * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}.
2259      * <p>
2260      * The transitionName for the view background will be "android:navigation:background".
2261      * </p>
2262      * @attr ref android.R.styleable#Window_navigationBarColor
2263      */
setNavigationBarColor(@olorInt int color)2264     public abstract void setNavigationBarColor(@ColorInt int color);
2265 
2266     /**
2267      * Shows a thin line of the specified color between the navigation bar and the app
2268      * content.
2269      * <p>
2270      * For this to take effect,
2271      * the window must be drawing the system bar backgrounds with
2272      * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2273      * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_NAVIGATION} must not be set.
2274      *
2275      * @param dividerColor The color of the thin line.
2276      * @attr ref android.R.styleable#Window_navigationBarDividerColor
2277      */
setNavigationBarDividerColor(@olorInt int dividerColor)2278     public void setNavigationBarDividerColor(@ColorInt int dividerColor) {
2279     }
2280 
2281     /**
2282      * Retrieves the color of the navigation bar divider.
2283      *
2284      * @return The color of the navigation bar divider color.
2285      * @see #setNavigationBarColor(int)
2286      * @attr ref android.R.styleable#Window_navigationBarDividerColor
2287      */
getNavigationBarDividerColor()2288     public @ColorInt int getNavigationBarDividerColor() {
2289         return 0;
2290     }
2291 
2292     /** @hide */
setTheme(int resId)2293     public void setTheme(int resId) {
2294     }
2295 
2296     /**
2297      * Whether the caption should be displayed directly on the content rather than push the content
2298      * down. This affects only freeform windows since they display the caption.
2299      * @hide
2300      */
setOverlayWithDecorCaptionEnabled(boolean enabled)2301     public void setOverlayWithDecorCaptionEnabled(boolean enabled) {
2302         mOverlayWithDecorCaptionEnabled = enabled;
2303     }
2304 
2305     /** @hide */
isOverlayWithDecorCaptionEnabled()2306     public boolean isOverlayWithDecorCaptionEnabled() {
2307         return mOverlayWithDecorCaptionEnabled;
2308     }
2309 
2310     /** @hide */
notifyRestrictedCaptionAreaCallback(int left, int top, int right, int bottom)2311     public void notifyRestrictedCaptionAreaCallback(int left, int top, int right, int bottom) {
2312         if (mOnRestrictedCaptionAreaChangedListener != null) {
2313             mRestrictedCaptionAreaRect.set(left, top, right, bottom);
2314             mOnRestrictedCaptionAreaChangedListener.onRestrictedCaptionAreaChanged(
2315                     mRestrictedCaptionAreaRect);
2316         }
2317     }
2318 
2319     /**
2320      * Set what color should the caption controls be. By default the system will try to determine
2321      * the color from the theme. You can overwrite this by using {@link #DECOR_CAPTION_SHADE_DARK},
2322      * {@link #DECOR_CAPTION_SHADE_LIGHT}, or {@link #DECOR_CAPTION_SHADE_AUTO}.
2323      * @see #DECOR_CAPTION_SHADE_DARK
2324      * @see #DECOR_CAPTION_SHADE_LIGHT
2325      * @see #DECOR_CAPTION_SHADE_AUTO
2326      */
setDecorCaptionShade(int decorCaptionShade)2327     public abstract void setDecorCaptionShade(int decorCaptionShade);
2328 
2329     /**
2330      * Set the drawable that is drawn underneath the caption during the resizing.
2331      *
2332      * During the resizing the caption might not be drawn fast enough to match the new dimensions.
2333      * There is a second caption drawn underneath it that will be fast enough. By default the
2334      * caption is constructed from the theme. You can provide a drawable, that will be drawn instead
2335      * to better match your application.
2336      */
setResizingCaptionDrawable(Drawable drawable)2337     public abstract void setResizingCaptionDrawable(Drawable drawable);
2338 
2339     /**
2340      * Called when the activity changes from fullscreen mode to multi-window mode and visa-versa.
2341      * @hide
2342      */
onMultiWindowModeChanged()2343     public abstract void onMultiWindowModeChanged();
2344 
2345     /**
2346      * Called when the activity changes to/from picture-in-picture mode.
2347      * @hide
2348      */
onPictureInPictureModeChanged(boolean isInPictureInPictureMode)2349     public abstract void onPictureInPictureModeChanged(boolean isInPictureInPictureMode);
2350 
2351     /**
2352      * Called when the activity just relaunched.
2353      * @hide
2354      */
reportActivityRelaunched()2355     public abstract void reportActivityRelaunched();
2356 
2357     /**
2358      * Called to set flag to check if the close on swipe is enabled. This will only function if
2359      * FEATURE_SWIPE_TO_DISMISS has been set.
2360      * @hide
2361      */
setCloseOnSwipeEnabled(boolean closeOnSwipeEnabled)2362     public void setCloseOnSwipeEnabled(boolean closeOnSwipeEnabled) {
2363         mCloseOnSwipeEnabled = closeOnSwipeEnabled;
2364     }
2365 
2366     /**
2367      * @return {@code true} if the close on swipe is enabled.
2368      * @hide
2369      */
isCloseOnSwipeEnabled()2370     public boolean isCloseOnSwipeEnabled() {
2371         return mCloseOnSwipeEnabled;
2372     }
2373 }
2374