Class ParamsCustomization.CustomizationEditor
java.lang.Object
com.regula.documentreader.api.params.ParamsCustomization.CustomizationEditor
- Enclosing class:
- ParamsCustomization
Interface used for modifying
ParamsCustomization
object. All changes you make in an editor
are batched, and not copied back to the original ParamsCustomization until you call apply()
-
Method Summary
Modifier and TypeMethodDescriptionvoid
apply()
Use this method to apply set values.void
applyImmediately
(Context context) Use this method to apply set values immediatelysetActivityIndicatorColor
(String activityIndicatorColor) setActivityIndicatorSize
(Integer activityIndicatorSize) setBackgroundMaskAlpha
(Float backgroundMaskAlpha) setBackgroundMaskColor
(String resultStatusTextColor) setBorderBackgroundImage
(Drawable borderBackgroundImage) setBorderBackgroundImageMatrix
(Matrix borderBackgroundImageMatrix) setBorderBackgroundImageScaleType
(ImageView.ScaleType scaleType) setCameraFrameActiveColor
(String cameraFrameActiveColor) setCameraFrameBorderWidth
(Integer cameraFrameBorderWidth) setCameraFrameCornerRadius
(Float cameraFrameCornerRadius) setCameraFrameDefaultColor
(String cameraFrameDefaultColor) setCameraFrameLineCap
(Paint.Cap cap) setCameraFrameLineLength
(Integer cameraFrameLineLength) setCameraFrameOffsetWidth
(Integer offset) setCameraFrameShapeType
(Integer cameraFrameShapeType) setCameraFrameVerticalPositionMultiplier
(Float multiplier) setCameraPreviewBackgroundColor
(String resultStatusTextColor) setCameraSwitchButtonImage
(Drawable cameraSwitchButtonImage) setCaptureButtonImage
(Drawable captureButtonImage) setChangeFrameCollapseButtonImage
(Drawable changeFrameButtonCollapseImage) setChangeFrameExpandButtonImage
(Drawable changeFrameButtonExpandImage) setCloseButtonImage
(Drawable closeButton) setColor
(CustomizationColor item, int value) Customizing UI ColorssetColor
(CustomizationColor item, long value) Customizing UI ColorssetCustomLabelStatus
(SpannableString status) setCustomStatusPositionMultiplier
(Float multiplier) setFont
(CustomizationFont item, int value) Customizing fontssetFont
(CustomizationFont item, Typeface typeface) Customizing fontssetFontSize
(CustomizationFont item, int value) Customizing font sizesetHelpAnimationImage
(Drawable helpAnimationImage) setHelpAnimationImageMatrix
(Matrix matrix) setHelpAnimationImageScaleType
(ImageView.ScaleType scaleType) setHologramAnimationImage
(Drawable helpAnimationImage) Deprecated.setHologramAnimationImageMatrix
(Matrix matrix) Deprecated.setHologramAnimationImageScaleType
(ImageView.ScaleType scaleType) Deprecated.setHologramAnimationPositionMultiplier
(Float multiplier) Deprecated.setImage
(CustomizationImage image, Drawable drawable) Customizing imagessetLivenessAnimationImage
(Drawable helpAnimationImage) setLivenessAnimationImageMatrix
(Matrix matrix) setLivenessAnimationImageScaleType
(ImageView.ScaleType scaleType) setLivenessAnimationPositionMultiplier
(Float multiplier) setMultipageAnimationBackImage
(Drawable multipageAnimationBackImage) setMultipageAnimationBackImageMatrix
(Matrix matrix) setMultipageAnimationBackImageScaleType
(ImageView.ScaleType scaleType) setMultipageAnimationFrontImage
(Drawable multipageAnimationFrontImage) setMultipageAnimationFrontImageMatrix
(Matrix matrix) setMultipageAnimationFrontImageScaleType
(ImageView.ScaleType scaleType) setMultipageButtonBackgroundColor
(String multipageButtonBackgroundColor) setNextPageAnimationEndDelay
(float delay) setNextPageAnimationStartDelay
(float delay) setResultStatus
(String status) setResultStatusBackgroundColor
(String resultStatusBackgroundColor) setResultStatusPositionMultiplier
(Float resultStatusPositionMultiplier) setResultStatusTextColor
(String resultStatusTextColor) setResultStatusTextFont
(Typeface resultStatusTextFont) setResultStatusTextSize
(Integer resultStatusTextSize) setShowBackgroundMask
(boolean showBackgroundMask) setShowHelpAnimation
(boolean showHelpAnimation) setShowNextPageAnimation
(boolean showNextPageAnimation) setShowResultStatusMessages
(boolean showResultStatusMessages) setShowStatusMessages
(boolean showStatusMessages) setStatusBackgroundColor
(String statusBackgroundColor) setStatusPositionMultiplier
(Float statusPositionMultiplier) setStatusTextColor
(String statusTextColor) setStatusTextFont
(Typeface statusTextFont) setStatusTextSize
(Integer statusTextSize) setTintColor
(String tintColor) setToolbarSize
(Float height) setTorchImageOff
(Drawable torchImageOff) setTorchImageOn
(Drawable torchImageOn) setUiCustomizationLayer
(JSONObject mUiCustomizationLayer)
-
Method Details
-
setCameraFrameLineCap
-
setCameraFrameCornerRadius
public ParamsCustomization.CustomizationEditor setCameraFrameCornerRadius(Float cameraFrameCornerRadius) -
setCameraFramePortraitAspectRatio
-
setCameraFrameLandscapeAspectRatio
-
setCameraFrameVerticalPositionMultiplier
public ParamsCustomization.CustomizationEditor setCameraFrameVerticalPositionMultiplier(Float multiplier) -
setCustomStatusPositionMultiplier
-
setCustomLabelStatus
-
setHologramAnimationPositionMultiplier
@Deprecated public ParamsCustomization.CustomizationEditor setHologramAnimationPositionMultiplier(Float multiplier) Deprecated. -
setLivenessAnimationPositionMultiplier
public ParamsCustomization.CustomizationEditor setLivenessAnimationPositionMultiplier(Float multiplier) -
setHologramAnimationImageScaleType
@Deprecated public ParamsCustomization.CustomizationEditor setHologramAnimationImageScaleType(ImageView.ScaleType scaleType) Deprecated. -
setLivenessAnimationImageScaleType
public ParamsCustomization.CustomizationEditor setLivenessAnimationImageScaleType(ImageView.ScaleType scaleType) -
setHologramAnimationImageMatrix
@Deprecated public ParamsCustomization.CustomizationEditor setHologramAnimationImageMatrix(Matrix matrix) Deprecated. -
setLivenessAnimationImageMatrix
-
setBackgroundMaskAlpha
-
setBorderBackgroundImage
public ParamsCustomization.CustomizationEditor setBorderBackgroundImage(Drawable borderBackgroundImage) -
setBorderBackgroundImageMatrix
public ParamsCustomization.CustomizationEditor setBorderBackgroundImageMatrix(Matrix borderBackgroundImageMatrix) -
setBorderBackgroundImageScaleType
public ParamsCustomization.CustomizationEditor setBorderBackgroundImageScaleType(ImageView.ScaleType scaleType) -
setCameraFrameOffsetWidth
-
setResultStatusPositionMultiplier
public ParamsCustomization.CustomizationEditor setResultStatusPositionMultiplier(Float resultStatusPositionMultiplier) -
setStatusPositionMultiplier
public ParamsCustomization.CustomizationEditor setStatusPositionMultiplier(Float statusPositionMultiplier) -
setMultipageAnimationBackImageMatrix
-
setMultipageAnimationBackImageScaleType
public ParamsCustomization.CustomizationEditor setMultipageAnimationBackImageScaleType(ImageView.ScaleType scaleType) -
setHelpAnimationImageMatrix
-
setMultipageAnimationBackImage
public ParamsCustomization.CustomizationEditor setMultipageAnimationBackImage(Drawable multipageAnimationBackImage) -
setMultipageAnimationFrontImageMatrix
-
setHelpAnimationImageScaleType
public ParamsCustomization.CustomizationEditor setHelpAnimationImageScaleType(ImageView.ScaleType scaleType) -
setMultipageAnimationFrontImageScaleType
public ParamsCustomization.CustomizationEditor setMultipageAnimationFrontImageScaleType(ImageView.ScaleType scaleType) -
setMultipageAnimationFrontImage
public ParamsCustomization.CustomizationEditor setMultipageAnimationFrontImage(Drawable multipageAnimationFrontImage) -
setHelpAnimationImage
-
setHologramAnimationImage
@Deprecated public ParamsCustomization.CustomizationEditor setHologramAnimationImage(Drawable helpAnimationImage) Deprecated. -
setLivenessAnimationImage
public ParamsCustomization.CustomizationEditor setLivenessAnimationImage(Drawable helpAnimationImage) -
setShowBackgroundMask
-
setShowNextPageAnimation
public ParamsCustomization.CustomizationEditor setShowNextPageAnimation(boolean showNextPageAnimation) -
setNextPageAnimationStartDelay
- Parameters:
delay
- – The amount of the delay, in milliseconds
-
setNextPageAnimationEndDelay
- Parameters:
delay
- – The amount of the delay, in milliseconds
-
setActivityIndicatorColor
public ParamsCustomization.CustomizationEditor setActivityIndicatorColor(String activityIndicatorColor) -
setActivityIndicatorSize
public ParamsCustomization.CustomizationEditor setActivityIndicatorSize(Integer activityIndicatorSize) -
setTintColor
-
setMultipageButtonBackgroundColor
public ParamsCustomization.CustomizationEditor setMultipageButtonBackgroundColor(String multipageButtonBackgroundColor) -
setResultStatusBackgroundColor
public ParamsCustomization.CustomizationEditor setResultStatusBackgroundColor(String resultStatusBackgroundColor) -
setResultStatusTextColor
public ParamsCustomization.CustomizationEditor setResultStatusTextColor(String resultStatusTextColor) -
setResultStatusTextSize
public ParamsCustomization.CustomizationEditor setResultStatusTextSize(Integer resultStatusTextSize) -
setResultStatusTextFont
public ParamsCustomization.CustomizationEditor setResultStatusTextFont(Typeface resultStatusTextFont) -
setCameraFrameLineLength
public ParamsCustomization.CustomizationEditor setCameraFrameLineLength(Integer cameraFrameLineLength) -
setCameraFrameShapeType
public ParamsCustomization.CustomizationEditor setCameraFrameShapeType(Integer cameraFrameShapeType) -
setStatusTextColor
-
setStatusTextSize
-
setStatusBackgroundColor
public ParamsCustomization.CustomizationEditor setStatusBackgroundColor(String statusBackgroundColor) -
setStatusTextFont
-
setCameraFrameActiveColor
public ParamsCustomization.CustomizationEditor setCameraFrameActiveColor(String cameraFrameActiveColor) -
setCameraFrameDefaultColor
public ParamsCustomization.CustomizationEditor setCameraFrameDefaultColor(String cameraFrameDefaultColor) -
setCameraFrameBorderWidth
public ParamsCustomization.CustomizationEditor setCameraFrameBorderWidth(Integer cameraFrameBorderWidth) -
setShowHelpAnimation
-
setShowResultStatusMessages
public ParamsCustomization.CustomizationEditor setShowResultStatusMessages(boolean showResultStatusMessages) -
setShowStatusMessages
-
setResultStatus
-
setStatus
-
setTorchImageOn
-
setTorchImageOff
-
setCloseButtonImage
-
setCaptureButtonImage
-
setChangeFrameCollapseButtonImage
public ParamsCustomization.CustomizationEditor setChangeFrameCollapseButtonImage(Drawable changeFrameButtonCollapseImage) -
setChangeFrameExpandButtonImage
public ParamsCustomization.CustomizationEditor setChangeFrameExpandButtonImage(Drawable changeFrameButtonExpandImage) -
setCameraSwitchButtonImage
public ParamsCustomization.CustomizationEditor setCameraSwitchButtonImage(Drawable cameraSwitchButtonImage) -
setToolbarSize
-
setUiCustomizationLayer
public ParamsCustomization.CustomizationEditor setUiCustomizationLayer(JSONObject mUiCustomizationLayer) -
setCameraPreviewBackgroundColor
public ParamsCustomization.CustomizationEditor setCameraPreviewBackgroundColor(String resultStatusTextColor) -
setColor
Customizing UI Colors- Parameters:
item
- - customization objectCustomizationColor
value
- of color (e.g. 0xff00ff00)
-
setColor
Customizing UI Colors- Parameters:
item
- - customization objectCustomizationColor
value
- of color (e.g. 0xFFFFFFFF or color from resources)
-
setFont
Customizing fonts- Parameters:
item
- - customization objectCustomizationFont
value
- of font
-
setFont
Customizing fonts- Parameters:
item
- - customization objectCustomizationFont
typeface
-
-
setFontSize
Customizing font size- Parameters:
item
- - customization objectCustomizationFont
value
- of font size
-
setImage
public ParamsCustomization.CustomizationEditor setImage(CustomizationImage image, Drawable drawable) Customizing images- Parameters:
image
- - customization objectCustomizationImage
drawable
-
-
setBackgroundMaskColor
-
apply
public void apply()Use this method to apply set values. Changes will take effect on internal events -
applyImmediately
public void applyImmediately(Context context) Use this method to apply set values immediately- Parameters:
context
- Context
-