ginicapture/net.gini.android.capture.camera/CameraFragmentCompat

CameraFragmentCompat

Component API

{@code CameraFragmentCompat} is the main entry point to the Gini Capture SDK 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 then a button for importing documents is shown next to the trigger button. A hint popup is displayed the first time the Gini Capture SDK is used to inform the user about document importing.

For importing documents {@code READ_EXTERNAL_STORAGE} permission is required and if the permission is not granted the Gini Capture SDK 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 {@code CameraFragmentCompat} into your layout either directly with {@code } in your Activity's layout or using the androidx.fragment.app.FragmentManager and one of the {@code createInstance()} methods.

A CameraFragmentListener instance must be available until the {@code * 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 .

Your Activity is automatically set as the listener in onAttach .

Customizing the Camera Screen

See the CameraActivity for details.

public class CameraFragmentCompat extends Fragment implements CameraFragmentInterface, FragmentImplCallback
Content copied to clipboard

Functions

callStartTransitionListener
Link copied to clipboard
void callStartTransitionListener()
Content copied to clipboard
createInstance
Link copied to clipboard
static CameraFragmentCompat createInstance()
Content copied to clipboard
dump
Link copied to clipboard
void dump(String prefix, FileDescriptor fd, PrintWriter writer, Array<String> args)
Content copied to clipboard
ensureAnimationInfo
Link copied to clipboard
Fragment.AnimationInfo ensureAnimationInfo()
Content copied to clipboard
equals
Link copied to clipboard
final boolean equals(Object o)
Content copied to clipboard
findFragmentByWho
Link copied to clipboard
Fragment findFragmentByWho(String who)
Content copied to clipboard
getActivity
Link copied to clipboard
final FragmentActivity getActivity()
Content copied to clipboard
@Nullable()
abstract Activity getActivity()
Content copied to clipboard
getAllowEnterTransitionOverlap
Link copied to clipboard
boolean getAllowEnterTransitionOverlap()
Content copied to clipboard
getAllowReturnTransitionOverlap
Link copied to clipboard
boolean getAllowReturnTransitionOverlap()
Content copied to clipboard
getAnimatingAway
Link copied to clipboard
View getAnimatingAway()
Content copied to clipboard
getAnimator
Link copied to clipboard
Animator getAnimator()
Content copied to clipboard
getArguments
Link copied to clipboard
final Bundle getArguments()
Content copied to clipboard
getChildFragmentManager
Link copied to clipboard
final FragmentManager getChildFragmentManager()
Content copied to clipboard
getContext
Link copied to clipboard
Context getContext()
Content copied to clipboard
getDefaultViewModelProviderFactory
Link copied to clipboard
ViewModelProvider.Factory getDefaultViewModelProviderFactory()
Content copied to clipboard
getEnterTransition
Link copied to clipboard
Object getEnterTransition()
Content copied to clipboard
getEnterTransitionCallback
Link copied to clipboard
SharedElementCallback getEnterTransitionCallback()
Content copied to clipboard
getExitTransition
Link copied to clipboard
Object getExitTransition()
Content copied to clipboard
getExitTransitionCallback
Link copied to clipboard
SharedElementCallback getExitTransitionCallback()
Content copied to clipboard
getFragmentManager
Link copied to clipboard
final FragmentManager getFragmentManager()
Content copied to clipboard
getHost
Link copied to clipboard
final Object getHost()
Content copied to clipboard
getId
Link copied to clipboard
final int getId()
Content copied to clipboard
getLayoutInflater
Link copied to clipboard
final LayoutInflater getLayoutInflater()
Content copied to clipboard
getLifecycle
Link copied to clipboard
Lifecycle getLifecycle()
Content copied to clipboard
getLoaderManager
Link copied to clipboard
LoaderManager getLoaderManager()
Content copied to clipboard
getNextAnim
Link copied to clipboard
int getNextAnim()
Content copied to clipboard
getNextTransition
Link copied to clipboard
int getNextTransition()
Content copied to clipboard
getParentFragment
Link copied to clipboard
final Fragment getParentFragment()
Content copied to clipboard
getParentFragmentManager
Link copied to clipboard
final FragmentManager getParentFragmentManager()
Content copied to clipboard
getReenterTransition
Link copied to clipboard
Object getReenterTransition()
Content copied to clipboard
getResources
Link copied to clipboard
final Resources getResources()
Content copied to clipboard
getRetainInstance
Link copied to clipboard
final boolean getRetainInstance()
Content copied to clipboard
getReturnTransition
Link copied to clipboard
Object getReturnTransition()
Content copied to clipboard
getSavedStateRegistry
Link copied to clipboard
final SavedStateRegistry getSavedStateRegistry()
Content copied to clipboard
getSharedElementEnterTransition
Link copied to clipboard
Object getSharedElementEnterTransition()
Content copied to clipboard
getSharedElementReturnTransition
Link copied to clipboard
Object getSharedElementReturnTransition()
Content copied to clipboard
getStateAfterAnimating
Link copied to clipboard
int getStateAfterAnimating()
Content copied to clipboard
getString
Link copied to clipboard
final String getString(int resId)
Content copied to clipboard
getTag
Link copied to clipboard
final String getTag()
Content copied to clipboard
getTargetFragment
Link copied to clipboard
final Fragment getTargetFragment()
Content copied to clipboard
getTargetRequestCode
Link copied to clipboard
final int getTargetRequestCode()
Content copied to clipboard
getText
Link copied to clipboard
final CharSequence getText(int resId)
Content copied to clipboard
getUserVisibleHint
Link copied to clipboard
boolean getUserVisibleHint()
Content copied to clipboard
getView
Link copied to clipboard
View getView()
Content copied to clipboard
@Nullable()
abstract View getView()
Content copied to clipboard
getViewLifecycleOwner
Link copied to clipboard
LifecycleOwner getViewLifecycleOwner()
Content copied to clipboard
getViewLifecycleOwnerLiveData
Link copied to clipboard
LiveData<LifecycleOwner> getViewLifecycleOwnerLiveData()
Content copied to clipboard
getViewModelStore
Link copied to clipboard
ViewModelStore getViewModelStore()
Content copied to clipboard
hashCode
Link copied to clipboard
final int hashCode()
Content copied to clipboard
hasOptionsMenu
Link copied to clipboard
final boolean hasOptionsMenu()
Content copied to clipboard
hideActivityIndicatorAndEnableInteraction
Link copied to clipboard

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

void hideActivityIndicatorAndEnableInteraction()
Content copied to clipboard
hideInterface
Link copied to clipboard

Call this method to hide the interface elements. The camera preview remains visible.

Note: the interface elements are shown by default.

void hideInterface()
Content copied to clipboard
initLifecycle
Link copied to clipboard
void initLifecycle()
Content copied to clipboard
initState
Link copied to clipboard
void initState()
Content copied to clipboard
instantiate
Link copied to clipboard
static Fragment instantiate(Context context, String fname)
Content copied to clipboard
isAdded
Link copied to clipboard
final boolean isAdded()
Content copied to clipboard
isDetached
Link copied to clipboard
final boolean isDetached()
Content copied to clipboard
isHidden
Link copied to clipboard
final boolean isHidden()
Content copied to clipboard
isHideReplaced
Link copied to clipboard
boolean isHideReplaced()
Content copied to clipboard
isInBackStack
Link copied to clipboard
final boolean isInBackStack()
Content copied to clipboard
isInLayout
Link copied to clipboard
final boolean isInLayout()
Content copied to clipboard
isMenuVisible
Link copied to clipboard
final boolean isMenuVisible()
Content copied to clipboard
isPostponed
Link copied to clipboard
boolean isPostponed()
Content copied to clipboard
isRemoving
Link copied to clipboard
final boolean isRemoving()
Content copied to clipboard
isRemovingParent
Link copied to clipboard
final boolean isRemovingParent()
Content copied to clipboard
isResumed
Link copied to clipboard
final boolean isResumed()
Content copied to clipboard
isStateSaved
Link copied to clipboard
final boolean isStateSaved()
Content copied to clipboard
isVisible
Link copied to clipboard
final boolean isVisible()
Content copied to clipboard
noteStateNotSaved
Link copied to clipboard
void noteStateNotSaved()
Content copied to clipboard
onActivityCreated
Link copied to clipboard
void onActivityCreated(Bundle savedInstanceState)
Content copied to clipboard
onActivityResult
Link copied to clipboard
void onActivityResult(int requestCode, int resultCode, Intent data)
Content copied to clipboard
void onActivityResult(int requestCode, int resultCode, Intent data)
Content copied to clipboard
onAttach
Link copied to clipboard
void onAttach(Context context)
Content copied to clipboard
onAttachFragment
Link copied to clipboard
void onAttachFragment(Fragment childFragment)
Content copied to clipboard
onConfigurationChanged
Link copied to clipboard
void onConfigurationChanged(Configuration newConfig)
Content copied to clipboard
onContextItemSelected
Link copied to clipboard
boolean onContextItemSelected(MenuItem item)
Content copied to clipboard
onCreate
Link copied to clipboard
void onCreate(Bundle savedInstanceState)
Content copied to clipboard

Internal use only.

void onCreate(Bundle savedInstanceState)
Content copied to clipboard
onCreateAnimation
Link copied to clipboard
Animation onCreateAnimation(int transit, boolean enter, int nextAnim)
Content copied to clipboard
onCreateAnimator
Link copied to clipboard
Animator onCreateAnimator(int transit, boolean enter, int nextAnim)
Content copied to clipboard
onCreateContextMenu
Link copied to clipboard
void onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)
Content copied to clipboard
onCreateOptionsMenu
Link copied to clipboard
void onCreateOptionsMenu(Menu menu, MenuInflater inflater)
Content copied to clipboard
onCreateView
Link copied to clipboard
View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
Content copied to clipboard

