All Implemented Interfaces:: android.os.Parcelable


public final class ShutterButton
 implements Parcelable

Configuration of the 'shutter' button.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`enabledInAutoSnappingMode`
`private String`	`accessibilityDescription`
`private ScanbotColor`	`outerColor`
`private ScanbotColor`	`innerColor`

Constructor Summary

Constructors
Constructor	Description
`ShutterButton(Map<String, Object> source)`
`ShutterButton(JSONObject json)`
`ShutterButton(Boolean enabledInAutoSnappingMode, String accessibilityDescription, ScanbotColor outerColor, ScanbotColor innerColor)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getEnabledInAutoSnappingMode()`	Determines if the 'shutter' button can be tapped to manually snap a document when 'auto snapping mode' is active.
`final Unit`	`setEnabledInAutoSnappingMode(Boolean enabledInAutoSnappingMode)`	Determines if the 'shutter' button can be tapped to manually snap a document when 'auto snapping mode' is active.
`final String`	`getAccessibilityDescription()`	The text to be read when the 'shutter' button is selected via the accessibility mode.
`final Unit`	`setAccessibilityDescription(String accessibilityDescription)`	The text to be read when the 'shutter' button is selected via the accessibility mode.
`final ScanbotColor`	`getOuterColor()`	The outer color of the 'shutter' button.
`final Unit`	`setOuterColor(ScanbotColor outerColor)`	The outer color of the 'shutter' button.
`final ScanbotColor`	`getInnerColor()`	The inner color of the 'shutter' button.
`final Unit`	`setInnerColor(ScanbotColor innerColor)`	The inner color of the 'shutter' button.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final ShutterButton`	`clone()`
`final static ShutterButton`	`default()`

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

- Constructor Detail
  - ShutterButton
```
ShutterButton(Map<String, Object> source)
```
  - ShutterButton
```
ShutterButton(JSONObject json)
```
  - ShutterButton
```
ShutterButton(Boolean enabledInAutoSnappingMode, String accessibilityDescription, ScanbotColor outerColor, ScanbotColor innerColor)
```
- Method Detail
  - getEnabledInAutoSnappingMode
```
 final Boolean getEnabledInAutoSnappingMode()
```
    Determines if the 'shutter' button can be tapped to manually snap a document when 'auto snapping mode' is active.
    Default is true
  - setEnabledInAutoSnappingMode
```
 final Unit setEnabledInAutoSnappingMode(Boolean enabledInAutoSnappingMode)
```
    Determines if the 'shutter' button can be tapped to manually snap a document when 'auto snapping mode' is active.
    Default is true
  - getAccessibilityDescription
```
 final String getAccessibilityDescription()
```
    The text to be read when the 'shutter' button is selected via the accessibility mode.
    Default is "?accessibilityDescriptionCameraShutterButton"
  - setAccessibilityDescription
```
 final Unit setAccessibilityDescription(String accessibilityDescription)
```
    The text to be read when the 'shutter' button is selected via the accessibility mode.
    Default is "?accessibilityDescriptionCameraShutterButton"
  - getOuterColor
```
 final ScanbotColor getOuterColor()
```
    The outer color of the 'shutter' button.
    Default is "?sbColorOnPrimary"
  - setOuterColor
```
 final Unit setOuterColor(ScanbotColor outerColor)
```
    The outer color of the 'shutter' button.
    Default is "?sbColorOnPrimary"
  - getInnerColor
```
 final ScanbotColor getInnerColor()
```
    The inner color of the 'shutter' button.
    Default is "?sbColorOnPrimary"
  - setInnerColor
```
 final Unit setInnerColor(ScanbotColor innerColor)
```
    The inner color of the 'shutter' button.
    Default is "?sbColorOnPrimary"
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final ShutterButton clone()
```
  - default
```
 final static ShutterButton default()
```

Class ShutterButton

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ShutterButton

ShutterButton

ShutterButton

Method Detail

getEnabledInAutoSnappingMode

setEnabledInAutoSnappingMode

getAccessibilityDescription

setAccessibilityDescription

getOuterColor

setOuterColor

getInnerColor

setInnerColor

toJson

clone

default