Window

DECOR_CAPTION_SHADE_AUTO

static val DECOR_CAPTION_SHADE_AUTO: Int

Flag for letting the theme drive the color of the window caption controls. Use with setDecorCaptionShade(int). This is the default value.

Value: 0

DECOR_CAPTION_SHADE_DARK

static val DECOR_CAPTION_SHADE_DARK: Int

Flag for setting dark-color controls on the window caption. Use with setDecorCaptionShade(int).

Value: 2

DECOR_CAPTION_SHADE_LIGHT

static val DECOR_CAPTION_SHADE_LIGHT: Int

Flag for setting light-color controls on the window caption. Use with setDecorCaptionShade(int).

Value: 1

DEFAULT_FEATURES

protected static val DEFAULT_FEATURES: Int

Deprecated: use getDefaultFeatures(android.content.Context) instead.

The default features enabled.

Value: 65

FEATURE_ACTION_BAR

static val FEATURE_ACTION_BAR: Int

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.

Value: 8

FEATURE_ACTION_BAR_OVERLAY

static val FEATURE_ACTION_BAR_OVERLAY: Int

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 android.os.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.

Value: 9

FEATURE_ACTION_MODE_OVERLAY

static val FEATURE_ACTION_MODE_OVERLAY: Int

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.

Value: 10

FEATURE_ACTIVITY_TRANSITIONS

static val FEATURE_ACTIVITY_TRANSITIONS: Int

Enables Activities to run Activity Transitions either through sending or receiving ActivityOptions bundle created with android.app.ActivityOptions#makeSceneTransitionAnimation(android.app.Activity, * android.util.Pair[]) or android.app.ActivityOptions#makeSceneTransitionAnimation( * android.app.Activity, View, String).

Value: 13

FEATURE_CONTENT_TRANSITIONS

static val FEATURE_CONTENT_TRANSITIONS: Int

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.

Value: 12

FEATURE_CONTEXT_MENU

static val FEATURE_CONTEXT_MENU: Int

Flag for the context menu. This is enabled by default.

Value: 6

FEATURE_CUSTOM_TITLE

static val FEATURE_CUSTOM_TITLE: Int

Flag for custom title. You cannot combine this feature with other title features.

Value: 7

FEATURE_INDETERMINATE_PROGRESS

static val FEATURE_INDETERMINATE_PROGRESS: Int

Deprecated: No longer supported starting in API 21.

Flag for indeterminate progress.

Value: 5

FEATURE_LEFT_ICON

static val FEATURE_LEFT_ICON: Int

Flag for having an icon on the left side of the title bar

Value: 3

FEATURE_NO_TITLE

static val FEATURE_NO_TITLE: Int

Flag for the "no title" feature, turning off the title at the top of the screen.

Value: 1

FEATURE_OPTIONS_PANEL

static val FEATURE_OPTIONS_PANEL: Int

Flag for the "options panel" feature. This is enabled by default.

Value: 0

FEATURE_PROGRESS

static val FEATURE_PROGRESS: Int

Deprecated: No longer supported starting in API 21.

Flag for the progress indicator feature.

Value: 2

FEATURE_RIGHT_ICON

static val FEATURE_RIGHT_ICON: Int

Flag for having an icon on the right side of the title bar

Value: 4

FEATURE_SWIPE_TO_DISMISS

static val FEATURE_SWIPE_TO_DISMISS: Int

Deprecated: Swipe-to-dismiss isn't functional anymore.

Flag for requesting a decoration-free window that is dismissed by swiping from the left.

Value: 11

ID_ANDROID_CONTENT

static val ID_ANDROID_CONTENT: Int

The ID that the main layout in the XML layout file should have.

Value: 16908290

NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME

static val NAVIGATION_BAR_BACKGROUND_TRANSITION_NAME: String

The transitionName for the navigation bar background View when a custom background is used.

Value: "android:navigation:background"

PROGRESS_END

static val PROGRESS_END: Int

