Google は、黒人コミュニティに対する人種平等の促進に取り組んでいます。取り組みを見る

WindowInsetsCompat.Builder

public static final class WindowInsetsCompat.Builder
extends Object

java.lang.Object
   ↳ androidx.core.view.WindowInsetsCompat.Builder


Builder for WindowInsetsCompat.

Summary

Public constructors

Builder()

Creates a builder where all insets are initially consumed.

Builder(WindowInsetsCompat insets)

Creates a builder where all insets are initialized from WindowInsetsCompat.

Public methods

WindowInsetsCompat build()

Builds a WindowInsetsCompat instance.

WindowInsetsCompat.Builder setDisplayCutout(DisplayCutoutCompat displayCutout)

Sets the display cutout.

WindowInsetsCompat.Builder setInsets(int typeMask, Insets insets)

Sets the insets of a specific window type in pixels.

WindowInsetsCompat.Builder setInsetsIgnoringVisibility(int typeMask, Insets insets)

Sets the insets a specific window type in pixels, while ignoring its visibility state.

WindowInsetsCompat.Builder setMandatorySystemGestureInsets(Insets insets)

This method is deprecated. Use setInsets(int, Insets) with WindowInsetsCompat.Type.mandatorySystemGestures().

WindowInsetsCompat.Builder setStableInsets(Insets insets)

This method is deprecated. Use setInsetsIgnoringVisibility(int, Insets) with WindowInsetsCompat.Type.systemBars().

WindowInsetsCompat.Builder setSystemGestureInsets(Insets insets)

This method is deprecated. Use setInsets(int, Insets) with WindowInsetsCompat.Type.systemGestures().

WindowInsetsCompat.Builder setSystemWindowInsets(Insets insets)

This method is deprecated. Use setInsets(int, Insets) with WindowInsetsCompat.Type.systemBars().

WindowInsetsCompat.Builder setTappableElementInsets(Insets insets)

This method is deprecated. Use setInsets(int, Insets) with WindowInsetsCompat.Type.tappableElement().

WindowInsetsCompat.Builder setVisible(int typeMask, boolean visible)

Sets whether windows that can cause insets are currently visible on screen.

Inherited methods

Public constructors

Builder

public Builder ()

Creates a builder where all insets are initially consumed.

Builder

public Builder (WindowInsetsCompat insets)

Creates a builder where all insets are initialized from WindowInsetsCompat.

Parameters
insets WindowInsetsCompat: the instance to initialize from.

Public methods

build

public WindowInsetsCompat build ()

Builds a WindowInsetsCompat instance.

Returns
WindowInsetsCompat the WindowInsetsCompat instance.

setDisplayCutout

public WindowInsetsCompat.Builder setDisplayCutout (DisplayCutoutCompat displayCutout)

Sets the display cutout.

The cutout passed will only take effect when running on API 29 and above.

Parameters
displayCutout DisplayCutoutCompat: the display cutout or null if there is none

Returns
WindowInsetsCompat.Builder itself

setInsets

public WindowInsetsCompat.Builder setInsets (int typeMask, 
                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
typeMask int: The bitmask of WindowInsetsCompat.Type to set the insets for.

insets Insets: The insets to set.

Returns
WindowInsetsCompat.Builder itself

setInsetsIgnoringVisibility

public WindowInsetsCompat.Builder setInsetsIgnoringVisibility (int typeMask, 
                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
typeMask int: The bitmask of WindowInsetsCompat.Type to set the insets for.

insets Insets: The insets to set.

Returns
WindowInsetsCompat.Builder itself

Throws
IllegalArgumentException If typeMask contains WindowInsetsCompat.Type.ime(). Maximum insets are not available for this type as the height of the IME is dynamic depending on the EditorInfo of the currently focused view, as well as the UI state of the IME.

setMandatorySystemGestureInsets

public WindowInsetsCompat.Builder setMandatorySystemGestureInsets (Insets insets)

This method is deprecated.
Use setInsets(int, Insets) with WindowInsetsCompat.Type.mandatorySystemGestures().

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 ViewCompat.setSystemGestureExclusionRects(View, List).

The insets passed will only take effect when running on API 29 and above.

Parameters
insets Insets

Returns
WindowInsetsCompat.Builder itself

setStableInsets

public WindowInsetsCompat.Builder setStableInsets (Insets insets)

This method is deprecated.
Use setInsetsIgnoringVisibility(int, Insets) with WindowInsetsCompat.Type.systemBars().

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.

Parameters
insets Insets

Returns
WindowInsetsCompat.Builder itself

setSystemGestureInsets

public WindowInsetsCompat.Builder setSystemGestureInsets (Insets insets)

This method is deprecated.
Use setInsets(int, Insets) with WindowInsetsCompat.Type.systemGestures().

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.

Parameters
insets Insets

Returns
WindowInsetsCompat.Builder itself

setSystemWindowInsets

public WindowInsetsCompat.Builder setSystemWindowInsets (Insets insets)

This method is deprecated.
Use setInsets(int, Insets) with WindowInsetsCompat.Type.systemBars().

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.

Parameters
insets Insets

Returns
WindowInsetsCompat.Builder itself

setTappableElementInsets

public WindowInsetsCompat.Builder setTappableElementInsets (Insets insets)

This method is deprecated.
Use setInsets(int, Insets) with WindowInsetsCompat.Type.tappableElement().

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.

Parameters
insets Insets

Returns
WindowInsetsCompat.Builder itself

setVisible

public WindowInsetsCompat.Builder setVisible (int typeMask, 
                boolean visible)

Sets whether windows that can cause insets are currently visible on screen.

Parameters
typeMask int: The bitmask of WindowInsetsCompat.Type to set the visibility for.

visible boolean: Whether to mark the windows as visible or not.

Returns
WindowInsetsCompat.Builder itself