All Implemented Interfaces:: android.os.Parcelable


public final class TextPatternScannerScreenConfiguration
 implements Parcelable

Configuration of the screen for detecting generic text data.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`version`
`private final String`	`screen`
`private TextPatternScannerScreenTextLocalization`	`localization`
`private Palette`	`palette`
`private ScanbotColor`	`backgroundColor`
`private CameraConfiguration`	`cameraConfiguration`
`private CameraPermissionScreen`	`cameraPermission`
`private UserGuidanceConfiguration`	`topUserGuidance`
`private UserGuidanceConfiguration`	`finderViewUserGuidance`
`private TopBarConfiguration`	`topBar`
`private IconButton`	`topBarOpenIntroScreenButton`
`private TextPatternScannerIntroScreenConfiguration`	`introScreen`
`private ActionBarConfiguration`	`actionBar`
`private PermanentViewFinderConfiguration`	`viewFinder`
`private TextPatternScannerConfiguration`	`scannerConfiguration`
`private Boolean`	`shouldShowWordBoxes`
`private ScanbotColor`	`wordBoxesFillColor`
`private ScanbotColor`	`wordBoxesLineColor`
`private Boolean`	`confirmationAlertDialogEnabled`
`private ScanbotAlertDialog`	`confirmationAlertDialog`
`private ScanCompletionOverlay`	`successOverlay`
`private Sound`	`sound`
`private Vibration`	`vibration`
`private Boolean`	`keepScreenOn`

Constructor Summary

