All Implemented Interfaces:: android.os.Parcelable


public final class CroppingJsonConfiguration
 implements Parcelable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`version`
`private String`	`screen`
`private String`	`cancelButtonTitle`
`private String`	`hintTitle`
`private JsonColor`	`hintTitleColor`
`private JsonColor`	`backgroundColor`
`private String`	`rotateButtonTitle`
`private String`	`resetButtonTitle`
`private String`	`detectButtonTitle`
`private String`	`doneButtonTitle`
`private Boolean`	`rotateButtonHidden`
`private Boolean`	`detectResetButtonHidden`
`private JsonOrientationLockMode`	`orientationLockMode`
`private JsonColor`	`polygonColor`
`private JsonColor`	`anchorPointsColor`
`private JsonColor`	`polygonColorMagnetic`
`private Double`	`polygonLineWidth`
`private JsonColor`	`topBarBackgroundColor`
`private JsonColor`	`topBarButtonsActiveColor`
`private JsonColor`	`bottomBarBackgroundColor`
`private JsonColor`	`bottomBarButtonsColor`
`private Boolean`	`useButtonsAllCaps`
`private Boolean`	`swapTopBottomButtons`
`private JsonCroppingAccessibilityConfiguration`	`accessibilityConfiguration`

Constructor Summary

