Package com.regula.documentreader.api.params

Class Functionality.FunctionalityEditor

java.lang.Object

com.regula.documentreader.api.params.Functionality.FunctionalityEditor

Enclosing class:

Functionality

public static class Functionality.FunctionalityEditor
extends java.lang.Object

Interface used for modifying Functionality object. All changes you make in an editor are batched, and not copied back to the original Functionality until you call apply()

Method Summary

Modifier and Type	Method	Description
void	apply()	Commit your changes back from this Editor to the Functionality object it is editing.
Functionality.FunctionalityEditor	setBtDeviceName(java.lang.String btDeviceName)	See Functionality.getBtDeviceName()
Functionality.FunctionalityEditor	setCameraFrame(java.lang.String cameraFrame)	See Functionality.getCameraFrame()
Functionality.FunctionalityEditor	setCameraMode(int cameraMode)	See Functionality.getCameraMode()
Functionality.FunctionalityEditor	setCameraSize(java.lang.Integer width, java.lang.Integer height)	See Functionality.getCameraWidth() and Functionality.getCameraHeight()
Functionality.FunctionalityEditor	setCaptureMode(int captureMode)	See Functionality.getCaptureMode()
Functionality.FunctionalityEditor	setDatabaseAutoupdate(boolean databaseAutoupdate)	See Functionality.isDatabaseAutoupdate()
Functionality.FunctionalityEditor	setDisplayMetadata(boolean displayMetadata)	See Functionality.isDisplayMetaData()
Functionality.FunctionalityEditor	setDoRecordProcessingVideo(boolean doRecordProcessingVideo)	See Functionality.doRecordProcessingVideo()
Functionality.FunctionalityEditor	setExcludedCamera2Models(java.util.List<java.lang.String> models)	See Functionality.getExcludedCamera2Models()
Functionality.FunctionalityEditor	setExposure(float exposure)	See Functionality.getExposure()
Functionality.FunctionalityEditor	setForcePagesCount(int forcePagesCount)
Functionality.FunctionalityEditor	setIsCameraTorchCheckDisabled(boolean disabled)	As some devices have bug returning hasSystemFeature(PackageManager.FEATURE_CAMERA_FLASH) false when FLASH is actually available, use this to turn this check off !!!CAUTION!!! use at your own risk
Functionality.FunctionalityEditor	setManualMultipageMode(boolean isManualMultipageMode)	See Functionality.isManualMultipageMode()
Functionality.FunctionalityEditor	setOrientation(int orientation)	See Functionality.getOrientation()
Functionality.FunctionalityEditor	setPictureOnBoundsReady(boolean pictureOnBoundsReady)	See PictureOnBoundsReady
Functionality.FunctionalityEditor	setRfidTimeout(int rfidTimeout)	See Functionality.getRfidTimeout()
Functionality.FunctionalityEditor	setShowCameraSwitchButton(boolean mShowCameraSwitchButton)	See Functionality.isShowCameraSwitchButton()
Functionality.FunctionalityEditor	setShowCaptureButton(boolean showCaptureButton)	See Functionality.isShowCaptureButton()
Functionality.FunctionalityEditor	setShowCaptureButtonDelayFromDetect(long showCaptureButtonDelayFromDetect)	See Functionality.getShowCaptureButtonDelayFromDetect()
Functionality.FunctionalityEditor	setShowCaptureButtonDelayFromStart(long showCaptureButtonDelayFromStart)	See Functionality.getShowCaptureButtonDelayFromStart()
Functionality.FunctionalityEditor	setShowChangeFrameButton(boolean showChangeFrameButton)	See Functionality.isShowChangeFrameButton()
Functionality.FunctionalityEditor	setShowCloseButton(boolean showCloseButton)	See Functionality.isShowCloseButton()
Functionality.FunctionalityEditor	setShowSkipNextPageButton(boolean showSkipNextPageButton)	See Functionality.isShowSkipNextPageButton()
Functionality.FunctionalityEditor	setShowTorchButton(boolean showTorchButton)	See Functionality.isShowTorchButton()
Functionality.FunctionalityEditor	setSkipFocusingFrames(boolean skipFocusingFrames)	See Functionality.isSkipFocusingFrames()
Functionality.FunctionalityEditor	setStartDocReaderForResult(boolean startForResult)	See Functionality.getStartDocReaderForResult()
Functionality.FunctionalityEditor	setUseAuthenticator(boolean useAuthenticator)	See Functionality.isUseAuthenticator()
Functionality.FunctionalityEditor	setVideoCaptureMotionControl(boolean videoCaptureMotionControl)	See Functionality.isVideoCaptureMotionControl()
Functionality.FunctionalityEditor	setZoomEnabled(boolean zoomEnabled)	See Functionality.isZoomEnabled()
Functionality.FunctionalityEditor	setZoomFactor(float zoomFactor)	See Functionality.getZoomFactor()

Methods inherited from class java.lang.Object

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

Method Detail

setUseAuthenticator

public Functionality.FunctionalityEditor setUseAuthenticator(boolean useAuthenticator)

See Functionality.isUseAuthenticator()

setPictureOnBoundsReady

