Class DocumentFlowAppearanceConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class DocumentFlowAppearanceConfiguration implements Parcelable
Configuration of the general appearance.
-
-
Field Summary
Fields Modifier and Type Field Description private StatusBarMode
statusBarMode
private NavigationBarMode
navigationBarMode
private ScanbotColor
topBarBackgroundColor
private ScanbotColor
bottomBarBackgroundColor
private OrientationLockMode
orientationLockMode
-
Constructor Summary
Constructors Constructor Description DocumentFlowAppearanceConfiguration(Map<String, Object> source)
DocumentFlowAppearanceConfiguration(JSONObject json)
DocumentFlowAppearanceConfiguration(StatusBarMode statusBarMode, NavigationBarMode navigationBarMode, ScanbotColor topBarBackgroundColor, ScanbotColor bottomBarBackgroundColor, OrientationLockMode orientationLockMode)
-
Method Summary
Modifier and Type Method Description final StatusBarMode
getStatusBarMode()
Determines the visual mode used for the status bar icons. final Unit
setStatusBarMode(StatusBarMode statusBarMode)
Determines the visual mode used for the status bar icons. final NavigationBarMode
getNavigationBarMode()
Determines the visual mode used for the navigation bar icons. final Unit
setNavigationBarMode(NavigationBarMode navigationBarMode)
Determines the visual mode used for the navigation bar icons. final ScanbotColor
getTopBarBackgroundColor()
The background color of the top bar. final Unit
setTopBarBackgroundColor(ScanbotColor topBarBackgroundColor)
The background color of the top bar. final ScanbotColor
getBottomBarBackgroundColor()
The background color of the bottom bar. final Unit
setBottomBarBackgroundColor(ScanbotColor bottomBarBackgroundColor)
The background color of the bottom bar. final OrientationLockMode
getOrientationLockMode()
Which mode to use when orientation should be locked to landscape or portrait. final Unit
setOrientationLockMode(OrientationLockMode orientationLockMode)
Which mode to use when orientation should be locked to landscape or portrait. final JSONObject
toJson()
final static DocumentFlowAppearanceConfiguration
default()
-
-
Constructor Detail
-
DocumentFlowAppearanceConfiguration
DocumentFlowAppearanceConfiguration(JSONObject json)
-
DocumentFlowAppearanceConfiguration
DocumentFlowAppearanceConfiguration(StatusBarMode statusBarMode, NavigationBarMode navigationBarMode, ScanbotColor topBarBackgroundColor, ScanbotColor bottomBarBackgroundColor, OrientationLockMode orientationLockMode)
-
-
Method Detail
-
getStatusBarMode
final StatusBarMode getStatusBarMode()
Determines the visual mode used for the status bar icons. Default is LIGHT
-
setStatusBarMode
final Unit setStatusBarMode(StatusBarMode statusBarMode)
Determines the visual mode used for the status bar icons. Default is LIGHT
-
getNavigationBarMode
final NavigationBarMode getNavigationBarMode()
Determines the visual mode used for the navigation bar icons. Android only. Default is LIGHT
-
setNavigationBarMode
final Unit setNavigationBarMode(NavigationBarMode navigationBarMode)
Determines the visual mode used for the navigation bar icons. Android only. Default is LIGHT
-
getTopBarBackgroundColor
final ScanbotColor getTopBarBackgroundColor()
The background color of the top bar. Only applicable when the visual mode is specified as 'SOLID', otherwise ignored. Default is "?sbColorPrimary"
-
setTopBarBackgroundColor
final Unit setTopBarBackgroundColor(ScanbotColor topBarBackgroundColor)
The background color of the top bar. Only applicable when the visual mode is specified as 'SOLID', otherwise ignored. Default is "?sbColorPrimary"
-
getBottomBarBackgroundColor
final ScanbotColor getBottomBarBackgroundColor()
The background color of the bottom bar. Default is "?sbColorPrimary"
-
setBottomBarBackgroundColor
final Unit setBottomBarBackgroundColor(ScanbotColor bottomBarBackgroundColor)
The background color of the bottom bar. Default is "?sbColorPrimary"
-
getOrientationLockMode
final OrientationLockMode getOrientationLockMode()
Which mode to use when orientation should be locked to landscape or portrait. Default is NONE
-
setOrientationLockMode
final Unit setOrientationLockMode(OrientationLockMode orientationLockMode)
Which mode to use when orientation should be locked to landscape or portrait. Default is NONE
-
toJson
final JSONObject toJson()
-
default
final static DocumentFlowAppearanceConfiguration default()
-
-
-
-