Package io.scanbot.sdk.ui_v2.common
Class IconUserGuidanceConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class IconUserGuidanceConfiguration implements Parcelable
Configuration of the hint (containing an icon) guiding users through the scanning process.
-
-
Field Summary
Fields Modifier and Type Field Description private Booleanvisibleprivate IconStyleiconprivate StyledTexttitleprivate BackgroundStylebackground
-
Constructor Summary
Constructors Constructor Description IconUserGuidanceConfiguration(Map<String, Object> source)IconUserGuidanceConfiguration(JSONObject json)IconUserGuidanceConfiguration(Boolean visible, IconStyle icon, StyledText title, BackgroundStyle background)
-
Method Summary
Modifier and Type Method Description final BooleangetVisible()Determines whether the user guidance is visible or not. final UnitsetVisible(Boolean visible)Determines whether the user guidance is visible or not. final IconStylegetIcon()Configuration of the icon appearance. final UnitsetIcon(IconStyle icon)Configuration of the icon appearance. final StyledTextgetTitle()The title of the user guidance. final UnitsetTitle(StyledText title)The title of the user guidance. final BackgroundStylegetBackground()Configuration of the background appearance for the user guidance hints. final UnitsetBackground(BackgroundStyle background)Configuration of the background appearance for the user guidance hints. final JSONObjecttoJson(ToJsonConfiguration config)final IconUserGuidanceConfigurationclone()final static IconUserGuidanceConfigurationdefault()-
-
Constructor Detail
-
IconUserGuidanceConfiguration
IconUserGuidanceConfiguration(JSONObject json)
-
IconUserGuidanceConfiguration
IconUserGuidanceConfiguration(Boolean visible, IconStyle icon, StyledText title, BackgroundStyle background)
-
-
Method Detail
-
getVisible
final Boolean getVisible()
Determines whether the user guidance is visible or not.
Default is true
-
setVisible
final Unit setVisible(Boolean visible)
Determines whether the user guidance is visible or not.
Default is true
-
getTitle
final StyledText getTitle()
The title of the user guidance.
-
setTitle
final Unit setTitle(StyledText title)
The title of the user guidance.
-
getBackground
final BackgroundStyle getBackground()
Configuration of the background appearance for the user guidance hints.
-
setBackground
final Unit setBackground(BackgroundStyle background)
Configuration of the background appearance for the user guidance hints.
-
toJson
final JSONObject toJson(ToJsonConfiguration config)
-
clone
final IconUserGuidanceConfiguration clone()
-
default
final static IconUserGuidanceConfiguration default()
-
-
-
-