Barcode Sequence View

Defined in package com.scandit.datacapture.barcode.sequence.ui

BarcodeSequenceViewUIListener

interface BarcodeSequenceViewUIListener

Added in version 8.0.0

onNextButtonTapped(barcodeSequenceView, sequencedShelfModule)

void onNextButtonTapped(@NonNull BarcodeSequenceView barcodeSequenceView,
        @Nullable SequencedShelfModule sequencedShelfModule)

Added in version 8.0.0

Callback method that is called when the next button is tapped in the view with the sequenced shelf module. Module may be null.

onViewListButtonTapped(barcodeSequenceView, sequencedShelfModule)

void onViewListButtonTapped(@NonNull BarcodeSequenceView barcodeSequenceView,
        @Nullable SequencedShelfModule sequencedShelfModule)

Added in version 8.0.0

Callback method that is called when the view list button is tapped in the view with the sequenced shelf module. Module may be null.

BarcodeSequenceView

class BarcodeSequenceView : FrameLayout

Added in version 8.0.0

Barcode Sequence comes with a ready-to-use UI that allows highlighting barcodes and trays and building a shelf module. The BarcodeSequenceView integrates with any app in just a few lines of code.

BarcodeSequenceView()

BarcodeSequenceView(@NonNull ViewGroup parentView,
        @NonNull BarcodeSequence barcodeSequence,
        @NonNull DataCaptureContext dataCaptureContext,
        @NonNull BarcodeSequenceViewSettings settings,
        @Nullable CameraSettings cameraSettings)

Added in version 8.0.0

Creates a new BarcodeSequenceView with the provided mode, view settings, camera settings.

BarcodeSequenceView()

BarcodeSequenceView(@NonNull ViewGroup parentView,
        @NonNull BarcodeSequence barcodeSequence,
        @NonNull DataCaptureContext dataCaptureContext,
        @NonNull BarcodeSequenceViewSettings settings)

Added in version 8.0.0

Creates a new BarcodeSequenceView with the provided mode, view settings, and default camera settings from BarcodeSequence.createRecommendedCameraSettings().

uiListener

@Nullable BarcodeSequenceViewUIListener getUiListener()
void setUiListener(@Nullable BarcodeSequenceViewUIListener value)

Added in version 8.0.0

Sets the listener which is called whenever buttons are tapped in the view.

shouldShowTorchControl

boolean getShouldShowTorchControl()
void setShouldShowTorchControl(boolean value)

Added in version 8.0.0

Indicates whether the torch control button should be shown.

Default is true.

torchControlPosition

Anchor getTorchControlPosition()
void setTorchControlPosition(Anchor value)

Added in version 8.0.0

Updates the position of the torch control button.

Default is Anchor.TOP_LEFT.

initialGuidanceTitleText

@NonNull String getInitialGuidanceTitleText()
void setInitialGuidanceTitleText(@NonNull String value)

Added in version 8.0.0

The title text for the initial guidance tutorial dialog.

Default is “Scan all codes in a shelf”.

initialGuidanceDescriptionText

@NonNull String getInitialGuidanceDescriptionText()
void setInitialGuidanceDescriptionText(@NonNull String value)

Added in version 8.0.0

The description text for the initial guidance tutorial dialog.

Default is “For best results, use landscape mode and scan each row from left to right pausing in between rows.”.

initialGuidanceButtonText

@NonNull String getInitialGuidanceButtonText()
void setInitialGuidanceButtonText(@NonNull String value)

Added in version 8.0.0

The button text for the initial guidance tutorial dialog.

Default is “OK”.

rotateDeviceToCaptureText

@NonNull String getRotateDeviceToCaptureText()
void setRotateDeviceToCaptureText(@NonNull String value)

Added in version 8.0.0

The text displayed in the rotation prompt when the device needs to be rotated to landscape mode for sequencing.

Default is “Rotate to landscape to capture”.

pointShelfToCaptureText

@NonNull String getPointShelfToCaptureText()
void setPointShelfToCaptureText(@NonNull String value)

Added in version 8.1.0

