WindowInsetsAnimationCompat.BoundsCompat

public static final class WindowInsetsAnimationCompat.BoundsCompat
extends Object

java.lang.Object
   ↳ androidx.core.view.WindowInsetsAnimationCompat.BoundsCompat


Class representing the range of an WindowInsetsAnimationCompat

Summary

Public constructors

BoundsCompat(Insets lowerBound, Insets upperBound)

Public methods

Insets getLowerBound()

Queries the lower inset bound of the animation.

Insets getUpperBound()

Queries the upper inset bound of the animation.

WindowInsetsAnimationCompat.BoundsCompat inset(Insets insets)

Insets both the lower and upper bound by the specified insets.

WindowInsetsAnimation.Bounds toBounds()

Creates a new instance of WindowInsetsAnimation.Bounds from this compat instance.

static WindowInsetsAnimationCompat.BoundsCompat toBoundsCompat(WindowInsetsAnimation.Bounds bounds)

Create a new insance of WindowInsetsAnimationCompat.BoundsCompat using the provided platform WindowInsetsAnimation.Bounds.

String toString()

Inherited methods

Public constructors

BoundsCompat

public BoundsCompat (Insets lowerBound, 
                Insets upperBound)

Parameters
lowerBound Insets

upperBound Insets

Public methods

getLowerBound

public Insets getLowerBound ()

Queries the lower inset bound of the animation. If the animation is about showing or hiding a window that cause insets, the lower bound is Insets.NONE and the upper bound is the same as WindowInsetsCompat.getInsets(int) for the fully shown state. This is the same as WindowInsetsAnimationControllerCompat.getHiddenStateInsets() and WindowInsetsAnimationControllerCompat.getShownStateInsets() in case the listener gets invoked because of an animation that originates from WindowInsetsAnimationControllerCompat.

However, if the size of a window that causes insets is changing, these are the lower/upper bounds of that size animation.

There are no overlapping animations for a specific type, but there may be multiple animations running at the same time for different inset types.

Returns
Insets

getUpperBound

public Insets getUpperBound ()

Queries the upper inset bound of the animation. If the animation is about showing or hiding a window that cause insets, the lower bound is Insets.NONE nd the upper bound is the same as WindowInsetsCompat.getInsets(int) for the fully shown state. This is the same as WindowInsetsAnimationControllerCompat.getHiddenStateInsets() and WindowInsetsAnimationControllerCompat.getShownStateInsets() in case the listener gets invoked because of an animation that originates from WindowInsetsAnimationControllerCompat.

However, if the size of a window that causes insets is changing, these are the lower/upper bounds of that size animation.

There are no overlapping animations for a specific type, but there may be multiple animations running at the same time for different inset types.

Returns
Insets

inset

public WindowInsetsAnimationCompat.BoundsCompat inset (Insets insets)

Insets both the lower and upper bound by the specified insets. This is to be used in WindowInsetsAnimationCompat.Callback.onStart(WindowInsetsAnimationCompat, WindowInsetsAnimationCompat.BoundsCompat) to indicate that a part of the insets has been used to offset or clip its children, and the children shouldn't worry about that part anymore.

Parameters
insets Insets: The amount to inset.

Returns
WindowInsetsAnimationCompat.BoundsCompat A copy of this instance inset in the given directions.

toBounds

public WindowInsetsAnimation.Bounds toBounds ()

Creates a new instance of WindowInsetsAnimation.Bounds from this compat instance.

Returns
WindowInsetsAnimation.Bounds

toBoundsCompat

public static WindowInsetsAnimationCompat.BoundsCompat toBoundsCompat (WindowInsetsAnimation.Bounds bounds)

Create a new insance of WindowInsetsAnimationCompat.BoundsCompat using the provided platform WindowInsetsAnimation.Bounds.

Parameters
bounds WindowInsetsAnimation.Bounds

Returns
WindowInsetsAnimationCompat.BoundsCompat

toString

public String toString ()

Returns
String