WindowInsetsCompat.Builder
public final class WindowInsetsCompat.Builder
Builder for WindowInsetsCompat.
Summary
Public constructors |
|---|
Builder()Creates a builder where all insets are initially consumed. |
Builder(@NonNull WindowInsetsCompat insets)Creates a builder where all insets are initialized from |
Public constructors
Builder
public Builder(@NonNull WindowInsetsCompat insets)
Creates a builder where all insets are initialized from WindowInsetsCompat.
| Parameters | |
|---|---|
@NonNull WindowInsetsCompat insets |
the instance to initialize from. |
Public methods
build
public @NonNull WindowInsetsCompat build()
Builds a WindowInsetsCompat instance.
| Returns | |
|---|---|
@NonNull WindowInsetsCompat |
the |
setDisplayCutout
public @NonNull WindowInsetsCompat.Builder setDisplayCutout(@Nullable DisplayCutoutCompat displayCutout)
Sets the display cutout.
The cutout passed will only take effect when running on API 29 and above.
| Parameters | |
|---|---|
@Nullable DisplayCutoutCompat displayCutout |
the display cutout or null if there is none |
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
getDisplayCutout |
setInsets
public @NonNull WindowInsetsCompat.Builder setInsets(int typeMask, @NonNull Insets insets)
Sets the insets of a specific window type in pixels.
The insets represents the area of a a window that is partially or fully obscured by the system windows identified by typeMask.
| Parameters | |
|---|---|
int typeMask |
The bitmask of |
@NonNull Insets insets |
The insets to set. |
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
getInsets |
setInsetsIgnoringVisibility
public @NonNull WindowInsetsCompat.Builder setInsetsIgnoringVisibility(int typeMask, @NonNull Insets insets)
Sets the insets a specific window type in pixels, while ignoring its visibility state.
The insets represents the area of a a window that that may be partially or fully obscured by the system window identified by typeMask. This value does not change based on the visibility state of those elements. For example, if the status bar is normally shown, but temporarily hidden, the inset returned here will still provide the inset associated with the status bar being shown.
| Parameters | |
|---|---|
int typeMask |
The bitmask of |
@NonNull Insets insets |
The insets to set. |
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
If |
| See also | |
|---|---|
getInsetsIgnoringVisibility |
public @NonNull WindowInsetsCompat.BuildersetMandatorySystemGestureInsets(@NonNull Insets insets)
Sets mandatory system gesture insets in pixels.
The mandatory system gesture insets represent the area of a window where mandatory 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.
In contrast to regular system gestures, mandatory system gestures cannot be overridden by setSystemGestureExclusionRects.
The insets passed will only take effect when running on API 29 and above.
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
getMandatorySystemGestureInsets |
public @NonNull WindowInsetsCompat.BuildersetStableInsets(@NonNull Insets insets)
Sets the stable insets in pixels.
The stable inset represents the area of a full-screen window that may be partially or fully obscured by the system UI elements. This value does not change based on the visibility state of those elements; for example, if the status bar is normally shown, but temporarily hidden, the stable inset will still provide the inset associated with the status bar being shown.
The insets passed will only take effect when running on API 29 and above.
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
getStableInsets |
public @NonNull WindowInsetsCompat.BuildersetSystemGestureInsets(@NonNull Insets insets)
Sets system gesture insets in pixels.
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.
The insets passed will only take effect when running on API 29 and above.
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
getSystemGestureInsets |
public @NonNull WindowInsetsCompat.BuildersetSystemWindowInsets(@NonNull Insets insets)
Sets system window insets in pixels.
The system window inset represents the area of a full-screen window that is partially or fully obscured by the status bar, navigation bar, IME or other system windows.
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
getSystemWindowInsets |
public @NonNull WindowInsetsCompat.BuildersetTappableElementInsets(@NonNull Insets insets)
Sets tappable element insets in pixels.
The tappable element insets represent how much tappable elements must at least be inset to remain both tappable and visually unobstructed by persistent system windows.
The insets passed will only take effect when running on API 29 and above.
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
getTappableElementInsets |
setVisible
public @NonNull WindowInsetsCompat.Builder setVisible(int typeMask, boolean visible)
Sets whether windows that can cause insets are currently visible on screen.
| Parameters | |
|---|---|
int typeMask |
The bitmask of |
boolean visible |
Whether to mark the windows as visible or not. |
| Returns | |
|---|---|
@NonNull WindowInsetsCompat.Builder |
itself |
| See also | |
|---|---|
isVisible |