com.braunster.tutorialview.object

Class Tutorial

java.lang.Object

com.braunster.tutorialview.object.Tutorial

All Implemented Interfaces:

android.os.Parcelable, TutorialInterface

public class Tutorial
extends java.lang.Object
implements android.os.Parcelable, TutorialInterface

Created by braunster on 24/12/14.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Tutorial.GotItPosition Static values representing available positions for placing the "GotIt" button in the TutorialView.
class	Tutorial.InfoPosition Static values representing available positions for placing the info text in the TutorialView.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<Tutorial>	CREATOR
protected long	mAnimationDuration Holds the animation duration that will be used to animate the tutorial in and out.
protected AbstractTutorialView.AnimationType	mAnimationType Holds the animation type value that will be preformed on opening and closing the tutorial.
protected int	mTutorialInfoLayoutId The layout id that will be used to inflate the tutorial info view.
protected int	mTutorialTextColor Holds the color for the default info view text view.
protected int	mTutorialTextSize Holds the size of the default info view text view.
protected java.lang.String	mTutorialTextTypeFaceName Holds the name of the typeface that will be used for the default info view text view

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Tutorial()

Method Summary

Modifier and Type	Method and Description
void	clear()
int	describeContents()
long	getAnimationDuration()
AbstractTutorialView.AnimationType	getAnimationType()
int	getPositionToSurroundHeight()
int	getPositionToSurroundWidth()
float	getPositionToSurroundX()
float	getPositionToSurroundY()
java.lang.String	getTitle()
int	getTutorialBackgroundColor()
int	getTutorialGotItPosition()
int	getTutorialInfoLayoutId()
int	getTutorialInfoTextPosition()
java.lang.String	getTutorialText()
int	getTutorialTextColor()
int	getTutorialTextSize()
java.lang.String	getTutorialTextTypeFace()
void	setAnimationDuration(long mAnimationDuration)
void	setAnimationType(AbstractTutorialView.AnimationType mAnimationType)
void	setPositionToSurroundHeight(int mPositionToSurroundHeight)
void	setPositionToSurroundWidth(int mPositionToSurroundWidth)
void	setPositionToSurroundX(float mPositionToSurroundX)
void	setPositionToSurroundY(float mPositionToSurroundY)
void	setTitle(java.lang.String mTitle)
void	setTutorialBackgroundColor(int mBackgroundColor) The background color for the tutorial.
void	setTutorialGotItPosition(int gotItPosition)
void	setTutorialInfoLayoutId(int mTutorialInfoLayoutId) The Layout id of the view that will be used to show the tutorial text or information.
void	setTutorialInfoTextPosition(int infoTextPosition)
void	setTutorialText(java.lang.String mInfoText) The text that will be used for the mTutorialInfoView.
void	setTutorialTextColor(int mTutorialTextColor)
void	setTutorialTextSize(int mTutorialTextSize) Set the size that will be used for the default info view text view.
void	setTutorialTextTypeFace(java.lang.String mTutorialTextTypeFaceName)
void	setViewToSurround(android.view.View view)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

mAnimationDuration

protected long mAnimationDuration

Holds the animation duration that will be used to animate the tutorial in and out. Id does not assigned it will be ignored and AbstractTutorialView.DEFAULT_ANIM_DURATION will be used.

mAnimationType

protected AbstractTutorialView.AnimationType mAnimationType

Holds the animation type value that will be preformed on opening and closing the tutorial.

mTutorialInfoLayoutId

protected int mTutorialInfoLayoutId

The layout id that will be used to inflate the tutorial info view.

mTutorialTextColor

protected int mTutorialTextColor

Holds the color for the default info view text view.

mTutorialTextTypeFaceName

protected java.lang.String mTutorialTextTypeFaceName

Holds the name of the typeface that will be used for the default info view text view

mTutorialTextSize

protected int mTutorialTextSize

Holds the size of the default info view text view.

CREATOR

public static final android.os.Parcelable.Creator<Tutorial> CREATOR

Constructor Detail

Tutorial

public Tutorial()

Method Detail

clear

public void clear()

setViewToSurround

public void setViewToSurround(android.view.View view)

getTitle

public java.lang.String getTitle()

getPositionToSurroundX

public float getPositionToSurroundX()

getPositionToSurroundY

public float getPositionToSurroundY()

getPositionToSurroundWidth

public int getPositionToSurroundWidth()

getPositionToSurroundHeight

public int getPositionToSurroundHeight()

setPositionToSurroundX

public void setPositionToSurroundX(float mPositionToSurroundX)

setPositionToSurroundY

public void setPositionToSurroundY(float mPositionToSurroundY)

setPositionToSurroundWidth

public void setPositionToSurroundWidth(int mPositionToSurroundWidth)

setPositionToSurroundHeight

public void setPositionToSurroundHeight(int mPositionToSurroundHeight)

getTutorialBackgroundColor

