Package com.regula.documentreader.api.params

Class ParamsCustomization

  • public class ParamsCustomization
extends java.lang.Object
    Structure containing parameters for UI customization on the document capture screen
    See Also:
    UI customization

    • Constructor Detail

      • ParamsCustomization

        public ParamsCustomization()

    • Method Detail

      • getStatus

        public java.lang.String getStatus()
        Message displayed on the status label next to frame

      • getResultStatus

        public java.lang.String getResultStatus()
        Message displayed on the result status label next to frame

      • isShowStatusMessages

        public boolean isShowStatusMessages()
        if set, help messages will be displayed during the document detection

      • isShowResultStatusMessages

        public boolean isShowResultStatusMessages()
        If set, current status messages will be displayed during the document detection

      • isShowHelpAnimation

        public boolean isShowHelpAnimation()
        if set, animation showing how to position document will be displayed

      • getCameraFrameBorderWidth

        public java.lang.Integer getCameraFrameBorderWidth()
        Thickness of document bounds border on the video preview (dp)

      • getCameraFrameDefaultColor

        public java.lang.String getCameraFrameDefaultColor()
        Hex string of document bounds border color in default state

      • getCameraFrameActiveColor

        public java.lang.String getCameraFrameActiveColor()
        Hex string of document bounds border color in document detected state

      • getStatusTextFont

        public Typeface getStatusTextFont()
        Typeface of main text status

      • getStatusTextSize

        public java.lang.Integer getStatusTextSize()
        Size of main text status (sp)

      • getStatusTextColor

        public java.lang.String getStatusTextColor()
        Hex string of main text status color

      • getStatusBackgroundColor

        public java.lang.String getStatusBackgroundColor()
        Hex string of main text status background color

      • getCameraFrameShapeType

        public java.lang.Integer getCameraFrameShapeType()
        Defines the shape of document bounds border
        Returns:
        one of FrameShapeType

      • getCameraFrameLineLength

        public java.lang.Integer getCameraFrameLineLength()
        Defines the length (dp) of the corner side in shape mode FrameShapeType.CORNER

      • getResultStatusTextFont

        public Typeface getResultStatusTextFont()
        Typeface of current text status

      • getResultStatusTextSize

        public java.lang.Integer getResultStatusTextSize()
        Size of current text status (sp)

      • getResultStatusTextColor

        public java.lang.String getResultStatusTextColor()
        Hex string of current text status color

      • getResultStatusBackgroundColor

        public java.lang.String getResultStatusBackgroundColor()
        Hex string of current text status background color

      • getMultipageButtonBackgroundColor

        public java.lang.String getMultipageButtonBackgroundColor()
        Hex string of page skipping button background

      • getTintColor

        public java.lang.String getTintColor()
        Hex string of visual elements color (one for all)

      • getActivityIndicatorColor

        public java.lang.String getActivityIndicatorColor()
        Hex string of loading indicator(s) color

      • isShowNextPageAnimation

        public boolean isShowNextPageAnimation()
        if set, expecting page turn animation will be shown

      • isShowBackgroundMask

        public boolean isShowBackgroundMask()
        if set, background will be darkened around the document detection frame

      • getHologramAnimationImage

        public Drawable getHologramAnimationImage()
        Drawable displayed as instruction animation, when hologram detection sequence is started

      • getHologramAnimationImageScaleType

        public ImageView.ScaleType getHologramAnimationImageScaleType()
        To change the scaling of the image, use one of the android.widget.ImageView.ScaleType members

      • getHologramAnimationImageMatrix

        public Matrix getHologramAnimationImageMatrix()
        Matrix used to scale hologram instructional animation image Is used only when getHologramAnimationImageScaleType() is set to android.widget.ImageView.ScaleType#MATRIX

      • getHelpAnimationImageDrawable

        public Drawable getHelpAnimationImageDrawable()
        Drawable displayed as instruction animation on scanning process start

      • getHelpAnimationImageScaleType

        public ImageView.ScaleType getHelpAnimationImageScaleType()
        To change the scaling of the image, use one of the android.widget.ImageView.ScaleType members

      • getHelpAnimationImageMatrix

        public Matrix getHelpAnimationImageMatrix()
        Matrix used to scale scanning instructional animation image Is used only when getHelpAnimationImageScaleType() is set to android.widget.ImageView.ScaleType#MATRIX

      • getUiCustomizationLayer

        public JSONObject getUiCustomizationLayer()
        JSON structure defining labels and graphic elements to be added to the Camera UI
        See Also:
        Documentation

      • getMultipageAnimationFrontImage

        public Drawable getMultipageAnimationFrontImage()
        Drawable displayed during as first image on page turn hint animation

      • getMultipageAnimationFrontImageScaleType

        public ImageView.ScaleType getMultipageAnimationFrontImageScaleType()
        To change the scaling of the image, use one of the android.widget.ImageView.ScaleType members

      • getMultipageAnimationFrontImageMatrix

        public Matrix getMultipageAnimationFrontImageMatrix()
        Matrix used to scale page turn animation first image Is used only when getHelpAnimationImageScaleType() is set to android.widget.ImageView.ScaleType#MATRIX

      • getMultipageAnimationBackImage

        public Drawable getMultipageAnimationBackImage()
        Drawable displayed during as second image on page turn hint animation

      • getMultipageAnimationBackImageScaleType

        public ImageView.ScaleType getMultipageAnimationBackImageScaleType()
        To change the scaling of the image, use one of the android.widget.ImageView.ScaleType members

      • getMultipageAnimationBackImageMatrix

        public Matrix getMultipageAnimationBackImageMatrix()
        Matrix used to scale page turn animation second image Is used only when getMultipageAnimationBackImageScaleType() is set to android.widget.ImageView.ScaleType#MATRIX

      • getStatusPositionMultiplier

        public java.lang.Float getStatusPositionMultiplier()
        You can change the location of the status message. For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800, your message will be centralized and located at 200 px from top, that is (800 / 2) * 0.5 = 200 px. If the multiplier is equal to 1, the message will be centered. If the multiplier is equal to zero, the default location will be used

      • getBorderBackgroundImage

        public Drawable getBorderBackgroundImage()
        Drawable displayed within the camera frame

      • getBackgroundMaskAlpha

        public java.lang.Float getBackgroundMaskAlpha()
        Value representing transparency of the overlay mask around the camera frame. Float value in range from 0 to 1, where 0 is fully transparent

      • getCameraFrameOffsetWidth

        public java.lang.Integer getCameraFrameOffsetWidth()
        Value in pixels the camera frame with will be decreased for

      • getCustomLabelStatus

        public SpannableString getCustomLabelStatus()
        Additional message displayed on the status label next to frame

      • getHologramAnimationPositionMultiplier

        public java.lang.Float getHologramAnimationPositionMultiplier()
        Change the position of hologram detection help animation.

      • getCameraFrameVerticalPositionMultiplier

        public java.lang.Float getCameraFrameVerticalPositionMultiplier()
        Change the vertical position of the camera frame.

      • getCameraFrameLandscapeAspectRatio

        public java.lang.Float getCameraFrameLandscapeAspectRatio()
        Width / Height ratio applied to the camera frame in landscape orientation view

      • getCameraFramePortraitAspectRatio

        public java.lang.Float getCameraFramePortraitAspectRatio()
        Width / Height ratio applied to the camera frame in portrait orientation view

      • getCameraFrameCornerRadius

        public java.lang.Float getCameraFrameCornerRadius()
        Value in pixels representing the camera frame rectangle corner radius, 0 - no radius

      • getCameraFrameLineCap

        public Paint.Cap getCameraFrameLineCap()
        This option specifies the treatment for the beginning and ending of stroked line in the camera frame. One of Paint.Cap values

      • getTorchImageOnDrawable

        public Drawable getTorchImageOnDrawable()
        Drawable used for torch button when torch is on

      • getTorchImageOffDrawable

        public Drawable getTorchImageOffDrawable()
        Drawable used for torch button when torch is off

      • getCloseButtonDrawable

        public Drawable getCloseButtonDrawable()
        Drawable used for close button

      • getCaptureButtonDrawable

        public Drawable getCaptureButtonDrawable()
        Drawable used for capture button

      • getChangeFrameCollapseButtonDrawable

        public Drawable getChangeFrameCollapseButtonDrawable()
        Drawable used for the camera frame collapse button

      • getChangeFrameExpandButtonDrawable

        public Drawable getChangeFrameExpandButtonDrawable()
        Drawable used for the camera frame expand button

      • getCameraSwitchButtonDrawable

        public Drawable getCameraSwitchButtonDrawable()
        Drawable used for camera switch button

      • getToolbarSize

        public java.lang.Float getToolbarSize()
        Value in pixels, representing height of the toolbar at the bottom of camera preview activity