com.braunster.tutorialview

Interface TutorialInterface

All Known Subinterfaces:

TutorialViewInterface

All Known Implementing Classes:

AbstractTutorialView, RippleTutorialView, Tutorial, TutorialLayout, TutorialView

public interface TutorialInterface

Created by braunster on 04/12/14.

Method Summary

Modifier and Type	Method and Description
long	getAnimationDuration()
AbstractTutorialView.AnimationType	getAnimationType()
int	getTutorialBackgroundColor()
int	getTutorialGotItPosition()
int	getTutorialInfoLayoutId()
int	getTutorialInfoTextPosition()
java.lang.String	getTutorialText()
int	getTutorialTextColor()
int	getTutorialTextSize()
java.lang.String	getTutorialTextTypeFace()
void	setAnimationDuration(long duration)
void	setAnimationType(AbstractTutorialView.AnimationType animationType)
void	setTutorialBackgroundColor(int mTutorialBackgroundColor) The background color for the tutorial.
void	setTutorialGotItPosition(int gotItPosition)
void	setTutorialInfoLayoutId(int tutorialInfoLayoutId) 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 tutorialText) 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 tutorialTextTypeFaceName)

Method Detail

setTutorialInfoLayoutId

void setTutorialInfoLayoutId(int tutorialInfoLayoutId)

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

Parameters:

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

getTutorialInfoLayoutId

int getTutorialInfoLayoutId()

setTutorialBackgroundColor

void setTutorialBackgroundColor(int mTutorialBackgroundColor)

The background color for the tutorial.

Parameters:

mTutorialBackgroundColor - the backgrond color to use for the background

getTutorialBackgroundColor

int getTutorialBackgroundColor()

setTutorialText

void setTutorialText(java.lang.String tutorialText)

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.

Parameters:

tutorialText - The explenation text about the view.

See Also:

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

getTutorialText

java.lang.String getTutorialText()

setTutorialTextSize

void setTutorialTextSize(int mTutorialTextSize)

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.

Parameters:

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

See Also:

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

getTutorialTextSize

int getTutorialTextSize()

setTutorialTextColor

void setTutorialTextColor(int mTutorialTextColor)

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)

getTutorialTextColor

int getTutorialTextColor()

setTutorialTextTypeFace

void setTutorialTextTypeFace(java.lang.String tutorialTextTypeFaceName)

Parameters:

tutorialTextTypeFaceName - 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

java.lang.String getTutorialTextTypeFace()

setAnimationType

void setAnimationType(AbstractTutorialView.AnimationType animationType)

Parameters:

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

getAnimationType

AbstractTutorialView.AnimationType getAnimationType()

setAnimationDuration

void setAnimationDuration(long duration)

Parameters:

duration - the time that will be used for the animation

getAnimationDuration

long getAnimationDuration()

setTutorialInfoTextPosition

void setTutorialInfoTextPosition(int infoTextPosition)

getTutorialInfoTextPosition

int getTutorialInfoTextPosition()

setTutorialGotItPosition

void setTutorialGotItPosition(int gotItPosition)

getTutorialGotItPosition

int getTutorialGotItPosition()