All Implemented Interfaces:: java.io.Serializable


public class BaseScannerConfiguration
 implements Serializable

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`allowCaptureModeSetting`
`private Boolean`	`autoCapture`
`private ScanFilter`	`defaultScanFilter`
`private PageEditConfiguration`	`pageEditConfig`
`private Integer`	`theme`
`private ColorConfiguration`	`colorConfig`
`private Source`	`source`
`private List<File>`	`sourceImages`
`private Boolean`	`autoCrop`
`private Boolean`	`multiPage`
`private Boolean`	`preCaptureFocus`
`private TextConfiguration`	`textConfig`
`private ButtonConfiguration`	`buttonConfig`
`private Boolean`	`confirmPages`
`private Boolean`	`allowPageEditing`
`private Boolean`	`vibrateOnCapture`
`private StatusBarAppearance`	`statusBarAppearance`
`private NavigationBarAppearance`	`navigationBarAppearance`
`private Onboarding`	`onboarding`
`private ScanTips`	`scanTips`

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 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.
`final Boolean`	`getPreCaptureFocus()`	If true, the camera will run a focus action right before taking the image.
`final Unit`	`setPreCaptureFocus(Boolean preCaptureFocus)`	If true, the camera will run a focus action right before taking the image.
`final TextConfiguration`	`getTextConfig()`	Configuration class used to alter the default text behaviour.
`final Unit`	`setTextConfig(TextConfiguration textConfig)`	Configuration class used to alter the default text behaviour.
`final ButtonConfiguration`	`getButtonConfig()`	Configuration class used to alter the default buttons.
`final Unit`	`setButtonConfig(ButtonConfiguration buttonConfig)`	Configuration class used to alter the default buttons.
`final Boolean`	`getConfirmPages()`	If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished.
`final Unit`	`setConfirmPages(Boolean confirmPages)`	If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished.
`final Boolean`	`getAllowPageEditing()`	If true, after the scan screen is finished, an editing screen with the captured images will be displayed.
`final Unit`	`setAllowPageEditing(Boolean allowPageEditing)`	If true, after the scan screen is finished, an editing screen with the captured images will be displayed.
`final Boolean`	`getVibrateOnCapture()`	If true, when an image is captured, the device vibrates to signal successful capture.
`final Unit`	`setVibrateOnCapture(Boolean vibrateOnCapture)`	If true, when an image is captured, the device vibrates to signal successful capture.
`final StatusBarAppearance`	`getStatusBarAppearance()`	Overrides the status bar appearance.
`final Unit`	`setStatusBarAppearance(StatusBarAppearance statusBarAppearance)`	Overrides the status bar appearance.
`final NavigationBarAppearance`	`getNavigationBarAppearance()`	Overrides the navigation bar appearance.
`final Unit`	`setNavigationBarAppearance(NavigationBarAppearance navigationBarAppearance)`	Overrides the navigation bar appearance.
`final Onboarding`	`getOnboarding()`	An optional onboarding when the user opens the scanner for the first time.
`final Unit`	`setOnboarding(Onboarding onboarding)`	An optional onboarding when the user opens the scanner for the first time.
`final ScanTips`	`getScanTips()`	An optional toolbar item that shows scan tips when clicked.
`final Unit`	`setScanTips(ScanTips scanTips)`	An optional toolbar item that shows scan tips when clicked.

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

- 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.
  - 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 if 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 if 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.
  - getPreCaptureFocus
```
 final Boolean getPreCaptureFocus()
```
    If true, the camera will run a focus action right before taking the image. This improves the quality of the scanned images, but depending on the device, image capture might take a little bit longer. Defaults to true.
  - setPreCaptureFocus
```
 final Unit setPreCaptureFocus(Boolean preCaptureFocus)
```
    If true, the camera will run a focus action right before taking the image. This improves the quality of the scanned images, but depending on the device, image capture might take a little bit longer. Defaults to true.
  - getTextConfig
```
 final TextConfiguration getTextConfig()
```
    Configuration class used to alter the default text behaviour.
  - setTextConfig
