Package com.microblink.blinkcard.fragment.overlay.blinkcard.reticleui

Class BlinkCardReticleOverlayView

java.lang.Object

com.microblink.blinkcard.fragment.overlay.blinkcard.reticleui.BlinkCardReticleOverlayView

All Implemented Interfaces:

BlinkCardOverlayView

public class BlinkCardReticleOverlayView
extends Object
implements BlinkCardOverlayView

Field Summary

Fields

Modifier and Type	Field	Description
protected BlinkCardReticleUiState	currentState
protected BlinkCardReticleOverlayStrings	strings

Constructor Summary

Constructors

Constructor	Description
BlinkCardReticleOverlayView(boolean shouldShowControlButtons, boolean shouldShowFlashlightWarning, boolean shouldShowIntroductionDialog, boolean shouldShowOnboardingInfo, BlinkCardReticleOverlayStrings strings, int style)

Method Summary

Modifier and Type	Method	Description
void	animateAndShowManualEntryButton()
void	changeState(BlinkCardReticleUiState newState, String statusMessage)
void	changeStateIfRequired(BlinkCardReticleUiState newState, String statusMessage)
void	cleanup()	Clean up your resources here.
android.view.ViewGroup	createLayout(android.app.Activity activity, RecognizerRunnerView recognizerRunnerView)	Inflate your custom layout layout here
TorchController	createTorchController(RecognizerRunnerView recognizerRunnerView)	Return properly set-up torch controller or null if torch is handled by the activity.
protected long	currentStateDuration()
protected android.util.Pair<BlinkCardReticleUiState,String>	detectionStatusToReticleState(DetectionStatus detectionStatus)
void	disableManualEntryButton()	Manual entry button should be disabled/hidden from the UI.
void	enableManualEntryButton(android.view.View.OnClickListener onClickListener)	Manual entry button should be enabled/shown in the UI.
OnboardingView	getOnboardingView()
RetryDialogStrings	getRecognitionTimeoutDialogStrings()
void	onCardDetectionUpdate(DetectionStatus detectionStatus)	Called on any update to card detection process.
void	onConfigurationChanged(int newHostScreenOrientation)	Called when host's screen orientation is changed.
void	onErrorDialogShown()	Called when error dialog is shown.
void	onFirstSideScanStarted()	Called when scanning of the first side starts.
void	onFrameProcessingStatus(BlinkCardProcessingStatus status)	Called after each frame has been processed
long	onScanSuccess()	Called when both sides are scanned.
void	onSecondSideScanStarted()	Called when scanning of the second side starts.
void	onTorchStateChanged(boolean torchOn)	Called when torch (flashlight) state is updated.
protected boolean	shouldStayInCurrentState(BlinkCardReticleUiState newState)

Methods inherited from class java.lang.Object

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

Field Details

strings

protected BlinkCardReticleOverlayStrings strings

currentState

protected BlinkCardReticleUiState currentState

Constructor Details

BlinkCardReticleOverlayView

public BlinkCardReticleOverlayView(boolean shouldShowControlButtons,
 boolean shouldShowFlashlightWarning,
 boolean shouldShowIntroductionDialog,
 boolean shouldShowOnboardingInfo,
 @Nullable
 BlinkCardReticleOverlayStrings strings,
 @StyleRes
 int style)

Method Details

getOnboardingView

@NonNull
public OnboardingView getOnboardingView()

Specified by:

getOnboardingView in interface BlinkCardOverlayView

createLayout

@NonNull
public android.view.ViewGroup createLayout(@NonNull
 android.app.Activity activity,
 @NonNull
 RecognizerRunnerView recognizerRunnerView)

Description copied from interface: BlinkCardOverlayView

Inflate your custom layout layout here

Specified by:

createLayout in interface BlinkCardOverlayView

Parameters:

activity - current activity

Returns:

root view of your custom layout

onConfigurationChanged

public void onConfigurationChanged(int newHostScreenOrientation)

Description copied from interface: BlinkCardOverlayView

Called when host's screen orientation is changed.

Specified by:

onConfigurationChanged in interface BlinkCardOverlayView

Parameters:

