All Implemented Interfaces:: com.abbyy.mobile.uicomponents.scenario.CaptureScenario


public final class DataCaptureScenario
extends BaseCaptureScenario implements CaptureScenario

Scenario for data capture.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`DataCaptureScenario.CharInfo`	Extended information about the character formatting.
`public final class`	`DataCaptureScenario.DataField`	A recognized data field. Provides field contents, location and included data fields, if applicable.
`public final class`	`DataCaptureScenario.DataFieldInfo`	Information about a data field that can be detected on current data scheme. Provides field id, name and, if applicable, included data fields.
`public final class`	`DataCaptureScenario.DataScheme`	Information on the data scheme applied to the recognized frame. This class provides access to the identifier and human-readable name of the scheme, as well as full list of fields that can be detected on a document applying this data scheme.
`public final class`	`DataCaptureScenario.Result`	The result of DataCaptureScenario.
`public interface`	`DataCaptureScenario.Callback`	The callback for DataCaptureScenario.
`public interface`	`DataCaptureScenario.CloseListener`	Listener for the close button.
`public enum`	`DataCaptureScenario.ResourceType`	String resources for DataCaptureScenario that should be shown according to the corresponding view control.
`public interface`	`DataCaptureScenario.UISettings`	Provides access to extra user interface settings of current view control.
`public interface`	`DataCaptureScenario.DataCaptureSettings`	Settings of data capture.
`public final class`	`DataCaptureScenario.AreaOfInterest`	Area of interest for data capture.

Field Summary

Fields
Modifier and Type	Field	Description
`private final ImageCaptureSettings`	`imageCaptureSettings`
`private final DataCaptureScenario.DataCaptureSettings`	`dataCaptureSettings`

Constructor Summary

Constructors
Constructor	Description
`DataCaptureScenario(Engine engine)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`setCallback(DataCaptureScenario.Callback callback)`	Set the scenario callback.
`final Unit`	`setCloseListener(DataCaptureScenario.CloseListener closeListener)`	Set the scenario cancellation listener.
`final Unit`	`start()`	Start the scenario execution.
`final Unit`	`stop()`	Stops automatic and manual capture and releases the resources.
`final Unit`	`setAutoCaptureEnabled(Boolean isEnabled)`	Enable the real-time capture from the camera preview.
`final Boolean`	`isAutoCaptureEnabled()`	Check if the automatic capture is currently running
`final Unit`	`pickImageFromGallery()`	Open image gallery view.
`final Unit`	`captureDataManually()`	Start the data capture manually
`final Unit`	`setGalleryButtonEnabled(Boolean isEnabled)`	Enable the gallery button for user interaction.
`final Boolean`	`isGalleryButtonEnabled()`	Check if the gallery button is enabled for user interaction.
`final Unit`	`setUISettings(DataCaptureScenario.UISettings uiSettings)`	Set the extra UI settings of the CaptureView
`final Unit`	`setNamedProperty(String name, Object value)`	Set the named extended property of the scenario.
`final ImageCaptureSettings`	`getImageCaptureSettings()`	Get the settings for the image capture configuration.
`final DataCaptureScenario.DataCaptureSettings`	`getDataCaptureSettings()`	Get the settings for the data capture configuration.

Methods inherited from class com.abbyy.mobile.uicomponents.scenario.CaptureScenario
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DataCaptureScenario
```
DataCaptureScenario(Engine engine)
```
- Method Detail
  - setCallback
```
@MainThread() final Unit setCallback(DataCaptureScenario.Callback callback)
```
    Set the scenario callback.
  - setCloseListener
```
@MainThread() final Unit setCloseListener(DataCaptureScenario.CloseListener closeListener)
```
    Set the scenario cancellation listener.
  - start
```
@MainThread() final Unit start()
```
    Start the scenario execution.
  - stop
```
@MainThread() final Unit stop()
```
    Stops automatic and manual capture and releases the resources.
  - setAutoCaptureEnabled
```
@MainThread() final Unit setAutoCaptureEnabled(Boolean isEnabled)
```
    Enable the real-time capture from the camera preview. If the auto-capture mode is disabled, data should be captured manually.
    
    Parameters:
    
    isEnabled - Set true to enable the automatic capture from the camera preview and false to enable manual capture mode.
  - isAutoCaptureEnabled
```
@MainThread() final Boolean isAutoCaptureEnabled()
```
    Check if the automatic capture is currently running
  - pickImageFromGallery
```
@MainThread() final Unit pickImageFromGallery()
```
    Open image gallery view. This method can be used for implementing your own gallery button.
  - captureDataManually
```
@MainThread() final Unit captureDataManually()
```
    Start the data capture manually
  - setGalleryButtonEnabled
```
@MainThread() final Unit setGalleryButtonEnabled(Boolean isEnabled)
```
    Enable the gallery button for user interaction.
    
    Parameters:
    
    isEnabled - Set true to enable the button and false to disable it.
  - isGalleryButtonEnabled
```
@MainThread() final Boolean isGalleryButtonEnabled()
```
    Check if the gallery button is enabled for user interaction.
  - setUISettings
```
@MainThread() final Unit setUISettings(DataCaptureScenario.UISettings uiSettings)
```
    Set the extra UI settings of the CaptureView
  - setNamedProperty
```
@MainThread() final Unit setNamedProperty(String name, Object value)
```
    Set the named extended property of the scenario.
    
    Parameters:
    
    name - the name of the property
    
    value - the value of the property
  - getImageCaptureSettings
```
@MainThread() final ImageCaptureSettings getImageCaptureSettings()
```
    Get the settings for the image capture configuration.
  - getDataCaptureSettings
```
@MainThread() final DataCaptureScenario.DataCaptureSettings getDataCaptureSettings()
```
    Get the settings for the data capture configuration.

Class DataCaptureScenario

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.abbyy.mobile.uicomponents.scenario.CaptureScenario

Methods inherited from class java.lang.Object

Constructor Detail

DataCaptureScenario

Method Detail

setCallback

setCloseListener

start

stop

setAutoCaptureEnabled

isAutoCaptureEnabled

pickImageFromGallery

captureDataManually

setGalleryButtonEnabled

isGalleryButtonEnabled

setUISettings

setNamedProperty

getImageCaptureSettings

getDataCaptureSettings