Label Capture Validation Flow Overlay

Defined in package com.scandit.datacapture.label.ui.overlay.validation

LabelCaptureValidationFlowOverlay

class LabelCaptureValidationFlowOverlay : FrameLayout

Added in version 7.3.0

Overlay for label capture that displays a user interface designed to facilitate the validation of a label capture process. It also allows the capture of several label fields in several scans, which are later aggregated to for a complete scanned label which is reported back through the LabelCaptureValidationFlowListener. Note that this overlay offers no barcode or field highlighting. If this is needed, another overlay (like LabelCaptureBasicOverlay) should be user alongside this one.

newInstance(context, mode, view)

static @NonNull LabelCaptureValidationFlowOverlay newInstance(@NonNull Context context,
        LabelCapture mode,
        @Nullable DataCaptureView view)

Added in version 7.3.0

Constructs a new overlay to visualize the label capture validation flow. When view is non-null, the overlay is automatically added to the view. Otherwise, the overlay needs to be added through a call to DataCaptureView.addOverlay().

applySettings(settings)

void applySettings(@NonNull LabelCaptureValidationFlowSettings settings)

Added in version 7.3.0

Applies the new settings to the validation flow overlay.

onResume()

void onResume()

Added in version 7.3.0

Notifies the overlay that the container has resumed.

This method should be called in a Fragment or Activity’s onResume method to allow starting the scanning process or to restore a state previously paused by onPause().

onPause()

void onPause()

Added in version 7.3.0

Notifies the overlay that the container has paused.

This method should be called in a Fragment or Activity’s onPause method to pause the scanning flow. The scan state will then be restored when onResume() in called.

listener

@NonNull LabelCaptureValidationFlowListener getListener()
void setListener(@NonNull LabelCaptureValidationFlowListener value)

Added in version 7.3.0

Sets the listener to this overlay instance to observe the label capture mode and get notified when a label has been validated and accepted by the end user.