Type
class Type
| kotlin.Any | |
| ↳ | android.view.WindowInsets.Type |
Class that defines different types of sources causing window insets.
Summary
| Public methods | |
|---|---|
| static Int | |
| static Int |
Returns an insets type representing the area that used by |
| static Int |
ime() |
| static Int | |
| static Int | |
| static Int | |
| static Int | |
| static Int |
Returns an insets type representing the system gesture insets. |
| static Int |
System overlays represent the insets caused by the system visible elements. |
| static Int | |
Public methods
captionBar
static fun captionBar(): Int
| Return | |
|---|---|
Int |
An insets type representing the window of a caption bar. Value is either 0 or a combination of the following:
|
displayCutout
static fun displayCutout(): Int
Returns an insets type representing the area that used by DisplayCutout.
This is equivalent to the safe insets on getDisplayCutout().
Note: During dispatch to View.onApplyWindowInsets, if the window is using the default WindowManager.LayoutParams.layoutInDisplayCutoutMode, getDisplayCutout() will return null even if the window overlaps a display cutout area, in which case the displayCutout() inset will still report the accurate value.
| Return | |
|---|---|
Int |
Value is either 0 or a combination of the following:
|
ime
static fun ime(): Int
| Return | |
|---|---|
Int |
An insets type representing the window of an InputMethod. Value is either 0 or a combination of the following:
|
mandatorySystemGestures
static fun mandatorySystemGestures(): Int
| Return | |
|---|---|
Int |
Value is either 0 or a combination of the following:
|
See Also
navigationBars
static fun navigationBars(): Int
| Return | |
|---|---|
Int |
An insets type representing any system bars for navigation. Value is either 0 or a combination of the following:
|
statusBars
static fun statusBars(): Int
| Return | |
|---|---|
Int |
An insets type representing any system bars for displaying status. Value is either 0 or a combination of the following:
|
systemBars
static fun systemBars(): Int
| Return | |
|---|---|
Int |
All system bars. Includes statusBars(), captionBar() as well as navigationBars(), systemOverlays(), but not ime(). Value is either 0 or a combination of the following:
|
systemGestures
static fun systemGestures(): Int
Returns an insets type representing the system gesture insets.
The system gesture insets represent the area of a window where system gestures have priority and may consume some or all touch input, e.g. due to the a system bar occupying it, or it being reserved for touch-only gestures.
Simple taps are guaranteed to reach the window even within the system gesture insets, as long as they are outside the system window insets.
When View.SYSTEM_UI_FLAG_LAYOUT_STABLE is requested, an inset will be returned even when the system gestures are inactive due to View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION.
| Return | |
|---|---|
Int |
Value is either 0 or a combination of the following:
|
See Also
systemOverlays
static fun systemOverlays(): Int
System overlays represent the insets caused by the system visible elements. Unlike navigationBars() or statusBars(), system overlays might not be hidden by the client.
For compatibility reasons, this type is included in systemBars(). In this way, views which fit systemBars() fit systemOverlays().
Examples include climate controls, multi-tasking affordances, etc.
| Return | |
|---|---|
Int |
An insets type representing the system overlays. Value is either 0 or a combination of the following:
|
tappableElement
static fun tappableElement(): Int
| Return | |
|---|---|
Int |
Value is either 0 or a combination of the following:
|
See Also