Package 

Class OnboardingFragmentCompat

  • All Implemented Interfaces:
    android.content.ComponentCallbacks , android.view.View.OnCreateContextMenuListener , androidx.activity.result.ActivityResultCaller , androidx.lifecycle.HasDefaultViewModelProviderFactory , androidx.lifecycle.LifecycleOwner , androidx.lifecycle.ViewModelStoreOwner , androidx.savedstate.SavedStateRegistryOwner , net.gini.android.capture.internal.ui.FragmentImplCallback , net.gini.android.capture.onboarding.OnboardingFragmentImplCallback , net.gini.android.capture.onboarding.OnboardingFragmentInterface 
    
public class OnboardingFragmentCompat
extends Fragment implements OnboardingFragmentImplCallback, 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 and use an AppCompat Theme.

    Include the OnboardingFragmentCompat into your layout either directly with <fragment> in your Activity's layout or using the androidx.fragment.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 createInstance or createInstanceWithoutEmptyLastPage 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 createInstanceWithoutEmptyLastPage or the 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 setListener.

    Your Activity is automatically set as the listener in onCreate.

    Customizing the Onboarding Screen

    See the OnboardingActivity for details.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      static OnboardingFragmentCompat createInstanceWithoutEmptyLastPage(@NonNull() ArrayList<OnboardingPage> pages) Factory method for creating a new instance of the Fragment using the provided list of onboarding pages.
      static OnboardingFragmentCompat createInstance(@NonNull() ArrayList<OnboardingPage> 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.
      void onCreate(Bundle savedInstanceState)
      View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
      PagerAdapter getViewPagerAdapter(@NonNull() List<OnboardingPage> pages)
      void setListener(@NonNull() OnboardingFragmentListener listener) Set a listener for onboarding events.
      void showAlertDialog(@NonNull() String message, @NonNull() String positiveButtonTitle, @NonNull() DialogInterface.OnClickListener positiveButtonClickListener, @Nullable() String negativeButtonTitle, @Nullable() DialogInterface.OnClickListener negativeButtonClickListener, @Nullable() DialogInterface.OnCancelListener cancelListener)

      • Methods inherited from class androidx.fragment.app.Fragment

        dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getDefaultViewModelProviderFactory, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getParentFragmentManager, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSavedStateRegistry, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hasOptionsMenu, hashCode, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onActivityResult, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDestroyView, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onPrimaryNavigationFragmentChanged, onRequestPermissionsResult, onResume, onSaveInstanceState, onStart, onStop, onViewCreated, onViewStateRestored, postponeEnterTransition, registerForActivityResult, registerForContextMenu, requestPermissions, requireActivity, requireArguments, requireContext, requireFragmentManager, requireHost, requireParentFragment, requireView, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

      • Methods inherited from class net.gini.android.capture.internal.ui.FragmentImplCallback

        getActivity, getView, startActivity, startActivityForResult

      • Methods inherited from class java.lang.Object

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