Class DocumentScannerUserGuidance
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class DocumentScannerUserGuidance implements Parcelable
Configuration of the hints guiding users through the scanning process.
-
-
Field Summary
Fields Modifier and Type Field Description private UserGuidanceVisibilityvisibilityprivate StyledTexttitleprivate BackgroundStylebackgroundprivate UserGuidanceStatesstatesTitles
-
Constructor Summary
Constructors Constructor Description DocumentScannerUserGuidance(Map<String, Object> source)DocumentScannerUserGuidance(JSONObject json)DocumentScannerUserGuidance(UserGuidanceVisibility visibility, StyledText title, BackgroundStyle background, UserGuidanceStates statesTitles)
-
Method Summary
Modifier and Type Method Description final UserGuidanceVisibilitygetVisibility()Determines when the user guidance hints should be visible. final UnitsetVisibility(UserGuidanceVisibility visibility)Determines when the user guidance hints should be visible. final StyledTextgetTitle()Configure the text style for the user guidance hints. final UnitsetTitle(StyledText title)Configure the text style for the user guidance hints. final BackgroundStylegetBackground()Configure the background style for the user guidance hints. final UnitsetBackground(BackgroundStyle background)Configure the background style for the user guidance hints. final UserGuidanceStatesgetStatesTitles()Configure the titles of the user guidance hints for different states. final UnitsetStatesTitles(UserGuidanceStates statesTitles)Configure the titles of the user guidance hints for different states. final JSONObjecttoJson(ToJsonConfiguration config)final DocumentScannerUserGuidanceclone()final static DocumentScannerUserGuidancedefault()-
-
Constructor Detail
-
DocumentScannerUserGuidance
DocumentScannerUserGuidance(JSONObject json)
-
DocumentScannerUserGuidance
DocumentScannerUserGuidance(UserGuidanceVisibility visibility, StyledText title, BackgroundStyle background, UserGuidanceStates statesTitles)
-
-
Method Detail
-
getVisibility
final UserGuidanceVisibility getVisibility()
Determines when the user guidance hints should be visible.
Default is ENABLED
-
setVisibility
final Unit setVisibility(UserGuidanceVisibility visibility)
Determines when the user guidance hints should be visible.
Default is ENABLED
-
getTitle
final StyledText getTitle()
Configure the text style for the user guidance hints.
-
setTitle
final Unit setTitle(StyledText title)
Configure the text style for the user guidance hints.
-
getBackground
final BackgroundStyle getBackground()
Configure the background style for the user guidance hints.
-
setBackground
final Unit setBackground(BackgroundStyle background)
Configure the background style for the user guidance hints.
-
getStatesTitles
final UserGuidanceStates getStatesTitles()
Configure the titles of the user guidance hints for different states.
-
setStatesTitles
final Unit setStatesTitles(UserGuidanceStates statesTitles)
Configure the titles of the user guidance hints for different states.
-
toJson
final JSONObject toJson(ToJsonConfiguration config)
-
clone
final DocumentScannerUserGuidance clone()
-
default
final static DocumentScannerUserGuidance default()
-
-
-
-