Deprecated: FEATURE_PROGRESS and related methods are no longer supported starting in API 21.

Ending value for the (primary) progress.

Value: 10000

PROGRESS_INDETERMINATE_OFF

static val PROGRESS_INDETERMINATE_OFF: Int

Deprecated: FEATURE_INDETERMINATE_PROGRESS and related methods are no longer supported starting in API 21.

Flag for setting the progress bar's indeterminate mode off.

Value: -4

PROGRESS_INDETERMINATE_ON

static val PROGRESS_INDETERMINATE_ON: Int

Deprecated: FEATURE_INDETERMINATE_PROGRESS and related methods are no longer supported starting in API 21.

Flag for setting the progress bar's indeterminate mode on.

Value: -3

PROGRESS_SECONDARY_END

static val PROGRESS_SECONDARY_END: Int

Deprecated: FEATURE_PROGRESS and related methods are no longer supported starting in API 21.

Highest possible value for the secondary progress.

Value: 30000

PROGRESS_SECONDARY_START

static val PROGRESS_SECONDARY_START: Int

Deprecated: FEATURE_PROGRESS and related methods are no longer supported starting in API 21.

Lowest possible value for the secondary progress.

Value: 20000

PROGRESS_START

static val PROGRESS_START: Int

Deprecated: FEATURE_PROGRESS and related methods are no longer supported starting in API 21.

Starting value for the (primary) progress.

Value: 0

PROGRESS_VISIBILITY_OFF

static val PROGRESS_VISIBILITY_OFF: Int

Deprecated: FEATURE_PROGRESS and related methods are no longer supported starting in API 21.

Flag for setting the progress bar's visibility to GONE.

Value: -2

PROGRESS_VISIBILITY_ON

static val PROGRESS_VISIBILITY_ON: Int

Deprecated: FEATURE_PROGRESS and related methods are no longer supported starting in API 21.

Flag for setting the progress bar's visibility to VISIBLE.

Value: -1

STATUS_BAR_BACKGROUND_TRANSITION_NAME

static val STATUS_BAR_BACKGROUND_TRANSITION_NAME: String

The transitionName for the status bar background View when a custom background is used.

Value: "android:status:background"

Window

Window(context: Context!)

addContentView

abstract fun addContentView(
    view: View!, 
    params: ViewGroup.LayoutParams!
): Unit

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.

addFlags

open fun addFlags(flags: Int): Unit

Convenience function to set the flag bits as specified in flags, as per setFlags.

addOnFrameMetricsAvailableListener

fun addOnFrameMetricsAvailableListener(
    listener: Window.OnFrameMetricsAvailableListener, 
    handler: Handler!
): Unit

Set an observer to collect frame stats for each frame rendered in this window. Must be in hardware rendering mode.

clearFlags

open fun clearFlags(flags: Int): Unit

Convenience function to clear the flag bits as specified in flags, as per setFlags.

closeAllPanels

abstract fun closeAllPanels(): Unit

closePanel

abstract fun closePanel(featureId: Int): Unit

findViewById

open fun <T : View!> findViewById(id: Int): T

Finds a view that was identified by the android:id XML attribute that was processed in android.app.Activity#onCreate.

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.

getAllowEnterTransitionOverlap

open fun getAllowEnterTransitionOverlap(): Boolean

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.

getAllowReturnTransitionOverlap

open fun getAllowReturnTransitionOverlap(): Boolean

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.

getAttributes

fun getAttributes(): WindowManager.LayoutParams!

Retrieve the current window attributes associated with this panel.

getCallback

fun getCallback(): Window.Callback!

Return the current Callback interface for this window.

getColorMode

open fun getColorMode(): Int

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.

getContainer

fun getContainer(): Window!

Return the container for this Window.

getContentScene

open fun getContentScene(): Scene!

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.

getContext

fun getContext(): Context!

Return the Context this window policy is running in, for retrieving resources and other information.

getCurrentFocus

abstract fun getCurrentFocus(): View?

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.

getDecorView

abstract fun getDecorView(): View

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).

