blob: 0053caa782782a0487be9710ab58ace308fadfd8 [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;
Filip Gruszczynskife568352015-01-05 10:41:29 -080028import android.annotation.SystemApi;
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;
Romain Guy9622e202011-09-29 16:37:27 -070043import android.os.SystemProperties;
Adam Powellcfbe9be2013-11-06 14:58:58 -080044import android.transition.Scene;
George Mounte1803372014-02-26 19:00:52 +000045import android.transition.Transition;
Adam Powellcfbe9be2013-11-06 14:58:58 -080046import android.transition.TransitionManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070047import android.view.accessibility.AccessibilityEvent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080048
Clara Bayarri75e09792015-07-29 16:20:40 +010049import java.util.List;
50
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080051/**
52 * Abstract base class for a top-level window look and behavior policy. An
53 * instance of this class should be used as the top-level view added to the
54 * window manager. It provides standard UI policies such as a background, title
55 * area, default key processing, etc.
56 *
57 * <p>The only existing implementation of this abstract class is
Jorim Jaggib10e33f2015-02-04 21:57:40 +010058 * android.view.PhoneWindow, which you should instantiate when needing a
59 * Window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080060 */
61public abstract class Window {
62 /** Flag for the "options panel" feature. This is enabled by default. */
63 public static final int FEATURE_OPTIONS_PANEL = 0;
64 /** Flag for the "no title" feature, turning off the title at the top
65 * of the screen. */
66 public static final int FEATURE_NO_TITLE = 1;
Alan Viverette4aef7c82015-09-04 14:14:50 -040067
68 /**
69 * Flag for the progress indicator feature.
70 *
71 * @deprecated No longer supported starting in API 21.
72 */
73 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074 public static final int FEATURE_PROGRESS = 2;
Alan Viverette4aef7c82015-09-04 14:14:50 -040075
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080076 /** Flag for having an icon on the left side of the title bar */
77 public static final int FEATURE_LEFT_ICON = 3;
78 /** Flag for having an icon on the right side of the title bar */
79 public static final int FEATURE_RIGHT_ICON = 4;
Alan Viverette4aef7c82015-09-04 14:14:50 -040080
81 /**
82 * Flag for indeterminate progress.
83 *
84 * @deprecated No longer supported starting in API 21.
85 */
86 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080087 public static final int FEATURE_INDETERMINATE_PROGRESS = 5;
Alan Viverette4aef7c82015-09-04 14:14:50 -040088
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089 /** Flag for the context menu. This is enabled by default. */
90 public static final int FEATURE_CONTEXT_MENU = 6;
91 /** Flag for custom title. You cannot combine this feature with other title features. */
92 public static final int FEATURE_CUSTOM_TITLE = 7;
Adam Powell33b97432010-04-20 10:01:14 -070093 /**
94 * Flag for enabling the Action Bar.
95 * This is enabled by default for some devices. The Action Bar
96 * replaces the title bar and provides an alternate location
97 * for an on-screen menu button on some devices.
98 */
Adam Powell5d279772010-07-27 16:34:07 -070099 public static final int FEATURE_ACTION_BAR = 8;
100 /**
Adam Powell6b336f82010-08-10 20:13:01 -0700101 * Flag for requesting an Action Bar that overlays window content.
102 * Normally an Action Bar will sit in the space above window content, but if this
103 * feature is requested along with {@link #FEATURE_ACTION_BAR} it will be layered over
104 * the window content itself. This is useful if you would like your app to have more control
105 * over how the Action Bar is displayed, such as letting application content scroll beneath
106 * an Action Bar with a transparent background or otherwise displaying a transparent/translucent
107 * Action Bar over application content.
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -0700108 *
109 * <p>This mode is especially useful with {@link View#SYSTEM_UI_FLAG_FULLSCREEN
110 * View.SYSTEM_UI_FLAG_FULLSCREEN}, which allows you to seamlessly hide the
111 * action bar in conjunction with other screen decorations.
112 *
113 * <p>As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, when an
114 * ActionBar is in this mode it will adjust the insets provided to
115 * {@link View#fitSystemWindows(android.graphics.Rect) View.fitSystemWindows(Rect)}
116 * to include the content covered by the action bar, so you can do layout within
117 * that space.
Adam Powell6b336f82010-08-10 20:13:01 -0700118 */
119 public static final int FEATURE_ACTION_BAR_OVERLAY = 9;
120 /**
Adam Powell5d279772010-07-27 16:34:07 -0700121 * Flag for specifying the behavior of action modes when an Action Bar is not present.
122 * If overlay is enabled, the action mode UI will be allowed to cover existing window content.
123 */
Adam Powell6b336f82010-08-10 20:13:01 -0700124 public static final int FEATURE_ACTION_MODE_OVERLAY = 10;
Adam Powell18e905f2013-10-24 14:27:48 -0700125 /**
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800126 * Flag for requesting a decoration-free window that is dismissed by swiping from the left.
127 */
128 public static final int FEATURE_SWIPE_TO_DISMISS = 11;
Will Haldean Brown568628d2014-03-04 15:25:43 -0800129 /**
George Mountc3a043c2015-02-04 14:37:04 -0800130 * Flag for requesting that window content changes should be animated using a
131 * TransitionManager.
Adam Powell18e905f2013-10-24 14:27:48 -0700132 *
George Mountc3a043c2015-02-04 14:37:04 -0800133 * <p>The TransitionManager is set using
134 * {@link #setTransitionManager(android.transition.TransitionManager)}. If none is set,
135 * a default TransitionManager will be used.</p>
Adam Powell18e905f2013-10-24 14:27:48 -0700136 *
137 * @see #setContentView
138 */
Will Haldean Brown568628d2014-03-04 15:25:43 -0800139 public static final int FEATURE_CONTENT_TRANSITIONS = 12;
Adam Powell4b6d93f2012-09-18 18:34:08 -0700140
141 /**
George Mount9826f632014-09-11 08:50:09 -0700142 * Enables Activities to run Activity Transitions either through sending or receiving
143 * ActivityOptions bundle created with
144 * {@link android.app.ActivityOptions#makeSceneTransitionAnimation(android.app.Activity,
145 * android.util.Pair[])} or {@link android.app.ActivityOptions#makeSceneTransitionAnimation(
146 * android.app.Activity, View, String)}.
147 */
148 public static final int FEATURE_ACTIVITY_TRANSITIONS = 13;
149
150 /**
Adam Powell4b6d93f2012-09-18 18:34:08 -0700151 * Max value used as a feature ID
152 * @hide
153 */
George Mount9826f632014-09-11 08:50:09 -0700154 public static final int FEATURE_MAX = FEATURE_ACTIVITY_TRANSITIONS;
Adam Powell4b6d93f2012-09-18 18:34:08 -0700155
Alan Viverette4aef7c82015-09-04 14:14:50 -0400156 /**
157 * Flag for setting the progress bar's visibility to VISIBLE.
158 *
159 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
160 * supported starting in API 21.
161 */
162 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800163 public static final int PROGRESS_VISIBILITY_ON = -1;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400164
165 /**
166 * Flag for setting the progress bar's visibility to GONE.
167 *
168 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
169 * supported starting in API 21.
170 */
171 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800172 public static final int PROGRESS_VISIBILITY_OFF = -2;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400173
174 /**
175 * Flag for setting the progress bar's indeterminate mode on.
176 *
177 * @deprecated {@link #FEATURE_INDETERMINATE_PROGRESS} and related methods
178 * are no longer supported starting in API 21.
179 */
180 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800181 public static final int PROGRESS_INDETERMINATE_ON = -3;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400182
183 /**
184 * Flag for setting the progress bar's indeterminate mode off.
185 *
186 * @deprecated {@link #FEATURE_INDETERMINATE_PROGRESS} and related methods
187 * are no longer supported starting in API 21.
188 */
189 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800190 public static final int PROGRESS_INDETERMINATE_OFF = -4;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400191
192 /**
193 * Starting value for the (primary) progress.
194 *
195 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
196 * supported starting in API 21.
197 */
198 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800199 public static final int PROGRESS_START = 0;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400200
201 /**
202 * Ending value for the (primary) progress.
203 *
204 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
205 * supported starting in API 21.
206 */
207 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800208 public static final int PROGRESS_END = 10000;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400209
210 /**
211 * Lowest possible value for the secondary progress.
212 *
213 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
214 * supported starting in API 21.
215 */
216 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800217 public static final int PROGRESS_SECONDARY_START = 20000;
Alan Viverette4aef7c82015-09-04 14:14:50 -0400218
219 /**
220 * Highest possible value for the secondary progress.
221 *
222 * @deprecated {@link #FEATURE_PROGRESS} and related methods are no longer
223 * supported starting in API 21.
224 */
225 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800226 public static final int PROGRESS_SECONDARY_END = 30000;
George Mount238010f2014-06-30 17:31:17 -0700227
228 /**
229 * The transitionName for the status bar background View when a custom background is used.
230 * @see android.view.Window#setStatusBarColor(int)
231 */
232 public static final String STATUS_BAR_BACKGROUND_TRANSITION_NAME = "android:status:background";
233
234 /**
235 * The transitionName for the navigation bar background View when a custom background is used.
236 * @see android.view.Window#setNavigationBarColor(int)
237 */
238 public static final String NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME =
239 "android:navigation:background";
240
Bryce Leeaa1008c2015-01-13 09:26:46 -0800241 /**
242 * The default features enabled.
243 * @deprecated use {@link #getDefaultFeatures(android.content.Context)} instead.
244 */
Bryce Leed6e6e722014-11-21 11:08:45 -0800245 @Deprecated
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800246 @SuppressWarnings({"PointlessBitwiseExpression"})
247 protected static final int DEFAULT_FEATURES = (1 << FEATURE_OPTIONS_PANEL) |
248 (1 << FEATURE_CONTEXT_MENU);
249
250 /**
251 * The ID that the main layout in the XML layout file should have.
252 */
253 public static final int ID_ANDROID_CONTENT = com.android.internal.R.id.content;
254
Jeff Brownd32460c2012-07-20 16:15:36 -0700255 private static final String PROPERTY_HARDWARE_UI = "persist.sys.ui.hw";
256
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800257 /**
258 * Flag for letting the theme drive the color of the window caption controls. Use with
259 * {@link #setDecorCaptionShade(int)}. This is the default value.
260 */
261 public static final int DECOR_CAPTION_SHADE_AUTO = 0;
262 /**
263 * Flag for setting light-color controls on the window caption. Use with
264 * {@link #setDecorCaptionShade(int)}.
265 */
266 public static final int DECOR_CAPTION_SHADE_LIGHT = 1;
267 /**
268 * Flag for setting dark-color controls on the window caption. Use with
269 * {@link #setDecorCaptionShade(int)}.
270 */
271 public static final int DECOR_CAPTION_SHADE_DARK = 2;
272
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800273 private final Context mContext;
RoboErik55011652014-07-09 15:05:53 -0700274
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800275 private TypedArray mWindowStyle;
276 private Callback mCallback;
Adam Powell117b6952014-05-05 18:14:56 -0700277 private OnWindowDismissedCallback mOnWindowDismissedCallback;
Michael Kwan67639a52016-12-16 12:38:10 -0800278 private OnWindowSwipeDismissedCallback mOnWindowSwipeDismissedCallback;
Skuhnece2faa52015-08-11 10:36:38 -0700279 private WindowControllerCallback mWindowControllerCallback;
Wale Ogunwalea504ca32016-01-30 16:02:13 -0800280 private OnRestrictedCaptionAreaChangedListener mOnRestrictedCaptionAreaChangedListener;
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800281 private Rect mRestrictedCaptionAreaRect;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800282 private WindowManager mWindowManager;
283 private IBinder mAppToken;
284 private String mAppName;
Jeff Brownd32460c2012-07-20 16:15:36 -0700285 private boolean mHardwareAccelerated;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800286 private Window mContainer;
287 private Window mActiveChild;
288 private boolean mIsActive = false;
289 private boolean mHasChildren = false;
Dianne Hackborncfaf8872011-01-18 13:57:54 -0800290 private boolean mCloseOnTouchOutside = false;
291 private boolean mSetCloseOnTouchOutside = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800292 private int mForcedWindowFlags = 0;
293
Bryce Leed6e6e722014-11-21 11:08:45 -0800294 private int mFeatures;
295 private int mLocalFeatures;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800296
297 private boolean mHaveWindowFormat = false;
Dianne Hackborn661cd522011-08-22 00:26:20 -0700298 private boolean mHaveDimAmount = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800299 private int mDefaultWindowFormat = PixelFormat.OPAQUE;
300
301 private boolean mHasSoftInputMode = false;
RoboErik55011652014-07-09 15:05:53 -0700302
Dianne Hackborn291905e2010-08-17 15:17:15 -0700303 private boolean mDestroyed;
304
Andrii Kulian933076d2016-03-29 17:04:42 -0700305 private boolean mOverlayWithDecorCaptionEnabled = false;
Michael Kwanf7964be2016-11-30 16:44:33 -0800306 private boolean mCloseOnSwipeEnabled = false;
Filip Gruszczynski63250652015-11-18 14:43:01 -0800307
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800308 // The current window attributes.
309 private final WindowManager.LayoutParams mWindowAttributes =
310 new WindowManager.LayoutParams();
311
312 /**
313 * API from a Window back to its caller. This allows the client to
314 * intercept key dispatching, panels and menus, etc.
315 */
316 public interface Callback {
317 /**
318 * Called to process key events. At the very least your
319 * implementation must call
320 * {@link android.view.Window#superDispatchKeyEvent} to do the
321 * standard key processing.
322 *
323 * @param event The key event.
324 *
325 * @return boolean Return true if this event was consumed.
326 */
327 public boolean dispatchKeyEvent(KeyEvent event);
328
329 /**
Jeff Brown64da12a2011-01-04 19:57:47 -0800330 * Called to process a key shortcut event.
331 * At the very least your implementation must call
332 * {@link android.view.Window#superDispatchKeyShortcutEvent} to do the
333 * standard key shortcut processing.
334 *
335 * @param event The key shortcut event.
336 * @return True if this event was consumed.
337 */
338 public boolean dispatchKeyShortcutEvent(KeyEvent event);
339
340 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800341 * Called to process touch screen events. At the very least your
342 * implementation must call
343 * {@link android.view.Window#superDispatchTouchEvent} to do the
344 * standard touch screen processing.
345 *
346 * @param event The touch screen event.
347 *
348 * @return boolean Return true if this event was consumed.
349 */
350 public boolean dispatchTouchEvent(MotionEvent event);
RoboErik55011652014-07-09 15:05:53 -0700351
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800352 /**
353 * Called to process trackball events. At the very least your
354 * implementation must call
355 * {@link android.view.Window#superDispatchTrackballEvent} to do the
356 * standard trackball processing.
357 *
358 * @param event The trackball event.
359 *
360 * @return boolean Return true if this event was consumed.
361 */
362 public boolean dispatchTrackballEvent(MotionEvent event);
svetoslavganov75986cf2009-05-14 22:28:01 -0700363
364 /**
Jeff Browncb1404e2011-01-15 18:14:15 -0800365 * Called to process generic motion events. At the very least your
366 * implementation must call
367 * {@link android.view.Window#superDispatchGenericMotionEvent} to do the
368 * standard processing.
369 *
370 * @param event The generic motion event.
371 *
372 * @return boolean Return true if this event was consumed.
373 */
374 public boolean dispatchGenericMotionEvent(MotionEvent event);
375
376 /**
svetoslavganov75986cf2009-05-14 22:28:01 -0700377 * Called to process population of {@link AccessibilityEvent}s.
378 *
379 * @param event The event.
380 *
381 * @return boolean Return true if event population was completed.
382 */
383 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event);
384
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800385 /**
386 * Instantiate the view to display in the panel for 'featureId'.
387 * You can return null, in which case the default content (typically
388 * a menu) will be created for you.
389 *
390 * @param featureId Which panel is being created.
391 *
392 * @return view The top-level view to place in the panel.
393 *
394 * @see #onPreparePanel
395 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700396 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800397 public View onCreatePanelView(int featureId);
398
399 /**
400 * Initialize the contents of the menu for panel 'featureId'. This is
401 * called if onCreatePanelView() returns null, giving you a standard
402 * menu in which you can place your items. It is only called once for
403 * the panel, the first time it is shown.
404 *
405 * <p>You can safely hold on to <var>menu</var> (and any items created
406 * from it), making modifications to it as desired, until the next
407 * time onCreatePanelMenu() is called for this feature.
408 *
409 * @param featureId The panel being created.
410 * @param menu The menu inside the panel.
411 *
412 * @return boolean You must return true for the panel to be displayed;
413 * if you return false it will not be shown.
414 */
415 public boolean onCreatePanelMenu(int featureId, Menu menu);
416
417 /**
418 * Prepare a panel to be displayed. This is called right before the
419 * panel window is shown, every time it is shown.
420 *
421 * @param featureId The panel that is being displayed.
422 * @param view The View that was returned by onCreatePanelView().
423 * @param menu If onCreatePanelView() returned null, this is the Menu
424 * being displayed in the panel.
425 *
426 * @return boolean You must return true for the panel to be displayed;
427 * if you return false it will not be shown.
428 *
429 * @see #onCreatePanelView
430 */
431 public boolean onPreparePanel(int featureId, View view, Menu menu);
432
433 /**
434 * Called when a panel's menu is opened by the user. This may also be
435 * called when the menu is changing from one type to another (for
436 * example, from the icon menu to the expanded menu).
RoboErik55011652014-07-09 15:05:53 -0700437 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800438 * @param featureId The panel that the menu is in.
439 * @param menu The menu that is opened.
440 * @return Return true to allow the menu to open, or false to prevent
441 * the menu from opening.
442 */
443 public boolean onMenuOpened(int featureId, Menu menu);
RoboErik55011652014-07-09 15:05:53 -0700444
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800445 /**
446 * Called when a panel's menu item has been selected by the user.
447 *
448 * @param featureId The panel that the menu is in.
449 * @param item The menu item that was selected.
450 *
451 * @return boolean Return true to finish processing of selection, or
452 * false to perform the normal menu handling (calling its
453 * Runnable or sending a Message to its target Handler).
454 */
455 public boolean onMenuItemSelected(int featureId, MenuItem item);
456
457 /**
458 * This is called whenever the current window attributes change.
459 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800460 */
461 public void onWindowAttributesChanged(WindowManager.LayoutParams attrs);
462
463 /**
464 * This hook is called whenever the content view of the screen changes
465 * (due to a call to
466 * {@link Window#setContentView(View, android.view.ViewGroup.LayoutParams)
467 * Window.setContentView} or
468 * {@link Window#addContentView(View, android.view.ViewGroup.LayoutParams)
469 * Window.addContentView}).
470 */
471 public void onContentChanged();
472
473 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700474 * This hook is called whenever the window focus changes. See
475 * {@link View#onWindowFocusChanged(boolean)
Svetoslav3a0d8782014-12-04 12:50:11 -0800476 * View.onWindowFocusChangedNotLocked(boolean)} for more information.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800477 *
478 * @param hasFocus Whether the window now has focus.
479 */
480 public void onWindowFocusChanged(boolean hasFocus);
481
482 /**
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700483 * Called when the window has been attached to the window manager.
484 * See {@link View#onAttachedToWindow() View.onAttachedToWindow()}
485 * for more information.
486 */
487 public void onAttachedToWindow();
RoboErik55011652014-07-09 15:05:53 -0700488
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700489 /**
490 * Called when the window has been attached to the window manager.
491 * See {@link View#onDetachedFromWindow() View.onDetachedFromWindow()}
492 * for more information.
493 */
494 public void onDetachedFromWindow();
RoboErik55011652014-07-09 15:05:53 -0700495
Dianne Hackborn3be63c02009-08-20 19:31:38 -0700496 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800497 * Called when a panel is being closed. If another logical subsequent
498 * panel is being opened (and this panel is being closed to make room for the subsequent
499 * panel), this method will NOT be called.
RoboErik55011652014-07-09 15:05:53 -0700500 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800501 * @param featureId The panel that is being displayed.
502 * @param menu If onCreatePanelView() returned null, this is the Menu
503 * being displayed in the panel.
504 */
505 public void onPanelClosed(int featureId, Menu menu);
RoboErik55011652014-07-09 15:05:53 -0700506
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 /**
508 * Called when the user signals the desire to start a search.
RoboErik55011652014-07-09 15:05:53 -0700509 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800510 * @return true if search launched, false if activity refuses (blocks)
RoboErik55011652014-07-09 15:05:53 -0700511 *
512 * @see android.app.Activity#onSearchRequested()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800513 */
514 public boolean onSearchRequested();
Adam Powell6e346362010-07-23 10:18:23 -0700515
516 /**
Tim Kilbourn6a975b32015-04-09 17:14:34 -0700517 * Called when the user signals the desire to start a search.
518 *
519 * @param searchEvent A {@link SearchEvent} describing the signal to
520 * start a search.
521 * @return true if search launched, false if activity refuses (blocks)
522 */
523 public boolean onSearchRequested(SearchEvent searchEvent);
524
525 /**
Adam Powelldebf3be2010-11-15 18:58:48 -0800526 * Called when an action mode is being started for this window. Gives the
527 * callback an opportunity to handle the action mode in its own unique and
528 * beautiful way. If this method returns null the system can choose a way
Clara Bayarri4423d912015-03-02 19:42:48 +0000529 * to present the mode or choose not to start the mode at all. This is equivalent
530 * to {@link #onWindowStartingActionMode(android.view.ActionMode.Callback, int)}
531 * with type {@link ActionMode#TYPE_PRIMARY}.
Adam Powell6e346362010-07-23 10:18:23 -0700532 *
533 * @param callback Callback to control the lifecycle of this action mode
Adam Powelldebf3be2010-11-15 18:58:48 -0800534 * @return The ActionMode that was started, or null if the system should present it
Adam Powell6e346362010-07-23 10:18:23 -0700535 */
Tor Norbyed9273d62013-05-30 15:59:53 -0700536 @Nullable
Adam Powelldebf3be2010-11-15 18:58:48 -0800537 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback);
538
539 /**
Clara Bayarri4423d912015-03-02 19:42:48 +0000540 * Called when an action mode is being started for this window. Gives the
541 * callback an opportunity to handle the action mode in its own unique and
542 * beautiful way. If this method returns null the system can choose a way
543 * to present the mode or choose not to start the mode at all.
544 *
545 * @param callback Callback to control the lifecycle of this action mode
546 * @param type One of {@link ActionMode#TYPE_PRIMARY} or {@link ActionMode#TYPE_FLOATING}.
547 * @return The ActionMode that was started, or null if the system should present it
548 */
549 @Nullable
550 public ActionMode onWindowStartingActionMode(ActionMode.Callback callback, int type);
551
552 /**
Adam Powelldebf3be2010-11-15 18:58:48 -0800553 * Called when an action mode has been started. The appropriate mode callback
554 * method will have already been invoked.
555 *
556 * @param mode The new mode that has just been started.
557 */
558 public void onActionModeStarted(ActionMode mode);
559
560 /**
561 * Called when an action mode has been finished. The appropriate mode callback
562 * method will have already been invoked.
563 *
564 * @param mode The mode that was just finished.
565 */
566 public void onActionModeFinished(ActionMode mode);
Clara Bayarri75e09792015-07-29 16:20:40 +0100567
568 /**
569 * Called when Keyboard Shortcuts are requested for the current window.
570 *
571 * @param data The data list to populate with shortcuts.
572 * @param menu The current menu, which may be null.
Clara Bayarrifcd7e802016-03-10 12:58:18 +0000573 * @param deviceId The id for the connected device the shortcuts should be provided for.
Clara Bayarri75e09792015-07-29 16:20:40 +0100574 */
Sunny Goyal2a6d9aa2016-03-16 17:12:46 -0700575 default public void onProvideKeyboardShortcuts(
Clara Bayarrifcd7e802016-03-10 12:58:18 +0000576 List<KeyboardShortcutGroup> data, @Nullable Menu menu, int deviceId) { };
Vladislav Kaznacheev3787de12016-12-21 10:36:35 -0800577
578 /**
579 * Called when pointer capture is enabled or disabled for the current window.
580 *
581 * @param hasCapture True if the window has pointer capture.
582 */
583 default public void onPointerCaptureChanged(boolean hasCapture) { };
Adam Powell117b6952014-05-05 18:14:56 -0700584 }
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800585
Adam Powell117b6952014-05-05 18:14:56 -0700586 /** @hide */
587 public interface OnWindowDismissedCallback {
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800588 /**
589 * Called when a window is dismissed. This informs the callback that the
590 * window is gone, and it should finish itself.
Wale Ogunwaleba7881c2015-08-01 19:28:29 -0700591 * @param finishTask True if the task should also be finished.
Ned Burns7d6cb912016-12-02 17:25:33 -0500592 * @param suppressWindowTransition True if the resulting exit and enter window transition
593 * animations should be suppressed.
Will Haldean Brownca6234e2014-02-12 10:23:41 -0800594 */
Ned Burns7d6cb912016-12-02 17:25:33 -0500595 void onWindowDismissed(boolean finishTask, boolean suppressWindowTransition);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800596 }
597
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700598 /** @hide */
Michael Kwan67639a52016-12-16 12:38:10 -0800599 public interface OnWindowSwipeDismissedCallback {
600 /**
601 * Called when a window is swipe dismissed. This informs the callback that the
602 * window is gone, and it should finish itself.
603 * @param finishTask True if the task should also be finished.
604 * @param suppressWindowTransition True if the resulting exit and enter window transition
605 * animations should be suppressed.
606 */
607 void onWindowSwipeDismissed();
608 }
609
610 /** @hide */
Skuhnece2faa52015-08-11 10:36:38 -0700611 public interface WindowControllerCallback {
612 /**
Filip Gruszczynski411c06f2016-01-07 09:44:44 -0800613 * Moves the activity from
614 * {@link android.app.ActivityManager.StackId#FREEFORM_WORKSPACE_STACK_ID} to
615 * {@link android.app.ActivityManager.StackId#FULLSCREEN_WORKSPACE_STACK_ID} stack.
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700616 */
Filip Gruszczynski411c06f2016-01-07 09:44:44 -0800617 void exitFreeformMode() throws RemoteException;
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700618
Jaewan Kimd98dcab2016-05-03 02:52:18 +0900619 /**
620 * Puts the activity in picture-in-picture mode if the activity supports.
621 * @see android.R.attr#supportsPictureInPicture
622 */
623 void enterPictureInPictureModeIfPossible();
624
Wale Ogunwale868a5e12015-08-02 16:19:20 -0700625 /** Returns the current stack Id for the window. */
626 int getWindowStackId() throws RemoteException;
627 }
628
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800629 /**
630 * Callback for clients that want to be aware of where caption draws content.
631 */
Wale Ogunwalea504ca32016-01-30 16:02:13 -0800632 public interface OnRestrictedCaptionAreaChangedListener {
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800633 /**
634 * Called when the area where caption draws content changes.
635 *
636 * @param rect The area where caption content is positioned, relative to the top view.
637 */
638 void onRestrictedCaptionAreaChanged(Rect rect);
639 }
640
Andres Morales910beb82016-02-02 16:19:40 -0800641 /**
642 * Callback for clients that want frame timing information for each
643 * frame rendered by the Window.
644 */
Andres Moralesd908c622016-04-20 13:13:34 -0700645 public interface OnFrameMetricsAvailableListener {
Andres Morales910beb82016-02-02 16:19:40 -0800646 /**
647 * Called when information is available for the previously rendered frame.
648 *
649 * Reports can be dropped if this callback takes too
650 * long to execute, as the report producer cannot wait for the consumer to
651 * complete.
652 *
653 * It is highly recommended that clients copy the passed in FrameMetrics
654 * via {@link FrameMetrics#FrameMetrics(FrameMetrics)} within this method and defer
655 * additional computation or storage to another thread to avoid unnecessarily
656 * dropping reports.
657 *
658 * @param window The {@link Window} on which the frame was displayed.
659 * @param frameMetrics the available metrics. This object is reused on every call
660 * and thus <strong>this reference is not valid outside the scope of this method</strong>.
661 * @param dropCountSinceLastInvocation the number of reports dropped since the last time
662 * this callback was invoked.
663 */
Andres Moralesd908c622016-04-20 13:13:34 -0700664 void onFrameMetricsAvailable(Window window, FrameMetrics frameMetrics,
Andres Morales910beb82016-02-02 16:19:40 -0800665 int dropCountSinceLastInvocation);
666 }
667
668
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800669 public Window(Context context) {
670 mContext = context;
Bryce Leed6e6e722014-11-21 11:08:45 -0800671 mFeatures = mLocalFeatures = getDefaultFeatures(context);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800672 }
673
674 /**
675 * Return the Context this window policy is running in, for retrieving
676 * resources and other information.
677 *
678 * @return Context The Context that was supplied to the constructor.
679 */
680 public final Context getContext() {
681 return mContext;
682 }
683
684 /**
685 * Return the {@link android.R.styleable#Window} attributes from this
686 * window's theme.
687 */
688 public final TypedArray getWindowStyle() {
689 synchronized (this) {
690 if (mWindowStyle == null) {
691 mWindowStyle = mContext.obtainStyledAttributes(
692 com.android.internal.R.styleable.Window);
693 }
694 return mWindowStyle;
695 }
696 }
RoboErik55011652014-07-09 15:05:53 -0700697
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800698 /**
699 * Set the container for this window. If not set, the DecorWindow
700 * operates as a top-level window; otherwise, it negotiates with the
701 * container to display itself appropriately.
702 *
703 * @param container The desired containing Window.
704 */
705 public void setContainer(Window container) {
706 mContainer = container;
707 if (container != null) {
708 // Embedded screens never have a title.
709 mFeatures |= 1<<FEATURE_NO_TITLE;
710 mLocalFeatures |= 1<<FEATURE_NO_TITLE;
711 container.mHasChildren = true;
712 }
713 }
714
715 /**
716 * Return the container for this Window.
717 *
718 * @return Window The containing window, or null if this is a
719 * top-level window.
720 */
721 public final Window getContainer() {
722 return mContainer;
723 }
724
725 public final boolean hasChildren() {
726 return mHasChildren;
727 }
RoboErik55011652014-07-09 15:05:53 -0700728
Dianne Hackborn291905e2010-08-17 15:17:15 -0700729 /** @hide */
730 public final void destroy() {
731 mDestroyed = true;
732 }
733
734 /** @hide */
735 public final boolean isDestroyed() {
736 return mDestroyed;
737 }
738
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800739 /**
740 * Set the window manager for use by this Window to, for example,
741 * display panels. This is <em>not</em> used for displaying the
742 * Window itself -- that must be done by the client.
743 *
Jeff Brown98365d72012-08-19 20:30:52 -0700744 * @param wm The window manager for adding new windows.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800745 */
Romain Guy529b60a2010-08-03 18:05:47 -0700746 public void setWindowManager(WindowManager wm, IBinder appToken, String appName) {
747 setWindowManager(wm, appToken, appName, false);
748 }
749
750 /**
751 * Set the window manager for use by this Window to, for example,
752 * display panels. This is <em>not</em> used for displaying the
753 * Window itself -- that must be done by the client.
754 *
Jeff Brown98365d72012-08-19 20:30:52 -0700755 * @param wm The window manager for adding new windows.
Romain Guy529b60a2010-08-03 18:05:47 -0700756 */
757 public void setWindowManager(WindowManager wm, IBinder appToken, String appName,
758 boolean hardwareAccelerated) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800759 mAppToken = appToken;
760 mAppName = appName;
Jeff Brownd32460c2012-07-20 16:15:36 -0700761 mHardwareAccelerated = hardwareAccelerated
762 || SystemProperties.getBoolean(PROPERTY_HARDWARE_UI, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800763 if (wm == null) {
Jeff Brown98365d72012-08-19 20:30:52 -0700764 wm = (WindowManager)mContext.getSystemService(Context.WINDOW_SERVICE);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800765 }
Jeff Brown98365d72012-08-19 20:30:52 -0700766 mWindowManager = ((WindowManagerImpl)wm).createLocalWindowManager(this);
Dianne Hackborn5fd21692011-06-07 14:09:47 -0700767 }
768
Jeff Brownd32460c2012-07-20 16:15:36 -0700769 void adjustLayoutParamsForSubWindow(WindowManager.LayoutParams wp) {
770 CharSequence curTitle = wp.getTitle();
771 if (wp.type >= WindowManager.LayoutParams.FIRST_SUB_WINDOW &&
tiger_huangff58e302015-10-13 21:38:19 +0800772 wp.type <= WindowManager.LayoutParams.LAST_SUB_WINDOW) {
Jeff Brownd32460c2012-07-20 16:15:36 -0700773 if (wp.token == null) {
774 View decor = peekDecorView();
775 if (decor != null) {
776 wp.token = decor.getWindowToken();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800777 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800778 }
Jeff Brownd32460c2012-07-20 16:15:36 -0700779 if (curTitle == null || curTitle.length() == 0) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700780 final StringBuilder title = new StringBuilder(32);
Jeff Brownd32460c2012-07-20 16:15:36 -0700781 if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700782 title.append("Media");
Jeff Brownd32460c2012-07-20 16:15:36 -0700783 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_MEDIA_OVERLAY) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700784 title.append("MediaOvr");
Jeff Brownd32460c2012-07-20 16:15:36 -0700785 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_PANEL) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700786 title.append("Panel");
Jeff Brownd32460c2012-07-20 16:15:36 -0700787 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_SUB_PANEL) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700788 title.append("SubPanel");
Wale Ogunwale0a4dc222015-04-14 12:58:42 -0700789 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ABOVE_SUB_PANEL) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700790 title.append("AboveSubPanel");
Jeff Brownd32460c2012-07-20 16:15:36 -0700791 } else if (wp.type == WindowManager.LayoutParams.TYPE_APPLICATION_ATTACHED_DIALOG) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700792 title.append("AtchDlg");
Jeff Brownd32460c2012-07-20 16:15:36 -0700793 } else {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700794 title.append(wp.type);
Jeff Brownd32460c2012-07-20 16:15:36 -0700795 }
796 if (mAppName != null) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700797 title.append(":").append(mAppName);
Jeff Brownd32460c2012-07-20 16:15:36 -0700798 }
799 wp.setTitle(title);
Romain Guy529b60a2010-08-03 18:05:47 -0700800 }
tiger_huangff58e302015-10-13 21:38:19 +0800801 } else if (wp.type >= WindowManager.LayoutParams.FIRST_SYSTEM_WINDOW &&
802 wp.type <= WindowManager.LayoutParams.LAST_SYSTEM_WINDOW) {
803 // We don't set the app token to this system window because the life cycles should be
804 // independent. If an app creates a system window and then the app goes to the stopped
805 // state, the system window should not be affected (can still show and receive input
806 // events).
807 if (curTitle == null || curTitle.length() == 0) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700808 final StringBuilder title = new StringBuilder(32);
809 title.append("Sys").append(wp.type);
tiger_huangff58e302015-10-13 21:38:19 +0800810 if (mAppName != null) {
Wale Ogunwale9b344422015-10-16 09:07:45 -0700811 title.append(":").append(mAppName);
tiger_huangff58e302015-10-13 21:38:19 +0800812 }
813 wp.setTitle(title);
814 }
Jeff Brownd32460c2012-07-20 16:15:36 -0700815 } else {
816 if (wp.token == null) {
817 wp.token = mContainer == null ? mAppToken : mContainer.mAppToken;
818 }
819 if ((curTitle == null || curTitle.length() == 0)
820 && mAppName != null) {
821 wp.setTitle(mAppName);
822 }
823 }
824 if (wp.packageName == null) {
825 wp.packageName = mContext.getPackageName();
826 }
Robert Carr13678ee2016-04-20 14:04:15 -0700827 if (mHardwareAccelerated ||
828 (mWindowAttributes.flags & FLAG_HARDWARE_ACCELERATED) != 0) {
829 wp.flags |= FLAG_HARDWARE_ACCELERATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800830 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800831 }
832
833 /**
834 * Return the window manager allowing this Window to display its own
835 * windows.
836 *
837 * @return WindowManager The ViewManager.
838 */
839 public WindowManager getWindowManager() {
840 return mWindowManager;
841 }
842
843 /**
844 * Set the Callback interface for this window, used to intercept key
845 * events and other dynamic operations in the window.
846 *
847 * @param callback The desired Callback interface.
848 */
849 public void setCallback(Callback callback) {
850 mCallback = callback;
851 }
852
853 /**
854 * Return the current Callback interface for this window.
855 */
856 public final Callback getCallback() {
857 return mCallback;
858 }
859
Andres Morales06f5bc72015-12-15 15:21:31 -0800860 /**
861 * Set an observer to collect frame stats for each frame rendererd in this window.
862 *
863 * Must be in hardware rendering mode.
Andres Morales06f5bc72015-12-15 15:21:31 -0800864 */
Andres Moralesd908c622016-04-20 13:13:34 -0700865 public final void addOnFrameMetricsAvailableListener(
866 @NonNull OnFrameMetricsAvailableListener listener,
Andres Morales910beb82016-02-02 16:19:40 -0800867 Handler handler) {
Andres Morales06f5bc72015-12-15 15:21:31 -0800868 final View decorView = getDecorView();
869 if (decorView == null) {
870 throw new IllegalStateException("can't observe a Window without an attached view");
871 }
872
Andres Morales910beb82016-02-02 16:19:40 -0800873 if (listener == null) {
874 throw new NullPointerException("listener cannot be null");
Andres Morales06f5bc72015-12-15 15:21:31 -0800875 }
876
Andres Morales910beb82016-02-02 16:19:40 -0800877 decorView.addFrameMetricsListener(this, listener, handler);
Andres Morales06f5bc72015-12-15 15:21:31 -0800878 }
879
880 /**
881 * Remove observer and stop listening to frame stats for this window.
Andres Morales06f5bc72015-12-15 15:21:31 -0800882 */
Andres Moralesd908c622016-04-20 13:13:34 -0700883 public final void removeOnFrameMetricsAvailableListener(OnFrameMetricsAvailableListener listener) {
Andres Morales06f5bc72015-12-15 15:21:31 -0800884 final View decorView = getDecorView();
885 if (decorView != null) {
Andres Morales910beb82016-02-02 16:19:40 -0800886 getDecorView().removeFrameMetricsListener(listener);
Andres Morales06f5bc72015-12-15 15:21:31 -0800887 }
888 }
889
Adam Powell117b6952014-05-05 18:14:56 -0700890 /** @hide */
891 public final void setOnWindowDismissedCallback(OnWindowDismissedCallback dcb) {
892 mOnWindowDismissedCallback = dcb;
893 }
894
895 /** @hide */
Ned Burns7d6cb912016-12-02 17:25:33 -0500896 public final void dispatchOnWindowDismissed(
897 boolean finishTask, boolean suppressWindowTransition) {
Adam Powell117b6952014-05-05 18:14:56 -0700898 if (mOnWindowDismissedCallback != null) {
Ned Burns7d6cb912016-12-02 17:25:33 -0500899 mOnWindowDismissedCallback.onWindowDismissed(finishTask, suppressWindowTransition);
Adam Powell117b6952014-05-05 18:14:56 -0700900 }
901 }
902
Stefan Kuhne9bad7412015-08-07 10:35:52 -0700903 /** @hide */
Michael Kwan67639a52016-12-16 12:38:10 -0800904 public final void setOnWindowSwipeDismissedCallback(OnWindowSwipeDismissedCallback sdcb) {
905 mOnWindowSwipeDismissedCallback = sdcb;
906 }
907
908 /** @hide */
909 public final void dispatchOnWindowSwipeDismissed() {
910 if (mOnWindowSwipeDismissedCallback != null) {
911 mOnWindowSwipeDismissedCallback.onWindowSwipeDismissed();
912 }
913 }
914
915 /** @hide */
Skuhnece2faa52015-08-11 10:36:38 -0700916 public final void setWindowControllerCallback(WindowControllerCallback wccb) {
917 mWindowControllerCallback = wccb;
Stefan Kuhne9bad7412015-08-07 10:35:52 -0700918 }
919
920 /** @hide */
Skuhnece2faa52015-08-11 10:36:38 -0700921 public final WindowControllerCallback getWindowControllerCallback() {
922 return mWindowControllerCallback;
Stefan Kuhne9bad7412015-08-07 10:35:52 -0700923 }
924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800925 /**
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800926 * Set a callback for changes of area where caption will draw its content.
927 *
928 * @param listener Callback that will be called when the area changes.
929 */
Wale Ogunwalea504ca32016-01-30 16:02:13 -0800930 public final void setRestrictedCaptionAreaListener(OnRestrictedCaptionAreaChangedListener listener) {
931 mOnRestrictedCaptionAreaChangedListener = listener;
Filip Gruszczynski3dec0812015-12-09 08:42:41 -0800932 mRestrictedCaptionAreaRect = listener != null ? new Rect() : null;
933 }
934
935 /**
Dianne Hackborndc8a7f62010-05-10 11:29:34 -0700936 * Take ownership of this window's surface. The window's view hierarchy
937 * will no longer draw into the surface, though it will otherwise continue
938 * to operate (such as for receiving input events). The given SurfaceHolder
939 * callback will be used to tell you about state changes to the surface.
940 */
Dianne Hackbornd76b67c2010-07-13 17:48:30 -0700941 public abstract void takeSurface(SurfaceHolder.Callback2 callback);
RoboErik55011652014-07-09 15:05:53 -0700942
Dianne Hackborndc8a7f62010-05-10 11:29:34 -0700943 /**
Dianne Hackborn1e4b9f32010-06-23 14:10:57 -0700944 * Take ownership of this window's InputQueue. The window will no
945 * longer read and dispatch input events from the queue; it is your
Dianne Hackborna95e4cb2010-06-18 18:09:33 -0700946 * responsibility to do so.
947 */
Dianne Hackborn1e4b9f32010-06-23 14:10:57 -0700948 public abstract void takeInputQueue(InputQueue.Callback callback);
RoboErik55011652014-07-09 15:05:53 -0700949
Dianne Hackborna95e4cb2010-06-18 18:09:33 -0700950 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800951 * Return whether this window is being displayed with a floating style
952 * (based on the {@link android.R.attr#windowIsFloating} attribute in
953 * the style/theme).
954 *
955 * @return Returns true if the window is configured to be displayed floating
956 * on top of whatever is behind it.
957 */
958 public abstract boolean isFloating();
959
960 /**
961 * Set the width and height layout parameters of the window. The default
Dianne Hackbornc9189352010-12-15 14:57:25 -0800962 * for both of these is MATCH_PARENT; you can change them to WRAP_CONTENT
963 * or an absolute value to make a window that is not full-screen.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800964 *
965 * @param width The desired layout width of the window.
966 * @param height The desired layout height of the window.
Dianne Hackbornc9189352010-12-15 14:57:25 -0800967 *
968 * @see ViewGroup.LayoutParams#height
969 * @see ViewGroup.LayoutParams#width
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800970 */
Dianne Hackbornc9189352010-12-15 14:57:25 -0800971 public void setLayout(int width, int height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800972 final WindowManager.LayoutParams attrs = getAttributes();
973 attrs.width = width;
974 attrs.height = height;
Adrian Roosea562512014-05-05 13:33:03 +0200975 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800976 }
977
978 /**
979 * Set the gravity of the window, as per the Gravity constants. This
980 * controls how the window manager is positioned in the overall window; it
981 * is only useful when using WRAP_CONTENT for the layout width or height.
982 *
983 * @param gravity The desired gravity constant.
984 *
985 * @see Gravity
986 * @see #setLayout
987 */
988 public void setGravity(int gravity)
989 {
990 final WindowManager.LayoutParams attrs = getAttributes();
991 attrs.gravity = gravity;
Adrian Roosea562512014-05-05 13:33:03 +0200992 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800993 }
994
995 /**
996 * Set the type of the window, as per the WindowManager.LayoutParams
997 * types.
998 *
999 * @param type The new window type (see WindowManager.LayoutParams).
1000 */
1001 public void setType(int type) {
1002 final WindowManager.LayoutParams attrs = getAttributes();
1003 attrs.type = type;
Adrian Roosea562512014-05-05 13:33:03 +02001004 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001005 }
1006
1007 /**
1008 * Set the format of window, as per the PixelFormat types. This overrides
1009 * the default format that is selected by the Window based on its
1010 * window decorations.
1011 *
1012 * @param format The new window format (see PixelFormat). Use
1013 * PixelFormat.UNKNOWN to allow the Window to select
1014 * the format.
1015 *
1016 * @see PixelFormat
1017 */
1018 public void setFormat(int format) {
1019 final WindowManager.LayoutParams attrs = getAttributes();
1020 if (format != PixelFormat.UNKNOWN) {
1021 attrs.format = format;
1022 mHaveWindowFormat = true;
1023 } else {
1024 attrs.format = mDefaultWindowFormat;
1025 mHaveWindowFormat = false;
1026 }
Adrian Roosea562512014-05-05 13:33:03 +02001027 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001028 }
1029
1030 /**
1031 * Specify custom animations to use for the window, as per
1032 * {@link WindowManager.LayoutParams#windowAnimations
1033 * WindowManager.LayoutParams.windowAnimations}. Providing anything besides
1034 * 0 here will override the animations the window would
1035 * normally retrieve from its theme.
1036 */
Tor Norbye417ee5b2015-03-10 20:57:37 -07001037 public void setWindowAnimations(@StyleRes int resId) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001038 final WindowManager.LayoutParams attrs = getAttributes();
1039 attrs.windowAnimations = resId;
Adrian Roosea562512014-05-05 13:33:03 +02001040 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001041 }
1042
1043 /**
1044 * Specify an explicit soft input mode to use for the window, as per
1045 * {@link WindowManager.LayoutParams#softInputMode
1046 * WindowManager.LayoutParams.softInputMode}. Providing anything besides
1047 * "unspecified" here will override the input mode the window would
1048 * normally retrieve from its theme.
1049 */
1050 public void setSoftInputMode(int mode) {
1051 final WindowManager.LayoutParams attrs = getAttributes();
1052 if (mode != WindowManager.LayoutParams.SOFT_INPUT_STATE_UNSPECIFIED) {
1053 attrs.softInputMode = mode;
1054 mHasSoftInputMode = true;
1055 } else {
1056 mHasSoftInputMode = false;
1057 }
Adrian Roosea562512014-05-05 13:33:03 +02001058 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001059 }
RoboErik55011652014-07-09 15:05:53 -07001060
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001061 /**
1062 * Convenience function to set the flag bits as specified in flags, as
1063 * per {@link #setFlags}.
1064 * @param flags The flag bits to be set.
1065 * @see #setFlags
Christopher Tate193fc072012-06-04 11:27:40 -07001066 * @see #clearFlags
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001067 */
1068 public void addFlags(int flags) {
1069 setFlags(flags, flags);
1070 }
Adam Lesinski95c42972013-10-02 10:13:27 -07001071
1072 /** @hide */
1073 public void addPrivateFlags(int flags) {
1074 setPrivateFlags(flags, flags);
1075 }
RoboErik55011652014-07-09 15:05:53 -07001076
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001077 /**
1078 * Convenience function to clear the flag bits as specified in flags, as
1079 * per {@link #setFlags}.
1080 * @param flags The flag bits to be cleared.
1081 * @see #setFlags
Christopher Tate193fc072012-06-04 11:27:40 -07001082 * @see #addFlags
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001083 */
1084 public void clearFlags(int flags) {
1085 setFlags(0, flags);
1086 }
1087
1088 /**
1089 * Set the flags of the window, as per the
1090 * {@link WindowManager.LayoutParams WindowManager.LayoutParams}
1091 * flags.
RoboErik55011652014-07-09 15:05:53 -07001092 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001093 * <p>Note that some flags must be set before the window decoration is
1094 * created (by the first call to
1095 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)} or
1096 * {@link #getDecorView()}:
1097 * {@link WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN} and
1098 * {@link WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR}. These
1099 * will be set for you based on the {@link android.R.attr#windowIsFloating}
1100 * attribute.
1101 *
1102 * @param flags The new window flags (see WindowManager.LayoutParams).
1103 * @param mask Which of the window flag bits to modify.
Christopher Tate193fc072012-06-04 11:27:40 -07001104 * @see #addFlags
1105 * @see #clearFlags
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001106 */
1107 public void setFlags(int flags, int mask) {
1108 final WindowManager.LayoutParams attrs = getAttributes();
1109 attrs.flags = (attrs.flags&~mask) | (flags&mask);
1110 mForcedWindowFlags |= mask;
Adrian Roosea562512014-05-05 13:33:03 +02001111 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001112 }
1113
Adam Lesinski95c42972013-10-02 10:13:27 -07001114 private void setPrivateFlags(int flags, int mask) {
1115 final WindowManager.LayoutParams attrs = getAttributes();
1116 attrs.privateFlags = (attrs.privateFlags & ~mask) | (flags & mask);
Adrian Roosea562512014-05-05 13:33:03 +02001117 dispatchWindowAttributesChanged(attrs);
1118 }
1119
1120 /**
1121 * {@hide}
1122 */
Wale Ogunwale393b1c12014-10-18 16:22:01 -07001123 protected void setNeedsMenuKey(int value) {
1124 final WindowManager.LayoutParams attrs = getAttributes();
1125 attrs.needsMenuKey = value;
1126 dispatchWindowAttributesChanged(attrs);
1127 }
1128
1129 /**
1130 * {@hide}
1131 */
Adrian Roosea562512014-05-05 13:33:03 +02001132 protected void dispatchWindowAttributesChanged(WindowManager.LayoutParams attrs) {
Adam Lesinski95c42972013-10-02 10:13:27 -07001133 if (mCallback != null) {
1134 mCallback.onWindowAttributesChanged(attrs);
1135 }
1136 }
1137
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001138 /**
Romain Guy48327452017-01-23 17:03:35 -08001139 * <p>Set the color mode of the window. Setting the color mode might
1140 * override the window's pixel {@link WindowManager.LayoutParams#format format}.</p>
1141 *
1142 * <p>The color mode must be one of {@link ActivityInfo#COLOR_MODE_DEFAULT},
1143 * {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT} or {@link ActivityInfo#COLOR_MODE_HDR}.</p>
1144 */
1145 public void setColorMode(@ActivityInfo.ColorMode int colorMode) {
1146 final WindowManager.LayoutParams attrs = getAttributes();
1147 attrs.setColorMode(colorMode);
1148 dispatchWindowAttributesChanged(attrs);
1149 }
1150
1151 /**
1152 * Returns the color mode of the window, one of {@link ActivityInfo#COLOR_MODE_DEFAULT},
1153 * {@link ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT} or {@link ActivityInfo#COLOR_MODE_HDR}.
1154 */
1155 @ActivityInfo.ColorMode
1156 public int getColorMode() {
1157 return getAttributes().getColorMode();
1158 }
1159
1160 /**
Dianne Hackborn661cd522011-08-22 00:26:20 -07001161 * Set the amount of dim behind the window when using
1162 * {@link WindowManager.LayoutParams#FLAG_DIM_BEHIND}. This overrides
1163 * the default dim amount of that is selected by the Window based on
1164 * its theme.
1165 *
1166 * @param amount The new dim amount, from 0 for no dim to 1 for full dim.
1167 */
1168 public void setDimAmount(float amount) {
1169 final WindowManager.LayoutParams attrs = getAttributes();
1170 attrs.dimAmount = amount;
1171 mHaveDimAmount = true;
Adrian Roosea562512014-05-05 13:33:03 +02001172 dispatchWindowAttributesChanged(attrs);
Dianne Hackborn661cd522011-08-22 00:26:20 -07001173 }
1174
1175 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001176 * Specify custom window attributes. <strong>PLEASE NOTE:</strong> the
1177 * layout params you give here should generally be from values previously
1178 * retrieved with {@link #getAttributes()}; you probably do not want to
1179 * blindly create and apply your own, since this will blow away any values
1180 * set by the framework that you are not interested in.
1181 *
1182 * @param a The new window attributes, which will completely override any
1183 * current values.
1184 */
1185 public void setAttributes(WindowManager.LayoutParams a) {
1186 mWindowAttributes.copyFrom(a);
Adrian Roosea562512014-05-05 13:33:03 +02001187 dispatchWindowAttributesChanged(mWindowAttributes);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001188 }
1189
1190 /**
1191 * Retrieve the current window attributes associated with this panel.
1192 *
1193 * @return WindowManager.LayoutParams Either the existing window
1194 * attributes object, or a freshly created one if there is none.
1195 */
1196 public final WindowManager.LayoutParams getAttributes() {
1197 return mWindowAttributes;
1198 }
1199
1200 /**
1201 * Return the window flags that have been explicitly set by the client,
1202 * so will not be modified by {@link #getDecorView}.
1203 */
1204 protected final int getForcedWindowFlags() {
1205 return mForcedWindowFlags;
1206 }
RoboErik55011652014-07-09 15:05:53 -07001207
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001208 /**
1209 * Has the app specified their own soft input mode?
1210 */
1211 protected final boolean hasSoftInputMode() {
1212 return mHasSoftInputMode;
1213 }
RoboErik55011652014-07-09 15:05:53 -07001214
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001215 /** @hide */
1216 public void setCloseOnTouchOutside(boolean close) {
1217 mCloseOnTouchOutside = close;
1218 mSetCloseOnTouchOutside = true;
1219 }
RoboErik55011652014-07-09 15:05:53 -07001220
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001221 /** @hide */
Dianne Hackbornef575752011-01-18 17:35:17 -08001222 public void setCloseOnTouchOutsideIfNotSet(boolean close) {
1223 if (!mSetCloseOnTouchOutside) {
1224 mCloseOnTouchOutside = close;
1225 mSetCloseOnTouchOutside = true;
1226 }
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001227 }
RoboErik55011652014-07-09 15:05:53 -07001228
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001229 /** @hide */
Filip Gruszczynskife568352015-01-05 10:41:29 -08001230 @SystemApi
1231 public void setDisableWallpaperTouchEvents(boolean disable) {
1232 setPrivateFlags(disable
1233 ? WindowManager.LayoutParams.PRIVATE_FLAG_DISABLE_WALLPAPER_TOUCH_EVENTS : 0,
1234 WindowManager.LayoutParams.PRIVATE_FLAG_DISABLE_WALLPAPER_TOUCH_EVENTS);
1235 }
1236
1237 /** @hide */
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001238 public abstract void alwaysReadCloseOnTouchAttr();
RoboErik55011652014-07-09 15:05:53 -07001239
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001240 /** @hide */
1241 public boolean shouldCloseOnTouch(Context context, MotionEvent event) {
1242 if (mCloseOnTouchOutside && event.getAction() == MotionEvent.ACTION_DOWN
1243 && isOutOfBounds(context, event) && peekDecorView() != null) {
1244 return true;
1245 }
1246 return false;
1247 }
RoboErik55011652014-07-09 15:05:53 -07001248
Ruchi Kandoi43e38de2016-04-14 19:34:53 -07001249 /* Sets the Sustained Performance requirement for the calling window.
1250 * @param enable disables or enables the mode.
1251 */
1252 public void setSustainedPerformanceMode(boolean enable) {
1253 setPrivateFlags(enable
1254 ? WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE : 0,
1255 WindowManager.LayoutParams.PRIVATE_FLAG_SUSTAINED_PERFORMANCE_MODE);
1256 }
1257
Dianne Hackborncfaf8872011-01-18 13:57:54 -08001258 private boolean isOutOfBounds(Context context, MotionEvent event) {
1259 final int x = (int) event.getX();
1260 final int y = (int) event.getY();
1261 final int slop = ViewConfiguration.get(context).getScaledWindowTouchSlop();
1262 final View decorView = getDecorView();
1263 return (x < -slop) || (y < -slop)
1264 || (x > (decorView.getWidth()+slop))
1265 || (y > (decorView.getHeight()+slop));
1266 }
RoboErik55011652014-07-09 15:05:53 -07001267
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001268 /**
1269 * Enable extended screen features. This must be called before
1270 * setContentView(). May be called as many times as desired as long as it
1271 * is before setContentView(). If not called, no extended features
1272 * will be available. You can not turn off a feature once it is requested.
1273 * You canot use other title features with {@link #FEATURE_CUSTOM_TITLE}.
1274 *
1275 * @param featureId The desired features, defined as constants by Window.
1276 * @return The features that are now set.
1277 */
1278 public boolean requestFeature(int featureId) {
1279 final int flag = 1<<featureId;
1280 mFeatures |= flag;
1281 mLocalFeatures |= mContainer != null ? (flag&~mContainer.mFeatures) : flag;
1282 return (mFeatures&flag) != 0;
1283 }
1284
Adam Powellf4a6ec42010-08-24 14:18:10 -07001285 /**
1286 * @hide Used internally to help resolve conflicting features.
1287 */
1288 protected void removeFeature(int featureId) {
1289 final int flag = 1<<featureId;
1290 mFeatures &= ~flag;
1291 mLocalFeatures &= ~(mContainer != null ? (flag&~mContainer.mFeatures) : flag);
1292 }
1293
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001294 public final void makeActive() {
1295 if (mContainer != null) {
1296 if (mContainer.mActiveChild != null) {
1297 mContainer.mActiveChild.mIsActive = false;
1298 }
1299 mContainer.mActiveChild = this;
1300 }
1301 mIsActive = true;
1302 onActive();
1303 }
1304
1305 public final boolean isActive()
1306 {
1307 return mIsActive;
1308 }
1309
1310 /**
1311 * Finds a view that was identified by the id attribute from the XML that
1312 * was processed in {@link android.app.Activity#onCreate}. This will
1313 * implicitly call {@link #getDecorView} for you, with all of the
1314 * associated side-effects.
1315 *
1316 * @return The view if found or null otherwise.
1317 */
Scott Kennedyc0519552015-02-11 15:33:10 -08001318 @Nullable
Tor Norbye7b9c9122013-05-30 16:48:33 -07001319 public View findViewById(@IdRes int id) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001320 return getDecorView().findViewById(id);
1321 }
1322
1323 /**
1324 * Convenience for
1325 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1326 * to set the screen content from a layout resource. The resource will be
1327 * inflated, adding all top-level views to the screen.
1328 *
1329 * @param layoutResID Resource ID to be inflated.
1330 * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
1331 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001332 public abstract void setContentView(@LayoutRes int layoutResID);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001333
1334 /**
1335 * Convenience for
1336 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1337 * set the screen content to an explicit view. This view is placed
1338 * directly into the screen's view hierarchy. It can itself be a complex
1339 * view hierarhcy.
1340 *
1341 * @param view The desired content to display.
1342 * @see #setContentView(View, android.view.ViewGroup.LayoutParams)
1343 */
1344 public abstract void setContentView(View view);
1345
1346 /**
1347 * Set the screen content to an explicit view. This view is placed
1348 * directly into the screen's view hierarchy. It can itself be a complex
1349 * view hierarchy.
1350 *
1351 * <p>Note that calling this function "locks in" various characteristics
1352 * of the window that can not, from this point forward, be changed: the
1353 * features that have been requested with {@link #requestFeature(int)},
George Mountc3a043c2015-02-04 14:37:04 -08001354 * and certain window flags as described in {@link #setFlags(int, int)}.</p>
1355 *
1356 * <p>If {@link #FEATURE_CONTENT_TRANSITIONS} is set, the window's
1357 * TransitionManager will be used to animate content from the current
1358 * content View to view.</p>
RoboErik55011652014-07-09 15:05:53 -07001359 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001360 * @param view The desired content to display.
1361 * @param params Layout parameters for the view.
George Mountc3a043c2015-02-04 14:37:04 -08001362 * @see #getTransitionManager()
1363 * @see #setTransitionManager(android.transition.TransitionManager)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001364 */
1365 public abstract void setContentView(View view, ViewGroup.LayoutParams params);
1366
1367 /**
1368 * Variation on
1369 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}
1370 * to add an additional content view to the screen. Added after any existing
1371 * ones in the screen -- existing views are NOT removed.
1372 *
1373 * @param view The desired content to display.
1374 * @param params Layout parameters for the view.
1375 */
1376 public abstract void addContentView(View view, ViewGroup.LayoutParams params);
1377
1378 /**
Filip Gruszczynskia59ac9c2015-09-10 18:28:48 -07001379 * Remove the view that was used as the screen content.
1380 *
1381 * @hide
1382 */
1383 public abstract void clearContentView();
1384
1385 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001386 * Return the view in this Window that currently has focus, or null if
1387 * there are none. Note that this does not look in any containing
1388 * Window.
1389 *
1390 * @return View The current View with focus or null.
1391 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001392 @Nullable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001393 public abstract View getCurrentFocus();
1394
1395 /**
1396 * Quick access to the {@link LayoutInflater} instance that this Window
1397 * retrieved from its Context.
1398 *
1399 * @return LayoutInflater The shared LayoutInflater.
1400 */
Tor Norbyed9273d62013-05-30 15:59:53 -07001401 @NonNull
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001402 public abstract LayoutInflater getLayoutInflater();
1403
1404 public abstract void setTitle(CharSequence title);
1405
Alan Viverette2525d9c2013-11-15 14:42:19 -08001406 @Deprecated
Tor Norbye80756e32015-03-02 09:39:27 -08001407 public abstract void setTitleColor(@ColorInt int textColor);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001408
1409 public abstract void openPanel(int featureId, KeyEvent event);
1410
1411 public abstract void closePanel(int featureId);
1412
1413 public abstract void togglePanel(int featureId, KeyEvent event);
1414
Dianne Hackbornb31e84bc2010-06-08 18:04:35 -07001415 public abstract void invalidatePanelMenu(int featureId);
RoboErik55011652014-07-09 15:05:53 -07001416
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001417 public abstract boolean performPanelShortcut(int featureId,
1418 int keyCode,
1419 KeyEvent event,
1420 int flags);
1421 public abstract boolean performPanelIdentifierAction(int featureId,
1422 int id,
1423 int flags);
1424
1425 public abstract void closeAllPanels();
1426
1427 public abstract boolean performContextMenuIdentifierAction(int id, int flags);
1428
1429 /**
1430 * Should be called when the configuration is changed.
RoboErik55011652014-07-09 15:05:53 -07001431 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001432 * @param newConfig The new configuration.
1433 */
1434 public abstract void onConfigurationChanged(Configuration newConfig);
RoboErik55011652014-07-09 15:05:53 -07001435
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001436 /**
Alan Viverette79c067c52014-10-29 14:27:47 -07001437 * Sets the window elevation.
Alan Viverette71922de2015-01-12 16:14:02 -08001438 * <p>
1439 * Changes to this property take effect immediately and will cause the
1440 * window surface to be recreated. This is an expensive operation and as a
1441 * result, this property should not be animated.
Alan Viverette79c067c52014-10-29 14:27:47 -07001442 *
1443 * @param elevation The window elevation.
1444 * @see View#setElevation(float)
1445 * @see android.R.styleable#Window_windowElevation
1446 */
1447 public void setElevation(float elevation) {}
1448
1449 /**
Filip Gruszczynskia59ac9c2015-09-10 18:28:48 -07001450 * Gets the window elevation.
1451 *
1452 * @hide
1453 */
1454 public float getElevation() {
1455 return 0.0f;
1456 }
1457
1458 /**
Alan Viverette79c067c52014-10-29 14:27:47 -07001459 * Sets whether window content should be clipped to the outline of the
1460 * window background.
1461 *
1462 * @param clipToOutline Whether window content should be clipped to the
1463 * outline of the window background.
1464 * @see View#setClipToOutline(boolean)
1465 * @see android.R.styleable#Window_windowClipToOutline
1466 */
1467 public void setClipToOutline(boolean clipToOutline) {}
1468
1469 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001470 * Change the background of this window to a Drawable resource. Setting the
1471 * background to null will make the window be opaque. To make the window
1472 * transparent, you can use an empty drawable (for instance a ColorDrawable
1473 * with the color 0 or the system drawable android:drawable/empty.)
RoboErik55011652014-07-09 15:05:53 -07001474 *
Alan Viverette79c067c52014-10-29 14:27:47 -07001475 * @param resId The resource identifier of a drawable resource which will
1476 * be installed as the new background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001477 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001478 public void setBackgroundDrawableResource(@DrawableRes int resId) {
Alan Viverette79c067c52014-10-29 14:27:47 -07001479 setBackgroundDrawable(mContext.getDrawable(resId));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001480 }
1481
1482 /**
1483 * Change the background of this window to a custom Drawable. Setting the
1484 * background to null will make the window be opaque. To make the window
1485 * transparent, you can use an empty drawable (for instance a ColorDrawable
1486 * with the color 0 or the system drawable android:drawable/empty.)
1487 *
1488 * @param drawable The new Drawable to use for this window's background.
1489 */
1490 public abstract void setBackgroundDrawable(Drawable drawable);
1491
1492 /**
1493 * Set the value for a drawable feature of this window, from a resource
Tor Norbye7b9c9122013-05-30 16:48:33 -07001494 * identifier. You must have called requestFeature(featureId) before
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001495 * calling this function.
1496 *
1497 * @see android.content.res.Resources#getDrawable(int)
1498 *
1499 * @param featureId The desired drawable feature to change, defined as a
1500 * constant by Window.
1501 * @param resId Resource identifier of the desired image.
1502 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001503 public abstract void setFeatureDrawableResource(int featureId, @DrawableRes int resId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001504
1505 /**
1506 * Set the value for a drawable feature of this window, from a URI. You
1507 * must have called requestFeature(featureId) before calling this
1508 * function.
1509 *
1510 * <p>The only URI currently supported is "content:", specifying an image
1511 * in a content provider.
1512 *
1513 * @see android.widget.ImageView#setImageURI
1514 *
1515 * @param featureId The desired drawable feature to change. Features are
1516 * constants defined by Window.
1517 * @param uri The desired URI.
1518 */
1519 public abstract void setFeatureDrawableUri(int featureId, Uri uri);
1520
1521 /**
1522 * Set an explicit Drawable value for feature of this window. You must
1523 * have called requestFeature(featureId) before calling this function.
1524 *
Alan Viverette9678e342014-10-24 15:23:58 -07001525 * @param featureId The desired drawable feature to change. Features are
1526 * constants defined by Window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001527 * @param drawable A Drawable object to display.
1528 */
1529 public abstract void setFeatureDrawable(int featureId, Drawable drawable);
1530
1531 /**
Alan Viverette9678e342014-10-24 15:23:58 -07001532 * Set a custom alpha value for the given drawable feature, controlling how
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001533 * much the background is visible through it.
1534 *
Alan Viverette9678e342014-10-24 15:23:58 -07001535 * @param featureId The desired drawable feature to change. Features are
1536 * constants defined by Window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001537 * @param alpha The alpha amount, 0 is completely transparent and 255 is
1538 * completely opaque.
1539 */
1540 public abstract void setFeatureDrawableAlpha(int featureId, int alpha);
1541
1542 /**
Alan Viverette9678e342014-10-24 15:23:58 -07001543 * Set the integer value for a feature. The range of the value depends on
1544 * the feature being set. For {@link #FEATURE_PROGRESS}, it should go from
1545 * 0 to 10000. At 10000 the progress is complete and the indicator hidden.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001546 *
Alan Viverette9678e342014-10-24 15:23:58 -07001547 * @param featureId The desired feature to change. Features are constants
1548 * defined by Window.
1549 * @param value The value for the feature. The interpretation of this
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 * value is feature-specific.
1551 */
1552 public abstract void setFeatureInt(int featureId, int value);
1553
1554 /**
1555 * Request that key events come to this activity. Use this if your
1556 * activity has no views with focus, but the activity still wants
1557 * a chance to process key events.
1558 */
1559 public abstract void takeKeyEvents(boolean get);
1560
1561 /**
1562 * Used by custom windows, such as Dialog, to pass the key press event
1563 * further down the view hierarchy. Application developers should
1564 * not need to implement or call this.
1565 *
1566 */
1567 public abstract boolean superDispatchKeyEvent(KeyEvent event);
1568
1569 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08001570 * Used by custom windows, such as Dialog, to pass the key shortcut press event
1571 * further down the view hierarchy. Application developers should
1572 * not need to implement or call this.
1573 *
1574 */
1575 public abstract boolean superDispatchKeyShortcutEvent(KeyEvent event);
1576
1577 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001578 * Used by custom windows, such as Dialog, to pass the touch screen event
1579 * further down the view hierarchy. Application developers should
1580 * not need to implement or call this.
1581 *
1582 */
1583 public abstract boolean superDispatchTouchEvent(MotionEvent event);
RoboErik55011652014-07-09 15:05:53 -07001584
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001585 /**
1586 * Used by custom windows, such as Dialog, to pass the trackball event
1587 * further down the view hierarchy. Application developers should
1588 * not need to implement or call this.
1589 *
1590 */
1591 public abstract boolean superDispatchTrackballEvent(MotionEvent event);
RoboErik55011652014-07-09 15:05:53 -07001592
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001593 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08001594 * Used by custom windows, such as Dialog, to pass the generic motion event
1595 * further down the view hierarchy. Application developers should
1596 * not need to implement or call this.
1597 *
1598 */
1599 public abstract boolean superDispatchGenericMotionEvent(MotionEvent event);
1600
1601 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001602 * Retrieve the top-level window decor view (containing the standard
1603 * window frame/decorations and the client's content inside of that), which
1604 * can be added as a window to the window manager.
RoboErik55011652014-07-09 15:05:53 -07001605 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001606 * <p><em>Note that calling this function for the first time "locks in"
1607 * various window characteristics as described in
1608 * {@link #setContentView(View, android.view.ViewGroup.LayoutParams)}.</em></p>
RoboErik55011652014-07-09 15:05:53 -07001609 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001610 * @return Returns the top-level window decor view.
1611 */
1612 public abstract View getDecorView();
1613
1614 /**
1615 * Retrieve the current decor view, but only if it has already been created;
1616 * otherwise returns null.
RoboErik55011652014-07-09 15:05:53 -07001617 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001618 * @return Returns the top-level window decor or null.
1619 * @see #getDecorView
1620 */
1621 public abstract View peekDecorView();
1622
1623 public abstract Bundle saveHierarchyState();
RoboErik55011652014-07-09 15:05:53 -07001624
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001625 public abstract void restoreHierarchyState(Bundle savedInstanceState);
RoboErik55011652014-07-09 15:05:53 -07001626
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001627 protected abstract void onActive();
1628
1629 /**
1630 * Return the feature bits that are enabled. This is the set of features
1631 * that were given to requestFeature(), and are being handled by this
1632 * Window itself or its container. That is, it is the set of
1633 * requested features that you can actually use.
1634 *
1635 * <p>To do: add a public version of this API that allows you to check for
1636 * features by their feature ID.
1637 *
1638 * @return int The feature bits.
1639 */
1640 protected final int getFeatures()
1641 {
1642 return mFeatures;
1643 }
RoboErik55011652014-07-09 15:05:53 -07001644
Adam Powell33b97432010-04-20 10:01:14 -07001645 /**
Bryce Leed6e6e722014-11-21 11:08:45 -08001646 * Return the feature bits set by default on a window.
1647 * @param context The context used to access resources
1648 */
1649 public static int getDefaultFeatures(Context context) {
1650 int features = 0;
1651
1652 final Resources res = context.getResources();
1653 if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureOptionsPanel)) {
1654 features |= 1 << FEATURE_OPTIONS_PANEL;
1655 }
1656
1657 if (res.getBoolean(com.android.internal.R.bool.config_defaultWindowFeatureContextMenu)) {
1658 features |= 1 << FEATURE_CONTEXT_MENU;
1659 }
1660
1661 return features;
1662 }
1663
1664 /**
Adam Powell33b97432010-04-20 10:01:14 -07001665 * Query for the availability of a certain feature.
RoboErik55011652014-07-09 15:05:53 -07001666 *
Adam Powell33b97432010-04-20 10:01:14 -07001667 * @param feature The feature ID to check
1668 * @return true if the feature is enabled, false otherwise.
1669 */
1670 public boolean hasFeature(int feature) {
1671 return (getFeatures() & (1 << feature)) != 0;
1672 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001673
1674 /**
1675 * Return the feature bits that are being implemented by this Window.
1676 * This is the set of features that were given to requestFeature(), and are
1677 * being handled by only this Window itself, not by its containers.
1678 *
1679 * @return int The feature bits.
1680 */
1681 protected final int getLocalFeatures()
1682 {
1683 return mLocalFeatures;
1684 }
1685
1686 /**
1687 * Set the default format of window, as per the PixelFormat types. This
1688 * is the format that will be used unless the client specifies in explicit
1689 * format with setFormat();
1690 *
1691 * @param format The new window format (see PixelFormat).
1692 *
1693 * @see #setFormat
1694 * @see PixelFormat
1695 */
1696 protected void setDefaultWindowFormat(int format) {
1697 mDefaultWindowFormat = format;
1698 if (!mHaveWindowFormat) {
1699 final WindowManager.LayoutParams attrs = getAttributes();
1700 attrs.format = format;
Adrian Roosea562512014-05-05 13:33:03 +02001701 dispatchWindowAttributesChanged(attrs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001702 }
1703 }
1704
Dianne Hackborn661cd522011-08-22 00:26:20 -07001705 /** @hide */
1706 protected boolean haveDimAmount() {
1707 return mHaveDimAmount;
1708 }
1709
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001710 public abstract void setChildDrawable(int featureId, Drawable drawable);
1711
1712 public abstract void setChildInt(int featureId, int value);
1713
1714 /**
1715 * Is a keypress one of the defined shortcut keys for this window.
1716 * @param keyCode the key code from {@link android.view.KeyEvent} to check.
1717 * @param event the {@link android.view.KeyEvent} to use to help check.
1718 */
1719 public abstract boolean isShortcutKey(int keyCode, KeyEvent event);
RoboErik55011652014-07-09 15:05:53 -07001720
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001721 /**
RoboErik55011652014-07-09 15:05:53 -07001722 * @see android.app.Activity#setVolumeControlStream(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001723 */
1724 public abstract void setVolumeControlStream(int streamType);
1725
1726 /**
1727 * @see android.app.Activity#getVolumeControlStream()
1728 */
1729 public abstract int getVolumeControlStream();
Adam Powell269248d2011-08-02 10:26:54 -07001730
1731 /**
RoboErikfd63dd02014-08-28 15:22:55 -07001732 * Sets a {@link MediaController} to send media keys and volume changes to.
1733 * If set, this should be preferred for all media keys and volume requests
1734 * sent to this window.
1735 *
1736 * @param controller The controller for the session which should receive
1737 * media keys and volume changes.
RoboErik55011652014-07-09 15:05:53 -07001738 * @see android.app.Activity#setMediaController(android.media.session.MediaController)
1739 */
1740 public void setMediaController(MediaController controller) {
1741 }
1742
1743 /**
RoboErikfd63dd02014-08-28 15:22:55 -07001744 * Gets the {@link MediaController} that was previously set.
1745 *
1746 * @return The controller which should receive events.
1747 * @see #setMediaController(android.media.session.MediaController)
RoboErik55011652014-07-09 15:05:53 -07001748 * @see android.app.Activity#getMediaController()
1749 */
1750 public MediaController getMediaController() {
1751 return null;
1752 }
1753
1754 /**
Adam Powell269248d2011-08-02 10:26:54 -07001755 * Set extra options that will influence the UI for this window.
1756 * @param uiOptions Flags specifying extra options for this window.
1757 */
1758 public void setUiOptions(int uiOptions) { }
Adam Powelle43fca92011-08-16 12:57:01 -07001759
1760 /**
1761 * Set extra options that will influence the UI for this window.
1762 * Only the bits filtered by mask will be modified.
1763 * @param uiOptions Flags specifying extra options for this window.
1764 * @param mask Flags specifying which options should be modified. Others will remain unchanged.
1765 */
1766 public void setUiOptions(int uiOptions, int mask) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001767
1768 /**
1769 * Set the primary icon for this window.
1770 *
1771 * @param resId resource ID of a drawable to set
1772 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001773 public void setIcon(@DrawableRes int resId) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001774
1775 /**
1776 * Set the default icon for this window.
1777 * This will be overridden by any other icon set operation which could come from the
1778 * theme or another explicit set.
1779 *
1780 * @hide
1781 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001782 public void setDefaultIcon(@DrawableRes int resId) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001783
1784 /**
1785 * Set the logo for this window. A logo is often shown in place of an
1786 * {@link #setIcon(int) icon} but is generally wider and communicates window title information
1787 * as well.
1788 *
1789 * @param resId resource ID of a drawable to set
1790 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001791 public void setLogo(@DrawableRes int resId) { }
Adam Powell04fe6eb2013-05-31 14:39:48 -07001792
1793 /**
1794 * Set the default logo for this window.
1795 * This will be overridden by any other logo set operation which could come from the
1796 * theme or another explicit set.
1797 *
1798 * @hide
1799 */
Tor Norbye7b9c9122013-05-30 16:48:33 -07001800 public void setDefaultLogo(@DrawableRes int resId) { }
keunyoung30f420f2013-08-02 14:23:10 -07001801
1802 /**
1803 * Set focus locally. The window should have the
1804 * {@link WindowManager.LayoutParams#FLAG_LOCAL_FOCUS_MODE} flag set already.
1805 * @param hasFocus Whether this window has focus or not.
1806 * @param inTouchMode Whether this window is in touch mode or not.
1807 */
1808 public void setLocalFocus(boolean hasFocus, boolean inTouchMode) { }
1809
1810 /**
1811 * Inject an event to window locally.
1812 * @param event A key or touch event to inject to this window.
1813 */
1814 public void injectInputEvent(InputEvent event) { }
Adam Powellcfbe9be2013-11-06 14:58:58 -08001815
1816 /**
1817 * Retrieve the {@link TransitionManager} responsible for for default transitions
1818 * in this window. Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1819 *
1820 * <p>This method will return non-null after content has been initialized (e.g. by using
1821 * {@link #setContentView}) if {@link #FEATURE_CONTENT_TRANSITIONS} has been granted.</p>
1822 *
1823 * @return This window's content TransitionManager or null if none is set.
George Mountc3a043c2015-02-04 14:37:04 -08001824 * @attr ref android.R.styleable#Window_windowContentTransitionManager
Adam Powellcfbe9be2013-11-06 14:58:58 -08001825 */
1826 public TransitionManager getTransitionManager() {
1827 return null;
1828 }
1829
1830 /**
1831 * Set the {@link TransitionManager} to use for default transitions in this window.
1832 * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1833 *
1834 * @param tm The TransitionManager to use for scene changes.
George Mountc3a043c2015-02-04 14:37:04 -08001835 * @attr ref android.R.styleable#Window_windowContentTransitionManager
Adam Powellcfbe9be2013-11-06 14:58:58 -08001836 */
1837 public void setTransitionManager(TransitionManager tm) {
1838 throw new UnsupportedOperationException();
1839 }
1840
1841 /**
1842 * Retrieve the {@link Scene} representing this window's current content.
1843 * Requires {@link #FEATURE_CONTENT_TRANSITIONS}.
1844 *
1845 * <p>This method will return null if the current content is not represented by a Scene.</p>
1846 *
1847 * @return Current Scene being shown or null
1848 */
1849 public Scene getContentScene() {
1850 return null;
1851 }
1852
1853 /**
George Mount31a21722014-03-24 17:44:36 -07001854 * Sets the Transition that will be used to move Views into the initial scene. The entering
1855 * Views will be those that are regular Views or ViewGroups that have
1856 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1857 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1858 * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
1859 * entering Views will remain unaffected.
George Mountc03da0e2014-08-22 17:04:02 -07001860 *
George Mount31a21722014-03-24 17:44:36 -07001861 * @param transition The Transition to use to move Views into the initial Scene.
George Mountc03da0e2014-08-22 17:04:02 -07001862 * @attr ref android.R.styleable#Window_windowEnterTransition
Adam Powellcfbe9be2013-11-06 14:58:58 -08001863 */
George Mount31a21722014-03-24 17:44:36 -07001864 public void setEnterTransition(Transition transition) {}
George Mount0a778ed2013-12-13 13:35:36 -08001865
1866 /**
George Mount68f96d82014-07-31 13:13:10 -07001867 * Sets the Transition that will be used to move Views out of the scene when the Window is
1868 * preparing to close, for example after a call to
1869 * {@link android.app.Activity#finishAfterTransition()}. The exiting
1870 * Views will be those that are regular Views or ViewGroups that have
1871 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1872 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1873 * {@link View#VISIBLE} to {@link View#INVISIBLE}. If <code>transition</code> is null,
1874 * entering Views will remain unaffected. If nothing is set, the default will be to
1875 * use the same value as set in {@link #setEnterTransition(android.transition.Transition)}.
George Mountc03da0e2014-08-22 17:04:02 -07001876 *
George Mount68f96d82014-07-31 13:13:10 -07001877 * @param transition The Transition to use to move Views out of the Scene when the Window
1878 * is preparing to close.
George Mountc03da0e2014-08-22 17:04:02 -07001879 * @attr ref android.R.styleable#Window_windowReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07001880 */
1881 public void setReturnTransition(Transition transition) {}
1882
1883 /**
George Mount31a21722014-03-24 17:44:36 -07001884 * Sets the Transition that will be used to move Views out of the scene when starting a
1885 * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
1886 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1887 * {@link android.transition.Visibility} as exiting is governed by changing visibility
1888 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
George Mount9826f632014-09-11 08:50:09 -07001889 * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001890 *
George Mount31a21722014-03-24 17:44:36 -07001891 * @param transition The Transition to use to move Views out of the scene when calling a
1892 * new Activity.
George Mountc03da0e2014-08-22 17:04:02 -07001893 * @attr ref android.R.styleable#Window_windowExitTransition
George Mount0a778ed2013-12-13 13:35:36 -08001894 */
George Mount31a21722014-03-24 17:44:36 -07001895 public void setExitTransition(Transition transition) {}
George Mount0a778ed2013-12-13 13:35:36 -08001896
1897 /**
George Mount68f96d82014-07-31 13:13:10 -07001898 * Sets the Transition that will be used to move Views in to the scene when returning from
1899 * a previously-started Activity. The entering Views will be those that are regular Views
1900 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
1901 * will extend {@link android.transition.Visibility} as exiting is governed by changing
1902 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null,
1903 * the views will remain unaffected. If nothing is set, the default will be to use the same
1904 * transition as {@link #setExitTransition(android.transition.Transition)}.
George Mount9826f632014-09-11 08:50:09 -07001905 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001906 *
George Mount68f96d82014-07-31 13:13:10 -07001907 * @param transition The Transition to use to move Views into the scene when reentering from a
1908 * previously-started Activity.
George Mountc03da0e2014-08-22 17:04:02 -07001909 * @attr ref android.R.styleable#Window_windowReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07001910 */
1911 public void setReenterTransition(Transition transition) {}
1912
1913 /**
George Mount31a21722014-03-24 17:44:36 -07001914 * Returns the transition used to move Views into the initial scene. The entering
1915 * Views will be those that are regular Views or ViewGroups that have
1916 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1917 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1918 * {@link View#INVISIBLE} to {@link View#VISIBLE}. If <code>transition</code> is null,
George Mount9826f632014-09-11 08:50:09 -07001919 * entering Views will remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mount31a21722014-03-24 17:44:36 -07001920 *
1921 * @return the Transition to use to move Views into the initial Scene.
George Mountc03da0e2014-08-22 17:04:02 -07001922 * @attr ref android.R.styleable#Window_windowEnterTransition
George Mount0a778ed2013-12-13 13:35:36 -08001923 */
George Mount31a21722014-03-24 17:44:36 -07001924 public Transition getEnterTransition() { return null; }
George Mountcb4b7d92014-02-25 10:47:55 -08001925
1926 /**
Chet Haaseb64e777f2016-12-09 07:17:10 -08001927 * 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 -07001928 * preparing to close, for example after a call to
1929 * {@link android.app.Activity#finishAfterTransition()}. The exiting
1930 * Views will be those that are regular Views or ViewGroups that have
1931 * {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1932 * {@link android.transition.Visibility} as entering is governed by changing visibility from
1933 * {@link View#VISIBLE} to {@link View#INVISIBLE}.
George Mountc03da0e2014-08-22 17:04:02 -07001934 *
George Mount68f96d82014-07-31 13:13:10 -07001935 * @return The Transition to use to move Views out of the Scene when the Window
1936 * is preparing to close.
George Mountc03da0e2014-08-22 17:04:02 -07001937 * @attr ref android.R.styleable#Window_windowReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07001938 */
1939 public Transition getReturnTransition() { return null; }
1940
1941 /**
George Mount31a21722014-03-24 17:44:36 -07001942 * Returns the Transition that will be used to move Views out of the scene when starting a
1943 * new Activity. The exiting Views will be those that are regular Views or ViewGroups that
1944 * have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions will extend
1945 * {@link android.transition.Visibility} as exiting is governed by changing visibility
1946 * from {@link View#VISIBLE} to {@link View#INVISIBLE}. If transition is null, the views will
George Mount9826f632014-09-11 08:50:09 -07001947 * remain unaffected. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001948 *
George Mount31a21722014-03-24 17:44:36 -07001949 * @return the Transition to use to move Views out of the scene when calling a
1950 * new Activity.
George Mountc03da0e2014-08-22 17:04:02 -07001951 * @attr ref android.R.styleable#Window_windowExitTransition
George Mountcb4b7d92014-02-25 10:47:55 -08001952 */
George Mount31a21722014-03-24 17:44:36 -07001953 public Transition getExitTransition() { return null; }
George Mount0a778ed2013-12-13 13:35:36 -08001954
1955 /**
George Mount68f96d82014-07-31 13:13:10 -07001956 * Returns the Transition that will be used to move Views in to the scene when returning from
1957 * a previously-started Activity. The entering Views will be those that are regular Views
1958 * or ViewGroups that have {@link ViewGroup#isTransitionGroup} return true. Typical Transitions
1959 * will extend {@link android.transition.Visibility} as exiting is governed by changing
1960 * visibility from {@link View#VISIBLE} to {@link View#INVISIBLE}.
George Mount9826f632014-09-11 08:50:09 -07001961 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001962 *
George Mount68f96d82014-07-31 13:13:10 -07001963 * @return The Transition to use to move Views into the scene when reentering from a
1964 * previously-started Activity.
George Mountc03da0e2014-08-22 17:04:02 -07001965 * @attr ref android.R.styleable#Window_windowReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07001966 */
1967 public Transition getReenterTransition() { return null; }
1968
1969 /**
George Mount31a21722014-03-24 17:44:36 -07001970 * Sets the Transition that will be used for shared elements transferred into the content
1971 * Scene. Typical Transitions will affect size and location, such as
George Mount990205e2014-06-24 09:36:18 -07001972 * {@link android.transition.ChangeBounds}. A null
George Mount31a21722014-03-24 17:44:36 -07001973 * value will cause transferred shared elements to blink to the final position.
George Mount9826f632014-09-11 08:50:09 -07001974 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001975 *
George Mount31a21722014-03-24 17:44:36 -07001976 * @param transition The Transition to use for shared elements transferred into the content
1977 * Scene.
George Mountc03da0e2014-08-22 17:04:02 -07001978 * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
George Mount0a778ed2013-12-13 13:35:36 -08001979 */
George Mount31a21722014-03-24 17:44:36 -07001980 public void setSharedElementEnterTransition(Transition transition) {}
George Mounte1803372014-02-26 19:00:52 +00001981
1982 /**
George Mount68f96d82014-07-31 13:13:10 -07001983 * Sets the Transition that will be used for shared elements transferred back to a
1984 * calling Activity. Typical Transitions will affect size and location, such as
1985 * {@link android.transition.ChangeBounds}. A null
1986 * value will cause transferred shared elements to blink to the final position.
1987 * If no value is set, the default will be to use the same value as
1988 * {@link #setSharedElementEnterTransition(android.transition.Transition)}.
George Mount9826f632014-09-11 08:50:09 -07001989 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07001990 *
George Mount68f96d82014-07-31 13:13:10 -07001991 * @param transition The Transition to use for shared elements transferred out of the content
1992 * Scene.
George Mountc03da0e2014-08-22 17:04:02 -07001993 * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07001994 */
1995 public void setSharedElementReturnTransition(Transition transition) {}
1996
1997 /**
George Mount31a21722014-03-24 17:44:36 -07001998 * Returns the Transition that will be used for shared elements transferred into the content
George Mount9826f632014-09-11 08:50:09 -07001999 * Scene. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002000 *
George Mount31a21722014-03-24 17:44:36 -07002001 * @return Transition to use for sharend elements transferred into the content Scene.
George Mountc03da0e2014-08-22 17:04:02 -07002002 * @attr ref android.R.styleable#Window_windowSharedElementEnterTransition
George Mountcb4b7d92014-02-25 10:47:55 -08002003 */
George Mount31a21722014-03-24 17:44:36 -07002004 public Transition getSharedElementEnterTransition() { return null; }
George Mountcb4b7d92014-02-25 10:47:55 -08002005
2006 /**
George Mount68f96d82014-07-31 13:13:10 -07002007 * Returns the Transition that will be used for shared elements transferred back to a
George Mount9826f632014-09-11 08:50:09 -07002008 * calling Activity. Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002009 *
George Mount68f96d82014-07-31 13:13:10 -07002010 * @return Transition to use for sharend elements transferred into the content Scene.
George Mountc03da0e2014-08-22 17:04:02 -07002011 * @attr ref android.R.styleable#Window_windowSharedElementReturnTransition
George Mount68f96d82014-07-31 13:13:10 -07002012 */
2013 public Transition getSharedElementReturnTransition() { return null; }
2014
2015 /**
George Mount31a21722014-03-24 17:44:36 -07002016 * Sets the Transition that will be used for shared elements after starting a new Activity
2017 * before the shared elements are transferred to the called Activity. If the shared elements
2018 * must animate during the exit transition, this Transition should be used. Upon completion,
2019 * the shared elements may be transferred to the started Activity.
George Mount9826f632014-09-11 08:50:09 -07002020 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002021 *
George Mount31a21722014-03-24 17:44:36 -07002022 * @param transition The Transition to use for shared elements in the launching Window
2023 * prior to transferring to the launched Activity's Window.
George Mountc03da0e2014-08-22 17:04:02 -07002024 * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
George Mounte1803372014-02-26 19:00:52 +00002025 */
George Mount31a21722014-03-24 17:44:36 -07002026 public void setSharedElementExitTransition(Transition transition) {}
2027
2028 /**
George Mount68f96d82014-07-31 13:13:10 -07002029 * Sets the Transition that will be used for shared elements reentering from a started
2030 * Activity after it has returned the shared element to it start location. If no value
2031 * is set, this will default to
2032 * {@link #setSharedElementExitTransition(android.transition.Transition)}.
George Mount9826f632014-09-11 08:50:09 -07002033 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mountc03da0e2014-08-22 17:04:02 -07002034 *
George Mount68f96d82014-07-31 13:13:10 -07002035 * @param transition The Transition to use for shared elements in the launching Window
2036 * after the shared element has returned to the Window.
George Mountc03da0e2014-08-22 17:04:02 -07002037 * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07002038 */
2039 public void setSharedElementReenterTransition(Transition transition) {}
2040
2041 /**
George Mount31a21722014-03-24 17:44:36 -07002042 * Returns the Transition to use for shared elements in the launching Window prior
2043 * to transferring to the launched Activity's Window.
George Mount9826f632014-09-11 08:50:09 -07002044 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mount31a21722014-03-24 17:44:36 -07002045 *
2046 * @return the Transition to use for shared elements in the launching Window prior
2047 * to transferring to the launched Activity's Window.
George Mountc03da0e2014-08-22 17:04:02 -07002048 * @attr ref android.R.styleable#Window_windowSharedElementExitTransition
George Mount31a21722014-03-24 17:44:36 -07002049 */
2050 public Transition getSharedElementExitTransition() { return null; }
2051
2052 /**
George Mount68f96d82014-07-31 13:13:10 -07002053 * Returns the Transition that will be used for shared elements reentering from a started
2054 * Activity after it has returned the shared element to it start location.
George Mount9826f632014-09-11 08:50:09 -07002055 * Requires {@link #FEATURE_ACTIVITY_TRANSITIONS}.
George Mount68f96d82014-07-31 13:13:10 -07002056 *
2057 * @return the Transition that will be used for shared elements reentering from a started
2058 * Activity after it has returned the shared element to it start location.
George Mountc03da0e2014-08-22 17:04:02 -07002059 * @attr ref android.R.styleable#Window_windowSharedElementReenterTransition
George Mount68f96d82014-07-31 13:13:10 -07002060 */
2061 public Transition getSharedElementReenterTransition() { return null; }
2062
2063 /**
George Mount31a21722014-03-24 17:44:36 -07002064 * Controls how the transition set in
2065 * {@link #setEnterTransition(android.transition.Transition)} overlaps with the exit
2066 * transition of the calling Activity. When true, the transition will start as soon as possible.
2067 * When false, the transition will wait until the remote exiting transition completes before
George Mount5d52d312016-06-10 14:16:45 -07002068 * starting. The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002069 *
George Mount31a21722014-03-24 17:44:36 -07002070 * @param allow true to start the enter transition when possible or false to
2071 * wait until the exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002072 * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002073 */
2074 public void setAllowEnterTransitionOverlap(boolean allow) {}
2075
2076 /**
2077 * Returns how the transition set in
2078 * {@link #setEnterTransition(android.transition.Transition)} overlaps with the exit
2079 * transition of the calling Activity. When true, the transition will start as soon as possible.
2080 * When false, the transition will wait until the remote exiting transition completes before
George Mount5d52d312016-06-10 14:16:45 -07002081 * starting. The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002082 *
George Mount31a21722014-03-24 17:44:36 -07002083 * @return true when the enter transition should start as soon as possible or false to
2084 * when it should wait until the exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002085 * @attr ref android.R.styleable#Window_windowAllowEnterTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002086 */
2087 public boolean getAllowEnterTransitionOverlap() { return true; }
2088
2089 /**
2090 * Controls how the transition set in
2091 * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
2092 * transition of the called Activity when reentering after if finishes. When true,
2093 * the transition will start as soon as possible. When false, the transition will wait
2094 * until the called Activity's exiting transition completes before starting.
George Mount5d52d312016-06-10 14:16:45 -07002095 * The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002096 *
George Mount31a21722014-03-24 17:44:36 -07002097 * @param allow true to start the transition when possible or false to wait until the
2098 * called Activity's exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002099 * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002100 */
George Mountc03da0e2014-08-22 17:04:02 -07002101 public void setAllowReturnTransitionOverlap(boolean allow) {}
2102
2103 /**
George Mount31a21722014-03-24 17:44:36 -07002104 * Returns how the transition set in
2105 * {@link #setExitTransition(android.transition.Transition)} overlaps with the exit
2106 * transition of the called Activity when reentering after if finishes. When true,
2107 * the transition will start as soon as possible. When false, the transition will wait
2108 * until the called Activity's exiting transition completes before starting.
George Mount5d52d312016-06-10 14:16:45 -07002109 * The default value is true.
George Mountc03da0e2014-08-22 17:04:02 -07002110 *
George Mount31a21722014-03-24 17:44:36 -07002111 * @return true when the transition should start when possible or false when it should wait
2112 * until the called Activity's exiting transition completes.
George Mountc03da0e2014-08-22 17:04:02 -07002113 * @attr ref android.R.styleable#Window_windowAllowReturnTransitionOverlap
George Mount31a21722014-03-24 17:44:36 -07002114 */
George Mountc03da0e2014-08-22 17:04:02 -07002115 public boolean getAllowReturnTransitionOverlap() { return true; }
2116
2117 /**
George Mounted1e01d2014-06-05 13:49:12 -07002118 * Returns the duration, in milliseconds, of the window background fade
2119 * when transitioning into or away from an Activity when called with an Activity Transition.
2120 * <p>When executing the enter transition, the background starts transparent
George Mount9826f632014-09-11 08:50:09 -07002121 * and fades in. This requires {@link #FEATURE_ACTIVITY_TRANSITIONS}. The default is
George Mounted1e01d2014-06-05 13:49:12 -07002122 * 300 milliseconds.</p>
George Mountc03da0e2014-08-22 17:04:02 -07002123 *
George Mounted1e01d2014-06-05 13:49:12 -07002124 * @return The duration of the window background fade to opaque during enter transition.
2125 * @see #getEnterTransition()
George Mountc03da0e2014-08-22 17:04:02 -07002126 * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
George Mounted1e01d2014-06-05 13:49:12 -07002127 */
2128 public long getTransitionBackgroundFadeDuration() { return 0; }
2129
2130 /**
2131 * Sets the duration, in milliseconds, of the window background fade
2132 * when transitioning into or away from an Activity when called with an Activity Transition.
2133 * <p>When executing the enter transition, the background starts transparent
George Mount9826f632014-09-11 08:50:09 -07002134 * and fades in. This requires {@link #FEATURE_ACTIVITY_TRANSITIONS}. The default is
George Mounted1e01d2014-06-05 13:49:12 -07002135 * 300 milliseconds.</p>
George Mountc03da0e2014-08-22 17:04:02 -07002136 *
George Mounted1e01d2014-06-05 13:49:12 -07002137 * @param fadeDurationMillis The duration of the window background fade to or from opaque
2138 * during enter transition.
2139 * @see #setEnterTransition(android.transition.Transition)
George Mountc03da0e2014-08-22 17:04:02 -07002140 * @attr ref android.R.styleable#Window_windowTransitionBackgroundFadeDuration
George Mounted1e01d2014-06-05 13:49:12 -07002141 */
2142 public void setTransitionBackgroundFadeDuration(long fadeDurationMillis) { }
2143
2144 /**
George Mountb89d5cc2014-08-18 16:50:50 -07002145 * Returns <code>true</code> when shared elements should use an Overlay during
2146 * shared element transitions or <code>false</code> when they should animate as
2147 * part of the normal View hierarchy. The default value is true.
2148 *
2149 * @return <code>true</code> when shared elements should use an Overlay during
2150 * shared element transitions or <code>false</code> when they should animate as
2151 * part of the normal View hierarchy.
George Mountc03da0e2014-08-22 17:04:02 -07002152 * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
George Mountb89d5cc2014-08-18 16:50:50 -07002153 */
2154 public boolean getSharedElementsUseOverlay() { return true; }
2155
2156 /**
2157 * Sets whether or not shared elements should use an Overlay during shared element transitions.
2158 * The default value is true.
2159 *
2160 * @param sharedElementsUseOverlay <code>true</code> indicates that shared elements should
2161 * be transitioned with an Overlay or <code>false</code>
2162 * to transition within the normal View hierarchy.
George Mountc03da0e2014-08-22 17:04:02 -07002163 * @attr ref android.R.styleable#Window_windowSharedElementsUseOverlay
George Mountb89d5cc2014-08-18 16:50:50 -07002164 */
2165 public void setSharedElementsUseOverlay(boolean sharedElementsUseOverlay) { }
2166
2167 /**
Adrian Roos217ccd22014-05-09 14:29:04 +02002168 * @return the color of the status bar.
2169 */
Tor Norbye80756e32015-03-02 09:39:27 -08002170 @ColorInt
Adrian Roos217ccd22014-05-09 14:29:04 +02002171 public abstract int getStatusBarColor();
2172
2173 /**
John Spurlockbc4cf002015-03-24 21:51:20 -04002174 * Sets the color of the status bar to {@code color}.
Adrian Roos217ccd22014-05-09 14:29:04 +02002175 *
2176 * For this to take effect,
2177 * the window must be drawing the system bar backgrounds with
2178 * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2179 * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_STATUS} must not be set.
2180 *
John Spurlockbc4cf002015-03-24 21:51:20 -04002181 * If {@code color} is not opaque, consider setting
Adrian Roos217ccd22014-05-09 14:29:04 +02002182 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
2183 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
George Mount238010f2014-06-30 17:31:17 -07002184 * <p>
2185 * The transitionName for the view background will be "android:status:background".
2186 * </p>
Adrian Roos217ccd22014-05-09 14:29:04 +02002187 */
Tor Norbye80756e32015-03-02 09:39:27 -08002188 public abstract void setStatusBarColor(@ColorInt int color);
Adrian Roos217ccd22014-05-09 14:29:04 +02002189
2190 /**
2191 * @return the color of the navigation bar.
2192 */
Tor Norbye80756e32015-03-02 09:39:27 -08002193 @ColorInt
Adrian Roos217ccd22014-05-09 14:29:04 +02002194 public abstract int getNavigationBarColor();
2195
2196 /**
2197 * Sets the color of the navigation bar to {@param color}.
2198 *
2199 * For this to take effect,
2200 * the window must be drawing the system bar backgrounds with
2201 * {@link android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS} and
2202 * {@link android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_NAVIGATION} must not be set.
2203 *
2204 * If {@param color} is not opaque, consider setting
2205 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE} and
2206 * {@link android.view.View#SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}.
George Mount238010f2014-06-30 17:31:17 -07002207 * <p>
2208 * The transitionName for the view background will be "android:navigation:background".
2209 * </p>
Adrian Roos217ccd22014-05-09 14:29:04 +02002210 */
Tor Norbye80756e32015-03-02 09:39:27 -08002211 public abstract void setNavigationBarColor(@ColorInt int color);
Adrian Roos217ccd22014-05-09 14:29:04 +02002212
Filip Gruszczynski0daf2102015-09-29 08:39:07 -07002213 /** @hide */
2214 public void setTheme(int resId) {
2215 }
Filip Gruszczynski63250652015-11-18 14:43:01 -08002216
2217 /**
2218 * Whether the caption should be displayed directly on the content rather than push the content
2219 * down. This affects only freeform windows since they display the caption.
2220 * @hide
2221 */
Andrii Kulian933076d2016-03-29 17:04:42 -07002222 public void setOverlayWithDecorCaptionEnabled(boolean enabled) {
2223 mOverlayWithDecorCaptionEnabled = enabled;
Filip Gruszczynski63250652015-11-18 14:43:01 -08002224 }
2225
2226 /** @hide */
Andrii Kulian933076d2016-03-29 17:04:42 -07002227 public boolean isOverlayWithDecorCaptionEnabled() {
2228 return mOverlayWithDecorCaptionEnabled;
Filip Gruszczynski63250652015-11-18 14:43:01 -08002229 }
Filip Gruszczynski9b81e402015-12-08 15:42:01 -08002230
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002231 /** @hide */
2232 public void notifyRestrictedCaptionAreaCallback(int left, int top, int right, int bottom) {
Wale Ogunwalea504ca32016-01-30 16:02:13 -08002233 if (mOnRestrictedCaptionAreaChangedListener != null) {
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002234 mRestrictedCaptionAreaRect.set(left, top, right, bottom);
Wale Ogunwalea504ca32016-01-30 16:02:13 -08002235 mOnRestrictedCaptionAreaChangedListener.onRestrictedCaptionAreaChanged(
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002236 mRestrictedCaptionAreaRect);
2237 }
2238 }
Filip Gruszczynski9b81e402015-12-08 15:42:01 -08002239
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002240 /**
2241 * Set what color should the caption controls be. By default the system will try to determine
Wale Ogunwalea504ca32016-01-30 16:02:13 -08002242 * the color from the theme. You can overwrite this by using {@link #DECOR_CAPTION_SHADE_DARK},
2243 * {@link #DECOR_CAPTION_SHADE_LIGHT}, or {@link #DECOR_CAPTION_SHADE_AUTO}.
2244 * @see #DECOR_CAPTION_SHADE_DARK
2245 * @see #DECOR_CAPTION_SHADE_LIGHT
2246 * @see #DECOR_CAPTION_SHADE_AUTO
Filip Gruszczynski3dec0812015-12-09 08:42:41 -08002247 */
2248 public abstract void setDecorCaptionShade(int decorCaptionShade);
2249
2250 /**
2251 * Set the drawable that is drawn underneath the caption during the resizing.
2252 *
2253 * During the resizing the caption might not be drawn fast enough to match the new dimensions.
2254 * There is a second caption drawn underneath it that will be fast enough. By default the
2255 * caption is constructed from the theme. You can provide a drawable, that will be drawn instead
2256 * to better match your application.
2257 */
2258 public abstract void setResizingCaptionDrawable(Drawable drawable);
Wale Ogunwaleeb6722c2015-12-08 11:43:43 -08002259
2260 /**
2261 * Called when the activity changes from fullscreen mode to multi-window mode and visa-versa.
2262 * @hide
2263 */
Andrii Kulian933076d2016-03-29 17:04:42 -07002264 public abstract void onMultiWindowModeChanged();
Jorim Jaggi4846ee32016-01-07 17:39:12 +01002265
2266 /**
2267 * Called when the activity just relaunched.
2268 * @hide
2269 */
2270 public abstract void reportActivityRelaunched();
Michael Kwanf7964be2016-11-30 16:44:33 -08002271
2272 /**
2273 * Called to set flag to check if the close on swipe is enabled. This will only function if
2274 * FEATURE_SWIPE_TO_DISMISS has been set.
2275 * @hide
2276 */
2277 public void setCloseOnSwipeEnabled(boolean closeOnSwipeEnabled) {
2278 mCloseOnSwipeEnabled = closeOnSwipeEnabled;
2279 }
2280
2281 /**
2282 * @return {@code true} if the close on swipe is enabled.
2283 * @hide
2284 */
2285 public boolean isCloseOnSwipeEnabled() {
2286 return mCloseOnSwipeEnabled;
2287 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002288}