blob: b9f9e5e89ca8223569429de766ddc2e54971e005 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.view;
18
Aurimas Liutikas67e2ae82016-10-11 18:17:42 -070019import static android.view.WindowManager.LayoutParams.FLAG_HARDWARE_ACCELERATED;
20
Tor Norbye80756e32015-03-02 09:39:27 -080021import android.annotation.ColorInt;
Tor Norbye7b9c9122013-05-30 16:48:33 -070022import android.annotation.DrawableRes;
23import android.annotation.IdRes;
24import android.annotation.LayoutRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070025import android.annotation.NonNull;
26import android.annotation.Nullable;
Tor Norbye417ee5b2015-03-10 20:57:37 -070027import android.annotation.StyleRes;
Wale Ogunwale3382ab12017-07-27 08:55:03 -070028import android.app.WindowConfiguration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080029import android.content.Context;
Romain Guy48327452017-01-23 17:03:35 -080030import android.content.pm.ActivityInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080031import android.content.res.Configuration;
Bryce Leed6e6e722014-11-21 11:08:45 -080032import android.content.res.Resources;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080033import android.content.res.TypedArray;
Skuhnece2faa52015-08-11 10:36:38 -070034import android.graphics.PixelFormat;
Filip Gruszczynski3dec0812015-12-09 08:42:41 -080035import android.graphics.Rect;
Filip Gruszczynski14418da2015-10-04 16:43:48 -070036import android.graphics.drawable.Drawable;
RoboErik55011652014-07-09 15:05:53 -070037import android.media.session.MediaController;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080038import android.net.Uri;
39import android.os.Bundle;
Andres Morales910beb82016-02-02 16:19:40 -080040import android.os.Handler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041import android.os.IBinder;
Wale Ogunwale868a5e12015-08-02 16:19:20 -070042import android.os.RemoteException;
Adam Powellcfbe9be2013-11-06 14:58:58 -080043import android.transition.Scene;
George Mounte1803372014-02-26 19:00:52 +000044import android.transition.Transition;
Adam Powellcfbe9be2013-11-06 14:58:58 -080045import android.transition.TransitionManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070046import android.view.accessibility.AccessibilityEvent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080047
Clara Bayarri75e09792015-07-29 16:20:40 +010048import java.util.List;
49
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050/**
51 * Abstract base class for a top-level window look and behavior policy. An
52 * instance of this class should be used as the top-level view added to the
53 * window manager. It provides standard UI policies such as a background, title
54 * area, default key processing, etc.
55 *
56 * <p>The only existing implementation of this abstract class is
Jorim Jaggib10e33f2015-02-04 21:57:40 +010057 * android.view.PhoneWindow, which you should instantiate when needing a
58 * Window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080059 */
60public abstract class Window {
61 /** Flag for the "options panel" feature. This is enabled by default. */
62 public static final int FEATURE_OPTIONS_PANEL = 0;
63 /** Flag for the "no title" feature, turning off the title at the top
64 * of the screen. */
65 public static final int FEATURE_NO_TITLE = 1;
Alan Viverette4aef7c82015-09-04 14:14:50 -040066
67 /**
68 * Flag for the progress indicator feature.
69 *
70 * @deprecated No longer supported starting in API 21.
71 */
72 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080073 public static final int FEATURE_PROGRESS = 2;
Alan Viverette4aef7c82015-09-04 14:14:50 -040074
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080075 /** Flag for having an icon on the left side of the title bar */
76 public static final int FEATURE_LEFT_ICON = 3;
77 /** Flag for having an icon on the right side of the title bar */
78 public static final int FEATURE_RIGHT_ICON = 4;
Alan Viverette4aef7c82015-09-04 14:14:50 -040079
80 /**
81 * Flag for indeterminate progress.
82 *
83 * @deprecated No longer supported starting in API 21.
84 */
85 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080086 public static final int FEATURE_INDETERMINATE_PROGRESS = 5;
Alan Viverette4aef7c82015-09-04 14:14:50 -040087
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080088 /** Flag for the context menu. This is enabled by default. */
89 public static final int FEATURE_CONTEXT_MENU = 6;
90 /** Flag for custom title. You cannot combine this feature with other title features. */
91 public static final int FEATURE_CUSTOM_TITLE = 7;
Adam Powell33b97432010-04-20 10:01:14 -070092 /**
93 * Flag for enabling the Action Bar.
94 * This is enabled by default for some devices. The Action Bar
95 * replaces the title bar and provides an alternate location
96 * for an on-screen menu button on some devices.
97 */
Adam Powell5d279772010-07-27 16:34:07 -070098 public static final int FEATURE_ACTION_BAR = 8;
99 /**
Adam Powell6b336f82010-08-10 20:13:01 -0700100 * Flag for requesting an Action Bar that overlays window content.
101 * Normally an Action Bar will sit in the space above window content, but if this
102 * feature is requested along with {@link #FEATURE_ACTION_BAR} it will be layered over
103 * the window content itself. This is useful if you would like your app to have more control
104 * over how the Action Bar is displayed, such as letting application content scroll beneath
105 * an Action Bar with a transparent background or otherwise displaying a transparent/translucent
106 * Action Bar over application content.
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -0700107 *
108 * <p>This mode is especially useful with {@link View#SYSTEM_UI_FLAG_FULLSCREEN
109 * View.SYSTEM_UI_FLAG_FULLSCREEN}, which allows you to seamlessly hide the
110 * action bar in conjunction with other screen decorations.
111 *
112 * <p>As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, when an
113 * ActionBar is in this mode it will adjust the insets provided to
114 * {@link View#fitSystemWindows(android.graphics.Rect) View.fitSystemWindows(Rect)}
115 * to include the content covered by the action bar, so you can do layout within
116 * that space.
Adam Powell6b336f82010-08-10 20:13:01 -0700117 */
118 public static final int FEATURE_ACTION_BAR_OVERLAY = 9;
119 /**
Adam Powell5d279772010-07-27 16:34:07 -0700120 * Flag for specifying the behavior of action modes when an Action Bar is not present.
121 * If overlay is enabled, the action mode UI will be allowed to cover existing window content.
122 */
Adam Powell6b336f82010-08-10 20:13:01 -0700123 public static final int FEATURE_ACTION_MODE_OVERLAY = 10;
Adam Powell18e905f2013-10-24 14:27:48 -0700124 /**
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800125 * Flag for requesting a decoration-free window that is dismissed by swiping from the left.
126 */
127 public static final int FEATURE_SWIPE_TO_DISMISS = 11;
Will Haldean Brown568628d2014-03-04 15:25:43 -0800128 /**
George Mountc3a043c2015-02-04 14:37:04 -0800129 * Flag for requesting that window content changes should be animated using a
130 * TransitionManager.
Adam Powell18e905f2013-10-24 14:27:48 -0700131 *
George Mountc3a043c2015-02-04 14:37:04 -0800132 * <p>The TransitionManager is set using
133 * {@link #setTransitionManager(android.transition.TransitionManager)}. If none is set,
134 * a default TransitionManager will be used.</p>
Adam Powell18e905f2013-10-24 14:27:48 -0700135 *
136 * @see #setContentView
137 */
Will Haldean Brown568628d2014-03-04 15:25:43 -0800138 public static final int FEATURE_CONTENT_TRANSITIONS = 12;
Adam Powell4b6d93f2012-09-18 18:34:08 -0700139
140 /**
George Mount9826f632014-09-11 08:50:09 -0700141 * Enables Activities to run Activity Transitions either through sending or receiving
142 * ActivityOptions bundle created with
143 * {@link android.app.ActivityOptions#makeSceneTransitionAnimation(android.app.Activity,
144 * android.util.Pair[])} or {@link android.app.ActivityOptions#makeSceneTransitionAnimation(
145 * android.app.Activity, View, String)}.
146 */
147 public static final int FEATURE_ACTIVITY_TRANSITIONS = 13;
148
149 /**
Adam Powell4b6d93f2012-09-18 18:34:08 -0700150 * Max value used as a feature ID
151 * @hide
152 */
George Mount9826f632014-09-11 08:50:09 -0700153 public static final int FEATURE_MAX = FEATURE_ACTIVITY_TRANSITIONS;
Adam Powell4b6d93f2012-09-18 18:34:08 -0700154
Alan Viverette4aef7c82015-09-04 14:14:50 -0400155 /**
156 * Flag for setting the progress bar's visibility to VISIBLE.
157 *
158 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
159 * supported starting in API 21.
160 */
161 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800162 public static final int PROGRESS_VISIBILITY_ON = -1;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400163
164 /**
165 * Flag for setting the progress bar's visibility to GONE.
166 *
167 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
168 * supported starting in API 21.
169 */
170 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800171 public static final int PROGRESS_VISIBILITY_OFF = -2;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400172
173 /**
174 * Flag for setting the progress bar's indeterminate mode on.
175 *
176 * @deprecated {@link #FEATURE_INDETERMINATE_PROGRESS} and related methods
177 * are no longer supported starting in API 21.
178 */
179 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800180 public static final int PROGRESS_INDETERMINATE_ON = -3;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400181
182 /**
183 * Flag for setting the progress bar's indeterminate mode off.
184 *
185 * @deprecated {@link #FEATURE_INDETERMINATE_PROGRESS} and related methods
186 * are no longer supported starting in API 21.
187 */
188 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800189 public static final int PROGRESS_INDETERMINATE_OFF = -4;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400190
191 /**
192 * Starting value for the (primary) progress.
193 *
194 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
195 * supported starting in API 21.
196 */
197 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800198 public static final int PROGRESS_START = 0;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400199
200 /**
201 * Ending value for the (primary) progress.
202 *
203 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
204 * supported starting in API 21.
205 */
206 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800207 public static final int PROGRESS_END = 10000;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400208
209 /**
210 * Lowest possible value for the secondary progress.
211 *
212 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
213 * supported starting in API 21.
214 */
215 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800216 public static final int PROGRESS_SECONDARY_START = 20000;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400217
218 /**
219 * Highest possible value for the secondary progress.
220 *
221 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
222 * supported starting in API 21.
223 */
224 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800225 public static final int PROGRESS_SECONDARY_END = 30000;
George Mount238010f2014-06-30 17:31:17 -0700226
227 /**
228 * The transitionName for the status bar background View when a custom background is used.
229 * @see android.view.Window#setStatusBarColor(int)
230 */
231 public static final String STATUS_BAR_BACKGROUND_TRANSITION_NAME = "android:status:background";
232
233 /**
234 * The transitionName for the navigation bar background View when a custom background is used.
235 * @see android.view.Window#setNavigationBarColor(int)
236 */
237 public static final String NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME =
238 "android:navigation:background";
239
Bryce Leeaa1008c2015-01-13 09:26:46 -0800240 /**
241 * The default features enabled.
242 * @deprecated use {@link #getDefaultFeatures(android.content.Context)} instead.
243 */
Bryce Leed6e6e722014-11-21 11:08:45 -0800244 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800245 @SuppressWarnings({"PointlessBitwiseExpression"})
246 protected static final int DEFAULT_FEATURES = (1 << FEATURE_OPTIONS_PANEL) |
247 (1 << FEATURE_CONTEXT_MENU);
248
249 /**
250 * The ID that the main layout in the XML layout file should have.
251 */
252 public static final int ID_ANDROID_CONTENT = com.android.internal.R.id.content;
253
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800254 /**
255 * Flag for letting the theme drive the color of the window caption controls. Use with
256 * {@link #setDecorCaptionShade(int)}. This is the default value.
257 */
258 public static final int DECOR_CAPTION_SHADE_AUTO = 0;
259 /**
260 * Flag for setting light-color controls on the window caption. Use with
261 * {@link #setDecorCaptionShade(int)}.
262 */
263 public static final int DECOR_CAPTION_SHADE_LIGHT = 1;
264 /**
265 * Flag for setting dark-color controls on the window caption. Use with
266 * {@link #setDecorCaptionShade(int)}.
267 */
268 public static final int DECOR_CAPTION_SHADE_DARK = 2;
269
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800270 private final Context mContext;
RoboErik55011652014-07-09 15:05:53 -0700271
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800272 private TypedArray mWindowStyle;
273 private Callback mCallback;
Adam Powell117b6952014-05-05 18:14:56 -0700274 private OnWindowDismissedCallback mOnWindowDismissedCallback;
Michael Kwan67639a52016-12-16 12:38:10 -0800275 private OnWindowSwipeDismissedCallback mOnWindowSwipeDismissedCallback;
Skuhnece2faa52015-08-11 10:36:38 -0700276 private WindowControllerCallback mWindowControllerCallback;
Wale Ogunwalea504ca32016-01-30 16:02:13 -0800277 private OnRestrictedCaptionAreaChangedListener mOnRestrictedCaptionAreaChangedListener;
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800278 private Rect mRestrictedCaptionAreaRect;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800279 private WindowManager mWindowManager;
280 private IBinder mAppToken;
281 private String mAppName;
Jeff Brownd32460c2012-07-20 16:15:36 -0700282 private boolean mHardwareAccelerated;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800283 private Window mContainer;
284 private Window mActiveChild;
285 private boolean mIsActive = false;
286 private boolean mHasChildren = false;
Dianne Hackborncfaf8872011-01-18 13:57:54 -0800287 private boolean mCloseOnTouchOutside = false;
288 private boolean mSetCloseOnTouchOutside = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800289 private int mForcedWindowFlags = 0;
290
Bryce Leed6e6e722014-11-21 11:08:45 -0800291 private int mFeatures;
292 private int mLocalFeatures;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800293
294 private boolean mHaveWindowFormat = false;
Dianne Hackborn661cd522011-08-22 00:26:20 -0700295 private boolean mHaveDimAmount = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800296 private int mDefaultWindowFormat = PixelFormat.OPAQUE;
297
298 private boolean mHasSoftInputMode = false;
RoboErik55011652014-07-09 15:05:53 -0700299
Dianne Hackborn291905e2010-08-17 15:17:15 -0700300 private boolean mDestroyed;
301
Andrii Kulian933076d2016-03-29 17:04:42 -0700302 private boolean mOverlayWithDecorCaptionEnabled = false;
Michael Kwanf7964be2016-11-30 16:44:33 -0800303 private boolean mCloseOnSwipeEnabled = false;
Filip Gruszczynski63250652015-11-18 14:43:01 -0800304
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800305 // The current window attributes.
306 private final WindowManager.LayoutParams mWindowAttributes =
307 new WindowManager.LayoutParams();
308
309 /**
310 * API from a Window back to its caller. This allows the client to
311 * intercept key dispatching, panels and menus, etc.
312 */
313 public interface Callback {
314 /**
315 * Called to process key events. At the very least your
316 * implementation must call
317 * {@link android.view.Window#superDispatchKeyEvent} to do the
318 * standard key processing.
319 *
320 * @param event The key event.
321 *
322 * @return boolean Return true if this event was consumed.
323 */
324 public boolean dispatchKeyEvent(KeyEvent event);
325
326 /**
Jeff Brown64da12a2011-01-04 19:57:47 -0800327 * Called to process a key shortcut event.
328 * At the very least your implementation must call
329 * {@link android.view.Window#superDispatchKeyShortcutEvent} to do the
330 * standard key shortcut processing.
331 *
332 * @param event The key shortcut event.
333 * @return True if this event was consumed.
334 */
335 public boolean dispatchKeyShortcutEvent(KeyEvent event);
336
337 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800338 * Called to process touch screen events. At the very least your
339 * implementation must call
340 * {@link android.view.Window#superDispatchTouchEvent} to do the
341 * standard touch screen processing.
342 *
343 * @param event The touch screen event.
344 *
345 * @return boolean Return true if this event was consumed.
346 */
347 public boolean dispatchTouchEvent(MotionEvent event);
RoboErik55011652014-07-09 15:05:53 -0700348
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800349 /**
350 * Called to process trackball events. At the very least your
351 * implementation must call
352 * {@link android.view.Window#superDispatchTrackballEvent} to do the
353 * standard trackball processing.
354 *
355 * @param event The trackball event.
356 *
357 * @return boolean Return true if this event was consumed.
358 */
359 public boolean dispatchTrackballEvent(MotionEvent event);
svetoslavganov75986cf2009-05-14 22:28:01 -0700360
361 /**
Jeff Browncb1404e2011-01-15 18:14:15 -0800362 * Called to process generic motion events. At the very least your
363 * implementation must call
364 * {@link android.view.Window#superDispatchGenericMotionEvent} to do the
365 * standard processing.
366 *
367 * @param event The generic motion event.
368 *
369 * @return boolean Return true if this event was consumed.
370 */
371 public boolean dispatchGenericMotionEvent(MotionEvent event);
372
373 /**
svetoslavganov75986cf2009-05-14 22:28:01 -0700374 * Called to process population of {@link AccessibilityEvent}s.
375 *
376 * @param event The event.
377 *
378 * @return boolean Return true if event population was completed.
379 */
380 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event);
381
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800382 /**
383 * Instantiate the view to display in the panel for 'featureId'.
384 * You can return null, in which case the default content (typically
385 * a menu) will be created for you.
386 *
387 * @param featureId Which panel is being created.
388 *
389 * @return view The top-level view to place in the panel.
390 *
391 * @see #onPreparePanel
392 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700393 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800394 public View onCreatePanelView(int featureId);
395
396 /**
397 * Initialize the contents of the menu for panel 'featureId'. This is
398 * called if onCreatePanelView() returns null, giving you a standard
399 * menu in which you can place your items. It is only called once for
400 * the panel, the first time it is shown.
401 *
402 * <p>You can safely hold on to <var>menu</var> (and any items created
403 * from it), making modifications to it as desired, until the next
404 * time onCreatePanelMenu() is called for this feature.
405 *
406 * @param featureId The panel being created.
407 * @param menu The menu inside the panel.
408 *
409 * @return boolean You must return true for the panel to be displayed;
410 * if you return false it will not be shown.
411 */
412 public boolean onCreatePanelMenu(int featureId, Menu menu);
413
414 /**
415 * Prepare a panel to be displayed. This is called right before the
416 * panel window is shown, every time it is shown.
417 *
418 * @param featureId The panel that is being displayed.
419 * @param view The View that was returned by onCreatePanelView().
420 * @param menu If onCreatePanelView() returned null, this is the Menu
421 * being displayed in the panel.
422 *
423 * @return boolean You must return true for the panel to be displayed;
424 * if you return false it will not be shown.
425 *
426 * @see #onCreatePanelView
427 */
428 public boolean onPreparePanel(int featureId, View view, Menu menu);
429
430 /**
431 * Called when a panel's menu is opened by the user. This may also be
432 * called when the menu is changing from one type to another (for
433 * example, from the icon menu to the expanded menu).
RoboErik55011652014-07-09 15:05:53 -0700434 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800435 * @param featureId The panel that the menu is in.
436 * @param menu The menu that is opened.
437 * @return Return true to allow the menu to open, or false to prevent
438 * the menu from opening.
439 */
440 public boolean onMenuOpened(int featureId, Menu menu);
RoboErik55011652014-07-09 15:05:53 -0700441
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800442 /**
443 * Called when a panel's menu item has been selected by the user.
444 *
445 * @param featureId The panel that the menu is in.
446 * @param item The menu item that was selected.
447 *
448 * @return boolean Return true to finish processing of selection, or
449 * false to perform the normal menu handling (calling its
450 * Runnable or sending a Message to its target Handler).
451 */
452 public boolean onMenuItemSelected(int featureId, MenuItem item);
453
454 /**
455 * This is called whenever the current window attributes change.
456 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800457 */
458 public void onWindowAttributesChanged(WindowManager.LayoutParams attrs);
459
460 /**
461 * This hook is called whenever the content view of the screen changes
462 * (due to a call to
463 * {@link Window#setContentView(View, android.view.ViewGroup.LayoutParams)
464 * Window.setContentView} or
465 * {@link Window#addContentView(View, android.view.ViewGroup.LayoutParams)
466 * Window.addContentView}).
467 */
468 public void onContentChanged();
469
470 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700471 * This hook is called whenever the window focus changes. See
472 * {@link View#onWindowFocusChanged(boolean)
Svetoslav3a0d8782014-12-04 12:50:11 -0800473 * View.onWindowFocusChangedNotLocked(boolean)} for more information.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800474 *
475 * @param hasFocus Whether the window now has focus.
476 */
477 public void onWindowFocusChanged(boolean hasFocus);
478
479 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700480 * Called when the window has been attached to the window manager.
481 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
482 * for more information.
483 */
484 public void onAttachedToWindow();
RoboErik55011652014-07-09 15:05:53 -0700485
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700486 /**
Chet Haasee7bf2192017-08-18 15:24:56 -0700487 * Called when the window has been detached from the window manager.
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700488 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
489 * for more information.
490 */
491 public void onDetachedFromWindow();
RoboErik55011652014-07-09 15:05:53 -0700492
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700493 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800494 * Called when a panel is being closed. If another logical subsequent
495 * panel is being opened (and this panel is being closed to make room for the subsequent
496 * panel), this method will NOT be called.
RoboErik55011652014-07-09 15:05:53 -0700497 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800498 * @param featureId The panel that is being displayed.
499 * @param menu If onCreatePanelView() returned null, this is the Menu
500 * being displayed in the panel.
501 */
502 public void onPanelClosed(int featureId, Menu menu);
RoboErik55011652014-07-09 15:05:53 -0700503
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800504 /**
505 * Called when the user signals the desire to start a search.
RoboErik55011652014-07-09 15:05:53 -0700506 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 * @return true if search launched, false if activity refuses (blocks)
RoboErik55011652014-07-09 15:05:53 -0700508 *
509 * @see android.app.Activity#onSearchRequested()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800510 */
511 public boolean onSearchRequested();
Adam Powell6e346362010-07-23 10:18:23 -0700512
513 /**
Tim Kilbourn6a975b32015-04-09 17:14:34 -0700514 * Called when the user signals the desire to start a search.
515 *
516 * @param searchEvent A {@link SearchEvent} describing the signal to
517 * start a search.
518 * @return true if search launched, false if activity refuses (blocks)
519 */
520 public boolean onSearchRequested(SearchEvent searchEvent);
521
522 /**
Adam Powelldebf3be2010-11-15 18:58:48 -0800523 * Called when an action mode is being started for this window. Gives the
524 * callback an opportunity to handle the action mode in its own unique and
525 * beautiful way. If this method returns null the system can choose a way
Clara Bayarri4423d912015-03-02 19:42:48 +0000526 * to present the mode or choose not to start the mode at all. This is equivalent
527 * to {@link #onWindowStartingActionMode(android.view.ActionMode.Callback, int)}
528 * with type {@link ActionMode#TYPE_PRIMARY}.
Adam Powell6e346362010-07-23 10:18:23 -0700529 *
530 * @param callback Callback to control the lifecycle of this action mode
Adam Powelldebf3be2010-11-15 18:58:48 -0800531 * @return The ActionMode that was started, or null if the system should present it
Adam Powell6e346362010-07-23 10:18:23 -0700532 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700533 @Nullable
Adam Powelldebf3be2010-11-15 18:58:48 -0800534 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback);
535
536 /**
Clara Bayarri4423d912015-03-02 19:42:48 +0000537 * Called when an action mode is being started for this window. Gives the
538 * callback an opportunity to handle the action mode in its own unique and
539 * beautiful way. If this method returns null the system can choose a way
540 * to present the mode or choose not to start the mode at all.
541 *
542 * @param callback Callback to control the lifecycle of this action mode
543 * @param type One of {@link ActionMode#TYPE_PRIMARY} or {@link ActionMode#TYPE_FLOATING}.
544 * @return The ActionMode that was started, or null if the system should present it
545 */
546 @Nullable
547 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback, int type);
548
549 /**
Adam Powelldebf3be2010-11-15 18:58:48 -0800550 * Called when an action mode has been started. The appropriate mode callback
551 * method will have already been invoked.
552 *
553 * @param mode The new mode that has just been started.
554 */
555 public void onActionModeStarted(ActionMode mode);
556
557 /**
558 * Called when an action mode has been finished. The appropriate mode callback
559 * method will have already been invoked.
560 *
561 * @param mode The mode that was just finished.
562 */
563 public void onActionModeFinished(ActionMode mode);
Clara Bayarri75e09792015-07-29 16:20:40 +0100564
565 /**
566 * Called when Keyboard Shortcuts are requested for the current window.
567 *
568 * @param data The data list to populate with shortcuts.
569 * @param menu The current menu, which may be null.
Clara Bayarrifcd7e802016-03-10 12:58:18 +0000570 * @param deviceId The id for the connected device the shortcuts should be provided for.
Clara Bayarri75e09792015-07-29 16:20:40 +0100571 */
Sunny Goyal2a6d9aa2016-03-16 17:12:46 -0700572 default public void onProvideKeyboardShortcuts(
Clara Bayarrifcd7e802016-03-10 12:58:18 +0000573 List<KeyboardShortcutGroup> data, @Nullable Menu menu, int deviceId) { };
Vladislav Kaznacheev3787de12016-12-21 10:36:35 -0800574
575 /**
576 * Called when pointer capture is enabled or disabled for the current window.
577 *
578 * @param hasCapture True if the window has pointer capture.
579 */
580 default public void onPointerCaptureChanged(boolean hasCapture) { };
Adam Powell117b6952014-05-05 18:14:56 -0700581 }
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800582
Adam Powell117b6952014-05-05 18:14:56 -0700583 /** @hide */
584 public interface OnWindowDismissedCallback {
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800585 /**
586 * Called when a window is dismissed. This informs the callback that the
587 * window is gone, and it should finish itself.
Wale Ogunwaleba7881c2015-08-01 19:28:29 -0700588 * @param finishTask True if the task should also be finished.
Ned Burns7d6cb912016-12-02 17:25:33 -0500589 * @param suppressWindowTransition True if the resulting exit and enter window transition
590 * animations should be suppressed.
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800591 */
Ned Burns7d6cb912016-12-02 17:25:33 -0500592 void onWindowDismissed(boolean finishTask, boolean suppressWindowTransition);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800593 }
594
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700595 /** @hide */
Michael Kwan67639a52016-12-16 12:38:10 -0800596 public interface OnWindowSwipeDismissedCallback {
597 /**
598 * Called when a window is swipe dismissed. This informs the callback that the
599 * window is gone, and it should finish itself.
600 * @param finishTask True if the task should also be finished.
601 * @param suppressWindowTransition True if the resulting exit and enter window transition
602 * animations should be suppressed.
603 */
604 void onWindowSwipeDismissed();
605 }
606
607 /** @hide */
Skuhnece2faa52015-08-11 10:36:38 -0700608 public interface WindowControllerCallback {
609 /**
Filip Gruszczynski411c06f2016-01-07 09:44:44 -0800610 * Moves the activity from
Wale Ogunwale3382ab12017-07-27 08:55:03 -0700611 * Moves the activity from {@link WindowConfiguration#WINDOWING_MODE_FREEFORM} windowing
612 * mode to {@link WindowConfiguration#WINDOWING_MODE_FULLSCREEN}.
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700613 */
Filip Gruszczynski411c06f2016-01-07 09:44:44 -0800614 void exitFreeformMode() throws RemoteException;
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700615
Jaewan Kimd98dcab2016-05-03 02:52:18 +0900616 /**
617 * Puts the activity in picture-in-picture mode if the activity supports.
618 * @see android.R.attr#supportsPictureInPicture
619 */
620 void enterPictureInPictureModeIfPossible();
621
Winson Chung4d8681f2017-05-23 16:22:08 -0700622 /** Returns whether the window belongs to the task root. */
623 boolean isTaskRoot();
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700624 }
625
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800626 /**
627 * Callback for clients that want to be aware of where caption draws content.
628 */
Wale Ogunwalea504ca32016-01-30 16:02:13 -0800629 public interface OnRestrictedCaptionAreaChangedListener {
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800630 /**
631 * Called when the area where caption draws content changes.
632 *
633 * @param rect The area where caption content is positioned, relative to the top view.
634 */
635 void onRestrictedCaptionAreaChanged(Rect rect);
636 }
637
Andres Morales910beb82016-02-02 16:19:40 -0800638 /**
639 * Callback for clients that want frame timing information for each
640 * frame rendered by the Window.
641 */
Andres Moralesd908c622016-04-20 13:13:34 -0700642 public interface OnFrameMetricsAvailableListener {
Andres Morales910beb82016-02-02 16:19:40 -0800643 /**
644 * Called when information is available for the previously rendered frame.
645 *
646 * Reports can be dropped if this callback takes too
647 * long to execute, as the report producer cannot wait for the consumer to
648 * complete.
649 *
650 * It is highly recommended that clients copy the passed in FrameMetrics
651 * via {@link FrameMetrics#FrameMetrics(FrameMetrics)} within this method and defer
652 * additional computation or storage to another thread to avoid unnecessarily
653 * dropping reports.
654 *
655 * @param window The {@link Window} on which the frame was displayed.
656 * @param frameMetrics the available metrics. This object is reused on every call
657 * and thus <strong>this reference is not valid outside the scope of this method</strong>.
658 * @param dropCountSinceLastInvocation the number of reports dropped since the last time
659 * this callback was invoked.
660 */
Andres Moralesd908c622016-04-20 13:13:34 -0700661 void onFrameMetricsAvailable(Window window, FrameMetrics frameMetrics,
Andres Morales910beb82016-02-02 16:19:40 -0800662 int dropCountSinceLastInvocation);
663 }
664
665
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800666 public Window(Context context) {
667 mContext = context;
Bryce Leed6e6e722014-11-21 11:08:45 -0800668 mFeatures = mLocalFeatures = getDefaultFeatures(context);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800669 }
670
671 /**
672 * Return the Context this window policy is running in, for retrieving
673 * resources and other information.
674 *
675 * @return Context The Context that was supplied to the constructor.
676 */
677 public final Context getContext() {
678 return mContext;
679 }
680
681 /**
682 * Return the {@link android.R.styleable#Window} attributes from this
683 * window's theme.
684 */
685 public final TypedArray getWindowStyle() {
686 synchronized (this) {
687 if (mWindowStyle == null) {
688 mWindowStyle = mContext.obtainStyledAttributes(
689 com.android.internal.R.styleable.Window);
690 }
691 return mWindowStyle;
692 }
693 }
RoboErik55011652014-07-09 15:05:53 -0700694
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800695 /**
696 * Set the container for this window. If not set, the DecorWindow
697 * operates as a top-level window; otherwise, it negotiates with the
698 * container to display itself appropriately.
699 *
700 * @param container The desired containing Window.
701 */
702 public void setContainer(Window container) {
703 mContainer = container;
704 if (container != null) {
705 // Embedded screens never have a title.
706 mFeatures |= 1<<FEATURE_NO_TITLE;
707 mLocalFeatures |= 1<<FEATURE_NO_TITLE;
708 container.mHasChildren = true;
709 }
710 }
711
712 /**
713 * Return the container for this Window.
714 *
715 * @return Window The containing window, or null if this is a
716 * top-level window.
717 */
718 public final Window getContainer() {
719 return mContainer;
720 }
721
722 public final boolean hasChildren() {
723 return mHasChildren;
724 }
RoboErik55011652014-07-09 15:05:53 -0700725
Dianne Hackborn291905e2010-08-17 15:17:15 -0700726 /** @hide */
727 public final void destroy() {
728 mDestroyed = true;
729 }
730
731 /** @hide */
732 public final boolean isDestroyed() {
733 return mDestroyed;
734 }
735
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800736 /**
737 * Set the window manager for use by this Window to, for example,
738 * display panels. This is <em>not</em> used for displaying the
739 * Window itself -- that must be done by the client.
740 *
Jeff Brown98365d72012-08-19 20:30:52 -0700741 * @param wm The window manager for adding new windows.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800742 */
Romain Guy529b60a2010-08-03 18:05:47 -0700743 public void setWindowManager(WindowManager wm, IBinder appToken, String appName) {
744 setWindowManager(wm, appToken, appName, false);
745 }
746
747 /**
748 * Set the window manager for use by this Window to, for example,
749 * display panels. This is <em>not</em> used for displaying the
750 * Window itself -- that must be done by the client.
751 *
Jeff Brown98365d72012-08-19 20:30:52 -0700752 * @param wm The window manager for adding new windows.
Romain Guy529b60a2010-08-03 18:05:47 -0700753 */
754 public void setWindowManager(WindowManager wm, IBinder appToken, String appName,
755 boolean hardwareAccelerated) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800756 mAppToken = appToken;
757 mAppName = appName;
John Recke22d4d72018-03-02 15:49:48 -0800758 mHardwareAccelerated = hardwareAccelerated;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800759 if (wm == null) {
Jeff Brown98365d72012-08-19 20:30:52 -0700760 wm = (WindowManager)mContext.getSystemService(Context.WINDOW_SERVICE);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800761 }
Jeff Brown98365d72012-08-19 20:30:52 -0700762 mWindowManager = ((WindowManagerImpl)wm).createLocalWindowManager(this);
Dianne Hackborn5fd21692011-06-07 14:09:47 -0700763 }
764
Jeff Brownd32460c2012-07-20 16:15:36 -0700765 void adjustLayoutParamsForSubWindow(WindowManager.LayoutParams wp) {
766 CharSequence curTitle = wp.getTitle();
767 if (wp.type >= WindowManager.LayoutParams.FIRST_SUB_WINDOW &&
tiger_huangff58e302015-10-13 21:38:19 +0800768 wp.type <= WindowManager.LayoutParams.LAST_SUB_WINDOW) {
Jeff Brownd32460c2012-07-20 16:15:36 -0700769 if (wp.token == null) {
770 View decor = peekDecorView();
771 if (decor != null) {
772 wp.token = decor.getWindowToken();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800773 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800774 }
Jeff Brownd32460c2012-07-20 16:15:36 -0700775 if (curTitle == null || curTitle.length() == 0) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700776 final StringBuilder title = new StringBuilder(32);
Jeff Brownd32460c2012-07-20 16:15:36 -0700777 if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700778 title.append("Media");
Jeff Brownd32460c2012-07-20 16:15:36 -0700779 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700780 title.append("MediaOvr");
Jeff Brownd32460c2012-07-20 16:15:36 -0700781 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_PANEL) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700782 title.append("Panel");
Jeff Brownd32460c2012-07-20 16:15:36 -0700783 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700784 title.append("SubPanel");
Wale Ogunwale0a4dc222015-04-14 12:58:42 -0700785 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700786 title.append("AboveSubPanel");
Jeff Brownd32460c2012-07-20 16:15:36 -0700787 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700788 title.append("AtchDlg");
Jeff Brownd32460c2012-07-20 16:15:36 -0700789 } else {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700790 title.append(wp.type);
Jeff Brownd32460c2012-07-20 16:15:36 -0700791 }
792 if (mAppName != null) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700793 title.append(":").append(mAppName);
Jeff Brownd32460c2012-07-20 16:15:36 -0700794 }
795 wp.setTitle(title);
Romain Guy529b60a2010-08-03 18:05:47 -0700796 }
tiger_huangff58e302015-10-13 21:38:19 +0800797 } else if (wp.type >= WindowManager.LayoutParams.FIRST_SYSTEM_WINDOW &&
798 wp.type <= WindowManager.LayoutParams.LAST_SYSTEM_WINDOW) {
799 // We don't set the app token to this system window because the life cycles should be
800 // independent. If an app creates a system window and then the app goes to the stopped
801 // state, the system window should not be affected (can still show and receive input
802 // events).
803 if (curTitle == null || curTitle.length() == 0) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700804 final StringBuilder title = new StringBuilder(32);
805 title.append("Sys").append(wp.type);
tiger_huangff58e302015-10-13 21:38:19 +0800806 if (mAppName != null) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700807 title.append(":").append(mAppName);
tiger_huangff58e302015-10-13 21:38:19 +0800808 }
809 wp.setTitle(title);
810 }
Jeff Brownd32460c2012-07-20 16:15:36 -0700811 } else {
812 if (wp.token == null) {
813 wp.token = mContainer == null ? mAppToken : mContainer.mAppToken;
814 }
815 if ((curTitle == null || curTitle.length() == 0)
816 && mAppName != null) {
817 wp.setTitle(mAppName);
818 }
819 }
820 if (wp.packageName == null) {
821 wp.packageName = mContext.getPackageName();
822 }
Robert Carr13678ee2016-04-20 14:04:15 -0700823 if (mHardwareAccelerated ||
824 (mWindowAttributes.flags & FLAG_HARDWARE_ACCELERATED) != 0) {
825 wp.flags |= FLAG_HARDWARE_ACCELERATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800826 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800827 }
828
829 /**
830 * Return the window manager allowing this Window to display its own
831 * windows.
832 *
833 * @return WindowManager The ViewManager.
834 */
835 public WindowManager getWindowManager() {
836 return mWindowManager;
837 }
838
839 /**
840 * Set the Callback interface for this window, used to intercept key
841 * events and other dynamic operations in the window.
842 *
843 * @param callback The desired Callback interface.
844 */
845 public void setCallback(Callback callback) {
846 mCallback = callback;
847 }
848
849 /**
850 * Return the current Callback interface for this window.
851 */
852 public final Callback getCallback() {
853 return mCallback;
854 }
855
Andres Morales06f5bc72015-12-15 15:21:31 -0800856 /**
Andrew Zeng8b7fb462018-08-03 13:32:04 -0700857 * Set an observer to collect frame stats for each frame rendered in this window.
Andres Morales06f5bc72015-12-15 15:21:31 -0800858 *
859 * Must be in hardware rendering mode.
Andres Morales06f5bc72015-12-15 15:21:31 -0800860 */
Andres Moralesd908c622016-04-20 13:13:34 -0700861 public final void addOnFrameMetricsAvailableListener(
862 @NonNull OnFrameMetricsAvailableListener listener,
Andres Morales910beb82016-02-02 16:19:40 -0800863 Handler handler) {
Andres Morales06f5bc72015-12-15 15:21:31 -0800864 final View decorView = getDecorView();
865 if (decorView == null) {
866 throw new IllegalStateException("can't observe a Window without an attached view");
867 }
868
Andres Morales910beb82016-02-02 16:19:40 -0800869 if (listener == null) {
870 throw new NullPointerException("listener cannot be null");
Andres Morales06f5bc72015-12-15 15:21:31 -0800871 }
872
Andres Morales910beb82016-02-02 16:19:40 -0800873 decorView.addFrameMetricsListener(this, listener, handler);
Andres Morales06f5bc72015-12-15 15:21:31 -0800874 }
875
876 /**
877 * Remove observer and stop listening to frame stats for this window.
Andres Morales06f5bc72015-12-15 15:21:31 -0800878 */
Andres Moralesd908c622016-04-20 13:13:34 -0700879 public final void removeOnFrameMetricsAvailableListener(OnFrameMetricsAvailableListener listener) {
Andres Morales06f5bc72015-12-15 15:21:31 -0800880 final View decorView = getDecorView();
881 if (decorView != null) {
Andres Morales910beb82016-02-02 16:19:40 -0800882 getDecorView().removeFrameMetricsListener(listener);
Andres Morales06f5bc72015-12-15 15:21:31 -0800883 }
884 }
885
Adam Powell117b6952014-05-05 18:14:56 -0700886 /** @hide */
887 public final void setOnWindowDismissedCallback(OnWindowDismissedCallback dcb) {
888 mOnWindowDismissedCallback = dcb;
889 }
890
891 /** @hide */
Ned Burns7d6cb912016-12-02 17:25:33 -0500892 public final void dispatchOnWindowDismissed(
893 boolean finishTask, boolean suppressWindowTransition) {
Adam Powell117b6952014-05-05 18:14:56 -0700894 if (mOnWindowDismissedCallback != null) {
Ned Burns7d6cb912016-12-02 17:25:33 -0500895 mOnWindowDismissedCallback.onWindowDismissed(finishTask, suppressWindowTransition);
Adam Powell117b6952014-05-05 18:14:56 -0700896 }
897 }
898
Stefan Kuhne9bad7412015-08-07 10:35:52 -0700899 /** @hide */
Michael Kwan67639a52016-12-16 12:38:10 -0800900 public final void setOnWindowSwipeDismissedCallback(OnWindowSwipeDismissedCallback sdcb) {
901 mOnWindowSwipeDismissedCallback = sdcb;
902 }
903
904 /** @hide */
905 public final void dispatchOnWindowSwipeDismissed() {
906 if (mOnWindowSwipeDismissedCallback != null) {
907 mOnWindowSwipeDismissedCallback.onWindowSwipeDismissed();
908 }
909 }
910
911 /** @hide */
Skuhnece2faa52015-08-11 10:36:38 -0700912 public final void setWindowControllerCallback(WindowControllerCallback wccb) {
913 mWindowControllerCallback = wccb;
Stefan Kuhne9bad7412015-08-07 10:35:52 -0700914 }
915
916 /** @hide */
Skuhnece2faa52015-08-11 10:36:38 -0700917 public final WindowControllerCallback getWindowControllerCallback() {
918 return mWindowControllerCallback;
Stefan Kuhne9bad7412015-08-07 10:35:52 -0700919 }
920
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800921 /**
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800922 * Set a callback for changes of area where caption will draw its content.
923 *
924 * @param listener Callback that will be called when the area changes.
925 */
Wale Ogunwalea504ca32016-01-30 16:02:13 -0800926 public final void setRestrictedCaptionAreaListener(OnRestrictedCaptionAreaChangedListener listener) {
927 mOnRestrictedCaptionAreaChangedListener = listener;
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800928 mRestrictedCaptionAreaRect = listener != null ? new Rect() : null;
929 }
930
931 /**
Dianne Hackborndc8a7f62010-05-10 11:29:34 -0700932 * Take ownership of this window's surface. The window's view hierarchy
933 * will no longer draw into the surface, though it will otherwise continue
934 * to operate (such as for receiving input events). The given SurfaceHolder
935 * callback will be used to tell you about state changes to the surface.
936 */
Dianne Hackbornd76b67c2010-07-13 17:48:30 -0700937 public abstract void takeSurface(SurfaceHolder.Callback2 callback);
RoboErik55011652014-07-09 15:05:53 -0700938
Dianne Hackborndc8a7f62010-05-10 11:29:34 -0700939 /**
Dianne Hackborn1e4b9f32010-06-23 14:10:57 -0700940 * Take ownership of this window's InputQueue. The window will no
941 * longer read and dispatch input events from the queue; it is your
Dianne Hackborna95e4cb2010-06-18 18:09:33 -0700942 * responsibility to do so.
943 */
Dianne Hackborn1e4b9f32010-06-23 14:10:57 -0700944 public abstract void takeInputQueue(InputQueue.Callback callback);
RoboErik55011652014-07-09 15:05:53 -0700945
Dianne Hackborna95e4cb2010-06-18 18:09:33 -0700946 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800947 * Return whether this window is being displayed with a floating style
948 * (based on the {@link android.R.attr#windowIsFloating} attribute in
949 * the style/theme).
950 *
951 * @return Returns true if the window is configured to be displayed floating
952 * on top of whatever is behind it.
953 */
954 public abstract boolean isFloating();
955
956 /**
957 * Set the width and height layout parameters of the window. The default
Dianne Hackbornc9189352010-12-15 14:57:25 -0800958 * for both of these is MATCH_PARENT; you can change them to WRAP_CONTENT
959 * or an absolute value to make a window that is not full-screen.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800960 *
961 * @param width The desired layout width of the window.
962 * @param height The desired layout height of the window.
Dianne Hackbornc9189352010-12-15 14:57:25 -0800963 *
964 * @see ViewGroup.LayoutParams#height
965 * @see ViewGroup.LayoutParams#width
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800966 */
Dianne Hackbornc9189352010-12-15 14:57:25 -0800967 public void setLayout(int width, int height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800968 final WindowManager.LayoutParams attrs = getAttributes();
969 attrs.width = width;
970 attrs.height = height;
Adrian Roosea562512014-05-05 13:33:03 +0200971 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800972 }
973
974 /**
975 * Set the gravity of the window, as per the Gravity constants. This
976 * controls how the window manager is positioned in the overall window; it
977 * is only useful when using WRAP_CONTENT for the layout width or height.
978 *
979 * @param gravity The desired gravity constant.
980 *
981 * @see Gravity
982 * @see #setLayout
983 */
984 public void setGravity(int gravity)
985 {
986 final WindowManager.LayoutParams attrs = getAttributes();
987 attrs.gravity = gravity;
Adrian Roosea562512014-05-05 13:33:03 +0200988 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800989 }
990
991 /**
992 * Set the type of the window, as per the WindowManager.LayoutParams
993 * types.
994 *
995 * @param type The new window type (see WindowManager.LayoutParams).
996 */
997 public void setType(int type) {
998 final WindowManager.LayoutParams attrs = getAttributes();
999 attrs.type = type;
Adrian Roosea562512014-05-05 13:33:03 +02001000 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001001 }
1002
1003 /**
1004 * Set the format of window, as per the PixelFormat types. This overrides
1005 * the default format that is selected by the Window based on its
1006 * window decorations.
1007 *
1008 * @param format The new window format (see PixelFormat). Use
1009 * PixelFormat.UNKNOWN to allow the Window to select
1010 * the format.
1011 *
1012 * @see PixelFormat
1013 */
1014 public void setFormat(int format) {
1015 final WindowManager.LayoutParams attrs = getAttributes();
1016 if (format != PixelFormat.UNKNOWN) {
1017 attrs.format = format;
1018 mHaveWindowFormat = true;
1019 } else {
1020 attrs.format = mDefaultWindowFormat;
1021 mHaveWindowFormat = false;
1022 }
Adrian Roosea562512014-05-05 13:33:03 +02001023 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001024 }
1025
1026 /**
1027 * Specify custom animations to use for the window, as per
1028 * {@link WindowManager.LayoutParams#windowAnimations
1029 * WindowManager.LayoutParams.windowAnimations}. Providing anything besides
1030 * 0 here will override the animations the window would
1031 * normally retrieve from its theme.
1032 */
Tor Norbye417ee5b2015-03-10 20:57:37 -07001033 public void setWindowAnimations(@StyleRes int resId) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001034 final WindowManager.LayoutParams attrs = getAttributes();
1035 attrs.windowAnimations = resId;
Adrian Roosea562512014-05-05 13:33:03 +02001036 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001037 }
1038
1039 /**
1040 * Specify an explicit soft input mode to use for the window, as per
1041 * {@link WindowManager.LayoutParams#softInputMode
1042 * WindowManager.LayoutParams.softInputMode}. Providing anything besides
1043 * "unspecified" here will override the input mode the window would
1044 * normally retrieve from its theme.
1045 */
1046 public void setSoftInputMode(int mode) {
1047 final WindowManager.LayoutParams attrs = getAttributes();
1048 if (mode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
1049 attrs.softInputMode = mode;
1050 mHasSoftInputMode = true;
1051 } else {
1052 mHasSoftInputMode = false;
1053 }
Adrian Roosea562512014-05-05 13:33:03 +02001054 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001055 }
RoboErik55011652014-07-09 15:05:53 -07001056
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001057 /**
1058 * Convenience function to set the flag bits as specified in flags, as
1059 * per {@link #setFlags}.
1060 * @param flags The flag bits to be set.
1061 * @see #setFlags
Christopher Tate193fc072012-06-04 11:27:40 -07001062 * @see #clearFlags
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001063 */
1064 public void addFlags(int flags) {
1065 setFlags(flags, flags);
1066 }
Adam Lesinski95c42972013-10-02 10:13:27 -07001067
1068 /** @hide */
1069 public void addPrivateFlags(int flags) {
1070 setPrivateFlags(flags, flags);
1071 }
RoboErik55011652014-07-09 15:05:53 -07001072
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001073 /**
1074 * Convenience function to clear the flag bits as specified in flags, as
1075 * per {@link #setFlags}.
1076 * @param flags The flag bits to be cleared.
1077 * @see #setFlags
Christopher Tate193fc072012-06-04 11:27:40 -07001078 * @see #addFlags
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001079 */
1080 public void clearFlags(int flags) {
1081 setFlags(0, flags);
1082 }
1083
1084 /**
1085 * Set the flags of the window, as per the
1086 * {@link WindowManager.LayoutParams WindowManager.LayoutParams}
1087 * flags.
RoboErik55011652014-07-09 15:05:53 -07001088 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001089 * <p>Note that some flags must be set before the window decoration is
1090 * created (by the first call to
1091 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} or
1092 * {@link #getDecorView()}:
1093 * {@link WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN} and
1094 * {@link WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR}. These
1095 * will be set for you based on the {@link android.R.attr#windowIsFloating}
1096 * attribute.
1097 *
1098 * @param flags The new window flags (see WindowManager.LayoutParams).
1099 * @param mask Which of the window flag bits to modify.
Christopher Tate193fc072012-06-04 11:27:40 -07001100 * @see #addFlags
1101 * @see #clearFlags
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001102 */
1103 public void setFlags(int flags, int mask) {
1104 final WindowManager.LayoutParams attrs = getAttributes();
1105 attrs.flags = (attrs.flags&~mask) | (flags&mask);
1106 mForcedWindowFlags |= mask;
Adrian Roosea562512014-05-05 13:33:03 +02001107 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001108 }
1109
Adam Lesinski95c42972013-10-02 10:13:27 -07001110 private void setPrivateFlags(int flags, int mask) {
1111 final WindowManager.LayoutParams attrs = getAttributes();
1112 attrs.privateFlags = (attrs.privateFlags & ~mask) | (flags & mask);
Adrian Roosea562512014-05-05 13:33:03 +02001113 dispatchWindowAttributesChanged(attrs);
1114 }
1115
1116 /**
1117 * {@hide}
1118 */
Wale Ogunwale393b1c12014-10-18 16:22:01 -07001119 protected void setNeedsMenuKey(int value) {
1120 final WindowManager.LayoutParams attrs = getAttributes();
1121 attrs.needsMenuKey = value;
1122 dispatchWindowAttributesChanged(attrs);
1123 }
1124
1125 /**
1126 * {@hide}
1127 */
Adrian Roosea562512014-05-05 13:33:03 +02001128 protected void dispatchWindowAttributesChanged(WindowManager.LayoutParams attrs) {
Adam Lesinski95c42972013-10-02 10:13:27 -07001129 if (mCallback != null) {
1130 mCallback.onWindowAttributesChanged(attrs);
1131 }
1132 }
1133
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001134 /**
Romain Guyadae59b2017-06-20 14:45:53 -07001135 * <p>Sets the requested color mode of the window. The requested the color mode might
Romain Guy48327452017-01-23 17:03:35 -08001136 * override the window's pixel {@link WindowManager.LayoutParams#format format}.</p>
1137 *
Romain Guyadae59b2017-06-20 14:45:53 -07001138 * <p>The requested color mode must be one of {@link ActivityInfo#COLOR_MODE_DEFAULT},
Romain Guy48327452017-01-23 17:03:35 -08001139 * {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT} or {@link ActivityInfo#COLOR_MODE_HDR}.</p>
Romain Guyadae59b2017-06-20 14:45:53 -07001140 *
1141 * <p>The requested color mode is not guaranteed to be honored. Please refer to
1142 * {@link #getColorMode()} for more information.</p>
1143 *
1144 * @see #getColorMode()
1145 * @see Display#isWideColorGamut()
1146 * @see Configuration#isScreenWideColorGamut()
Romain Guy48327452017-01-23 17:03:35 -08001147 */
1148 public void setColorMode(@ActivityInfo.ColorMode int colorMode) {
1149 final WindowManager.LayoutParams attrs = getAttributes();
1150 attrs.setColorMode(colorMode);
1151 dispatchWindowAttributesChanged(attrs);
1152 }
1153
1154 /**
Romain Guyadae59b2017-06-20 14:45:53 -07001155 * Returns the requested color mode of the window, one of
1156 * {@link ActivityInfo#COLOR_MODE_DEFAULT}, {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT}
1157 * or {@link ActivityInfo#COLOR_MODE_HDR}. If {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT}
1158 * was requested it is possible the window will not be put in wide color gamut mode depending
1159 * on device and display support for that mode. Use {@link #isWideColorGamut} to determine
1160 * if the window is currently in wide color gamut mode.
1161 *
1162 * @see #setColorMode(int)
1163 * @see Display#isWideColorGamut()
1164 * @see Configuration#isScreenWideColorGamut()
Romain Guy48327452017-01-23 17:03:35 -08001165 */
1166 @ActivityInfo.ColorMode
1167 public int getColorMode() {
1168 return getAttributes().getColorMode();
1169 }
1170
1171 /**
Romain Guyadae59b2017-06-20 14:45:53 -07001172 * Returns true if this window's color mode is {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT},
1173 * the display has a wide color gamut and this device supports wide color gamut rendering.
1174 *
1175 * @see Display#isWideColorGamut()
1176 * @see Configuration#isScreenWideColorGamut()
1177 */
1178 public boolean isWideColorGamut() {
1179 return getColorMode() == ActivityInfo.COLOR_MODE_WIDE_COLOR_GAMUT
1180 && getContext().getResources().getConfiguration().isScreenWideColorGamut();
1181 }
1182
1183 /**
Dianne Hackborn661cd522011-08-22 00:26:20 -07001184 * Set the amount of dim behind the window when using
1185 * {@link WindowManager.LayoutParams#FLAG_DIM_BEHIND}. This overrides
1186 * the default dim amount of that is selected by the Window based on
1187 * its theme.
1188 *
1189 * @param amount The new dim amount, from 0 for no dim to 1 for full dim.
1190 */
1191 public void setDimAmount(float amount) {
1192 final WindowManager.LayoutParams attrs = getAttributes();
1193 attrs.dimAmount = amount;
1194 mHaveDimAmount = true;
Adrian Roosea562512014-05-05 13:33:03 +02001195 dispatchWindowAttributesChanged(attrs);
Dianne Hackborn661cd522011-08-22 00:26:20 -07001196 }
1197
1198 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001199 * Specify custom window attributes. <strong>PLEASE NOTE:</strong> the
1200 * layout params you give here should generally be from values previously
1201 * retrieved with {@link #getAttributes()}; you probably do not want to
1202 * blindly create and apply your own, since this will blow away any values
1203 * set by the framework that you are not interested in.
1204 *
1205 * @param a The new window attributes, which will completely override any
1206 * current values.
1207 */
1208 public void setAttributes(WindowManager.LayoutParams a) {
1209 mWindowAttributes.copyFrom(a);
Adrian Roosea562512014-05-05 13:33:03 +02001210 dispatchWindowAttributesChanged(mWindowAttributes);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001211 }
1212
1213 /**
1214 * Retrieve the current window attributes associated with this panel.
1215 *
1216 * @return WindowManager.LayoutParams Either the existing window
1217 * attributes object, or a freshly created one if there is none.
1218 */
1219 public final WindowManager.LayoutParams getAttributes() {
1220 return mWindowAttributes;
1221 }
1222
1223 /**
1224 * Return the window flags that have been explicitly set by the client,
1225 * so will not be modified by {@link #getDecorView}.
1226 */
1227 protected final int getForcedWindowFlags() {
1228 return mForcedWindowFlags;
1229 }
RoboErik55011652014-07-09 15:05:53 -07001230
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001231 /**
1232 * Has the app specified their own soft input mode?
1233 */
1234 protected final boolean hasSoftInputMode() {
1235 return mHasSoftInputMode;
1236 }
RoboErik55011652014-07-09 15:05:53 -07001237
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001238 /** @hide */
1239 public void setCloseOnTouchOutside(boolean close) {
1240 mCloseOnTouchOutside = close;
1241 mSetCloseOnTouchOutside = true;
1242 }
RoboErik55011652014-07-09 15:05:53 -07001243
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001244 /** @hide */
Dianne Hackbornef575752011-01-18 17:35:17 -08001245 public void setCloseOnTouchOutsideIfNotSet(boolean close) {
1246 if (!mSetCloseOnTouchOutside) {
1247 mCloseOnTouchOutside = close;
1248 mSetCloseOnTouchOutside = true;
1249 }
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001250 }
RoboErik55011652014-07-09 15:05:53 -07001251
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001252 /** @hide */
1253 public abstract void alwaysReadCloseOnTouchAttr();
RoboErik55011652014-07-09 15:05:53 -07001254
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001255 /** @hide */
1256 public boolean shouldCloseOnTouch(Context context, MotionEvent event) {
Michael Wrightddec8fb2017-06-16 18:36:26 +01001257 final boolean isOutside =
1258 event.getAction() == MotionEvent.ACTION_DOWN && isOutOfBounds(context, event)
1259 || event.getAction() == MotionEvent.ACTION_OUTSIDE;
1260 if (mCloseOnTouchOutside && peekDecorView() != null && isOutside) {
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001261 return true;
1262 }
1263 return false;
1264 }
RoboErik55011652014-07-09 15:05:53 -07001265
Ruchi Kandoi43e38de2016-04-14 19:34:53 -07001266 /* Sets the Sustained Performance requirement for the calling window.
1267 * @param enable disables or enables the mode.
1268 */
1269 public void setSustainedPerformanceMode(boolean enable) {
1270 setPrivateFlags(enable
1271 ? WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE : 0,
1272 WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE);
1273 }
1274
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001275 private boolean isOutOfBounds(Context context, MotionEvent event) {
1276 final int x = (int) event.getX();
1277 final int y = (int) event.getY();
1278 final int slop = ViewConfiguration.get(context).getScaledWindowTouchSlop();
1279 final View decorView = getDecorView();
1280 return (x < -slop) || (y < -slop)
1281 || (x > (decorView.getWidth()+slop))
1282 || (y > (decorView.getHeight()+slop));
1283 }
RoboErik55011652014-07-09 15:05:53 -07001284
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001285 /**
1286 * Enable extended screen features. This must be called before
1287 * setContentView(). May be called as many times as desired as long as it
1288 * is before setContentView(). If not called, no extended features
1289 * will be available. You can not turn off a feature once it is requested.
1290 * You canot use other title features with {@link #FEATURE_CUSTOM_TITLE}.
1291 *
1292 * @param featureId The desired features, defined as constants by Window.
1293 * @return The features that are now set.
1294 */
1295 public boolean requestFeature(int featureId) {
1296 final int flag = 1<<featureId;
1297 mFeatures |= flag;
1298 mLocalFeatures |= mContainer != null ? (flag&~mContainer.mFeatures) : flag;
1299 return (mFeatures&flag) != 0;
1300 }
1301
Adam Powellf4a6ec42010-08-24 14:18:10 -07001302 /**
1303 * @hide Used internally to help resolve conflicting features.
1304 */
1305 protected void removeFeature(int featureId) {
1306 final int flag = 1<<featureId;
1307 mFeatures &= ~flag;
1308 mLocalFeatures &= ~(mContainer != null ? (flag&~mContainer.mFeatures) : flag);
1309 }
1310
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001311 public final void makeActive() {
1312 if (mContainer != null) {
1313 if (mContainer.mActiveChild != null) {
1314 mContainer.mActiveChild.mIsActive = false;
1315 }
1316 mContainer.mActiveChild = this;
1317 }
1318 mIsActive = true;
1319 onActive();
1320 }
1321
1322 public final boolean isActive()
1323 {
1324 return mIsActive;
1325 }
1326
1327 /**
Alan Viverettedb7423c2017-03-31 13:13:58 -04001328 * Finds a view that was identified by the {@code android:id} XML attribute
Chris Craik6faa9e52018-01-11 10:46:10 -08001329 * that was processed in {@link android.app.Activity#onCreate}.
1330 * <p>
1331 * This will implicitly call {@link #getDecorView} with all of the associated side-effects.
Alan Viverettedb7423c2017-03-31 13:13:58 -04001332 * <p>
1333 * <strong>Note:</strong> In most cases -- depending on compiler support --
1334 * the resulting view is automatically cast to the target class type. If
1335 * the target class type is unconstrained, an explicit cast may be
1336 * necessary.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001337 *
Alan Viverettedb7423c2017-03-31 13:13:58 -04001338 * @param id the ID to search for
1339 * @return a view with given ID if found, or {@code null} otherwise
1340 * @see View#findViewById(int)
Chris Craik6faa9e52018-01-11 10:46:10 -08001341 * @see Window#requireViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001342 */
Scott Kennedyc0519552015-02-11 15:33:10 -08001343 @Nullable
Alan Viverettedb7423c2017-03-31 13:13:58 -04001344 public <T extends View> T findViewById(@IdRes int id) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001345 return getDecorView().findViewById(id);
1346 }
Chris Craik6faa9e52018-01-11 10:46:10 -08001347 /**
1348 * Finds a view that was identified by the {@code android:id} XML attribute
1349 * that was processed in {@link android.app.Activity#onCreate}, or throws an
1350 * IllegalArgumentException if the ID is invalid, or there is no matching view in the hierarchy.
1351 * <p>
1352 * <strong>Note:</strong> In most cases -- depending on compiler support --
1353 * the resulting view is automatically cast to the target class type. If
1354 * the target class type is unconstrained, an explicit cast may be
1355 * necessary.
1356 *
1357 * @param id the ID to search for
1358 * @return a view with given ID
1359 * @see View#requireViewById(int)
1360 * @see Window#findViewById(int)
1361 */
1362 @NonNull
1363 public final <T extends View> T requireViewById(@IdRes int id) {
1364 T view = findViewById(id);
1365 if (view == null) {
1366 throw new IllegalArgumentException("ID does not reference a View inside this Window");
1367 }
1368 return view;
1369 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001370
1371 /**
1372 * Convenience for
1373 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1374 * to set the screen content from a layout resource. The resource will be
1375 * inflated, adding all top-level views to the screen.
1376 *
1377 * @param layoutResID Resource ID to be inflated.
1378 * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
1379 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001380 public abstract void setContentView(@LayoutRes int layoutResID);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001381
1382 /**
1383 * Convenience for
1384 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1385 * set the screen content to an explicit view. This view is placed
1386 * directly into the screen's view hierarchy. It can itself be a complex
1387 * view hierarhcy.
1388 *
1389 * @param view The desired content to display.
1390 * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
1391 */
1392 public abstract void setContentView(View view);
1393
1394 /**
1395 * Set the screen content to an explicit view. This view is placed
1396 * directly into the screen's view hierarchy. It can itself be a complex
1397 * view hierarchy.
1398 *
1399 * <p>Note that calling this function "locks in" various characteristics
1400 * of the window that can not, from this point forward, be changed: the
1401 * features that have been requested with {@link #requestFeature(int)},
George Mountc3a043c2015-02-04 14:37:04 -08001402 * and certain window flags as described in {@link #setFlags(int, int)}.</p>
1403 *
1404 * <p>If {@link #FEATURE_CONTENT_TRANSITIONS} is set, the window's
1405 * TransitionManager will be used to animate content from the current
1406 * content View to view.</p>
RoboErik55011652014-07-09 15:05:53 -07001407 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001408 * @param view The desired content to display.
1409 * @param params Layout parameters for the view.
George Mountc3a043c2015-02-04 14:37:04 -08001410 * @see #getTransitionManager()
1411 * @see #setTransitionManager(android.transition.TransitionManager)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001412 */
1413 public abstract void setContentView(View view, ViewGroup.LayoutParams params);
1414
1415 /**
1416 * Variation on
1417 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1418 * to add an additional content view to the screen. Added after any existing
1419 * ones in the screen -- existing views are NOT removed.
1420 *
1421 * @param view The desired content to display.
1422 * @param params Layout parameters for the view.
1423 */
1424 public abstract void addContentView(View view, ViewGroup.LayoutParams params);
1425
1426 /**
Filip Gruszczynskia59ac9c2015-09-10 18:28:48 -07001427 * Remove the view that was used as the screen content.
1428 *
1429 * @hide
1430 */
1431 public abstract void clearContentView();
1432
1433 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001434 * Return the view in this Window that currently has focus, or null if
1435 * there are none. Note that this does not look in any containing
1436 * Window.
1437 *
1438 * @return View The current View with focus or null.
1439 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001440 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001441 public abstract View getCurrentFocus();
1442
1443 /**
1444 * Quick access to the {@link LayoutInflater} instance that this Window
1445 * retrieved from its Context.
1446 *
1447 * @return LayoutInflater The shared LayoutInflater.
1448 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001449 @NonNull
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001450 public abstract LayoutInflater getLayoutInflater();
1451
1452 public abstract void setTitle(CharSequence title);
1453
Alan Viverette2525d9c2013-11-15 14:42:19 -08001454 @Deprecated
Tor Norbye80756e32015-03-02 09:39:27 -08001455 public abstract void setTitleColor(@ColorInt int textColor);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001456
1457 public abstract void openPanel(int featureId, KeyEvent event);
1458
1459 public abstract void closePanel(int featureId);
1460
1461 public abstract void togglePanel(int featureId, KeyEvent event);
1462
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001463 public abstract void invalidatePanelMenu(int featureId);
RoboErik55011652014-07-09 15:05:53 -07001464
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001465 public abstract boolean performPanelShortcut(int featureId,
1466 int keyCode,
1467 KeyEvent event,
1468 int flags);
1469 public abstract boolean performPanelIdentifierAction(int featureId,
1470 int id,
1471 int flags);
1472
1473 public abstract void closeAllPanels();
1474
1475 public abstract boolean performContextMenuIdentifierAction(int id, int flags);
1476
1477 /**
1478 * Should be called when the configuration is changed.
RoboErik55011652014-07-09 15:05:53 -07001479 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001480 * @param newConfig The new configuration.
1481 */
1482 public abstract void onConfigurationChanged(Configuration newConfig);
RoboErik55011652014-07-09 15:05:53 -07001483
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001484 /**
Alan Viverette79c067c52014-10-29 14:27:47 -07001485 * Sets the window elevation.
Alan Viverette71922de2015-01-12 16:14:02 -08001486 * <p>
1487 * Changes to this property take effect immediately and will cause the
1488 * window surface to be recreated. This is an expensive operation and as a
1489 * result, this property should not be animated.
Alan Viverette79c067c52014-10-29 14:27:47 -07001490 *
1491 * @param elevation The window elevation.
1492 * @see View#setElevation(float)
1493 * @see android.R.styleable#Window_windowElevation
1494 */
1495 public void setElevation(float elevation) {}
1496
1497 /**
Filip Gruszczynskia59ac9c2015-09-10 18:28:48 -07001498 * Gets the window elevation.
1499 *
1500 * @hide
1501 */
1502 public float getElevation() {
1503 return 0.0f;
1504 }
1505
1506 /**
Alan Viverette79c067c52014-10-29 14:27:47 -07001507 * Sets whether window content should be clipped to the outline of the
1508 * window background.
1509 *
1510 * @param clipToOutline Whether window content should be clipped to the
1511 * outline of the window background.
1512 * @see View#setClipToOutline(boolean)
1513 * @see android.R.styleable#Window_windowClipToOutline
1514 */
1515 public void setClipToOutline(boolean clipToOutline) {}
1516
1517 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001518 * Change the background of this window to a Drawable resource. Setting the
1519 * background to null will make the window be opaque. To make the window
1520 * transparent, you can use an empty drawable (for instance a ColorDrawable
1521 * with the color 0 or the system drawable android:drawable/empty.)
RoboErik55011652014-07-09 15:05:53 -07001522 *
Alan Viverette79c067c52014-10-29 14:27:47 -07001523 * @param resId The resource identifier of a drawable resource which will
1524 * be installed as the new background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001525 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001526 public void setBackgroundDrawableResource(@DrawableRes int resId) {
Alan Viverette79c067c52014-10-29 14:27:47 -07001527 setBackgroundDrawable(mContext.getDrawable(resId));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001528 }
1529
1530 /**
1531 * Change the background of this window to a custom Drawable. Setting the
1532 * background to null will make the window be opaque. To make the window
1533 * transparent, you can use an empty drawable (for instance a ColorDrawable
1534 * with the color 0 or the system drawable android:drawable/empty.)
1535 *
1536 * @param drawable The new Drawable to use for this window's background.
1537 */
1538 public abstract void setBackgroundDrawable(Drawable drawable);
1539
1540 /**
1541 * Set the value for a drawable feature of this window, from a resource
Tor Norbye7b9c9122013-05-30 16:48:33 -07001542 * identifier. You must have called requestFeature(featureId) before
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001543 * calling this function.
1544 *
1545 * @see android.content.res.Resources#getDrawable(int)
1546 *
1547 * @param featureId The desired drawable feature to change, defined as a
1548 * constant by Window.
1549 * @param resId Resource identifier of the desired image.
1550 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001551 public abstract void setFeatureDrawableResource(int featureId, @DrawableRes int resId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552
1553 /**
1554 * Set the value for a drawable feature of this window, from a URI. You
1555 * must have called requestFeature(featureId) before calling this
1556 * function.
1557 *
1558 * <p>The only URI currently supported is "content:", specifying an image
1559 * in a content provider.
1560 *
1561 * @see android.widget.ImageView#setImageURI
1562 *
1563 * @param featureId The desired drawable feature to change. Features are
1564 * constants defined by Window.
1565 * @param uri The desired URI.
1566 */
1567 public abstract void setFeatureDrawableUri(int featureId, Uri uri);
1568
1569 /**
1570 * Set an explicit Drawable value for feature of this window. You must
1571 * have called requestFeature(featureId) before calling this function.
1572 *
Alan Viverette9678e342014-10-24 15:23:58 -07001573 * @param featureId The desired drawable feature to change. Features are
1574 * constants defined by Window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001575 * @param drawable A Drawable object to display.
1576 */
1577 public abstract void setFeatureDrawable(int featureId, Drawable drawable);
1578
1579 /**
Alan Viverette9678e342014-10-24 15:23:58 -07001580 * Set a custom alpha value for the given drawable feature, controlling how
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001581 * much the background is visible through it.
1582 *
Alan Viverette9678e342014-10-24 15:23:58 -07001583 * @param featureId The desired drawable feature to change. Features are
1584 * constants defined by Window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001585 * @param alpha The alpha amount, 0 is completely transparent and 255 is
1586 * completely opaque.
1587 */
1588 public abstract void setFeatureDrawableAlpha(int featureId, int alpha);
1589
1590 /**
Alan Viverette9678e342014-10-24 15:23:58 -07001591 * Set the integer value for a feature. The range of the value depends on
1592 * the feature being set. For {@link #FEATURE_PROGRESS}, it should go from
1593 * 0 to 10000. At 10000 the progress is complete and the indicator hidden.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594 *
Alan Viverette9678e342014-10-24 15:23:58 -07001595 * @param featureId The desired feature to change. Features are constants
1596 * defined by Window.
1597 * @param value The value for the feature. The interpretation of this
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001598 * value is feature-specific.
1599 */
1600 public abstract void setFeatureInt(int featureId, int value);
1601
1602 /**
1603 * Request that key events come to this activity. Use this if your
1604 * activity has no views with focus, but the activity still wants
1605 * a chance to process key events.
1606 */
1607 public abstract void takeKeyEvents(boolean get);
1608
1609 /**
1610 * Used by custom windows, such as Dialog, to pass the key press event
1611 * further down the view hierarchy. Application developers should
1612 * not need to implement or call this.
1613 *
1614 */
1615 public abstract boolean superDispatchKeyEvent(KeyEvent event);
1616
1617 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08001618 * Used by custom windows, such as Dialog, to pass the key shortcut press event
1619 * further down the view hierarchy. Application developers should
1620 * not need to implement or call this.
1621 *
1622 */
1623 public abstract boolean superDispatchKeyShortcutEvent(KeyEvent event);
1624
1625 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001626 * Used by custom windows, such as Dialog, to pass the touch screen event
1627 * further down the view hierarchy. Application developers should
1628 * not need to implement or call this.
1629 *
1630 */
1631 public abstract boolean superDispatchTouchEvent(MotionEvent event);
RoboErik55011652014-07-09 15:05:53 -07001632
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 /**
1634 * Used by custom windows, such as Dialog, to pass the trackball event
1635 * further down the view hierarchy. Application developers should
1636 * not need to implement or call this.
1637 *
1638 */
1639 public abstract boolean superDispatchTrackballEvent(MotionEvent event);
RoboErik55011652014-07-09 15:05:53 -07001640
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001641 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08001642 * Used by custom windows, such as Dialog, to pass the generic motion event
1643 * further down the view hierarchy. Application developers should
1644 * not need to implement or call this.
1645 *
1646 */
1647 public abstract boolean superDispatchGenericMotionEvent(MotionEvent event);
1648
1649 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001650 * Retrieve the top-level window decor view (containing the standard
1651 * window frame/decorations and the client's content inside of that), which
1652 * can be added as a window to the window manager.
RoboErik55011652014-07-09 15:05:53 -07001653 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001654 * <p><em>Note that calling this function for the first time "locks in"
1655 * various window characteristics as described in
1656 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001657 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001658 * @return Returns the top-level window decor view.
1659 */
Siarhei Vishniakouc771e7e2018-04-19 11:43:29 -07001660 public abstract @NonNull View getDecorView();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661
1662 /**
1663 * Retrieve the current decor view, but only if it has already been created;
1664 * otherwise returns null.
RoboErik55011652014-07-09 15:05:53 -07001665 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001666 * @return Returns the top-level window decor or null.
1667 * @see #getDecorView
1668 */
1669 public abstract View peekDecorView();
1670
1671 public abstract Bundle saveHierarchyState();
RoboErik55011652014-07-09 15:05:53 -07001672
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001673 public abstract void restoreHierarchyState(Bundle savedInstanceState);
RoboErik55011652014-07-09 15:05:53 -07001674
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001675 protected abstract void onActive();
1676
1677 /**
1678 * Return the feature bits that are enabled. This is the set of features
1679 * that were given to requestFeature(), and are being handled by this
1680 * Window itself or its container. That is, it is the set of
1681 * requested features that you can actually use.
1682 *
1683 * <p>To do: add a public version of this API that allows you to check for
1684 * features by their feature ID.
1685 *
1686 * @return int The feature bits.
1687 */
1688 protected final int getFeatures()
1689 {
1690 return mFeatures;
1691 }
RoboErik55011652014-07-09 15:05:53 -07001692
Adam Powell33b97432010-04-20 10:01:14 -07001693 /**
Bryce Leed6e6e722014-11-21 11:08:45 -08001694 * Return the feature bits set by default on a window.
1695 * @param context The context used to access resources
1696 */
1697 public static int getDefaultFeatures(Context context) {
1698 int features = 0;
1699
1700 final Resources res = context.getResources();
1701 if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureOptionsPanel)) {
1702 features |= 1 << FEATURE_OPTIONS_PANEL;
1703 }
1704
1705 if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureContextMenu)) {
1706 features |= 1 << FEATURE_CONTEXT_MENU;
1707 }
1708
1709 return features;
1710 }
1711
1712 /**
Adam Powell33b97432010-04-20 10:01:14 -07001713 * Query for the availability of a certain feature.
RoboErik55011652014-07-09 15:05:53 -07001714 *
Adam Powell33b97432010-04-20 10:01:14 -07001715 * @param feature The feature ID to check
1716 * @return true if the feature is enabled, false otherwise.
1717 */
1718 public boolean hasFeature(int feature) {
1719 return (getFeatures() & (1 << feature)) != 0;
1720 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001721
1722 /**
1723 * Return the feature bits that are being implemented by this Window.
1724 * This is the set of features that were given to requestFeature(), and are
1725 * being handled by only this Window itself, not by its containers.
1726 *
1727 * @return int The feature bits.
1728 */
1729 protected final int getLocalFeatures()
1730 {
1731 return mLocalFeatures;
1732 }
1733
1734 /**
1735 * Set the default format of window, as per the PixelFormat types. This
1736 * is the format that will be used unless the client specifies in explicit
1737 * format with setFormat();
1738 *
1739 * @param format The new window format (see PixelFormat).
1740 *
1741 * @see #setFormat
1742 * @see PixelFormat
1743 */
1744 protected void setDefaultWindowFormat(int format) {
1745 mDefaultWindowFormat = format;
1746 if (!mHaveWindowFormat) {
1747 final WindowManager.LayoutParams attrs = getAttributes();
1748 attrs.format = format;
Adrian Roosea562512014-05-05 13:33:03 +02001749 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001750 }
1751 }
1752
Dianne Hackborn661cd522011-08-22 00:26:20 -07001753 /** @hide */
1754 protected boolean haveDimAmount() {
1755 return mHaveDimAmount;
1756 }
1757
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001758 public abstract void setChildDrawable(int featureId, Drawable drawable);
1759
1760 public abstract void setChildInt(int featureId, int value);
1761
1762 /**
1763 * Is a keypress one of the defined shortcut keys for this window.
1764 * @param keyCode the key code from {@link android.view.KeyEvent} to check.
1765 * @param event the {@link android.view.KeyEvent} to use to help check.
1766 */
1767 public abstract boolean isShortcutKey(int keyCode, KeyEvent event);
RoboErik55011652014-07-09 15:05:53 -07001768
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001769 /**
RoboErik55011652014-07-09 15:05:53 -07001770 * @see android.app.Activity#setVolumeControlStream(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001771 */
1772 public abstract void setVolumeControlStream(int streamType);
1773
1774 /**
1775 * @see android.app.Activity#getVolumeControlStream()
1776 */
1777 public abstract int getVolumeControlStream();
Adam Powell269248d2011-08-02 10:26:54 -07001778
1779 /**
RoboErikfd63dd02014-08-28 15:22:55 -07001780 * Sets a {@link MediaController} to send media keys and volume changes to.
1781 * If set, this should be preferred for all media keys and volume requests
1782 * sent to this window.
1783 *
1784 * @param controller The controller for the session which should receive
1785 * media keys and volume changes.
RoboErik55011652014-07-09 15:05:53 -07001786 * @see android.app.Activity#setMediaController(android.media.session.MediaController)
1787 */
1788 public void setMediaController(MediaController controller) {
1789 }
1790
1791 /**
RoboErikfd63dd02014-08-28 15:22:55 -07001792 * Gets the {@link MediaController} that was previously set.
1793 *
1794 * @return The controller which should receive events.
1795 * @see #setMediaController(android.media.session.MediaController)
RoboErik55011652014-07-09 15:05:53 -07001796 * @see android.app.Activity#getMediaController()
1797 */
1798 public MediaController getMediaController() {
1799 return null;
1800 }
1801
1802 /**
Adam Powell269248d2011-08-02 10:26:54 -07001803 * Set extra options that will influence the UI for this window.
1804 * @param uiOptions Flags specifying extra options for this window.
1805 */
1806 public void setUiOptions(int uiOptions) { }
Adam Powelle43fca92011-08-16 12:57:01 -07001807
1808 /**
1809 * Set extra options that will influence the UI for this window.
1810 * Only the bits filtered by mask will be modified.
1811 * @param uiOptions Flags specifying extra options for this window.
1812 * @param mask Flags specifying which options should be modified. Others will remain unchanged.
1813 */
1814 public void setUiOptions(int uiOptions, int mask) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001815
1816 /**
1817 * Set the primary icon for this window.
1818 *
1819 * @param resId resource ID of a drawable to set
1820 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001821 public void setIcon(@DrawableRes int resId) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001822
1823 /**
1824 * Set the default icon for this window.
1825 * This will be overridden by any other icon set operation which could come from the
1826 * theme or another explicit set.
1827 *
1828 * @hide
1829 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001830 public void setDefaultIcon(@DrawableRes int resId) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001831
1832 /**
1833 * Set the logo for this window. A logo is often shown in place of an
1834 * {@link #setIcon(int) icon} but is generally wider and communicates window title information
1835 * as well.
1836 *
1837 * @param resId resource ID of a drawable to set
1838 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001839 public void setLogo(@DrawableRes int resId) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001840
1841 /**
1842 * Set the default logo for this window.
1843 * This will be overridden by any other logo set operation which could come from the
1844 * theme or another explicit set.
1845 *
1846 * @hide
1847 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001848 public void setDefaultLogo(@DrawableRes int resId) { }
keunyoung30f420f2013-08-02 14:23:10 -07001849
1850 /**
1851 * Set focus locally. The window should have the
1852 * {@link WindowManager.LayoutParams#FLAG_LOCAL_FOCUS_MODE} flag set already.
1853 * @param hasFocus Whether this window has focus or not.
1854 * @param inTouchMode Whether this window is in touch mode or not.
1855 */
1856 public void setLocalFocus(boolean hasFocus, boolean inTouchMode) { }
1857
1858 /**
1859 * Inject an event to window locally.
1860 * @param event A key or touch event to inject to this window.
1861 */
1862 public void injectInputEvent(InputEvent event) { }
Adam Powellcfbe9be2013-11-06 14:58:58 -08001863
1864 /**
1865 * Retrieve the {@link TransitionManager} responsible for for default transitions
1866 * in this window. Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1867 *
1868 * <p>This method will return non-null after content has been initialized (e.g. by using
1869 * {@link #setContentView}) if {@link #FEATURE_CONTENT_TRANSITIONS} has been granted.</p>
1870 *
1871 * @return This window's content TransitionManager or null if none is set.
George Mountc3a043c2015-02-04 14:37:04 -08001872 * @attr ref android.R.styleable#Window_windowContentTransitionManager
Adam Powellcfbe9be2013-11-06 14:58:58 -08001873 */
1874 public TransitionManager getTransitionManager() {
1875 return null;
1876 }
1877
1878 /**
1879 * Set the {@link TransitionManager} to use for default transitions in this window.
1880 * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1881 *
1882 * @param tm The TransitionManager to use for scene changes.
George Mountc3a043c2015-02-04 14:37:04 -08001883 * @attr ref android.R.styleable#Window_windowContentTransitionManager
Adam Powellcfbe9be2013-11-06 14:58:58 -08001884 */
1885 public void setTransitionManager(TransitionManager tm) {
1886 throw new UnsupportedOperationException();
1887 }
1888
1889 /**
1890 * Retrieve the {@link Scene} representing this window's current content.
1891 * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1892 *
1893 * <p>This method will return null if the current content is not represented by a Scene.</p>
1894 *
1895 * @return Current Scene being shown or null
1896 */
1897 public Scene getContentScene() {
1898 return null;
1899 }
1900
1901 /**
George Mount31a21722014-03-24 17:44:36 -07001902 * Sets the Transition that will be used to move Views into the initial scene. The entering
1903 * Views will be those that are regular Views or ViewGroups that have
1904 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1905 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1906 * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
1907 * entering Views will remain unaffected.
George Mountc03da0e2014-08-22 17:04:02 -07001908 *
George Mount31a21722014-03-24 17:44:36 -07001909 * @param transition The Transition to use to move Views into the initial Scene.
George Mountc03da0e2014-08-22 17:04:02 -07001910 * @attr ref android.R.styleable#Window_windowEnterTransition
Adam Powellcfbe9be2013-11-06 14:58:58 -08001911 */
George Mount31a21722014-03-24 17:44:36 -07001912 public void setEnterTransition(Transition transition) {}
George Mount0a778ed2013-12-13 13:35:36 -08001913
1914 /**
George Mount68f96d82014-07-31 13:13:10 -07001915 * Sets the Transition that will be used to move Views out of the scene when the Window is
1916 * preparing to close, for example after a call to
1917 * {@link android.app.Activity#finishAfterTransition()}. The exiting
1918 * Views will be those that are regular Views or ViewGroups that have
1919 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1920 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1921 * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null,
1922 * entering Views will remain unaffected. If nothing is set, the default will be to
1923 * use the same value as set in {@link #setEnterTransition(android.transition.Transition)}.
George Mountc03da0e2014-08-22 17:04:02 -07001924 *
George Mount68f96d82014-07-31 13:13:10 -07001925 * @param transition The Transition to use to move Views out of the Scene when the Window
1926 * is preparing to close.
George Mountc03da0e2014-08-22 17:04:02 -07001927 * @attr ref android.R.styleable#Window_windowReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07001928 */
1929 public void setReturnTransition(Transition transition) {}
1930
1931 /**
George Mount31a21722014-03-24 17:44:36 -07001932 * Sets the Transition that will be used to move Views out of the scene when starting a
1933 * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
1934 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1935 * {@link android.transition.Visibility} as exiting is governed by changing visibility
1936 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
George Mount9826f632014-09-11 08:50:09 -07001937 * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001938 *
George Mount31a21722014-03-24 17:44:36 -07001939 * @param transition The Transition to use to move Views out of the scene when calling a
1940 * new Activity.
George Mountc03da0e2014-08-22 17:04:02 -07001941 * @attr ref android.R.styleable#Window_windowExitTransition
George Mount0a778ed2013-12-13 13:35:36 -08001942 */
George Mount31a21722014-03-24 17:44:36 -07001943 public void setExitTransition(Transition transition) {}
George Mount0a778ed2013-12-13 13:35:36 -08001944
1945 /**
George Mount68f96d82014-07-31 13:13:10 -07001946 * Sets the Transition that will be used to move Views in to the scene when returning from
1947 * a previously-started Activity. The entering Views will be those that are regular Views
1948 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
1949 * will extend {@link android.transition.Visibility} as exiting is governed by changing
1950 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null,
1951 * the views will remain unaffected. If nothing is set, the default will be to use the same
1952 * transition as {@link #setExitTransition(android.transition.Transition)}.
George Mount9826f632014-09-11 08:50:09 -07001953 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001954 *
George Mount68f96d82014-07-31 13:13:10 -07001955 * @param transition The Transition to use to move Views into the scene when reentering from a
1956 * previously-started Activity.
George Mountc03da0e2014-08-22 17:04:02 -07001957 * @attr ref android.R.styleable#Window_windowReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07001958 */
1959 public void setReenterTransition(Transition transition) {}
1960
1961 /**
George Mount31a21722014-03-24 17:44:36 -07001962 * Returns the transition used to move Views into the initial scene. The entering
1963 * Views will be those that are regular Views or ViewGroups that have
1964 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1965 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1966 * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
George Mount9826f632014-09-11 08:50:09 -07001967 * entering Views will remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mount31a21722014-03-24 17:44:36 -07001968 *
1969 * @return the Transition to use to move Views into the initial Scene.
George Mountc03da0e2014-08-22 17:04:02 -07001970 * @attr ref android.R.styleable#Window_windowEnterTransition
George Mount0a778ed2013-12-13 13:35:36 -08001971 */
George Mount31a21722014-03-24 17:44:36 -07001972 public Transition getEnterTransition() { return null; }
George Mountcb4b7d92014-02-25 10:47:55 -08001973
1974 /**
Chet Haaseb64e777f2016-12-09 07:17:10 -08001975 * Returns the Transition that will be used to move Views out of the scene when the Window is
George Mount68f96d82014-07-31 13:13:10 -07001976 * preparing to close, for example after a call to
1977 * {@link android.app.Activity#finishAfterTransition()}. The exiting
1978 * Views will be those that are regular Views or ViewGroups that have
1979 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1980 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1981 * {@link View#VISIBLE} to {@link View#INVISIBLE}.
George Mountc03da0e2014-08-22 17:04:02 -07001982 *
George Mount68f96d82014-07-31 13:13:10 -07001983 * @return The Transition to use to move Views out of the Scene when the Window
1984 * is preparing to close.
George Mountc03da0e2014-08-22 17:04:02 -07001985 * @attr ref android.R.styleable#Window_windowReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07001986 */
1987 public Transition getReturnTransition() { return null; }
1988
1989 /**
George Mount31a21722014-03-24 17:44:36 -07001990 * Returns the Transition that will be used to move Views out of the scene when starting a
1991 * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
1992 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1993 * {@link android.transition.Visibility} as exiting is governed by changing visibility
1994 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
George Mount9826f632014-09-11 08:50:09 -07001995 * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001996 *
George Mount31a21722014-03-24 17:44:36 -07001997 * @return the Transition to use to move Views out of the scene when calling a
1998 * new Activity.
George Mountc03da0e2014-08-22 17:04:02 -07001999 * @attr ref android.R.styleable#Window_windowExitTransition
George Mountcb4b7d92014-02-25 10:47:55 -08002000 */
George Mount31a21722014-03-24 17:44:36 -07002001 public Transition getExitTransition() { return null; }
George Mount0a778ed2013-12-13 13:35:36 -08002002
2003 /**
George Mount68f96d82014-07-31 13:13:10 -07002004 * Returns the Transition that will be used to move Views in to the scene when returning from
2005 * a previously-started Activity. The entering Views will be those that are regular Views
2006 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
2007 * will extend {@link android.transition.Visibility} as exiting is governed by changing
2008 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}.
George Mount9826f632014-09-11 08:50:09 -07002009 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002010 *
George Mount68f96d82014-07-31 13:13:10 -07002011 * @return The Transition to use to move Views into the scene when reentering from a
2012 * previously-started Activity.
George Mountc03da0e2014-08-22 17:04:02 -07002013 * @attr ref android.R.styleable#Window_windowReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07002014 */
2015 public Transition getReenterTransition() { return null; }
2016
2017 /**
George Mount31a21722014-03-24 17:44:36 -07002018 * Sets the Transition that will be used for shared elements transferred into the content
2019 * Scene. Typical Transitions will affect size and location, such as
George Mount990205e2014-06-24 09:36:18 -07002020 * {@link android.transition.ChangeBounds}. A null
George Mount31a21722014-03-24 17:44:36 -07002021 * value will cause transferred shared elements to blink to the final position.
George Mount9826f632014-09-11 08:50:09 -07002022 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002023 *
George Mount31a21722014-03-24 17:44:36 -07002024 * @param transition The Transition to use for shared elements transferred into the content
2025 * Scene.
George Mountc03da0e2014-08-22 17:04:02 -07002026 * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
George Mount0a778ed2013-12-13 13:35:36 -08002027 */
George Mount31a21722014-03-24 17:44:36 -07002028 public void setSharedElementEnterTransition(Transition transition) {}
George Mounte1803372014-02-26 19:00:52 +00002029
2030 /**
George Mount68f96d82014-07-31 13:13:10 -07002031 * Sets the Transition that will be used for shared elements transferred back to a
2032 * calling Activity. Typical Transitions will affect size and location, such as
2033 * {@link android.transition.ChangeBounds}. A null
2034 * value will cause transferred shared elements to blink to the final position.
2035 * If no value is set, the default will be to use the same value as
2036 * {@link #setSharedElementEnterTransition(android.transition.Transition)}.
George Mount9826f632014-09-11 08:50:09 -07002037 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002038 *
George Mount68f96d82014-07-31 13:13:10 -07002039 * @param transition The Transition to use for shared elements transferred out of the content
2040 * Scene.
George Mountc03da0e2014-08-22 17:04:02 -07002041 * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07002042 */
2043 public void setSharedElementReturnTransition(Transition transition) {}
2044
2045 /**
George Mount31a21722014-03-24 17:44:36 -07002046 * Returns the Transition that will be used for shared elements transferred into the content
George Mount9826f632014-09-11 08:50:09 -07002047 * Scene. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002048 *
George Mount31a21722014-03-24 17:44:36 -07002049 * @return Transition to use for sharend elements transferred into the content Scene.
George Mountc03da0e2014-08-22 17:04:02 -07002050 * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
George Mountcb4b7d92014-02-25 10:47:55 -08002051 */
George Mount31a21722014-03-24 17:44:36 -07002052 public Transition getSharedElementEnterTransition() { return null; }
George Mountcb4b7d92014-02-25 10:47:55 -08002053
2054 /**
George Mount68f96d82014-07-31 13:13:10 -07002055 * Returns the Transition that will be used for shared elements transferred back to a
George Mount9826f632014-09-11 08:50:09 -07002056 * calling Activity. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002057 *
George Mount68f96d82014-07-31 13:13:10 -07002058 * @return Transition to use for sharend elements transferred into the content Scene.
George Mountc03da0e2014-08-22 17:04:02 -07002059 * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07002060 */
2061 public Transition getSharedElementReturnTransition() { return null; }
2062
2063 /**
George Mount31a21722014-03-24 17:44:36 -07002064 * Sets the Transition that will be used for shared elements after starting a new Activity
2065 * before the shared elements are transferred to the called Activity. If the shared elements
2066 * must animate during the exit transition, this Transition should be used. Upon completion,
2067 * the shared elements may be transferred to the started Activity.
George Mount9826f632014-09-11 08:50:09 -07002068 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002069 *
George Mount31a21722014-03-24 17:44:36 -07002070 * @param transition The Transition to use for shared elements in the launching Window
2071 * prior to transferring to the launched Activity's Window.
George Mountc03da0e2014-08-22 17:04:02 -07002072 * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
George Mounte1803372014-02-26 19:00:52 +00002073 */
George Mount31a21722014-03-24 17:44:36 -07002074 public void setSharedElementExitTransition(Transition transition) {}
2075
2076 /**
George Mount68f96d82014-07-31 13:13:10 -07002077 * Sets the Transition that will be used for shared elements reentering from a started
2078 * Activity after it has returned the shared element to it start location. If no value
2079 * is set, this will default to
2080 * {@link #setSharedElementExitTransition(android.transition.Transition)}.
George Mount9826f632014-09-11 08:50:09 -07002081 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002082 *
George Mount68f96d82014-07-31 13:13:10 -07002083 * @param transition The Transition to use for shared elements in the launching Window
2084 * after the shared element has returned to the Window.
George Mountc03da0e2014-08-22 17:04:02 -07002085 * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07002086 */
2087 public void setSharedElementReenterTransition(Transition transition) {}
2088
2089 /**
George Mount31a21722014-03-24 17:44:36 -07002090 * Returns the Transition to use for shared elements in the launching Window prior
2091 * to transferring to the launched Activity's Window.
George Mount9826f632014-09-11 08:50:09 -07002092 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mount31a21722014-03-24 17:44:36 -07002093 *
2094 * @return the Transition to use for shared elements in the launching Window prior
2095 * to transferring to the launched Activity's Window.
George Mountc03da0e2014-08-22 17:04:02 -07002096 * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
George Mount31a21722014-03-24 17:44:36 -07002097 */
2098 public Transition getSharedElementExitTransition() { return null; }
2099
2100 /**
George Mount68f96d82014-07-31 13:13:10 -07002101 * Returns the Transition that will be used for shared elements reentering from a started
2102 * Activity after it has returned the shared element to it start location.
George Mount9826f632014-09-11 08:50:09 -07002103 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mount68f96d82014-07-31 13:13:10 -07002104 *
2105 * @return 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.
George Mountc03da0e2014-08-22 17:04:02 -07002107 * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07002108 */
2109 public Transition getSharedElementReenterTransition() { return null; }
2110
2111 /**
George Mount31a21722014-03-24 17:44:36 -07002112 * Controls how the transition set in
2113 * {@link #setEnterTransition(android.transition.Transition)} overlaps with the exit
2114 * transition of the calling Activity. When true, the transition will start as soon as possible.
2115 * When false, the transition will wait until the remote exiting transition completes before
George Mount5d52d312016-06-10 14:16:45 -07002116 * starting. The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002117 *
George Mount31a21722014-03-24 17:44:36 -07002118 * @param allow true to start the enter transition when possible or false to
2119 * wait until the exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002120 * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002121 */
2122 public void setAllowEnterTransitionOverlap(boolean allow) {}
2123
2124 /**
2125 * Returns how the transition set in
2126 * {@link #setEnterTransition(android.transition.Transition)} overlaps with the exit
2127 * transition of the calling Activity. When true, the transition will start as soon as possible.
2128 * When false, the transition will wait until the remote exiting transition completes before
George Mount5d52d312016-06-10 14:16:45 -07002129 * starting. The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002130 *
George Mount31a21722014-03-24 17:44:36 -07002131 * @return true when the enter transition should start as soon as possible or false to
2132 * when it should wait until the exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002133 * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002134 */
2135 public boolean getAllowEnterTransitionOverlap() { return true; }
2136
2137 /**
2138 * Controls how the transition set in
2139 * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
2140 * transition of the called Activity when reentering after if finishes. When true,
2141 * the transition will start as soon as possible. When false, the transition will wait
2142 * until the called Activity's exiting transition completes before starting.
George Mount5d52d312016-06-10 14:16:45 -07002143 * The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002144 *
George Mount31a21722014-03-24 17:44:36 -07002145 * @param allow true to start the transition when possible or false to wait until the
2146 * called Activity's exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002147 * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002148 */
George Mountc03da0e2014-08-22 17:04:02 -07002149 public void setAllowReturnTransitionOverlap(boolean allow) {}
2150
2151 /**
George Mount31a21722014-03-24 17:44:36 -07002152 * Returns how the transition set in
2153 * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
2154 * transition of the called Activity when reentering after if finishes. When true,
2155 * the transition will start as soon as possible. When false, the transition will wait
2156 * until the called Activity's exiting transition completes before starting.
George Mount5d52d312016-06-10 14:16:45 -07002157 * The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002158 *
George Mount31a21722014-03-24 17:44:36 -07002159 * @return true when the transition should start when possible or false when it should wait
2160 * until the called Activity's exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002161 * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002162 */
George Mountc03da0e2014-08-22 17:04:02 -07002163 public boolean getAllowReturnTransitionOverlap() { return true; }
2164
2165 /**
George Mounted1e01d2014-06-05 13:49:12 -07002166 * Returns the duration, in milliseconds, of the window background fade
2167 * when transitioning into or away from an Activity when called with an Activity Transition.
2168 * <p>When executing the enter transition, the background starts transparent
George Mount9826f632014-09-11 08:50:09 -07002169 * and fades in. This requires {@link #FEATURE_ACTIVITY_TRANSITIONS}. The default is
George Mounted1e01d2014-06-05 13:49:12 -07002170 * 300 milliseconds.</p>
George Mountc03da0e2014-08-22 17:04:02 -07002171 *
George Mounted1e01d2014-06-05 13:49:12 -07002172 * @return The duration of the window background fade to opaque during enter transition.
2173 * @see #getEnterTransition()
George Mountc03da0e2014-08-22 17:04:02 -07002174 * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
George Mounted1e01d2014-06-05 13:49:12 -07002175 */
2176 public long getTransitionBackgroundFadeDuration() { return 0; }
2177
2178 /**
2179 * Sets the duration, in milliseconds, of the window background fade
2180 * when transitioning into or away from an Activity when called with an Activity Transition.
2181 * <p>When executing the enter transition, the background starts transparent
George Mount9826f632014-09-11 08:50:09 -07002182 * and fades in. This requires {@link #FEATURE_ACTIVITY_TRANSITIONS}. The default is
George Mounted1e01d2014-06-05 13:49:12 -07002183 * 300 milliseconds.</p>
George Mountc03da0e2014-08-22 17:04:02 -07002184 *
George Mounted1e01d2014-06-05 13:49:12 -07002185 * @param fadeDurationMillis The duration of the window background fade to or from opaque
2186 * during enter transition.
2187 * @see #setEnterTransition(android.transition.Transition)
George Mountc03da0e2014-08-22 17:04:02 -07002188 * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
George Mounted1e01d2014-06-05 13:49:12 -07002189 */
2190 public void setTransitionBackgroundFadeDuration(long fadeDurationMillis) { }
2191
2192 /**
George Mountb89d5cc2014-08-18 16:50:50 -07002193 * Returns <code>true</code> when shared elements should use an Overlay during
2194 * shared element transitions or <code>false</code> when they should animate as
2195 * part of the normal View hierarchy. The default value is true.
2196 *
2197 * @return <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.
George Mountc03da0e2014-08-22 17:04:02 -07002200 * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
George Mountb89d5cc2014-08-18 16:50:50 -07002201 */
2202 public boolean getSharedElementsUseOverlay() { return true; }
2203
2204 /**
2205 * Sets whether or not shared elements should use an Overlay during shared element transitions.
2206 * The default value is true.
2207 *
2208 * @param sharedElementsUseOverlay <code>true</code> indicates that shared elements should
2209 * be transitioned with an Overlay or <code>false</code>
2210 * to transition within the normal View hierarchy.
George Mountc03da0e2014-08-22 17:04:02 -07002211 * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
George Mountb89d5cc2014-08-18 16:50:50 -07002212 */
2213 public void setSharedElementsUseOverlay(boolean sharedElementsUseOverlay) { }
2214
2215 /**
Adrian Roos217ccd22014-05-09 14:29:04 +02002216 * @return the color of the status bar.
2217 */
Tor Norbye80756e32015-03-02 09:39:27 -08002218 @ColorInt
Adrian Roos217ccd22014-05-09 14:29:04 +02002219 public abstract int getStatusBarColor();
2220
2221 /**
John Spurlockbc4cf002015-03-24 21:51:20 -04002222 * Sets the color of the status bar to {@code color}.
Adrian Roos217ccd22014-05-09 14:29:04 +02002223 *
2224 * For this to take effect,
2225 * the window must be drawing the system bar backgrounds with
2226 * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2227 * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_STATUS} must not be set.
2228 *
John Spurlockbc4cf002015-03-24 21:51:20 -04002229 * If {@code color} is not opaque, consider setting
Adrian Roos217ccd22014-05-09 14:29:04 +02002230 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
2231 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
George Mount238010f2014-06-30 17:31:17 -07002232 * <p>
2233 * The transitionName for the view background will be "android:status:background".
2234 * </p>
Adrian Roos217ccd22014-05-09 14:29:04 +02002235 */
Tor Norbye80756e32015-03-02 09:39:27 -08002236 public abstract void setStatusBarColor(@ColorInt int color);
Adrian Roos217ccd22014-05-09 14:29:04 +02002237
2238 /**
2239 * @return the color of the navigation bar.
2240 */
Tor Norbye80756e32015-03-02 09:39:27 -08002241 @ColorInt
Adrian Roos217ccd22014-05-09 14:29:04 +02002242 public abstract int getNavigationBarColor();
2243
2244 /**
2245 * Sets the color of the navigation bar to {@param color}.
2246 *
2247 * For this to take effect,
2248 * the window must be drawing the system bar backgrounds with
2249 * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2250 * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_NAVIGATION} must not be set.
2251 *
2252 * If {@param color} is not opaque, consider setting
2253 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
2254 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}.
George Mount238010f2014-06-30 17:31:17 -07002255 * <p>
2256 * The transitionName for the view background will be "android:navigation:background".
2257 * </p>
Jorim Jaggia0b78d52018-01-22 19:01:42 +01002258 * @attr ref android.R.styleable#Window_navigationBarColor
Adrian Roos217ccd22014-05-09 14:29:04 +02002259 */
Tor Norbye80756e32015-03-02 09:39:27 -08002260 public abstract void setNavigationBarColor(@ColorInt int color);
Adrian Roos217ccd22014-05-09 14:29:04 +02002261
Jorim Jaggia0b78d52018-01-22 19:01:42 +01002262 /**
2263 * Shows a thin line of the specified color between the navigation bar and the app
2264 * content.
2265 * <p>
2266 * For this to take effect,
2267 * the window must be drawing the system bar backgrounds with
2268 * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2269 * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_NAVIGATION} must not be set.
2270 *
2271 * @param dividerColor The color of the thin line.
2272 * @attr ref android.R.styleable#Window_navigationBarDividerColor
2273 */
2274 public void setNavigationBarDividerColor(@ColorInt int dividerColor) {
2275 }
2276
2277 /**
2278 * Retrieves the color of the navigation bar divider.
2279 *
2280 * @return The color of the navigation bar divider color.
2281 * @see #setNavigationBarColor(int)
2282 * @attr ref android.R.styleable#Window_navigationBarDividerColor
2283 */
2284 public @ColorInt int getNavigationBarDividerColor() {
2285 return 0;
2286 }
2287
Filip Gruszczynski0daf2102015-09-29 08:39:07 -07002288 /** @hide */
2289 public void setTheme(int resId) {
2290 }
Filip Gruszczynski63250652015-11-18 14:43:01 -08002291
2292 /**
2293 * Whether the caption should be displayed directly on the content rather than push the content
2294 * down. This affects only freeform windows since they display the caption.
2295 * @hide
2296 */
Andrii Kulian933076d2016-03-29 17:04:42 -07002297 public void setOverlayWithDecorCaptionEnabled(boolean enabled) {
2298 mOverlayWithDecorCaptionEnabled = enabled;
Filip Gruszczynski63250652015-11-18 14:43:01 -08002299 }
2300
2301 /** @hide */
Andrii Kulian933076d2016-03-29 17:04:42 -07002302 public boolean isOverlayWithDecorCaptionEnabled() {
2303 return mOverlayWithDecorCaptionEnabled;
Filip Gruszczynski63250652015-11-18 14:43:01 -08002304 }
Filip Gruszczynski9b81e402015-12-08 15:42:01 -08002305
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002306 /** @hide */
2307 public void notifyRestrictedCaptionAreaCallback(int left, int top, int right, int bottom) {
Wale Ogunwalea504ca32016-01-30 16:02:13 -08002308 if (mOnRestrictedCaptionAreaChangedListener != null) {
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002309 mRestrictedCaptionAreaRect.set(left, top, right, bottom);
Wale Ogunwalea504ca32016-01-30 16:02:13 -08002310 mOnRestrictedCaptionAreaChangedListener.onRestrictedCaptionAreaChanged(
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002311 mRestrictedCaptionAreaRect);
2312 }
2313 }
Filip Gruszczynski9b81e402015-12-08 15:42:01 -08002314
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002315 /**
2316 * Set what color should the caption controls be. By default the system will try to determine
Wale Ogunwalea504ca32016-01-30 16:02:13 -08002317 * the color from the theme. You can overwrite this by using {@link #DECOR_CAPTION_SHADE_DARK},
2318 * {@link #DECOR_CAPTION_SHADE_LIGHT}, or {@link #DECOR_CAPTION_SHADE_AUTO}.
2319 * @see #DECOR_CAPTION_SHADE_DARK
2320 * @see #DECOR_CAPTION_SHADE_LIGHT
2321 * @see #DECOR_CAPTION_SHADE_AUTO
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002322 */
2323 public abstract void setDecorCaptionShade(int decorCaptionShade);
2324
2325 /**
2326 * Set the drawable that is drawn underneath the caption during the resizing.
2327 *
2328 * During the resizing the caption might not be drawn fast enough to match the new dimensions.
2329 * There is a second caption drawn underneath it that will be fast enough. By default the
2330 * caption is constructed from the theme. You can provide a drawable, that will be drawn instead
2331 * to better match your application.
2332 */
2333 public abstract void setResizingCaptionDrawable(Drawable drawable);
Wale Ogunwaleeb6722c2015-12-08 11:43:43 -08002334
2335 /**
2336 * Called when the activity changes from fullscreen mode to multi-window mode and visa-versa.
2337 * @hide
2338 */
Andrii Kulian933076d2016-03-29 17:04:42 -07002339 public abstract void onMultiWindowModeChanged();
Jorim Jaggi4846ee32016-01-07 17:39:12 +01002340
2341 /**
Winson Chung4d8681f2017-05-23 16:22:08 -07002342 * Called when the activity changes to/from picture-in-picture mode.
2343 * @hide
2344 */
2345 public abstract void onPictureInPictureModeChanged(boolean isInPictureInPictureMode);
2346
2347 /**
Jorim Jaggi4846ee32016-01-07 17:39:12 +01002348 * Called when the activity just relaunched.
2349 * @hide
2350 */
2351 public abstract void reportActivityRelaunched();
Michael Kwanf7964be2016-11-30 16:44:33 -08002352
2353 /**
2354 * Called to set flag to check if the close on swipe is enabled. This will only function if
2355 * FEATURE_SWIPE_TO_DISMISS has been set.
2356 * @hide
2357 */
2358 public void setCloseOnSwipeEnabled(boolean closeOnSwipeEnabled) {
2359 mCloseOnSwipeEnabled = closeOnSwipeEnabled;
2360 }
2361
2362 /**
2363 * @return {@code true} if the close on swipe is enabled.
2364 * @hide
2365 */
2366 public boolean isCloseOnSwipeEnabled() {
2367 return mCloseOnSwipeEnabled;
2368 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002369}