All Implemented Interfaces:: android.os.Parcelable


public final class TopBarConfiguration
 implements Parcelable

Configuration of the top bar's appearance.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private StyledText`	`title`
`private TopBarMode`	`mode`
`private StatusBarMode`	`statusBarMode`
`private ScanbotColor`	`backgroundColor`
`private ButtonConfiguration`	`cancelButton`

Constructor Summary

Constructors
Constructor	Description
`TopBarConfiguration(Map<String, Object> source)`
`TopBarConfiguration(JSONObject json)`
`TopBarConfiguration(StyledText title, TopBarMode mode, StatusBarMode statusBarMode, ScanbotColor backgroundColor, ButtonConfiguration cancelButton)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final StyledText`	`getTitle()`	Appearance of the top bar's title.
`final Unit`	`setTitle(StyledText title)`	Appearance of the top bar's title.
`final TopBarMode`	`getMode()`	The visual mode used for the top bar.
`final Unit`	`setMode(TopBarMode mode)`	The visual mode used for the top bar.
`final StatusBarMode`	`getStatusBarMode()`	The visual mode used for the status bar icons.
`final Unit`	`setStatusBarMode(StatusBarMode statusBarMode)`	The visual mode used for the status bar icons.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the top bar to be used when the visual mode is specified as SOLID.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the top bar to be used when the visual mode is specified as SOLID.
`final ButtonConfiguration`	`getCancelButton()`	Configuration of the 'cancel' button's appearance.
`final Unit`	`setCancelButton(ButtonConfiguration cancelButton)`	Configuration of the 'cancel' button's appearance.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final TopBarConfiguration`	`clone()`
`final static TopBarConfiguration`	`default()`

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

- Constructor Detail
  - TopBarConfiguration
```
TopBarConfiguration(Map<String, Object> source)
```
  - TopBarConfiguration
```
TopBarConfiguration(JSONObject json)
```
  - TopBarConfiguration
```
TopBarConfiguration(StyledText title, TopBarMode mode, StatusBarMode statusBarMode, ScanbotColor backgroundColor, ButtonConfiguration cancelButton)
```
- Method Detail
  - getTitle
```
 final StyledText getTitle()
```
    Appearance of the top bar's title.
  - setTitle
```
 final Unit setTitle(StyledText title)
```
    Appearance of the top bar's title.
  - getMode
```
 final TopBarMode getMode()
```
    The visual mode used for the top bar.
    Default is SOLID
  - setMode
```
 final Unit setMode(TopBarMode mode)
```
    The visual mode used for the top bar.
    Default is SOLID
  - getStatusBarMode
```
 final StatusBarMode getStatusBarMode()
```
    The visual mode used for the status bar icons.
    Default is LIGHT
  - setStatusBarMode
```
 final Unit setStatusBarMode(StatusBarMode statusBarMode)
```
    The visual mode used for the status bar icons.
    Default is LIGHT
  - getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
    The background color of the top bar to be used when the visual mode is specified as SOLID. Otherwise ignored.
    Default is "?sbColorPrimary"
  - setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
    The background color of the top bar to be used when the visual mode is specified as SOLID. Otherwise ignored.
    Default is "?sbColorPrimary"
  - getCancelButton
```
 final ButtonConfiguration getCancelButton()
```
    Configuration of the 'cancel' button's appearance.
  - setCancelButton
```
 final Unit setCancelButton(ButtonConfiguration cancelButton)
```
    Configuration of the 'cancel' button's appearance.
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final TopBarConfiguration clone()
```
  - default
```
 final static TopBarConfiguration default()
```

Class TopBarConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TopBarConfiguration

TopBarConfiguration

TopBarConfiguration

Method Detail

getTitle

setTitle

getMode

setMode

getStatusBarMode

setStatusBarMode

getBackgroundColor

setBackgroundColor

getCancelButton

setCancelButton

toJson

clone

default