Parallax.IntProperty

Added in 1.1.0

Kotlin |Java

class Parallax.IntProperty : Property

kotlin.Any
↳	android.util.Property
	↳	androidx.leanback.widget.Parallax.IntProperty

Known direct subclasses

RecyclerViewParallax.ChildPositionProperty

RecyclerViewParallax.ChildPositionProperty

Subclass of Parallax.IntProperty.

IntProperty provide access to an index based integer type property inside Parallax. The IntProperty typically represents UI element position inside Parallax.

Summary

Constants
`const Int`	`UNKNOWN_AFTER = 2147483647` Property value is unknown and it's larger than `getMaxValue`.
`const Int`	`UNKNOWN_BEFORE = -2147483648` Property value is unknown and it's smaller than minimal value of Parallax.

Public constructors
`IntProperty(name: String!, index: Int)` Constructor.

Public functions
`Parallax.PropertyMarkerValue!`	`at(offsetValue: Int, fractionOfMaxParentVisibleSize: Float)` Create an `PropertyMarkerValue` object by multiplying the fraction with `getMaxValue` and adding offsetValue to it.
`Parallax.PropertyMarkerValue!`	`atAbsolute(absoluteValue: Int)` Creates an `PropertyMarkerValue` object for the absolute marker value.
`Parallax.PropertyMarkerValue!`	`atFraction(fractionOfMaxValue: Float)` Creates an `PropertyMarkerValue` object for a fraction of `getMaxValue`.
`Parallax.PropertyMarkerValue!`	`atMax()` Creates an `PropertyMarkerValue` object for the marker value representing `getMaxValue`.
`Parallax.PropertyMarkerValue!`	`atMin()` Creates an `PropertyMarkerValue` object for the marker value representing 0.
`Int!`	`get(object: Parallax!)`
`Int`	`getIndex()`
`Int`	`getValue(object: Parallax!)` Fast version of get() method that returns a primitive int value of the Property.
`Unit`	`set(object: Parallax!, value: Int!)`
`Unit`	`setValue(object: Parallax!, value: Int)` Fast version of set() method that takes a primitive int value into the Property.

Inherited functions

From android.util.Property

`String!`	`getName()`
`Class<V!>!`	`getType()`
`Boolean`	`isReadOnly()`
`java-static Property<T!, V!>!`	`<T, V> of(hostType: Class<T!>!, valueType: Class<V!>!, name: String!)`

Constants

UNKNOWN_AFTER

Added in 1.1.0

const val UNKNOWN_AFTER = 2147483647: Int

Property value is unknown and it's larger than getMaxValue. For example if a child is not created and after the last visible child of RecyclerView.

UNKNOWN_BEFORE

Added in 1.1.0

const val UNKNOWN_BEFORE = -2147483648: Int

Property value is unknown and it's smaller than minimal value of Parallax. For example if a child is not created and before the first visible child of RecyclerView.

Public constructors

IntProperty

Added in 1.1.0

IntProperty(name: String!, index: Int)

Constructor.

Parameters
`name: String!`	Name of this Property.
`index: Int`	Index of this Property inside `Parallax`.

Public functions

at

Added in 1.1.0

fun at(offsetValue: Int, fractionOfMaxParentVisibleSize: Float): Parallax.PropertyMarkerValue!

Create an PropertyMarkerValue object by multiplying the fraction with getMaxValue and adding offsetValue to it.

Parameters
`offsetValue: Int`	An offset integer value to be added to marker value.
`fractionOfMaxParentVisibleSize: Float`	0 to 1 fraction to multiply with `getMaxValue` for the marker value.

Returns
`Parallax.PropertyMarkerValue!`	A new `PropertyMarkerValue` object.

atAbsolute

Added in 1.1.0

fun atAbsolute(absoluteValue: Int): Parallax.PropertyMarkerValue!

Creates an PropertyMarkerValue object for the absolute marker value.

Parameters
`absoluteValue: Int`	The integer marker value.

Returns
`Parallax.PropertyMarkerValue!`	A new `PropertyMarkerValue` object.

atFraction

Added in 1.1.0

fun atFraction(fractionOfMaxValue: Float): Parallax.PropertyMarkerValue!

Creates an PropertyMarkerValue object for a fraction of getMaxValue.

Parameters
`fractionOfMaxValue: Float`	0 to 1 fraction to multiply with `getMaxValue` for the marker value.

Returns
`Parallax.PropertyMarkerValue!`	A new `PropertyMarkerValue` object.

atMax

Added in 1.1.0

fun atMax(): Parallax.PropertyMarkerValue!

Creates an PropertyMarkerValue object for the marker value representing getMaxValue.

Returns
`Parallax.PropertyMarkerValue!`	A new `PropertyMarkerValue` object.

atMin

Added in 1.1.0

fun atMin(): Parallax.PropertyMarkerValue!

Creates an PropertyMarkerValue object for the marker value representing 0.

Returns
`Parallax.PropertyMarkerValue!`	A new `PropertyMarkerValue` object.

Added in 1.1.0

fun get(object: Parallax!): Int!

getIndex

Added in 1.1.0

fun getIndex(): Int

Returns
`Int`	Index of this Property in `Parallax`.

Added in 1.1.0

fun getValue(object: Parallax!): Int

Fast version of get() method that returns a primitive int value of the Property.

Parameters
`object: Parallax!`	The Parallax object that owns this Property.

Returns
`Int`	Int value of the Property.

Added in 1.1.0

fun set(object: Parallax!, value: Int!): Unit

Added in 1.1.0

fun setValue(object: Parallax!, value: Int): Unit

Fast version of set() method that takes a primitive int value into the Property.

Parameters
`object: Parallax!`	The Parallax object that owns this Property.
`value: Int`	Int value of the Property.