CameraFragmentCompat

public class CameraFragmentCompat extends Fragment implements CameraFragmentInterface, FragmentImplCallback

Component API

CameraFragmentCompat is the main entry point to the Gini Vision Library when using the Component API with the Android Support Library.

It shows a camera preview with tap-to-focus functionality, a trigger button and an optional flash on/off button. The camera preview also shows document corner guides to which the user should align the document.

If instantiated with createInstance then a button for importing documents is shown next to the trigger button. A hint popup is displayed the first time the Gini Vision Library is used to inform the user about document importing.

For importing documents READ_EXTERNAL_STORAGE permission is required and if the permission is not granted the Gini Vision Library will prompt the user to grant the permission. See @{code Customizing the Camera Screen} on how to override the message and button titles for the rationale and on permission denial alerts.

Note: Your Activity hosting this Fragment must extend the and use an AppCompat Theme.

Include the CameraFragmentCompat into your layout either directly with <fragment> in your Activity's layout or using the androidx.fragment.app.FragmentManager and one of the createInstance() methods.

A CameraFragmentListener instance must be available until the CameraFragmentCompat 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 CameraFragmentListener interface or explicitly by setting the listener using setListener.

Your Activity is automatically set as the listener in onAttach.

Customizing the Camera Screen

See the CameraActivity for details.

Functions

createInstance

static CameraFragmentCompat createInstance()

static CameraFragmentCompat createInstance(@NonNull() GiniVisionFeatureConfiguration giniVisionFeatureConfiguration)

Factory method for creating a new instance of the Fragment with document import enabled for the specified file types.

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()

hideActivityIndicatorAndEnableInteraction

void hideActivityIndicatorAndEnableInteraction()

Call this method to hide the activity indicator and enable user interaction.

hideCameraTriggerButton

@Deprecated()

~~void~~ ~~hideCameraTriggerButton~~()

Call this method to hide the camera trigger button.

hideDocumentCornerGuides

@Deprecated()

~~void~~ ~~hideDocumentCornerGuides~~()

Call this method to hide the document corner guides.

hideInterface

void hideInterface()

Call this method to hide the interface elements.

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

@Nullable()

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

Internal use only.

onDestroy

void onDestroy()

Internal use only.

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()

Internal use only.

onSaveInstanceState

void onSaveInstanceState(@NonNull() Bundle outState)

Internal use only.

onStart

void onStart()

Internal use only.

onStop

void onStop()

Internal use only.

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() CameraFragmentListener listener)

Set a listener for camera 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)

showActivityIndicatorAndDisableInteraction

void showActivityIndicatorAndDisableInteraction()

Call this method to show an activity indicator and disable user interaction.

showAlertDialog

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

showCameraTriggerButton

@Deprecated()

~~void~~ ~~showCameraTriggerButton~~()

Call this method to show the camera trigger button.

showDocumentCornerGuides

@Deprecated()

~~void~~ ~~showDocumentCornerGuides~~()

Call this method to show the document corner guides.

showError

void showError(@NonNull() String message, int duration)

Call this method to show an error message to the user in the Camera Screen.

showInterface

void showInterface()

Call this method to show the interface elements.

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)