Barcode Sequence View

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

BarcodeSequenceViewUIListener

interface BarcodeSequenceViewUIListener

Added in version 8.0.0

onNextButtonTapped(barcodeSequenceView, sequencedShelfModule)

fun onNextButtonTapped(barcodeSequenceView: BarcodeSequenceView,
        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)

fun onViewListButtonTapped(barcodeSequenceView: BarcodeSequenceView,
        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.

Note

Orientation Handling

Barcode Sequence is designed to work only in landscape orientation. To prevent loss of barcode tracking during device rotation, you can lock the screen orientation to landscape.

If you need to support rotation and want to prevent tracking loss, you can use android:configChanges="screenSize|orientation" to prevent the Activity from being recreated.

BarcodeSequenceView()

BarcodeSequenceView(parentView: ViewGroup,
        barcodeSequence: BarcodeSequence,
        dataCaptureContext: DataCaptureContext,
        settings: BarcodeSequenceViewSettings,
        cameraSettings: CameraSettings?)

Added in version 8.0.0

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

BarcodeSequenceView()

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

Added in version 8.0.0

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

uiListener

var uiListener: BarcodeSequenceViewUIListener?

Added in version 8.0.0

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

shouldShowTorchControl

var shouldShowTorchControl: Boolean

Added in version 8.0.0

Indicates whether the torch control button should be shown.

Default is true.

torchControlPosition

var torchControlPosition: Anchor

Added in version 8.0.0

Updates the position of the torch control button.

Default is Anchor.TOP_LEFT.

initialGuidanceTitleText

var initialGuidanceTitleText: String

Added in version 8.0.0

The title text for the initial guidance tutorial dialog.

Default is “Scan all codes in a shelf”.

initialGuidanceDescriptionText

var initialGuidanceDescriptionText: String

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

var initialGuidanceButtonText: String

Added in version 8.0.0

The button text for the initial guidance tutorial dialog.

Default is “OK”.

rotateDeviceToCaptureText

var rotateDeviceToCaptureText: String

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

var pointShelfToCaptureText: String

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

var shouldShowViewListButton: Boolean

Added in version 8.0.0

Whether the View List button is shown.

Default is true.

shouldShowNextButton

var shouldShowNextButton: Boolean

Added in version 8.0.0

Whether the Next button is shown.

Default is true.

shouldShowRedoButton

var shouldShowRedoButton: Boolean

Added in version 8.0.0

Whether the Redo button is shown.

Default is true.

nextButtonText

var nextButtonText: String

Added in version 8.0.0

The text for the Next button.

Default is “Next”.

redoButtonText

var redoButtonText: String

Added in version 8.0.0

The text for the Redo button.

Default is “Redo”.

viewListButtonText

var viewListButtonText: String

Added in version 8.0.0

The text for the View List button.

Default is “View List”.

redoShelfDialogTitleText

var redoShelfDialogTitleText: String

Added in version 8.0.0

The title text for the redo confirmation dialog.

Default is “Redo Shelf”.

redoShelfDialogDescriptionText

var redoShelfDialogDescriptionText: String

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

var redoShelfDialogAcceptButtonText: String

Added in version 8.0.0

The accept button text for the redo confirmation dialog.

Default is “Redo”.

redoShelfDialogCancelButtonText

var redoShelfDialogCancelButtonText: String

Added in version 8.0.0

The cancel button text for the redo confirmation dialog.

Default is “Cancel”.

removeBarcodeButtonText

var removeBarcodeButtonText: String

Added in version 8.0.0

The text for the remove barcode button in popover annotation.

Default is “Remove”.

addBarcodeButtonText

var addBarcodeButtonText: String

Added in version 8.0.0

The text for the add barcode button in popover annotation.

Default is “Add”.

onResume()

fun 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()

fun 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()

fun 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()

fun reset()

Added in version 8.0.0

Clears UI state and resets the view.