com.stephentuso.welcome

Class WelcomeHelper

java.lang.Object

com.stephentuso.welcome.WelcomeHelper

public class WelcomeHelper
extends java.lang.Object

Created by stephentuso on 11/15/15. Class that handles showing a welcome screen

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_WELCOME_SCREEN_REQUEST

Constructor Summary

Constructors

Constructor and Description
WelcomeHelper(android.app.Activity activity, java.lang.Class<? extends WelcomeActivity> activityClass)

Method Summary

Modifier and Type	Method and Description
void	forceShow() Always shows the welcome screen
void	forceShow(int requestCode) Always show the welcome screen
void	onSaveInstanceState(android.os.Bundle outState)
boolean	show(android.os.Bundle savedInstanceState) Shows the welcome screen if it hasn't already been started or completed yet
boolean	show(android.os.Bundle savedInstanceState, int requestCode) Shows the welcome screen if it hasn't already been started or completed yet

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WELCOME_SCREEN_REQUEST

public static final int DEFAULT_WELCOME_SCREEN_REQUEST

See Also:

Constant Field Values

Constructor Detail

WelcomeHelper

public WelcomeHelper(android.app.Activity activity,
                     java.lang.Class<? extends WelcomeActivity> activityClass)

Parameters:

activity - An activity

activityClass - Class of your welcome screen. An Activity that extends WelcomeActivity

Method Detail

show

public boolean show(android.os.Bundle savedInstanceState)

Shows the welcome screen if it hasn't already been started or completed yet

Parameters:

savedInstanceState - Saved instance state Bundle

Returns:

true if the welcome screen was shown, false if it wasn't

show

public boolean show(android.os.Bundle savedInstanceState,
                    int requestCode)

Shows the welcome screen if it hasn't already been started or completed yet

Parameters:

savedInstanceState - Saved instance state Bundle

requestCode - The request code that will be returned with the result of the welcome screen in your Activity's onActivityResult

Returns:

true if the welcome screen was shown, false if it wasn't

forceShow

public void forceShow()

Always shows the welcome screen

forceShow

public void forceShow(int requestCode)

Always show the welcome screen

Parameters:

requestCode - The request code that will be returned with the result of the welcome screen in your Activity's onActivityResult

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)