getDefaultFeatures

open static fun getDefaultFeatures(context: Context!): Int

Return the feature bits set by default on a window.

getDesiredHdrHeadroom

open fun getDesiredHdrHeadroom(): Float

Get the desired amount of HDR headroom as set by setDesiredHdrHeadroom(float)

getEnterTransition

open fun getEnterTransition(): Transition!

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 android.transition.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.

getExitTransition

open fun getExitTransition(): Transition!

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 android.transition.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.

getFrameRateBoostOnTouchEnabled

open fun getFrameRateBoostOnTouchEnabled(): Boolean

Get whether frame rate touch boost is enabled setFrameRateBoostOnTouchEnabled(boolean)

getInsetsController

open fun getInsetsController(): WindowInsetsController?

getLayoutInflater

abstract fun getLayoutInflater(): LayoutInflater

Quick access to the LayoutInflater instance that this Window retrieved from its Context.

getMediaController

open fun getMediaController(): MediaController!

Gets the MediaController that was previously set.

getNavigationBarColor

abstract fun getNavigationBarColor(): Int

Deprecated: This is no longer needed since the setter is deprecated.

getNavigationBarDividerColor

open fun getNavigationBarDividerColor(): Int

Deprecated: This is no longer needed since the setter is deprecated.

Retrieves the color of the navigation bar divider.

getOnBackInvokedDispatcher

open fun getOnBackInvokedDispatcher(): OnBackInvokedDispatcher

Returns the OnBackInvokedDispatcher instance associated with this window.

getReenterTransition

open fun getReenterTransition(): Transition!

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 android.transition.Visibility as exiting is governed by changing visibility from View.VISIBLE to View.INVISIBLE. Requires FEATURE_ACTIVITY_TRANSITIONS.

getReturnTransition

open fun getReturnTransition(): Transition!

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 android.app.Activity#finishAfterTransition(). The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup.isTransitionGroup return true. Typical Transitions will extend android.transition.Visibility as entering is governed by changing visibility from View.VISIBLE to View.INVISIBLE.

getRootSurfaceControl

open fun getRootSurfaceControl(): AttachedSurfaceControl?

This will be null before a content view is added, e.g. via #setContentView or addContentView. See android.view.View#getRootSurfaceControl.

getSharedElementEnterTransition

open fun getSharedElementEnterTransition(): Transition!

Returns the Transition that will be used for shared elements transferred into the content Scene. Requires FEATURE_ACTIVITY_TRANSITIONS.

getSharedElementExitTransition

open fun getSharedElementExitTransition(): Transition!

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.

getSharedElementReenterTransition

open fun getSharedElementReenterTransition(): Transition!

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.

getSharedElementReturnTransition

open fun getSharedElementReturnTransition(): Transition!

Returns the Transition that will be used for shared elements transferred back to a calling Activity. Requires FEATURE_ACTIVITY_TRANSITIONS.

getSharedElementsUseOverlay

open fun getSharedElementsUseOverlay(): Boolean

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.

getStatusBarColor

abstract fun getStatusBarColor(): Int

Deprecated: This is no longer needed since the setter is deprecated.

getSystemGestureExclusionRects

open fun getSystemGestureExclusionRects(): MutableList<Rect!>

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.

getTransitionBackgroundFadeDuration

open fun getTransitionBackgroundFadeDuration(): Long

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.

getTransitionManager

open fun getTransitionManager(): TransitionManager!

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) if FEATURE_CONTENT_TRANSITIONS has been granted.

getVolumeControlStream

abstract fun getVolumeControlStream(): Int

getWindowManager

open fun getWindowManager(): WindowManager!

Return the window manager allowing this Window to display its own windows.

getWindowStyle

fun getWindowStyle(): TypedArray!

Return the android.R.styleable#Window attributes from this window's theme.

hasChildren

fun hasChildren(): Boolean

hasFeature

open fun hasFeature(feature: Int): Boolean

Query for the availability of a certain feature.

injectInputEvent

