com.stephentuso.welcome

Class FullscreenParallaxPage

java.lang.Object

com.stephentuso.welcome.WelcomePage<FullscreenParallaxPage>

com.stephentuso.welcome.FullscreenParallaxPage

public class FullscreenParallaxPage
extends WelcomePage<FullscreenParallaxPage>

A page that applies a parallax effect to the supplied layout. The speed at which the children are moved is determined by their location in the layout, the first will move the slowest and the last will move the fastest, or the opposite, if the parallax factors are reversed. See documentation for the parallax factor methods for more details. Created by stephentuso on 10/12/16.

Nested Class Summary

Nested classes/interfaces inherited from class com.stephentuso.welcome.WelcomePage

WelcomePage.OnChangeListener

Field Summary

Fields inherited from class com.stephentuso.welcome.WelcomePage

index, isRtl, totalPages

Constructor Summary

Constructors

Constructor and Description
FullscreenParallaxPage(int layoutResId) A page that applies a parallax effect to the supplied layout.

Method Summary

Modifier and Type	Method and Description
FullscreenParallaxPage	firstParallaxFactor(float factor) The factor that the first item in the layout should move, relative to the movement of the page.
Fragment	fragment()
FullscreenParallaxPage	lastParallaxFactor(float factor) The factor that the last item in the layout should move, relative to the movement of the page.
FullscreenParallaxPage	recursive(boolean recursive) Whether or not the parallax effect should be recursive.

Methods inherited from class com.stephentuso.welcome.WelcomePage

background, background, createFragment, getFragment, onPageScrolled, onPageScrollStateChanged, onPageSelected, setup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FullscreenParallaxPage

public FullscreenParallaxPage(@LayoutRes
                              int layoutResId)

A page that applies a parallax effect to the supplied layout. The speed at which the children are moved is determined by their location in the layout.

Parameters:

layoutResId - The layout to show

Method Detail

firstParallaxFactor

public FullscreenParallaxPage firstParallaxFactor(float factor)

The factor that the first item in the layout should move, relative to the movement of the page. The factors for items between the first and last will be evenly distributed between the first and last parallax factors. If a = page offset; x = parallax factor item offset = a + ax Meaning the following values will have these results: -1: Completely stationary 0: Same speed as page 1: Twice as fast as page Default: 0.2

Parameters:

factor - The parallax factor for the first item in the layout

Returns:

This FullscreenParallaxPage object to allow method calls to be chained

lastParallaxFactor

public FullscreenParallaxPage lastParallaxFactor(float factor)

The factor that the last item in the layout should move, relative to the movement of the page. The factors for items between the first and last will be evenly distributed between the first and last parallax factors. If a = page offset; x = parallax factor item offset = a + ax Meaning the following values will have these results: -1: Completely stationary 0: Same speed as page 1: Twice as fast as page Default: 1

Parameters:

factor - The parallax factor for the first item in the layout

Returns:

This FullscreenParallaxPage object to allow method calls to be chained

recursive

public FullscreenParallaxPage recursive(boolean recursive)

Whether or not the parallax effect should be recursive. If false, ViewGroups will be treated as a single item, and their children will move at the same speed. If true, the parallax effect will be applied to ViewGroup children individually.

Parameters:

recursive - Whether or not the effect should be recursive (travel through ViewGroups)

Returns:

This FullscreenParallaxPage object to allow method calls to be chained

fragment

public Fragment fragment()

Specified by:

fragment in class WelcomePage<FullscreenParallaxPage>