ListItemScale

Artifact: androidx.tv:tv-material

View Source

Added in 1.0.0

class ListItemScale

---

Represents the scale Float of ListItem for different interaction states. Note: This scale must always be a non-negative float.

Summary

Public companion properties
ListItemScale	None Signifies the absence of a ScaleIndication in ListItem component.

Public constructors

ListItemScale(     scale: @FloatRange(from = 0.0) Float,     focusedScale: @FloatRange(from = 0.0) Float,     pressedScale: @FloatRange(from = 0.0) Float,     selectedScale: @FloatRange(from = 0.0) Float,     disabledScale: @FloatRange(from = 0.0) Float,     focusedSelectedScale: @FloatRange(from = 0.0) Float,     focusedDisabledScale: @FloatRange(from = 0.0) Float,     pressedSelectedScale: @FloatRange(from = 0.0) Float ) create an instance with arbitrary scale factors.

Public functions
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties
@FloatRange(from = 0.0) Float	disabledScale the scale used when the ListItem is not enabled.
@FloatRange(from = 0.0) Float	focusedDisabledScale the scale used when the ListItem is not enabled and focused.
@FloatRange(from = 0.0) Float	focusedScale the scale used when the ListItem is enabled and focused.
@FloatRange(from = 0.0) Float	focusedSelectedScale the scale used when the ListItem is enabled, focused and selected.
@FloatRange(from = 0.0) Float	pressedScale the scale used when the ListItem is enabled and pressed.
@FloatRange(from = 0.0) Float	pressedSelectedScale the scale used when the ListItem is enabled, pressed and selected.
@FloatRange(from = 0.0) Float	scale the scale used when the ListItem is enabled.
@FloatRange(from = 0.0) Float	selectedScale the scale used when the ListItem is enabled and selected.

Public companion properties

None

Added in 1.0.0

val None: ListItemScale

Signifies the absence of a ScaleIndication in ListItem component.

Public constructors

ListItemScale

Added in 1.0.0

ListItemScale(
    scale: @FloatRange(from = 0.0) Float,
    focusedScale: @FloatRange(from = 0.0) Float,
    pressedScale: @FloatRange(from = 0.0) Float,
    selectedScale: @FloatRange(from = 0.0) Float,
    disabledScale: @FloatRange(from = 0.0) Float,
    focusedSelectedScale: @FloatRange(from = 0.0) Float,
    focusedDisabledScale: @FloatRange(from = 0.0) Float,
    pressedSelectedScale: @FloatRange(from = 0.0) Float
)

create an instance with arbitrary scale factors. See ListItemDefaults.scale for the default scale factors used in a ListItem.

Parameters
scale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is enabled.
focusedScale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is enabled and focused.
pressedScale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is enabled and pressed.
selectedScale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is enabled and selected.
disabledScale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is not enabled.
focusedSelectedScale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is enabled, focused and selected.
focusedDisabledScale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is not enabled and focused.
pressedSelectedScale: @FloatRange(from = 0.0) Float	the scale used when the ListItem is enabled, pressed and selected.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

disabledScale

Added in 1.0.0

val disabledScale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is not enabled.

focusedDisabledScale

Added in 1.0.0

val focusedDisabledScale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is not enabled and focused.

focusedScale

Added in 1.0.0

val focusedScale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is enabled and focused.

focusedSelectedScale

Added in 1.0.0

val focusedSelectedScale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is enabled, focused and selected.

pressedScale

Added in 1.0.0

val pressedScale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is enabled and pressed.

pressedSelectedScale

Added in 1.0.0

val pressedSelectedScale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is enabled, pressed and selected.

scale

Added in 1.0.0

val scale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is enabled.

selectedScale

Added in 1.0.0

val selectedScale: @FloatRange(from = 0.0) Float

the scale used when the ListItem is enabled and selected.