ReviewActivity (Gini Vision Library for Android)

java.lang.Object
- AppCompatActivity
- - net.gini.android.vision.review.ReviewActivity

All Implemented Interfaces:

ReviewFragmentInterface, ReviewFragmentListener
```
public class ReviewActivity
extends AppCompatActivity
implements ReviewFragmentListener, ReviewFragmentInterface
```
Screen API
When you use the Screen API, the ReviewActivity displays the photographed or imported image and allows the user to review it by checking the sharpness, quality and orientation of the image. The user can correct the orientation by rotating the image.
Extending the ReviewActivity 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 GiniVisionNetworkService and a GiniVisionNetworkApi implementation.
Note: When declaring your ReviewActivity subclass in the AndroidManifest.xml you should set the theme to the GiniVisionTheme and the title to the string resource named gv_title_review. If you would like to use your own theme please consider that ReviewActivity extends AppCompatActivity and requires an AppCompat Theme.
The ReviewActivity is started by the CameraActivity after the user has taken a photo or imported an image of a document.
If you didn't create GiniVision instance you have to implement the following methods in your ReviewActivity subclass:
- ReviewActivity.onShouldAnalyzeDocument(Document) - you should start analyzing the original document by sending it to the Gini API. We assume that in most cases the photo is good enough and this way we are able to provide analysis results quicker.
  Note: Call ReviewActivity.onDocumentAnalyzed() when the analysis is done and the Activity wasn't stopped.
- ReviewActivity.onAddDataToResult(Intent) - you can 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 ReviewActivity.onDocumentAnalyzed() and the image wasn't changed before the user tapped on the Next button.
  When this is called, your AnalysisActivity subclass is not launched, instead control is returned to your Activity which started the CameraActivity and you can extract the results of the analysis.
You can also override the following methods, if you didn't create a GiniVision instance:
- ReviewActivity.onDocumentWasRotated(Document, int, int) - you should cancel the analysis started in ReviewActivity.onShouldAnalyzeDocument(Document) because the document was rotated and analysing the original is not necessary anymore. The Gini Vision Library will proceed to the Analysis Screen where the reviewed document can be analyzed.
- ReviewActivity.onProceedToAnalysisScreen(Document) - called when the Gini Vision Library will continue to the Analysis Screen. For example you can unsubscribe your analysis listener, if you want to continue the analysis in your AnalysisActivity subclass in case the document wasn't modified.
- ReviewActivity.onBackPressed() - called when the back or the up button was clicked. You should cancel the analysis started in ReviewActivity.onShouldAnalyzeDocument(Document).
Customizing the Review Screen
Customizing the look of the Review Screen is done via overriding of app resources.
The following items are customizable:
- Rotate button icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_review_button_rotate.png
- Rotate button color: via the color resources named gv_review_fab_mini and gv_review_fab_mini_pressed
- Next button icon: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_review_fab_next.png
- Next button color: via the color resources named gv_review_fab and gv_review_fab_pressed
- Bottom advice text: via the string resource named gv_review_bottom_panel_text
- Bottom text color: via the color resource named gv_review_bottom_panel_text
- Bottom text font: via overriding the style named GiniVisionTheme.Review.BottomPanel.TextStyle and setting an item named gvCustomFont with the path to the font file in your assets folder
- Bottom text style: via overriding the style named GiniVisionTheme.Review.BottomPanel.TextStyle and setting an item named android:textStyle to normal, bold or italic
- Bottom text size: via overriding the style named GiniVisionTheme.Review.BottomPanel.TextStyle and setting an item named android:textSize to the desired sp size
- Bottom panel background color: via the color resource named gv_review_bottom_panel_background
- Background color: via the color resource named gv_background. Note: this color resource is global to all Activities (CameraActivity, OnboardingActivity, ReviewActivity, AnalysisActivity)
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, 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 you set in your AndroidManifest.xml when declaring your Activity that extends ReviewActivity. The default title string resource is named gv_title_review
- Title color: via the color resource named gv_action_bar_title
- Back button: via images for mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi named gv_action_bar_back

Constructor Summary

Constructors
Constructor and Description

ReviewActivity()