public int getTutorialBackgroundColor()

Specified by:

getTutorialBackgroundColor in interface TutorialInterface

setTutorialBackgroundColor

public void setTutorialBackgroundColor(int mBackgroundColor)

Description copied from interface: TutorialInterface

The background color for the tutorial.

Specified by:

setTutorialBackgroundColor in interface TutorialInterface

Parameters:

mBackgroundColor - the backgrond color to use for the background

setTutorialText

public void setTutorialText(java.lang.String mInfoText)

Description copied from interface: TutorialInterface

The text that will be used for the mTutorialInfoView. Only if the layout that is used is the default layout com.braunster.tutorialview.R.layout#tutorial_text.

Specified by:

setTutorialText in interface TutorialInterface

Parameters:

mInfoText - The explenation text about the view.

See Also:

AbstractTutorialView.setTutorialTextTypeFace(String), AbstractTutorialView.setTutorialTextColor(int), AbstractTutorialView.setTutorialTextSize(int)

getTutorialText

public java.lang.String getTutorialText()

Specified by:

getTutorialText in interface TutorialInterface

getTutorialTextSize

public int getTutorialTextSize()

Specified by:

getTutorialTextSize in interface TutorialInterface

setTutorialTextSize

public void setTutorialTextSize(int mTutorialTextSize)

Description copied from interface: TutorialInterface

Set the size that will be used for the default info view text view. The size of the title and other button won't be changed.

Specified by:

setTutorialTextSize in interface TutorialInterface

Parameters:

mTutorialTextSize - the size that would be used for the info text.

See Also:

AbstractTutorialView.setTutorialText(String), AbstractTutorialView.setTutorialTextColor(int), AbstractTutorialView.setTutorialTextTypeFace(String)

setTitle

public void setTitle(java.lang.String mTitle)

getTutorialTextColor

public int getTutorialTextColor()

Specified by:

getTutorialTextColor in interface TutorialInterface

setTutorialTextColor

public void setTutorialTextColor(int mTutorialTextColor)

Specified by:

setTutorialTextColor in interface TutorialInterface

Parameters:

mTutorialTextColor - the color that will be used for the default info view text view. This color will also be used for the "Got It" button.

See Also:

AbstractTutorialView.setTutorialTextSize(int), AbstractTutorialView.setTutorialText(String), AbstractTutorialView.setTutorialTextTypeFace(String)

getTutorialInfoLayoutId

public int getTutorialInfoLayoutId()

Specified by:

getTutorialInfoLayoutId in interface TutorialInterface

setTutorialInfoLayoutId

public void setTutorialInfoLayoutId(int mTutorialInfoLayoutId)

Description copied from interface: TutorialInterface

The Layout id of the view that will be used to show the tutorial text or information.

Specified by:

setTutorialInfoLayoutId in interface TutorialInterface

Parameters:

mTutorialInfoLayoutId - the id of the layout that should be used for the info text.

getAnimationType

public AbstractTutorialView.AnimationType getAnimationType()

Specified by:

getAnimationType in interface TutorialInterface

setAnimationType

public void setAnimationType(AbstractTutorialView.AnimationType mAnimationType)

Specified by:

setAnimationType in interface TutorialInterface

Parameters:

mAnimationType - the animation type that will be used to show and hide the tutorial.

getAnimationDuration

public long getAnimationDuration()

Specified by:

getAnimationDuration in interface TutorialInterface

setTutorialInfoTextPosition

public void setTutorialInfoTextPosition(int infoTextPosition)

Specified by:

setTutorialInfoTextPosition in interface TutorialInterface

getTutorialInfoTextPosition

public int getTutorialInfoTextPosition()

Specified by:

getTutorialInfoTextPosition in interface TutorialInterface

setTutorialGotItPosition

public void setTutorialGotItPosition(int gotItPosition)

Specified by:

setTutorialGotItPosition in interface TutorialInterface

getTutorialGotItPosition

public int getTutorialGotItPosition()

Specified by:

getTutorialGotItPosition in interface TutorialInterface

setAnimationDuration

public void setAnimationDuration(long mAnimationDuration)

Specified by:

setAnimationDuration in interface TutorialInterface

Parameters:

mAnimationDuration - the time that will be used for the animation

setTutorialTextTypeFace

public void setTutorialTextTypeFace(java.lang.String mTutorialTextTypeFaceName)

Specified by:

setTutorialTextTypeFace in interface TutorialInterface

Parameters:

mTutorialTextTypeFaceName - the typeface name that will be used for the default info view text view.

See Also:

AbstractTutorialView.setTutorialTextSize(int), AbstractTutorialView.setTutorialText(String), AbstractTutorialView.setTutorialTextColor(int)

getTutorialTextTypeFace

public java.lang.String getTutorialTextTypeFace()

Specified by:

getTutorialTextTypeFace in interface TutorialInterface

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable