IDentity-SDK/com.idmission.sdk2.client.model/IDLayoutOptions

IDLayoutOptions

public final class IDLayoutOptions implements Parcelable

Provides options to customize layout or position of labels in ID Capture, Retry and Instruction Screens.

Constructors

public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity, @DrawableRes() Integer instructionContinueBtnBg, Integer instructionLabelTextBgCardElevation, @DrawableRes() Integer retryScreenDoneBtnBg, @DrawableRes() Integer retryScreenRetryBtnBg, Boolean instructionBackBtnHide, @DrawableRes() Integer captureAnywayButton, @DrawableRes() Integer exitButton, Boolean isIdCaptureProgressBarEnabled, Float idCaptureProgressBarLineWidth, @DrawableRes() Integer previewScreenRetryBtnBg, @DrawableRes() Integer previewScreenDoneBtnBg, Boolean previewScreenToolbarBackIconHide, Boolean isCaptureScreenToolbarTitleHide)

Properties

captureAnywayButton

private Integer captureAnywayButton

Sets the background drawable for the capture Anyway button on the ID Capture screen.

captureLabelGravity

private LabelGravity captureLabelGravity

Option to set Capture screen prompt label position.

exitButton

private Integer exitButton

Sets the background drawable for the Exit button on the ID Capture screen.

idCaptureProgressBarLineWidth

private Float idCaptureProgressBarLineWidth

Option to change the progress bar line width in ID Capture screen.

instructionBackBtnHide

private Boolean instructionBackBtnHide

Hide the instruction back button set value to true Id Instruction screen.

instructionContinueBtnBg

private Integer instructionContinueBtnBg

Sets the background drawable for the Continue button on the ID Instruction screen.

instructionLabelTextBgCardElevation

private Integer instructionLabelTextBgCardElevation

Sets the card elevation for "Place your ID in the screen as shown. The image will be captured automatically." background Id Instruction screen.

isCaptureScreenToolbarTitleHide

private Boolean isCaptureScreenToolbarTitleHide

Option to hide the Capture screen toolbar title text. Default is true (hidden).

isIdCaptureProgressBarEnabled

private Boolean isIdCaptureProgressBarEnabled

Option to enable or disable progress bar in ID Capture screen.

previewScreenDoneBtnBg

private Integer previewScreenDoneBtnBg

Sets the background drawable for the Done button on the Preview screen.

previewScreenRetryBtnBg

private Integer previewScreenRetryBtnBg

Sets the background drawable for the Retry button on the Preview screen.

previewScreenToolbarBackIconHide

private Boolean previewScreenToolbarBackIconHide

Option to hide the Preview screen toolbar back button. Default is true (hidden).

retryScreenDoneBtnBg

private Integer retryScreenDoneBtnBg

Sets the background drawable for the Done button on the ID Retry screen.

retryScreenRetryBtnBg

private Integer retryScreenRetryBtnBg

Sets the background drawable for the Retry button on the ID Retry screen.

topBarCancelButtonGravity

private CancelButtonGravity topBarCancelButtonGravity

Option to set Capture screen top bar cancel button position.

Functions

describeContents

public abstract Integer describeContents()

getCaptureAnywayButton

public final Integer getCaptureAnywayButton()

Sets the background drawable for the capture Anyway button on the ID Capture screen.

getCaptureLabelGravity

public final LabelGravity getCaptureLabelGravity()

Option to set Capture screen prompt label position.

getExitButton

public final Integer getExitButton()

Sets the background drawable for the Exit button on the ID Capture screen.

getIdCaptureProgressBarLineWidth

public final Float getIdCaptureProgressBarLineWidth()

Option to change the progress bar line width in ID Capture screen.

getInstructionBackBtnHide

public final Boolean getInstructionBackBtnHide()

Hide the instruction back button set value to true Id Instruction screen.

getInstructionContinueBtnBg

public final Integer getInstructionContinueBtnBg()

Sets the background drawable for the Continue button on the ID Instruction screen.

getInstructionLabelTextBgCardElevation

public final Integer getInstructionLabelTextBgCardElevation()

Sets the card elevation for "Place your ID in the screen as shown. The image will be captured automatically." background Id Instruction screen.

getPreviewScreenDoneBtnBg

public final Integer getPreviewScreenDoneBtnBg()