Constructors
Constructor and Description
`ReviewActivity()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`onAddDataToResult(Intent result)` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`onBackPressed()`
`void`	`onDocumentAnalyzed()` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`onDocumentReviewedAndAnalyzed(Document document)` Called if you called `ReviewFragmentStandard.onDocumentAnalyzed()` or `ReviewFragmentCompat.onDocumentAnalyzed()` and the image wasn't changed and the user tapped on the Next button.
`void`	`onDocumentWasRotated(Document document, int oldRotation, int newRotation)` Deprecated. When a `GiniVision` and a `GiniVisionNetworkService` instance is available rotation is handled internally. The document is analyzed by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the Analysis Screen in `AnalysisFragmentListener#onExtractionsAvailable(Map, Map)`.
`void`	`onError(GiniVisionError error)` Called when an error occurred.
`void`	`onExtractionsAvailable(java.util.Map extractions)` Called when the document has been analyzed and extractions are available.
`void`	`onNoExtractionsFound()` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation.
`boolean`	`onOptionsItemSelected(MenuItem item)`
`void`	`onProceedToAnalysisScreen(Document document)` Called if you didn't call `ReviewFragmentStandard.onDocumentAnalyzed()` or `ReviewFragmentCompat.onDocumentAnalyzed()` (or the image was changed) and the user tapped on the Next button.
`void`	`onProceedToAnalysisScreen(Document document, java.lang.String errorMessage)` Called when the user tapped on the Next button and one of the following conditions apply: Analysis is in progress Analysis completed with an error The image was rotated
`void`	`onProceedToNoExtractionsScreen(Document document)` Called when the document has been analyzed and no extractions were received.
`void`	`onShouldAnalyzeDocument(Document document)` Deprecated. When a `GiniVision` instance is available the document is analyzed internally by using the configured `GiniVisionNetworkService` implementation. The extractions will be returned in the extra called `CameraActivity.EXTRA_OUT_EXTRACTIONS` of the `CameraActivity`'s result Intent.
`void`	`setListener(ReviewFragmentListener listener)` Set a listener for review events.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReviewActivity
```
public ReviewActivity()
```
- Method Detail
  - onOptionsItemSelected
```
public boolean onOptionsItemSelected(MenuItem item)
```
  - onBackPressed
```
public void onBackPressed()
```
  - onShouldAnalyzeDocument
```
@Deprecated
public void onShouldAnalyzeDocument(Document document)
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Description copied from interface: ReviewFragmentListener
    
    Called when the Review Fragment was started and you should start analyzing the original document by sending it to the Gini API.
    We assume that in most cases the photo is good enough and this way we are able to provide analysis results quicker.
    Note: Call ReviewFragmentStandard.onDocumentAnalyzed() or ReviewFragmentCompat.onDocumentAnalyzed() when the analysis is done and your Activity wasn't stopped.
    
    Specified by:
    
    onShouldAnalyzeDocument in interface ReviewFragmentListener
    
    Parameters:
    
    document - contains the original image taken by the camera
  - onProceedToAnalysisScreen
```
public void onProceedToAnalysisScreen(Document document)
```
    Description copied from interface: ReviewFragmentListener
    
    Called if you didn't call ReviewFragmentStandard.onDocumentAnalyzed() or ReviewFragmentCompat.onDocumentAnalyzed() (or the image was changed) and the user tapped on the Next button.
    You should start your Activity extending AnalysisActivity and set the document as the AnalysisActivity.EXTRA_IN_DOCUMENT extra.
    
    Specified by:
    
    onProceedToAnalysisScreen in interface ReviewFragmentListener
    
    Parameters:
    
    document - contains the reviewed image (can be the original one or a modified image)
  - onProceedToAnalysisScreen
```
public void onProceedToAnalysisScreen(Document document,
                                      java.lang.String errorMessage)
```
    Description copied from interface: ReviewFragmentListener
    Called when the user tapped on the Next button and one of the following conditions apply:
    - Analysis is in progress
    - Analysis completed with an error
    - The image was rotated
      You should start your Activity extending AnalysisActivity and set the document as the AnalysisActivity.EXTRA_IN_DOCUMENT extra.
    Specified by:
    
    onProceedToAnalysisScreen in interface ReviewFragmentListener
    
    Parameters:
    
    document - contains the reviewed image (can be the original one or a modified image)
    
    errorMessage - an optional error message to be passed to the Analysis Screen
  - onDocumentReviewedAndAnalyzed
```
public void onDocumentReviewedAndAnalyzed(Document document)
```
    Description copied from interface: ReviewFragmentListener
    
    Called if you called ReviewFragmentStandard.onDocumentAnalyzed() or ReviewFragmentCompat.onDocumentAnalyzed() and the image wasn't changed and the user tapped on the Next button.
    You should finish your Activity and proceed to handling the results of the analysis.
    
    Specified by:
    
    onDocumentReviewedAndAnalyzed in interface ReviewFragmentListener
    
    Parameters:
    
    document - contains the reviewed image (can be the original one or a modified image)
  - onAddDataToResult
```
@Deprecated
public void onAddDataToResult(Intent result)
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Callback for adding your own data to the Activity's result.
    
    Called when the document has been analyzed and wasn't modified at the time the user tapped on the Next button.
    
    You should add the results of the analysis as extras and retrieve them when the CameraActivity returns.
    
    Note: you should call ReviewActivity.onDocumentAnalyzed() after you've received the analysis results from the Gini API, otherwise this method won't be invoked.
    
    Parameters:
    
    result - the Intent which will be returned as the result data.
  - onDocumentWasRotated
