All Implemented Interfaces:: android.os.Parcelable


public final class CroppingConfiguration
 implements Parcelable

Configuration of the standalone cropping screen.

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 Palette`	`palette`
`private String`	`documentUuid`
`private String`	`pageUuid`
`private CroppingTextLocalization`	`localization`
`private CroppingAppearanceConfiguration`	`appearance`
`private CroppingScreenConfiguration`	`cropping`
`private DocumentAnalysisMode`	`documentAnalysisMode`

Constructor Summary

Constructors
Constructor	Description
`CroppingConfiguration(Map<String, Object> source)`
`CroppingConfiguration(JSONObject json)`
`CroppingConfiguration(String version, String screen, Palette palette, String documentUuid, String pageUuid, CroppingTextLocalization localization, CroppingAppearanceConfiguration appearance, CroppingScreenConfiguration cropping, DocumentAnalysisMode documentAnalysisMode)`

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 Unit`	`setVersion(String version)`	Version number 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 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 String`	`getDocumentUuid()`	The UUID of the document to be cropped.
`final Unit`	`setDocumentUuid(String documentUuid)`	The UUID of the document to be cropped.
`final String`	`getPageUuid()`	The UUID of the page of the document to be cropped.
`final Unit`	`setPageUuid(String pageUuid)`	The UUID of the page of the document to be cropped.
`final CroppingTextLocalization`	`getLocalization()`	Configuration of all the strings for the standalone cropping screen.
`final Unit`	`setLocalization(CroppingTextLocalization localization)`	Configuration of all the strings for the standalone cropping screen.
`final CroppingAppearanceConfiguration`	`getAppearance()`	Configuration of the general appearance for the cropping screen.
`final Unit`	`setAppearance(CroppingAppearanceConfiguration appearance)`	Configuration of the general appearance for the cropping screen.
`final CroppingScreenConfiguration`	`getCropping()`	Configuration of the cropping screen.
`final Unit`	`setCropping(CroppingScreenConfiguration cropping)`	Configuration of the cropping screen.
`final DocumentAnalysisMode`	`getDocumentAnalysisMode()`	Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
`final Unit`	`setDocumentAnalysisMode(DocumentAnalysisMode documentAnalysisMode)`	Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final CroppingConfiguration`	`clone()`

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

- Constructor Detail
  - CroppingConfiguration
```
CroppingConfiguration(Map<String, Object> source)
```
  - CroppingConfiguration
```
CroppingConfiguration(JSONObject json)
```
  - CroppingConfiguration
```
CroppingConfiguration(String version, String screen, Palette palette, String documentUuid, String pageUuid, CroppingTextLocalization localization, CroppingAppearanceConfiguration appearance, CroppingScreenConfiguration cropping, DocumentAnalysisMode documentAnalysisMode)
```
- Method Detail
  - getVersion
```
 final String getVersion()
```
    Version number of the configuration object.
    Default is "1.0"
  - setVersion
```
 final Unit setVersion(String version)
```
    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 "CroppingConfiguration"
  - setScreen
```
 final Unit setScreen(String screen)
```
    The configuration object should be applied for this screen.
    Default is "CroppingConfiguration"
  - 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.
  - getDocumentUuid
```
 final String getDocumentUuid()
```
    The UUID of the document to be cropped.
  - setDocumentUuid
```
 final Unit setDocumentUuid(String documentUuid)
```
    The UUID of the document to be cropped.
  - getPageUuid
```
 final String getPageUuid()
```
    The UUID of the page of the document to be cropped.
  - setPageUuid
```
 final Unit setPageUuid(String pageUuid)
```
    The UUID of the page of the document to be cropped.
  - getLocalization
```
 final CroppingTextLocalization getLocalization()
```
    Configuration of all the strings for the standalone cropping screen.
  - setLocalization
```
 final Unit setLocalization(CroppingTextLocalization localization)
```
    Configuration of all the strings for the standalone cropping screen.
  - getAppearance
```
 final CroppingAppearanceConfiguration getAppearance()
```
    Configuration of the general appearance for the cropping screen.
  - setAppearance
```
 final Unit setAppearance(CroppingAppearanceConfiguration appearance)
```
    Configuration of the general appearance for the cropping screen.
  - getCropping
```
 final CroppingScreenConfiguration getCropping()
```
    Configuration of the cropping screen.
  - setCropping
```
 final Unit setCropping(CroppingScreenConfiguration cropping)
```
    Configuration of the cropping screen.
  - getDocumentAnalysisMode
```
 final DocumentAnalysisMode getDocumentAnalysisMode()
```
    Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
    Default is UNFILTERED_DOCUMENT
  - setDocumentAnalysisMode
```
 final Unit setDocumentAnalysisMode(DocumentAnalysisMode documentAnalysisMode)
```
    Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
    Default is UNFILTERED_DOCUMENT
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final CroppingConfiguration clone()
```

Class CroppingConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CroppingConfiguration

CroppingConfiguration

CroppingConfiguration

Method Detail

getVersion

setVersion

getScreen

setScreen

getPalette

setPalette

getDocumentUuid

setDocumentUuid

getPageUuid

setPageUuid

getLocalization

setLocalization

getAppearance

setAppearance

getCropping

setCropping

getDocumentAnalysisMode

setDocumentAnalysisMode

toJson

clone