Package 

Class MultiPageReviewActivity

  • All Implemented Interfaces:
    android.content.ComponentCallbacks , android.content.ComponentCallbacks2 , android.view.KeyEvent.Callback , android.view.LayoutInflater.Factory , android.view.LayoutInflater.Factory2 , android.view.View.OnCreateContextMenuListener , android.view.Window.Callback , androidx.activity.OnBackPressedDispatcherOwner , androidx.activity.contextaware.ContextAware , androidx.activity.result.ActivityResultCaller , androidx.activity.result.ActivityResultRegistryOwner , androidx.appcompat.app.ActionBarDrawerToggle.DelegateProvider , androidx.appcompat.app.AppCompatCallback , androidx.core.app.ActivityCompat.OnRequestPermissionsResultCallback , androidx.core.app.ActivityCompat.RequestPermissionsRequestCodeValidator , androidx.core.app.OnMultiWindowModeChangedProvider , androidx.core.app.OnNewIntentProvider , androidx.core.app.OnPictureInPictureModeChangedProvider , androidx.core.app.TaskStackBuilder.SupportParentable , androidx.core.content.OnConfigurationChangedProvider , androidx.core.content.OnTrimMemoryProvider , androidx.core.view.KeyEventDispatcher.Component , androidx.core.view.MenuHost , androidx.lifecycle.HasDefaultViewModelProviderFactory , androidx.lifecycle.LifecycleOwner , androidx.lifecycle.ViewModelStoreOwner , androidx.savedstate.SavedStateRegistryOwner , net.gini.android.capture.review.multipage.MultiPageReviewFragmentListener 
    