Constructors
Constructor	Description
CroppingJsonConfiguration(String version, String screen, String cancelButtonTitle, String hintTitle, JsonColor hintTitleColor, JsonColor backgroundColor, String rotateButtonTitle, String resetButtonTitle, String detectButtonTitle, String doneButtonTitle, Boolean rotateButtonHidden, Boolean detectResetButtonHidden, JsonOrientationLockMode orientationLockMode, JsonColor polygonColor, JsonColor anchorPointsColor, JsonColor polygonColorMagnetic, Double polygonLineWidth, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor bottomBarBackgroundColor, JsonColor bottomBarButtonsColor, Boolean useButtonsAllCaps, Boolean swapTopBottomButtons, JsonCroppingAccessibilityConfiguration accessibilityConfiguration)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getVersion()`	A version of the configuration object
`final Unit`	`setVersion(String version)`	A version of the configuration object
`final String`	`getScreen()`	The configuration object should be applied for this screen
`final Unit`	`setScreen(String screen)`	The configuration object should be applied for this screen
`final String`	`getCancelButtonTitle()`	Title of the cancel button.
`final Unit`	`setCancelButtonTitle(String cancelButtonTitle)`	Title of the cancel button.
`final String`	`getHintTitle()`	Text of the edit screen hint.
`final Unit`	`setHintTitle(String hintTitle)`	Text of the edit screen hint.
`final JsonColor`	`getHintTitleColor()`	Color of the edit screen hint text.
`final Unit`	`setHintTitleColor(JsonColor hintTitleColor)`	Color of the edit screen hint text.
`final JsonColor`	`getBackgroundColor()`	Background color of the screen.
`final Unit`	`setBackgroundColor(JsonColor backgroundColor)`	Background color of the screen.
`final String`	`getRotateButtonTitle()`	Title of the Rotate button.
`final Unit`	`setRotateButtonTitle(String rotateButtonTitle)`	Title of the Rotate button.
`final String`	`getResetButtonTitle()`	Title of the Reset button.
`final Unit`	`setResetButtonTitle(String resetButtonTitle)`	Title of the Reset button.
`final String`	`getDetectButtonTitle()`	Title of the Detect button.
`final Unit`	`setDetectButtonTitle(String detectButtonTitle)`	Title of the Detect button.
`final String`	`getDoneButtonTitle()`	Title of the Done button.
`final Unit`	`setDoneButtonTitle(String doneButtonTitle)`	Title of the Done button.
`final Boolean`	`getRotateButtonHidden()`	Changes the visibility of the Rotate button.
`final Unit`	`setRotateButtonHidden(Boolean rotateButtonHidden)`	Changes the visibility of the Rotate button.
`final Boolean`	`getDetectResetButtonHidden()`	Changes the visibility of Detect and Reset buttons.
`final Unit`	`setDetectResetButtonHidden(Boolean detectResetButtonHidden)`	Changes the visibility of Detect and Reset buttons.
`final JsonOrientationLockMode`	`getOrientationLockMode()`	UI Interface orientation lock mode
`final Unit`	`setOrientationLockMode(JsonOrientationLockMode orientationLockMode)`	UI Interface orientation lock mode
`final JsonColor`	`getPolygonColor()`	Default color of the cropping outline.
`final Unit`	`setPolygonColor(JsonColor polygonColor)`	Default color of the cropping outline.
`final JsonColor`	`getAnchorPointsColor()`	Default color of the cropping draggable elements.
`final Unit`	`setAnchorPointsColor(JsonColor anchorPointsColor)`	Default color of the cropping draggable elements.
`final JsonColor`	`getPolygonColorMagnetic()`	Outline color of magnetically snapped edges.
`final Unit`	`setPolygonColorMagnetic(JsonColor polygonColorMagnetic)`	Outline color of magnetically snapped edges.
`final Double`	`getPolygonLineWidth()`	Width of the detected document outline.
`final Unit`	`setPolygonLineWidth(Double polygonLineWidth)`	Width of the detected document outline.
`final JsonColor`	`getTopBarBackgroundColor()`	The background color of the top toolbar.
`final Unit`	`setTopBarBackgroundColor(JsonColor topBarBackgroundColor)`	The background color of the top toolbar.
`final JsonColor`	`getTopBarButtonsActiveColor()`	The color of all active toggle buttons in the toolbar.
`final Unit`	`setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)`	The color of all active toggle buttons in the toolbar.
`final JsonColor`	`getBottomBarBackgroundColor()`	The background color of the bottom shutter-bar.
`final Unit`	`setBottomBarBackgroundColor(JsonColor bottomBarBackgroundColor)`	The background color of the bottom shutter-bar.
`final JsonColor`	`getBottomBarButtonsColor()`	The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
`final Unit`	`setBottomBarButtonsColor(JsonColor bottomBarButtonsColor)`	The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
`final Boolean`	`getUseButtonsAllCaps()`	Controls whether buttons should use all capitals style, as defined by the Android Material Design.
`final Unit`	`setUseButtonsAllCaps(Boolean useButtonsAllCaps)`	Controls whether buttons should use all capitals style, as defined by the Android Material Design.
`final Boolean`	`getSwapTopBottomButtons()`	Swap top and bottom buttons on the screen
`final Unit`	`setSwapTopBottomButtons(Boolean swapTopBottomButtons)`	Swap top and bottom buttons on the screen
`final JsonCroppingAccessibilityConfiguration`	`getAccessibilityConfiguration()`	Allows you to customize the accessibility configuration for the Cropping UI
`final Unit`	`setAccessibilityConfiguration(JsonCroppingAccessibilityConfiguration accessibilityConfiguration)`	Allows you to customize the accessibility configuration for the Cropping UI

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

Constructor Detail

CroppingJsonConfiguration

CroppingJsonConfiguration(String version, String screen, String cancelButtonTitle, String hintTitle, JsonColor hintTitleColor, JsonColor backgroundColor, String rotateButtonTitle, String resetButtonTitle, String detectButtonTitle, String doneButtonTitle, Boolean rotateButtonHidden, Boolean detectResetButtonHidden, JsonOrientationLockMode orientationLockMode, JsonColor polygonColor, JsonColor anchorPointsColor, JsonColor polygonColorMagnetic, Double polygonLineWidth, JsonColor topBarBackgroundColor, JsonColor topBarButtonsActiveColor, JsonColor bottomBarBackgroundColor, JsonColor bottomBarButtonsColor, Boolean useButtonsAllCaps, Boolean swapTopBottomButtons, JsonCroppingAccessibilityConfiguration accessibilityConfiguration)

Method Detail
- getVersion
```
 final String getVersion()