open fun injectInputEvent(event: InputEvent!): Unit

Inject an event to window locally.

invalidatePanelMenu

abstract fun invalidatePanelMenu(featureId: Int): Unit

isActive

fun isActive(): Boolean

isFloating

abstract fun isFloating(): Boolean

Return whether this window is being displayed with a floating style (based on the android.R.attr#windowIsFloating attribute in the style/theme).

isFrameRatePowerSavingsBalanced

open fun isFrameRatePowerSavingsBalanced(): Boolean

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)

isNavigationBarContrastEnforced

open fun isNavigationBarContrastEnforced(): Boolean

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.

isShortcutKey

abstract fun isShortcutKey(
    keyCode: Int, 
    event: KeyEvent!
): Boolean

Is a keypress one of the defined shortcut keys for this window.

isStatusBarContrastEnforced

open fun isStatusBarContrastEnforced(): Boolean

Deprecated: 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.

isWideColorGamut

open fun isWideColorGamut(): Boolean

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.

makeActive

fun makeActive(): Unit

onConfigurationChanged

abstract fun onConfigurationChanged(newConfig: Configuration!): Unit

Should be called when the configuration is changed.

openPanel

abstract fun openPanel(
    featureId: Int, 
    event: KeyEvent!
): Unit

peekDecorView

abstract fun peekDecorView(): View!

Retrieve the current decor view, but only if it has already been created; otherwise returns null.

performContextMenuIdentifierAction

abstract fun performContextMenuIdentifierAction(
    id: Int, 
    flags: Int
): Boolean

performPanelIdentifierAction

abstract fun performPanelIdentifierAction(
    featureId: Int, 
    id: Int, 
    flags: Int
): Boolean

performPanelShortcut

abstract fun performPanelShortcut(
    featureId: Int, 
    keyCode: Int, 
    event: KeyEvent!, 
    flags: Int
): Boolean

registerScrollCaptureCallback

open fun registerScrollCaptureCallback(callback: ScrollCaptureCallback): Unit

Used to provide scroll capture support for an arbitrary window. This registeres the given callback with the root view of the window.

removeOnFrameMetricsAvailableListener

fun removeOnFrameMetricsAvailableListener(listener: Window.OnFrameMetricsAvailableListener!): Unit

Remove observer and stop listening to frame stats for this window.

requestFeature

open fun requestFeature(featureId: Int): Boolean

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.

requireViewById

fun <T : View!> requireViewById(id: Int): T

Finds a view that was identified by the android:id XML attribute that was processed in android.app.Activity#onCreate, 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.

restoreHierarchyState

abstract fun restoreHierarchyState(savedInstanceState: Bundle!): Unit

saveHierarchyState

abstract fun saveHierarchyState(): Bundle!

setAllowEnterTransitionOverlap

open fun setAllowEnterTransitionOverlap(allow: Boolean): Unit

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.

setAllowReturnTransitionOverlap

open fun setAllowReturnTransitionOverlap(allow: Boolean): Unit

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.

setAttributes

open fun setAttributes(a: WindowManager.LayoutParams!): Unit

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.

setBackgroundBlurRadius

open fun setBackgroundBlurRadius(blurRadius: Int): Unit

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 android.R.attr#windowIsTranslucent) and floating (see android.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 android.view.WindowManager#addCrossWindowBlurEnabledListener.

setBackgroundDrawable

abstract fun setBackgroundDrawable(drawable: Drawable!): Unit

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.)

setBackgroundDrawableResource

open fun setBackgroundDrawableResource(resId: Int): Unit

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.)

setCallback

open fun setCallback(callback: Window.Callback!): Unit

Set the Callback interface for this window, used to intercept key events and other dynamic operations in the window.

setChildDrawable

abstract fun setChildDrawable(
    featureId: Int, 
    drawable: Drawable!
): Unit

setChildInt

abstract fun setChildInt(
    featureId: Int, 
    value: Int
): Unit

setClipToOutline