public class MultiPageReviewActivity
extends AppCompatActivity implements MultiPageReviewFragmentListener
    When you use the Screen API and have enabled the multi-page feature, the MultiPageReviewActivity 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.

    If multi-page has been enabled then the MultiPageReviewActivity is started by the CameraActivity after the user has taken the first photo or imported the first image of a document. For subsequent images the user has to tap on the image stack in the Camera Screen to launch it.

    Important: A GiniCapture instance is required to use the MultiPageReviewActivity

    Customizing the look of the Review Screen is done via overriding of app resources.

    The following items are customizable:

    • Page indicator text style: via overriding the style named GiniCaptureTheme.Review.MultiPage.PageIndicator.TextStyle
    • Page indicator font: via overriding the style named GiniCaptureTheme.Review.MultiPage.PageIndicator.TextStyle and setting an item named gcCustomFont with the path to the font file in your assets folder
    • Page indicator background color: via the color resource named gc_multi_page_review_page_indicator_background
    • Next button icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gc_review_fab_checkmark.png
    • Next button color: via the color resources named gc_review_fab and gc_review_fab_pressed
    • Thumbnails panel background color: via the color resource named gc_multi_page_review_thumbnails_panel_background
    • Thumbnail card background color: via the color resource named gc_multi_page_review_thumbnail_card_background
    • Thumbnail badge text style: via overriding the style named GiniCaptureTheme.Review.MultiPage.ThumbnailBadge.TextStyle
    • Thumbnail badge font: via overriding the style named GiniCaptureTheme.Review.MultiPage.ThumbnailBadge.TextStyle and setting an item named gcCustomFont with the path to the font file in your assets folder
    • Thumbnail badge background border color: via the color resource named gc_multi_page_thumbnail_badge_background_border
    • Thumbnail drag indicator bumps icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gc_bumps_icon.png
    • Thumbnail highlight strip color: via the color resource named gc_multi_page_thumbnail_highlight_strip
    • Thumbnail activity indicator color: via the color resource named gc_analysis_activity_indicator
    • Thumbnail upload success background circle color: via the color resource named gc_multi_page_thumbnail_upload_success_icon_background
    • Thumbnail upload success foreground tick color: via the color resource named gc_multi_page_thumbnail_upload_success_icon_foreground
    • Thumbnail upload failure background circle color: via the color resource named gc_multi_page_thumbnail_upload_failure_icon_background
    • Thumbnail upload failure foreground cross color: via the color resource named gc_multi_page_thumbnail_upload_failure_icon_foreground
    • Add page icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gc_multi_page_add_page_icon.png
    • Add page icon subtitle text: via the string resource named gc_multi_page_review_add_pages_subtitle
    • Add page icon subtitle text style: via overriding the style named GiniCaptureTheme.Review.MultiPage.AddPagesSubtitle.TextStyle
    • Add page icon subtitle font: via overriding the style named GiniCaptureTheme.Review.MultiPage.AddPagesSubtitle.TextStyle and setting an item named gcCustomFont with the path to the font file in your assets folder
    • Reorder pages tip text: via the string resource named gc_multi_page_review_reorder_pages_tip
    • Reorder pages tip text style: via overriding the style named GiniCaptureTheme.Review.MultiPage.ReorderPagesTip.TextStyle
    • Reorder pages tip font: via overriding the style named GiniCaptureTheme.Review.MultiPage.ReorderPagesTip.TextStyle and setting an item named gcCustomFont with the path to the font file in your assets folder
    • Rotate icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gc_rotate_icon.png
    • Delete icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gc_delete_icon.png
    • Image error message text style: via overriding the style named GiniCaptureTheme.Snackbar.Error.TextStyle and setting an item named android:textStyle to normal, bold or italic
    • Image error message font: via overriding the style named GiniCaptureTheme.Snackbar.Error.TextStyle and setting an item named gcCustomFont with the path to the font file in your assets folder
    • Image error message button text style: via overriding the style named GiniCaptureTheme.Snackbar.Error.Button.TextStyle and setting an item named android:textStyle to normal, bold or italic
    • Image error message button font: via overriding the style named GiniCaptureTheme.Snackbar.Error.Button.TextStyle and setting an item named gcCustomFont with the path to the font file in your assets folder
    • Image error message background color: via the color resource named gc_snackbar_error_background
    • Image analysis error message retry button text: via the string resource named gc_document_analysis_error_retry
    • Imported image error message delete button text: via the string resource named gc_multi_page_review_delete_invalid_document
    • Imported image delete last page dialog message: via the string resource named gc_multi_page_review_file_import_delete_last_page_dialog_message
    • Imported image delete last page dialog positive button text: via the string resource named gc_multi_page_review_file_import_delete_last_page_dialog_positive_button
    • Imported image delete last page dialog negative button text: via the string resource named gc_multi_page_review_file_import_delete_last_page_dialog_negative_button
    • Imported image delete last page dialog button color: via the color resource named gc_accent

    Important: All overridden styles must have their respective Root. prefixed style as their parent. Ex.: the parent of GiniCaptureTheme.Review.BottomPanel.TextStyle must be Root.GiniCaptureTheme.Review.BottomPanel.TextStyle.

    Customizing the Action Bar is also done via overriding of app resources and each one - except the title string resource - is global to all Activities (CameraActivity, , ReviewActivity, MultiPageReviewActivity, ).

    The following items are customizable:

    • Background color: via the color resource named gc_action_bar (highly recommended for Android 5+: customize the status bar color via gc_status_bar)
    • Title: via the string resource named gc_title_multi_page_review
    • Title color: via the color resource named gc_action_bar_title
    • Back button (only for ReviewActivity, MultiPageReviewActivity and ): via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gc_action_bar_back

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      static Intent createIntent(@NonNull() Context context)
      boolean onOptionsItemSelected(MenuItem item)
      void onProceedToAnalysisScreen(@NonNull() GiniCaptureMultiPageDocument multiPageDocument) Called when all pages were uploaded successfully and the user tapped on the "next" button.
      void onReturnToCameraScreen() Called when the user wants to add a picture of another page.
      void onImportedDocumentReviewCancelled() Called when the user deleted all the pages of a document received from another app.
      void onError(@NonNull() GiniCaptureError error) Called when an error occurred.

      • Methods inherited from class androidx.appcompat.app.AppCompatActivity

        addContentView, closeOptionsMenu, dispatchKeyEvent, findViewById, getDelegate, getDrawerToggleDelegate, getMenuInflater, getResources, getSupportActionBar, getSupportParentActivityIntent, invalidateOptionsMenu, onConfigurationChanged, onContentChanged, onCreateSupportNavigateUpTaskStack, onKeyDown, onMenuItemSelected, onMenuOpened, onPanelClosed, onPrepareSupportNavigateUpTaskStack, onSupportActionModeFinished, onSupportActionModeStarted, onSupportContentChanged, onSupportNavigateUp, onWindowStartingSupportActionMode, openOptionsMenu, setContentView, setSupportActionBar, setSupportProgress, setSupportProgressBarIndeterminate, setSupportProgressBarIndeterminateVisibility, setSupportProgressBarVisibility, setTheme, startSupportActionMode, supportInvalidateOptionsMenu, supportNavigateUpTo, supportRequestWindowFeature, supportShouldUpRecreateTask

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

        dump, getSupportFragmentManager, getSupportLoaderManager, onAttachFragment, onCreateView, onRequestPermissionsResult, onStateNotSaved, setEnterSharedElementCallback, setExitSharedElementCallback, startActivityFromFragment, startIntentSenderFromFragment, supportFinishAfterTransition, supportPostponeEnterTransition, supportStartPostponedEnterTransition, validateRequestPermissionsRequestCode

      • Methods inherited from class androidx.activity.ComponentActivity

        addMenuProvider, addOnConfigurationChangedListener, addOnContextAvailableListener, addOnMultiWindowModeChangedListener, addOnNewIntentListener, addOnPictureInPictureModeChangedListener, addOnTrimMemoryListener, getActivityResultRegistry, getDefaultViewModelCreationExtras, getDefaultViewModelProviderFactory, getLastCustomNonConfigurationInstance, getLifecycle, getOnBackPressedDispatcher, getSavedStateRegistry, getViewModelStore, invalidateMenu, onBackPressed, onCreatePanelMenu, onMultiWindowModeChanged, onPictureInPictureModeChanged, onPreparePanel, onRetainCustomNonConfigurationInstance, onRetainNonConfigurationInstance, onTrimMemory, peekAvailableContext, registerForActivityResult, removeMenuProvider, removeOnConfigurationChangedListener, removeOnContextAvailableListener, removeOnMultiWindowModeChangedListener, removeOnNewIntentListener, removeOnPictureInPictureModeChangedListener, removeOnTrimMemoryListener, reportFullyDrawn, startActivityForResult, startIntentSenderForResult

      • Methods inherited from class androidx.core.app.ComponentActivity

        dispatchKeyShortcutEvent, getExtraData, putExtraData, superDispatchKeyEvent

      • Methods inherited from class android.app.Activity

        closeContextMenu, createPendingResult, dismissDialog, dismissKeyboardShortcutsHelper, dispatchGenericMotionEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, enterPictureInPictureMode, enterPictureInPictureMode, finish, finishActivity, finishActivityFromChild, finishAffinity, finishAfterTransition, finishAndRemoveTask, finishFromChild, getActionBar, getApplication, getCallingActivity, getCallingPackage, getChangingConfigurations, getComponentName, getContentScene, getContentTransitionManager, getCurrentFocus, getFragmentManager, getIntent, getLastNonConfigurationInstance, getLayoutInflater, getLoaderManager, getLocalClassName, getMaxNumPictureInPictureActions, getMediaController, getOnBackInvokedDispatcher, getParent, getParentActivityIntent, getPreferences, getReferrer, getRequestedOrientation, getSearchEvent, getSplashScreen, getSystemService, getTaskId, getTitle, getTitleColor, getVoiceInteractor, getVolumeControlStream, getWindow, getWindowManager, hasWindowFocus, isActivityTransitionRunning, isChangingConfigurations, isChild, isDestroyed, isFinishing, isImmersive, isInMultiWindowMode, isInPictureInPictureMode, isLaunchedFromBubble, isLocalVoiceInteractionSupported, isTaskRoot, isVoiceInteraction, isVoiceInteractionRoot, managedQuery, moveTaskToBack, navigateUpTo, navigateUpToFromChild, onActionModeFinished, onActionModeStarted, onActivityReenter, onAttachedToWindow, onContextItemSelected, onContextMenuClosed, onCreateContextMenu, onCreateDescription, onCreateNavigateUpTaskStack, onCreateOptionsMenu, onCreatePanelView, onCreateThumbnail, onDetachedFromWindow, onEnterAnimationComplete, onGenericMotionEvent, onGetDirectActions, onKeyLongPress, onKeyMultiple, onKeyShortcut, onKeyUp, onLocalVoiceInteractionStarted, onLocalVoiceInteractionStopped, onLowMemory, onNavigateUp, onNavigateUpFromChild, onOptionsMenuClosed, onPerformDirectAction, onPictureInPictureRequested, onPictureInPictureUiStateChanged, onPrepareNavigateUpTaskStack, onPrepareOptionsMenu, onProvideAssistContent, onProvideAssistData, onProvideKeyboardShortcuts, onProvideReferrer, onSearchRequested, onTopResumedActivityChanged, onTouchEvent, onTrackballEvent, onUserInteraction, onVisibleBehindCanceled, onWindowAttributesChanged, onWindowFocusChanged, onWindowStartingActionMode, openContextMenu, overridePendingTransition, postponeEnterTransition, recreate, registerActivityLifecycleCallbacks, registerComponentCallbacks, registerForContextMenu, releaseInstance, removeDialog, requestDragAndDropPermissions, requestPermissions, requestShowKeyboardShortcuts, requestVisibleBehind, requestWindowFeature, requireViewById, runOnUiThread, setActionBar, setContentTransitionManager, setDefaultKeyMode, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setFinishOnTouchOutside, setImmersive, setInheritShowWhenLocked, setIntent, setLocusContext, setMediaController, setPictureInPictureParams, setProgress, setProgressBarIndeterminate, setProgressBarIndeterminateVisibility, setProgressBarVisibility, setRecentsScreenshotEnabled, setRequestedOrientation, setResult, setSecondaryProgress, setShouldDockBigOverlays, setShowWhenLocked, setTaskDescription, setTitle, setTitleColor, setTranslucent, setTurnScreenOn, setVisible, setVolumeControlStream, setVrModeEnabled, shouldDockBigOverlays, shouldShowRequestPermissionRationale, shouldUpRecreateTask, showAssist, showDialog, showDialog, showLockTaskEscapeMessage, startActionMode, startActivities, startActivity, startActivityFromChild, startActivityIfNeeded, startIntentSender, startIntentSenderFromChild, startLocalVoiceInteraction, startLockTask, startManagingCursor, startNextMatchingActivity, startPostponedEnterTransition, startSearch, stopLocalVoiceInteraction, stopLockTask, stopManagingCursor, takeKeyEvents, triggerSearch, unregisterActivityLifecycleCallbacks, unregisterComponentCallbacks, unregisterForContextMenu

      • Methods inherited from class android.view.ContextThemeWrapper

        applyOverrideConfiguration, getAssets, getTheme

      • Methods inherited from class android.view.Window.Callback

        onPointerCaptureChanged

      • Methods inherited from class android.content.ContextWrapper

        bindIsolatedService, bindService, bindServiceAsUser, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingOrSelfUriPermissions, checkCallingPermission, checkCallingUriPermission, checkCallingUriPermissions, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermissions, clearWallpaper, createAttributionContext, createConfigurationContext, createContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, createWindowContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAttributionSource, getAttributionTag, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDataDir, getDatabasePath, getDir, getDisplay, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFileStreamPath, getFilesDir, getMainExecutor, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getOpPackageName, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getParams, getSharedPreferences, getSystemServiceName, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, isUiContext, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, peekWallpaper, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeSelfPermissionsOnKill, revokeUriPermission, sendBroadcast, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setWallpaper, startForegroundService, startInstrumentation, startService, stopService, unbindService, unregisterReceiver, updateServiceGroup

      • Methods inherited from class android.content.Context

        getColor, getColorStateList, getDrawable, getString, getSystemService, getText, obtainStyledAttributes, revokeSelfPermissionOnKill, sendBroadcastWithMultiplePermissions

      • Methods inherited from class java.lang.Object

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