public class TextDataScannerStep
Defines a single step of the data scanning flow
public static long SIGNIFICANT_DELAY_DEFAULT
public static float DEFAULT_FINDER_HEIGHT
public static io.scanbot.sdk.ui.view.generictext.entity.TextDataScannerStep.Companion Companion
public TextDataScannerStep(@NotNull
java.lang.String stepTag,
@NotNull
java.lang.String title,
@NotNull
java.lang.String guidanceText,
@Nullable
java.lang.String pattern,
boolean shouldMatchSubstring,
@Nullable
io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback validationCallback,
@Nullable
io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback cleanRecognitionResultCallback,
float preferredZoom,
@NotNull
io.scanbot.sdk.ui.camera.FinderAspectRatio aspectRatio,
float unzoomedFinderHeight,
@NotNull
java.util.Set<java.lang.Character> allowedSymbols,
@NotNull
io.scanbot.sdk.generictext.TextFilterStrategy textFilterStrategy,
long significantShakeDelay)
Defines a single step of the data scanning flow
stepTag - The tag of the scanning step to make. It will be indicated in the resulttitle - Title for a valueguidanceText - User guidance for the steppattern - Sets a validation pattern (Supports ? - any character, # - any digit,all other characters represent themselves). Empty string or null will disable the validation)shouldMatchSubstring - Find and match only part of the whole string if the pattern is usedvalidationCallback - Callback for text validationcleanRecognitionResultCallback - Callback to clean recognized string prior to validation.preferredZoom - Digital zoom level required for this stepaspectRatio - Aspect ratio for the stepunzoomedFinderHeight - Default height of the finder (for zoom-level 1.0)allowedSymbols - Allowed symbols to be detectedtextFilterStrategy - Additional parameter to set the type of the scanned object. @see TextFilterStrategy. Default is TextFilterStrategy.DocumentsignificantShakeDelay - Detection will be paused after significant movement-1 is default valueDefault = 0 for TextFilterStrategy.Document or 1000 for TextFilterStrategy.LcdDotMatrixDisplay@NotNull public java.lang.String getStepTag()
The tag of the scanning step to make.
It will be indicated in the result
@NotNull public java.lang.String getTitle()
Title for a value
@NotNull public java.lang.String getGuidanceText()
User guidance for the step
@Nullable public java.lang.String getPattern()
Sets a validation pattern
(Supports ? - any character, # - any digit,all other characters represent themselves). Empty string or null will disable the validation)
public boolean getShouldMatchSubstring()
Find and match only part of the whole string if the pattern is used
@Nullable public io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback getValidationCallback()
Callback for text validation
@Nullable public io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback getCleanRecognitionResultCallback()
Callback to clean recognized string prior to validation.
public float getPreferredZoom()
Digital zoom level required for this step
@NotNull public io.scanbot.sdk.ui.camera.FinderAspectRatio getAspectRatio()
Aspect ratio for the step
public float getUnzoomedFinderHeight()
Default height of the finder
(for zoom-level 1.0)
@NotNull public java.util.Set<java.lang.Character> getAllowedSymbols()
Allowed symbols to be detected
@NotNull public io.scanbot.sdk.generictext.TextFilterStrategy getTextFilterStrategy()
Additional parameter to set the type of the scanned object.
@see TextFilterStrategy. Default is TextFilterStrategy.Document
public long getSignificantShakeDelay()
Detection will be paused after significant movement
-1 is default valueDefault = 0 for TextFilterStrategy.Document or 1000 for TextFilterStrategy.LcdDotMatrixDisplay
@NotNull public java.lang.String component1()
The tag of the scanning step to make.
It will be indicated in the result
@NotNull public java.lang.String component2()
Title for a value
@NotNull public java.lang.String component3()
User guidance for the step
@Nullable public java.lang.String component4()
Sets a validation pattern
(Supports ? - any character, # - any digit,all other characters represent themselves). Empty string or null will disable the validation)
public boolean component5()
Find and match only part of the whole string if the pattern is used
@Nullable public io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback component6()
Callback for text validation
@Nullable public io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback component7()
Callback to clean recognized string prior to validation.
public float component8()
Digital zoom level required for this step
@NotNull public io.scanbot.sdk.ui.camera.FinderAspectRatio component9()
Aspect ratio for the step
public float component10()
Default height of the finder
(for zoom-level 1.0)
@NotNull public java.util.Set<java.lang.Character> component11()
Allowed symbols to be detected
@NotNull public io.scanbot.sdk.generictext.TextFilterStrategy component12()
Additional parameter to set the type of the scanned object.
@see TextFilterStrategy. Default is TextFilterStrategy.Document
public long component13()
Detection will be paused after significant movement
-1 is default valueDefault = 0 for TextFilterStrategy.Document or 1000 for TextFilterStrategy.LcdDotMatrixDisplay
@NotNull public TextDataScannerStep copy(@NotNull java.lang.String stepTag, @NotNull java.lang.String title, @NotNull java.lang.String guidanceText, @Nullable java.lang.String pattern, boolean shouldMatchSubstring, @Nullable io.scanbot.sdk.generictext.GenericTextRecognizer.GenericTextValidationCallback validationCallback, @Nullable io.scanbot.sdk.generictext.GenericTextRecognizer.CleanRecognitionResultCallback cleanRecognitionResultCallback, float preferredZoom, @NotNull io.scanbot.sdk.ui.camera.FinderAspectRatio aspectRatio, float unzoomedFinderHeight, @NotNull java.util.Set<java.lang.Character> allowedSymbols, @NotNull io.scanbot.sdk.generictext.TextFilterStrategy textFilterStrategy, long significantShakeDelay)
Defines a single step of the data scanning flow
@NotNull public java.lang.String toString()
public int hashCode()
public boolean equals(@Nullable
java.lang.Object p)