net.gini.android.vision.onboarding

Class OnboardingFragmentCompat

java.lang.Object

Fragment

net.gini.android.vision.onboarding.OnboardingFragmentCompat

All Implemented Interfaces:

OnboardingFragmentInterface

public class OnboardingFragmentCompat
extends Fragment
implements OnboardingFragmentInterface

Component API

When you use the Component API with the Android Support Library, the OnboardingFragmentCompat displays important advice for correctly photographing a document.

Note: Your Activity hosting this Fragment must extend the android.support.v7.app.AppCompatActivity and use an AppCompat Theme.

Include the OnboardingFragmentCompat into your layout either directly with <fragment> in your Activity's layout or using the android.support.v4.app.FragmentManager.

The default way of showing the Onboarding Screen is as an overlay above the camera preview with a semi-transparent background.

By default an empty last page is added to enable the revealing of the camera preview before the Onboarding Screen is dismissed.

If you would like to display a different number of pages, you can use the OnboardingFragmentCompat.createInstance(ArrayList) or OnboardingFragmentCompat.createInstanceWithoutEmptyLastPage(ArrayList) factory method and provide a list of OnboardingPage objects.

If you would like to disable the appending of the empty last page, you can use the OnboardingFragmentCompat.createInstanceWithoutEmptyLastPage(ArrayList) or the OnboardingFragmentCompat.createInstanceWithoutEmptyLastPage() factory method.

An OnboardingFragmentListener instance must be available until the OnboardingFragmentCompat is attached to an activity. Failing to do so will throw an exception. The listener instance can be provided either implicitly by making the hosting Activity implement the OnboardingFragmentListener interface or explicitly by setting the listener using OnboardingFragmentCompat.setListener(OnboardingFragmentListener).

Your Activity is automatically set as the listener in OnboardingFragmentCompat.onCreate(Bundle).

Customizing the Onboarding Screen

See the OnboardingActivity for details.

Constructor Summary

Constructors

Constructor and Description
OnboardingFragmentCompat()

Method Summary

Modifier and Type	Method and Description
static OnboardingFragmentCompat	createInstance(java.util.ArrayList pages) Factory method for creating a new instance of the Fragment using the provided list of onboarding pages.
static OnboardingFragmentCompat	createInstanceWithoutEmptyLastPage() Factory method for creating a new instance of the Fragment without appending an empty page to the default pages.
static OnboardingFragmentCompat	createInstanceWithoutEmptyLastPage(java.util.ArrayList pages) Factory method for creating a new instance of the Fragment using the provided list of onboarding pages.
PagerAdapter	getViewPagerAdapter(java.util.List pages)
void	setListener(OnboardingFragmentListener listener) Set a listener for onboarding events.
void	showAlertDialog(java.lang.String message, java.lang.String positiveButtonTitle, DialogInterface.OnClickListener positiveButtonClickListener, java.lang.String negativeButtonTitle, DialogInterface.OnClickListener negativeButtonClickListener, DialogInterface.OnCancelListener cancelListener)

Methods inherited from class java.lang.Object

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

Constructor Detail

OnboardingFragmentCompat

public OnboardingFragmentCompat()

Method Detail

createInstanceWithoutEmptyLastPage

public static OnboardingFragmentCompat createInstanceWithoutEmptyLastPage(java.util.ArrayList pages)

Factory method for creating a new instance of the Fragment using the provided list of onboarding pages.

This method prevents the appending of an empty page to your pages.

If you don't need a custom number of pages and wish to use the default behaviour, you can use the default constructor of OnboardingFragmentCompat.

Parameters:

pages - the pages to be shown

Returns:

a new instance of the Fragment

createInstance

public static OnboardingFragmentCompat createInstance(java.util.ArrayList pages)

Factory method for creating a new instance of the Fragment using the provided list of onboarding pages.

If you would like to prevent the appending of an empty page, you can use the OnboardingFragmentCompat.createInstanceWithoutEmptyLastPage(ArrayList) factory method.

If you don't need a custom number of pages and wish to use the default behaviour, you can use the default constructor of OnboardingFragmentCompat.

Parameters:

pages - the pages to be shown

Returns:

a new instance of the Fragment

createInstanceWithoutEmptyLastPage

public static OnboardingFragmentCompat createInstanceWithoutEmptyLastPage()

Factory method for creating a new instance of the Fragment without appending an empty page to the default pages.

If you wish to use the default behaviour, you can use the default constructor of OnboardingFragmentCompat.

Returns:

a new instance of the Fragment

getViewPagerAdapter

public PagerAdapter getViewPagerAdapter(java.util.List pages)

setListener

public void setListener(OnboardingFragmentListener listener)

Description copied from interface: OnboardingFragmentInterface

Set a listener for onboarding events.

By default the hosting Activity is expected to implement the OnboardingFragmentListener. In case that is not feasible you may set the listener using this method.

Note: the listener is expected to be available until the fragment is attached to an activity. Make sure to set the listener before that.

Specified by:

setListener in interface OnboardingFragmentInterface

Parameters:

listener - OnboardingFragmentListener instance

showAlertDialog

public void showAlertDialog(java.lang.String message,
                            java.lang.String positiveButtonTitle,
                            DialogInterface.OnClickListener positiveButtonClickListener,
                            java.lang.String negativeButtonTitle,
                            DialogInterface.OnClickListener negativeButtonClickListener,
                            DialogInterface.OnCancelListener cancelListener)