All Implemented Interfaces:: android.os.Parcelable


public final class MrzScannerScreenTextLocalization
 implements Parcelable

Configuration of the all strings for MRZ scanner screen.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`topBarTitle`
`private String`	`topBarCancelButton`
`private String`	`topUserGuidance`
`private String`	`finderViewUserGuidance`
`private String`	`introScreenTitle`
`private String`	`introScreenDoneButton`
`private String`	`introScreenText`
`private String`	`completionOverlaySuccessMessage`
`private String`	`accessibilityDescriptionOpenIntroScreenButton`
`private String`	`accessibilityDescriptionIntroScreenDoneButton`
`private String`	`accessibilityDescriptionCancelButton`
`private String`	`accessibilityDescriptionFlashButton`
`private String`	`accessibilityDescriptionZoomButton`
`private String`	`accessibilityDescriptionFlipCameraButton`
`private String`	`cameraPermissionEnableCameraTitle`
`private String`	`cameraPermissionEnableCameraExplanation`
`private String`	`cameraPermissionEnableCameraButton`
`private String`	`cameraPermissionCloseButton`
`private String`	`accessibilityDescriptionCameraPermissionEnableCameraButton`
`private String`	`accessibilityDescriptionCameraPermissionCloseButton`

Constructor Summary

Constructors
Constructor	Description
`MrzScannerScreenTextLocalization(Map<String, Object> source)`
`MrzScannerScreenTextLocalization(JSONObject json)`
MrzScannerScreenTextLocalization(String topBarTitle, String topBarCancelButton, String topUserGuidance, String finderViewUserGuidance, String introScreenTitle, String introScreenDoneButton, String introScreenText, String completionOverlaySuccessMessage, String accessibilityDescriptionOpenIntroScreenButton, String accessibilityDescriptionIntroScreenDoneButton, String accessibilityDescriptionCancelButton, String accessibilityDescriptionFlashButton, String accessibilityDescriptionZoomButton, String accessibilityDescriptionFlipCameraButton, String cameraPermissionEnableCameraTitle, String cameraPermissionEnableCameraExplanation, String cameraPermissionEnableCameraButton, String cameraPermissionCloseButton, String accessibilityDescriptionCameraPermissionEnableCameraButton, String accessibilityDescriptionCameraPermissionCloseButton)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getTopBarTitle()`	Title for the top bar.
`final Unit`	`setTopBarTitle(String topBarTitle)`	Title for the top bar.
`final String`	`getTopBarCancelButton()`	Cancel button text for the top bar.
`final Unit`	`setTopBarCancelButton(String topBarCancelButton)`	Cancel button text for the top bar.
`final String`	`getTopUserGuidance()`	Text for the top user guidance caption.
`final Unit`	`setTopUserGuidance(String topUserGuidance)`	Text for the top user guidance caption.
`final String`	`getFinderViewUserGuidance()`	Text for the user guidance caption below the finder view.
`final Unit`	`setFinderViewUserGuidance(String finderViewUserGuidance)`	Text for the user guidance caption below the finder view.
`final String`	`getIntroScreenTitle()`	Title for the introduction screen.
`final Unit`	`setIntroScreenTitle(String introScreenTitle)`	Title for the introduction screen.
`final String`	`getIntroScreenDoneButton()`	Start scanning button text for the introduction screen.
`final Unit`	`setIntroScreenDoneButton(String introScreenDoneButton)`	Start scanning button text for the introduction screen.
`final String`	`getIntroScreenText()`	The text explanation for the introduction screen.
`final Unit`	`setIntroScreenText(String introScreenText)`	The text explanation for the introduction screen.
`final String`	`getCompletionOverlaySuccessMessage()`	Caption for the success overlay.
`final Unit`	`setCompletionOverlaySuccessMessage(String completionOverlaySuccessMessage)`	Caption for the success overlay.
`final String`	`getAccessibilityDescriptionOpenIntroScreenButton()`	Accessibility description for the 'open introduction screen' button in top bar.
`final Unit`	`setAccessibilityDescriptionOpenIntroScreenButton(String accessibilityDescriptionOpenIntroScreenButton)`	Accessibility description for the 'open introduction screen' button in top bar.
`final String`	`getAccessibilityDescriptionIntroScreenDoneButton()`	Accessibility description for the 'done'/'start scanning' button in the introduction screen.
`final Unit`	`setAccessibilityDescriptionIntroScreenDoneButton(String accessibilityDescriptionIntroScreenDoneButton)`	Accessibility description for the 'done'/'start scanning' button in the introduction screen.
`final String`	`getAccessibilityDescriptionCancelButton()`	Accessibility description for the 'cancel' button in the top bar.
`final Unit`	`setAccessibilityDescriptionCancelButton(String accessibilityDescriptionCancelButton)`	Accessibility description for the 'cancel' button in the top bar.
`final String`	`getAccessibilityDescriptionFlashButton()`	Accessibility description for the flash button.
`final Unit`	`setAccessibilityDescriptionFlashButton(String accessibilityDescriptionFlashButton)`	Accessibility description for the flash button.
`final String`	`getAccessibilityDescriptionZoomButton()`	Accessibility description for the zoom button.
`final Unit`	`setAccessibilityDescriptionZoomButton(String accessibilityDescriptionZoomButton)`	Accessibility description for the zoom button.
`final String`	`getAccessibilityDescriptionFlipCameraButton()`	Accessibility description for the flip camera button.
`final Unit`	`setAccessibilityDescriptionFlipCameraButton(String accessibilityDescriptionFlipCameraButton)`	Accessibility description for the flip camera button.
`final String`	`getCameraPermissionEnableCameraTitle()`	The title of the camera permission dialog.
`final Unit`	`setCameraPermissionEnableCameraTitle(String cameraPermissionEnableCameraTitle)`	The title of the camera permission dialog.
`final String`	`getCameraPermissionEnableCameraExplanation()`	The explanation text of the camera permission dialog.
`final Unit`	`setCameraPermissionEnableCameraExplanation(String cameraPermissionEnableCameraExplanation)`	The explanation text of the camera permission dialog.
`final String`	`getCameraPermissionEnableCameraButton()`	The 'enable' button title of the camera permission dialog.
`final Unit`	`setCameraPermissionEnableCameraButton(String cameraPermissionEnableCameraButton)`	The 'enable' button title of the camera permission dialog.
`final String`	`getCameraPermissionCloseButton()`	The 'close' button title of the camera permission dialog.
`final Unit`	`setCameraPermissionCloseButton(String cameraPermissionCloseButton)`	The 'close' button title of the camera permission dialog.
`final String`	`getAccessibilityDescriptionCameraPermissionEnableCameraButton()`	The accessibility hint for the 'enable' button of the camera permission dialog.
`final Unit`	`setAccessibilityDescriptionCameraPermissionEnableCameraButton(String accessibilityDescriptionCameraPermissionEnableCameraButton)`	The accessibility hint for the 'enable' button of the camera permission dialog.
`final String`	`getAccessibilityDescriptionCameraPermissionCloseButton()`	The accessibility hint for the 'close' button of the camera permission dialog.
`final Unit`	`setAccessibilityDescriptionCameraPermissionCloseButton(String accessibilityDescriptionCameraPermissionCloseButton)`	The accessibility hint for the 'close' button of the camera permission dialog.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final MrzScannerScreenTextLocalization`	`clone()`
`final static MrzScannerScreenTextLocalization`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MrzScannerScreenTextLocalization
```
MrzScannerScreenTextLocalization(Map<String, Object> source)
```
  - MrzScannerScreenTextLocalization
