Search docsIDmission.com ↗
Mobile SDKs18 pages
Mobile SDKs / IDLayoutOptions

IDLayoutOptions

← Browse native SDK reference

Imported 2026-10-21View original source ↗How updates workRead Markdown
On this page · 4 sections
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)
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)
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)
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)
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)
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)
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)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity, @DrawableRes() Integer instructionContinueBtnBg, Integer instructionLabelTextBgCardElevation, @DrawableRes() Integer retryScreenDoneBtnBg, @DrawableRes() Integer retryScreenRetryBtnBg, Boolean instructionBackBtnHide, @DrawableRes() Integer captureAnywayButton)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity, @DrawableRes() Integer instructionContinueBtnBg, Integer instructionLabelTextBgCardElevation, @DrawableRes() Integer retryScreenDoneBtnBg, @DrawableRes() Integer retryScreenRetryBtnBg, Boolean instructionBackBtnHide)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity, @DrawableRes() Integer instructionContinueBtnBg, Integer instructionLabelTextBgCardElevation, @DrawableRes() Integer retryScreenDoneBtnBg, @DrawableRes() Integer retryScreenRetryBtnBg)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity, @DrawableRes() Integer instructionContinueBtnBg, Integer instructionLabelTextBgCardElevation, @DrawableRes() Integer retryScreenDoneBtnBg)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity, @DrawableRes() Integer instructionContinueBtnBg, Integer instructionLabelTextBgCardElevation)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity, @DrawableRes() Integer instructionContinueBtnBg)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity, CancelButtonGravity topBarCancelButtonGravity)
public IDLayoutOptions IDLayoutOptions(LabelGravity captureLabelGravity)
public IDLayoutOptions IDLayoutOptions()

Properties

private Integer captureAnywayButton

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

private LabelGravity captureLabelGravity

Option to set Capture screen prompt label position.

private Integer exitButton

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

private Float idCaptureProgressBarLineWidth

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

private Boolean instructionBackBtnHide

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

private Integer instructionContinueBtnBg

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

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.

private Boolean isCaptureScreenToolbarTitleHide

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

private Boolean isIdCaptureProgressBarEnabled

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

private Integer previewScreenDoneBtnBg

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

private Integer previewScreenRetryBtnBg

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

private Boolean previewScreenToolbarBackIconHide

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

private Integer retryScreenDoneBtnBg

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

private Integer retryScreenRetryBtnBg

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

private CancelButtonGravity topBarCancelButtonGravity

Option to set Capture screen top bar cancel button position.

Functions

public final Integer getCaptureAnywayButton()

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

public final LabelGravity getCaptureLabelGravity()

Option to set Capture screen prompt label position.

public final Integer getExitButton()

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

public final Float getIdCaptureProgressBarLineWidth()

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

public final Boolean getInstructionBackBtnHide()

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

public final Integer getInstructionContinueBtnBg()

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

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.

public final Integer getPreviewScreenDoneBtnBg()

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

public final Integer getPreviewScreenRetryBtnBg()

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

public final Boolean getPreviewScreenToolbarBackIconHide()

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

public final Integer getRetryScreenDoneBtnBg()

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

public final Integer getRetryScreenRetryBtnBg()

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

public final CancelButtonGravity getTopBarCancelButtonGravity()

Option to set Capture screen top bar cancel button position.

public final Boolean isCaptureScreenToolbarTitleHide()

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

public final Boolean isIdCaptureProgressBarEnabled()

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

public final Unit setCaptureAnywayButton(Integer captureAnywayButton)

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

public final Unit setCaptureLabelGravity(LabelGravity captureLabelGravity)

Option to set Capture screen prompt label position.

public final Unit setCaptureScreenToolbarTitleHide(Boolean isCaptureScreenToolbarTitleHide)

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

public final Unit setExitButton(Integer exitButton)

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

public final Unit setIdCaptureProgressBarEnabled(Boolean isIdCaptureProgressBarEnabled)

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

public final Unit setIdCaptureProgressBarLineWidth(Float idCaptureProgressBarLineWidth)

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

public final Unit setInstructionBackBtnHide(Boolean instructionBackBtnHide)

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

public final Unit setInstructionContinueBtnBg(Integer instructionContinueBtnBg)

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

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.

public final Unit setPreviewScreenDoneBtnBg(Integer previewScreenDoneBtnBg)

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

public final Unit setPreviewScreenRetryBtnBg(Integer previewScreenRetryBtnBg)

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

public final Unit setPreviewScreenToolbarBackIconHide(Boolean previewScreenToolbarBackIconHide)

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

public final Unit setRetryScreenDoneBtnBg(Integer retryScreenDoneBtnBg)

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

public final Unit setRetryScreenRetryBtnBg(Integer retryScreenRetryBtnBg)

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

public final Unit setTopBarCancelButtonGravity(CancelButtonGravity topBarCancelButtonGravity)

Option to set Capture screen top bar cancel button position.

public abstract Unit writeToParcel(Parcel p0, Integer p1)
Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.