```
  A version of the configuration object
- setVersion
```
 final Unit setVersion(String version)
```
  A version of the configuration object
- getScreen
```
 final String getScreen()
```
  The configuration object should be applied for this screen
- setScreen
```
 final Unit setScreen(String screen)
```
  The configuration object should be applied for this screen
- getCancelButtonTitle
```
 final String getCancelButtonTitle()
```
  Title of the cancel button.
- setCancelButtonTitle
```
 final Unit setCancelButtonTitle(String cancelButtonTitle)
```
  Title of the cancel button.
- getHintTitle
```
 final String getHintTitle()
```
  Text of the edit screen hint.
- setHintTitle
```
 final Unit setHintTitle(String hintTitle)
```
  Text of the edit screen hint.
- getHintTitleColor
```
 final JsonColor getHintTitleColor()
```
  Color of the edit screen hint text.
- setHintTitleColor
```
 final Unit setHintTitleColor(JsonColor hintTitleColor)
```
  Color of the edit screen hint text.
- getBackgroundColor
```
 final JsonColor getBackgroundColor()
```
  Background color of the screen.
- setBackgroundColor
```
 final Unit setBackgroundColor(JsonColor backgroundColor)
```
  Background color of the screen.
- getRotateButtonTitle
```
 final String getRotateButtonTitle()
```
  Title of the Rotate button.
- setRotateButtonTitle
```
 final Unit setRotateButtonTitle(String rotateButtonTitle)
```
  Title of the Rotate button.
- getResetButtonTitle
```
 final String getResetButtonTitle()
```
  Title of the Reset button.
- setResetButtonTitle
```
 final Unit setResetButtonTitle(String resetButtonTitle)
```
  Title of the Reset button.
- getDetectButtonTitle
```
 final String getDetectButtonTitle()
```
  Title of the Detect button.
- setDetectButtonTitle
```
 final Unit setDetectButtonTitle(String detectButtonTitle)
```
  Title of the Detect button.
- getDoneButtonTitle
```
 final String getDoneButtonTitle()
```
  Title of the Done button.
- setDoneButtonTitle
```
 final Unit setDoneButtonTitle(String doneButtonTitle)
```
  Title of the Done button.
- getRotateButtonHidden
```
 final Boolean getRotateButtonHidden()
```
  Changes the visibility of the Rotate button.
- setRotateButtonHidden
```
 final Unit setRotateButtonHidden(Boolean rotateButtonHidden)
```
  Changes the visibility of the Rotate button.
- getDetectResetButtonHidden
```
 final Boolean getDetectResetButtonHidden()
```
  Changes the visibility of Detect and Reset buttons.
- setDetectResetButtonHidden
```
 final Unit setDetectResetButtonHidden(Boolean detectResetButtonHidden)
```
  Changes the visibility of Detect and Reset buttons.
- getOrientationLockMode
```
 final JsonOrientationLockMode getOrientationLockMode()
```
  UI Interface orientation lock mode
- setOrientationLockMode
```
 final Unit setOrientationLockMode(JsonOrientationLockMode orientationLockMode)
```
  UI Interface orientation lock mode
- getPolygonColor
```
 final JsonColor getPolygonColor()
```
  Default color of the cropping outline.
- setPolygonColor
```
 final Unit setPolygonColor(JsonColor polygonColor)
```
  Default color of the cropping outline.
- getAnchorPointsColor
```
 final JsonColor getAnchorPointsColor()
```
  Default color of the cropping draggable elements.
- setAnchorPointsColor
```
 final Unit setAnchorPointsColor(JsonColor anchorPointsColor)
```
  Default color of the cropping draggable elements.
- getPolygonColorMagnetic
```
 final JsonColor getPolygonColorMagnetic()
```
  Outline color of magnetically snapped edges.
- setPolygonColorMagnetic
```
 final Unit setPolygonColorMagnetic(JsonColor polygonColorMagnetic)
