com.braunster.tutorialview.object

Class TutorialIntentBuilder

java.lang.Object

com.braunster.tutorialview.object.TutorialIntentBuilder

public class TutorialIntentBuilder
extends java.lang.Object

Created by braunster on 04/12/14.

Constructor Summary

Constructors

Constructor and Description
TutorialIntentBuilder(android.content.Context context)
TutorialIntentBuilder(android.content.Intent intent)

Method Summary

Modifier and Type	Method and Description
static boolean	changesSystemUiColors(android.content.Intent intent)
TutorialIntentBuilder	changeSystemUiColor(boolean change)
android.content.Intent	getIntent()
static Tutorial	getTutorial(android.content.Intent intent) Get the tutorial passed in the intent, If a list of tutorial had been passed as a walk through the first in the list will be returned.
static java.util.ArrayList<Tutorial>	getWalkThroughData(android.content.Intent intent) Getting the list of tutorials that will be used for the walk through
TutorialIntentBuilder	hasStatusBar(boolean hasStatusBar)
static boolean	hasStatusBar(android.content.Intent intent)
static boolean	isWalkThrough(android.content.Intent intent)
TutorialIntentBuilder	setTutorial(Tutorial tutorial)
TutorialIntentBuilder	setWalkThroughList(java.util.ArrayList<Tutorial> tutorials)
TutorialIntentBuilder	setWalkThroughList(Tutorial... tutorials)
static void	showTutorial(TutorialViewInterface tutorial, android.content.Intent intent) Used in the tutorial activity to show the tutorial, The data from the intent would be recovered and would be set on the TutorialInterface.
static boolean	skipOnBackPressed(android.content.Intent intent)
TutorialIntentBuilder	skipTutorialOnBackPressed(boolean skip)

Methods inherited from class java.lang.Object

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

Constructor Detail

TutorialIntentBuilder

public TutorialIntentBuilder(android.content.Context context)

TutorialIntentBuilder

public TutorialIntentBuilder(android.content.Intent intent)

Method Detail

setTutorial

public TutorialIntentBuilder setTutorial(Tutorial tutorial)

changeSystemUiColor

public TutorialIntentBuilder changeSystemUiColor(boolean change)

Parameters:

change - if true changes the color of the status and navigation bars on devices running API 21 (Lollipop) and up. * *

hasStatusBar

public TutorialIntentBuilder hasStatusBar(boolean hasStatusBar)

setWalkThroughList

public TutorialIntentBuilder setWalkThroughList(java.util.ArrayList<Tutorial> tutorials)

setWalkThroughList

public TutorialIntentBuilder setWalkThroughList(Tutorial... tutorials)

skipTutorialOnBackPressed

public TutorialIntentBuilder skipTutorialOnBackPressed(boolean skip)

Parameters:

skip - if true the TutorialActivity will skip the tutorial on back pressed.

See Also:

TutorialLayout.skip()

getIntent

public android.content.Intent getIntent()

Returns:

the intent that was build and populated with all attributes.

changesSystemUiColors

public static boolean changesSystemUiColors(android.content.Intent intent)

hasStatusBar

public static boolean hasStatusBar(android.content.Intent intent)

Returns:

the value passed in the intent, Default value is true as most apps has a status bar.

skipOnBackPressed

public static boolean skipOnBackPressed(android.content.Intent intent)

Returns:

true if should skip the walk through when user press on the back button.

showTutorial

public static void showTutorial(TutorialViewInterface tutorial,
                                android.content.Intent intent)

Used in the tutorial activity to show the tutorial, The data from the intent would be recovered and would be set on the TutorialInterface.

isWalkThrough

public static boolean isWalkThrough(android.content.Intent intent)

Returns:

true if the intent contains a walk through data (List of tutorials)

getTutorial

public static Tutorial getTutorial(android.content.Intent intent)

Get the tutorial passed in the intent, If a list of tutorial had been passed as a walk through the first in the list will be returned.

getWalkThroughData

public static java.util.ArrayList<Tutorial> getWalkThroughData(android.content.Intent intent)

Getting the list of tutorials that will be used for the walk through