Class CroppingConfiguration
-
- All Implemented Interfaces:
public final class CroppingConfiguration
Class which is used to configure io.scanbot.sdk.ui.view.edit.CroppingActivity Contains settings indicating views Behaviour, Texts and Appearance
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
CroppingConfiguration.Companion
-
Field Summary
Fields Modifier and Type Field Description private final Page
page
private final CroppingJsonConfiguration
params
private final CroppingNativeConfiguration
nativeParams
public final static CroppingConfiguration.Companion
Companion
-
Constructor Summary
Constructors Constructor Description CroppingConfiguration(Page page)
-
Method Summary
Modifier and Type Method Description final Page
getPage()
final CroppingJsonConfiguration
getParams()
final CroppingNativeConfiguration
getNativeParams()
final Unit
setOrientationLockMode(OrientationMode orientationMode)
Orientation lock mode of the cropping screen: PORTRAIT or LANDSCAPE. final Unit
setPolygonColor(Integer color)
Default color of the cropping outline. final Unit
setAnchorPointColor(Integer color)
Default color of the cropping draggable elements. final Unit
setPolygonColorMagnetic(Integer color)
Outline color of magnetically snapped edges. final Unit
setPolygonLineWidth(Integer width)
Width of the cropping outline in Px. final Unit
setTopBarBackgroundColor(Integer color)
Background color of the top toolbar. final Unit
setTopBarButtonsColor(Integer color)
Color of the titles of all buttons in the top toolbar (Cancel and Done buttons). final Unit
setBottomBarBackgroundColor(Integer color)
Background color of the bottom toolbar. final Unit
setBottomBarButtonsColor(Integer color)
Color of the titles of all buttons in the bottom toolbar (Rotate button). final Unit
setBackgroundColor(Integer color)
Background color of the main screen. final Unit
setCancelButtonTitle(String text)
Title of the cancel button. final Unit
setRotateButtonTitle(String text)
Title of the Rotate button. final Unit
setRotateButtonHidden(Boolean rotateButtonHidden)
Changes the visibility of the Rotate button. final Unit
setResetButtonTitle(String text)
Title of the Reset button. final Unit
setDetectButtonTitle(String text)
Title of the Detect button. final Unit
setDetectResetButtonHidden(Boolean detectResetButtonHidden)
Changes the visibility of Detect and Reset buttons. final Unit
setDoneButtonTitle(String text)
Title of the Done button. final Unit
setHintTitle(String text)
Text of the edit screen hint. final Unit
setHintTitleColor(Integer color)
Color of the edit screen hint text. final Unit
setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style. final Unit
setAccessibilityConfiguration(CroppingAccessibilityConfiguration accessibilityConfiguration)
A configuration with accessibility texts settings. final Unit
setSwapTopBottomButtons(Boolean swap)
Swap top and bottom buttons on the screen. -
-
Constructor Detail
-
CroppingConfiguration
CroppingConfiguration(Page page)
-
-
Method Detail
-
getParams
final CroppingJsonConfiguration getParams()
-
getNativeParams
final CroppingNativeConfiguration getNativeParams()
-
setOrientationLockMode
final Unit setOrientationLockMode(OrientationMode orientationMode)
Orientation lock mode of the cropping screen: PORTRAIT or LANDSCAPE. By default the screen orientation is not locked.
-
setPolygonColor
final Unit setPolygonColor(Integer color)
Default color of the cropping outline.
-
setAnchorPointColor
final Unit setAnchorPointColor(Integer color)
Default color of the cropping draggable elements.
-
setPolygonColorMagnetic
final Unit setPolygonColorMagnetic(Integer color)
Outline color of magnetically snapped edges.
-
setPolygonLineWidth
final Unit setPolygonLineWidth(Integer width)
Width of the cropping outline in Px.
-
setTopBarBackgroundColor
final Unit setTopBarBackgroundColor(Integer color)
Background color of the top toolbar.
-
setTopBarButtonsColor
final Unit setTopBarButtonsColor(Integer color)
Color of the titles of all buttons in the top toolbar (Cancel and Done buttons).
-
setBottomBarBackgroundColor
final Unit setBottomBarBackgroundColor(Integer color)
Background color of the bottom toolbar.
-
setBottomBarButtonsColor
final Unit setBottomBarButtonsColor(Integer color)
Color of the titles of all buttons in the bottom toolbar (Rotate button).
-
setBackgroundColor
final Unit setBackgroundColor(Integer color)
Background color of the main screen.
-
setCancelButtonTitle
final Unit setCancelButtonTitle(String text)
Title of the cancel button.
-
setRotateButtonTitle
final Unit setRotateButtonTitle(String text)
Title of the Rotate button.
-
setRotateButtonHidden
final Unit setRotateButtonHidden(Boolean rotateButtonHidden)
Changes the visibility of the Rotate button.
-
setResetButtonTitle
final Unit setResetButtonTitle(String text)
Title of the Reset button.
-
setDetectButtonTitle
final Unit setDetectButtonTitle(String text)
Title of the Detect button.
-
setDetectResetButtonHidden
final Unit setDetectResetButtonHidden(Boolean detectResetButtonHidden)
Changes the visibility of Detect and Reset buttons.
-
setDoneButtonTitle
final Unit setDoneButtonTitle(String text)
Title of the Done button.
-
setHintTitle
final Unit setHintTitle(String text)
Text of the edit screen hint.
-
setHintTitleColor
final Unit setHintTitleColor(Integer color)
Color of the edit screen hint text.
-
setUseButtonsAllCaps
final Unit setUseButtonsAllCaps(Boolean allCaps)
Controls whether buttons should use all capitals style.
-
setAccessibilityConfiguration
final Unit setAccessibilityConfiguration(CroppingAccessibilityConfiguration accessibilityConfiguration)
A configuration with accessibility texts settings.
-
setSwapTopBottomButtons
final Unit setSwapTopBottomButtons(Boolean swap)
Swap top and bottom buttons on the screen.
-
-
-
-