com.stephentuso.welcome

Class BasicPage

java.lang.Object

com.stephentuso.welcome.WelcomePage<BasicPage>

com.stephentuso.welcome.BasicPage

public class BasicPage
extends WelcomePage<BasicPage>

A page with a large image, header, and description Created by stephentuso on 10/11/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
BasicPage(int drawableResId, java.lang.String title, java.lang.String description) A page with a large image, header, and description

Method Summary

Modifier and Type	Method and Description
BasicPage	descriptionColor(int color) Set the color of the header
BasicPage	descriptionColorResource(android.content.Context context, int colorRes) Set the color of the description from a color resource id
BasicPage	descriptionTypeface(java.lang.String typefacePath) Set the typeface of the description
Fragment	fragment()
BasicPage	headerColor(int color) Set the color of the header
BasicPage	headerColorResource(android.content.Context context, int colorRes) Set the color of the header from a color resource id
BasicPage	headerTypeface(java.lang.String typefacePath) Set the typeface of the header
BasicPage	parallax(boolean showParallax) Whether or not a parallax effect should be shown.
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

BasicPage

public BasicPage(@DrawableRes
                 int drawableResId,
                 java.lang.String title,
                 java.lang.String description)

A page with a large image, header, and description

Parameters:

drawableResId - Resource id of drawable to show

title - Title, shown in large font

description - Description, shown beneath title

Method Detail

parallax

public BasicPage parallax(boolean showParallax)

Whether or not a parallax effect should be shown. If true, the image will move at a faster rate than the text Default: true

Parameters:

showParallax - If parallax effect should be shown

Returns:

This BasicPage object to allow method calls to be chained

headerTypeface

public BasicPage headerTypeface(java.lang.String typefacePath)

Set the typeface of the header

Parameters:

typefacePath - The path to a typeface in the assets folder

Returns:

This BasicPage object to allow method calls to be chained

descriptionTypeface

public BasicPage descriptionTypeface(java.lang.String typefacePath)

Set the typeface of the description

Parameters:

typefacePath - The path to a typeface in the assets folder

Returns:

This BasicPage object to allow method calls to be chained

headerColor

public BasicPage headerColor(int color)

Set the color of the header

Parameters:

color - Color int

Returns:

This BasicPage object to allow method calls to be chained

headerColorResource

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

descriptionColor

public BasicPage descriptionColor(int color)

Set the color of the header

Parameters:

color - Color int

Returns:

This BasicPage object to allow method calls to be chained

descriptionColorResource

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

setup

public void setup(WelcomeConfiguration config)

Overrides:

setup in class WelcomePage<BasicPage>

fragment

public Fragment fragment()

Specified by:

fragment in class WelcomePage<BasicPage>