```
MrzScannerScreenTextLocalization(JSONObject json)
```
  - MrzScannerScreenTextLocalization
```
MrzScannerScreenTextLocalization(String topBarTitle, String topBarCancelButton, String topUserGuidance, String finderViewUserGuidance, String introScreenTitle, String introScreenDoneButton, String introScreenText, String completionOverlaySuccessMessage, String accessibilityDescriptionOpenIntroScreenButton, String accessibilityDescriptionIntroScreenDoneButton, String accessibilityDescriptionCancelButton, String accessibilityDescriptionFlashButton, String accessibilityDescriptionZoomButton, String accessibilityDescriptionFlipCameraButton, String cameraPermissionEnableCameraTitle, String cameraPermissionEnableCameraExplanation, String cameraPermissionEnableCameraButton, String cameraPermissionCloseButton, String accessibilityDescriptionCameraPermissionEnableCameraButton, String accessibilityDescriptionCameraPermissionCloseButton)
```
- Method Detail
  - getTopBarTitle
```
 final String getTopBarTitle()
```
    Title for the top bar.
    Default is "MRZ Scanner"
  - setTopBarTitle
```
 final Unit setTopBarTitle(String topBarTitle)
```
    Title for the top bar.
    Default is "MRZ Scanner"
  - getTopBarCancelButton
