MultiPageReviewFragment

public class MultiPageReviewFragment extends Fragment implements MultiPageReviewFragmentInterface, PreviewFragmentListener, FragmentImplCallback

Component API

When you use the Compontent API and have enabled the multi-page feature, the {@code * MultiPageReviewFragment} displays the photographed or imported images and allows the user to review them by checking the order, sharpness, quality and orientation of the images. The user can correct the order by dragging the thumbnails of the images and can also correct the orientation by rotating the images.

Important:

A GiniCapture instance is required to use the {@code MultiPageReviewFragment}
Your Activity hosting this Fragment must extend the androidx.appcompat.app.AppCompatActivity and use an AppCompat Theme.

Include the {@code MultiPageReviewFragment} into your layout by using the factory method to create an instance and display it using the androidx.fragment.app.FragmentManager.

A MultiPageReviewFragmentListener instance must be available until the {@code * MultiPageReviewFragment} 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 MultiPageReviewFragmentListener interface or explicitly by setting the listener using setListener.

Your Activity is automatically set as the listener in onCreate.

Customizing the Multi-Page Review Screen See the MultiPageReviewActivity for details.

Functions

createInstance

static MultiPageReviewFragment createInstance()

dump

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

equals

final boolean equals(Object o)

getActivity

final FragmentActivity getActivity()

@Nullable()

abstract Activity getActivity()

getAllowEnterTransitionOverlap

boolean getAllowEnterTransitionOverlap()

getAllowReturnTransitionOverlap

boolean getAllowReturnTransitionOverlap()

getArguments

final Bundle getArguments()

getChildFragmentManager

final FragmentManager getChildFragmentManager()

getContext

Context getContext()

getDefaultViewModelProviderFactory

ViewModelProvider.Factory getDefaultViewModelProviderFactory()

getEnterTransition

Object getEnterTransition()

getExitTransition

Object getExitTransition()

getFragmentManager

final FragmentManager getFragmentManager()

getHost

final Object getHost()

getId

final int getId()

getLayoutInflater

final LayoutInflater getLayoutInflater()

getLifecycle

Lifecycle getLifecycle()

getLoaderManager

LoaderManager getLoaderManager()

getParentFragment

final Fragment getParentFragment()

getParentFragmentManager

final FragmentManager getParentFragmentManager()

getReenterTransition

Object getReenterTransition()

getResources

final Resources getResources()

getRetainInstance

final boolean getRetainInstance()

getReturnTransition

Object getReturnTransition()

getSavedStateRegistry

final SavedStateRegistry getSavedStateRegistry()

getSharedElementEnterTransition

Object getSharedElementEnterTransition()

getSharedElementReturnTransition

Object getSharedElementReturnTransition()

getString

final String getString(int resId)

getTag

final String getTag()

getTargetFragment

final Fragment getTargetFragment()

getTargetRequestCode

final int getTargetRequestCode()

getText

final CharSequence getText(int resId)

getUserVisibleHint

boolean getUserVisibleHint()

getView

View getView()

@Nullable()

abstract View getView()

getViewLifecycleOwner

LifecycleOwner getViewLifecycleOwner()

getViewLifecycleOwnerLiveData

LiveData<LifecycleOwner> getViewLifecycleOwnerLiveData()

getViewModelStore

ViewModelStore getViewModelStore()

hashCode

final int hashCode()

hasOptionsMenu

final boolean hasOptionsMenu()

instantiate

static Fragment instantiate(Context context, String fname)

isAdded

final boolean isAdded()

isDetached

final boolean isDetached()

isHidden

final boolean isHidden()

isInLayout

final boolean isInLayout()

isMenuVisible

final boolean isMenuVisible()

isRemoving

final boolean isRemoving()

isResumed

final boolean isResumed()

isStateSaved

final boolean isStateSaved()

isVisible

final boolean isVisible()

onActivityCreated

void onActivityCreated(Bundle savedInstanceState)

onActivityResult

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

onAttach

void onAttach(Context context)

onAttachFragment

void onAttachFragment(Fragment childFragment)

onConfigurationChanged

void onConfigurationChanged(Configuration newConfig)

onContextItemSelected

boolean onContextItemSelected(MenuItem item)

onCreate

void onCreate(Bundle savedInstanceState)

Internal use only.

onCreateAnimation

Animation onCreateAnimation(int transit, boolean enter, int nextAnim)

onCreateAnimator

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

onCreateContextMenu

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

onCreateOptionsMenu

void onCreateOptionsMenu(Menu menu, MenuInflater inflater)

