Barcode Check Icon Annotation

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

BarcodeCheckInfoAnnotationWidthPreset

Added in version 7.1.0

The available width options for an info annotation.

SMALL

Added in version 7.1.0

Small width. Recommended for annotations that contain only text or icon, and do not include a header or footer.

MEDIUM

Added in version 7.1.0

Medium width.

LARGE

Added in version 7.1.0

Large width.

BarcodeCheckInfoAnnotationAnchor

Added in version 7.1.0

The available anchor options for an info annotation.

LEFT

Added in version 7.1.0

The annotation is anchored at its left edge.

RIGHT

Added in version 7.1.0

The annotation is anchored at its right edge.

BOTTOM

Added in version 7.1.0

The annotation is anchored at its bottom-center point.

TOP

Added in version 7.1.0

The annotation is anchored at its top-center point.

BarcodeCheckInfoAnnotationListener

interface BarcodeCheckInfoAnnotationListener

Added in version 7.1.0

The listener for the info annotation.

onInfoAnnotationHeaderTapped(annotation)

void onInfoAnnotationHeaderTapped(@NonNull BarcodeCheckInfoAnnotation annotation)

Added in version 7.1.0

Called when the annotation header is tapped. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

onInfoAnnotationFooterTapped(annotation)

void onInfoAnnotationFooterTapped(@NonNull BarcodeCheckInfoAnnotation annotation)

Added in version 7.1.0

Called when the annotation footer is tapped. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

onInfoAnnotationLeftIconTapped(annotation, component, componentIndex)

void onInfoAnnotationLeftIconTapped(@NonNull BarcodeCheckInfoAnnotation annotation,
        @NonNull BarcodeCheckInfoAnnotationBodyComponent component,
        int componentIndex)

Added in version 7.1.0

Called when the left icon of an annotation component is tapped. componentIndex specifies the index of the component containing the tapped icon within the BarcodeCheckInfoAnnotation.body array. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

onInfoAnnotationRightIconTapped(annotation, component, componentIndex)

void onInfoAnnotationRightIconTapped(@NonNull BarcodeCheckInfoAnnotation annotation,
        @NonNull BarcodeCheckInfoAnnotationBodyComponent component,
        int componentIndex)

Added in version 7.1.0

Called when the right icon of an annotation component is tapped. componentIndex specifies the index of the component containing the tapped icon within the BarcodeCheckInfoAnnotation.body array. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is false.

onInfoAnnotationTapped(annotation)

void onInfoAnnotationTapped(@NonNull BarcodeCheckInfoAnnotation annotation)

Added in version 7.1.0

Called when the annotation is tapped. Called only if BarcodeCheckInfoAnnotation.isEntireAnnotationTappable is true.

BarcodeCheckInfoAnnotation

class BarcodeCheckInfoAnnotation : BarcodeCheckAnnotation

Added in version 7.1.0

Info annotations are tooltips that display text and icons, structured as an array of body components. Each body component contains text and may include optional tappable icons on both the left and right sides.

In addition to the body components, info annotations can include an optional header, and footer. By default, they appear automatically when the corresponding barcode is scanned. Info annotations are available in three predefined widths, with their height dynamically adjusting to fit the content. Here are some examples:


Body component only.	Body component and header.	Body component with attributed text and tappable icon.

BarcodeCheckInfoAnnotation()

BarcodeCheckInfoAnnotation(@NonNull Context context,
        @NonNull Barcode barcode)

Added in version 7.1.0

Constructs a new instance with the given barcode.

barcode

@NonNull Barcode getBarcode()

Added in version 7.1.0

The barcode instance for the annotation.

hasTip

boolean getHasTip()
void setHasTip(boolean value)

Added in version 7.1.0

Whether the annotation has a tip. The default value is true.

isEntireAnnotationTappable

boolean isEntireAnnotationTappable()
void setEntireAnnotationTappable(boolean value)

Added in version 7.1.0

If false, each individual element within the annotation (header, footer, icons in body components) is tappable. If true, the entire annotation is tappable.

anchor

BarcodeCheckInfoAnnotationAnchor getAnchor()
void setAnchor(BarcodeCheckInfoAnnotationAnchor value)

Added in version 7.1.0

The annotation anchor. The default value is BarcodeCheckInfoAnnotationAnchor.BOTTOM.

annotationTrigger

BarcodeCheckAnnotationTrigger getAnnotationTrigger()
void setAnnotationTrigger(BarcodeCheckAnnotationTrigger value)

Added in version 7.1.0

The trigger that causes the annotation to be presented. By default is BarcodeCheckAnnotationTrigger.HIGHLIGHT_TAP_AND_BARCODE_SCAN.

width

BarcodeCheckInfoAnnotationWidthPreset getWidth()
void setWidth(BarcodeCheckInfoAnnotationWidthPreset value)

Added in version 7.1.0

The annotation width. The default value is BarcodeCheckInfoAnnotationWidthPreset.SMALL.

body

@NonNull List<@NonNull BarcodeCheckInfoAnnotationBodyComponent> getBody()
void setBody(@NonNull List<@NonNull BarcodeCheckInfoAnnotationBodyComponent> value)

Added in version 7.1.0

The annotation body, represented as an array of body components. The default value is [].

header

@Nullable BarcodeCheckInfoAnnotationHeader getHeader()
void setHeader(@Nullable BarcodeCheckInfoAnnotationHeader value)

Added in version 7.1.0

The annotation header. The default value is null.

footer

@Nullable BarcodeCheckInfoAnnotationFooter getFooter()
void setFooter(@Nullable BarcodeCheckInfoAnnotationFooter value)

Added in version 7.1.0

The annotation footer. The default value is null.

backgroundColor

int getBackgroundColor()
void setBackgroundColor(int value)

Added in version 7.1.0

The background color. The default value is #CCFFFFFF.

listener

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

Added in version 7.1.0

An object that receives notifications for UI-related events.