Package com.microblink.blinkinput.fragment.overlay.documentcapture.detectionui

Class DetectionOverlayView

java.lang.Object

com.microblink.blinkinput.fragment.overlay.documentcapture.detectionui.DetectionOverlayView

All Implemented Interfaces:

DocumentCaptureContract.OverlayView

public class DetectionOverlayView
extends Object
implements DocumentCaptureContract.OverlayView

Constructor Summary

Constructors

Constructor	Description
DetectionOverlayView(DetectionOverlayStrings strings, int style)
DetectionOverlayView(DetectionOverlayStrings strings, int style, boolean showTopButtons)

Method Summary

Modifier and Type	Method	Description
void	bindOverlayController(DocumentCaptureContract.OverlayController overlayController)	Bind given overlay controller to this view.
void	cleanup()	Called when view will not be used anymore, here you should finish all remaining view actions and its resources.
void	clearAction()	Clears all displayed actions.
void	clearDetection()	Clears all document detection information.
void	createLayout(android.content.Context context, RecognizerRunnerView parentView)	Inflate your custom layout here and add it to the parent view.
void	onConfigurationChanged(RecognizerRunnerView recognizerRunnerview, android.content.res.Configuration newConfiguration)	Called on device configuration change.
void	onScanStarted()	Performs UI modifications when scanning is started.
void	onTorchStateChanged(boolean torchOn)	Called when torch state is changed, when it is turned off or on.
void	onTorchSupportStatusAvailable(boolean cameraSupportsTorch)	Called when camera device torch support status is available.
void	showAction(DocumentCaptureAction action)	Displays some action message the to user.
void	showDetection(DisplayableQuadDetection quadDetection)	Displays given detection to the user.
void	showScanSuccess(DocumentCaptureContract.UiUpdateListener uiUpdateListener)	Displays the scan success.

Methods inherited from class java.lang.Object

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

Constructor Details

DetectionOverlayView

public DetectionOverlayView(@NonNull
 DetectionOverlayStrings strings,
 @StyleRes
 int style,
 boolean showTopButtons)

DetectionOverlayView

public DetectionOverlayView(@NonNull
 DetectionOverlayStrings strings,
 @StyleRes
 int style)

Method Details

bindOverlayController

public void bindOverlayController(DocumentCaptureContract.OverlayController overlayController)

Description copied from interface: DocumentCaptureContract.OverlayView

Bind given overlay controller to this view.

Specified by:

bindOverlayController in interface DocumentCaptureContract.OverlayView

Parameters:

overlayController - overlay controller that should be used for view actions.

createLayout

@NonNull
public void createLayout(@NonNull
 android.content.Context context,
 @NonNull
 RecognizerRunnerView parentView)

Description copied from interface: DocumentCaptureContract.OverlayView

Inflate your custom layout here and add it to the parent view.

Specified by:

createLayout in interface DocumentCaptureContract.OverlayView

Parameters:

context - application context

parentView - root view to be used as inflation parent

onConfigurationChanged

public void onConfigurationChanged(RecognizerRunnerView recognizerRunnerview,
 android.content.res.Configuration newConfiguration)

Description copied from interface: DocumentCaptureContract.OverlayView

Called on device configuration change.

Specified by:

onConfigurationChanged in interface DocumentCaptureContract.OverlayView

onTorchSupportStatusAvailable

public void onTorchSupportStatusAvailable(boolean cameraSupportsTorch)

Description copied from interface: DocumentCaptureContract.OverlayView

Called when camera device torch support status is available.

Specified by:

onTorchSupportStatusAvailable in interface DocumentCaptureContract.OverlayView

Parameters:

cameraSupportsTorch - whether used camera supports torch

onTorchStateChanged

public void onTorchStateChanged(boolean torchOn)

Description copied from interface: DocumentCaptureContract.OverlayView

Called when torch state is changed, when it is turned off or on.

Specified by:

onTorchStateChanged in interface DocumentCaptureContract.OverlayView

Parameters:

torchOn - true if torch is turned on, false if torch is turned off.

clearDetection

public void clearDetection()

Description copied from interface: DocumentCaptureContract.OverlayView

Clears all document detection information.

Specified by:

clearDetection in interface DocumentCaptureContract.OverlayView

showDetection

public void showDetection(DisplayableQuadDetection quadDetection)

Description copied from interface: DocumentCaptureContract.OverlayView

Displays given detection to the user.

Specified by:

showDetection in interface DocumentCaptureContract.OverlayView

Parameters:

quadDetection - detection location with status.

onScanStarted

public void onScanStarted()

Description copied from interface: DocumentCaptureContract.OverlayView

Performs UI modifications when scanning is started.

Specified by:

onScanStarted in interface DocumentCaptureContract.OverlayView

showScanSuccess

public void showScanSuccess(DocumentCaptureContract.UiUpdateListener uiUpdateListener)

Description copied from interface: DocumentCaptureContract.OverlayView

Displays the scan success.

Specified by:

showScanSuccess in interface DocumentCaptureContract.OverlayView

Parameters:

uiUpdateListener - listener that will be notified when all UI actions are finished (UI changes, animations...).

showAction

public void showAction(DocumentCaptureAction action)

Description copied from interface: DocumentCaptureContract.OverlayView

Displays some action message the to user.

Specified by:

showAction in interface DocumentCaptureContract.OverlayView

Parameters:

action - action that should be displayed.

clearAction

public void clearAction()

Description copied from interface: DocumentCaptureContract.OverlayView

Clears all displayed actions.

Specified by:

clearAction in interface DocumentCaptureContract.OverlayView

cleanup

public void cleanup()

Description copied from interface: DocumentCaptureContract.OverlayView

Called when view will not be used anymore, here you should finish all remaining view actions and its resources.

Specified by:

cleanup in interface DocumentCaptureContract.OverlayView