Internal use only.

@Nullable()
View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
Content copied to clipboard
onDestroy
Link copied to clipboard
void onDestroy()
Content copied to clipboard

Internal use only.

void onDestroy()
Content copied to clipboard
onDestroyOptionsMenu
Link copied to clipboard
void onDestroyOptionsMenu()
Content copied to clipboard
onDestroyView
Link copied to clipboard
void onDestroyView()
Content copied to clipboard
onDetach
Link copied to clipboard
void onDetach()
Content copied to clipboard
onGetLayoutInflater
Link copied to clipboard
LayoutInflater onGetLayoutInflater(Bundle savedInstanceState)
Content copied to clipboard
onHiddenChanged
Link copied to clipboard
void onHiddenChanged(boolean hidden)
Content copied to clipboard
onInflate
Link copied to clipboard
void onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)
Content copied to clipboard
onLowMemory
Link copied to clipboard
void onLowMemory()
Content copied to clipboard
onMultiWindowModeChanged
Link copied to clipboard
void onMultiWindowModeChanged(boolean isInMultiWindowMode)
Content copied to clipboard
onOptionsItemSelected
Link copied to clipboard
boolean onOptionsItemSelected(MenuItem item)
Content copied to clipboard
onOptionsMenuClosed
Link copied to clipboard
void onOptionsMenuClosed(Menu menu)
Content copied to clipboard
onPause
Link copied to clipboard
void onPause()
Content copied to clipboard
onPictureInPictureModeChanged
Link copied to clipboard
void onPictureInPictureModeChanged(boolean isInPictureInPictureMode)
Content copied to clipboard
onPrepareOptionsMenu
Link copied to clipboard
void onPrepareOptionsMenu(Menu menu)
Content copied to clipboard
onPrimaryNavigationFragmentChanged
Link copied to clipboard
void onPrimaryNavigationFragmentChanged(boolean isPrimaryNavigationFragment)
Content copied to clipboard
onRequestPermissionsResult
Link copied to clipboard
void onRequestPermissionsResult(int requestCode, Array<String> permissions, Array<int> grantResults)
Content copied to clipboard
onResume
Link copied to clipboard
void onResume()
Content copied to clipboard

