net.gini.android.vision.analysis

Class AnalysisFragmentCompat

java.lang.Object

Fragment

net.gini.android.vision.analysis.AnalysisFragmentCompat

All Implemented Interfaces:

AnalysisFragmentInterface

public class AnalysisFragmentCompat
extends Fragment
implements AnalysisFragmentInterface

Component API

When you use the Component API with the Android Support Library, the AnalyzeDocumentFragmentCompat displays the captured or imported document and an activity indicator while the document is being analyzed by the Gini API.

Note: You can use the activity indicator message to display a message under the activity indicator 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.

Note: Your Activity hosting this Fragment must extend the android.support.v7.app.AppCompatActivity and use an AppCompat Theme.

Include the AnalyzeDocumentFragmentCompat into your layout by using the AnalysisFragmentCompat.createInstance(Document, String) factory method to create an instance and display it using the android.support.v4.app.FragmentManager.

An AnalysisFragmentListener instance must be available until the AnalysisFragmentCompat is attached to an activity. Failing to do so will throw an exception. The listener instance can be provided either implicitly by making the hosting Activity implement the AnalysisFragmentListener interface or explicitly by setting the listener using AnalysisFragmentCompat.setListener(AnalysisFragmentListener).

Your Activity is automatically set as the listener in AnalysisFragmentCompat.onCreate(Bundle).

Customizing the Analysis Screen

See the AnalysisActivity for details.

Constructor Summary

Constructors

Constructor and Description
AnalysisFragmentCompat()

Method Summary

Modifier and Type	Method and Description
static AnalysisFragmentCompat	createInstance(Document document, java.lang.String documentAnalysisErrorMessage) Factory method for creating a new instance of the Fragment using the provided document.
void	hideError() Call this method to hide the error shown before with AnalysisFragmentInterface.showError(String, String, View.OnClickListener) or AnalysisFragmentInterface.showError(String, int).
void	onDocumentAnalyzed() You should call this method after you've received the analysis results from the Gini API.
void	onNoExtractionsFound() You should call this method after you've received the analysis results from the Gini API without the required extractions.
void	setListener(AnalysisFragmentListener listener) Set a listener for analysis events.
void	showAlertDialog(java.lang.String message, java.lang.String positiveButtonTitle, DialogInterface.OnClickListener positiveButtonClickListener, java.lang.String negativeButtonTitle, DialogInterface.OnClickListener negativeButtonClickListener, DialogInterface.OnCancelListener cancelListener)
void	showError(java.lang.String message, int duration) Call this method when you need to show an error message to the user in the Analysis Screen.
void	showError(java.lang.String message, java.lang.String buttonTitle, View.OnClickListener onClickListener) Call this method when you need to show an error message with an invokable action to the user in the Analysis Screen.
void	startScanAnimation() You should call this method when you start the document analysis using the Gini API.
void	stopScanAnimation() You should call this method when the document analysis has finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisFragmentCompat

public AnalysisFragmentCompat()

Method Detail

hideError

public void hideError()

Description copied from interface: AnalysisFragmentInterface

Call this method to hide the error shown before with AnalysisFragmentInterface.showError(String, String, View.OnClickListener) or AnalysisFragmentInterface.showError(String, int).

Specified by:

hideError in interface AnalysisFragmentInterface

onNoExtractionsFound

public void onNoExtractionsFound()

Description copied from interface: AnalysisFragmentInterface

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 AnalysisFragmentInterface

onDocumentAnalyzed

public void onDocumentAnalyzed()

Description copied from interface: AnalysisFragmentInterface

You should call this method after you've received the analysis results from the Gini API.

Specified by:

onDocumentAnalyzed in interface AnalysisFragmentInterface

showError

public void showError(java.lang.String message,
                      java.lang.String buttonTitle,
                      View.OnClickListener onClickListener)

Description copied from interface: AnalysisFragmentInterface

Call this method when you need to show an error message with an invokable action to the user in the Analysis Screen.

Specified by:

showError in interface AnalysisFragmentInterface

Parameters:

message - a short error message

buttonTitle - if not null and not empty, shows a button with the given title

onClickListener - listener for the button

showError

public void showError(java.lang.String message,
                      int duration)

Description copied from interface: AnalysisFragmentInterface

Call this method when you need to show an error message to the user in the Analysis Screen.

Specified by:

showError in interface AnalysisFragmentInterface

Parameters:

message - a short error message

duration - how long should the error message be shown in ms

startScanAnimation

public void startScanAnimation()

Description copied from interface: AnalysisFragmentInterface

You should call this method when you start the document analysis using the Gini API.

Specified by:

startScanAnimation in interface AnalysisFragmentInterface

stopScanAnimation

public void stopScanAnimation()

Description copied from interface: AnalysisFragmentInterface

You should call this method when the document analysis has finished.

Specified by:

stopScanAnimation in interface AnalysisFragmentInterface

setListener

public void setListener(AnalysisFragmentListener listener)

Description copied from interface: AnalysisFragmentInterface

Set a listener for analysis events.

By default the hosting Activity is expected to implement the AnalysisFragmentListener. 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 AnalysisFragmentInterface

Parameters:

listener - AnalysisFragmentListener instance

createInstance

public static AnalysisFragmentCompat createInstance(Document document,
                                                    java.lang.String documentAnalysisErrorMessage)

Factory method for creating a new instance of the Fragment using the provided document.

You may pass in an optional analysis error message. This error message is shown to the user with a retry button.

Note: Always use this method to create new instances. Document is required and an exception is thrown if it's missing.

Parameters:

document - must be the Document from (Document)

documentAnalysisErrorMessage - an optional error message shown to the user

Returns:

a new instance of the Fragment

showAlertDialog

public void showAlertDialog(java.lang.String message,
                            java.lang.String positiveButtonTitle,
                            DialogInterface.OnClickListener positiveButtonClickListener,
                            java.lang.String negativeButtonTitle,
                            DialogInterface.OnClickListener negativeButtonClickListener,
                            DialogInterface.OnCancelListener cancelListener)