Package com.microblink.photopay.fragment.overlay.fieldbyfield

Class FieldByFieldOverlayController

java.lang.Object

com.microblink.photopay.fragment.overlay.BaseOverlayController

com.microblink.photopay.fragment.overlay.fieldbyfield.FieldByFieldOverlayController

All Implemented Interfaces:

ScanningOverlay, OnActivityFlipListener, ScanResultListener

public final class FieldByFieldOverlayController
extends BaseOverlayController
implements OnActivityFlipListener

Field Summary

Fields inherited from class com.microblink.photopay.fragment.overlay.BaseOverlayController

errorDialog, handler, overlayState, recognizerRunnerFragment, recognizerRunnerView, scanResultListener, scanSoundPlayer, torchController

Constructor Summary

Constructors

Constructor	Description
FieldByFieldOverlayController(FieldByFieldOverlaySettings settings, ScanResultListener scanResultListener)

Method Summary

Modifier and Type	Method	Description
protected int	getBeepSoundResourceId()
protected int	getSplashScreenLayoutId()
void	onActivityFlip()	Called when activity is flipped.
protected void	onFragmentConfigurationChanged(android.content.res.Configuration newConfig)
protected void	onFragmentCreated(android.os.Bundle savedInstanceState)
protected void	onFragmentResumed()
protected void	onFragmentSaveInstanceState(android.os.Bundle outState)
void	onRecognizerRunnerFragmentAttached(RecognizerRunnerFragment recognizerRunnerFragment, android.app.Activity activity)	Called after RecognizerRunnerFragment gets attached to its host activity.
void	onRecognizerRunnerViewCreated(RecognizerRunnerFragment recognizerRunnerFragment)	Called when RecognizerRunnerView has been created within given RecognizerRunnerFragment.
void	onScanningDone(RecognitionSuccessType recognitionSuccessType)	This method is called when recognition is done.
protected void	setMeteringAreas()
protected boolean	shouldResetStateOnRecognizerResume()

Methods inherited from class com.microblink.photopay.fragment.overlay.BaseOverlayController

getContext, onCameraAutofocusFailed, onFragmentDestroyed, onFragmentPaused, onFragmentStarted, onFragmentStopped, onFrameRecognitionDone, onUnrecoverableError, pauseScanning, resumeScanning

Methods inherited from class java.lang.Object

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

Constructor Details

FieldByFieldOverlayController

public FieldByFieldOverlayController(@NonNull
 FieldByFieldOverlaySettings settings,
 @NonNull
 ScanResultListener scanResultListener)

Method Details

onRecognizerRunnerFragmentAttached

public void onRecognizerRunnerFragmentAttached(@NonNull
 RecognizerRunnerFragment recognizerRunnerFragment,
 @NonNull
 android.app.Activity activity)

Description copied from interface: ScanningOverlay

Called after RecognizerRunnerFragment gets attached to its host activity. This happens before RecognizerRunnerFragment.onCreateView(LayoutInflater, ViewGroup, Bundle) which internally invokes ScanningOverlay.onRecognizerRunnerViewCreated(RecognizerRunnerFragment). This means that at the time this method is invoked, methods like RecognizerRunnerFragment.getRecognizerRunnerView() or RecognizerRunnerFragment.getContentLayout() will return null. However, this is a good place to register your LifecycleObserver with RecognizerRunnerFragment.registerLifecycleObserver(LifecycleObserver) if your overlay needs to be notified about lifecycle events of RecognizerRunnerFragment.

Specified by:

onRecognizerRunnerFragmentAttached in interface ScanningOverlay

Overrides:

onRecognizerRunnerFragmentAttached in class BaseOverlayController

Parameters:

recognizerRunnerFragment - RecognizerRunnerFragment that has been attached to host activity.

activity - Activity to which RecognizerRunnerFragment has been attached.

getSplashScreenLayoutId

protected int getSplashScreenLayoutId()

Specified by:

getSplashScreenLayoutId in class BaseOverlayController

onRecognizerRunnerViewCreated

public void onRecognizerRunnerViewCreated(@NonNull
 RecognizerRunnerFragment recognizerRunnerFragment)

Description copied from interface: ScanningOverlay

Called when RecognizerRunnerView has been created within given RecognizerRunnerFragment. You can use RecognizerRunnerFragment.getRecognizerRunnerView() to get the created RecognizerRunnerView and configure it. The most important thing you should do in this method is to set RecognizerBundle to created RecognizerRunnerView using RecognizerRunnerView.setRecognizerBundle(RecognizerBundle). You can also register various callbacks to RecognizerRunnerView, except CameraEventsListener (using BaseCameraView.setCameraEventsListener(CameraEventsListener)) and ScanResultListener (using RecognizerRunnerView.setScanResultListener(ScanResultListener) - those two listeners will be set to RecognizerRunnerView within RecognizerRunnerFragment after calling this method - if you need to observe camera events within RecognizerRunnerFragment, you can set your own BaseCameraEventsListener to it with RecognizerRunnerFragment.setCameraEventsListener(BaseCameraEventsListener). In this method, you can also access RecognizerRunnerFragment's content layout with method RecognizerRunnerFragment.getContentLayout() and add your views to it.

Specified by:

onRecognizerRunnerViewCreated in interface ScanningOverlay

Overrides:

onRecognizerRunnerViewCreated in class BaseOverlayController

Parameters:

recognizerRunnerFragment - RecognizerRunnerFragment within which RecognizerRunnerView has been created.

shouldResetStateOnRecognizerResume

protected boolean shouldResetStateOnRecognizerResume()

Specified by:

shouldResetStateOnRecognizerResume in class BaseOverlayController

getBeepSoundResourceId

protected int getBeepSoundResourceId()

Specified by:

getBeepSoundResourceId in class BaseOverlayController

onScanningDone

public void onScanningDone(@NonNull
 RecognitionSuccessType recognitionSuccessType)

Description copied from interface: ScanResultListener

This method is called when recognition is done. This method might be called on background thread or main thread, depending on the type of scan.

Specified by:

onScanningDone in interface ScanResultListener

Parameters:

recognitionSuccessType - indicates the success type of recognition

onFragmentCreated

protected void onFragmentCreated(@Nullable
 android.os.Bundle savedInstanceState)

Overrides:

onFragmentCreated in class BaseOverlayController

onFragmentResumed

protected void onFragmentResumed()

Overrides:

onFragmentResumed in class BaseOverlayController

onFragmentConfigurationChanged

protected void onFragmentConfigurationChanged(@NonNull
 android.content.res.Configuration newConfig)

Overrides:

onFragmentConfigurationChanged in class BaseOverlayController

onFragmentSaveInstanceState

protected void onFragmentSaveInstanceState(@Nullable
 android.os.Bundle outState)

Overrides:

onFragmentSaveInstanceState in class BaseOverlayController

onActivityFlip

public void onActivityFlip()

Description copied from interface: OnActivityFlipListener

Called when activity is flipped. This can happen if your activity is in sensor or user orientation mode and landscape to reverse landscape or portrait to reverse portrait or vice versa orientation change has occurred. Normally, Android will not give you any notification when this orientation change occurs, so SDK automatically detects that and with this listener informs you of such event.

Specified by:

onActivityFlip in interface OnActivityFlipListener

setMeteringAreas

protected void setMeteringAreas()

Overrides:

setMeteringAreas in class BaseOverlayController