WindowInsetsAnimation.Bounds

Kotlin |Java

public static final class WindowInsetsAnimation.Bounds
extends Object

java.lang.Object
↳	android.view.WindowInsetsAnimation.Bounds

Class representing the range of an WindowInsetsAnimation

Summary

Public constructors
`Bounds(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.
`WindowInsetsAnimation.Bounds`	`inset(Insets insets)` Insets both the lower and upper bound by the specified insets.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Bounds

Added in API level 30

public Bounds (Insets lowerBound, 
                Insets upperBound)

Parameters
`lowerBound`	`Insets`: This value cannot be `null`.
`upperBound`	`Insets`: This value cannot be `null`.

Public methods

getLowerBound

Added in API level 30

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 WindowInsets#getInsets(int) for the fully shown state. This is the same as WindowInsetsAnimationController#getHiddenStateInsets and WindowInsetsAnimationController#getShownStateInsets in case the listener gets invoked because of an animation that originates from WindowInsetsAnimationController.

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`	This value cannot be `null`.

See also:

getUpperBound

Added in API level 30

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 WindowInsets#getInsets(int) for the fully shown state. This is the same as WindowInsetsAnimationController#getHiddenStateInsets and WindowInsetsAnimationController#getShownStateInsets in case the listener gets invoked because of an animation that originates from WindowInsetsAnimationController.

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`	This value cannot be `null`.

See also:

inset

Added in API level 30

public WindowInsetsAnimation.Bounds inset (Insets insets)

Insets both the lower and upper bound by the specified insets. This is to be used in Callback#onStart 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. This value cannot be `null`.

Returns
`WindowInsetsAnimation.Bounds`	A copy of this instance inset in the given directions. This value cannot be `null`.

See also:

toString

Added in API level 30

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.