DetailsParallax

Kotlin |Java

open class DetailsParallax : RecyclerViewParallax

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

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

It can be used for both creating cover image parallax effect and controlling video playing when transitioning to/from half/full screen. A direct use case is androidx.leanback.app.DetailsFragmentBackgroundController.

Summary

Public constructors
`<init>()`

Public methods
open Parallax.IntProperty!	`getOverviewRowBottom()` Returns the bottom of the details overview row.
open Parallax.IntProperty!	`getOverviewRowTop()` Returns the top of the details overview row.

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.

From class RecyclerViewParallax

`RecyclerViewParallax.ChildPositionProperty!`	`createProperty(name: String!, index: Int)`
`Float`	`getMaxValue()`
`RecyclerView!`	`getRecyclerView()`
`Unit`	`setRecyclerView(recyclerView: RecyclerView!)` Set RecyclerView that this Parallax will register onScrollListener.
`Unit`	`updateValues()` 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.

DetailsParallax()

open fun getOverviewRowBottom(): Parallax.IntProperty!

Returns the bottom of the details overview row. This is tracked for implementing the parallax effect.

open fun getOverviewRowTop(): Parallax.IntProperty!

Returns the top of the details overview row. This is tracked for implementing the parallax effect.