Package com.microblink.photopay.uisettings

Class FieldByFieldUISettings

java.lang.Object
com.microblink.photopay.uisettings.UISettings<FieldByFieldOverlayController>
com.microblink.photopay.uisettings.FieldByFieldUISettings
All Implemented Interfaces:
CurrentImageListenerUIOptions, DebugImageListenerUIOptions, HelpIntentUIOptions, OcrResultDisplayUIOptions, SplashScreenUIOptions, SuccessfulImageListenerUIOptions
public class FieldByFieldUISettings extends UISettings<FieldByFieldOverlayController> implements HelpIntentUIOptions, OcrResultDisplayUIOptions, DebugImageListenerUIOptions, CurrentImageListenerUIOptions, SuccessfulImageListenerUIOptions, SplashScreenUIOptions
Scan settings for FieldByFieldScanActivity.

  • Constructor Details

    • FieldByFieldUISettings

      public FieldByFieldUISettings(@NonNull FieldByFieldBundle fieldByFieldBundle)

    • FieldByFieldUISettings

      public FieldByFieldUISettings(@NonNull android.content.Intent intent)

  • Method Details

    • getFieldByFieldBundle

      @NonNull public FieldByFieldBundle getFieldByFieldBundle()
      Returns the FieldByFieldBundle containing scan elements with parsers that will be used for processing.
      Returns:
      the FieldByFieldBundle containing scan elements with parsers that will be used for processing.

    • setHelpIntent

      public void setHelpIntent(@Nullable android.content.Intent helpIntent)
      Description copied from interface: HelpIntentUIOptions
      Defines intent for help activity called when help should be shown. If not set or set to null, help button will not be shown in the scanning UI.
      Specified by:
      setHelpIntent in interface HelpIntentUIOptions
      Parameters:
      helpIntent - intent for help activity called when help should be shown.

    • saveToIntent

      public final void saveToIntent(@NonNull android.content.Intent intent)
      Description copied from class: UISettings
      Saves this scan activity settings to Intent so it can be passed to the corresponding scan activity. Intent target activity must be set before calling this method, and target activity must be compatible with this settings. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.
      Overrides:
      saveToIntent in class UISettings<FieldByFieldOverlayController>
      Parameters:
      intent - Intent to which this scan activity settings should be saved.

    • setInfiniteLoopScan

      public void setInfiniteLoopScan(boolean infiniteLoopScan)
      If set to true, scan activity will never return. Default is false.
      Parameters:
      infiniteLoopScan - whether to activate infinite loop mode or not.

    • setOcrResultDisplayMode

      public void setOcrResultDisplayMode(@Nullable OcrResultDisplayMode ocrResultDisplayMode)
      Description copied from interface: OcrResultDisplayUIOptions
      Defines mode in which OCR result will be drawn on camera preview.
      Specified by:
      setOcrResultDisplayMode in interface OcrResultDisplayUIOptions
      Parameters:
      ocrResultDisplayMode - mode in which OCR result will be drawn on camera preview.

    • setDebugImageListener

      public void setDebugImageListener(@Nullable DebugImageListener debugImageListener)
      Description copied from interface: DebugImageListenerUIOptions
      Sets implementation of DebugImageListener interface that will obtain images that are being processed. DebugImageListener will receive all possible debug images that become available during recognition process.
      Specified by:
      setDebugImageListener in interface DebugImageListenerUIOptions
      Parameters:
      debugImageListener - Implementation of debug image listener or null to clear listener that has been set previously.

    • setCurrentImageListener

      public void setCurrentImageListener(@Nullable CurrentImageListener currentImageListener)
      Description copied from interface: CurrentImageListenerUIOptions
      Sets implementation of CurrentImageListener interface that will obtain images that are currently being processed. CurrentImageListener will receive all possible images that become available during recognition process.
      Specified by:
      setCurrentImageListener in interface CurrentImageListenerUIOptions
      Parameters:
      currentImageListener - Implementation of image listener or null to clear listener that has been set previously.

    • setSuccessfulImageListener

      public void setSuccessfulImageListener(@Nullable SuccessfulImageListener successfulImageListener)
      Description copied from interface: SuccessfulImageListenerUIOptions
      Sets implementation of SuccessfulImageListener interface that will obtain images from the successful scan. SuccessfulImageListener will receive image when recognition process has successfully scanned an item and has a successful scan image to return.
      Specified by:
      setSuccessfulImageListener in interface SuccessfulImageListenerUIOptions
      Parameters:
      successfulImageListener - Implementation of image listener or null to clear listener that has been set previously.

    • setSplashScreenLayoutResourceID

      public final void setSplashScreenLayoutResourceID(@LayoutRes int splashScreenLayoutResourceID)
      Description copied from interface: SplashScreenUIOptions
      Defines the ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized. If not set, default splash screen will be used.
      Specified by:
      setSplashScreenLayoutResourceID in interface SplashScreenUIOptions
      Parameters:
      splashScreenLayoutResourceID - ID of the layout resource that will be used as camera splash screen displayed while camera is being initialized.

    • getTargetActivity

      @NonNull public Class<?> getTargetActivity()
      Description copied from class: UISettings
      Returns target activity. Concrete settings can be used only with the corresponding activity. This method is public for convenience when you are not able to use ActivityRunner. DO NOT USE THIS METHOD UNLESS YOU KNOW WHAT YOU ARE DOING. Improper usage will crash your app.
      Specified by:
      getTargetActivity in class UISettings<FieldByFieldOverlayController>
      Returns:
      target activity.

    • createOverlayController

      @NonNull public FieldByFieldOverlayController createOverlayController(@NonNull android.app.Activity activity, @NonNull ScanResultListener scanResultListener)
      Description copied from class: UISettings
      Creates overlay controller and configures it using set values.
      Specified by:
      createOverlayController in class UISettings<FieldByFieldOverlayController>