Custom Text Builder

Defined in package com.scandit.datacapture.label.capture

CustomTextBuilder

class CustomTextBuilder : TextFieldBuilder

Added in version 6.21.0

Builder class for creating CustomText field definitions. Provides a fluent interface for configuring text field properties including validation regexes, location constraints, and OCR-specific settings.

location

var location: LabelFieldLocation?

Added in version 6.21.0

setLocation(location)

fun setLocation(location: LabelFieldLocation): CustomTextBuilder

Added in version 6.21.0

setLocation(location)

fun setLocation(location: RectF): CustomTextBuilder

Added in version 6.21.0

setLocation(left, top, right, bottom)

fun setLocation(left: Float,
        top: Float,
        right: Float,
        bottom: Float): CustomTextBuilder

Added in version 6.21.0

setLocation(location)

fun setLocation(location: Rect): CustomTextBuilder

Added in version 6.21.0

setAnchorRegexes(anchorRegexes)

fun setAnchorRegexes(anchorRegexes: String): CustomTextBuilder

Added in version 8.0.0

Used to specify keywords or phrases that help identify the context of the field. This is particularly useful when the label contains multiple fields that could match the same regex (e.g., when both packaging and expiry dates are present).

setAnchorRegexes(anchorRegexes)

fun setAnchorRegexes(anchorRegexes: Iterable<String>): CustomTextBuilder

Added in version 8.0.0

Used to specify keywords or phrases that help identify the context of the field. This is particularly useful when the label contains multiple fields that could match the same regex (e.g., when both packaging and expiry dates are present).

setAnchorRegex(anchorRegex)

fun setAnchorRegex(anchorRegex: Regex): CustomTextBuilder

Added in version 8.0.0

Used to specify keywords or phrases that help identify the context of the field. This is particularly useful when the label contains multiple fields that could match the same regex (e.g., when both packaging and expiry dates are present).

resetAnchorRegexes()

fun resetAnchorRegexes(): CustomTextBuilder

Added in version 8.0.0

This method can be used to remove the default anchorRegex, allowing you to rely solely on the valueRegexes for detection.

build(name)

fun build(name: String): CustomText

Added in version 6.21.0

Creates a CustomText field definition with the specified name and all configured properties.

getThis()

fun getThis(): CustomTextBuilder

Added in version 6.21.0

Returns this builder instance for method chaining.