```
 final String getTopBarCancelButton()
```
    Cancel button text for the top bar.
    Default is "Cancel"
  - setTopBarCancelButton
```
 final Unit setTopBarCancelButton(String topBarCancelButton)
```
    Cancel button text for the top bar.
    Default is "Cancel"
  - getTopUserGuidance
```
 final String getTopUserGuidance()
```
    Text for the top user guidance caption.
    Default is "Scan your Identity Document"
  - setTopUserGuidance
```
 final Unit setTopUserGuidance(String topUserGuidance)
```
    Text for the top user guidance caption.
    Default is "Scan your Identity Document"
  - getFinderViewUserGuidance
```
 final String getFinderViewUserGuidance()
```
    Text for the user guidance caption below the finder view.
    Default is "Scan the MRZ"
  - setFinderViewUserGuidance
```
 final Unit setFinderViewUserGuidance(String finderViewUserGuidance)
```
    Text for the user guidance caption below the finder view.
    Default is "Scan the MRZ"
  - getIntroScreenTitle
```
 final String getIntroScreenTitle()
```
    Title for the introduction screen.
    Default is "How to scan an MRZ"
  - setIntroScreenTitle
```
 final Unit setIntroScreenTitle(String introScreenTitle)
```
    Title for the introduction screen.
    Default is "How to scan an MRZ"
  - getIntroScreenDoneButton
```
 final String getIntroScreenDoneButton()
```
    Start scanning button text for the introduction screen.
    Default is "Start Scanning"
  - setIntroScreenDoneButton
```
 final Unit setIntroScreenDoneButton(String introScreenDoneButton)
```
    Start scanning button text for the introduction screen.
    Default is "Start Scanning"
  - getIntroScreenText
```
 final String getIntroScreenText()
```
    The text explanation for the introduction screen.
    Default is "The Machine Readable Zone (MRZ) is a special code on your ID document (such as a passport or ID card) that contains your personal information in a machine-readable format.\n\nTo scan it, simply hold your camera over the document, so that it aligns with the MRZ section. Once scanned, the data will be automatically processed, and you will be directed to the results screen.\n\nPress 'Start Scanning' to begin."
  - setIntroScreenText
```
 final Unit setIntroScreenText(String introScreenText)
```
    The text explanation for the introduction screen.
    Default is "The Machine Readable Zone (MRZ) is a special code on your ID document (such as a passport or ID card) that contains your personal information in a machine-readable format.\n\nTo scan it, simply hold your camera over the document, so that it aligns with the MRZ section. Once scanned, the data will be automatically processed, and you will be directed to the results screen.\n\nPress 'Start Scanning' to begin."
  - getCompletionOverlaySuccessMessage
```
 final String getCompletionOverlaySuccessMessage()
```
    Caption for the success overlay.
    Default is "Scanned successfully"
  - setCompletionOverlaySuccessMessage
