All Implemented Interfaces:: android.os.Parcelable


public final class CroppingScreenConfiguration
 implements Parcelable

Configuration of the screen for cropping the scanned pages.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private ButtonConfiguration`	`topBarBackButton`
`private StyledText`	`topBarTitle`
`private ButtonConfiguration`	`topBarConfirmButton`
`private ScanbotColor`	`backgroundColor`
`private ScanbotColor`	`croppingHandlerColor`
`private ScanbotColor`	`croppingPolygonColor`
`private ScanbotColor`	`croppingPolygonMagneticLineColor`
`private CroppingBottomBar`	`bottomBar`

Constructor Summary

Constructors
Constructor	Description
`CroppingScreenConfiguration(Map<String, Object> source)`
`CroppingScreenConfiguration(JSONObject json)`
`CroppingScreenConfiguration(ButtonConfiguration topBarBackButton, StyledText topBarTitle, ButtonConfiguration topBarConfirmButton, ScanbotColor backgroundColor, ScanbotColor croppingHandlerColor, ScanbotColor croppingPolygonColor, ScanbotColor croppingPolygonMagneticLineColor, CroppingBottomBar bottomBar)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final ButtonConfiguration`	`getTopBarBackButton()`	Configuration of the 'cancel' button, located in the top bar.
`final Unit`	`setTopBarBackButton(ButtonConfiguration topBarBackButton)`	Configuration of the 'cancel' button, located in the top bar.
`final StyledText`	`getTopBarTitle()`	Configuration of the title, located in the top bar.
`final Unit`	`setTopBarTitle(StyledText topBarTitle)`	Configuration of the title, located in the top bar.
`final ButtonConfiguration`	`getTopBarConfirmButton()`	Configuration of the 'confirm' button, located in the top bar.
`final Unit`	`setTopBarConfirmButton(ButtonConfiguration topBarConfirmButton)`	Configuration of the 'confirm' button, located in the top bar.
`final ScanbotColor`	`getBackgroundColor()`	The background color of the cropping screen.
`final Unit`	`setBackgroundColor(ScanbotColor backgroundColor)`	The background color of the cropping screen.
`final ScanbotColor`	`getCroppingHandlerColor()`	The color of the cropping handles.
`final Unit`	`setCroppingHandlerColor(ScanbotColor croppingHandlerColor)`	The color of the cropping handles.
`final ScanbotColor`	`getCroppingPolygonColor()`	The color of the cropping polygon.
`final Unit`	`setCroppingPolygonColor(ScanbotColor croppingPolygonColor)`	The color of the cropping polygon.
`final ScanbotColor`	`getCroppingPolygonMagneticLineColor()`	The color of the magnetic lines on the cropping polygon.
`final Unit`	`setCroppingPolygonMagneticLineColor(ScanbotColor croppingPolygonMagneticLineColor)`	The color of the magnetic lines on the cropping polygon.
`final CroppingBottomBar`	`getBottomBar()`	Configuration of the bottom bar for the cropping screen.
`final Unit`	`setBottomBar(CroppingBottomBar bottomBar)`	Configuration of the bottom bar for the cropping screen.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final CroppingScreenConfiguration`	`clone()`
`final static CroppingScreenConfiguration`	`default()`

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

Constructor Detail

CroppingScreenConfiguration

CroppingScreenConfiguration(Map<String, Object> source)

CroppingScreenConfiguration

CroppingScreenConfiguration(JSONObject json)

CroppingScreenConfiguration

CroppingScreenConfiguration(ButtonConfiguration topBarBackButton, StyledText topBarTitle, ButtonConfiguration topBarConfirmButton, ScanbotColor backgroundColor, ScanbotColor croppingHandlerColor, ScanbotColor croppingPolygonColor, ScanbotColor croppingPolygonMagneticLineColor, CroppingBottomBar bottomBar)

Method Detail
- getTopBarBackButton
```
 final ButtonConfiguration getTopBarBackButton()
```
  Configuration of the 'cancel' button, located in the top bar.
- setTopBarBackButton
```
 final Unit setTopBarBackButton(ButtonConfiguration topBarBackButton)
```
  Configuration of the 'cancel' button, located in the top bar.
- getTopBarTitle
```
 final StyledText getTopBarTitle()
```
  Configuration of the title, located in the top bar.
- setTopBarTitle
```
 final Unit setTopBarTitle(StyledText topBarTitle)
```
  Configuration of the title, located in the top bar.
- getTopBarConfirmButton
```
 final ButtonConfiguration getTopBarConfirmButton()
```
  Configuration of the 'confirm' button, located in the top bar.
- setTopBarConfirmButton
```
 final Unit setTopBarConfirmButton(ButtonConfiguration topBarConfirmButton)
```
  Configuration of the 'confirm' button, located in the top bar.
- getBackgroundColor
```
 final ScanbotColor getBackgroundColor()
```
  The background color of the cropping screen.
  Default is "?sbColorOutline"
- setBackgroundColor
```
 final Unit setBackgroundColor(ScanbotColor backgroundColor)
```
  The background color of the cropping screen.
  Default is "?sbColorOutline"
- getCroppingHandlerColor
```
 final ScanbotColor getCroppingHandlerColor()
```
  The color of the cropping handles.
  Default is "?sbColorSurface"
- setCroppingHandlerColor
```
 final Unit setCroppingHandlerColor(ScanbotColor croppingHandlerColor)
```
  The color of the cropping handles.
  Default is "?sbColorSurface"
- getCroppingPolygonColor
```
 final ScanbotColor getCroppingPolygonColor()
```
  The color of the cropping polygon.
  Default is "?sbColorSurface"
- setCroppingPolygonColor
```
 final Unit setCroppingPolygonColor(ScanbotColor croppingPolygonColor)
```
  The color of the cropping polygon.
  Default is "?sbColorSurface"
- getCroppingPolygonMagneticLineColor
```
 final ScanbotColor getCroppingPolygonMagneticLineColor()
```
  The color of the magnetic lines on the cropping polygon.
  Default is "?sbColorSurface"
- setCroppingPolygonMagneticLineColor
```
 final Unit setCroppingPolygonMagneticLineColor(ScanbotColor croppingPolygonMagneticLineColor)
```
  The color of the magnetic lines on the cropping polygon.
  Default is "?sbColorSurface"
- getBottomBar
```
 final CroppingBottomBar getBottomBar()
```
  Configuration of the bottom bar for the cropping screen.
- setBottomBar
```
 final Unit setBottomBar(CroppingBottomBar bottomBar)
```
  Configuration of the bottom bar for the cropping screen.
- toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
- clone
```
 final CroppingScreenConfiguration clone()
```
- default
```
 final static CroppingScreenConfiguration default()
```

Class CroppingScreenConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CroppingScreenConfiguration

CroppingScreenConfiguration

CroppingScreenConfiguration

Method Detail

getTopBarBackButton

setTopBarBackButton

getTopBarTitle

setTopBarTitle

getTopBarConfirmButton

setTopBarConfirmButton

getBackgroundColor

setBackgroundColor

getCroppingHandlerColor

setCroppingHandlerColor

getCroppingPolygonColor

setCroppingPolygonColor

getCroppingPolygonMagneticLineColor

setCroppingPolygonMagneticLineColor

getBottomBar

setBottomBar

toJson

clone

default