Summary: Ctors | Methods | Inherited Methods

DetailsParallax

Kotlin |Java

public class DetailsParallax
extends RecyclerViewParallax

java.lang.Object
↳	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 DetailsFragmentBackgroundController.

See also:

Summary

Public constructors
`DetailsParallax()`

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

Inherited methods

From class


        
          androidx.leanback.widget.RecyclerViewParallax

`RecyclerViewParallax.ChildPositionProperty`	`createProperty(String name, int index)` Create a new Property object.
`float`	`getMaxValue()` Return the max value which is typically size of parent visible area, e.g.
`RecyclerView`	`getRecyclerView()`
`void`	`setRecyclerView(RecyclerView recyclerView)` Set RecyclerView that this Parallax will register onScrollListener.
`void`	`updateValues()` Manually update values.

From class


        
          androidx.leanback.widget.Parallax

`ParallaxEffect`	`addEffect(PropertyMarkerValue... ranges)` Create a `ParallaxEffect` object that will track source variable changes within a provided set of ranges.
`final PropertyT`	`addProperty(String name)` Add a new IntProperty in the Parallax object.
`abstract PropertyT`	`createProperty(String name, int index)` Create a new Property object.
`List<ParallaxEffect>`	`getEffects()` Returns a list of `ParallaxEffect` object which defines rules to perform mapping to multiple `ParallaxTarget`s.
`abstract float`	`getMaxValue()` Return the max value which is typically size of parent visible area, e.g.
`final List<PropertyT>`	`getProperties()`
`void`	`removeAllEffects()` Remove all `ParallaxEffect` objects.
`void`	`removeEffect(ParallaxEffect effect)` Remove the `ParallaxEffect` object.
`void`	`updateValues()` Update property values and perform `ParallaxEffect`s.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

DetailsParallax

public DetailsParallax ()

Public methods

getOverviewRowBottom

public Parallax.IntProperty getOverviewRowBottom ()

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

Returns
`Parallax.IntProperty`

getOverviewRowTop

public Parallax.IntProperty getOverviewRowTop ()

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

Returns
`Parallax.IntProperty`