Note

This API is still in beta and may change in future versions of Scandit Data Capture SDK.

Text Definition

Defined in package com.scandit.datacapture.usi.capture.component.text

TextDefinition

class TextDefinition : ScanComponentDefinition

Added in version 8.0.0

A class that holds the definition for a text expected to be scanned as part of a certain ScanItemDefinition.

TextDefinition()

TextDefinition(@NonNull TextIdentifier identifier)

Added in version 8.0.0

A constructor that receives the identifier for the text definition.

identifier

@NonNull TextIdentifier getIdentifier()

Added in version 8.0.0

The unique identifier for this component.

location

@Nullable Quadrilateral getLocation()
void setLocation(@Nullable Quadrilateral value)

Added in version 8.0.0

The expected location of the text.

optional

boolean getOptional()
void setOptional(boolean value)

Added in version 8.0.0

Whether the text is optional.

semantics

ScanComponentTextSemanticType getSemantics()
void setSemantics(ScanComponentTextSemanticType value)

Added in version 8.0.0

A semantic type to be applied to the text definition.

hiddenProperties

@NonNull String getHiddenProperties()
void setHiddenProperties(@NonNull String value)

Added in version 8.0.0

A list of hidden properties to set on the text definition.

valueRegexes

@NonNull List<@NonNull String> getValueRegexes()
void setValueRegexes(@NonNull List<@NonNull String> value)

Added in version 8.0.0

A list of value regex to use when searching for the text.

anchorRegexes

@NonNull List<@NonNull String> getAnchorRegexes()
void setAnchorRegexes(@NonNull List<@NonNull String> value)

Added in version 8.0.0

A list of anchor regexes to use when searching for the text.

builder(identifier)

static @NonNull TextDefinitionBuilder builder(@NonNull TextIdentifier identifier)

Added in version 8.0.0

Creates a builder object that can be used to fluently create a TextDefinition instance.