com.stephentuso.welcome

Class ParallaxPage

java.lang.Object

com.stephentuso.welcome.WelcomePage<ParallaxPage>

com.stephentuso.welcome.ParallaxPage

public class ParallaxPage
extends WelcomePage<ParallaxPage>

A page with a title and description 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
ParallaxPage(int layoutResId, java.lang.String title, java.lang.String description) A page with a title and description that applies a parallax effect to the supplied layout.

Method Summary

Modifier and Type	Method and Description
ParallaxPage	descriptionColor(int color) Set the color of the header
ParallaxPage	descriptionColorResource(android.content.Context context, int colorRes) Set the color of the description from a color resource id
ParallaxPage	descriptionTypefacePath(java.lang.String path) Set the typeface of the description
ParallaxPage	firstParallaxFactor(float factor) The factor that the first item in the layout should move, relative to the movement of the page.
Fragment	fragment()
ParallaxPage	headerColor(int color) Set the color of the header
ParallaxPage	headerColorResource(android.content.Context context, int colorRes) Set the color of the header from a color resource id
ParallaxPage	headerTypeface(java.lang.String path) Set the typeface of the header
ParallaxPage	lastParallaxFactor(float factor) The factor that the last item in the layout should move, relative to the movement of the page.
ParallaxPage	recursive(boolean recursive) Whether or not the parallax effect should be recursive.
void	setup(WelcomeConfiguration config)

Methods inherited from class com.stephentuso.welcome.WelcomePage

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ParallaxPage

public ParallaxPage(@LayoutRes
                    int layoutResId,
                    java.lang.String title,
                    java.lang.String description)

A page with a title and description 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.

Parameters:

layoutResId - The layout to show/apply parallax effect to

title - A title, shown in large font

description - String shown below title

Method Detail

firstParallaxFactor

public ParallaxPage 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 ParallaxPage object to allow method calls to be chained

lastParallaxFactor

public ParallaxPage 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 last item in the layout

Returns:

This ParallaxPage object to allow method calls to be chained

recursive

public ParallaxPage 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 ParallaxPage object to allow method calls to be chained

headerTypeface

public ParallaxPage headerTypeface(java.lang.String path)

Set the typeface of the header

Parameters:

path - The path to a typeface in the assets folder

Returns:

This ParallaxPage object to allow method calls to be chained

descriptionTypefacePath

public ParallaxPage descriptionTypefacePath(java.lang.String path)

Set the typeface of the description

Parameters:

path - The path to a typeface in the assets folder

Returns:

This ParallaxPage object to allow method calls to be chained

headerColor

public ParallaxPage headerColor(int color)

Set the color of the header

Parameters:

color - Color int

Returns:

This ParallaxPage object to allow method calls to be chained

headerColorResource

public ParallaxPage headerColorResource(android.content.Context context,
                                        @ColorRes
                                        int colorRes)

Set the color of the header from a color resource id

Parameters:

context - Context used to resolve color

colorRes - Resource id of color to set

Returns:

This ParallaxPage object to allow method calls to be chained

descriptionColor

public ParallaxPage descriptionColor(int color)

Set the color of the header

Parameters:

color - Color int

Returns:

This ParallaxPage object to allow method calls to be chained

descriptionColorResource

public ParallaxPage descriptionColorResource(android.content.Context context,
                                             @ColorRes
                                             int colorRes)

Set the color of the description from a color resource id

Parameters:

context - Context used to resolve color

colorRes - Resource id of color to set

Returns:

This ParallaxPage object to allow method calls to be chained

setup

public void setup(WelcomeConfiguration config)

Overrides:

setup in class WelcomePage<ParallaxPage>

fragment

public Fragment fragment()

Specified by:

fragment in class WelcomePage<ParallaxPage>