GradientProtection

Added in 1.16.0

Kotlin |Java

class GradientProtection : Protection

kotlin.Any
↳	androidx.core.view.insets.Protection
	↳	androidx.core.view.insets.GradientProtection

A type of protection which draws the gradient color.

Summary

Public constructors
`GradientProtection(side: Int)` Creates an instance associated with a `WindowInsetsCompat.Side`.
`GradientProtection(side: Int, color: @ColorInt Int)` Creates an instance associated with a `WindowInsetsCompat.Side`.

Public functions
`@ColorInt Int`	`getColor()` Gets the color associated with this protection.
`Float`	`getScale()` Gets the scale of the thickness of the protection.
`Unit`	`setColor(color: @ColorInt Int)` Sets the color to the protection.
`Unit`	`setScale(scale: Float)` Sets the scale of the thickness to the protection.

`Unit`	`animateAlpha(toAlpha: Float)` Animates the alpha from the current value to the specified one.
`Unit`	`animateInsetsAmount(toInsetsAmount: Float)` Animates the insets amount from the current value to the specified one.
`@FloatRange(from = 0.0, to = 1.0) Float`	`getAlpha()` Gets the opacity of the protection.
`Float`	`getInsetAmount()` Gets the depth of the protection.
`Int`	`getSide()` Gets the side of this protection.
`Unit`	`setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) Float)` Sets the opacity of the protection to a value from 0 to 1, where 0 means the protection is completely transparent and 1 means the protection is completely opaque.
`Unit`	`setInsetAmount(insetAmount: @FloatRange(from = 0.0, to = 1.0) Float)` Sets the depth of the protection to a value from 0 to 1, where 0 means the protection is completely outside the window and 1 means the protection is completely inside the window.

Added in 1.16.0

GradientProtection(side: Int)

Creates an instance associated with a WindowInsetsCompat.Side.

Parameters
`side: Int`	the given `WindowInsetsCompat.Side`.

Added in 1.16.0

GradientProtection(side: Int, color: @ColorInt Int)

Creates an instance associated with a WindowInsetsCompat.Side.

Parameters
`side: Int`	the given `WindowInsetsCompat.Side`.
`color: @ColorInt Int`	The color to draw.

Added in 1.16.0

fun getColor(): @ColorInt Int

Gets the color associated with this protection.

Returns
`@ColorInt Int`	The color associated with this protection.

Added in 1.16.0

fun getScale(): Float

Gets the scale of the thickness of the protection.

Returns
`Float`	The scale of the thickness.

Added in 1.16.0

fun setColor(color: @ColorInt Int): Unit

Sets the color to the protection. The pixels farther away from the edge get more transparent.

Parameters
`color: @ColorInt Int`	The color to draw.

Added in 1.16.0

fun setScale(scale: Float): Unit

Sets the scale of the thickness to the protection.

Parameters
`scale: Float`	The scale of the thickness.