Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience Class Reference
Inheritance diagram for com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience:
com.kofax.kmc.kui.uicontrols.captureanimations.DocumentBaseCaptureExperience com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience com.kofax.kmc.kui.uicontrols.StabilityDelayListener com.kofax.kmc.kui.uicontrols.LevelnessListener com.kofax.kmc.kui.uicontrols.AutoFocusResultListener com.kofax.kmc.kui.uicontrols.ImageCapturedListener

Public Member Functions

 CheckCaptureExperience (ImageCaptureView view)
 
 CheckCaptureExperience (ImageCaptureView view, CheckCaptureExperienceCriteriaHolder criteria)
 
CaptureMessage getUserInstructionMessage ()
 
void setUserInstructionMessage (CaptureMessage userInstructionsMessage)
 
CaptureMessage getCenterMessage ()
 
void setCenterMessage (CaptureMessage centerMessage)
 
Bitmap getCheckSampleImage ()
 
void setCheckSampleImage (Bitmap checkSampleImage)
 
void setCaptureCriteria (CheckCaptureExperienceCriteriaHolder criteria)
 
CheckCaptureExperienceCriteriaHolder getCaptureCriteria ()
 
- Public Member Functions inherited from com.kofax.kmc.kui.uicontrols.captureanimations.DocumentBaseCaptureExperience
 DocumentBaseCaptureExperience (ImageCaptureView view, DocumentBaseCaptureExperienceCriteriaHolder criteria)
 
final void addOnImageCapturedListener (ImageCapturedListener listener)
 
final void removeOnImageCapturedListener (ImageCapturedListener listener)
 
final void setVibrationEnabled (boolean enable)
 
boolean isVibrationEnabled ()
 
void takePicture ()
 
void takePictureContinually ()
 
void stopCapture ()
 
void destroy ()
 
void enableAnimationTutor (boolean enable)
 
boolean isAnimationTutorEnable ()
 
CaptureMessage getUserInstructionMessage ()
 
void setUserInstructionMessage (CaptureMessage userInstructionsMessage)
 
CaptureMessage getHoldSteadyMessage ()
 
void setHoldSteadyMessage (CaptureMessage holdSteadyMessage)
 
void setCenterMessage (CaptureMessage centerMessage)
 
CaptureMessage getCenterMessage ()
 
void setZoomInMessage (CaptureMessage zoomInMessage)
 
CaptureMessage getZoomInMessage ()
 
void setZoomOutMessage (CaptureMessage zoomOutMessage)
 
CaptureMessage getZoomOutMessage ()
 
void setRotateMessage (CaptureMessage message)
 
CaptureMessage getRotateMessage ()
 
void setHoldParallelMessage (CaptureMessage message)
 
CaptureMessage getHoldParallelMessage ()
 
void setCapturedMessage (CaptureMessage capturedMessage)
 
CaptureMessage getCapturedMessage ()
 
void setOuterViewFinderColor (int colorCode)
 Outer view finder color. More...
 
int getOuterViewFinderColor ()
 
void setGuidanceFrameColor (int colorCode)
 Guidance frame color. More...
 
void setSteadyGuidanceFrameColor (int colorCode)
 Steady guidance frame color. More...
 
int getGuidanceFrameColor ()
 
double getPaddingPercent ()
 
Bitmap getDocumentSampleImage ()
 
void setDocumentSampleImage (Bitmap documentSampleImage)
 
void addPageDetectionListener (PageDetectionListener listener)
 
void removePageDetectionListener (PageDetectionListener listener)
 
- Public Member Functions inherited from com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience
void addOnImageCapturedListener (ImageCapturedListener listener)
 
void removeOnImageCapturedListener (ImageCapturedListener listener)
 
void setVibrationEnabled (boolean enable)
 
boolean isVibrationEnabled ()
 
void takePicture ()
 
void takePictureContinually ()
 
void stopCapture ()
 
void onImageCaptured (ImageCapturedEvent event)
 Invoked when the camera captures an image. More...
 
void onAutoFocus (AutoFocusResultEvent event)
 Invoked when the camera completes focusing. More...
 
void onLevelness (LevelnessEvent event)
 Invoked when the orientation of the device changes. More...
 
void onStabilityDelay (StabilityDelayEvent event)
 Invoked when stability levels change. More...
 
void destroy ()
 

Additional Inherited Members

- Protected Member Functions inherited from com.kofax.kmc.kui.uicontrols.captureanimations.DocumentBaseCaptureExperience
void initBase (ImageCaptureView view, DocumentBaseCaptureExperienceCriteriaHolder criteria)
 
- Protected Member Functions inherited from com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience
void invokeImageCapturedListeners (ImageCapturedEvent event)
 
boolean captureCriteriaMetInternal (CaptureExperienceData data)
 
- Protected Attributes inherited from com.kofax.kmc.kui.uicontrols.captureanimations.DocumentBaseCaptureExperience
Context _ctx
 
