com.matthewtamlin.sliding_intro_screen_library

Class ParallaxPage

java.lang.Object

Fragment

com.matthewtamlin.sliding_intro_screen_library.Page

com.matthewtamlin.sliding_intro_screen_library.ParallaxPage

public class ParallaxPage
extends Page

An Page with three elements: a front image, a back image and text. The front and back images are centred at the top the Page, such that the front image is drawn on top of the back image. The text is drawn over both images. This class can be used in an IntroActivity with a ParallaxTransformer to create a parallax scrolling effect, where the images transition at different speeds. To allow the use of custom transformers, the resource ids of the views can be accessed using the getFrontImageHolderResId(), getBackImageHolderResId() and getTextHolderResId() methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected android.graphics.Bitmap	backImage The current back image.
protected android.widget.ImageView	backImageHolder The View which displays the back image.
protected android.graphics.Bitmap	frontImage The current front image.
protected android.widget.ImageView	frontImageHolder The View which displays the front image.
protected android.widget.FrameLayout	rootView The root view of this Fragment.
protected java.lang.CharSequence	text The current text.
protected android.widget.TextView	textHolder The View which displays the text.

Constructor Summary

Constructors

Constructor and Description
ParallaxPage() Required default empty constructor.

Method Summary

Modifier and Type	Method and Description
android.graphics.Bitmap	getBackImage()
int	getBackImageHolderResId()
android.graphics.Bitmap	getFrontImage()
int	getFrontImageHolderResId()
java.lang.CharSequence	getText()
int	getTextHolderResId()
static ParallaxPage	newInstance()
void	notifyBackImageChanged() Updates the UI of this ParallaxPage to reflect the image supplied to (Bitmap).
void	notifyFrontImageChanged() Updates the UI of this ParallaxPage to reflect the image supplied to setFrontImage(Bitmap).
void	notifyTextChanged() Updates the UI of this ParallaxPage to reflect the text supplied to setText(CharSequence).
void	onCreate(android.os.Bundle savedInstanceState)
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	setBackImage(android.graphics.Bitmap backImage) Sets the back image of this ParallaxPage.
void	setFrontImage(android.graphics.Bitmap frontImage) Sets the front image of this ParallaxPage.
void	setText(java.lang.CharSequence text) Sets and displays the text of this ParallaxPage.

Methods inherited from class com.matthewtamlin.sliding_intro_screen_library.Page

getDesiredBackgroundColor, setDesiredBackgroundColor

Methods inherited from class java.lang.Object

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

Field Detail

rootView

protected android.widget.FrameLayout rootView

The root view of this Fragment.

frontImageHolder

protected android.widget.ImageView frontImageHolder

The View which displays the front image.

backImageHolder

protected android.widget.ImageView backImageHolder

The View which displays the back image.

textHolder

protected android.widget.TextView textHolder

The View which displays the text.

frontImage

protected android.graphics.Bitmap frontImage

The current front image.

backImage

protected android.graphics.Bitmap backImage

The current back image.

text

protected java.lang.CharSequence text

The current text.

Constructor Detail

ParallaxPage

public ParallaxPage()

Required default empty constructor.

Method Detail

newInstance

public static ParallaxPage newInstance()

Returns:

a new instance of ParallaxPage.

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)

onCreate

public void onCreate(android.os.Bundle savedInstanceState)

setFrontImage

public void setFrontImage(android.graphics.Bitmap frontImage)

Sets the front image of this ParallaxPage.

Parameters:

frontImage - the image to display

getFrontImage

public android.graphics.Bitmap getFrontImage()

Returns:

the current front image, null if there is none

getFrontImageHolderResId

public int getFrontImageHolderResId()

Returns:

the resource id of the view which holds the front image

setBackImage

public void setBackImage(android.graphics.Bitmap backImage)

Sets the back image of this ParallaxPage.

Parameters:

backImage - the image to display

getBackImage

public android.graphics.Bitmap getBackImage()

Returns:

the current back image, null if there is none

getBackImageHolderResId

public int getBackImageHolderResId()

Returns:

the resource id of the view which holds the back image

setText

public void setText(java.lang.CharSequence text)

Sets and displays the text of this ParallaxPage.

Parameters:

text - the text to display

getText

public java.lang.CharSequence getText()

Returns:

the current text, null if there is none

getTextHolderResId

public int getTextHolderResId()

Returns:

the resource id of the view which holds the text

notifyFrontImageChanged

public void notifyFrontImageChanged()

Updates the UI of this ParallaxPage to reflect the image supplied to setFrontImage(Bitmap). There is no need to explicitly call this method after calling setFrontImage(Bitmap).

notifyBackImageChanged

public void notifyBackImageChanged()

Updates the UI of this ParallaxPage to reflect the image supplied to (Bitmap). There is no need to explicitly call this method after calling setBackImage(Bitmap).

notifyTextChanged

public void notifyTextChanged()

Updates the UI of this ParallaxPage to reflect the text supplied to setText(CharSequence). There is no need to explicitly call this method after calling setText(CharSequence).