```
public void onDocumentWasRotated(Document document,
                                 int oldRotation,
                                 int newRotation)
```
    Deprecated. When a GiniVision and a GiniVisionNetworkService instance is available rotation is handled internally. The document is analyzed by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the Analysis Screen in AnalysisFragmentListener#onExtractionsAvailable(Map, Map).
    
    Called when the user rotated the image.
    
    In case you started the document analysis in ReviewFragmentListener.onShouldAnalyzeDocument(Document) you should cancel it here as the original image is not valid anymore.
    
    Specified by:
    
    onDocumentWasRotated in interface ReviewFragmentListener
    
    Parameters:
    
    document - contains the modified image
    
    oldRotation - the previous rotation in degrees
    
    newRotation - the new rotation in degrees
  - onDocumentAnalyzed
```
@Deprecated
public void onDocumentAnalyzed()
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation. The extractions will be returned in the extra called CameraActivity.EXTRA_OUT_EXTRACTIONS of the CameraActivity's result Intent.
    
    Description copied from interface: ReviewFragmentInterface
    
    You should call this method after you've received the analysis results from the Gini API.
    This is important for managing the behavior of the Review Document Fragment when the Next button was clicked.
    If the document has already been analyzed and the image wasn't changed when the user tapped the Next button, ReviewFragmentListener.onDocumentReviewedAndAnalyzed(Document) is called and there is no need to show an AnalysisActivity or AnalysisFragmentStandard or AnalysisFragmentCompat.
    If the document wasn't analyzed or the image was changed when the user tapped the Next button, ReviewFragmentListener.onProceedToAnalysisScreen(Document) is called.
    
    Specified by:
    
    onDocumentAnalyzed in interface ReviewFragmentInterface
  - onNoExtractionsFound
```
@Deprecated
public void onNoExtractionsFound()
```
    Deprecated. When a GiniVision instance is available the document is analyzed internally by using the configured GiniVisionNetworkService implementation.
    
    Description copied from interface: ReviewFragmentInterface
    
    You should call this method after you've received the analysis results from the Gini API without the required extractions.
    
    Specified by:
    
    onNoExtractionsFound in interface ReviewFragmentInterface
  - onError
```
public void onError(GiniVisionError error)
```
    Description copied from interface: ReviewFragmentListener
    
    Called when an error occurred.
    
    Specified by:
    
    onError in interface ReviewFragmentListener
    
    Parameters:
    
    error - details about what went wrong
  - setListener
```
public void setListener(ReviewFragmentListener listener)
```
    Description copied from interface: ReviewFragmentInterface
    
    Set a listener for review events.
    By default the hosting Activity is expected to implement the ReviewFragmentListener. In case that is not feasible you may set the listener using this method.
    Note: the listener is expected to be available until the fragment is attached to an activity. Make sure to set the listener before that.
    
    Specified by:
    
    setListener in interface ReviewFragmentInterface
    
    Parameters:
    
    listener - ReviewFragmentListener instance
  - onExtractionsAvailable
```
public void onExtractionsAvailable(java.util.Map extractions)
```
    Description copied from interface: ReviewFragmentListener
    
    Called when the document has been analyzed and extractions are available.
    
    Specified by:
    
    onExtractionsAvailable in interface ReviewFragmentListener
    
    Parameters:
    
    extractions - a map of the extractions with the extraction labels as keys
  - onProceedToNoExtractionsScreen
```
public void onProceedToNoExtractionsScreen(Document document)
```
    Description copied from interface: ReviewFragmentListener
    
    Called when the document has been analyzed and no extractions were received.
    You should show the NoResultsFragmentStandard or NoResultsFragmentCompat.
    
    Specified by:
    
    onProceedToNoExtractionsScreen in interface ReviewFragmentListener
    
    Parameters:
    
    document - contains the reviewed document

Class ReviewActivity

Screen API

Customizing the Review Screen

Customizing the Action Bar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReviewActivity

Method Detail

onOptionsItemSelected

onBackPressed

onShouldAnalyzeDocument

onProceedToAnalysisScreen

onProceedToAnalysisScreen

onDocumentReviewedAndAnalyzed

onAddDataToResult

onDocumentWasRotated

onDocumentAnalyzed

onNoExtractionsFound

onError

setListener

onExtractionsAvailable

onProceedToNoExtractionsScreen