```
 final Unit setCompletionOverlaySuccessMessage(String completionOverlaySuccessMessage)
```
    Caption for the success overlay.
    Default is "Scanned successfully"
  - getAccessibilityDescriptionOpenIntroScreenButton
```
 final String getAccessibilityDescriptionOpenIntroScreenButton()
```
    Accessibility description for the 'open introduction screen' button in top bar.
    Default is "Open introduction screen."
  - setAccessibilityDescriptionOpenIntroScreenButton
```
 final Unit setAccessibilityDescriptionOpenIntroScreenButton(String accessibilityDescriptionOpenIntroScreenButton)
```
    Accessibility description for the 'open introduction screen' button in top bar.
    Default is "Open introduction screen."
  - getAccessibilityDescriptionIntroScreenDoneButton
```
 final String getAccessibilityDescriptionIntroScreenDoneButton()
```
    Accessibility description for the 'done'/'start scanning' button in the introduction screen.
    Default is "Start scanning"
  - setAccessibilityDescriptionIntroScreenDoneButton
```
 final Unit setAccessibilityDescriptionIntroScreenDoneButton(String accessibilityDescriptionIntroScreenDoneButton)
```
    Accessibility description for the 'done'/'start scanning' button in the introduction screen.
    Default is "Start scanning"
  - getAccessibilityDescriptionCancelButton
```
 final String getAccessibilityDescriptionCancelButton()
```
    Accessibility description for the 'cancel' button in the top bar.
    Default is "Cancel"
  - setAccessibilityDescriptionCancelButton
```
 final Unit setAccessibilityDescriptionCancelButton(String accessibilityDescriptionCancelButton)
```
    Accessibility description for the 'cancel' button in the top bar.
    Default is "Cancel"
  - getAccessibilityDescriptionFlashButton
```
 final String getAccessibilityDescriptionFlashButton()
```
    Accessibility description for the flash button.
    Default is "Toggle flash"
  - setAccessibilityDescriptionFlashButton
```
 final Unit setAccessibilityDescriptionFlashButton(String accessibilityDescriptionFlashButton)
```
    Accessibility description for the flash button.
    Default is "Toggle flash"
  - getAccessibilityDescriptionZoomButton
```
 final String getAccessibilityDescriptionZoomButton()
```
    Accessibility description for the zoom button.
    Default is "Toggle camera zoom"
  - setAccessibilityDescriptionZoomButton
```
 final Unit setAccessibilityDescriptionZoomButton(String accessibilityDescriptionZoomButton)
```
    Accessibility description for the zoom button.
    Default is "Toggle camera zoom"
  - getAccessibilityDescriptionFlipCameraButton
```
 final String getAccessibilityDescriptionFlipCameraButton()
```
    Accessibility description for the flip camera button.
    Default is "Flip camera"
  - setAccessibilityDescriptionFlipCameraButton
```
 final Unit setAccessibilityDescriptionFlipCameraButton(String accessibilityDescriptionFlipCameraButton)
```
    Accessibility description for the flip camera button.
    Default is "Flip camera"
  - getCameraPermissionEnableCameraTitle
```
 final String getCameraPermissionEnableCameraTitle()
```
    The title of the camera permission dialog.
    Default is "Camera permission denied!"
  - setCameraPermissionEnableCameraTitle
```
 final Unit setCameraPermissionEnableCameraTitle(String cameraPermissionEnableCameraTitle)
```
    The title of the camera permission dialog.
    Default is "Camera permission denied!"
  - getCameraPermissionEnableCameraExplanation
```
 final String getCameraPermissionEnableCameraExplanation()
```
    The explanation text of the camera permission dialog.
    Default is "Please allow the usage of the camera to start the scanning process."
  - setCameraPermissionEnableCameraExplanation
```
 final Unit setCameraPermissionEnableCameraExplanation(String cameraPermissionEnableCameraExplanation)
```
    The explanation text of the camera permission dialog.
    Default is "Please allow the usage of the camera to start the scanning process."
  - getCameraPermissionEnableCameraButton