public Functionality.FunctionalityEditor setPictureOnBoundsReady(boolean pictureOnBoundsReady)

See PictureOnBoundsReady

setCameraFrame

public Functionality.FunctionalityEditor setCameraFrame(java.lang.String cameraFrame)

See Functionality.getCameraFrame()

setOrientation

public Functionality.FunctionalityEditor setOrientation(int orientation)

See Functionality.getOrientation()

setShowTorchButton

public Functionality.FunctionalityEditor setShowTorchButton(boolean showTorchButton)

See Functionality.isShowTorchButton()

setShowCloseButton

public Functionality.FunctionalityEditor setShowCloseButton(boolean showCloseButton)

See Functionality.isShowCloseButton()

setVideoCaptureMotionControl

public Functionality.FunctionalityEditor setVideoCaptureMotionControl(boolean videoCaptureMotionControl)

See Functionality.isVideoCaptureMotionControl()

setShowCaptureButton

public Functionality.FunctionalityEditor setShowCaptureButton(boolean showCaptureButton)

See Functionality.isShowCaptureButton()

setShowChangeFrameButton

public Functionality.FunctionalityEditor setShowChangeFrameButton(boolean showChangeFrameButton)

See Functionality.isShowChangeFrameButton()

setShowCaptureButtonDelayFromDetect

public Functionality.FunctionalityEditor setShowCaptureButtonDelayFromDetect(long showCaptureButtonDelayFromDetect)

See Functionality.getShowCaptureButtonDelayFromDetect()

setShowCaptureButtonDelayFromStart

public Functionality.FunctionalityEditor setShowCaptureButtonDelayFromStart(long showCaptureButtonDelayFromStart)

See Functionality.getShowCaptureButtonDelayFromStart()

setDatabaseAutoupdate

public Functionality.FunctionalityEditor setDatabaseAutoupdate(boolean databaseAutoupdate)

See Functionality.isDatabaseAutoupdate()

setShowSkipNextPageButton

public Functionality.FunctionalityEditor setShowSkipNextPageButton(boolean showSkipNextPageButton)

See Functionality.isShowSkipNextPageButton()

setSkipFocusingFrames

public Functionality.FunctionalityEditor setSkipFocusingFrames(boolean skipFocusingFrames)

See Functionality.isSkipFocusingFrames()

setBtDeviceName

public Functionality.FunctionalityEditor setBtDeviceName(java.lang.String btDeviceName)

See Functionality.getBtDeviceName()

setShowCameraSwitchButton

public Functionality.FunctionalityEditor setShowCameraSwitchButton(boolean mShowCameraSwitchButton)

See Functionality.isShowCameraSwitchButton()

setStartDocReaderForResult

public Functionality.FunctionalityEditor setStartDocReaderForResult(boolean startForResult)

See Functionality.getStartDocReaderForResult()

setCaptureMode

public Functionality.FunctionalityEditor setCaptureMode(int captureMode)

See Functionality.getCaptureMode()

setDisplayMetadata

public Functionality.FunctionalityEditor setDisplayMetadata(boolean displayMetadata)

See Functionality.isDisplayMetaData()

setCameraSize

public Functionality.FunctionalityEditor setCameraSize(java.lang.Integer width,
                                                       java.lang.Integer height)

See Functionality.getCameraWidth() and Functionality.getCameraHeight()

setZoomEnabled

public Functionality.FunctionalityEditor setZoomEnabled(boolean zoomEnabled)

See Functionality.isZoomEnabled()

setZoomFactor

public Functionality.FunctionalityEditor setZoomFactor(float zoomFactor)

See Functionality.getZoomFactor()

setRfidTimeout

public Functionality.FunctionalityEditor setRfidTimeout(int rfidTimeout)

See Functionality.getRfidTimeout()

setExposure

public Functionality.FunctionalityEditor setExposure(float exposure)

See Functionality.getExposure()

setCameraMode

public Functionality.FunctionalityEditor setCameraMode(int cameraMode)

See Functionality.getCameraMode()

setExcludedCamera2Models

public Functionality.FunctionalityEditor setExcludedCamera2Models(java.util.List<java.lang.String> models)

See Functionality.getExcludedCamera2Models()

setDoRecordProcessingVideo

public Functionality.FunctionalityEditor setDoRecordProcessingVideo(boolean doRecordProcessingVideo)

See Functionality.doRecordProcessingVideo()

setIsCameraTorchCheckDisabled

public Functionality.FunctionalityEditor setIsCameraTorchCheckDisabled(boolean disabled)

As some devices have bug returning hasSystemFeature(PackageManager.FEATURE_CAMERA_FLASH) false when FLASH is actually available, use this to turn this check off !!!CAUTION!!! use at your own risk

Parameters:

disabled - false by default

setManualMultipageMode

public Functionality.FunctionalityEditor setManualMultipageMode(boolean isManualMultipageMode)

See Functionality.isManualMultipageMode()

setForcePagesCount

public Functionality.FunctionalityEditor setForcePagesCount(int forcePagesCount)

apply

public void apply()

Commit your changes back from this Editor to the Functionality object it is editing. This atomically performs the requested modifications, replacing whatever is currently in the Functionality.