Sets the background drawable for the Done button on the Preview screen.

getPreviewScreenRetryBtnBg

public final Integer getPreviewScreenRetryBtnBg()

Sets the background drawable for the Retry button on the Preview screen.

getPreviewScreenToolbarBackIconHide

public final Boolean getPreviewScreenToolbarBackIconHide()

Option to hide the Preview screen toolbar back button. Default is true (hidden).

getRetryScreenDoneBtnBg

public final Integer getRetryScreenDoneBtnBg()

Sets the background drawable for the Done button on the ID Retry screen.

getRetryScreenRetryBtnBg

public final Integer getRetryScreenRetryBtnBg()

Sets the background drawable for the Retry button on the ID Retry screen.

getTopBarCancelButtonGravity

public final CancelButtonGravity getTopBarCancelButtonGravity()

Option to set Capture screen top bar cancel button position.

isCaptureScreenToolbarTitleHide

public final Boolean isCaptureScreenToolbarTitleHide()

Option to hide the Capture screen toolbar title text. Default is true (hidden).

isIdCaptureProgressBarEnabled

public final Boolean isIdCaptureProgressBarEnabled()

Option to enable or disable progress bar in ID Capture screen.

setCaptureAnywayButton

public final Unit setCaptureAnywayButton(Integer captureAnywayButton)

Sets the background drawable for the capture Anyway button on the ID Capture screen.

setCaptureLabelGravity

public final Unit setCaptureLabelGravity(LabelGravity captureLabelGravity)

Option to set Capture screen prompt label position.

setCaptureScreenToolbarTitleHide

public final Unit setCaptureScreenToolbarTitleHide(Boolean isCaptureScreenToolbarTitleHide)

Option to hide the Capture screen toolbar title text. Default is true (hidden).

setExitButton

public final Unit setExitButton(Integer exitButton)

Sets the background drawable for the Exit button on the ID Capture screen.

setIdCaptureProgressBarEnabled

public final Unit setIdCaptureProgressBarEnabled(Boolean isIdCaptureProgressBarEnabled)

Option to enable or disable progress bar in ID Capture screen.

setIdCaptureProgressBarLineWidth

public final Unit setIdCaptureProgressBarLineWidth(Float idCaptureProgressBarLineWidth)

Option to change the progress bar line width in ID Capture screen.

setInstructionBackBtnHide

public final Unit setInstructionBackBtnHide(Boolean instructionBackBtnHide)

Hide the instruction back button set value to true Id Instruction screen.

setInstructionContinueBtnBg

public final Unit setInstructionContinueBtnBg(Integer instructionContinueBtnBg)

Sets the background drawable for the Continue button on the ID Instruction screen.

setInstructionLabelTextBgCardElevation

public final Unit setInstructionLabelTextBgCardElevation(Integer instructionLabelTextBgCardElevation)

Sets the card elevation for "Place your ID in the screen as shown. The image will be captured automatically." background Id Instruction screen.

setPreviewScreenDoneBtnBg

public final Unit setPreviewScreenDoneBtnBg(Integer previewScreenDoneBtnBg)

Sets the background drawable for the Done button on the Preview screen.

setPreviewScreenRetryBtnBg

public final Unit setPreviewScreenRetryBtnBg(Integer previewScreenRetryBtnBg)

Sets the background drawable for the Retry button on the Preview screen.

setPreviewScreenToolbarBackIconHide

public final Unit setPreviewScreenToolbarBackIconHide(Boolean previewScreenToolbarBackIconHide)

Option to hide the Preview screen toolbar back button. Default is true (hidden).

setRetryScreenDoneBtnBg

public final Unit setRetryScreenDoneBtnBg(Integer retryScreenDoneBtnBg)

Sets the background drawable for the Done button on the ID Retry screen.

setRetryScreenRetryBtnBg

public final Unit setRetryScreenRetryBtnBg(Integer retryScreenRetryBtnBg)

Sets the background drawable for the Retry button on the ID Retry screen.

setTopBarCancelButtonGravity

public final Unit setTopBarCancelButtonGravity(CancelButtonGravity topBarCancelButtonGravity)

Option to set Capture screen top bar cancel button position.

writeToParcel

public abstract Unit writeToParcel(Parcel p0, Integer p1)