onCreateView

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

onDeleteDocument

void onDeleteDocument(@NonNull() ImageDocument document)

onDestroy

void onDestroy()

onDestroyOptionsMenu

void onDestroyOptionsMenu()

onDestroyView

void onDestroyView()

onDetach

void onDetach()

onGetLayoutInflater

LayoutInflater onGetLayoutInflater(Bundle savedInstanceState)

onHiddenChanged

void onHiddenChanged(boolean hidden)

onInflate

void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)

onLowMemory

void onLowMemory()

onMultiWindowModeChanged

void onMultiWindowModeChanged(boolean isInMultiWindowMode)

onOptionsItemSelected

boolean onOptionsItemSelected(MenuItem item)

onOptionsMenuClosed

void onOptionsMenuClosed(Menu menu)

onPause

void onPause()

onPictureInPictureModeChanged

void onPictureInPictureModeChanged(boolean isInPictureInPictureMode)

onPrepareOptionsMenu

void onPrepareOptionsMenu(Menu menu)

onPrimaryNavigationFragmentChanged

void onPrimaryNavigationFragmentChanged(boolean isPrimaryNavigationFragment)

onRequestPermissionsResult

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

onResume

void onResume()

onRetryUpload

void onRetryUpload(@NonNull() ImageDocument document)

onSaveInstanceState

void onSaveInstanceState(Bundle outState)

onStart

void onStart()

onStop

void onStop()

onViewCreated

void onViewCreated(View view, Bundle savedInstanceState)

onViewStateRestored

void onViewStateRestored(Bundle savedInstanceState)

postponeEnterTransition

void postponeEnterTransition()

registerForActivityResult

final ActivityResultLauncher<I> registerForActivityResult<I, O>(ActivityResultContract<I, O> contract, ActivityResultCallback<O> callback)

registerForContextMenu

void registerForContextMenu(View view)

requestPermissions

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

requireActivity

final FragmentActivity requireActivity()

requireArguments

final Bundle requireArguments()

requireContext

final Context requireContext()

requireFragmentManager

final FragmentManager requireFragmentManager()

requireHost

final Object requireHost()

requireParentFragment

final Fragment requireParentFragment()

requireView

final View requireView()

setAllowEnterTransitionOverlap

void setAllowEnterTransitionOverlap(boolean allow)

setAllowReturnTransitionOverlap

void setAllowReturnTransitionOverlap(boolean allow)

setArguments

void setArguments(Bundle args)

setEnterSharedElementCallback

void setEnterSharedElementCallback(SharedElementCallback callback)

setEnterTransition

void setEnterTransition(Object transition)

setExitSharedElementCallback

void setExitSharedElementCallback(SharedElementCallback callback)

setExitTransition

void setExitTransition(Object transition)

setHasOptionsMenu

void setHasOptionsMenu(boolean hasMenu)

setInitialSavedState

void setInitialSavedState(Fragment.SavedState state)

setListener

void setListener(@NonNull() MultiPageReviewFragmentListener listener)

Set a listener for multi-page review events.

setMenuVisibility

void setMenuVisibility(boolean menuVisible)

setReenterTransition

void setReenterTransition(Object transition)

setRetainInstance

void setRetainInstance(boolean retain)

setReturnTransition

void setReturnTransition(Object transition)

setSharedElementEnterTransition

void setSharedElementEnterTransition(Object transition)

setSharedElementReturnTransition

void setSharedElementReturnTransition(Object transition)

setTargetFragment

void setTargetFragment(Fragment fragment, int requestCode)

setUserVisibleHint

void setUserVisibleHint(boolean isVisibleToUser)

shouldShowRequestPermissionRationale

boolean shouldShowRequestPermissionRationale(String permission)

showAlertDialog

void showAlertDialog(@NonNull() String message, @NonNull() String positiveButtonTitle, @NonNull() DialogInterface.OnClickListener positiveButtonClickListener, @Nullable() String negativeButtonTitle, @Nullable() DialogInterface.OnClickListener negativeButtonClickListener, @Nullable() DialogInterface.OnCancelListener cancelListener)

startActivity

void startActivity(Intent intent)

abstract void startActivity(Intent intent)

startActivityForResult

void startActivityForResult(Intent intent, int requestCode)

abstract void startActivityForResult(Intent intent, int requestCode)

startIntentSenderForResult

void startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)

startPostponedEnterTransition

void startPostponedEnterTransition()

toString

String toString()

unregisterForContextMenu

void unregisterForContextMenu(View view)