Analysis Activity
Screen API
When you use the Screen API, the {@code 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 {@code gc_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.
The preferred way of adding network calls to the Gini Capture SDK is by creating a GiniCapture instance with a and a GiniCaptureNetworkApi implementation.
The {@code 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 {@code AnalysisActivity}
directly.
Customizing the look of the Analysis Screen is done via overriding of app resources.
The following items are customizable:
- Activity indicator color: via the color resource named
{@code * gc_analysis_activity_indicator}
- Activity indicator message: via the string resource named
{@code * gc_analysis_activity_indicator_message}
- Activity indicator message text style: via overriding the style named
{@code * GiniCaptureTheme.Analysis.AnalysingMessage.TextStyle}
- Activity indicator message font: via overriding the style named
{@code * GiniCaptureTheme.Analysis.AnalysingMessage.TextStyle}
and setting an item named{@code gcCustomFont}
with the path to the font file in your{@code assets}
folder - PDF info panel background: via the color resource named
{@code * gc_analysis_pdf_info_background}
- PDF filename text style: via overriding the style named
{@code * GiniCaptureTheme.Analysis.PdfFilename.TextStyle}
and setting an item named{@code android:textStyle}
to{@code normal}
,{@code bold}
or{@code italic}
- PDF filename text size: via overriding the style named
{@code * GiniCaptureTheme.Analysis.PdfFilename.TextStyle}
and setting an item named{@code autoSizeMaxTextSize}
and{@code autoSizeMinTextSize}
to the desired maximum and minimum{@code sp}
sizes - PDF filename text color: via the color resource named
{@code * gc_analysis_pdf_info_text}
- PDF filename font: via overriding the style named
{@code * GiniCaptureTheme.Analysis.PdfFilename.TextStyle}
and setting an item named{@code gcCustomFont}
with the path to the font file in your{@code assets}
folder - PDF page count text style: via overriding the style named
{@code * GiniCaptureTheme.Analysis.PdfPageCount.TextStyle}
and setting an item named{@code android:textStyle}
to{@code normal}
,{@code bold}
or{@code italic}
- PDF page count text size: via overriding the style named
{@code * GiniCaptureTheme.Analysis.PdfPageCount.TextStyle}
and setting an item named{@code android:textSize}
to the desired{@code sp}
size - PDF page count text color: via the color resource named
{@code * gc_analysis_pdf_info_text}
- PDF page count font: via overriding the style named
{@code * GiniCaptureTheme.Analysis.PdfPageCount.TextStyle}
and setting an item named{@code gcCustomFont}
with the path to the font file in your{@code assets}
folder - Background color: via the color resource named
{@code gc_background}
. Note: this color resource is global to all Activities ( CameraActivity , OnboardingActivity , ReviewActivity , ) - Error message text color: via the color resource named
{@code * gc_snackbar_error_text}
- Error message font: via overriding the style named
{@code * GiniCaptureTheme.Snackbar.Error.TextStyle}
and setting an item named{@code gcCustomFont}
with the path to the font file in your{@code * assets}
folder - Error message text style: via overriding the style named
{@code * GiniCaptureTheme.Snackbar.Error.TextStyle}
and setting an item named{@code android:textStyle}
to{@code normal}
,{@code bold}
or{@code * italic}
- Error message text size: via overriding the style named
{@code * GiniCaptureTheme.Snackbar.Error.TextStyle}
and setting an item named{@code android:textSize}
to the desired{@code sp}
size - Error message button text color: via the color resource named
{@code * gc_snackbar_error_button_title}
and{@code gc_snackbar_error_button_title_pressed}
- Error message button font: via overriding the style named
{@code * GiniCaptureTheme.Snackbar.Error.Button.TextStyle}
and setting an item named{@code gcCustomFont}
with the path to the font file in your{@code assets}
folder - Error message button text style: via overriding the style named
{@code * GiniCaptureTheme.Snackbar.Error.Button.TextStyle}
and setting an item named{@code android:textStyle}
to{@code normal}
,{@code bold}
or{@code italic}
- Error message button text size: via overriding the style named
{@code * GiniCaptureTheme.Snackbar.Error.Button.TextStyle}
and setting an item named{@code android:textSize}
to the desired{@code sp}
size - Error message background color: via the color resource named
{@code * gc_snackbar_error_background}
- Document analysis error message retry button text: via the string resource named
{@code gc_document_analysis_error_retry}
Important: All overriden styles must have their respective {@code Root.}
prefixed style as their parent. Ex.: the parent of {@code GiniCaptureTheme.Snackbar.Error.TextStyle}
must be {@code * Root.GiniCaptureTheme.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.capture.review.multipage.MultiPageReviewActivity , AnalysisActivity ).
The following items are customizable:
- Background color: via the color resource named
{@code gc_action_bar}
(highly recommended for Android 5+: customize the status bar color via{@code gc_status_bar}
) - Back button (only for ReviewActivity and AnalysisActivity ): via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named
{@code gc_action_bar_back}
Functions
Properties
Internal use only.
Internal use only.
Internal use only.
Internal use only.
Internal use only.