```
  Outline color of magnetically snapped edges.
- getPolygonLineWidth
```
 final Double getPolygonLineWidth()
```
  Width of the detected document outline.
- setPolygonLineWidth
```
 final Unit setPolygonLineWidth(Double polygonLineWidth)
```
  Width of the detected document outline.
- getTopBarBackgroundColor
```
 final JsonColor getTopBarBackgroundColor()
```
  The background color of the top toolbar.
- setTopBarBackgroundColor
```
 final Unit setTopBarBackgroundColor(JsonColor topBarBackgroundColor)
```
  The background color of the top toolbar.
- getTopBarButtonsActiveColor
```
 final JsonColor getTopBarButtonsActiveColor()
```
  The color of all active toggle buttons in the toolbar.
- setTopBarButtonsActiveColor
```
 final Unit setTopBarButtonsActiveColor(JsonColor topBarButtonsActiveColor)
```
  The color of all active toggle buttons in the toolbar.
- getBottomBarBackgroundColor
```
 final JsonColor getBottomBarBackgroundColor()
```
  The background color of the bottom shutter-bar.
- setBottomBarBackgroundColor
```
 final Unit setBottomBarBackgroundColor(JsonColor bottomBarBackgroundColor)
```
  The background color of the bottom shutter-bar.
- getBottomBarButtonsColor
```
 final JsonColor getBottomBarButtonsColor()
```
  The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
- setBottomBarButtonsColor
```
 final Unit setBottomBarButtonsColor(JsonColor bottomBarButtonsColor)
```
  The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
- getUseButtonsAllCaps
```
 final Boolean getUseButtonsAllCaps()
```
  Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
- setUseButtonsAllCaps
```
 final Unit setUseButtonsAllCaps(Boolean useButtonsAllCaps)
```
  Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
- getSwapTopBottomButtons
```
 final Boolean getSwapTopBottomButtons()
```
  Swap top and bottom buttons on the screen
- setSwapTopBottomButtons
```
 final Unit setSwapTopBottomButtons(Boolean swapTopBottomButtons)
```
  Swap top and bottom buttons on the screen
- getAccessibilityConfiguration
```
 final JsonCroppingAccessibilityConfiguration getAccessibilityConfiguration()
```
  Allows you to customize the accessibility configuration for the Cropping UI
- setAccessibilityConfiguration
```
 final Unit setAccessibilityConfiguration(JsonCroppingAccessibilityConfiguration accessibilityConfiguration)
```
  Allows you to customize the accessibility configuration for the Cropping UI

Class CroppingJsonConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CroppingJsonConfiguration

Method Detail

getVersion

setVersion

getScreen

setScreen

getCancelButtonTitle

setCancelButtonTitle

getHintTitle

setHintTitle

getHintTitleColor

setHintTitleColor

getBackgroundColor

setBackgroundColor

getRotateButtonTitle

setRotateButtonTitle

getResetButtonTitle

setResetButtonTitle

getDetectButtonTitle

setDetectButtonTitle

getDoneButtonTitle

setDoneButtonTitle

getRotateButtonHidden

setRotateButtonHidden

getDetectResetButtonHidden

setDetectResetButtonHidden

getOrientationLockMode

setOrientationLockMode

getPolygonColor

setPolygonColor

getAnchorPointsColor

setAnchorPointsColor

getPolygonColorMagnetic

setPolygonColorMagnetic

getPolygonLineWidth

setPolygonLineWidth

getTopBarBackgroundColor

setTopBarBackgroundColor

getTopBarButtonsActiveColor

setTopBarButtonsActiveColor

getBottomBarBackgroundColor

setBottomBarBackgroundColor

getBottomBarButtonsColor

setBottomBarButtonsColor

getUseButtonsAllCaps

setUseButtonsAllCaps

getSwapTopBottomButtons

setSwapTopBottomButtons

getAccessibilityConfiguration

setAccessibilityConfiguration