The text displayed in the rotation prompt when the device is not facing the shelf and needs to be rotated towards it for sequencing.

Default is “Point the shelf to capture”.

shouldShowViewListButton

boolean getShouldShowViewListButton()
void setShouldShowViewListButton(boolean value)

Added in version 8.0.0

Whether the View List button is shown.

Default is true.

shouldShowNextButton

boolean getShouldShowNextButton()
void setShouldShowNextButton(boolean value)

Added in version 8.0.0

Whether the Next button is shown.

Default is true.

shouldShowRedoButton

boolean getShouldShowRedoButton()
void setShouldShowRedoButton(boolean value)

Added in version 8.0.0

Whether the Redo button is shown.

Default is true.

nextButtonText

@NonNull String getNextButtonText()
void setNextButtonText(@NonNull String value)

Added in version 8.0.0

The text for the Next button.

Default is “Next”.

redoButtonText

@NonNull String getRedoButtonText()
void setRedoButtonText(@NonNull String value)

Added in version 8.0.0

The text for the Redo button.

Default is “Redo”.

viewListButtonText

@NonNull String getViewListButtonText()
void setViewListButtonText(@NonNull String value)

Added in version 8.0.0

The text for the View List button.

Default is “View List”.

redoShelfDialogTitleText

@NonNull String getRedoShelfDialogTitleText()
void setRedoShelfDialogTitleText(@NonNull String value)

Added in version 8.0.0

The title text for the redo confirmation dialog.

Default is “Redo Shelf”.

redoShelfDialogDescriptionText

@NonNull String getRedoShelfDialogDescriptionText()
void setRedoShelfDialogDescriptionText(@NonNull String value)

Added in version 8.0.0

The description text for the redo confirmation dialog.

Default is “Your current capture will be cleared. Do you want to start a new capture?”.

redoShelfDialogAcceptButtonText

@NonNull String getRedoShelfDialogAcceptButtonText()
void setRedoShelfDialogAcceptButtonText(@NonNull String value)

Added in version 8.0.0

The accept button text for the redo confirmation dialog.

Default is “Redo”.

redoShelfDialogCancelButtonText

@NonNull String getRedoShelfDialogCancelButtonText()
void setRedoShelfDialogCancelButtonText(@NonNull String value)

Added in version 8.0.0

The cancel button text for the redo confirmation dialog.

Default is “Cancel”.

removeBarcodeButtonText

@NonNull String getRemoveBarcodeButtonText()
void setRemoveBarcodeButtonText(@NonNull String value)

Added in version 8.0.0

The text for the remove barcode button in popover annotation.

Default is “Remove”.

addBarcodeButtonText

@NonNull String getAddBarcodeButtonText()
void setAddBarcodeButtonText(@NonNull String value)

Added in version 8.0.0

The text for the add barcode button in popover annotation.

Default is “Add”.

onResume()

void onResume()

Added in version 8.0.0

Function to call on Fragment/Activity onResume callback. This will set the BarcodeSequenceView’s lifecycle state to Resumed. Scanning only happens when the BarcodeSequenceView is in Resumed state. You have to call this for the correct functioning of the BarcodeSequenceView.

override fun onResume() {
  super.onResume()
  barcodeSequenceView.onResume()
}

onPause()

void onPause()

Added in version 8.0.0

Function to call on Fragment/Activity onPause callback. This will set the BarcodeSequenceView’s lifecycle state to Paused. Scanning only happens when the BarcodeSequenceView is in Resumed state. You have to call this for the correct functioning of the BarcodeSequenceView.

override fun onPause() {
  super.onPause()
  barcodeSequenceView.onPause()
}

onDestroy()

void onDestroy()

Added in version 8.0.0

Function to call on Fragment/Activity onDestroyView callback. This will set the BarcodeSequenceView’s lifecycle state to Destroyed. Scanning only happens when the BarcodeSequenceView is in Resumed state. You have to call this for the correct functioning of the BarcodeSequenceView.

override fun onDestroyView() {
  super.onDestroyView()
  barcodeSequenceView.onDestroy()
}

reset()

void reset()

Added in version 8.0.0

Clears UI state and resets the view.