ginivision/net.gini.android.vision.onboarding/OnboardingFragmentStandard

OnboardingFragmentStandard

Component API

When you use the Component API without the Android Support Library, the {@code OnboardingFragmentStandard} displays important advice for correctly photographing a document.

Include the {@code OnboardingFragmentStandard} into your layout either directly with {@code } in your Activity's layout or using the android.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 or 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 or the createInstanceWithoutEmptyLastPage factory method.

An OnboardingFragmentListener instance must be available until the {@code OnboardingFragmentStandard} 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 setListener .

Your Activity is automatically set as the listener in onCreate .

Customizing the Onboarding Screen

See the OnboardingActivity for details.

public class OnboardingFragmentStandard extends Fragment implements OnboardingFragmentImplCallback, OnboardingFragmentInterface

Functions

createInstance

androidJvm

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 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 .

static OnboardingFragmentStandard createInstance(ArrayList<OnboardingPage> pages)

createInstanceWithoutEmptyLastPage

androidJvm

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 .

static OnboardingFragmentStandard createInstanceWithoutEmptyLastPage()

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 .

static OnboardingFragmentStandard createInstanceWithoutEmptyLastPage(ArrayList<OnboardingPage> pages)

dump

androidJvm

void dump(String prefix, FileDescriptor fd, PrintWriter writer, Array<String> args)

equals

androidJvm

final boolean equals(Object o)

getActivity

androidJvm

final Activity getActivity()

@Nullable()

abstract Activity getActivity()

getAllowEnterTransitionOverlap

androidJvm

boolean getAllowEnterTransitionOverlap()

getAllowReturnTransitionOverlap

androidJvm

boolean getAllowReturnTransitionOverlap()

getArguments

androidJvm

final Bundle getArguments()

getChildFragmentManager

androidJvm

final FragmentManager getChildFragmentManager()

getContext

androidJvm

Context getContext()

getEnterTransition

androidJvm

Transition getEnterTransition()

getExitTransition

androidJvm

Transition getExitTransition()

getFragmentManager

androidJvm

final FragmentManager getFragmentManager()

getHost

androidJvm

final Object getHost()

getId

androidJvm

final int getId()

getLayoutInflater

androidJvm

final LayoutInflater getLayoutInflater()

getLoaderManager

androidJvm

LoaderManager getLoaderManager()

getParentFragment

androidJvm

final Fragment getParentFragment()

getReenterTransition

androidJvm

Transition getReenterTransition()

getResources

androidJvm

final Resources getResources()

getRetainInstance

androidJvm

final boolean getRetainInstance()

getReturnTransition

androidJvm

Transition getReturnTransition()

getSharedElementEnterTransition

androidJvm

Transition getSharedElementEnterTransition()

getSharedElementReturnTransition

androidJvm

Transition getSharedElementReturnTransition()

getString

androidJvm

final String getString(int resId)

getTag

androidJvm

final String getTag()

getTargetFragment

androidJvm

final Fragment getTargetFragment()

getTargetRequestCode

androidJvm

final int getTargetRequestCode()

getText

androidJvm

final CharSequence getText(int resId)

getUserVisibleHint

androidJvm

boolean getUserVisibleHint()

getView

androidJvm

View getView()

@Nullable()

abstract View getView()

getViewPagerAdapter

androidJvm

abstract PagerAdapter getViewPagerAdapter(List<OnboardingPage> pages)

PagerAdapter getViewPagerAdapter(List<OnboardingPage> pages)

hashCode

androidJvm

final int hashCode()

instantiate

androidJvm

static Fragment instantiate(Context context, String fname)

isAdded

androidJvm

final boolean isAdded()

isDetached

androidJvm

final boolean isDetached()

isHidden

androidJvm

final boolean isHidden()

isInLayout

androidJvm

final boolean isInLayout()

isRemoving

androidJvm

final boolean isRemoving()

isResumed

androidJvm

final boolean isResumed()

isStateSaved

androidJvm

final boolean isStateSaved()

