ginivision/net.gini.android.vision.camera/CameraFragmentStandard

CameraFragmentStandard

Component API

{@code CameraFragmentStandard} is the main entry point to the Gini Vision Library when using the Component API without 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 {@code 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.

Include the {@code CameraFragmentStandard} into your layout either directly with {@code } in your Activity's layout or using the android.app.FragmentManager and one of the {@code createInstance()} methods.

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

public class CameraFragmentStandard extends Fragment implements CameraFragmentInterface, FragmentImplCallback

Functions

createInstance

androidJvm

static CameraFragmentStandard createInstance()

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

static CameraFragmentStandard createInstance(GiniVisionFeatureConfiguration giniVisionFeatureConfiguration)

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

hashCode

androidJvm

final int hashCode()

hideActivityIndicatorAndEnableInteraction

androidJvm

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

void hideActivityIndicatorAndEnableInteraction()

hideCameraTriggerButton

androidJvm

Call this method to hide the camera trigger button.

Note: the camera trigger button is shown by default.

@Deprecated()

void hideCameraTriggerButton()

hideDocumentCornerGuides

androidJvm

Call this method to hide the document corner guides.

Note: the document corner guides are shown by default.

@Deprecated()

void hideDocumentCornerGuides()

hideInterface

androidJvm

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

Note: the interface elements are shown by default.

void hideInterface()

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)

Internal use only.

void onAttach(Activity activity)

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)

Internal use only.

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)

Internal use only.

@Nullable()

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

onDestroy

androidJvm

void onDestroy()

Internal use only.

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

Internal use only.

void onResume()

onSaveInstanceState

androidJvm

void onSaveInstanceState(Bundle outState)

Internal use only.

void onSaveInstanceState(Bundle outState)

onStart

androidJvm

void onStart()

Internal use only.

void onStart()

onStop

androidJvm

void onStop()

Internal use only.

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