Constructors
Constructor	Description
`TextPatternScannerScreenConfiguration(Map<String, Object> source)`
`TextPatternScannerScreenConfiguration(JSONObject json)`
TextPatternScannerScreenConfiguration(String version, String screen, TextPatternScannerScreenTextLocalization localization, Palette palette, ScanbotColor backgroundColor, CameraConfiguration cameraConfiguration, CameraPermissionScreen cameraPermission, UserGuidanceConfiguration topUserGuidance, UserGuidanceConfiguration finderViewUserGuidance, TopBarConfiguration topBar, IconButton topBarOpenIntroScreenButton, TextPatternScannerIntroScreenConfiguration introScreen, ActionBarConfiguration actionBar, PermanentViewFinderConfiguration viewFinder, TextPatternScannerConfiguration scannerConfiguration, Boolean shouldShowWordBoxes, ScanbotColor wordBoxesFillColor, ScanbotColor wordBoxesLineColor, Boolean confirmationAlertDialogEnabled, ScanbotAlertDialog confirmationAlertDialog, ScanCompletionOverlay successOverlay, Sound sound, Vibration vibration, Boolean keepScreenOn)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getVersion()`	Version number of the configuration object.
`final String`	`getScreen()`	The configuration object should be applied for this screen.
`final TextPatternScannerScreenTextLocalization`	`getLocalization()`	Configuration of the all strings for generic text scanner screen.
`final Unit`	`setLocalization(TextPatternScannerScreenTextLocalization localization)`	Configuration of the all strings for generic text scanner screen.
`final Palette`	`getPalette()`	Define the screen's base color values from which other colors are derived.
`final Unit`	`setPalette(Palette palette)`	Define the screen's base color values from which other colors are derived.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the generic text scanner screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the generic text scanner screen.
`final CameraConfiguration`	`getCameraConfiguration()`	Configuration of the camera behavior.
`final Unit`	`setCameraConfiguration(CameraConfiguration cameraConfiguration)`	Configuration of the camera behavior.
`final CameraPermissionScreen`	`getCameraPermission()`	Configuration of the dialog for requesting camera permissions.
`final Unit`	`setCameraPermission(CameraPermissionScreen cameraPermission)`	Configuration of the dialog for requesting camera permissions.
`final UserGuidanceConfiguration`	`getTopUserGuidance()`	Configuration of the top user guidance.
`final Unit`	`setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)`	Configuration of the top user guidance.
`final UserGuidanceConfiguration`	`getFinderViewUserGuidance()`	Configuration of the user guidance below finder view.
`final Unit`	`setFinderViewUserGuidance(UserGuidanceConfiguration finderViewUserGuidance)`	Configuration of the user guidance below finder view.
`final TopBarConfiguration`	`getTopBar()`	Configuration of the top bar on the generic text scanner screen.
`final Unit`	`setTopBar(TopBarConfiguration topBar)`	Configuration of the top bar on the generic text scanner screen.
`final IconButton`	`getTopBarOpenIntroScreenButton()`	Configuration of the button in the top bar that opens the introduction screen.
`final Unit`	`setTopBarOpenIntroScreenButton(IconButton topBarOpenIntroScreenButton)`	Configuration of the button in the top bar that opens the introduction screen.
`final TextPatternScannerIntroScreenConfiguration`	`getIntroScreen()`	Configuration of the introduction screen for the generic text scanner screen.
`final Unit`	`setIntroScreen(TextPatternScannerIntroScreenConfiguration introScreen)`	Configuration of the introduction screen for the generic text scanner screen.
`final ActionBarConfiguration`	`getActionBar()`	Configuration of the action bar.
`final Unit`	`setActionBar(ActionBarConfiguration actionBar)`	Configuration of the action bar.
`final PermanentViewFinderConfiguration`	`getViewFinder()`	Configuration of the view finder.
`final Unit`	`setViewFinder(PermanentViewFinderConfiguration viewFinder)`	Configuration of the view finder.
`final TextPatternScannerConfiguration`	`getScannerConfiguration()`	Configuration of the scanner.
`final Unit`	`setScannerConfiguration(TextPatternScannerConfiguration scannerConfiguration)`	Configuration of the scanner.
`final Boolean`	`getShouldShowWordBoxes()`	Whether word boxes should be displayed or not.
`final Unit`	`setShouldShowWordBoxes(Boolean shouldShowWordBoxes)`	Whether word boxes should be displayed or not.
`final ScanbotColor`	`getWordBoxesFillColor()`	The color of word boxes filling.
`final Unit`	`setWordBoxesFillColor(ScanbotColor wordBoxesFillColor)`	The color of word boxes filling.
`final ScanbotColor`	`getWordBoxesLineColor()`	The color of word boxes border lines.
`final Unit`	`setWordBoxesLineColor(ScanbotColor wordBoxesLineColor)`	The color of word boxes border lines.
`final Boolean`	`getConfirmationAlertDialogEnabled()`	If the confirmation alert dialog is enabled.
`final Unit`	`setConfirmationAlertDialogEnabled(Boolean confirmationAlertDialogEnabled)`	If the confirmation alert dialog is enabled.
`final ScanbotAlertDialog`	`getConfirmationAlertDialog()`	Configuration of the confirmation alert dialog.
`final Unit`	`setConfirmationAlertDialog(ScanbotAlertDialog confirmationAlertDialog)`	Configuration of the confirmation alert dialog.
`final ScanCompletionOverlay`	`getSuccessOverlay()`	Configuration of the result overlay.
`final Unit`	`setSuccessOverlay(ScanCompletionOverlay successOverlay)`	Configuration of the result overlay.
`final Sound`	`getSound()`	Configuration of the scan confirmation sound.
`final Unit`	`setSound(Sound sound)`	Configuration of the scan confirmation sound.
`final Vibration`	`getVibration()`	Configuration of the vibration feedback.
`final Unit`	`setVibration(Vibration vibration)`	Configuration of the vibration feedback.
`final Boolean`	`getKeepScreenOn()`	If enabled, the screen will not turn off while the barcode scanner is active.
`final Unit`	`setKeepScreenOn(Boolean keepScreenOn)`	If enabled, the screen will not turn off while the barcode scanner is active.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final TextPatternScannerScreenConfiguration`	`clone()`
`final static TextPatternScannerScreenConfiguration`	`default()`

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

Constructor Detail

TextPatternScannerScreenConfiguration

TextPatternScannerScreenConfiguration(Map<String, Object> source)

TextPatternScannerScreenConfiguration

TextPatternScannerScreenConfiguration(JSONObject json)

TextPatternScannerScreenConfiguration

TextPatternScannerScreenConfiguration(String version, String screen, TextPatternScannerScreenTextLocalization localization, Palette palette, ScanbotColor backgroundColor, CameraConfiguration cameraConfiguration, CameraPermissionScreen cameraPermission, UserGuidanceConfiguration topUserGuidance, UserGuidanceConfiguration finderViewUserGuidance, TopBarConfiguration topBar, IconButton topBarOpenIntroScreenButton, TextPatternScannerIntroScreenConfiguration introScreen, ActionBarConfiguration actionBar, PermanentViewFinderConfiguration viewFinder, TextPatternScannerConfiguration scannerConfiguration, Boolean shouldShowWordBoxes, ScanbotColor wordBoxesFillColor, ScanbotColor wordBoxesLineColor, Boolean confirmationAlertDialogEnabled, ScanbotAlertDialog confirmationAlertDialog, ScanCompletionOverlay successOverlay, Sound sound, Vibration vibration, Boolean keepScreenOn)