Internal use only.

void onResume()
Content copied to clipboard
onSaveInstanceState
Link copied to clipboard
void onSaveInstanceState(Bundle outState)
Content copied to clipboard

Internal use only.

void onSaveInstanceState(Bundle outState)
Content copied to clipboard
onStart
Link copied to clipboard
void onStart()
Content copied to clipboard

Internal use only.

void onStart()
Content copied to clipboard
onStop
Link copied to clipboard
void onStop()
Content copied to clipboard

Internal use only.

void onStop()
Content copied to clipboard
onViewCreated
Link copied to clipboard
void onViewCreated(View view, Bundle savedInstanceState)
Content copied to clipboard
onViewStateRestored
Link copied to clipboard
void onViewStateRestored(Bundle savedInstanceState)
Content copied to clipboard
performActivityCreated
Link copied to clipboard
void performActivityCreated(Bundle savedInstanceState)
Content copied to clipboard
performAttach
Link copied to clipboard
void performAttach()
Content copied to clipboard
performConfigurationChanged
Link copied to clipboard
void performConfigurationChanged(Configuration newConfig)
Content copied to clipboard
performContextItemSelected
Link copied to clipboard
boolean performContextItemSelected(MenuItem item)
Content copied to clipboard
performCreate
Link copied to clipboard
void performCreate(Bundle savedInstanceState)
Content copied to clipboard
performCreateOptionsMenu
Link copied to clipboard
boolean performCreateOptionsMenu(Menu menu, MenuInflater inflater)
Content copied to clipboard
performCreateView
Link copied to clipboard
void performCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
Content copied to clipboard
performDestroy
Link copied to clipboard
void performDestroy()
Content copied to clipboard
performDestroyView
Link copied to clipboard
void performDestroyView()
Content copied to clipboard
performDetach
Link copied to clipboard
void performDetach()
Content copied to clipboard
performGetLayoutInflater
Link copied to clipboard
LayoutInflater performGetLayoutInflater(Bundle savedInstanceState)
Content copied to clipboard
performLowMemory
Link copied to clipboard
void performLowMemory()
Content copied to clipboard
performMultiWindowModeChanged
Link copied to clipboard
void performMultiWindowModeChanged(boolean isInMultiWindowMode)
Content copied to clipboard
performOptionsItemSelected
Link copied to clipboard
boolean performOptionsItemSelected(MenuItem item)
Content copied to clipboard
performOptionsMenuClosed
Link copied to clipboard
void performOptionsMenuClosed(Menu menu)
Content copied to clipboard
performPause
Link copied to clipboard
void performPause()
Content copied to clipboard
performPictureInPictureModeChanged
Link copied to clipboard
void performPictureInPictureModeChanged(boolean isInPictureInPictureMode)
Content copied to clipboard
performPrepareOptionsMenu
Link copied to clipboard
boolean performPrepareOptionsMenu(Menu menu)
Content copied to clipboard
performPrimaryNavigationFragmentChanged
Link copied to clipboard
void performPrimaryNavigationFragmentChanged()
Content copied to clipboard
performResume
Link copied to clipboard
void performResume()
Content copied to clipboard
performSaveInstanceState
Link copied to clipboard
void performSaveInstanceState(Bundle outState)
Content copied to clipboard
performStart
Link copied to clipboard
void performStart()
Content copied to clipboard
performStop
Link copied to clipboard
void performStop()
Content copied to clipboard
postponeEnterTransition
Link copied to clipboard
void postponeEnterTransition()
Content copied to clipboard
registerForContextMenu
Link copied to clipboard
void registerForContextMenu(View view)
Content copied to clipboard
requestPermissions
Link copied to clipboard
final void requestPermissions(Array<String> permissions, int requestCode)
Content copied to clipboard
requireActivity
Link copied to clipboard
final FragmentActivity requireActivity()
Content copied to clipboard
requireArguments
Link copied to clipboard
final Bundle requireArguments()
Content copied to clipboard
requireContext
Link copied to clipboard
final Context requireContext()
Content copied to clipboard
requireFragmentManager
Link copied to clipboard
final FragmentManager requireFragmentManager()
Content copied to clipboard
requireHost
Link copied to clipboard
final Object requireHost()
Content copied to clipboard
requireParentFragment
Link copied to clipboard
final Fragment requireParentFragment()
Content copied to clipboard
requireView
Link copied to clipboard
final View requireView()
Content copied to clipboard
restoreChildFragmentState
Link copied to clipboard
void restoreChildFragmentState(Bundle savedInstanceState)
Content copied to clipboard
restoreViewState
Link copied to clipboard
final void restoreViewState(Bundle savedInstanceState)
Content copied to clipboard
setAllowEnterTransitionOverlap
Link copied to clipboard
void setAllowEnterTransitionOverlap(boolean allow)
Content copied to clipboard
setAllowReturnTransitionOverlap
Link copied to clipboard
void setAllowReturnTransitionOverlap(boolean allow)
Content copied to clipboard
setAnimatingAway
Link copied to clipboard
void setAnimatingAway(View view)
Content copied to clipboard
setAnimator
Link copied to clipboard
void setAnimator(Animator animator)
Content copied to clipboard
setArguments
Link copied to clipboard
void setArguments(Bundle args)
Content copied to clipboard
setEnterSharedElementCallback
Link copied to clipboard
void setEnterSharedElementCallback(SharedElementCallback callback)
Content copied to clipboard
setEnterTransition
Link copied to clipboard
void setEnterTransition(Object transition)
Content copied to clipboard
setExitSharedElementCallback
Link copied to clipboard
void setExitSharedElementCallback(SharedElementCallback callback)
Content copied to clipboard
setExitTransition
Link copied to clipboard
void setExitTransition(Object transition)
Content copied to clipboard
setHasOptionsMenu
Link copied to clipboard
void setHasOptionsMenu(boolean hasMenu)
Content copied to clipboard
setHideReplaced
Link copied to clipboard
void setHideReplaced(boolean replaced)
Content copied to clipboard
setInitialSavedState
Link copied to clipboard
void setInitialSavedState(Fragment.SavedState state)
Content copied to clipboard
setListener
Link copied to clipboard

