Package com.regula.documentreader.api.params

Class ParamsCustomization

java.lang.Object
com.regula.documentreader.api.params.ParamsCustomization
public class ParamsCustomization extends Object
Structure containing parameters for UI customization on the document capture screen
See Also:

  • Constructor Details

    • ParamsCustomization

      public ParamsCustomization()

  • Method Details

    • getStatus

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

    • getResultStatus

      @Deprecated public String getResultStatus()
      Deprecated.
      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

      @Deprecated public boolean isShowResultStatusMessages()
      Deprecated.
      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 Integer getCameraFrameBorderWidth()
      Thickness of document bounds border on the video preview (dp)

    • getCameraFrameDefaultColor

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

    • getCameraFrameActiveColor

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

    • getStatusTextFont

      public Typeface getStatusTextFont()
      Typeface of main text status

    • getStatusTextSize

      public Integer getStatusTextSize()
      Size of main text status (sp)

    • getStatusTextColor

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

    • getStatusBackgroundColor

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

    • getCameraFrameShapeType

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

    • getCameraFrameLineLength

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

    • getResultStatusTextFont

      @Deprecated public Typeface getResultStatusTextFont()
      Deprecated.
      Typeface of current text status

    • getResultStatusTextSize

      @Deprecated public Integer getResultStatusTextSize()
      Deprecated.
      Size of current text status (sp)

    • getResultStatusTextColor

      @Deprecated public String getResultStatusTextColor()
      Deprecated.
      Hex string of current text status color

    • getResultStatusBackgroundColor

      @Deprecated public String getResultStatusBackgroundColor()
      Deprecated.
      Hex string of current text status background color

    • getMultipageButtonBackgroundColor

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

    • getMultipageButtonText

      public String getMultipageButtonText()
      Hex string of page skipping button background

    • getMultipageButtonTextFont

      public Typeface getMultipageButtonTextFont()
      Typeface of page skipping button text

    • getMultipageButtonTextSize

      public Integer getMultipageButtonTextSize()
      Size of page skipping button text (sp)

    • getMultipageButtonTextColor

      public String getMultipageButtonTextColor()
      Hex string of page skipping button text color

    • getTintColor

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

    • getActivityIndicatorColor

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

    • getActivityIndicatorSize

      public Integer getActivityIndicatorSize()
      width and height of loading indicator(s)

    • isShowNextPageAnimation

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

    • getNextPageAnimationStartDelay

      public Float getNextPageAnimationStartDelay()
      Animation delay before flip, 0 - is default value

    • getNextPageAnimationEndDelay

      public Float getNextPageAnimationEndDelay()
      Animation delay after flip, 0 - is default value

    • isShowBackgroundMask

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

    • getHologramAnimationImage

      @Deprecated public Drawable getHologramAnimationImage()
      Deprecated.
      Drawable displayed as instruction animation, when hologram detection sequence is started use getLivenessAnimationImage() instead

    • getLivenessAnimationImage

      public Drawable getLivenessAnimationImage()
      Drawable displayed as instruction animation, when liveness detection sequence is started

    • getHologramAnimationImageScaleType

      @Deprecated public ImageView.ScaleType getHologramAnimationImageScaleType()
      Deprecated.
      To change the scaling of the image, use one of the ImageView.ScaleType members use getLivenessAnimationImageScaleType() instead

    • getLivenessAnimationImageScaleType

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

    • getHologramAnimationImageMatrix

      @Deprecated public Matrix getHologramAnimationImageMatrix()
      Deprecated.
      MATRIX used to scale hologram instructional animation image Is used only when getHologramAnimationImageScaleType() is set to ImageView.ScaleType#MATRIX use getLivenessAnimationImageMatrix()} instead

    • getLivenessAnimationImageMatrix

      public Matrix getLivenessAnimationImageMatrix()
      MATRIX used to scale liveness instructional animation image Is used only when getHologramAnimationImageScaleType() is set to 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 ImageView.ScaleType members

    • getHelpAnimationImageMatrix

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

    • getUiCustomizationLayer

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

    • 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 ImageView.ScaleType members

    • getMultipageAnimationFrontImageMatrix

      public Matrix getMultipageAnimationFrontImageMatrix()
      MATRIX used to scale page turn animation first image Is used only when getHelpAnimationImageScaleType() is set to 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 ImageView.ScaleType members

    • getMultipageAnimationBackImageMatrix

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

    • getStatusPositionMultiplier

      public 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

    • getResultStatusPositionMultiplier

      @Deprecated public Float getResultStatusPositionMultiplier()
      Deprecated.
      See getStatusPositionMultiplier()

    • getBorderBackgroundImage

      public Drawable getBorderBackgroundImage()
      Drawable displayed within the camera frame

    • getBorderBackgroundImageMatrix

      public Matrix getBorderBackgroundImageMatrix()
      MATRIX used to scale border image Is used only when getBorderBackgroundImageScaleType() is set to ImageView.ScaleType#MATRIX

    • getBorderBackgroundImageScaleType

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

    • getBackgroundMaskAlpha

      public 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

    • getBackgroundMaskColor

      public String getBackgroundMaskColor()
      Hex string of background mask color

    • getCameraFrameOffsetWidth

      public 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

    • getCustomStatusPositionMultiplier

      public Float getCustomStatusPositionMultiplier()
      See getStatusPositionMultiplier()

    • getHologramAnimationPositionMultiplier

      @Deprecated public Float getHologramAnimationPositionMultiplier()
      Deprecated.
      Change the position of hologram detection help animation. use getLivenessAnimationPositionMultiplier() instead

    • getLivenessAnimationPositionMultiplier

      public Float getLivenessAnimationPositionMultiplier()
      Change the position of liveness detection help animation.

    • getCameraPreviewVerticalPositionMultiplier

      public Float getCameraPreviewVerticalPositionMultiplier()
      Change the vertical position of the camera preview.

    • getCameraFrameVerticalPositionMultiplier

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

    • getActivityIndicatorPortraitPositionMultiplier

      public Float getActivityIndicatorPortraitPositionMultiplier()
      Change the vertical position of the activity indicator in portrait mode.

    • getActivityIndicatorLandscapePositionMultiplier

      public Float getActivityIndicatorLandscapePositionMultiplier()
      Change the vertical position of the activity indicator in landscape mode.

    • getCameraFrameLandscapeAspectRatio

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

    • getCameraFramePortraitAspectRatio

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

    • getCameraFrameCornerRadius

      public 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

    • getMultipageButtonDrawable

      public Drawable getMultipageButtonDrawable()
      Drawable used for multipage button

    • getCaptureButtonDrawable

      public Drawable getCaptureButtonDrawable()
      Drawable used for capture button

    • getChangeFrameCollapseButtonDrawable

      @Deprecated public Drawable getChangeFrameCollapseButtonDrawable()
      Deprecated.
      Drawable used for the camera frame collapse button. Not used for new UI

    • getChangeFrameExpandButtonDrawable

      @Deprecated public Drawable getChangeFrameExpandButtonDrawable()
      Deprecated.
      Drawable used for the camera frame expand button. Not used for new UI

    • getCameraSwitchButtonDrawable

      public Drawable getCameraSwitchButtonDrawable()
      Drawable used for camera switch button

    • getToolbarSize

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

    • getCameraPreviewBackgroundColor

      public String getCameraPreviewBackgroundColor()
      Hex string of camera preview background color

    • getColors

      public HashMap<CustomizationColor,Long> getColors()

    • getFonts

      public HashMap<CustomizationFont,Integer> getFonts()

    • getFontSizes

      public HashMap<CustomizationFont,Integer> getFontSizes()

    • getTypeFaces

      public HashMap<CustomizationFont,Typeface> getTypeFaces()

    • getImages

      public HashMap<CustomizationImage,Drawable> getImages()

    • edit

      public ParamsCustomization.CustomizationEditor edit()
      Create a new Editor for these preferences, through which you can make modifications to the data in the customization and atomically commit those changes back to the ParamsCustomization object. Note that you must call ParamsCustomization.CustomizationEditor.apply() to have any changes you perform in the Editor actually show up in the ParamsCustomization.
      Returns:
      ParamsCustomization.CustomizationEditor instance

    • toJsonObject

      public JSONObject toJsonObject()

    • toJson

      public String toJson()

    • fromJson

      public void fromJson(String json)

    • fromJson

      public void fromJson(JSONObject object)