/

• English
• Deutsch
• Español – América Latina
• Français
• Indonesia
• Polski
• Português – Brasil
• Tiếng Việt
• 中文 – 简体
• 日本語
• 한국어

Android Studio Sign in

• API reference

Parallax

public abstract class Parallax
extends Object

Known Direct Subclasses RecyclerViewParallax RecyclerViewParallax Implementation of Parallax class for RecyclerView.

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

Parallax tracks a list of dynamic Propertys typically representing foreground UI element positions on screen. Parallax keeps a list of ParallaxEffect objects which define rules to mapping property values to ParallaxTarget.

To create a ParallaxEffect, user calls addEffect(PropertyMarkerValue[]) with a list of Parallax.PropertyMarkerValue which defines the range of Parallax.IntProperty or Parallax.FloatProperty. Then user adds ParallaxTarget into ParallaxEffect.

App may subclass Parallax.IntProperty or Parallax.FloatProperty to supply additional information about how to retrieve Property value. RecyclerViewParallax is a great example of Parallax implementation tracking child view positions on screen.

Restrictions of properties
• FloatProperty and IntProperty cannot be mixed in one Parallax
• Values must be in ascending order.
• If the UI element is unknown above screen, use UNKNOWN_BEFORE.
• if the UI element is unknown below screen, use UNKNOWN_AFTER.
• UNKNOWN_BEFORE and UNKNOWN_AFTER are not allowed to be next to each other.

Subclass must override updateValues() to update property values and perform ParallaxEffects. Subclass may call updateValues() automatically e.g. RecyclerViewParallax calls updateValues() in RecyclerView scrolling. App might call updateValues() manually when Parallax is unaware of the value change. For example, when a slide transition is running, RecyclerViewParallax is unaware of translation value changes; it's the app's responsibility to call updateValues() in every frame of animation.

Summary

Nested classes

FloatProperty provide access to an index based integer type property inside Parallax. 

IntProperty provide access to an index based integer type property inside Parallax. 

Class holding a fixed value for a Property in Parallax. 

Inherited methods
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

Parallax ()

Public methods

ParallaxEffect addEffect (PropertyMarkerValue... ranges)

PropertyT addProperty (String name)

PropertyT createProperty (String name, 
                int index)

List<ParallaxEffect> getEffects ()

float getMaxValue ()

List<PropertyT> getProperties ()

void removeAllEffects ()

void removeEffect (ParallaxEffect effect)

void updateValues ()