Options

Kotlin |Java

class Options

kotlin.Any
↳	androidx.leanback.widget.ShadowOverlayHelper.Options

Option values for ShadowOverlayContainer.

Summary

Public constructors
`<init>()` Option values for ShadowOverlayContainer.

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

Properties
static ShadowOverlayHelper.Options!	`DEFAULT` Default Options for values.

Options()

Option values for ShadowOverlayContainer.

fun dynamicShadowZ(
    unfocusedZ: Float, 
    focusedZ: Float
): ShadowOverlayHelper.Options!

Set value of focused and unfocused Z value for shadow.

Parameters
`unfocusedZ`	Float: Number of pixels for unfocused Z value.
`focusedZ`	Float: Number of pixels for focused Z value.

Return
`ShadowOverlayHelper.Options!`	The Options object itself.

fun getDynamicShadowFocusedZ(): Float

Get z value of shadow when a view is focused.

Return
`Float`	Z value of shadow when a view is focused.

fun getDynamicShadowUnfocusedZ(): Float

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

Return
`Float`	Z value of shadow when a view is not focused.

fun getRoundedCornerRadius(): Int

Get radius of rounded corner in pixels.

Return
`Int`	Radius of rounded corner in pixels.

fun roundedCornerRadius(roundedCornerRadius: Int): ShadowOverlayHelper.Options!

Set value of rounded corner radius.

Parameters
`roundedCornerRadius`	Int: Number of pixels of rounded corner radius. Set to 0 to use default settings.

Return
`ShadowOverlayHelper.Options!`	The Options object itself.

static val DEFAULT: ShadowOverlayHelper.Options!

Default Options for values.