RecyclerViewParallax

Kotlin |Java

open class RecyclerViewParallax : Parallax<RecyclerViewParallax.ChildPositionProperty!>

kotlin.Any
↳	androidx.leanback.widget.Parallax<androidx.leanback.widget.RecyclerViewParallax.ChildPositionProperty>
	↳	androidx.leanback.widget.RecyclerViewParallax

Known Direct Subclasses

DetailsParallax

Subclass of Parallax object that tracks overview row's top and bottom edge in DetailsFragment or DetailsSupportFragment.

Implementation of Parallax class for RecyclerView. This class allows users to track position of specific views inside RecyclerView relative to itself. See ChildPositionProperty for details.

Summary

Nested classes
	`ChildPositionProperty` Subclass of `Parallax.IntProperty`.

Public constructors
`<init>()` Implementation of `Parallax` class for `RecyclerView`.

Public methods
open RecyclerViewParallax.ChildPositionProperty!	`createProperty(name: String!, index: Int)`
open Float	`getMaxValue()`
open RecyclerView!	`getRecyclerView()`
open Unit	`setRecyclerView(recyclerView: RecyclerView!)` Set RecyclerView that this Parallax will register onScrollListener.
open Unit	`updateValues()` Manually update values.

Inherited functions

From class Parallax

`ParallaxEffect!`	`addEffect(vararg ranges: Parallax.PropertyMarkerValue<Any!>!)` Create a `ParallaxEffect` object that will track source variable changes within a provided set of ranges.
`PropertyT`	`addProperty(name: String!)` Add a new IntProperty in the Parallax object. App may override `createProperty(String, int)`.
`MutableList<ParallaxEffect!>!`	`getEffects()` Returns a list of `ParallaxEffect` object which defines rules to perform mapping to multiple `ParallaxTarget`s.
`MutableList<PropertyT>!`	`getProperties()`
`Unit`	`removeAllEffects()` Remove all `ParallaxEffect` objects.
`Unit`	`removeEffect(effect: ParallaxEffect!)` Remove the `ParallaxEffect` object.

Public constructors

<init>

RecyclerViewParallax()

Implementation of Parallax class for RecyclerView. This class allows users to track position of specific views inside RecyclerView relative to itself. See ChildPositionProperty for details.

Public methods

createProperty

open fun createProperty(
    name: String!, 
    index: Int
): RecyclerViewParallax.ChildPositionProperty!

getMaxValue

open fun getMaxValue(): Float

getRecyclerView

open fun getRecyclerView(): RecyclerView!

Return
`RecyclerView!`	Currently RecylerView that the source has registered onScrollListener.

setRecyclerView

open fun setRecyclerView(recyclerView: RecyclerView!): Unit

Set RecyclerView that this Parallax will register onScrollListener.

Parameters
`recyclerView`	RecyclerView!: RecyclerView to register onScrollListener.

updateValues

open fun updateValues(): Unit

Manually update values. This is used for changes not controlled by RecyclerView. E.g. called by a Slide transition that changes translation of the view.