com.braunster.tutorialview.object

Class TutorialBuilder

java.lang.Object

com.braunster.tutorialview.object.TutorialBuilder

public class TutorialBuilder
extends java.lang.Object

Created by braunster on 24/12/14.

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructor Summary

Constructors

Constructor and Description
TutorialBuilder()

Method Summary

Modifier and Type	Method and Description
Tutorial	build()
TutorialBuilder	setAnimationDuration(long mAnimationDuration)
TutorialBuilder	setAnimationType(AbstractTutorialView.AnimationType mAnimationType)
TutorialBuilder	setBackgroundColor(int mBackgroundColor)
TutorialBuilder	setInfoText(java.lang.String mInfoText)
TutorialBuilder	setmPositionToSurroundY(float mPositionToSurroundY)
TutorialBuilder	setPositionToSurroundHeight(int mPositionToSurroundHeight)
TutorialBuilder	setPositionToSurroundWidth(int mPositionToSurroundWidth)
TutorialBuilder	setPositionToSurroundX(float mPositionToSurroundX)
TutorialBuilder	setTitle(java.lang.String mTitle)
TutorialBuilder	setTutorialGotItPosition(int gotItPosition)
TutorialBuilder	setTutorialInfoLayoutId(int mTutorialInfoLayoutId)
TutorialBuilder	setTutorialInfoTextPosition(int infoTextPosition)
TutorialBuilder	setTutorialTextColor(int mTutorialTextColor)
TutorialBuilder	setTutorialTextSize(int mTutorialTextSize)
TutorialBuilder	setTutorialTextTypeFaceName(java.lang.String mTutorialTextTypeFaceName)
TutorialBuilder	setViewToSurround(android.view.View view)

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.

Constructor Detail

TutorialBuilder

public TutorialBuilder()

Method Detail

setViewToSurround

public TutorialBuilder setViewToSurround(android.view.View view)

setBackgroundColor

public TutorialBuilder setBackgroundColor(int mBackgroundColor)

setInfoText

public TutorialBuilder setInfoText(java.lang.String mInfoText)

setTutorialTextSize

public TutorialBuilder setTutorialTextSize(int mTutorialTextSize)

setTitle

public TutorialBuilder setTitle(java.lang.String mTitle)

setPositionToSurroundX

public TutorialBuilder setPositionToSurroundX(float mPositionToSurroundX)

setmPositionToSurroundY

public TutorialBuilder setmPositionToSurroundY(float mPositionToSurroundY)

setPositionToSurroundWidth

public TutorialBuilder setPositionToSurroundWidth(int mPositionToSurroundWidth)

setPositionToSurroundHeight

public TutorialBuilder setPositionToSurroundHeight(int mPositionToSurroundHeight)

setTutorialTextColor

public TutorialBuilder setTutorialTextColor(int mTutorialTextColor)

setTutorialTextTypeFaceName

public TutorialBuilder setTutorialTextTypeFaceName(java.lang.String mTutorialTextTypeFaceName)

setTutorialInfoLayoutId

public TutorialBuilder setTutorialInfoLayoutId(int mTutorialInfoLayoutId)

setAnimationType

public TutorialBuilder setAnimationType(AbstractTutorialView.AnimationType mAnimationType)

setAnimationDuration

public TutorialBuilder setAnimationDuration(long mAnimationDuration)

setTutorialInfoTextPosition

public TutorialBuilder setTutorialInfoTextPosition(int infoTextPosition)

setTutorialGotItPosition

public TutorialBuilder setTutorialGotItPosition(int gotItPosition)

build

public Tutorial build()