ShadowOverlayHelper.Options

Artifact: androidx.leanback:leanback

View Source

Added in 1.1.0

---

Kotlin |Java

public final class ShadowOverlayHelper.Options

---

Option values for ShadowOverlayContainer.

Summary

Constants
static final ShadowOverlayHelper.Options	DEFAULT Default Options for values.

Public fields
float	dynamicShadowFocusedZ
float	dynamicShadowUnfocusedZ
int	roundedCornerRadius

Public constructors
Options()

Public methods
ShadowOverlayHelper.Options	dynamicShadowZ(float unfocusedZ, float focusedZ) Set value of focused and unfocused Z value for shadow.
final float	getDynamicShadowFocusedZ() Get z value of shadow when a view is focused.
final float	getDynamicShadowUnfocusedZ() Get z value of shadow when a view is not focused.
final int	getRoundedCornerRadius() Get radius of rounded corner in pixels.
ShadowOverlayHelper.Options	roundedCornerRadius(int roundedCornerRadius) Set value of rounded corner radius.

Constants

DEFAULT

Added in 1.1.0

public static final ShadowOverlayHelper.Options DEFAULT

Default Options for values.

Public fields

dynamicShadowFocusedZ

Added in 1.1.0

public float dynamicShadowFocusedZ

dynamicShadowUnfocusedZ

Added in 1.1.0

public float dynamicShadowUnfocusedZ

roundedCornerRadius

Added in 1.1.0

public int roundedCornerRadius

Public constructors

Options

Added in 1.1.0

public Options()

Public methods

dynamicShadowZ

Added in 1.1.0

public ShadowOverlayHelper.Options dynamicShadowZ(float unfocusedZ, float focusedZ)

Set value of focused and unfocused Z value for shadow.

Parameters
float unfocusedZ	Number of pixels for unfocused Z value.
float focusedZ	Number of pixels for focused Z value.

Returns
ShadowOverlayHelper.Options	The Options object itself.

getDynamicShadowFocusedZ

Added in 1.1.0

public final float getDynamicShadowFocusedZ()

Get z value of shadow when a view is focused.

Returns
float	Z value of shadow when a view is focused.

getDynamicShadowUnfocusedZ

Added in 1.1.0

public final float getDynamicShadowUnfocusedZ()

Get z value of shadow when a view is not focused.

Returns
float	Z value of shadow when a view is not focused.

getRoundedCornerRadius

Added in 1.1.0

public final int getRoundedCornerRadius()

Get radius of rounded corner in pixels.

Returns
int	Radius of rounded corner in pixels.

roundedCornerRadius

Added in 1.1.0

public ShadowOverlayHelper.Options roundedCornerRadius(int roundedCornerRadius)

Set value of rounded corner radius.

Parameters
int roundedCornerRadius	Number of pixels of rounded corner radius. Set to 0 to use default settings.

Returns
ShadowOverlayHelper.Options	The Options object itself.