isVisible

androidJvm

final boolean isVisible()

onActivityCreated

androidJvm

void onActivityCreated(Bundle savedInstanceState)

onActivityResult

androidJvm

void onActivityResult(int requestCode, int resultCode, Intent data)

onAttach

androidJvm

void onAttach(Context context)

onAttachFragment

androidJvm

void onAttachFragment(Fragment childFragment)

onConfigurationChanged

androidJvm

void onConfigurationChanged(Configuration newConfig)

onContextItemSelected

androidJvm

boolean onContextItemSelected(MenuItem item)

onCreate

androidJvm

void onCreate(Bundle savedInstanceState)

onCreateAnimator

androidJvm

Animator onCreateAnimator(int transit, boolean enter, int nextAnim)

onCreateContextMenu

androidJvm

void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)

onCreateOptionsMenu

androidJvm

void onCreateOptionsMenu(Menu menu, MenuInflater inflater)

onCreateView

androidJvm

View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

@Nullable()

View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

onDestroy

androidJvm

void onDestroy()

onDestroyOptionsMenu

androidJvm

void onDestroyOptionsMenu()

onDestroyView

androidJvm

void onDestroyView()

onDetach

androidJvm

void onDetach()

onGetLayoutInflater

androidJvm

LayoutInflater onGetLayoutInflater(Bundle savedInstanceState)

onHiddenChanged

androidJvm

void onHiddenChanged(boolean hidden)

onInflate

androidJvm

void onInflate(AttributeSet attrs, Bundle savedInstanceState)

onLowMemory

androidJvm

void onLowMemory()

onMultiWindowModeChanged

androidJvm

void onMultiWindowModeChanged(boolean isInMultiWindowMode, Configuration newConfig)

onOptionsItemSelected

androidJvm

boolean onOptionsItemSelected(MenuItem item)

onOptionsMenuClosed

androidJvm

void onOptionsMenuClosed(Menu menu)

onPause

androidJvm

void onPause()

onPictureInPictureModeChanged

androidJvm

void onPictureInPictureModeChanged(boolean isInPictureInPictureMode, Configuration newConfig)

onPrepareOptionsMenu

androidJvm

void onPrepareOptionsMenu(Menu menu)

onRequestPermissionsResult

androidJvm

void onRequestPermissionsResult(int requestCode, Array<String> permissions, Array<int> grantResults)

onResume

androidJvm

void onResume()

onSaveInstanceState

androidJvm

void onSaveInstanceState(Bundle outState)

onStart

androidJvm

void onStart()

onStop

androidJvm

void onStop()

onTrimMemory

androidJvm

void onTrimMemory(int level)

onViewCreated

androidJvm

void onViewCreated(View view, Bundle savedInstanceState)

onViewStateRestored

androidJvm

void onViewStateRestored(Bundle savedInstanceState)

postponeEnterTransition

androidJvm

void postponeEnterTransition()

registerForContextMenu

androidJvm

void registerForContextMenu(View view)

requestPermissions

androidJvm

final void requestPermissions(Array<String> permissions, int requestCode)

setAllowEnterTransitionOverlap

androidJvm

void setAllowEnterTransitionOverlap(boolean allow)

setAllowReturnTransitionOverlap

androidJvm

void setAllowReturnTransitionOverlap(boolean allow)

setArguments

androidJvm

void setArguments(Bundle args)

setEnterSharedElementCallback

androidJvm

void setEnterSharedElementCallback(SharedElementCallback callback)

setEnterTransition

androidJvm

void setEnterTransition(Transition transition)

setExitSharedElementCallback

androidJvm

void setExitSharedElementCallback(SharedElementCallback callback)

setExitTransition

androidJvm

void setExitTransition(Transition transition)

setHasOptionsMenu

androidJvm

void setHasOptionsMenu(boolean hasMenu)

setInitialSavedState

androidJvm

void setInitialSavedState(Fragment.SavedState state)

setListener

androidJvm

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.

void setListener(OnboardingFragmentListener listener)