Method Detail
- getVersion
```
 final String getVersion()
```
  Version number of the configuration object.
  Default is "1.0"
- getScreen
```
 final String getScreen()
```
  The configuration object should be applied for this screen.
  Default is "TextPatternScanner"
- getLocalization
```
 final TextPatternScannerScreenTextLocalization getLocalization()
```
  Configuration of the all strings for generic text scanner screen.
- setLocalization
```
 final Unit setLocalization(TextPatternScannerScreenTextLocalization localization)
```
  Configuration of the all strings for generic text scanner screen.
- getPalette
```
 final Palette getPalette()
```
  Define the screen's base color values from which other colors are derived.
- setPalette
```
 final Unit setPalette(Palette palette)
```
  Define the screen's base color values from which other colors are derived.
- getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
  The background color of the generic text scanner screen.
  Default is "?sbColorSurfaceLow"
- setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
  The background color of the generic text scanner screen.
  Default is "?sbColorSurfaceLow"
- getCameraConfiguration
```
 final CameraConfiguration getCameraConfiguration()
```
  Configuration of the camera behavior.
- setCameraConfiguration
```
 final Unit setCameraConfiguration(CameraConfiguration cameraConfiguration)
```
  Configuration of the camera behavior.
- getCameraPermission
```
 final CameraPermissionScreen getCameraPermission()
```
  Configuration of the dialog for requesting camera permissions.
- setCameraPermission
```
 final Unit setCameraPermission(CameraPermissionScreen cameraPermission)
```
  Configuration of the dialog for requesting camera permissions.
- getTopUserGuidance
```
 final UserGuidanceConfiguration getTopUserGuidance()
```
  Configuration of the top user guidance.
- setTopUserGuidance
```
 final Unit setTopUserGuidance(UserGuidanceConfiguration topUserGuidance)
```
  Configuration of the top user guidance.
- getFinderViewUserGuidance
```
 final UserGuidanceConfiguration getFinderViewUserGuidance()
```
  Configuration of the user guidance below finder view.
- setFinderViewUserGuidance
```
 final Unit setFinderViewUserGuidance(UserGuidanceConfiguration finderViewUserGuidance)
```
  Configuration of the user guidance below finder view.
- getTopBar
```
 final TopBarConfiguration getTopBar()
```
  Configuration of the top bar on the generic text scanner screen.
- setTopBar
```
 final Unit setTopBar(TopBarConfiguration topBar)
```
  Configuration of the top bar on the generic text scanner screen.
- getTopBarOpenIntroScreenButton
```
 final IconButton getTopBarOpenIntroScreenButton()
```
  Configuration of the button in the top bar that opens the introduction screen.
- setTopBarOpenIntroScreenButton
```
 final Unit setTopBarOpenIntroScreenButton(IconButton topBarOpenIntroScreenButton)
```
  Configuration of the button in the top bar that opens the introduction screen.
- getIntroScreen
```
 final TextPatternScannerIntroScreenConfiguration getIntroScreen()
```
  Configuration of the introduction screen for the generic text scanner screen.
- setIntroScreen
```
 final Unit setIntroScreen(TextPatternScannerIntroScreenConfiguration introScreen)
```
  Configuration of the introduction screen for the generic text scanner screen.
- getActionBar
```
 final ActionBarConfiguration getActionBar()
```
  Configuration of the action bar.
- setActionBar
```
 final Unit setActionBar(ActionBarConfiguration actionBar)
```
  Configuration of the action bar.
- getViewFinder
```
 final PermanentViewFinderConfiguration getViewFinder()
```
  Configuration of the view finder.
- setViewFinder
```
 final Unit setViewFinder(PermanentViewFinderConfiguration viewFinder)
```
  Configuration of the view finder.
- getScannerConfiguration
```
 final TextPatternScannerConfiguration getScannerConfiguration()
```
  Configuration of the scanner.
- setScannerConfiguration
```
 final Unit setScannerConfiguration(TextPatternScannerConfiguration scannerConfiguration)
```
  Configuration of the scanner.
