All Implemented Interfaces:: java.io.Serializable


public final class DocumentScannerConfiguration
 implements Serializable

A configuration class used to alter the default scan behaviour.

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`allowCaptureModeSetting`
`private Boolean`	`autoCapture`
`private ScanFilter`	`defaultScanFilter`
`private PageEditConfiguration`	`pageEditConfig`
`private Integer`	`theme`
`private Integer`	`onboardingImageSource`
`private ColorConfiguration`	`colorConfig`
`private Source`	`source`
`private List<File>`	`sourceImages`
`private Boolean`	`autoCrop`
`private Boolean`	`multiPage`

Constructor Summary

Constructors
Constructor	Description
`DocumentScannerConfiguration()`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getAllowCaptureModeSetting()`	If true, the toolbar will display an Item allowing the user to switch between auto capture and manual capture.
`final Unit`	`setAllowCaptureModeSetting(Boolean allowCaptureModeSetting)`	If true, the toolbar will display an Item allowing the user to switch between auto capture and manual capture.
`final Boolean`	`getAutoCapture()`
`final Unit`	`setAutoCapture(Boolean autoCapture)`
`final ScanFilter`	`getDefaultScanFilter()`
`final Unit`	`setDefaultScanFilter(ScanFilter defaultScanFilter)`
`final PageEditConfiguration`	`getPageEditConfig()`	Configuration class used to alter the default page editing behaviour.
`final Unit`	`setPageEditConfig(PageEditConfiguration pageEditConfig)`	Configuration class used to alter the default page editing behaviour.
`final Integer`	`getTheme()`	Your custom theme if you like to change colors to match your branding.
`final Unit`	`setTheme(Integer theme)`	Your custom theme if you like to change colors to match your branding.
`final Integer`	`getOnboardingImageSource()`	Your custom image for the onboarding dialog that appears when scan is opened for the first time.
`final Unit`	`setOnboardingImageSource(Integer onboardingImageSource)`	Your custom image for the onboarding dialog that appears when scan is opened for the first time.
`final ColorConfiguration`	`getColorConfig()`
`final Unit`	`setColorConfig(ColorConfiguration colorConfig)`
`final Source`	`getSource()`	Select the source for the document scanner.
`final Unit`	`setSource(Source source)`	Select the source for the document scanner.
`final List<File>`	`getSourceImages()`	The source images for the document scanner if you have set the source to Source.IMAGE.
`final Unit`	`setSourceImages(List<File> sourceImages)`	The source images for the document scanner if you have set the source to Source.IMAGE.
`final Boolean`	`getAutoCrop()`	If true, image gets automatically cropped if document was detected.
`final Unit`	`setAutoCrop(Boolean autoCrop)`	If true, image gets automatically cropped if document was detected.
`final Boolean`	`getMultiPage()`	If true, scanning multi page documents is possible.
`final Unit`	`setMultiPage(Boolean multiPage)`	If true, scanning multi page documents is possible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentScannerConfiguration
```
DocumentScannerConfiguration()
```
- Method Detail
  - getAllowCaptureModeSetting
```
 final Boolean getAllowCaptureModeSetting()
```
    If true, the toolbar will display an Item allowing the user to switch between auto capture and manual capture. Defaults to false.
  - setAllowCaptureModeSetting
```
 final Unit setAllowCaptureModeSetting(Boolean allowCaptureModeSetting)
```
    If true, the toolbar will display an Item allowing the user to switch between auto capture and manual capture. Defaults to false.
  - getAutoCapture
```
 final Boolean getAutoCapture()
```
  - setAutoCapture
```
 final Unit setAutoCapture(Boolean autoCapture)
```
  - getDefaultScanFilter
```
 final ScanFilter getDefaultScanFilter()
```
  - setDefaultScanFilter
```
 final Unit setDefaultScanFilter(ScanFilter defaultScanFilter)
```
  - getPageEditConfig
```
 final PageEditConfiguration getPageEditConfig()
```
    Configuration class used to alter the default page editing behaviour.
  - setPageEditConfig
```
 final Unit setPageEditConfig(PageEditConfiguration pageEditConfig)
```
    Configuration class used to alter the default page editing behaviour.
  - getTheme
```
 final Integer getTheme()
```
    Your custom theme if you like to change colors to match your branding.
  - setTheme
```
 final Unit setTheme(Integer theme)
```
    Your custom theme if you like to change colors to match your branding.
  - getOnboardingImageSource
```
 final Integer getOnboardingImageSource()
```
    Your custom image for the onboarding dialog that appears when scan is opened for the first time.
  - setOnboardingImageSource
```
 final Unit setOnboardingImageSource(Integer onboardingImageSource)
```
    Your custom image for the onboarding dialog that appears when scan is opened for the first time.
  - getColorConfig
```
 final ColorConfiguration getColorConfig()
```
  - setColorConfig
```
 final Unit setColorConfig(ColorConfiguration colorConfig)
```
  - getSource
```
 final Source getSource()
```
    Select the source for the document scanner. Defaults to Source.CAMERA. See Source for possible values.
  - setSource
```
 final Unit setSource(Source source)
```
    Select the source for the document scanner. Defaults to Source.CAMERA. See Source for possible values.
  - getSourceImages
```
 final List<File> getSourceImages()
```
    The source images for the document scanner if you have set the source to Source.IMAGE.
  - setSourceImages
```
 final Unit setSourceImages(List<File> sourceImages)
```
    The source images for the document scanner if you have set the source to Source.IMAGE.
  - getAutoCrop
```
 final Boolean getAutoCrop()
```
    If true, image gets automatically cropped if document was detected. This applies only when source is Source.IMAGE or Source.GALLERY or Source.GALLERY_MULTIPLE. Defaults to true.
  - setAutoCrop
```
 final Unit setAutoCrop(Boolean autoCrop)
```
    If true, image gets automatically cropped if document was detected. This applies only when source is Source.IMAGE or Source.GALLERY or Source.GALLERY_MULTIPLE. Defaults to true.
  - getMultiPage
```
 final Boolean getMultiPage()
```
    If true, scanning multi page documents is possible. Set this to false if you need to scan single page documents. Defaults to true.
  - setMultiPage
```
 final Unit setMultiPage(Boolean multiPage)
```
    If true, scanning multi page documents is possible. Set this to false if you need to scan single page documents. Defaults to true.

Class DocumentScannerConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentScannerConfiguration

Method Detail

getAllowCaptureModeSetting

setAllowCaptureModeSetting

getAutoCapture

setAutoCapture

getDefaultScanFilter

setDefaultScanFilter

getPageEditConfig

setPageEditConfig

getTheme

setTheme

getOnboardingImageSource

setOnboardingImageSource

getColorConfig

setColorConfig

getSource

setSource

getSourceImages

setSourceImages

getAutoCrop

setAutoCrop

getMultiPage

setMultiPage