newHostScreenOrientation - orientation code, possible values are: ActivityInfo.SCREEN_ORIENTATION_PORTRAIT, ActivityInfo.SCREEN_ORIENTATION_REVERSE_PORTRAIT, ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE and ActivityInfo.SCREEN_ORIENTATION_REVERSE_LANDSCAPE

createTorchController

@NonNull
public TorchController createTorchController(@NonNull
 RecognizerRunnerView recognizerRunnerView)

Description copied from interface: BlinkCardOverlayView

Return properly set-up torch controller or null if torch is handled by the activity.

Specified by:

createTorchController in interface BlinkCardOverlayView

Parameters:

recognizerRunnerView - required for torch controller setup

Returns:

torch controller

onFirstSideScanStarted

@CallSuper
public void onFirstSideScanStarted()

Description copied from interface: BlinkCardOverlayView

Called when scanning of the first side starts.

Specified by:

onFirstSideScanStarted in interface BlinkCardOverlayView

onSecondSideScanStarted

public void onSecondSideScanStarted()

Description copied from interface: BlinkCardOverlayView

Called when scanning of the second side starts.

Specified by:

onSecondSideScanStarted in interface BlinkCardOverlayView

getRecognitionTimeoutDialogStrings

@NonNull
public RetryDialogStrings getRecognitionTimeoutDialogStrings()

Specified by:

getRecognitionTimeoutDialogStrings in interface BlinkCardOverlayView

Returns:

strings to be used for error dialog shown when second document side can't be recognized

enableManualEntryButton

public void enableManualEntryButton(android.view.View.OnClickListener onClickListener)

Description copied from interface: BlinkCardOverlayView

Manual entry button should be enabled/shown in the UI.

Specified by:

enableManualEntryButton in interface BlinkCardOverlayView

Parameters:

onClickListener - listener to register to manual entry button

animateAndShowManualEntryButton

public void animateAndShowManualEntryButton()

disableManualEntryButton

public void disableManualEntryButton()

Description copied from interface: BlinkCardOverlayView

Manual entry button should be disabled/hidden from the UI.

Specified by:

disableManualEntryButton in interface BlinkCardOverlayView

onScanSuccess

public long onScanSuccess()

Description copied from interface: BlinkCardOverlayView

Called when both sides are scanned. If you wish to animate success state, return delay in milliseconds and overlay controller will wait before reporting that scanning is done.

Specified by:

onScanSuccess in interface BlinkCardOverlayView

Returns:

delay in milliseconds

onCardDetectionUpdate

public void onCardDetectionUpdate(@NonNull
 DetectionStatus detectionStatus)

Description copied from interface: BlinkCardOverlayView

Called on any update to card detection process.

Specified by:

onCardDetectionUpdate in interface BlinkCardOverlayView

onFrameProcessingStatus

public void onFrameProcessingStatus(BlinkCardProcessingStatus status)

Description copied from interface: BlinkCardOverlayView

Called after each frame has been processed

Specified by:

onFrameProcessingStatus in interface BlinkCardOverlayView

Parameters:

status - latest frame processing status

detectionStatusToReticleState

protected android.util.Pair<BlinkCardReticleUiState,String> detectionStatusToReticleState(DetectionStatus detectionStatus)

onErrorDialogShown

public void onErrorDialogShown()

Description copied from interface: BlinkCardOverlayView

Called when error dialog is shown. Make sure to stop animations here.

Specified by:

onErrorDialogShown in interface BlinkCardOverlayView

onTorchStateChanged

public void onTorchStateChanged(boolean torchOn)

Description copied from interface: BlinkCardOverlayView

Called when torch (flashlight) state is updated.

Specified by:

onTorchStateChanged in interface BlinkCardOverlayView

Parameters:

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

cleanup

public void cleanup()

Description copied from interface: BlinkCardOverlayView

Clean up your resources here.

Specified by:

cleanup in interface BlinkCardOverlayView

changeStateIfRequired

public void changeStateIfRequired(@NonNull
 BlinkCardReticleUiState newState,
 String statusMessage)

changeState

public void changeState(@NonNull
 BlinkCardReticleUiState newState,
 String statusMessage)

shouldStayInCurrentState

protected boolean shouldStayInCurrentState(BlinkCardReticleUiState newState)

currentStateDuration

protected long currentStateDuration()