Set a listener for camera events.

By default the hosting Activity is expected to implement the CameraFragmentListener . 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(CameraFragmentListener listener)
Content copied to clipboard
setMenuVisibility
Link copied to clipboard
void setMenuVisibility(boolean menuVisible)
Content copied to clipboard
setNextAnim
Link copied to clipboard
void setNextAnim(int animResourceId)
Content copied to clipboard
setNextTransition
Link copied to clipboard
void setNextTransition(int nextTransition)
Content copied to clipboard
setOnStartEnterTransitionListener
Link copied to clipboard
void setOnStartEnterTransitionListener(Fragment.OnStartEnterTransitionListener listener)
Content copied to clipboard
setReenterTransition
Link copied to clipboard
void setReenterTransition(Object transition)
Content copied to clipboard
setRetainInstance
Link copied to clipboard
void setRetainInstance(boolean retain)
Content copied to clipboard
setReturnTransition
Link copied to clipboard
void setReturnTransition(Object transition)
Content copied to clipboard
setSharedElementEnterTransition
Link copied to clipboard
void setSharedElementEnterTransition(Object transition)
Content copied to clipboard
setSharedElementReturnTransition
Link copied to clipboard
void setSharedElementReturnTransition(Object transition)
Content copied to clipboard
setStateAfterAnimating
Link copied to clipboard
void setStateAfterAnimating(int state)
Content copied to clipboard
setTargetFragment
Link copied to clipboard
void setTargetFragment(Fragment fragment, int requestCode)
Content copied to clipboard
setUserVisibleHint
Link copied to clipboard
void setUserVisibleHint(boolean isVisibleToUser)
Content copied to clipboard
shouldShowRequestPermissionRationale
Link copied to clipboard
boolean shouldShowRequestPermissionRationale(String permission)
Content copied to clipboard
showActivityIndicatorAndDisableInteraction
Link copied to clipboard

