public interface TutorialViewInterface extends TutorialInterface
| 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() |
getAnimationDuration, getAnimationType, getTutorialBackgroundColor, getTutorialGotItPosition, getTutorialInfoLayoutId, getTutorialInfoTextPosition, getTutorialText, getTutorialTextColor, getTutorialTextSize, getTutorialTextTypeFace, setAnimationDuration, setAnimationType, setTutorialBackgroundColor, setTutorialGotItPosition, setTutorialInfoLayoutId, setTutorialInfoTextPosition, setTutorialText, setTutorialTextColor, setTutorialTextSize, setTutorialTextTypeFacevoid setViewToSurround(android.view.View mViewToSurround)
mViewToSurround - - the view that need to be surrounded with the tutorial.void setViewToSurround(android.view.View mViewToSurround,
java.lang.String title)
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.void setPositionToSurround(float positionToSurroundX,
float positionToSurroundY,
int positionToSurroundWidth,
int positionToSurroundHeight)
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.void setPositionToSurround(float positionToSurroundX,
float positionToSurroundY,
int positionToSurroundWidth,
int positionToSurroundHeight,
java.lang.String title)
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.void setTutorial(Tutorial tutorial, boolean show)
tutorial - The tutorial object that hold all the tutorial data.show - pass true if you want the tutorial to be shown.void setTutorial(Tutorial tutorial)
tutorial - The tutorial object that hold all the tutorial data.void setActionBar(android.app.ActionBar actionBar)
void setTutorialClosedListener(AbstractTutorialView.TutorialClosedListener tutorialClosedListener)
void changeActionBarColor(boolean mChangeActionBarColor)
mActionBarRestoreColor so when the tutorial is closed the action bar color will ber restored.void setActionBarRestoreColor(int mActionBarColor)
void setHasStatusBar(boolean hasStatusBar)
void setHasActionBar(boolean hasActionBar)
boolean isShowing()
boolean isWalkThrough()
void show()
void hide()