- getShouldShowWordBoxes
```
 final Boolean getShouldShowWordBoxes()
```
  Whether word boxes should be displayed or not.
  Default is true
- setShouldShowWordBoxes
```
 final Unit setShouldShowWordBoxes(Boolean shouldShowWordBoxes)
```
  Whether word boxes should be displayed or not.
  Default is true
- getWordBoxesFillColor
```
 final ScanbotColor getWordBoxesFillColor()
```
  The color of word boxes filling. Works best with an alpha < 0.5.
  Default is "#33CCE54C"
- setWordBoxesFillColor
```
 final Unit setWordBoxesFillColor(ScanbotColor wordBoxesFillColor)
```
  The color of word boxes filling. Works best with an alpha < 0.5.
  Default is "#33CCE54C"
- getWordBoxesLineColor
```
 final ScanbotColor getWordBoxesLineColor()
```
  The color of word boxes border lines.
  Default is "#33CCE599"
- setWordBoxesLineColor
```
 final Unit setWordBoxesLineColor(ScanbotColor wordBoxesLineColor)
```
  The color of word boxes border lines.
  Default is "#33CCE599"
- getConfirmationAlertDialogEnabled
```
 final Boolean getConfirmationAlertDialogEnabled()
```
  If the confirmation alert dialog is enabled.
  Default is false
- setConfirmationAlertDialogEnabled
```
 final Unit setConfirmationAlertDialogEnabled(Boolean confirmationAlertDialogEnabled)
```
  If the confirmation alert dialog is enabled.
  Default is false
- getConfirmationAlertDialog
```
 final ScanbotAlertDialog getConfirmationAlertDialog()
```
  Configuration of the confirmation alert dialog.
- setConfirmationAlertDialog
```
 final Unit setConfirmationAlertDialog(ScanbotAlertDialog confirmationAlertDialog)
```
  Configuration of the confirmation alert dialog.
- getSuccessOverlay
```
 final ScanCompletionOverlay getSuccessOverlay()
```
  Configuration of the result overlay.
- setSuccessOverlay
```
 final Unit setSuccessOverlay(ScanCompletionOverlay successOverlay)
```
  Configuration of the result overlay.
- getSound
```
 final Sound getSound()
```
  Configuration of the scan confirmation sound.
- setSound
```
 final Unit setSound(Sound sound)
```
  Configuration of the scan confirmation sound.
- getVibration
```
 final Vibration getVibration()
```
  Configuration of the vibration feedback.
- setVibration
```
 final Unit setVibration(Vibration vibration)
```
  Configuration of the vibration feedback.
- getKeepScreenOn
```
 final Boolean getKeepScreenOn()
```
  If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
  Default is true
- setKeepScreenOn
```
 final Unit setKeepScreenOn(Boolean keepScreenOn)
```
  If enabled, the screen will not turn off while the barcode scanner is active. (Android only).
  Default is true
- toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
- clone
```
 final TextPatternScannerScreenConfiguration clone()
```
- default
```
 final static TextPatternScannerScreenConfiguration default()
```

Class TextPatternScannerScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextPatternScannerScreenConfiguration

TextPatternScannerScreenConfiguration

TextPatternScannerScreenConfiguration

Method Detail

getVersion

getScreen

getLocalization

setLocalization

getPalette

setPalette

getBackgroundColor

setBackgroundColor

getCameraConfiguration

setCameraConfiguration

getCameraPermission

setCameraPermission

getTopUserGuidance

setTopUserGuidance

getFinderViewUserGuidance

setFinderViewUserGuidance

getTopBar

setTopBar

getTopBarOpenIntroScreenButton

setTopBarOpenIntroScreenButton

getIntroScreen

setIntroScreen

getActionBar

setActionBar

getViewFinder

setViewFinder

getScannerConfiguration

setScannerConfiguration

getShouldShowWordBoxes

setShouldShowWordBoxes

getWordBoxesFillColor

setWordBoxesFillColor

getWordBoxesLineColor

setWordBoxesLineColor

getConfirmationAlertDialogEnabled

setConfirmationAlertDialogEnabled

getConfirmationAlertDialog

setConfirmationAlertDialog

getSuccessOverlay

setSuccessOverlay

getSound

setSound

getVibration

setVibration

getKeepScreenOn

setKeepScreenOn

toJson

clone

default