```
 final Unit setTextConfig(TextConfiguration textConfig)
```
    Configuration class used to alter the default text behaviour.
  - getButtonConfig
```
 final ButtonConfiguration getButtonConfig()
```
    Configuration class used to alter the default buttons.
  - setButtonConfig
```
 final Unit setButtonConfig(ButtonConfiguration buttonConfig)
```
    Configuration class used to alter the default buttons.
  - getConfirmPages
```
 final Boolean getConfirmPages()
```
    If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished. Defaults to false.
  - setConfirmPages
```
 final Unit setConfirmPages(Boolean confirmPages)
```
    If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished. Defaults to false.
  - getAllowPageEditing
```
 final Boolean getAllowPageEditing()
```
    If true, after the scan screen is finished, an editing screen with the captured images will be displayed. On the editing screen, the user can crop manually, rotate the page, filter the page and much more. The editing screen can be configured by accessing the pageEditConfig. Defaults to true.
  - setAllowPageEditing
```
 final Unit setAllowPageEditing(Boolean allowPageEditing)
```
    If true, after the scan screen is finished, an editing screen with the captured images will be displayed. On the editing screen, the user can crop manually, rotate the page, filter the page and much more. The editing screen can be configured by accessing the pageEditConfig. Defaults to true.
  - getVibrateOnCapture
```
 final Boolean getVibrateOnCapture()
```
    If true, when an image is captured, the device vibrates to signal successful capture. Defaults to false.
  - setVibrateOnCapture
```
 final Unit setVibrateOnCapture(Boolean vibrateOnCapture)
```
    If true, when an image is captured, the device vibrates to signal successful capture. Defaults to false.
  - getStatusBarAppearance
```
 final StatusBarAppearance getStatusBarAppearance()
```
    Overrides the status bar appearance. By default, the system chooses the appearance based on the current UI Mode.
  - setStatusBarAppearance
```
 final Unit setStatusBarAppearance(StatusBarAppearance statusBarAppearance)
```
    Overrides the status bar appearance. By default, the system chooses the appearance based on the current UI Mode.
  - getNavigationBarAppearance
```
 final NavigationBarAppearance getNavigationBarAppearance()
```
    Overrides the navigation bar appearance. By default, the system chooses the appearance based on the current UI Mode.
  - setNavigationBarAppearance
```
 final Unit setNavigationBarAppearance(NavigationBarAppearance navigationBarAppearance)
```
    Overrides the navigation bar appearance. By default, the system chooses the appearance based on the current UI Mode.
  - getOnboarding
```
 final Onboarding getOnboarding()
```
    An optional onboarding when the user opens the scanner for the first time. See Onboarding for more details.
  - setOnboarding
```
 final Unit setOnboarding(Onboarding onboarding)
```
    An optional onboarding when the user opens the scanner for the first time. See Onboarding for more details.
  - getScanTips
```
 final ScanTips getScanTips()
```
    An optional toolbar item that shows scan tips when clicked. See ScanTips for more details.
  - setScanTips
```
 final Unit setScanTips(ScanTips scanTips)
```
    An optional toolbar item that shows scan tips when clicked. See ScanTips for more details.

Class BaseScannerConfiguration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAllowCaptureModeSetting

setAllowCaptureModeSetting

getAutoCapture

setAutoCapture

getDefaultScanFilter

setDefaultScanFilter

getPageEditConfig

setPageEditConfig

getTheme

setTheme

getColorConfig

setColorConfig

getSource

setSource

getSourceImages

setSourceImages

getAutoCrop

setAutoCrop

getMultiPage

setMultiPage

getPreCaptureFocus

setPreCaptureFocus

getTextConfig

setTextConfig

getButtonConfig

setButtonConfig

getConfirmPages

setConfirmPages

getAllowPageEditing

setAllowPageEditing

getVibrateOnCapture

setVibrateOnCapture

getStatusBarAppearance

setStatusBarAppearance

getNavigationBarAppearance

setNavigationBarAppearance

getOnboarding

setOnboarding

getScanTips

setScanTips