- Protected Attributes inherited from com.kofax.kmc.kui.uicontrols.captureanimations.CaptureExperience
CaptureExperienceData _captureExperienceData = new CaptureExperienceData()
 
final Object _lock
 
boolean _sdkCaptureRequested
 
boolean _continuousCapture
 
ImageCaptureView _imageCaptureView
 
final Handler _uiHandler = new Handler(Looper.getMainLooper())
 
boolean _continuousReset
 
float _aspectRatio
 
Set< ImageCapturedListener_imageCapturedListeners = new LinkedHashSet<ImageCapturedListener>()
 
Vibrator _vibrator
 
boolean _vibrationEnabled = false
 

Detailed Description

This class is responsible for rendering the enhanced visual experience on an ImageCaptureView and provides feedback to guide the user to take a clear, legible and optimally zoomed in photo of a document. Criteria of such a document can be specified by using a setCaptureCriteria(CheckCaptureExperienceCriteriaHolder) method.

When the criteria are satisfied, a photo can be taken automatically, to enable it use takePicture() or takePictureContinually().

Note: CheckCaptureExperience is best used on a view that occupies the maximum possible area of its parent view.

Constructor & Destructor Documentation

com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.CheckCaptureExperience ( ImageCaptureView  view)
inline

Constructs an experience on a given ImageCaptureView.

Parameters
viewThe ImageCaptureView this will be drawn onto
com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.CheckCaptureExperience ( ImageCaptureView  view,
CheckCaptureExperienceCriteriaHolder  criteria 
)
inline

Constructs an experience on a given ImageCaptureView with specific CheckCaptureExperienceCriteriaHolder

Parameters
viewThe ImageCaptureView this will be drawn onto
criteriaThe criteria used to determine if a photo should be taken

Member Function Documentation

CheckCaptureExperienceCriteriaHolder com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.getCaptureCriteria ( )
inline

Returns the criteria used to determine if a photo should be taken.

Returns
CheckCaptureExperienceCriteriaHolder
See also
CheckCaptureExperienceCriteriaHolder
CaptureMessage com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.getCenterMessage ( )
inline

Returns the attributes of the message that is displayed when document is not enough centered in the target frame for capture.

Default configuration:

  • message: "Center Check"
  • text color: white
  • background color: black with 0.7 alpha component
  • background drawable: not specified
  • text size: 16
  • typeface: not specified
  • messageIcons: not specified
  • orientation: CaptureMessage.KUIMessageOrientation#LANDSCAPE
  • width and height: not specified
  • position: center
  • visibility: true
Returns
CaptureMessage The center message
See also
setCenterMessage(CaptureMessage)
CaptureMessage
Bitmap com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.getCheckSampleImage ( )
inline

The Bitmap of a sample check that is displayed over the check frame area when the animated tutorial is enabled.

Returns
Bitmap The sample check image
See also
setDocumentSampleImage(android.graphics.Bitmap)
CaptureMessage com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.getUserInstructionMessage ( )
inline

Returns the attributes of the instruction message that is displayed on the capture control while the user is trying to capture. This instruction will be displayed during periods where other guidance is not available to correct a user. This may happen in particular when the user is holding a device far away from a document, preventing detection.

The following CaptureMessage properties are not supported for this message:

Default configuration:

  • message: "Fill viewable area with check"
  • text color: white
  • background color: transparent
  • background drawable: not specified
  • text size: 32
  • typeface: not specified
  • orientation: CaptureMessage.KUIMessageOrientation#LANDSCAPE
  • width and height: not specified
  • position: center
  • visibility: true
Returns
CaptureMessage The instruction capture message
See also
CaptureMessage
void com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.setCaptureCriteria ( CheckCaptureExperienceCriteriaHolder  criteria)
inline

Calling this method will cause all of the capture related parameters to be configured

Parameters
criteriaThe criteria used to determine if a photo should be taken
See also
CheckCaptureExperienceCriteriaHolder
void com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.setCenterMessage ( CaptureMessage  centerMessage)
inline

This instruction will be displayed when document is not centered in the target frame

Parameters
centerMessageThe center message
See also
CaptureMessage
void com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.setCheckSampleImage ( Bitmap  checkSampleImage)
inline

The specified Bitmap of a sample check is displayed over the check frame area when the animated tutorial is enabled. The sample check image is stretched if necessary to fill the entire check frame area. While the tutorial is running, MICR and guidance animation are superimposed over the image. A default check sample image is used if this is not set by the app.

Parameters
checkSampleImageThe sample check image
See also
enableAnimationTutor(boolean)
void com.kofax.kmc.kui.uicontrols.captureanimations.CheckCaptureExperience.setUserInstructionMessage ( CaptureMessage  userInstructionsMessage)
inline

A property to configure the attributes of the instruction message that is displayed on the capture control while user is trying to capture.

Parameters
userInstructionsMessage: CaptureMessage
See also
CaptureMessage

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.