WindowCompat

Added in 1.1.0

class WindowCompat


Helper for accessing features in Window.

Summary

Constants

const Int

Flag for enabling the Action Bar.

const Int

Flag for requesting an Action Bar that overlays window content.

const Int

Flag for specifying the behavior of action modes when an Action Bar is not present.

Public functions

java-static WindowInsetsControllerCompat
getInsetsController(window: Window, view: View)

Retrieves the single WindowInsetsControllerCompat of the window this view is attached to.

java-static T
<T : View?> requireViewById(window: Window, id: @IdRes Int)

Finds a view that was identified by the android:id XML attribute that was processed in onCreate, or throws an IllegalArgumentException if the ID is invalid, or there is no matching view in the hierarchy.

java-static Unit
setDecorFitsSystemWindows(
    window: Window,
    decorFitsSystemWindows: Boolean
)

Sets whether the decor view should fit root-level content views for WindowInsetsCompat.

Constants

FEATURE_ACTION_BAR

Added in 1.1.0
const val FEATURE_ACTION_BAR = 8: 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.

FEATURE_ACTION_BAR_OVERLAY

Added in 1.1.0
const val FEATURE_ACTION_BAR_OVERLAY = 9: 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 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.

FEATURE_ACTION_MODE_OVERLAY

Added in 1.1.0
const val FEATURE_ACTION_MODE_OVERLAY = 10: 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.

Public functions

getInsetsController

Added in 1.5.0
java-static fun getInsetsController(window: Window, view: View): WindowInsetsControllerCompat

Retrieves the single WindowInsetsControllerCompat of the window this view is attached to.

requireViewById

Added in 1.1.0
java-static fun <T : View?> requireViewById(window: Window, id: @IdRes Int): T

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

Parameters
window: Window

window in which to find the view.

id: @IdRes Int

the ID to search for

Returns
T

a view with given ID

setDecorFitsSystemWindows

Added in 1.5.0
java-static fun setDecorFitsSystemWindows(
    window: Window,
    decorFitsSystemWindows: Boolean
): Unit

Sets whether the decor view should fit root-level content views for WindowInsetsCompat.

If set to false, the framework will not fit the content view to the insets and will just pass through the WindowInsetsCompat to the content view.

Please note: using the setSystemUiVisibility API in your app can conflict with this method. Please discontinue use of setSystemUiVisibility.

Parameters
window: Window

The current window.

decorFitsSystemWindows: Boolean

Whether the decor view should fit root-level content views for insets.