net.gini.android.vision.onboarding

Class OnboardingPage

java.lang.Object

net.gini.android.vision.onboarding.OnboardingPage

public class OnboardingPage
extends java.lang.Object

The OnboardingPage is used by the Onboarding Fragment to display an image and a short text.

Use this class to show a different number of pages in the Onboarding Screen. Customizing the default onboarding pages can be done via overriding of app resources.

When using the Screen API set an ArrayList containing OnboardingPage objects as the CameraActivity.EXTRA_IN_ONBOARDING_PAGES when starting the CameraActivity.

When using the Componenent API provide an ArrayList containing OnboardingPage objects as the argument for the Onboarding Fragment factory method OnboardingFragmentStandard.createInstance(ArrayList) or OnboardingFragmentCompat.createInstance(ArrayList).

Constructor Summary

Constructors

Constructor and Description
OnboardingPage(int textResId, int imageResId) Create a new onboarding page with the desired string resource and drawable resource.

Method Summary

Modifier and Type	Method and Description
int	getImageResId()
int	getTextResId()

Methods inherited from class java.lang.Object

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

Constructor Detail

OnboardingPage

public OnboardingPage(int textResId,
                      int imageResId)

Create a new onboarding page with the desired string resource and drawable resource.

Note: the string should be a short sentence.

Parameters:

textResId - a string resource id which will be shown in the onboarding page

imageResId - a drawable resource id which will be shown in the onboarding page

Method Detail

getTextResId

public int getTextResId()

Returns:

the string resource id of the text shown on the onboarding page

getImageResId

public int getImageResId()

Returns:

the drawable resource id of the text shown on the onboarding page