open fun setClipToOutline(clipToOutline: Boolean): Unit

Sets whether window content should be clipped to the outline of the window background.

setColorMode

open fun setColorMode(colorMode: Int): Unit

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.

Note: This does not impact SurfaceViews or SurfaceControls, as those have their own independent color mode and HDR parameters.

setContainer

open fun setContainer(container: Window!): Unit

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.

setContentView

abstract fun setContentView(view: View!): Unit

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.

setContentView

abstract fun setContentView(
    view: View!, 
    params: ViewGroup.LayoutParams!
): Unit

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.

setContentView

abstract fun setContentView(layoutResID: Int): Unit

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.

setDecorCaptionShade

abstract fun setDecorCaptionShade(decorCaptionShade: Int): Unit

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.

setDecorFitsSystemWindows

open fun setDecorFitsSystemWindows(decorFitsSystemWindows: Boolean): Unit

Deprecated: 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.

setDesiredHdrHeadroom

open fun setDesiredHdrHeadroom(desiredHeadroom: Float): Unit

Sets the desired amount 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.

Note: This does not impact SurfaceViews or SurfaceControls, as those have their own independent desired HDR headroom and HDR capabilities.

setDimAmount

open fun setDimAmount(amount: Float): Unit

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.

setElevation

open fun setElevation(elevation: Float): Unit

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.

setEnterTransition

open fun setEnterTransition(transition: Transition!): Unit

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 android.transition.Visibility as entering is governed by changing visibility from View.INVISIBLE to View.VISIBLE. If transition is null, entering Views will remain unaffected.

setExitTransition

open fun setExitTransition(transition: Transition!): Unit

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 android.transition.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.

setFeatureDrawable

abstract fun setFeatureDrawable(
    featureId: Int, 
    drawable: Drawable!
): Unit

Set an explicit Drawable value for feature of this window. You must have called requestFeature(featureId) before calling this function.

setFeatureDrawableAlpha

abstract fun setFeatureDrawableAlpha(
    featureId: Int, 
    alpha: Int
): Unit

Set a custom alpha value for the given drawable feature, controlling how much the background is visible through it.

setFeatureDrawableResource

abstract fun setFeatureDrawableResource(
    featureId: Int, 
    resId: Int
): Unit

Set the value for a drawable feature of this window, from a resource identifier. You must have called requestFeature(featureId) before calling this function.

setFeatureDrawableUri

abstract fun setFeatureDrawableUri(
    featureId: Int, 
    uri: Uri!
): Unit

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.

setFeatureInt

abstract fun setFeatureInt(
    featureId: Int, 
    value: Int
): Unit

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.

setFlags

open fun setFlags(
    flags: Int, 
    mask: Int
): Unit

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 android.R.attr#windowIsFloating attribute.

setFormat

open fun setFormat(format: Int): Unit

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.

setFrameRateBoostOnTouchEnabled

open fun setFrameRateBoostOnTouchEnabled(enabled: Boolean): Unit

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.

setFrameRatePowerSavingsBalanced

open fun setFrameRatePowerSavingsBalanced(enabled: Boolean): Unit

Set whether frameratepowersavingsbalance is enabled for this Window. This allows device to adjust refresh rate as needed and can be useful for power saving.

setGravity

open fun setGravity(gravity: Int): Unit

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.

setHideOverlayWindows

fun setHideOverlayWindows(hide: Boolean): Unit

Prevent non-system overlay windows from being drawn on top of this window.
Requires android.Manifest.permission#HIDE_OVERLAY_WINDOWS

setIcon

open fun setIcon(resId: Int): Unit

Set the primary icon for this window.

setLayout

open fun setLayout(
    width: Int, 
    height: Int
): Unit

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.

setLocalFocus

open fun setLocalFocus(
    hasFocus: Boolean, 
    inTouchMode: Boolean
): Unit

Set focus locally. The window should have the WindowManager.LayoutParams.FLAG_LOCAL_FOCUS_MODE flag set already.

setLogo

open fun setLogo(resId: Int): Unit

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.

