com.braunster.tutorialview

Interface TutorialViewInterface

All Superinterfaces:

TutorialInterface

All Known Implementing Classes:

AbstractTutorialView, RippleTutorialView, TutorialLayout, TutorialView

public interface TutorialViewInterface
extends TutorialInterface

Created by braunster on 04/12/14.

Method Summary

Modifier and Type	Method and Description
void	changeActionBarColor(boolean mChangeActionBarColor) If true and an action bar is given to the view the action bar background color will be changed to the tutorial color.
void	hide()
boolean	isShowing()
boolean	isWalkThrough()
void	setActionBar(android.app.ActionBar actionBar) Setting the action bar, Used only if you pace the Tutorial view inside your root view.
void	setActionBarRestoreColor(int mActionBarColor) The of the color that will be set as the action bar color when the tutorial view will be closed.
void	setHasActionBar(boolean hasActionBar) Set true if the application has the activity that hold this view has action bar..
void	setHasStatusBar(boolean hasStatusBar) Set true if the application has status bar.
void	setPositionToSurround(float positionToSurroundX, float positionToSurroundY, int positionToSurroundWidth, int positionToSurroundHeight) Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.
void	setPositionToSurround(float positionToSurroundX, float positionToSurroundY, int positionToSurroundWidth, int positionToSurroundHeight, java.lang.String title) Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.
void	setTutorial(Tutorial tutorial) Set the tutorial data for this view and animate it into the screen.
void	setTutorial(Tutorial tutorial, boolean show) Set the tutorial data for this view and animate it into the screen if wanted.
void	setTutorialClosedListener(AbstractTutorialView.TutorialClosedListener tutorialClosedListener) Setting a listener that will be called when the tutorial is closed.
void	setViewToSurround(android.view.View mViewToSurround) Surround a given view by a visual tutorial with text.
void	setViewToSurround(android.view.View mViewToSurround, java.lang.String title) Surround a given view by a visual tutorial with text and title.
void	show()

Methods inherited from interface com.braunster.tutorialview.TutorialInterface

getAnimationDuration, getAnimationType, getTutorialBackgroundColor, getTutorialGotItPosition, getTutorialInfoLayoutId, getTutorialInfoTextPosition, getTutorialText, getTutorialTextColor, getTutorialTextSize, getTutorialTextTypeFace, setAnimationDuration, setAnimationType, setTutorialBackgroundColor, setTutorialGotItPosition, setTutorialInfoLayoutId, setTutorialInfoTextPosition, setTutorialText, setTutorialTextColor, setTutorialTextSize, setTutorialTextTypeFace

Method Detail

setViewToSurround

void setViewToSurround(android.view.View mViewToSurround)

Surround a given view by a visual tutorial with text.

Parameters:

mViewToSurround - - the view that need to be surrounded with the tutorial.

setViewToSurround

void setViewToSurround(android.view.View mViewToSurround,
                       java.lang.String title)

Surround a given view by a visual tutorial with text and title.

Parameters:

title - - the text of the title that will be used for the tutorial, If an action bar is assign the title will be in the action bar title.

mViewToSurround - - the view that need to be surrounded with the tutorial.

setPositionToSurround

void setPositionToSurround(float positionToSurroundX,
                           float positionToSurroundY,
                           int positionToSurroundWidth,
                           int positionToSurroundHeight)

Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.

Parameters:

positionToSurroundX - - The x position of the area that should be surrounded, This could be obtained by using getX() on the view you want to surround.

positionToSurroundY - - The y position of the area that should be surrounded, This could be obtained by using getY() on the view you want to surround.

positionToSurroundWidth - - The width of the area that should be surrounded, This could be obtained by using getMeasuredWidth() on the view you want to surround.

positionToSurroundHeight - - The height of the area that should be surrounded, This could be obtained by using getMeasuredHeight() on the view you want to surround.

setPositionToSurround

void setPositionToSurround(float positionToSurroundX,
                           float positionToSurroundY,
                           int positionToSurroundWidth,
                           int positionToSurroundHeight,
                           java.lang.String title)

Used mostly for the tutorial activity, Instead of passing a view to surround we pass the view coordination and dimensions.

Parameters:

title - - The title text that will be used for this tutorial.

positionToSurroundX - - The x position of the area that should be surrounded, This could be obtained by using getX() on the view you want to surround.

positionToSurroundY - - The y position of the area that should be surrounded, This could be obtained by using getY() on the view you want to surround.

positionToSurroundWidth - - The width of the area that should be surrounded, This could be obtained by using getMeasuredWidth() on the view you want to surround.

positionToSurroundHeight - - The height of the area that should be surrounded, This could be obtained by using getMeasuredHeight() on the view you want to surround.

setTutorial

void setTutorial(Tutorial tutorial,
                 boolean show)

Set the tutorial data for this view and animate it into the screen if wanted.

Parameters:

tutorial - The tutorial object that hold all the tutorial data.

show - pass true if you want the tutorial to be shown.

setTutorial

void setTutorial(Tutorial tutorial)

Set the tutorial data for this view and animate it into the screen.

Parameters:

tutorial - The tutorial object that hold all the tutorial data.

setActionBar

void setActionBar(android.app.ActionBar actionBar)

Setting the action bar, Used only if you pace the Tutorial view inside your root view. When set the view could change the title and color of the action bar as you pleased.

See Also:

setActionBarRestoreColor(int), changeActionBarColor(boolean)

setTutorialClosedListener

void setTutorialClosedListener(AbstractTutorialView.TutorialClosedListener tutorialClosedListener)

Setting a listener that will be called when the tutorial is closed.

changeActionBarColor

void changeActionBarColor(boolean mChangeActionBarColor)

If true and an action bar is given to the view the action bar background color will be changed to the tutorial color. You should also set mActionBarRestoreColor so when the tutorial is closed the action bar color will ber restored.

See Also:

AbstractTutorialView.setActionBarRestoreColor(int)

setActionBarRestoreColor

void setActionBarRestoreColor(int mActionBarColor)

The of the color that will be set as the action bar color when the tutorial view will be closed.

See Also:

AbstractTutorialView.changeActionBarColor(boolean)

setHasStatusBar

void setHasStatusBar(boolean hasStatusBar)

Set true if the application has status bar.

setHasActionBar

void setHasActionBar(boolean hasActionBar)

Set true if the application has the activity that hold this view has action bar..

isShowing

boolean isShowing()

Returns:

true if the tutorial is now showing it will remain true until the tutorial is fully animated out.

isWalkThrough

boolean isWalkThrough()

Returns:

true if the view is in walk through mode.

show

void show()

hide

void hide()