Label Field Definition Builder
Defined in package com.scandit.datacapture.label.capture
- LabelFieldDefinitionBuilder
class LabelFieldDefinitionBuilder<BuilderType, FieldType>
Added in version 6.21.0
Generic base class for field definition builders. Provides common functionality for configuring field properties such as regexes, optional status, and hidden properties.
- isOptional
var isOptional:
BooleanAdded in version 6.21.0
Whether the field is optional or mandatory. This is helpful when certain fields may not be present on every scan.
- valueRegexes
var valueRegexes: Iterable<String>
Added in version 8.0.0
The regexes used for content validation of this field.
- isOptional(optional)
fun isOptional(optional:
Boolean):BuilderTypeAdded in version 6.21.0
Sets whether the field is optional or mandatory.
- numberOfMandatoryInstances
var numberOfMandatoryInstances: Int?
Added in version 7.6.0
The minimum number of instances of this field that must be captured for the label to be considered complete. This is useful for fields that may appear multiple times on a label, such as multiple serial numbers or repeated information.
- setNumberOfMandatoryInstances(numberOfMandatoryInstances)
fun setNumberOfMandatoryInstances(numberOfMandatoryInstances: Int?):
BuilderTypeAdded in version 7.6.0
The minimum number of instances of this field that must be captured for the label to be considered complete. This is useful for fields that may appear multiple times on a label, such as multiple serial numbers or repeated information.
- setValueRegexes(valueRegexes)
fun setValueRegexes(valueRegexes: String):
BuilderTypeAdded in version 8.0.0
Sets the regexes used for content validation from a single string.
- setValueRegexes(valueRegexes)
fun setValueRegexes(valueRegexes: Iterable<String>):
BuilderTypeAdded in version 8.0.0
Sets the regexes used for content validation from a collection of strings.
- setValueRegex(valueRegex)
fun setValueRegex(valueRegex: String):
BuilderTypeAdded in version 8.0.0
Sets a single regex for content validation.
- setValueRegex(valueRegex)
fun setValueRegex(valueRegex: Regex):
BuilderTypeAdded in version 8.0.0
Sets a regular expression for content validation.
- setHiddenProperty(key, value)
fun setHiddenProperty(key: String, value: Any):
BuilderTypeAdded in version 6.21.0
- setHiddenProperties(hiddenProperties)
fun setHiddenProperties(hiddenProperties: Map<String, Any>):
BuilderTypeAdded in version 6.21.0
- build(name)
fun build(name: String):
FieldTypeAdded in version 6.21.0
Creates a field definition with the specified name and all configured properties.
- buildFluent(name)
fun buildFluent(name: String): LabelDefinitionBuilder
Added in version 6.21.0
Creates a field definition and returns a label definition builder for method chaining.