Package com.microblink.uisettings
Class DocumentUISettings
- java.lang.Object
-
- com.microblink.uisettings.UISettings<BlinkIdOverlayController>
-
- com.microblink.uisettings.BaseBlinkIdUiSettings
-
- com.microblink.uisettings.DocumentUISettings
-
- All Implemented Interfaces:
BackSideScanningTimeoutUIOptions
,BeepSoundUIOptions
,CurrentImageListenerUIOptions
,DebugImageListenerUIOptions
,DocumentDataMatchUIOptions
,DocumentNotSupportedDialogUIOptions
,HighResSuccessFrameCaptureUIOptions
,MrzDetectionUIOptions
,OcrResultDisplayUIOptions
,SplashScreenUIOptions
,StringsUIOptions<DocumentOverlayStrings>
,StyleUIOptions
public class DocumentUISettings extends BaseBlinkIdUiSettings implements StyleUIOptions, StringsUIOptions<DocumentOverlayStrings>
Scan settings for scanning documents.
-
-
Field Summary
-
Fields inherited from interface com.microblink.uisettings.options.BackSideScanningTimeoutUIOptions
TIMEOUT_INFINITY
-
-
Constructor Summary
Constructors Constructor Description DocumentUISettings(android.content.Intent intent)
DocumentUISettings(RecognizerBundle recognizerBundle)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected BlinkIdOverlayView
createOverlayView()
java.lang.Class<?>
getTargetActivity()
Returns target activity.protected boolean
isLockedToPortrait()
void
setOverlayViewStyle(int styleResourceID)
Provide your own style to replace default icons and colors.void
setStrings(DocumentOverlayStrings strings)
Sets strings that will be used in the UI.-
Methods inherited from class com.microblink.uisettings.BaseBlinkIdUiSettings
createOverlayController, enableHighResSuccessFrameCapture, saveToIntent, setBackSideScanningTimeoutMs, setBeepSoundResourceID, setCurrentImageListener, setDebugImageListener, setDocumentDataMatchRequired, setOcrResultDisplayMode, setShowMrzDetection, setShowNotSupportedDialog, setSplashScreenLayoutResourceID
-
Methods inherited from class com.microblink.uisettings.UISettings
getActivityTheme, getFilterTouchesWhenObscured, getUsingFlagSecure, setActivityTheme, setCameraSettings, setFilterTouchesWhenObscured, setUsingFlagSecure
-
-
-
-
Constructor Detail
-
DocumentUISettings
public DocumentUISettings(@NonNull RecognizerBundle recognizerBundle)
-
DocumentUISettings
public DocumentUISettings(@NonNull android.content.Intent intent)
-
-
Method Detail
-
isLockedToPortrait
protected boolean isLockedToPortrait()
- Specified by:
isLockedToPortrait
in classBaseBlinkIdUiSettings
-
getTargetActivity
@NonNull public java.lang.Class<?> getTargetActivity()
Description copied from class:UISettings
Returns target activity. Concrete settings can be used only with the corresponding activity. This method is public for convenience when you are not able to useActivityRunner
. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.- Specified by:
getTargetActivity
in classUISettings<BlinkIdOverlayController>
- Returns:
- target activity.
-
setOverlayViewStyle
public void setOverlayViewStyle(@StyleRes int styleResourceID)
Provide your own style to replace default icons and colors. Supports attributes from R.styleable.BlinkIdSimpleBoxOverlay- Specified by:
setOverlayViewStyle
in interfaceStyleUIOptions
- Parameters:
styleResourceID
- your style
-
setStrings
public void setStrings(@NonNull DocumentOverlayStrings strings)
Sets strings that will be used in the UI.- Specified by:
setStrings
in interfaceStringsUIOptions<DocumentOverlayStrings>
- Parameters:
strings
- strings that will be used
-
createOverlayView
@NonNull protected BlinkIdOverlayView createOverlayView()
- Specified by:
createOverlayView
in classBaseBlinkIdUiSettings
-
-