setMediaController

open fun setMediaController(controller: MediaController!): Unit

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.

setNavigationBarColor

abstract fun setNavigationBarColor(color: Int): Unit

Deprecated: Draw proper background behind WindowInsets.Type.navigationBars() or WindowInsets.Type.tappableElement() instead.

Sets the color of the navigation bar to {@param color}. For this to take effect, the window must be drawing the system bar backgrounds with android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS and android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_NAVIGATION must not be set. If {@param color} is not opaque, consider setting android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE and android.view.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.

setNavigationBarContrastEnforced

open fun setNavigationBarContrastEnforced(enforceContrast: Boolean): Unit

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.

setNavigationBarDividerColor

open fun setNavigationBarDividerColor(dividerColor: Int): Unit

Deprecated: 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 android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS and android.view.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.

setPreferMinimalPostProcessing

open fun setPreferMinimalPostProcessing(isPreferred: Boolean): Unit

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.

setReenterTransition

open fun setReenterTransition(transition: Transition!): Unit

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 android.transition.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.

setResizingCaptionDrawable

abstract fun setResizingCaptionDrawable(drawable: Drawable!): Unit

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).

setRestrictedCaptionAreaListener

fun setRestrictedCaptionAreaListener(listener: Window.OnRestrictedCaptionAreaChangedListener!): Unit

Set a callback for changes of area where caption will draw its content.

setReturnTransition

open fun setReturnTransition(transition: Transition!): Unit

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 android.app.Activity#finishAfterTransition(). The exiting Views will be those that are regular Views or ViewGroups that have ViewGroup.isTransitionGroup return true. Typical Transitions will extend android.transition.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).

setSharedElementEnterTransition

open fun setSharedElementEnterTransition(transition: Transition!): Unit

Sets the Transition that will be used for shared elements transferred into the content Scene. Typical Transitions will affect size and location, such as android.transition.ChangeBounds. A null value will cause transferred shared elements to blink to the final position. Requires FEATURE_ACTIVITY_TRANSITIONS.

setSharedElementExitTransition

open fun setSharedElementExitTransition(transition: Transition!): Unit

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.

setSharedElementReenterTransition

open fun setSharedElementReenterTransition(transition: Transition!): Unit

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.

setSharedElementReturnTransition

open fun setSharedElementReturnTransition(transition: Transition!): Unit

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 android.transition.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.

setSharedElementsUseOverlay

open fun setSharedElementsUseOverlay(sharedElementsUseOverlay: Boolean): Unit

Sets whether or not shared elements should use an Overlay during shared element transitions. The default value is true.

setSoftInputMode

open fun setSoftInputMode(mode: Int): Unit

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.

setStatusBarColor

abstract fun setStatusBarColor(color: Int): Unit

Deprecated: 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 android.view.WindowManager.LayoutParams#FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS and android.view.WindowManager.LayoutParams#FLAG_TRANSLUCENT_STATUS must not be set. If color is not opaque, consider setting android.view.View#SYSTEM_UI_FLAG_LAYOUT_STABLE and android.view.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.

setStatusBarContrastEnforced

open fun setStatusBarContrastEnforced(ensureContrast: Boolean): Unit

Deprecated: 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.

setSustainedPerformanceMode

open fun setSustainedPerformanceMode(enable: Boolean): Unit

setSystemGestureExclusionRects

open fun setSystemGestureExclusionRects(rects: MutableList<Rect!>): Unit

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.

setTitle

abstract fun setTitle(title: CharSequence!): Unit

setTitleColor

abstract fun setTitleColor(textColor: Int): Unit

Deprecated: Deprecated in Java.

setTransitionBackgroundFadeDuration

open fun setTransitionBackgroundFadeDuration(fadeDurationMillis: Long): Unit

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.

setTransitionManager

open fun setTransitionManager(tm: TransitionManager!): Unit

Set the TransitionManager to use for default transitions in this window. Requires FEATURE_CONTENT_TRANSITIONS.