Window
public
abstract
class
Window
extends Object
java.lang.Object | |
↳ | android.view.Window |
Abstract base class for a top-level window look and behavior policy. An instance of this class should be used as the top-level view added to the window manager. It provides standard UI policies such as a background, title area, default key processing, etc.
The framework will instantiate an implementation of this class on behalf of the application.
Summary
Nested classes | |
---|---|
interface |
Window.Callback
API from a Window back to its caller. |
interface |
Window.OnFrameMetricsAvailableListener
Callback for clients that want frame timing information for each frame rendered by the Window. |
interface |
Window.OnRestrictedCaptionAreaChangedListener
Callback for clients that want to be aware of where caption draws content. |
XML attributes | |
---|---|
android:navigationBarColor |
This is deprecated.
Draw proper background behind
WindowInsets.Type.navigationBars() or
WindowInsets.Type.tappableElement() instead.
May be a color value, in the form of " |
android:navigationBarDividerColor |
This is deprecated.
Draw proper background behind
WindowInsets.Type.navigationBars() or
WindowInsets.Type.tappableElement() instead.
May be a color value, in the form of " |
android:windowAllowEnterTransitionOverlap |
Flag indicating whether this Window's transition should overlap with the exiting transition of the calling Activity. |
android:windowAllowReturnTransitionOverlap |
Flag indicating whether this Window's transition should overlap with the exiting transition of the called Activity when the called Activity finishes. |
android:windowContentTransitionManager |
Reference to a TransitionManager XML resource defining the desired transitions between different window content. |
android:windowEnterTransition |
Reference to a Transition XML resource defining the desired Transition used to move Views into the initial Window's content Scene. |
android:windowExitTransition |
Reference to a Transition XML resource defining the desired Transition used to move Views out of the Window's content Scene when launching a new Activity. |
android:windowReenterTransition |
Reference to a Transition XML resource defining the desired Transition used to move Views in to the scene when returning from a previously-started Activity. |
android:windowReturnTransition |
Reference to a Transition XML resource defining the desired Transition used to move Views out of the scene when the Window is preparing to close. |
android:windowSharedElementEnterTransition |
Reference to a Transition XML resource defining the desired Transition used to move shared elements transferred into the Window's initial content Scene. |
android:windowSharedElementExitTransition |
Reference to a Transition XML resource defining the desired Transition used when starting a new Activity to move shared elements prior to transferring to the called Activity. |
android:windowSharedElementReenterTransition |
Reference to a Transition XML resource defining the desired Transition used for shared elements transferred back to a calling Activity. |
android:windowSharedElementReturnTransition |
Reference to a Transition XML resource defining the desired Transition used to move shared elements transferred back to a calling Activity. |
android:windowSharedElementsUseOverlay |
Indicates whether or not shared elements should use an overlay during transitions. |
android:windowTransitionBackgroundFadeDuration |
The duration, in milliseconds, of the window background fade duration when transitioning into or away from an Activity when called with an Activity Transition. |
Constants | |
---|---|
int |
DECOR_CAPTION_SHADE_AUTO
Flag for letting the theme drive the color of the window caption controls. |
int |
DECOR_CAPTION_SHADE_DARK
Flag for setting dark-color controls on the window caption. |
int |
DECOR_CAPTION_SHADE_LIGHT
Flag for setting light-color controls on the window caption. |
int |
DEFAULT_FEATURES
This constant was deprecated
in API level 22.
use |
int |
FEATURE_ACTION_BAR
Flag for enabling the Action Bar. |
int |
FEATURE_ACTION_BAR_OVERLAY
Flag for requesting an Action Bar that overlays window content. |
int |
FEATURE_ACTION_MODE_OVERLAY
Flag for specifying the behavior of action modes when an Action Bar is not present. |
int |
FEATURE_ACTIVITY_TRANSITIONS
Enables Activities to run Activity Transitions either through sending or receiving
ActivityOptions bundle created with
|
int |
FEATURE_CONTENT_TRANSITIONS
Flag for requesting that window content changes should be animated using a TransitionManager. |
int |
FEATURE_CONTEXT_MENU
Flag for the context menu. |
int |
FEATURE_CUSTOM_TITLE
Flag for custom title. |
int |
FEATURE_INDETERMINATE_PROGRESS
This constant was deprecated in API level 24. No longer supported starting in API 21. |
int |
FEATURE_LEFT_ICON
Flag for having an icon on the left side of the title bar |
int |
FEATURE_NO_TITLE
Flag for the "no title" feature, turning off the title at the top of the screen. |
int |
FEATURE_OPTIONS_PANEL
Flag for the "options panel" feature. |
int |
FEATURE_PROGRESS
This constant was deprecated in API level 24. No longer supported starting in API 21. |
int |
FEATURE_RIGHT_ICON
Flag for having an icon on the right side of the title bar |
int |
FEATURE_SWIPE_TO_DISMISS
This constant was deprecated in API level 30. Swipe-to-dismiss isn't functional anymore. |
int |
ID_ANDROID_CONTENT
The ID that the main layout in the XML layout file should have. |
String |
NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME
The transitionName for the navigation bar background View when a custom background is used. |
int |
PROGRESS_END
This constant was deprecated
in API level 24.
|
int |
PROGRESS_INDETERMINATE_OFF
This constant was deprecated
in API level 24.
|
int |
PROGRESS_INDETERMINATE_ON
This constant was deprecated
in API level 24.
|
int |
PROGRESS_SECONDARY_END
This constant was deprecated
in API level 24.
|
int |
PROGRESS_SECONDARY_START
This constant was deprecated
in API level 24.
|
int |
PROGRESS_START
This constant was deprecated
in API level 24.
|
int |
PROGRESS_VISIBILITY_OFF
This constant was deprecated
in API level 24.
|
int |
PROGRESS_VISIBILITY_ON
This constant was deprecated
in API level 24.
|
String |
STATUS_BAR_BACKGROUND_TRANSITION_NAME
The transitionName for the status bar background View when a custom background is used. |
Public constructors | |
---|---|
Window(Context context)
|
Public methods | |
---|---|
abstract
void
|
addContentView(View view, ViewGroup.LayoutParams params)
Variation on
|
void
|
addFlags(int flags)
Convenience function to set the flag bits as specified in flags, as
per |
final
void
|
addOnFrameMetricsAvailableListener(Window.OnFrameMetricsAvailableListener listener, Handler handler)
Set an observer to collect frame stats for each frame rendered in this window. |
void
|
clearFlags(int flags)
Convenience function to clear the flag bits as specified in flags, as
per |
abstract
void
|
closeAllPanels()
|
abstract
void
|
closePanel(int featureId)
|
<T extends View>
T
|
findViewById(int id)
Finds a view that was identified by the |
boolean
|
getAllowEnterTransitionOverlap()
Returns how the transition set in
|
boolean
|
getAllowReturnTransitionOverlap()
Returns how the transition set in
|
final
WindowManager.LayoutParams
|
getAttributes()
Retrieve the current window attributes associated with this panel. |
final
Window.Callback
|
getCallback()
Return the current Callback interface for this window. |
int
|
getColorMode()
Returns the requested color mode of the window, one of
|
final
Window
|
getContainer()
Return the container for this Window. |
Scene
|
getContentScene()
Retrieve the |
final
Context
|
getContext()
Return the Context this window policy is running in, for retrieving resources and other information. |
abstract
View
|
getCurrentFocus()
Return the view in this Window that currently has focus, or null if there are none. |
abstract
View
|
getDecorView()
Retrieve the top-level window decor view (containing the standard window frame/decorations and the client's content inside of that), which can be added as a window to the window manager. |
static
int
|
getDefaultFeatures(Context context)
Return the feature bits set by default on a window. |
float
|
getDesiredHdrHeadroom()
Get the desired amount of HDR headroom as set by |
Transition
|
getEnterTransition()
Returns the transition used to move Views into the initial scene. |
Transition
|
getExitTransition()
Returns the Transition that will be used to move Views out of the scene when starting a new Activity. |
boolean
|
getFrameRateBoostOnTouchEnabled()
Get whether frame rate touch boost is enabled
|
WindowInsetsController
|
getInsetsController()
|
abstract
LayoutInflater
|
getLayoutInflater()
Quick access to the |
MediaController
|
getMediaController()
Gets the |
abstract
int
|
getNavigationBarColor()
This method was deprecated in API level 35. This is no longer needed since the setter is deprecated. |
int
|
getNavigationBarDividerColor()
This method was deprecated in API level 35. This is no longer needed since the setter is deprecated. |
OnBackInvokedDispatcher
|
getOnBackInvokedDispatcher()
Returns the |
Transition
|
getReenterTransition()
Returns the Transition that will be used to move Views in to the scene when returning from a previously-started Activity. |
Transition
|
getReturnTransition()
Returns the Transition that will be used to move Views out of the scene when the Window is
preparing to close, for example after a call to
|
AttachedSurfaceControl
|
getRootSurfaceControl()
This will be null before a content view is added, e.g. via
|
Transition
|
getSharedElementEnterTransition()
Returns the Transition that will be used for shared elements transferred into the content Scene. |
Transition
|
getSharedElementExitTransition()
Returns the Transition to use for shared elements in the launching Window prior to transferring to the launched Activity's Window. |
Transition
|
getSharedElementReenterTransition()
Returns the Transition that will be used for shared elements reentering from a started Activity after it has returned the shared element to it start location. |
Transition
|
getSharedElementReturnTransition()
Returns the Transition that will be used for shared elements transferred back to a calling Activity. |
boolean
|
getSharedElementsUseOverlay()
Returns |
abstract
int
|
getStatusBarColor()
This method was deprecated in API level 35. This is no longer needed since the setter is deprecated. |
List<Rect>
|
getSystemGestureExclusionRects()
Retrieve the list of areas within this window's coordinate space where the system should not intercept touch or other pointing device gestures. |
long
|
getTransitionBackgroundFadeDuration()
Returns the duration, in milliseconds, of the window background fade when transitioning into or away from an Activity when called with an Activity Transition. |
TransitionManager
|
getTransitionManager()
Retrieve the |
abstract
int
|
getVolumeControlStream()
|
WindowManager
|
getWindowManager()
Return the window manager allowing this Window to display its own windows. |
final
TypedArray
|
getWindowStyle()
Return the |
final
boolean
|
hasChildren()
|
boolean
|
hasFeature(int feature)
Query for the availability of a certain feature. |
void
|
injectInputEvent(InputEvent event)
Inject an event to window locally. |
abstract
void
|
invalidatePanelMenu(int featureId)
|
final
boolean
|
isActive()
|
abstract
boolean
|
isFloating()
Return whether this window is being displayed with a floating style
(based on the |
boolean
|
isFrameRatePowerSavingsBalanced()
Get whether frameratepowersavingsbalance is enabled for this Window. |
boolean
|
isNavigationBarContrastEnforced()
Returns whether the system is ensuring that the navigation bar has enough contrast when a fully transparent background is requested. |
abstract
boolean
|
isShortcutKey(int keyCode, KeyEvent event)
Is a keypress one of the defined shortcut keys for this window. |
boolean
|
isStatusBarContrastEnforced()
This method was deprecated in API level 35. This is not needed since the setter is deprecated. |
boolean
|
isWideColorGamut()
Returns true if this window's color mode is |
final
void
|
makeActive()
|
abstract
void
|
onConfigurationChanged(Configuration newConfig)
Should be called when the configuration is changed. |
abstract
void
|
openPanel(int featureId, KeyEvent event)
|
abstract
View
|
peekDecorView()
Retrieve the current decor view, but only if it has already been created; otherwise returns null. |
abstract
boolean
|
performContextMenuIdentifierAction(int id, int flags)
|
abstract
boolean
|
performPanelIdentifierAction(int featureId, int id, int flags)
|
abstract
boolean
|
performPanelShortcut(int featureId, int keyCode, KeyEvent event, int flags)
|
void
|
registerScrollCaptureCallback(ScrollCaptureCallback callback)
Used to provide scroll capture support for an arbitrary window. |
final
void
|
removeOnFrameMetricsAvailableListener(Window.OnFrameMetricsAvailableListener listener)
Remove observer and stop listening to frame stats for this window. |
boolean
|
requestFeature(int featureId)
Enable extended screen features. |
final
<T extends View>
T
|
requireViewById(int id)
Finds a view that was identified by the |
abstract
void
|
restoreHierarchyState(Bundle savedInstanceState)
|
abstract
Bundle
|
saveHierarchyState()
|
void
|
setAllowEnterTransitionOverlap(boolean allow)
Controls how the transition set in
|
void
|
setAllowReturnTransitionOverlap(boolean allow)
Controls how the transition set in
|
void
|
setAttributes(WindowManager.LayoutParams a)
Specify custom window attributes. |
void
|
setBackgroundBlurRadius(int blurRadius)
Blurs the screen behind the window within the bounds of the window. |
abstract
void
|
setBackgroundDrawable(Drawable drawable)
Change the background of this window to a custom Drawable. |
void
|
setBackgroundDrawableResource(int resId)
Change the background of this window to a Drawable resource. |
void
|
setCallback(Window.Callback callback)
Set the Callback interface for this window, used to intercept key events and other dynamic operations in the window. |
abstract
void
|
setChildDrawable(int featureId, Drawable drawable)
|
abstract
void
|
setChildInt(int featureId, int value)
|
void
|
setClipToOutline(boolean clipToOutline)
Sets whether window content should be clipped to the outline of the window background. |
void
|
setColorMode(int colorMode)
Sets the requested color mode of the window. |
void
|
setContainer(Window container)
Set the container for this window. |
abstract
void
|
setContentView(View view, ViewGroup.LayoutParams params)
Set the screen content to an explicit view. |
abstract
void
|
setContentView(View view)
Convenience for
|
abstract
void
|
setContentView(int layoutResID)
Convenience for
|
abstract
void
|
setDecorCaptionShade(int decorCaptionShade)
Set what color should the caption controls be. |
void
|
setDecorFitsSystemWindows(boolean decorFitsSystemWindows)
This method was deprecated
in API level 35.
Make space in the container views to prevent the critical elements from getting
obscured by |
void
|
setDesiredHdrHeadroom(float desiredHeadroom)
Sets the desired about of HDR headroom to be used when rendering as a ratio of targetHdrPeakBrightnessInNits / targetSdrWhitePointInNits. |
void
|
setDimAmount(float amount)
Set the amount of dim behind the window when using
|
void
|
setElevation(float elevation)
Sets the window elevation. |
void
|
setEnterTransition(Transition transition)
Sets the Transition that will be used to move Views into the initial scene. |
void
|
setExitTransition(Transition transition)
Sets the Transition that will be used to move Views out of the scene when starting a new Activity. |
abstract
void
|
setFeatureDrawable(int featureId, Drawable drawable)
Set an explicit Drawable value for feature of this window. |
abstract
void
|
setFeatureDrawableAlpha(int featureId, int alpha)
Set a custom alpha value for the given drawable feature, controlling how much the background is visible through it. |
abstract
void
|
setFeatureDrawableResource(int featureId, int resId)
Set the value for a drawable feature of this window, from a resource identifier. |
abstract
void
|
setFeatureDrawableUri(int featureId, Uri uri)
Set the value for a drawable feature of this window, from a URI. |
abstract
void
|
setFeatureInt(int featureId, int value)
Set the integer value for a feature. |
void
|
setFlags(int flags, int mask)
Set the flags of the window, as per the
|
void
|
setFormat(int format)
Set the format of window, as per the PixelFormat types. |
void
|
setFrameRateBoostOnTouchEnabled(boolean enabled)
Sets whether the frame rate touch boost is enabled for this Window. |
void
|
setFrameRatePowerSavingsBalanced(boolean enabled)
Set whether frameratepowersavingsbalance is enabled for this Window. |
void
|
setGravity(int gravity)
Set the gravity of the window, as per the Gravity constants. |
final
void
|
setHideOverlayWindows(boolean hide)
Prevent non-system overlay windows from being drawn on top of this window. |
void
|
setIcon(int resId)
Set the primary icon for this window. |
void
|
setLayout(int width, int height)
Set the width and height layout parameters of the window. |
void
|
setLocalFocus(boolean hasFocus, boolean inTouchMode)
Set focus locally. |
void
|
setLogo(int resId)
Set the logo for this window. |
void
|
setMediaController(MediaController controller)
Sets a |
abstract
void
|
setNavigationBarColor(int color)
This method was deprecated
in API level 35.
Draw proper background behind |
void
|
setNavigationBarContrastEnforced(boolean enforceContrast)
Sets whether the system should ensure that the navigation bar has enough contrast when a fully transparent background is requested. |
void
|
setNavigationBarDividerColor(int dividerColor)
This method was deprecated
in API level 35.
Draw proper background behind |
void
|
setPreferMinimalPostProcessing(boolean isPreferred)
If |
void
|
setReenterTransition(Transition transition)
Sets the Transition that will be used to move Views in to the scene when returning from a previously-started Activity. |
abstract
void
|
setResizingCaptionDrawable(Drawable drawable)
Set the drawable that is drawn underneath the caption during the resizing. |
final
void
|
setRestrictedCaptionAreaListener(Window.OnRestrictedCaptionAreaChangedListener listener)
Set a callback for changes of area where caption will draw its content. |
void
|
setReturnTransition(Transition transition)
Sets the Transition that will be used to move Views out of the scene when the Window is
preparing to close, for example after a call to
|
void
|
setSharedElementEnterTransition(Transition transition)
Sets the Transition that will be used for shared elements transferred into the content Scene. |
void
|
setSharedElementExitTransition(Transition transition)
Sets the Transition that will be used for shared elements after starting a new Activity before the shared elements are transferred to the called Activity. |
void
|
setSharedElementReenterTransition(Transition transition)
Sets the Transition that will be used for shared elements reentering from a started Activity after it has returned the shared element to it start location. |
void
|
setSharedElementReturnTransition(Transition transition)
Sets the Transition that will be used for shared elements transferred back to a calling Activity. |
void
|
setSharedElementsUseOverlay(boolean sharedElementsUseOverlay)
Sets whether or not shared elements should use an Overlay during shared element transitions. |
void
|
setSoftInputMode(int mode)
Specify an explicit soft input mode to use for the window, as per
|
abstract
void
|
setStatusBarColor(int color)
This method was deprecated
in API level 35.
Draw proper background behind |
void
|
setStatusBarContrastEnforced(boolean ensureContrast)
This method was deprecated
in API level 35.
Draw proper background behind |
void
|
setSustainedPerformanceMode(boolean enable)
|
void
|
setSystemGestureExclusionRects(List<Rect> rects)
Sets a list of areas within this window's coordinate space where the system should not intercept touch or other pointing device gestures. |
abstract
void
|
setTitle(CharSequence title)
|
abstract
void
|
setTitleColor(int textColor)
|
void
|
setTransitionBackgroundFadeDuration(long fadeDurationMillis)
Sets the duration, in milliseconds, of the window background fade when transitioning into or away from an Activity when called with an Activity Transition. |
void
|
setTransitionManager(TransitionManager tm)
Set the |
void
|
setType(int type)
Set the type of the window, as per the WindowManager.LayoutParams types. |
void
|
setUiOptions(int uiOptions)
Set extra options that will influence the UI for this window. |
void
|
setUiOptions(int uiOptions, int mask)
Set extra options that will influence the UI for this window. |
abstract
void
|
setVolumeControlStream(int streamType)
|
void
|
setWindowAnimations(int resId)
Specify custom animations to use for the window, as per
|
void
|
setWindowManager(WindowManager wm, IBinder appToken, String appName)
Set the window manager for use by this Window to, for example, display panels. |
void
|
setWindowManager(WindowManager wm, IBinder appToken, String appName, boolean hardwareAccelerated)
Set the window manager for use by this Window to, for example, display panels. |
abstract
boolean
|
superDispatchGenericMotionEvent(MotionEvent event)
Used by custom windows, such as Dialog, to pass the generic motion event further down the view hierarchy. |
abstract
boolean
|
superDispatchKeyEvent(KeyEvent event)
Used by custom windows, such as Dialog, to pass the key press event further down the view hierarchy. |
abstract
boolean
|
superDispatchKeyShortcutEvent(KeyEvent event)
Used by custom windows, such as Dialog, to pass the key shortcut press event further down the view hierarchy. |
abstract
boolean
|
superDispatchTouchEvent(MotionEvent event)
Used by custom windows, such as Dialog, to pass the touch screen event further down the view hierarchy. |
abstract
boolean
|
superDispatchTrackballEvent(MotionEvent event)
Used by custom windows, such as Dialog, to pass the trackball event further down the view hierarchy. |
abstract
void
|
takeInputQueue(InputQueue.Callback callback)
Take ownership of this window's InputQueue. |
abstract
void
|
takeKeyEvents(boolean get)
Request that key events come to this activity. |
abstract
void
|
takeSurface(SurfaceHolder.Callback2 callback)
Take ownership of this window's surface. |
abstract
void
|
togglePanel(int featureId, KeyEvent event)
|
void
|
unregisterScrollCaptureCallback(ScrollCaptureCallback callback)
Unregisters a |
Protected methods | |
---|---|
final
int
|
getFeatures()
Return the feature bits that are enabled. |
final
int
|
getForcedWindowFlags()
Return the window flags that have been explicitly set by the client,
so will not be modified by |
final
int
|
getLocalFeatures()
Return the feature bits that are being implemented by this Window. |
final
boolean
|
hasSoftInputMode()
Has the app specified their own soft input mode? |
abstract
void
|
onActive()
|
void
|
setDefaultWindowFormat(int format)
Set the default format of window, as per the PixelFormat types. |
Inherited methods | |
---|---|
XML attributes
android:navigationBarColor
This is deprecated.
Draw proper background behind
WindowInsets.Type.navigationBars()
or
WindowInsets.Type.tappableElement()
instead.
May be a color value, in the form of "#rgb
",
"#argb
", "#rrggbb
", or
"#aarrggbb
".
The color for the navigation bar. If the color is not opaque, consider setting
View.SYSTEM_UI_FLAG_LAYOUT_STABLE
and
View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
.
For this to take effect, the window must be drawing the system bar backgrounds with
R.attr.windowDrawsSystemBarBackgrounds
and the navigation bar must not
have been requested to be translucent with
R.attr.windowTranslucentNavigation
.
Corresponds to Window.setNavigationBarColor(int)
.
If the color is transparent and the window enforces the navigation bar contrast, the
system will determine whether a scrim is necessary and draw one on behalf of the app to
ensure that the navigation bar has enough contrast with the contents of this app, and
set an appropriate effective bar background accordingly.
See: R.attr.enforceNavigationBarContrast
If the window belongs to an app targeting
VANILLA_ICE_CREAM
or above,
this attribute is ignored.
Related methods:
android:navigationBarDividerColor
This is deprecated.
Draw proper background behind
WindowInsets.Type.navigationBars()
or
WindowInsets.Type.tappableElement()
instead.
May be a color value, in the form of "#rgb
",
"#argb
", "#rrggbb
", or
"#aarrggbb
".
Shows a thin line of the specified color between the navigation bar and the app content.
For this to take effect, the window must be drawing the system bar backgrounds with
R.attr.windowDrawsSystemBarBackgrounds
and the navigation bar must not
have been requested to be translucent with
R.attr.windowTranslucentNavigation
.
Corresponds to Window.setNavigationBarDividerColor(int)
.
If the window belongs to an app targeting
VANILLA_ICE_CREAM
or above,
this attribute is ignored.
Related methods:
android:windowAllowEnterTransitionOverlap
Flag indicating whether this Window's transition should overlap with
the exiting transition of the calling Activity. Corresponds to
Window.setAllowEnterTransitionOverlap(boolean)
.
May be a boolean value, such as "true
" or
"false
".
Related methods:
android:windowAllowReturnTransitionOverlap
Flag indicating whether this Window's transition should overlap with
the exiting transition of the called Activity when the called Activity
finishes. Corresponds to
Window.setAllowReturnTransitionOverlap(boolean)
.
May be a boolean value, such as "true
" or
"false
".
Related methods:
android:windowContentTransitionManager
Reference to a TransitionManager XML resource defining the desired transitions between different window content.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowEnterTransition
Reference to a Transition XML resource defining the desired Transition
used to move Views into the initial Window's content Scene. Corresponds to
Window.setEnterTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowExitTransition
Reference to a Transition XML resource defining the desired Transition
used to move Views out of the Window's content Scene when launching a new Activity.
Corresponds to
Window.setExitTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowReenterTransition
Reference to a Transition XML resource defining the desired Transition
used to move Views in to the scene when returning from a previously-started Activity.
Corresponds to
Window.setReenterTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowReturnTransition
Reference to a Transition XML resource defining the desired Transition
used to move Views out of the scene when the Window is
preparing to close. Corresponds to
Window.setReturnTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowSharedElementEnterTransition
Reference to a Transition XML resource defining the desired Transition
used to move shared elements transferred into the Window's initial content Scene.
Corresponds to Window.setSharedElementEnterTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowSharedElementExitTransition
Reference to a Transition XML resource defining the desired Transition
used when starting a new Activity to move shared elements prior to transferring
to the called Activity.
Corresponds to Window.setSharedElementExitTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowSharedElementReenterTransition
Reference to a Transition XML resource defining the desired Transition
used for shared elements transferred back to a calling Activity.
Corresponds to Window.setSharedElementReenterTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowSharedElementReturnTransition
Reference to a Transition XML resource defining the desired Transition
used to move shared elements transferred back to a calling Activity.
Corresponds to Window.setSharedElementReturnTransition(android.transition.Transition)
.
May be a reference to another resource, in the form
"@[+][package:]type/name
" or a theme
attribute in the form
"?[package:]type/name
".
Related methods:
android:windowSharedElementsUseOverlay
Indicates whether or not shared elements should use an overlay during transitions. The default value is true.
May be a boolean value, such as "true
" or
"false
".
Related methods:
android:windowTransitionBackgroundFadeDuration
The duration, in milliseconds, of the window background fade duration
when transitioning into or away from an Activity when called with an
Activity Transition. Corresponds to
Window.setTransitionBackgroundFadeDuration(long)
.
May be an integer value, such as "100
".
Related methods:
Constants
DECOR_CAPTION_SHADE_AUTO
public static final int DECOR_CAPTION_SHADE_AUTO
Flag for letting the theme drive the color of the window caption controls. Use with
setDecorCaptionShade(int)
. This is the default value.
Constant Value: 0 (0x00000000)
DECOR_CAPTION_SHADE_DARK
public static final int DECOR_CAPTION_SHADE_DARK
Flag for setting dark-color controls on the window caption. Use with
setDecorCaptionShade(int)
.
Constant Value: 2 (0x00000002)
DECOR_CAPTION_SHADE_LIGHT
public static final int DECOR_CAPTION_SHADE_LIGHT
Flag for setting light-color controls on the window caption. Use with
setDecorCaptionShade(int)
.
Constant Value: 1 (0x00000001)
DEFAULT_FEATURES
protected static final int DEFAULT_FEATURES
This constant was deprecated
in API level 22.
use getDefaultFeatures(android.content.Context)
instead.
The default features enabled.
Constant Value: 65 (0x00000041)
FEATURE_ACTION_BAR
public static final int FEATURE_ACTION_BAR
Flag for enabling the Action Bar. This is enabled by default for some devices. The Action Bar replaces the title bar and provides an alternate location for an on-screen menu button on some devices.
Constant Value: 8 (0x00000008)
FEATURE_ACTION_BAR_OVERLAY
public static final int FEATURE_ACTION_BAR_OVERLAY
Flag for requesting an Action Bar that overlays window content.
Normally an Action Bar will sit in the space above window content, but if this
feature is requested along with FEATURE_ACTION_BAR
it will be layered over
the window content itself. This is useful if you would like your app to have more control
over how the Action Bar is displayed, such as letting application content scroll beneath
an Action Bar with a transparent background or otherwise displaying a transparent/translucent
Action Bar over application content.
This mode is especially useful with View.SYSTEM_UI_FLAG_FULLSCREEN
, which allows you to seamlessly hide the
action bar in conjunction with other screen decorations.
As of Build.VERSION_CODES.JELLY_BEAN
, when an
ActionBar is in this mode it will adjust the insets provided to
View.fitSystemWindows(Rect)
to include the content covered by the action bar, so you can do layout within
that space.
Constant Value: 9 (0x00000009)
FEATURE_ACTION_MODE_OVERLAY
public static final int FEATURE_ACTION_MODE_OVERLAY
Flag for specifying the behavior of action modes when an Action Bar is not present. If overlay is enabled, the action mode UI will be allowed to cover existing window content.
Constant Value: 10 (0x0000000a)
FEATURE_ACTIVITY_TRANSITIONS
public static final int FEATURE_ACTIVITY_TRANSITIONS
Enables Activities to run Activity Transitions either through sending or receiving
ActivityOptions bundle created with
ActivityOptions.makeSceneTransitionAnimation(android.app.Activity, android.util.Pair[])
or ActivityOptions.makeSceneTransitionAnimation(android.app.Activity, View, String)
.
Constant Value: 13 (0x0000000d)
FEATURE_CONTENT_TRANSITIONS
public static final int FEATURE_CONTENT_TRANSITIONS
Flag for requesting that window content changes should be animated using a TransitionManager.
The TransitionManager is set using
setTransitionManager(android.transition.TransitionManager)
. If none is set,
a default TransitionManager will be used.
See also:
Constant Value: 12 (0x0000000c)
FEATURE_CONTEXT_MENU
public static final int FEATURE_CONTEXT_MENU
Flag for the context menu. This is enabled by default.
Constant Value: 6 (0x00000006)
FEATURE_CUSTOM_TITLE
public static final int FEATURE_CUSTOM_TITLE
Flag for custom title. You cannot combine this feature with other title features.
Constant Value: 7 (0x00000007)
FEATURE_INDETERMINATE_PROGRESS
public static final int FEATURE_INDETERMINATE_PROGRESS
This constant was deprecated
in API level 24.
No longer supported starting in API 21.
Flag for indeterminate progress.
Constant Value: 5 (0x00000005)
FEATURE_LEFT_ICON
public static final int FEATURE_LEFT_ICON
Flag for having an icon on the left side of the title bar
Constant Value: 3 (0x00000003)
FEATURE_NO_TITLE
public static final int FEATURE_NO_TITLE
Flag for the "no title" feature, turning off the title at the top of the screen.
Constant Value: 1 (0x00000001)
FEATURE_OPTIONS_PANEL
public static final int FEATURE_OPTIONS_PANEL
Flag for the "options panel" feature. This is enabled by default.
Constant Value: 0 (0x00000000)
FEATURE_PROGRESS
public static final int FEATURE_PROGRESS
This constant was deprecated
in API level 24.
No longer supported starting in API 21.
Flag for the progress indicator feature.
Constant Value: 2 (0x00000002)
FEATURE_RIGHT_ICON
public static final int FEATURE_RIGHT_ICON
Flag for having an icon on the right side of the title bar
Constant Value: 4 (0x00000004)
FEATURE_SWIPE_TO_DISMISS
public static final int FEATURE_SWIPE_TO_DISMISS
This constant was deprecated
in API level 30.
Swipe-to-dismiss isn't functional anymore.
Flag for requesting a decoration-free window that is dismissed by swiping from the left.
Constant Value: 11 (0x0000000b)
ID_ANDROID_CONTENT
public static final int ID_ANDROID_CONTENT
The ID that the main layout in the XML layout file should have.
Constant Value: 16908290 (0x01020002)
NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME
public static final String NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME
The transitionName for the navigation bar background View when a custom background is used.
See also:
Constant Value: "android:navigation:background"
PROGRESS_END
public static final int PROGRESS_END
This constant was deprecated
in API level 24.
FEATURE_PROGRESS
and related methods are no longer
supported starting in API 21.
Ending value for the (primary) progress.
Constant Value: 10000 (0x00002710)
PROGRESS_INDETERMINATE_OFF
public static final int PROGRESS_INDETERMINATE_OFF
This constant was deprecated
in API level 24.
FEATURE_INDETERMINATE_PROGRESS
and related methods
are no longer supported starting in API 21.
Flag for setting the progress bar's indeterminate mode off.
Constant Value: -4 (0xfffffffc)
PROGRESS_INDETERMINATE_ON
public static final int PROGRESS_INDETERMINATE_ON
This constant was deprecated
in API level 24.
FEATURE_INDETERMINATE_PROGRESS
and related methods
are no longer supported starting in API 21.
Flag for setting the progress bar's indeterminate mode on.
Constant Value: -3 (0xfffffffd)
PROGRESS_SECONDARY_END
public static final int PROGRESS_SECONDARY_END
This constant was deprecated
in API level 24.
FEATURE_PROGRESS
and related methods are no longer
supported starting in API 21.
Highest possible value for the secondary progress.
Constant Value: 30000 (0x00007530)
PROGRESS_SECONDARY_START
public static final int PROGRESS_SECONDARY_START
This constant was deprecated
in API level 24.
FEATURE_PROGRESS
and related methods are no longer
supported starting in API 21.
Lowest possible value for the secondary progress.
Constant Value: 20000 (0x00004e20)
PROGRESS_START
public static final int PROGRESS_START
This constant was deprecated
in API level 24.
FEATURE_PROGRESS
and related methods are no longer
supported starting in API 21.
Starting value for the (primary) progress.
Constant Value: 0 (0x00000000)
PROGRESS_VISIBILITY_OFF
public static final int PROGRESS_VISIBILITY_OFF
This constant was deprecated
in API level 24.
FEATURE_PROGRESS
and related methods are no longer
supported starting in API 21.
Flag for setting the progress bar's visibility to GONE.
Constant Value: -2 (0xfffffffe)
PROGRESS_VISIBILITY_ON
public static final int PROGRESS_VISIBILITY_ON
This constant was deprecated
in API level 24.
FEATURE_PROGRESS
and related methods are no longer
supported starting in API 21.
Flag for setting the progress bar's visibility to VISIBLE.
Constant Value: -1 (0xffffffff)
STATUS_BAR_BACKGROUND_TRANSITION_NAME
public static final String STATUS_BAR_BACKGROUND_TRANSITION_NAME
The transitionName for the status bar background View when a custom background is used.
See also:
Constant Value: "android:status:background"
Public constructors
Public methods
addContentView
public abstract void addContentView (View view, ViewGroup.LayoutParams params)
Variation on
setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
to add an additional content view to the screen. Added after any existing
ones in the screen -- existing views are NOT removed.
Parameters | |
---|---|
view |
View : The desired content to display. |
params |
ViewGroup.LayoutParams : Layout parameters for the view. |
addFlags
public void addFlags (int flags)
Convenience function to set the flag bits as specified in flags, as
per setFlags(int, int)
.
Parameters | |
---|---|
flags |
int : The flag bits to be set. |
See also:
addOnFrameMetricsAvailableListener
public final void addOnFrameMetricsAvailableListener (Window.OnFrameMetricsAvailableListener listener, Handler handler)
Set an observer to collect frame stats for each frame rendered in this window. Must be in hardware rendering mode.
Parameters | |
---|---|
listener |
Window.OnFrameMetricsAvailableListener : This value cannot be null . |
handler |
Handler |
clearFlags
public void clearFlags (int flags)
Convenience function to clear the flag bits as specified in flags, as
per setFlags(int, int)
.
Parameters | |
---|---|
flags |
int : The flag bits to be cleared. |
See also:
closePanel
public abstract void closePanel (int featureId)
Parameters | |
---|---|
featureId |
int |
findViewById
public T findViewById (int id)
Finds a view that was identified by the android:id
XML attribute
that was processed in Activity.onCreate(Bundle)
.
This will implicitly call getDecorView()
with all of the associated side-effects.
Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.
Parameters | |
---|---|
id |
int : the ID to search for |
Returns | |
---|---|
T |
a view with given ID if found, or null otherwise |
getAllowEnterTransitionOverlap
public boolean getAllowEnterTransitionOverlap ()
Returns how the transition set in
setEnterTransition(android.transition.Transition)
overlaps with the exit
transition of the calling Activity. When true, the transition will start as soon as possible.
When false, the transition will wait until the remote exiting transition completes before
starting. The default value is true.
Related XML Attributes:
Returns | |
---|---|
boolean |
true when the enter transition should start as soon as possible or false to when it should wait until the exiting transition completes. |
getAllowReturnTransitionOverlap
public boolean getAllowReturnTransitionOverlap ()
Returns how the transition set in
setExitTransition(android.transition.Transition)
overlaps with the exit
transition of the called Activity when reentering after if finishes. When true,
the transition will start as soon as possible. When false, the transition will wait
until the called Activity's exiting transition completes before starting.
The default value is true.
Related XML Attributes:
Returns | |
---|---|
boolean |
true when the transition should start when possible or false when it should wait until the called Activity's exiting transition completes. |
getAttributes
public final WindowManager.LayoutParams getAttributes ()
Retrieve the current window attributes associated with this panel.
Returns | |
---|---|
WindowManager.LayoutParams |
WindowManager.LayoutParams Either the existing window attributes object, or a freshly created one if there is none. |
getCallback
public final Window.Callback getCallback ()
Return the current Callback interface for this window.
Returns | |
---|---|
Window.Callback |
getColorMode
public int getColorMode ()
Returns the requested color mode of the window, one of
ActivityInfo#COLOR_MODE_DEFAULT
, ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT
or ActivityInfo#COLOR_MODE_HDR
. If ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT
was requested it is possible the window will not be put in wide color gamut mode depending
on device and display support for that mode. Use isWideColorGamut()
to determine
if the window is currently in wide color gamut mode.
Returns | |
---|---|
int |
Value is ActivityInfo.COLOR_MODE_DEFAULT , ActivityInfo.COLOR_MODE_WIDE_COLOR_GAMUT , ActivityInfo.COLOR_MODE_HDR , or android.content.pm.ActivityInfo.COLOR_MODE_A8 |
getContainer
public final Window getContainer ()
Return the container for this Window.
Returns | |
---|---|
Window |
Window The containing window, or null if this is a top-level window. |
getContentScene
public Scene getContentScene ()
Retrieve the Scene
representing this window's current content.
Requires FEATURE_CONTENT_TRANSITIONS
.
This method will return null if the current content is not represented by a Scene.
Returns | |
---|---|
Scene |
Current Scene being shown or null |
getContext
public final Context getContext ()
Return the Context this window policy is running in, for retrieving resources and other information.
Returns | |
---|---|
Context |
Context The Context that was supplied to the constructor. |
getCurrentFocus
public abstract View getCurrentFocus ()
Return the view in this Window that currently has focus, or null if there are none. Note that this does not look in any containing Window.
Returns | |
---|---|
View |
View The current View with focus or null. |
getDecorView
public abstract View getDecorView ()
Retrieve the top-level window decor view (containing the standard window frame/decorations and the client's content inside of that), which can be added as a window to the window manager.
Note that calling this function for the first time "locks in"
various window characteristics as described in
setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
.
Returns | |
---|---|
View |
Returns the top-level window decor view.
This value cannot be null . |
getDefaultFeatures
public static int getDefaultFeatures (Context context)
Return the feature bits set by default on a window.
Parameters | |
---|---|
context |
Context : The context used to access resources |
Returns | |
---|---|
int |
getDesiredHdrHeadroom
public float getDesiredHdrHeadroom ()
Get the desired amount of HDR headroom as set by setDesiredHdrHeadroom(float)
Returns | |
---|---|
float |
The amount of HDR headroom set, or 0 for automatic/default behavior. |
See also:
getEnterTransition
public Transition getEnterTransition ()
Returns the transition used to move Views into the initial scene. The entering
Views will be those that are regular Views or ViewGroups that have
ViewGroup#isTransitionGroup
return true. Typical Transitions will extend
Visibility
as entering is governed by changing visibility from
View#INVISIBLE
to View#VISIBLE
. If transition
is null,
entering Views will remain unaffected. Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Returns | |
---|---|
Transition |
the Transition to use to move Views into the initial Scene. |
getExitTransition
public Transition getExitTransition ()
Returns the Transition that will be used to move Views out of the scene when starting a
new Activity. The exiting Views will be those that are regular Views or ViewGroups that
have ViewGroup#isTransitionGroup
return true. Typical Transitions will extend
Visibility
as exiting is governed by changing visibility
from View#VISIBLE
to View#INVISIBLE
. If transition is null, the views will
remain unaffected. Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Returns | |
---|---|
Transition |
the Transition to use to move Views out of the scene when calling a new Activity. |
getFrameRateBoostOnTouchEnabled
public boolean getFrameRateBoostOnTouchEnabled ()
Get whether frame rate touch boost is enabled
setFrameRateBoostOnTouchEnabled(boolean)
Returns | |
---|---|
boolean |
whether the frame rate touch boost is enabled. |
getInsetsController
public WindowInsetsController getInsetsController ()
Returns | |
---|---|
WindowInsetsController |
The WindowInsetsController associated with this window
This value may be null . |
See also:
getLayoutInflater
public abstract LayoutInflater getLayoutInflater ()
Quick access to the LayoutInflater
instance that this Window
retrieved from its Context.
Returns | |
---|---|
LayoutInflater |
LayoutInflater The shared LayoutInflater.
This value cannot be null . |
getMediaController
public MediaController getMediaController ()
Gets the MediaController
that was previously set.
Returns | |
---|---|
MediaController |
The controller which should receive events. |
getNavigationBarColor
public abstract int getNavigationBarColor ()
This method was deprecated
in API level 35.
This is no longer needed since the setter is deprecated.
Returns | |
---|---|
int |
the color of the navigation bar. |
getNavigationBarDividerColor
public int getNavigationBarDividerColor ()
This method was deprecated
in API level 35.
This is no longer needed since the setter is deprecated.
Retrieves the color of the navigation bar divider.
Related XML Attributes:
Returns | |
---|---|
int |
The color of the navigation bar divider color. |
See also:
getOnBackInvokedDispatcher
public OnBackInvokedDispatcher getOnBackInvokedDispatcher ()
Returns the OnBackInvokedDispatcher
instance associated with this window.
Returns | |
---|---|
OnBackInvokedDispatcher |
This value cannot be null . |
getReenterTransition
public Transition getReenterTransition ()
Returns the Transition that will be used to move Views in to the scene when returning from
a previously-started Activity. The entering Views will be those that are regular Views
or ViewGroups that have ViewGroup#isTransitionGroup
return true. Typical Transitions
will extend Visibility
as exiting is governed by changing
visibility from View#VISIBLE
to View#INVISIBLE
.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Returns | |
---|---|
Transition |
The Transition to use to move Views into the scene when reentering from a previously-started Activity. |
getReturnTransition
public Transition getReturnTransition ()
Returns the Transition that will be used to move Views out of the scene when the Window is
preparing to close, for example after a call to
Activity.finishAfterTransition()
. The exiting
Views will be those that are regular Views or ViewGroups that have
ViewGroup#isTransitionGroup
return true. Typical Transitions will extend
Visibility
as entering is governed by changing visibility from
View#VISIBLE
to View#INVISIBLE
.
Related XML Attributes:
Returns | |
---|---|
Transition |
The Transition to use to move Views out of the Scene when the Window is preparing to close. |
getRootSurfaceControl
public AttachedSurfaceControl getRootSurfaceControl ()
This will be null before a content view is added, e.g. via
setContentView(View)
or addContentView(View, LayoutParams)
. See
View.getRootSurfaceControl()
.
Returns | |
---|---|
AttachedSurfaceControl |
The AttachedSurfaceControl interface for this Window |
getSharedElementEnterTransition
public Transition getSharedElementEnterTransition ()
Returns the Transition that will be used for shared elements transferred into the content
Scene. Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Returns | |
---|---|
Transition |
Transition to use for sharend elements transferred into the content Scene. |
getSharedElementExitTransition
public Transition getSharedElementExitTransition ()
Returns the Transition to use for shared elements in the launching Window prior
to transferring to the launched Activity's Window.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Returns | |
---|---|
Transition |
the Transition to use for shared elements in the launching Window prior to transferring to the launched Activity's Window. |
getSharedElementReenterTransition
public Transition getSharedElementReenterTransition ()
Returns the Transition that will be used for shared elements reentering from a started
Activity after it has returned the shared element to it start location.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Returns | |
---|---|
Transition |
the Transition that will be used for shared elements reentering from a started Activity after it has returned the shared element to it start location. |
getSharedElementReturnTransition
public Transition getSharedElementReturnTransition ()
Returns the Transition that will be used for shared elements transferred back to a
calling Activity. Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Returns | |
---|---|
Transition |
Transition to use for sharend elements transferred into the content Scene. |
getSharedElementsUseOverlay
public boolean getSharedElementsUseOverlay ()
Returns true
when shared elements should use an Overlay during
shared element transitions or false
when they should animate as
part of the normal View hierarchy. The default value is true.
Related XML Attributes:
Returns | |
---|---|
boolean |
true when shared elements should use an Overlay during
shared element transitions or false when they should animate as
part of the normal View hierarchy. |
getStatusBarColor
public abstract int getStatusBarColor ()
This method was deprecated
in API level 35.
This is no longer needed since the setter is deprecated.
Returns | |
---|---|
int |
the color of the status bar. |
getSystemGestureExclusionRects
public List<Rect> getSystemGestureExclusionRects ()
Retrieve the list of areas within this window's coordinate space where the system should not
intercept touch or other pointing device gestures. This is the list as set by
setSystemGestureExclusionRects(java.util.List)
or an empty list if
setSystemGestureExclusionRects(java.util.List)
has not been called. It does not include
exclusion rects set by this window's view hierarchy.
Returns | |
---|---|
List<Rect> |
a list of system gesture exclusion rects specific to this window
This value cannot be null . |
getTransitionBackgroundFadeDuration
public long getTransitionBackgroundFadeDuration ()
Returns the duration, in milliseconds, of the window background fade when transitioning into or away from an Activity when called with an Activity Transition.
When executing the enter transition, the background starts transparent
and fades in. This requires FEATURE_ACTIVITY_TRANSITIONS
. The default is
300 milliseconds.
Related XML Attributes:
Returns | |
---|---|
long |
The duration of the window background fade to opaque during enter transition. |
See also:
getTransitionManager
public TransitionManager getTransitionManager ()
Retrieve the TransitionManager
responsible for for default transitions
in this window. Requires FEATURE_CONTENT_TRANSITIONS
.
This method will return non-null after content has been initialized (e.g. by using
setContentView(View)
) if FEATURE_CONTENT_TRANSITIONS
has been granted.
Related XML Attributes:
Returns | |
---|---|
TransitionManager |
This window's content TransitionManager or null if none is set. |
getVolumeControlStream
public abstract int getVolumeControlStream ()
Returns | |
---|---|
int |
See also:
getWindowManager
public WindowManager getWindowManager ()
Return the window manager allowing this Window to display its own windows.
Returns | |
---|---|
WindowManager |
WindowManager The ViewManager. |
getWindowStyle
public final TypedArray getWindowStyle ()
Return the R.styleable.Window
attributes from this
window's theme.
Returns | |
---|---|
TypedArray |
hasFeature
public boolean hasFeature (int feature)
Query for the availability of a certain feature.
Parameters | |
---|---|
feature |
int : The feature ID to check |
Returns | |
---|---|
boolean |
true if the feature is enabled, false otherwise. |
injectInputEvent
public void injectInputEvent (InputEvent event)
Inject an event to window locally.
Parameters | |
---|---|
event |
InputEvent : A key or touch event to inject to this window. |
invalidatePanelMenu
public abstract void invalidatePanelMenu (int featureId)
Parameters | |
---|---|
featureId |
int |
isFloating
public abstract boolean isFloating ()
Return whether this window is being displayed with a floating style
(based on the R.attr.windowIsFloating
attribute in
the style/theme).
Returns | |
---|---|
boolean |
Returns true if the window is configured to be displayed floating on top of whatever is behind it. |
isFrameRatePowerSavingsBalanced
public boolean isFrameRatePowerSavingsBalanced ()
Get whether frameratepowersavingsbalance is enabled for this Window.
This allows device to adjust refresh rate
as needed and can be useful for power saving.
setFrameRateBoostOnTouchEnabled(boolean)
Returns | |
---|---|
boolean |
whether the frameratepowersavingsbalance is enabled. |
isNavigationBarContrastEnforced
public boolean isNavigationBarContrastEnforced ()
Returns whether the system is ensuring that the navigation bar has enough contrast when a fully transparent background is requested.
When the navigation bar color has a non-zero alpha value, the value of this property has no effect.
Returns | |
---|---|
boolean |
true, if the system is ensuring contrast, false otherwise. |
isShortcutKey
public abstract boolean isShortcutKey (int keyCode, KeyEvent event)
Is a keypress one of the defined shortcut keys for this window.
Parameters | |
---|---|
keyCode |
int : the key code from KeyEvent to check. |
event |
KeyEvent : the KeyEvent to use to help check. |
Returns | |
---|---|
boolean |
isStatusBarContrastEnforced
public boolean isStatusBarContrastEnforced ()
This method was deprecated
in API level 35.
This is not needed since the setter is deprecated.
Returns whether the system is ensuring that the status bar has enough contrast when a fully transparent background is requested.
When the status bar color has a non-zero alpha value, the value of this property has no effect.
Returns | |
---|---|
boolean |
true, if the system is ensuring contrast, false otherwise. |
isWideColorGamut
public boolean isWideColorGamut ()
Returns true if this window's color mode is ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT
,
the display has a wide color gamut and this device supports wide color gamut rendering.
Returns | |
---|---|
boolean |
onConfigurationChanged
public abstract void onConfigurationChanged (Configuration newConfig)
Should be called when the configuration is changed.
Parameters | |
---|---|
newConfig |
Configuration : The new configuration. |
openPanel
public abstract void openPanel (int featureId, KeyEvent event)
Parameters | |
---|---|
featureId |
int |
event |
KeyEvent |
peekDecorView
public abstract View peekDecorView ()
Retrieve the current decor view, but only if it has already been created; otherwise returns null.
Returns | |
---|---|
View |
Returns the top-level window decor or null. |
See also:
performContextMenuIdentifierAction
public abstract boolean performContextMenuIdentifierAction (int id, int flags)
Parameters | |
---|---|
id |
int |
flags |
int |
Returns | |
---|---|
boolean |
performPanelIdentifierAction
public abstract boolean performPanelIdentifierAction (int featureId, int id, int flags)
Parameters | |
---|---|
featureId |
int |
id |
int |
flags |
int |
Returns | |
---|---|
boolean |
performPanelShortcut
public abstract boolean performPanelShortcut (int featureId, int keyCode, KeyEvent event, int flags)
Parameters | |
---|---|
featureId |
int |
keyCode |
int |
event |
KeyEvent |
flags |
int |
Returns | |
---|---|
boolean |
registerScrollCaptureCallback
public void registerScrollCaptureCallback (ScrollCaptureCallback callback)
Used to provide scroll capture support for an arbitrary window. This registeres the given callback with the root view of the window.
Parameters | |
---|---|
callback |
ScrollCaptureCallback : the callback to add
This value cannot be null . |
removeOnFrameMetricsAvailableListener
public final void removeOnFrameMetricsAvailableListener (Window.OnFrameMetricsAvailableListener listener)
Remove observer and stop listening to frame stats for this window.
Parameters | |
---|---|
listener |
Window.OnFrameMetricsAvailableListener |
requestFeature
public boolean requestFeature (int featureId)
Enable extended screen features. This must be called before
setContentView(). May be called as many times as desired as long as it
is before setContentView(). If not called, no extended features
will be available. You can not turn off a feature once it is requested.
You canot use other title features with FEATURE_CUSTOM_TITLE
.
Parameters | |
---|---|
featureId |
int : The desired features, defined as constants by Window. |
Returns | |
---|---|
boolean |
The features that are now set. |
requireViewById
public final T requireViewById (int id)
Finds a view that was identified by the android:id
XML attribute
that was processed in Activity.onCreate(Bundle)
, or throws an
IllegalArgumentException if the ID is invalid, or there is no matching view in the hierarchy.
Note: In most cases -- depending on compiler support -- the resulting view is automatically cast to the target class type. If the target class type is unconstrained, an explicit cast may be necessary.
Parameters | |
---|---|
id |
int : the ID to search for |
Returns | |
---|---|
T |
a view with given ID
This value cannot be null . |
restoreHierarchyState
public abstract void restoreHierarchyState (Bundle savedInstanceState)
Parameters | |
---|---|
savedInstanceState |
Bundle |
setAllowEnterTransitionOverlap
public void setAllowEnterTransitionOverlap (boolean allow)
Controls how the transition set in
setEnterTransition(android.transition.Transition)
overlaps with the exit
transition of the calling Activity. When true, the transition will start as soon as possible.
When false, the transition will wait until the remote exiting transition completes before
starting. The default value is true.
Related XML Attributes:
Parameters | |
---|---|
allow |
boolean : true to start the enter transition when possible or false to
wait until the exiting transition completes. |
setAllowReturnTransitionOverlap
public void setAllowReturnTransitionOverlap (boolean allow)
Controls how the transition set in
setExitTransition(android.transition.Transition)
overlaps with the exit
transition of the called Activity when reentering after if finishes. When true,
the transition will start as soon as possible. When false, the transition will wait
until the called Activity's exiting transition completes before starting.
The default value is true.
Related XML Attributes:
Parameters | |
---|---|
allow |
boolean : true to start the transition when possible or false to wait until the
called Activity's exiting transition completes. |
setAttributes
public void setAttributes (WindowManager.LayoutParams a)
Specify custom window attributes. PLEASE NOTE: the
layout params you give here should generally be from values previously
retrieved with getAttributes()
; you probably do not want to
blindly create and apply your own, since this will blow away any values
set by the framework that you are not interested in.
Parameters | |
---|---|
a |
WindowManager.LayoutParams : The new window attributes, which will completely override any
current values. |
setBackgroundBlurRadius
public void setBackgroundBlurRadius (int blurRadius)
Blurs the screen behind the window within the bounds of the window.
The density of the blur is set by the blur radius. The radius defines the size of the neighbouring area, from which pixels will be averaged to form the final color for each pixel. The operation approximates a Gaussian blur. A radius of 0 means no blur. The higher the radius, the denser the blur.
The window background drawable is drawn on top of the blurred region. The blur region bounds and rounded corners will mimic those of the background drawable.
For the blur region to be visible, the window has to be translucent
(see R.attr.windowIsTranslucent
) and floating
(see R.attr.windowIsFloating
).
Note the difference with WindowManager.LayoutParams#setBlurBehindRadius
,
which blurs the whole screen behind the window. Background blur blurs the screen behind
only within the bounds of the window.
Some devices might not support cross-window blur due to GPU limitations. It can also be
disabled at runtime, e.g. during battery saving mode, when multimedia tunneling is used or
when minimal post processing is requested. In such situations, no blur will be computed or
drawn, resulting in a transparent window background. To avoid this, the app might want to
change its theme to one that does not use blurs. To listen for cross-window blur
enabled/disabled events, use WindowManager#addCrossWindowBlurEnabledListener
.
Parameters | |
---|---|
blurRadius |
int : The blur radius to use for window background blur in pixels |
setBackgroundDrawable
public abstract void setBackgroundDrawable (Drawable drawable)
Change the background of this window to a custom Drawable. Setting the background to null will make the window be opaque. To make the window transparent, you can use an empty drawable (for instance a ColorDrawable with the color 0 or the system drawable android:drawable/empty.)
Parameters | |
---|---|
drawable |
Drawable : The new Drawable to use for this window's background. |
setBackgroundDrawableResource
public void setBackgroundDrawableResource (int resId)
Change the background of this window to a Drawable resource. Setting the background to null will make the window be opaque. To make the window transparent, you can use an empty drawable (for instance a ColorDrawable with the color 0 or the system drawable android:drawable/empty.)
Parameters | |
---|---|
resId |
int : The resource identifier of a drawable resource which will
be installed as the new background. |
setCallback
public void setCallback (Window.Callback callback)
Set the Callback interface for this window, used to intercept key events and other dynamic operations in the window.
Parameters | |
---|---|
callback |
Window.Callback : The desired Callback interface. |
setChildDrawable
public abstract void setChildDrawable (int featureId, Drawable drawable)
Parameters | |
---|---|
featureId |
int |
drawable |
Drawable |
setChildInt
public abstract void setChildInt (int featureId, int value)
Parameters | |
---|---|
featureId |
int |
value |
int |
setClipToOutline
public void setClipToOutline (boolean clipToOutline)
Sets whether window content should be clipped to the outline of the window background.
Parameters | |
---|---|
clipToOutline |
boolean : Whether window content should be clipped to the
outline of the window background. |
setColorMode
public void setColorMode (int colorMode)
Sets the requested color mode of the window. The requested the color mode might
override the window's pixel format
.
The requested color mode must be one of ActivityInfo#COLOR_MODE_DEFAULT
,
ActivityInfo#COLOR_MODE_WIDE_COLOR_GAMUT
or ActivityInfo#COLOR_MODE_HDR
.
The requested color mode is not guaranteed to be honored. Please refer to
getColorMode()
for more information.
Parameters | |
---|---|
colorMode |
int : Value is ActivityInfo.COLOR_MODE_DEFAULT , ActivityInfo.COLOR_MODE_WIDE_COLOR_GAMUT , ActivityInfo.COLOR_MODE_HDR , or android.content.pm.ActivityInfo.COLOR_MODE_A8 |
setContainer
public void setContainer (Window container)
Set the container for this window. If not set, the DecorWindow operates as a top-level window; otherwise, it negotiates with the container to display itself appropriately.
Parameters | |
---|---|
container |
Window : The desired containing Window. |
setContentView
public abstract void setContentView (View view, ViewGroup.LayoutParams params)
Set the screen content to an explicit view. This view is placed directly into the screen's view hierarchy. It can itself be a complex view hierarchy.
Note that calling this function "locks in" various characteristics
of the window that can not, from this point forward, be changed: the
features that have been requested with requestFeature(int)
,
and certain window flags as described in setFlags(int, int)
.
If FEATURE_CONTENT_TRANSITIONS
is set, the window's
TransitionManager will be used to animate content from the current
content View to view.
Parameters | |
---|---|
view |
View : The desired content to display. |
params |
ViewGroup.LayoutParams : Layout parameters for the view. |
setContentView
public abstract void setContentView (View view)
Convenience for
setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
set the screen content to an explicit view. This view is placed
directly into the screen's view hierarchy. It can itself be a complex
view hierarhcy.
Parameters | |
---|---|
view |
View : The desired content to display. |
setContentView
public abstract void setContentView (int layoutResID)
Convenience for
setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
to set the screen content from a layout resource. The resource will be
inflated, adding all top-level views to the screen.
Parameters | |
---|---|
layoutResID |
int : Resource ID to be inflated. |
setDecorCaptionShade
public abstract void setDecorCaptionShade (int decorCaptionShade)
Set what color should the caption controls be. By default the system will try to determine
the color from the theme. You can overwrite this by using DECOR_CAPTION_SHADE_DARK
,
DECOR_CAPTION_SHADE_LIGHT
, or DECOR_CAPTION_SHADE_AUTO
.
Parameters | |
---|---|
decorCaptionShade |
int |
setDecorFitsSystemWindows
public void setDecorFitsSystemWindows (boolean decorFitsSystemWindows)
This method was deprecated
in API level 35.
Make space in the container views to prevent the critical elements from getting
obscured by WindowInsets.Type#systemBars()
or
WindowInsets.Type#displayCutout()
instead.
Sets whether the decor view should fit root-level content views for WindowInsets
.
If set to true
, the framework will inspect the now deprecated
View#SYSTEM_UI_LAYOUT_FLAGS
as well the
WindowManager.LayoutParams#SOFT_INPUT_ADJUST_RESIZE
flag and fits content according
to these flags.
If set to false
, the framework will not fit the content view to the insets and will
just pass through the WindowInsets
to the content view.
If the app targets
VANILLA_ICE_CREAM
or above,
the behavior will be like setting this to false
, and cannot be changed.
Parameters | |
---|---|
decorFitsSystemWindows |
boolean : Whether the decor view should fit root-level content views for
insets. |
setDesiredHdrHeadroom
public void setDesiredHdrHeadroom (float desiredHeadroom)
Sets the desired about of HDR headroom to be used when rendering as a ratio of
targetHdrPeakBrightnessInNits / targetSdrWhitePointInNits. Only applies when
setColorMode(int)
is ActivityInfo#COLOR_MODE_HDR
By default the system will choose an amount of HDR headroom that is appropriate for the underlying device capabilities & bit-depth of the panel. However, for some types of content this can end up being more headroom than necessary or desired. An example would be a messaging app or gallery thumbnail view where some amount of HDR pop is desired without overly influencing the perceived brightness of the majority SDR content. This can also be used to animate in/out of an HDR range for smoother transitions.
Note: The actual amount of HDR headroom that will be given is subject to a variety
of factors such as ambient conditions, display capabilities, or bit-depth limitations.
See Display#getHdrSdrRatio()
for more information as well as how to query the
current value.
Parameters | |
---|---|
desiredHeadroom |
float : The amount of HDR headroom that is desired. Must be >= 1.0 (no HDR)
and <= 10,000.0. Passing 0.0 will reset to the default, automatically
chosen value.
Value is between 0.0f and 10000.0 inclusive |
setDimAmount
public void setDimAmount (float amount)
Set the amount of dim behind the window when using
WindowManager.LayoutParams#FLAG_DIM_BEHIND
. This overrides
the default dim amount of that is selected by the Window based on
its theme.
Parameters | |
---|---|
amount |
float : The new dim amount, from 0 for no dim to 1 for full dim. |
setElevation
public void setElevation (float elevation)
Sets the window elevation.
Changes to this property take effect immediately and will cause the window surface to be recreated. This is an expensive operation and as a result, this property should not be animated.
Parameters | |
---|---|
elevation |
float : The window elevation. |
setEnterTransition
public void setEnterTransition (Transition transition)
Sets the Transition that will be used to move Views into the initial scene. The entering
Views will be those that are regular Views or ViewGroups that have
ViewGroup#isTransitionGroup
return true. Typical Transitions will extend
Visibility
as entering is governed by changing visibility from
View#INVISIBLE
to View#VISIBLE
. If transition
is null,
entering Views will remain unaffected.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use to move Views into the initial Scene. |
setExitTransition
public void setExitTransition (Transition transition)
Sets the Transition that will be used to move Views out of the scene when starting a
new Activity. The exiting Views will be those that are regular Views or ViewGroups that
have ViewGroup#isTransitionGroup
return true. Typical Transitions will extend
Visibility
as exiting is governed by changing visibility
from View#VISIBLE
to View#INVISIBLE
. If transition is null, the views will
remain unaffected. Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use to move Views out of the scene when calling a
new Activity. |
setFeatureDrawable
public abstract void setFeatureDrawable (int featureId, Drawable drawable)
Set an explicit Drawable value for feature of this window. You must have called requestFeature(featureId) before calling this function.
Parameters | |
---|---|
featureId |
int : The desired drawable feature to change. Features are
constants defined by Window. |
drawable |
Drawable : A Drawable object to display. |
setFeatureDrawableAlpha
public abstract void setFeatureDrawableAlpha (int featureId, int alpha)
Set a custom alpha value for the given drawable feature, controlling how much the background is visible through it.
Parameters | |
---|---|
featureId |
int : The desired drawable feature to change. Features are
constants defined by Window. |
alpha |
int : The alpha amount, 0 is completely transparent and 255 is
completely opaque. |
setFeatureDrawableResource
public abstract void setFeatureDrawableResource (int featureId, int resId)
Set the value for a drawable feature of this window, from a resource identifier. You must have called requestFeature(featureId) before calling this function.
Parameters | |
---|---|
featureId |
int : The desired drawable feature to change, defined as a
constant by Window. |
resId |
int : Resource identifier of the desired image. |
See also:
setFeatureDrawableUri
public abstract void setFeatureDrawableUri (int featureId, Uri uri)
Set the value for a drawable feature of this window, from a URI. You must have called requestFeature(featureId) before calling this function.
The only URI currently supported is "content:", specifying an image in a content provider.
Parameters | |
---|---|
featureId |
int : The desired drawable feature to change. Features are
constants defined by Window. |
uri |
Uri : The desired URI. |
See also:
setFeatureInt
public abstract void setFeatureInt (int featureId, int value)
Set the integer value for a feature. The range of the value depends on
the feature being set. For FEATURE_PROGRESS
, it should go from
0 to 10000. At 10000 the progress is complete and the indicator hidden.
Parameters | |
---|---|
featureId |
int : The desired feature to change. Features are constants
defined by Window. |
value |
int : The value for the feature. The interpretation of this
value is feature-specific. |
setFlags
public void setFlags (int flags, int mask)
Set the flags of the window, as per the
WindowManager.LayoutParams
flags.
Note that some flags must be set before the window decoration is
created (by the first call to
setContentView(android.view.View, android.view.ViewGroup.LayoutParams)
or
getDecorView()
:
WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN
and
WindowManager.LayoutParams#FLAG_LAYOUT_INSET_DECOR
. These
will be set for you based on the R.attr.windowIsFloating
attribute.
Parameters | |
---|---|
flags |
int : The new window flags (see WindowManager.LayoutParams). |
mask |
int : Which of the window flag bits to modify. |
See also:
setFormat
public void setFormat (int format)
Set the format of window, as per the PixelFormat types. This overrides the default format that is selected by the Window based on its window decorations.
Parameters | |
---|---|
format |
int : The new window format (see PixelFormat). Use
PixelFormat.UNKNOWN to allow the Window to select
the format. |
See also:
setFrameRateBoostOnTouchEnabled
public void setFrameRateBoostOnTouchEnabled (boolean enabled)
Sets whether the frame rate touch boost is enabled for this Window. When enabled, the frame rate will be boosted when a user touches the Window.
Parameters | |
---|---|
enabled |
boolean : whether the frame rate touch boost is enabled. |
setFrameRatePowerSavingsBalanced
public void setFrameRatePowerSavingsBalanced (boolean enabled)
Set whether frameratepowersavingsbalance is enabled for this Window. This allows device to adjust refresh rate as needed and can be useful for power saving.
Parameters | |
---|---|
enabled |
boolean : whether the frameratepowersavingsbalance is enabled. |
setGravity
public void setGravity (int gravity)
Set the gravity of the window, as per the Gravity constants. This controls how the window manager is positioned in the overall window; it is only useful when using WRAP_CONTENT for the layout width or height.
Parameters | |
---|---|
gravity |
int : The desired gravity constant. |
See also:
setHideOverlayWindows
public final void setHideOverlayWindows (boolean hide)
Prevent non-system overlay windows from being drawn on top of this window.
Requires Manifest.permission.HIDE_OVERLAY_WINDOWS
Parameters | |
---|---|
hide |
boolean : whether non-system overlay windows should be hidden. |
setIcon
public void setIcon (int resId)
Set the primary icon for this window.
Parameters | |
---|---|
resId |
int : resource ID of a drawable to set |
setLayout
public void setLayout (int width, int height)
Set the width and height layout parameters of the window. The default for both of these is MATCH_PARENT; you can change them to WRAP_CONTENT or an absolute value to make a window that is not full-screen.
Parameters | |
---|---|
width |
int : The desired layout width of the window. |
height |
int : The desired layout height of the window. |
setLocalFocus
public void setLocalFocus (boolean hasFocus, boolean inTouchMode)
Set focus locally. The window should have the
WindowManager.LayoutParams#FLAG_LOCAL_FOCUS_MODE
flag set already.
Parameters | |
---|---|
hasFocus |
boolean : Whether this window has focus or not. |
inTouchMode |
boolean : Whether this window is in touch mode or not. |
setLogo
public void setLogo (int resId)
Set the logo for this window. A logo is often shown in place of an
icon
but is generally wider and communicates window title information
as well.
Parameters | |
---|---|
resId |
int : resource ID of a drawable to set |
setMediaController
public void setMediaController (MediaController controller)
Sets a MediaController
to send media keys and volume changes to.
If set, this should be preferred for all media keys and volume requests
sent to this window.
Parameters | |
---|---|
controller |
MediaController : The controller for the session which should receive
media keys and volume changes. |
setNavigationBarColor
public abstract void setNavigationBarColor (int color)
This method was deprecated
in API level 35.
Draw proper background behind WindowInsets.Type#navigationBars()
or
WindowInsets.Type#tappableElement()
instead.
Sets the color of the navigation bar to .
For this to take effect,
the window must be drawing the system bar backgrounds with
WindowManager.LayoutParams.FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS
and
WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION
must not be set.
If is not opaque, consider setting
View.SYSTEM_UI_FLAG_LAYOUT_STABLE
and
View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
.
The transitionName for the view background will be "android:navigation:background".
If the color is transparent and the window enforces the navigation bar contrast, the system will determine whether a scrim is necessary and draw one on behalf of the app to ensure that the navigation bar has enough contrast with the contents of this app, and set an appropriate effective bar background accordingly.
If the app targets
VANILLA_ICE_CREAM
or above,
the color will be transparent and cannot be changed.
Related XML Attributes:
setNavigationBarContrastEnforced
public void setNavigationBarContrastEnforced (boolean enforceContrast)
Sets whether the system should ensure that the navigation bar has enough contrast when a fully transparent background is requested.
If set to this value, the system will determine whether a scrim is necessary to ensure that the navigation bar has enough contrast with the contents of this app, and set an appropriate effective bar background color accordingly.
When the navigation bar color has a non-zero alpha value, the value of this property has no effect.
Parameters | |
---|---|
enforceContrast |
boolean |
setNavigationBarDividerColor
public void setNavigationBarDividerColor (int dividerColor)
This method was deprecated
in API level 35.
Draw proper background behind WindowInsets.Type#navigationBars()
or
WindowInsets.Type#tappableElement()
instead.
Shows a thin line of the specified color between the navigation bar and the app content.
For this to take effect,
the window must be drawing the system bar backgrounds with
WindowManager.LayoutParams.FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS
and
WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION
must not be set.
If the app targets
VANILLA_ICE_CREAM
or above,
the color will be transparent and cannot be changed.
Related XML Attributes:
Parameters | |
---|---|
dividerColor |
int : The color of the thin line. |
setPreferMinimalPostProcessing
public void setPreferMinimalPostProcessing (boolean isPreferred)
If isPreferred
is true, this method requests that the connected display does minimal
post processing when this window is visible on the screen. Otherwise, it requests that the
display switches back to standard image processing.
By default, the display does not do minimal post processing and if this is desired, this
method should not be used. It should be used with isPreferred=true
when low
latency has a higher priority than image enhancement processing (e.g. for games or video
conferencing). The display will automatically go back into standard image processing mode
when no window requesting minimal posst processing is visible on screen anymore.
setPreferMinimalPostProcessing(false)
can be used if
setPreferMinimalPostProcessing(true)
was previously called for this window and
minimal post processing is no longer required.
If the Display sink is connected via HDMI, the device will begin to send infoframes with Auto Low Latency Mode enabled and Game Content Type. This will switch the connected display to a minimal image processing mode (if available), which reduces latency, improving the user experience for gaming or video conferencing applications. For more information, see HDMI 2.1 specification.
If the Display sink has an internal connection or uses some other protocol than HDMI, effects may be similar but implementation-defined.
The ability to switch to a mode with minimal post proessing may be disabled by a user setting in the system settings menu. In that case, this method does nothing.
Parameters | |
---|---|
isPreferred |
boolean : Indicates whether minimal post processing is preferred for this window
(isPreferred=true ) or not (isPreferred=false ). |
setReenterTransition
public void setReenterTransition (Transition transition)
Sets the Transition that will be used to move Views in to the scene when returning from
a previously-started Activity. The entering Views will be those that are regular Views
or ViewGroups that have ViewGroup#isTransitionGroup
return true. Typical Transitions
will extend Visibility
as exiting is governed by changing
visibility from View#VISIBLE
to View#INVISIBLE
. If transition is null,
the views will remain unaffected. If nothing is set, the default will be to use the same
transition as setExitTransition(android.transition.Transition)
.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use to move Views into the scene when reentering from a
previously-started Activity. |
setResizingCaptionDrawable
public abstract void setResizingCaptionDrawable (Drawable drawable)
Set the drawable that is drawn underneath the caption during the resizing.
During the resizing the caption might not be drawn fast enough to match the new dimensions.
There is a second caption drawn underneath it that will be fast enough. By default the
caption is constructed from the theme. You can provide a drawable, that will be drawn instead
to better match your application.
Starting in Android 15, this API is a no-op. New window decorations introduced in Android 14
are drawn in SystemUI process, and OEMs are responsible to make them responsive to resizing.
There is no need to set a background drawable to improve UX anymore since then. Additionally,
the foremost activity can draw in caption areas starting in Android 15. Check
WindowInsetsController#APPEARANCE_TRANSPARENT_CAPTION_BAR_BACKGROUND
,
WindowInsetsController#APPEARANCE_LIGHT_CAPTION_BARS
,
WindowInsetsController#setSystemBarsAppearance(int, int)
and
WindowInsets#getBoundingRects(int)
.
Parameters | |
---|---|
drawable |
Drawable |
setRestrictedCaptionAreaListener
public final void setRestrictedCaptionAreaListener (Window.OnRestrictedCaptionAreaChangedListener listener)
Set a callback for changes of area where caption will draw its content.
Parameters | |
---|---|
listener |
Window.OnRestrictedCaptionAreaChangedListener : Callback that will be called when the area changes. |
setReturnTransition
public void setReturnTransition (Transition transition)
Sets the Transition that will be used to move Views out of the scene when the Window is
preparing to close, for example after a call to
Activity.finishAfterTransition()
. The exiting
Views will be those that are regular Views or ViewGroups that have
ViewGroup#isTransitionGroup
return true. Typical Transitions will extend
Visibility
as entering is governed by changing visibility from
View#VISIBLE
to View#INVISIBLE
. If transition
is null,
entering Views will remain unaffected. If nothing is set, the default will be to
use the same value as set in setEnterTransition(android.transition.Transition)
.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use to move Views out of the Scene when the Window
is preparing to close. |
setSharedElementEnterTransition
public void setSharedElementEnterTransition (Transition transition)
Sets the Transition that will be used for shared elements transferred into the content
Scene. Typical Transitions will affect size and location, such as
ChangeBounds
. A null
value will cause transferred shared elements to blink to the final position.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use for shared elements transferred into the content
Scene. |
setSharedElementExitTransition
public void setSharedElementExitTransition (Transition transition)
Sets the Transition that will be used for shared elements after starting a new Activity
before the shared elements are transferred to the called Activity. If the shared elements
must animate during the exit transition, this Transition should be used. Upon completion,
the shared elements may be transferred to the started Activity.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use for shared elements in the launching Window
prior to transferring to the launched Activity's Window. |
setSharedElementReenterTransition
public void setSharedElementReenterTransition (Transition transition)
Sets the Transition that will be used for shared elements reentering from a started
Activity after it has returned the shared element to it start location. If no value
is set, this will default to
setSharedElementExitTransition(android.transition.Transition)
.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use for shared elements in the launching Window
after the shared element has returned to the Window. |
setSharedElementReturnTransition
public void setSharedElementReturnTransition (Transition transition)
Sets the Transition that will be used for shared elements transferred back to a
calling Activity. Typical Transitions will affect size and location, such as
ChangeBounds
. A null
value will cause transferred shared elements to blink to the final position.
If no value is set, the default will be to use the same value as
setSharedElementEnterTransition(android.transition.Transition)
.
Requires FEATURE_ACTIVITY_TRANSITIONS
.
Related XML Attributes:
Parameters | |
---|---|
transition |
Transition : The Transition to use for shared elements transferred out of the content
Scene. |
setSharedElementsUseOverlay
public void setSharedElementsUseOverlay (boolean sharedElementsUseOverlay)
Sets whether or not shared elements should use an Overlay during shared element transitions. The default value is true.
Related XML Attributes:
Parameters | |
---|---|
sharedElementsUseOverlay |
boolean : true indicates that shared elements should
be transitioned with an Overlay or false
to transition within the normal View hierarchy. |
setSoftInputMode
public void setSoftInputMode (int mode)
Specify an explicit soft input mode to use for the window, as per
WindowManager.LayoutParams.softInputMode
. Providing anything besides
"unspecified" here will override the input mode the window would
normally retrieve from its theme.
Parameters | |
---|---|
mode |
int |
setStatusBarColor
public abstract void setStatusBarColor (int color)
This method was deprecated
in API level 35.
Draw proper background behind WindowInsets.Type#statusBars()
} instead.
Sets the color of the status bar to color
.
For this to take effect,
the window must be drawing the system bar backgrounds with
WindowManager.LayoutParams.FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS
and
WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS
must not be set.
If color
is not opaque, consider setting
View.SYSTEM_UI_FLAG_LAYOUT_STABLE
and
View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN
.
The transitionName for the view background will be "android:status:background".
If the color is transparent and the window enforces the status bar contrast, the system will determine whether a scrim is necessary and draw one on behalf of the app to ensure that the status bar has enough contrast with the contents of this app, and set an appropriate effective bar background accordingly.
If the app targets
VANILLA_ICE_CREAM
or above,
the color will be transparent and cannot be changed.
Parameters | |
---|---|
color |
int |
setStatusBarContrastEnforced
public void setStatusBarContrastEnforced (boolean ensureContrast)
This method was deprecated
in API level 35.
Draw proper background behind WindowInsets.Type#statusBars()
} instead.
Sets whether the system should ensure that the status bar has enough contrast when a fully transparent background is requested.
If set to this value, the system will determine whether a scrim is necessary to ensure that the status bar has enough contrast with the contents of this app, and set an appropriate effective bar background color accordingly.
When the status bar color has a non-zero alpha value, the value of this property has no effect.
Parameters | |
---|---|
ensureContrast |
boolean |
setSustainedPerformanceMode
public void setSustainedPerformanceMode (boolean enable)
Parameters | |
---|---|
enable |
boolean |
setSystemGestureExclusionRects
public void setSystemGestureExclusionRects (List<Rect> rects)
Sets a list of areas within this window's coordinate space where the system should not intercept touch or other pointing device gestures.
This method should be used by apps that make use of
takeSurface(android.view.SurfaceHolder.Callback2)
and do not have a view hierarchy available.
Apps that do have a view hierarchy should use
View#setSystemGestureExclusionRects(List)
instead. This method does not modify or
replace the gesture exclusion rects populated by individual views in this window's view
hierarchy using View#setSystemGestureExclusionRects(List)
.
Use this to tell the system which specific sub-areas of a view need to receive gesture
input in order to function correctly in the presence of global system gestures that may
conflict. For example, if the system wishes to capture swipe-in-from-screen-edge gestures
to provide system-level navigation functionality, a view such as a navigation drawer
container can mark the left (or starting) edge of itself as requiring gesture capture
priority using this API. The system may then choose to relax its own gesture recognition
to allow the app to consume the user's gesture. It is not necessary for an app to register
exclusion rects for broadly spanning regions such as the entirety of a
ScrollView
or for simple press and release click targets such as
Button
. Mark an exclusion rect when interacting with a view requires
a precision touch gesture in a small area in either the X or Y dimension, such as
an edge swipe or dragging a SeekBar
thumb.
Do not modify the provided list after this method is called.
Parameters | |
---|---|
rects |
List : A list of precision gesture regions that this window needs to function correctly
This value cannot be null . |
setTitle
public abstract void setTitle (CharSequence title)
Parameters | |
---|---|
title |
CharSequence |
setTitleColor
public abstract void setTitleColor (int textColor)
Parameters | |
---|---|
textColor |
int |
setTransitionBackgroundFadeDuration
public void setTransitionBackgroundFadeDuration (long fadeDurationMillis)
Sets the duration, in milliseconds, of the window background fade when transitioning into or away from an Activity when called with an Activity Transition.
When executing the enter transition, the background starts transparent
and fades in. This requires FEATURE_ACTIVITY_TRANSITIONS
. The default is
300 milliseconds.
Related XML Attributes:
Parameters | |
---|---|
fadeDurationMillis |
long : The duration of the window background fade to or from opaque
during enter transition. |
setTransitionManager
public void setTransitionManager (TransitionManager tm)
Set the TransitionManager
to use for default transitions in this window.
Requires FEATURE_CONTENT_TRANSITIONS
.
Related XML Attributes:
Parameters | |
---|---|
tm |
TransitionManager : The TransitionManager to use for scene changes. |
setType
public void setType (int type)
Set the type of the window, as per the WindowManager.LayoutParams types.
Parameters | |
---|---|
type |
int : The new window type (see WindowManager.LayoutParams). |
setUiOptions
public void setUiOptions (int uiOptions)
Set extra options that will influence the UI for this window.
Parameters | |
---|---|
uiOptions |
int : Flags specifying extra options for this window. |
setUiOptions
public void setUiOptions (int uiOptions, int mask)
Set extra options that will influence the UI for this window. Only the bits filtered by mask will be modified.
Parameters | |
---|---|
uiOptions |
int : Flags specifying extra options for this window. |
mask |
int : Flags specifying which options should be modified. Others will remain unchanged. |
setVolumeControlStream
public abstract void setVolumeControlStream (int streamType)
Parameters | |
---|---|
streamType |
int |
See also:
setWindowAnimations
public void setWindowAnimations (int resId)
Specify custom animations to use for the window, as per
WindowManager.LayoutParams.windowAnimations
. Providing anything besides
0 here will override the animations the window would
normally retrieve from its theme.
Parameters | |
---|---|
resId |
int |
setWindowManager
public void setWindowManager (WindowManager wm, IBinder appToken, String appName)
Set the window manager for use by this Window to, for example, display panels. This is not used for displaying the Window itself -- that must be done by the client.
Parameters | |
---|---|
wm |
WindowManager : The window manager for adding new windows. |
appToken |
IBinder |
appName |
String |
setWindowManager
public void setWindowManager (WindowManager wm, IBinder appToken, String appName, boolean hardwareAccelerated)
Set the window manager for use by this Window to, for example, display panels. This is not used for displaying the Window itself -- that must be done by the client.
Parameters | |
---|---|
wm |
WindowManager : The window manager for adding new windows. |
appToken |
IBinder |
appName |
String |
hardwareAccelerated |
boolean |
superDispatchGenericMotionEvent
public abstract boolean superDispatchGenericMotionEvent (MotionEvent event)
Used by custom windows, such as Dialog, to pass the generic motion event further down the view hierarchy. Application developers should not need to implement or call this.
Parameters | |
---|---|
event |
MotionEvent |
Returns | |
---|---|
boolean |
superDispatchKeyEvent
public abstract boolean superDispatchKeyEvent (KeyEvent event)
Used by custom windows, such as Dialog, to pass the key press event further down the view hierarchy. Application developers should not need to implement or call this.
Parameters | |
---|---|
event |
KeyEvent |
Returns | |
---|---|
boolean |
superDispatchKeyShortcutEvent
public abstract boolean superDispatchKeyShortcutEvent (KeyEvent event)
Used by custom windows, such as Dialog, to pass the key shortcut press event further down the view hierarchy. Application developers should not need to implement or call this.
Parameters | |
---|---|
event |
KeyEvent |
Returns | |
---|---|
boolean |
superDispatchTouchEvent
public abstract boolean superDispatchTouchEvent (MotionEvent event)
Used by custom windows, such as Dialog, to pass the touch screen event further down the view hierarchy. Application developers should not need to implement or call this.
Parameters | |
---|---|
event |
MotionEvent |
Returns | |
---|---|
boolean |
superDispatchTrackballEvent
public abstract boolean superDispatchTrackballEvent (MotionEvent event)
Used by custom windows, such as Dialog, to pass the trackball event further down the view hierarchy. Application developers should not need to implement or call this.
Parameters | |
---|---|
event |
MotionEvent |
Returns | |
---|---|
boolean |
takeInputQueue
public abstract void takeInputQueue (InputQueue.Callback callback)
Take ownership of this window's InputQueue. The window will no longer read and dispatch input events from the queue; it is your responsibility to do so.
Parameters | |
---|---|
callback |
InputQueue.Callback |
takeKeyEvents
public abstract void takeKeyEvents (boolean get)
Request that key events come to this activity. Use this if your activity has no views with focus, but the activity still wants a chance to process key events.
Parameters | |
---|---|
get |
boolean |
takeSurface
public abstract void takeSurface (SurfaceHolder.Callback2 callback)
Take ownership of this window's surface. The window's view hierarchy will no longer draw into the surface, though it will otherwise continue to operate (such as for receiving input events). The given SurfaceHolder callback will be used to tell you about state changes to the surface.
Parameters | |
---|---|
callback |
SurfaceHolder.Callback2 |
togglePanel
public abstract void togglePanel (int featureId, KeyEvent event)
Parameters | |
---|---|
featureId |
int |
event |
KeyEvent |
unregisterScrollCaptureCallback
public void unregisterScrollCaptureCallback (ScrollCaptureCallback callback)
Unregisters a ScrollCaptureCallback
previously registered with this window.
Parameters | |
---|---|
callback |
ScrollCaptureCallback : the callback to remove
This value cannot be null . |
Protected methods
getFeatures
protected final int getFeatures ()
Return the feature bits that are enabled. This is the set of features that were given to requestFeature(), and are being handled by this Window itself or its container. That is, it is the set of requested features that you can actually use.
To do: add a public version of this API that allows you to check for features by their feature ID.
Returns | |
---|---|
int |
int The feature bits. |
getForcedWindowFlags
protected final int getForcedWindowFlags ()
Return the window flags that have been explicitly set by the client,
so will not be modified by getDecorView()
.
Returns | |
---|---|
int |
getLocalFeatures
protected final int getLocalFeatures ()
Return the feature bits that are being implemented by this Window. This is the set of features that were given to requestFeature(), and are being handled by only this Window itself, not by its containers.
Returns | |
---|---|
int |
int The feature bits. |
hasSoftInputMode
protected final boolean hasSoftInputMode ()
Has the app specified their own soft input mode?
Returns | |
---|---|
boolean |
setDefaultWindowFormat
protected void setDefaultWindowFormat (int format)
Set the default format of window, as per the PixelFormat types. This is the format that will be used unless the client specifies in explicit format with setFormat();
Parameters | |
---|---|
format |
int : The new window format (see PixelFormat). |
See also:
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-07-18 UTC.