ChildPositionProperty

Kotlin |Java

class ChildPositionProperty : Parallax.IntProperty

kotlin.Any
↳	android.util.Property<androidx.leanback.widget.Parallax<android.util.Property<, >>, kotlin.Int>
	↳	androidx.leanback.widget.Parallax.IntProperty
		↳	androidx.leanback.widget.RecyclerViewParallax.ChildPositionProperty

Subclass of Parallax.IntProperty. Using this Property, users can track a RecylerView child's position inside recyclerview. i.e. tracking_pos = view.top + fraction * view.height() + offset This way we can track top using fraction 0 and bottom using fraction 1.

Summary

Inherited constants

From class IntProperty

Int

UNKNOWN_AFTER

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

Int

UNKNOWN_BEFORE

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 methods
RecyclerViewParallax.ChildPositionProperty!	`adapterPosition(adapterPosition: Int)` Sets adapter position of the recyclerview child to track.
RecyclerViewParallax.ChildPositionProperty!	`fraction(fraction: Float)` Sets fraction of size to be added to view's start position.
Int	`getAdapterPosition()` Returns adapter position of the recyclerview child to track.
Float	`getFraction()` Returns fraction of size to be added to view's start position.
Int	`getOffset()` Returns offset in pixels added to the view's start position.
Int	`getViewId()` Returns view Id of a descendant of recyclerview child to track.
RecyclerViewParallax.ChildPositionProperty!	`offset(offset: Int)` Sets offset in pixels added to the view's start position.
RecyclerViewParallax.ChildPositionProperty!	`viewId(viewId: Int)` Sets view Id of a descendant of recyclerview child to track.

Inherited functions

From class IntProperty

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

Public methods

adapterPosition

fun adapterPosition(adapterPosition: Int): RecyclerViewParallax.ChildPositionProperty!

Sets adapter position of the recyclerview child to track.

Parameters
`adapterPosition`	Int: Zero based position in adapter.

Return
RecyclerViewParallax.ChildPositionProperty!: This ChildPositionProperty object.

fraction

fun fraction(fraction: Float): RecyclerViewParallax.ChildPositionProperty!

Sets fraction of size to be added to view's start position. e.g. to track the center position of the view, use fraction 0.5; to track the end position of the view use fraction 1.

Parameters
`fraction`	Float: Fraction of size of the view.

Return
RecyclerViewParallax.ChildPositionProperty!: This ChildPositionProperty object.

getAdapterPosition

fun getAdapterPosition(): Int

Returns adapter position of the recyclerview child to track.

getFraction

fun getFraction(): Float

Returns fraction of size to be added to view's start position. e.g. to track the center position of the view, use fraction 0.5; to track the end position of the view use fraction 1.

getOffset

fun getOffset(): Int

Returns offset in pixels added to the view's start position.

getViewId

fun getViewId(): Int

Returns view Id of a descendant of recyclerview child to track.

offset

fun offset(offset: Int): RecyclerViewParallax.ChildPositionProperty!

Sets offset in pixels added to the view's start position.

Parameters
`offset`	Int: Offset in pixels added to the view's start position.

Return
RecyclerViewParallax.ChildPositionProperty!: This ChildPositionProperty object.

viewId

fun viewId(viewId: Int): RecyclerViewParallax.ChildPositionProperty!

Sets view Id of a descendant of recyclerview child to track.

Parameters
`viewId`	Int: Id of a descendant of recyclerview child.

Return
RecyclerViewParallax.ChildPositionProperty!: This ChildPositionProperty object.