Package io.scanbot.sdk.ui_v2.common
Class BaseViewFinderConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public class BaseViewFinderConfiguration implements Parcelable
Base configuration of the scanning interface’s viewfinder, serving as guidance to the user.
-
-
Field Summary
Fields Modifier and Type Field Description private FinderStylestyleprivate ScanbotColoroverlayColorprivate AspectRatioaspectRatioprivate EdgeInsetsminimumInsetsprivate DoublepreferredHeightprivate final String_type
-
Method Summary
Modifier and Type Method Description abstract FinderStylegetStyle()The visual appearance of the viewfinder. abstract UnitsetStyle(FinderStyle style)The visual appearance of the viewfinder. abstract ScanbotColorgetOverlayColor()The color of the viewfinder overlay. abstract UnitsetOverlayColor(ScanbotColor overlayColor)The color of the viewfinder overlay. abstract AspectRatiogetAspectRatio()The viewfinder's aspect ratio. abstract UnitsetAspectRatio(AspectRatio aspectRatio)The viewfinder's aspect ratio. abstract EdgeInsetsgetMinimumInsets()The minimum insets of the viewfinder. abstract UnitsetMinimumInsets(EdgeInsets minimumInsets)The minimum insets of the viewfinder. abstract DoublegetPreferredHeight()The preferred height of the viewfinder. abstract UnitsetPreferredHeight(Double preferredHeight)The preferred height of the viewfinder. abstract Stringget_type()abstract BaseViewFinderConfigurationclone()abstract JSONObjecttoJson(ToJsonConfiguration config)final static BaseViewFinderConfigurationinvoke(Map<String, Object> source)final static ViewFinderConfigurationviewFinderConfiguration()final static PermanentViewFinderConfigurationpermanentViewFinderConfiguration()
-
-
-
Method Detail
-
getStyle
abstract FinderStyle getStyle()
The visual appearance of the viewfinder.
-
setStyle
abstract Unit setStyle(FinderStyle style)
The visual appearance of the viewfinder.
-
getOverlayColor
abstract ScanbotColor getOverlayColor()
The color of the viewfinder overlay.
Default is "?sbColorSurfaceLow"
-
setOverlayColor
abstract Unit setOverlayColor(ScanbotColor overlayColor)
The color of the viewfinder overlay.
Default is "?sbColorSurfaceLow"
-
getAspectRatio
abstract AspectRatio getAspectRatio()
The viewfinder's aspect ratio.
-
setAspectRatio
abstract Unit setAspectRatio(AspectRatio aspectRatio)
The viewfinder's aspect ratio.
-
getMinimumInsets
abstract EdgeInsets getMinimumInsets()
The minimum insets of the viewfinder.
-
setMinimumInsets
abstract Unit setMinimumInsets(EdgeInsets minimumInsets)
The minimum insets of the viewfinder.
-
getPreferredHeight
abstract Double getPreferredHeight()
The preferred height of the viewfinder.
Default is -1.0
-
setPreferredHeight
abstract Unit setPreferredHeight(Double preferredHeight)
The preferred height of the viewfinder.
Default is -1.0
-
clone
abstract BaseViewFinderConfiguration clone()
-
toJson
abstract JSONObject toJson(ToJsonConfiguration config)
-
invoke
final static BaseViewFinderConfiguration invoke(Map<String, Object> source)
-
viewFinderConfiguration
final static ViewFinderConfiguration viewFinderConfiguration()
-
permanentViewFinderConfiguration
final static PermanentViewFinderConfiguration permanentViewFinderConfiguration()
-
-