net.gini.android.vision.review.multipage

Class MultiPageReviewActivity

java.lang.Object

AppCompatActivity

net.gini.android.vision.review.multipage.MultiPageReviewActivity

All Implemented Interfaces:

MultiPageReviewFragmentListener

public class MultiPageReviewActivity
extends AppCompatActivity
implements MultiPageReviewFragmentListener

Screen API

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 GiniVision instance is required to use the MultiPageReviewActivity

Customizing the Multi-Page Review Screen

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 GiniVisionTheme.Review.MultiPage.PageIndicator.TextStyle
• Page indicator font: via overriding the style named GiniVisionTheme.Review.MultiPage.PageIndicator.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
• Page indicator background color: via the color resource named gv_multi_page_review_page_indicator_background
• Next button icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_review_fab_checkmark.png
• Next button color: via the color resources named gv_review_fab and gv_review_fab_pressed
• Thumbnails panel background color: via the color resource named gv_multi_page_review_thumbnails_panel_background
• Thumbnail card background color: via the color resource named gv_multi_page_review_thumbnail_card_background
• Thumbnail badge text style: via overriding the style named GiniVisionTheme.Review.MultiPage.ThumbnailBadge.TextStyle
• Thumbnail badge font: via overriding the style named GiniVisionTheme.Review.MultiPage.ThumbnailBadge.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
• Thumbnail badge background border color: via the color resource named gv_multi_page_thumbnail_badge_background_border
• Thumbnail drag indicator bumps icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_bumps_icon.png
• Thumbnail highlight strip color: via the color resource named gv_multi_page_thumbnail_highlight_strip
• Thumbnail activity indicator color: via the color resource named gv_analysis_activity_indicator
• Thumbnail upload success background circle color: via the color resource named gv_multi_page_thumbnail_upload_success_icon_background
• Thumbnail upload success foreground tick color: via the color resource named gv_multi_page_thumbnail_upload_success_icon_foreground
• Thumbnail upload failure background circle color: via the color resource named gv_multi_page_thumbnail_upload_failure_icon_background
• Thumbnail upload failure foreground cross color: via the color resource named gv_multi_page_thumbnail_upload_failure_icon_foreground
• Add page icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_multi_page_add_page_icon.png
• Add page icon subtitle text: via the string resource named gv_multi_page_review_add_pages_subtitle
• Add page icon subtitle text style: via overriding the style named GiniVisionTheme.Review.MultiPage.AddPagesSubtitle.TextStyle
• Add page icon subtitle font: via overriding the style named GiniVisionTheme.Review.MultiPage.AddPagesSubtitle.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
• Reorder pages tip text: via the string resource named gv_multi_page_review_reorder_pages_tip
• Reorder pages tip text style: via overriding the style named GiniVisionTheme.Review.MultiPage.ReorderPagesTip.TextStyle
• Reorder pages tip font: via overriding the style named GiniVisionTheme.Review.MultiPage.ReorderPagesTip.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
• Rotate icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_rotate_icon.png
• Delete icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_delete_icon.png
• Image error message text style: via overriding the style named GiniVisionTheme.Snackbar.Error.TextStyle and setting an item named android:textStyle to normal, bold or italic
• Image error message font: via overriding the style named GiniVisionTheme.Snackbar.Error.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
• Image error message button text style: via overriding the style named GiniVisionTheme.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 GiniVisionTheme.Snackbar.Error.Button.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
• Image error message background color: via the color resource named gv_snackbar_error_background
• Image analysis error message retry button text: via the string resource named gv_document_analysis_error_retry
• Imported image error message delete button text: via the string resource named gv_multi_page_review_delete_invalid_document
• Imported image delete last page dialog message: via the string resource named gv_multi_page_review_file_import_delete_last_page_dialog_message
• Imported image delete last page dialog positive button text: via the string resource named gv_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 gv_multi_page_review_file_import_delete_last_page_dialog_negative_button
• Imported image delete last page dialog button color: via the color resource named gv_accent

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

Customizing the Action Bar

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, OnboardingActivity, ReviewActivity, MultiPageReviewActivity, AnalysisActivity).

The following items are customizable:

• Background color: via the color resource named gv_action_bar (highly recommended for Android 5+: customize the status bar color via gv_status_bar)
• Title: via the string resource named gv_title_multi_page_review
• Title color: via the color resource named gv_action_bar_title
• Back button (only for ReviewActivity, MultiPageReviewActivity and AnalysisActivity): via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_action_bar_back

Constructor Summary

Constructors

Constructor and Description
MultiPageReviewActivity()

Method Summary

Modifier and Type	Method and Description
static Intent	createIntent(Context context)
void	onBackPressed()
void	onImportedDocumentReviewCancelled() Called when the user deleted all the pages of a document received from another app.
boolean	onOptionsItemSelected(MenuItem item)
void	onProceedToAnalysisScreen(GiniVisionMultiPageDocument 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPageReviewActivity

public MultiPageReviewActivity()

Method Detail

createIntent

public static Intent createIntent(Context context)

onOptionsItemSelected

public boolean onOptionsItemSelected(MenuItem item)

onBackPressed

public void onBackPressed()

onProceedToAnalysisScreen

public void onProceedToAnalysisScreen(GiniVisionMultiPageDocument multiPageDocument)

Description copied from interface: MultiPageReviewFragmentListener

Called when all pages were uploaded successfully and the user tapped on the "next" button.

If you use the Screen API you should start the AnalysisActivity and set the document as the AnalysisActivity.EXTRA_IN_DOCUMENT extra.

If you use the Component API you should start the AnalysisFragmentCompat (or the AnalysisFragmentStandard) and pass the document when creating it with AnalysisFragmentCompat.createInstance(Document, String) (or AnalysisFragmentStandard.createInstance(Document, String)).

Specified by:

onProceedToAnalysisScreen in interface MultiPageReviewFragmentListener

Parameters:

multiPageDocument - contains the reviewed image (can be the original one or a modified image)

onReturnToCameraScreen

public void onReturnToCameraScreen()

Description copied from interface: MultiPageReviewFragmentListener

Called when the user wants to add a picture of another page. Also called when the user has deleted every page and the document consisted of images taken with the Camera Screen or imported using the Camera Screen.

If you host the MultiPageReviewFragment in its own Activity, then you should simply finish the Activity.

If you use one Activity to host all the GVL fragments, then you should display the CameraFragmentCompat (or the CameraFragmentStandard) again.

Specified by:

onReturnToCameraScreen in interface MultiPageReviewFragmentListener

onImportedDocumentReviewCancelled

public void onImportedDocumentReviewCancelled()

Description copied from interface: MultiPageReviewFragmentListener

Called when the user deleted all the pages of a document received from another app. This means the MultiPageReviewFragment was launched after a document had been created using GiniVision.createDocumentForImportedFiles(Intent, Context, AsyncCallback).

At this point you should finish GVL by closing the MultiPageReviewFragment and cleaning up using GiniVision.cleanup(Context).

Specified by:

onImportedDocumentReviewCancelled in interface MultiPageReviewFragmentListener