Analysis Activity
When you use the Screen API, the AnalysisActivity
displays the captured or imported document and an activity indicator while the document is being analyzed by the Gini API.
Note: The title from the ActionBar was removed. Use the activity indicator message instead by overriding the string resource named gv_analysis_activity_indicator_message
. The message is displayed for images only.
For PDF documents the first page is shown (only on Android 5.0 Lollipop and newer) along with the PDF's filename and number of pages above the page. On Android KitKat and older only the PDF's filename is shown with the preview area left empty.
Extending the AnalysisActivity
in your application has been deprecated. The preferred way of adding network calls to the Gini Vision Library is by creating a GiniVision instance with a and a GiniVisionNetworkApi implementation.
Note: When declaring your AnalysisActivity
subclass in the
AndroidManifest.xml
you should set the theme to the GiniVisionTheme
. If you would like to use your own theme please consider that AnalysisActivity
extends AppCompatActivity and requires an AppCompat Theme.
The AnalysisActivity
is started by the CameraActivity after the user has reviewed the document and either made no changes to the document and it hasn't been analyzed before tapping the Next button, or the user has modified the document, e.g. by rotating it.
For imported documents that cannot be reviewed, like PDFs, the CameraActivity starts the AnalysisActivity
directly.
If you didn't create GiniVision instance you have to implement the following methods in your AnalysisActivity
subclass:
- onAnalyzeDocument - start analyzing the document by sending it to the Gini API.Note: Call onDocumentAnalyzed when the analysis is done and the Activity hasn't been stopped.Note: If an analysis error message was set in the Review Screen with onDocumentAnalysisError this method won't be called until the user clicks the retry button next to the error message.
- onAddDataToResult - you should add the results of the analysis to the Intent as extras and retrieve them once the CameraActivity returns.This is called only if you called onDocumentAnalyzed before.When this is called, control is returned to your Activity which started the and you can extract the results of the analysis.
You can also override the following method:
- onBackPressed - called when the back or the up button was clicked.
The following items are customizable:
- Activity indicator color: via the color resource named
gv_analysis_activity_indicator
- Activity indicator message: via the string resource named
gv_analysis_activity_indicator_message
- Activity indicator message text style: via overriding the style named
GiniVisionTheme.Analysis.AnalysingMessage.TextStyle
- Activity indicator message font: via overriding the style named
GiniVisionTheme.Analysis.AnalysingMessage.TextStyle
and setting an item namedgvCustomFont
with the path to the font file in yourassets
folder - PDF info panel background: via the color resource named
gv_analysis_pdf_info_background
- PDF filename text style: via overriding the style named
GiniVisionTheme.Analysis.PdfFilename.TextStyle
and setting an item namedandroid:textStyle
tonormal
,bold
oritalic
- PDF filename text size: via overriding the style named
GiniVisionTheme.Analysis.PdfFilename.TextStyle
and setting an item namedautoSizeMaxTextSize
andautoSizeMinTextSize
to the desired maximum and minimumsp
sizes - PDF filename text color: via the color resource named
gv_analysis_pdf_info_text
- PDF filename font: via overriding the style named
GiniVisionTheme.Analysis.PdfFilename.TextStyle
and setting an item namedgvCustomFont
with the path to the font file in yourassets
folder - PDF page count text style: via overriding the style named
GiniVisionTheme.Analysis.PdfPageCount.TextStyle
and setting an item namedandroid:textStyle
tonormal
,bold
oritalic
- PDF page count text size: via overriding the style named
GiniVisionTheme.Analysis.PdfPageCount.TextStyle
and setting an item namedandroid:textSize
to the desiredsp
size - PDF page count text color: via the color resource named
gv_analysis_pdf_info_text
- PDF page count font: via overriding the style named
GiniVisionTheme.Analysis.PdfPageCount.TextStyle
and setting an item namedgvCustomFont
with the path to the font file in yourassets
folder - Background color: via the color resource named
gv_background
. Note: this color resource is global to all Activities (CameraActivity, OnboardingActivity, ReviewActivity, ) - Error message text color: via the color resource named
gv_snackbar_error_text
- Error message font: via overriding the style named
GiniVisionTheme.Snackbar.Error.TextStyle
and setting an item namedgvCustomFont
with the path to the font file in yourassets
folder - Error message text style: via overriding the style named
GiniVisionTheme.Snackbar.Error.TextStyle
and setting an item namedandroid:textStyle
tonormal
,bold
oritalic
- Error message text size: via overriding the style named
GiniVisionTheme.Snackbar.Error.TextStyle
and setting an item namedandroid:textSize
to the desiredsp
size - Error message button text color: via the color resource named
gv_snackbar_error_button_title
andgv_snackbar_error_button_title_pressed
- Error message button font: via overriding the style named
GiniVisionTheme.Snackbar.Error.Button.TextStyle
and setting an item namedgvCustomFont
with the path to the font file in yourassets
folder - Error message button text style: via overriding the style named
GiniVisionTheme.Snackbar.Error.Button.TextStyle
and setting an item namedandroid:textStyle
tonormal
,bold
oritalic
- Error message button text size: via overriding the style named
GiniVisionTheme.Snackbar.Error.Button.TextStyle
and setting an item namedandroid:textSize
to the desiredsp
size - Error message background color: via the color resource named
gv_snackbar_error_background
- Document analysis error message retry button text: via the string resource named
gv_document_analysis_error_retry
Important: All overriden styles must have their respective Root.
prefixed style as their parent. Ex.: the parent of GiniVisionTheme.Snackbar.Error.TextStyle
must be
Root.GiniVisionTheme.Snackbar.Error.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, OnboardingActivity, ReviewActivity, net.gini.android.vision.review.multipage.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 viagv_status_bar
) - Back button (only for ReviewActivity and AnalysisActivity): via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named
gv_action_bar_back