```
 final String getCameraPermissionEnableCameraButton()
```
    The 'enable' button title of the camera permission dialog.
    Default is "Grant permission"
  - setCameraPermissionEnableCameraButton
```
 final Unit setCameraPermissionEnableCameraButton(String cameraPermissionEnableCameraButton)
```
    The 'enable' button title of the camera permission dialog.
    Default is "Grant permission"
  - getCameraPermissionCloseButton
```
 final String getCameraPermissionCloseButton()
```
    The 'close' button title of the camera permission dialog.
    Default is "Close"
  - setCameraPermissionCloseButton
```
 final Unit setCameraPermissionCloseButton(String cameraPermissionCloseButton)
```
    The 'close' button title of the camera permission dialog.
    Default is "Close"
  - getAccessibilityDescriptionCameraPermissionEnableCameraButton
```
 final String getAccessibilityDescriptionCameraPermissionEnableCameraButton()
```
    The accessibility hint for the 'enable' button of the camera permission dialog.
    Default is "Tap to grant camera permission"
  - setAccessibilityDescriptionCameraPermissionEnableCameraButton
```
 final Unit setAccessibilityDescriptionCameraPermissionEnableCameraButton(String accessibilityDescriptionCameraPermissionEnableCameraButton)
```
    The accessibility hint for the 'enable' button of the camera permission dialog.
    Default is "Tap to grant camera permission"
  - getAccessibilityDescriptionCameraPermissionCloseButton
```
 final String getAccessibilityDescriptionCameraPermissionCloseButton()
```
    The accessibility hint for the 'close' button of the camera permission dialog.
    Default is "Close screen without granting permission"
  - setAccessibilityDescriptionCameraPermissionCloseButton
```
 final Unit setAccessibilityDescriptionCameraPermissionCloseButton(String accessibilityDescriptionCameraPermissionCloseButton)
```
    The accessibility hint for the 'close' button of the camera permission dialog.
    Default is "Close screen without granting permission"
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final MrzScannerScreenTextLocalization clone()
```
  - default
```
 final static MrzScannerScreenTextLocalization default()
```

Class MrzScannerScreenTextLocalization

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MrzScannerScreenTextLocalization

MrzScannerScreenTextLocalization

MrzScannerScreenTextLocalization

Method Detail

getTopBarTitle

setTopBarTitle

getTopBarCancelButton

setTopBarCancelButton

getTopUserGuidance

setTopUserGuidance

getFinderViewUserGuidance

setFinderViewUserGuidance

getIntroScreenTitle

setIntroScreenTitle

getIntroScreenDoneButton

setIntroScreenDoneButton

getIntroScreenText

setIntroScreenText

getCompletionOverlaySuccessMessage

setCompletionOverlaySuccessMessage

getAccessibilityDescriptionOpenIntroScreenButton

setAccessibilityDescriptionOpenIntroScreenButton

getAccessibilityDescriptionIntroScreenDoneButton

setAccessibilityDescriptionIntroScreenDoneButton

getAccessibilityDescriptionCancelButton

setAccessibilityDescriptionCancelButton

getAccessibilityDescriptionFlashButton

setAccessibilityDescriptionFlashButton

getAccessibilityDescriptionZoomButton

setAccessibilityDescriptionZoomButton

getAccessibilityDescriptionFlipCameraButton

setAccessibilityDescriptionFlipCameraButton

getCameraPermissionEnableCameraTitle

setCameraPermissionEnableCameraTitle

getCameraPermissionEnableCameraExplanation

setCameraPermissionEnableCameraExplanation

getCameraPermissionEnableCameraButton

setCameraPermissionEnableCameraButton

getCameraPermissionCloseButton

setCameraPermissionCloseButton

getAccessibilityDescriptionCameraPermissionEnableCameraButton

setAccessibilityDescriptionCameraPermissionEnableCameraButton

getAccessibilityDescriptionCameraPermissionCloseButton

setAccessibilityDescriptionCameraPermissionCloseButton

toJson

clone

default