Class TextPatternScannerScreenTextLocalization
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class TextPatternScannerScreenTextLocalization implements Parcelable
Configuration of the all strings for generic text scanner screen.
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description TextPatternScannerScreenTextLocalization(Map<String, Object> source)
TextPatternScannerScreenTextLocalization(JSONObject json)
TextPatternScannerScreenTextLocalization(String topBarTitle, String topBarCancelButton, String topUserGuidance, String finderViewUserGuidance, String introScreenTitle, String introScreenDoneButton, String introScreenText, String completionOverlaySuccessMessage, String accessibilityDescriptionOpenIntroScreenButton, String accessibilityDescriptionIntroScreenDoneButton, String accessibilityDescriptionCancelButton, String textPatternConfirmationAlertTitle, String textPatternConfirmationAlertCancelButton, String textPatternConfirmationAlertSubmitButton, String accessibilityDescriptionConfirmationCancelButton, String accessibilityDescriptionConfirmationSubmitButton, String accessibilityDescriptionFlashButton, String accessibilityDescriptionZoomButton, String accessibilityDescriptionFlipCameraButton, String cameraPermissionEnableCameraTitle, String cameraPermissionEnableCameraExplanation, String cameraPermissionEnableCameraButton, String cameraPermissionCloseButton, String accessibilityDescriptionCameraPermissionEnableCameraButton, String accessibilityDescriptionCameraPermissionCloseButton)
-
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
getTextPatternConfirmationAlertTitle()
Title for the text pattern confirmation alert. final Unit
setTextPatternConfirmationAlertTitle(String textPatternConfirmationAlertTitle)
Title for the text pattern confirmation alert. final String
getTextPatternConfirmationAlertCancelButton()
Cancel button text for the text pattern confirmation alert. final Unit
setTextPatternConfirmationAlertCancelButton(String textPatternConfirmationAlertCancelButton)
Cancel button text for the text pattern confirmation alert. final String
getTextPatternConfirmationAlertSubmitButton()
Submit button text for the text pattern confirmation alert. final Unit
setTextPatternConfirmationAlertSubmitButton(String textPatternConfirmationAlertSubmitButton)
Submit button text for the text pattern confirmation alert. final String
getAccessibilityDescriptionConfirmationCancelButton()
Accessibility description for the cancel button in the text pattern confirmation alert. final Unit
setAccessibilityDescriptionConfirmationCancelButton(String accessibilityDescriptionConfirmationCancelButton)
Accessibility description for the cancel button in the text pattern confirmation alert. final String
getAccessibilityDescriptionConfirmationSubmitButton()
Accessibility description for the submit button in the text pattern confirmation alert. final Unit
setAccessibilityDescriptionConfirmationSubmitButton(String accessibilityDescriptionConfirmationSubmitButton)
Accessibility description for the submit button in the text pattern confirmation alert. 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 TextPatternScannerScreenTextLocalization
clone()
final static TextPatternScannerScreenTextLocalization
default()
-
-
Constructor Detail
-
TextPatternScannerScreenTextLocalization
TextPatternScannerScreenTextLocalization(Map<String, Object> source)
-
TextPatternScannerScreenTextLocalization
TextPatternScannerScreenTextLocalization(JSONObject json)
-
TextPatternScannerScreenTextLocalization
TextPatternScannerScreenTextLocalization(String topBarTitle, String topBarCancelButton, String topUserGuidance, String finderViewUserGuidance, String introScreenTitle, String introScreenDoneButton, String introScreenText, String completionOverlaySuccessMessage, String accessibilityDescriptionOpenIntroScreenButton, String accessibilityDescriptionIntroScreenDoneButton, String accessibilityDescriptionCancelButton, String textPatternConfirmationAlertTitle, String textPatternConfirmationAlertCancelButton, String textPatternConfirmationAlertSubmitButton, String accessibilityDescriptionConfirmationCancelButton, String accessibilityDescriptionConfirmationSubmitButton, 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 "Text Scanner"
-
setTopBarTitle
final Unit setTopBarTitle(String topBarTitle)
Title for the top bar.
Default is "Text 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 "Locate the text you are looking for"
-
setTopUserGuidance
final Unit setTopUserGuidance(String topUserGuidance)
Text for the top user guidance caption.
Default is "Locate the text you are looking for"
-
getFinderViewUserGuidance
final String getFinderViewUserGuidance()
Text for the user guidance caption below the finder view.
Default is "Scanning for text pattern..."
-
setFinderViewUserGuidance
final Unit setFinderViewUserGuidance(String finderViewUserGuidance)
Text for the user guidance caption below the finder view.
Default is "Scanning for text pattern..."
-
getIntroScreenTitle
final String getIntroScreenTitle()
Title for the introduction screen.
Default is "How to scan text"
-
setIntroScreenTitle
final Unit setIntroScreenTitle(String introScreenTitle)
Title for the introduction screen.
Default is "How to scan text"
-
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 "To scan a single line of text, please hold your device so that the camera viewfinder clearly captures the text you want to scan. Please ensure the text is properly aligned. Once the scan is complete, the text will be automatically extracted.\n\nPress 'Start Scanning' to begin."
-
setIntroScreenText
final Unit setIntroScreenText(String introScreenText)
The text explanation for the introduction screen.
Default is "To scan a single line of text, please hold your device so that the camera viewfinder clearly captures the text you want to scan. Please ensure the text is properly aligned. Once the scan is complete, the text will be automatically extracted.\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"
-
getTextPatternConfirmationAlertTitle
final String getTextPatternConfirmationAlertTitle()
Title for the text pattern confirmation alert.
Default is "Text Detected!"
-
setTextPatternConfirmationAlertTitle
final Unit setTextPatternConfirmationAlertTitle(String textPatternConfirmationAlertTitle)
Title for the text pattern confirmation alert.
Default is "Text Detected!"
-
getTextPatternConfirmationAlertCancelButton
final String getTextPatternConfirmationAlertCancelButton()
Cancel button text for the text pattern confirmation alert.
Default is "Retry"
-
setTextPatternConfirmationAlertCancelButton
final Unit setTextPatternConfirmationAlertCancelButton(String textPatternConfirmationAlertCancelButton)
Cancel button text for the text pattern confirmation alert.
Default is "Retry"
-
getTextPatternConfirmationAlertSubmitButton
final String getTextPatternConfirmationAlertSubmitButton()
Submit button text for the text pattern confirmation alert.
Default is "Submit"
-
setTextPatternConfirmationAlertSubmitButton
final Unit setTextPatternConfirmationAlertSubmitButton(String textPatternConfirmationAlertSubmitButton)
Submit button text for the text pattern confirmation alert.
Default is "Submit"
-
getAccessibilityDescriptionConfirmationCancelButton
final String getAccessibilityDescriptionConfirmationCancelButton()
Accessibility description for the cancel button in the text pattern confirmation alert.
Default is "Retry"
-
setAccessibilityDescriptionConfirmationCancelButton
final Unit setAccessibilityDescriptionConfirmationCancelButton(String accessibilityDescriptionConfirmationCancelButton)
Accessibility description for the cancel button in the text pattern confirmation alert.
Default is "Retry"
-
getAccessibilityDescriptionConfirmationSubmitButton
final String getAccessibilityDescriptionConfirmationSubmitButton()
Accessibility description for the submit button in the text pattern confirmation alert.
Default is "Submit"
-
setAccessibilityDescriptionConfirmationSubmitButton
final Unit setAccessibilityDescriptionConfirmationSubmitButton(String accessibilityDescriptionConfirmationSubmitButton)
Accessibility description for the submit button in the text pattern confirmation alert.
Default is "Submit"
-
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 TextPatternScannerScreenTextLocalization clone()
-
default
final static TextPatternScannerScreenTextLocalization default()
-
-
-
-