Call this method to show an activity indicator and disable user interaction. The camera preview remains visible.

void showActivityIndicatorAndDisableInteraction()
Content copied to clipboard
showAlertDialog
Link copied to clipboard
void showAlertDialog(String message, String positiveButtonTitle, DialogInterface.OnClickListener positiveButtonClickListener, String negativeButtonTitle, DialogInterface.OnClickListener negativeButtonClickListener, DialogInterface.OnCancelListener cancelListener)
Content copied to clipboard
showError
Link copied to clipboard

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

void showError(String message, int duration)
Content copied to clipboard
abstract void showError(String message, int duration)
Content copied to clipboard
showInterface
Link copied to clipboard

Call this method to show the interface elements. The camera preview is always visible.

Note: the interface elements are shown by default.

void showInterface()
Content copied to clipboard
startActivity
Link copied to clipboard
void startActivity(Intent intent)
Content copied to clipboard
abstract void startActivity(Intent intent)
Content copied to clipboard
startActivityForResult
Link copied to clipboard
void startActivityForResult(Intent intent, int requestCode)
Content copied to clipboard
abstract void startActivityForResult(Intent intent, int requestCode)
Content copied to clipboard
startIntentSenderForResult
Link copied to clipboard
void startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)
Content copied to clipboard
startPostponedEnterTransition
Link copied to clipboard
void startPostponedEnterTransition()
Content copied to clipboard
toString
Link copied to clipboard
String toString()
Content copied to clipboard
unregisterForContextMenu
Link copied to clipboard
void unregisterForContextMenu(View view)
Content copied to clipboard
© 2020 CopyrightSponsored and developed by dokka