Label Capture Settings Builder

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

LabelCaptureSettingsBuilder

class LabelCaptureSettingsBuilder

Added in version 6.21.0

Builder class for creating LabelCaptureSettings objects. Provides a fluent interface for configuring label capture settings including label definitions, hidden properties, and other settings.

addLabel()

fun addLabel(): LabelDefinitionBuilder

Added in version 6.21.0

Adds a new label definition to the settings.

addLabel(label)

fun addLabel(label: LabelDefinition): LabelCaptureSettingsBuilder

Added in version 6.21.0

Adds a new label definition to the settings.

label(name, func)

fun label(name: String,
        func: LabelDefinitionBuilder.() -> Unit)

Added in version 6.21.0

Adds a new label definition to the settings.

setHiddenProperty(key, value)

fun setHiddenProperty(key: String,
        value: Any): LabelCaptureSettingsBuilder

Added in version 6.21.0

Sets a hidden property to be used when creating the LabelCaptureSettings object.

setHiddenProperties(hiddenProperties)

fun setHiddenProperties(hiddenProperties: Map<String, Any>): LabelCaptureSettingsBuilder

Added in version 6.21.0

Sets hidden properties to be used when creating the LabelCaptureSettings object.

setLabelProperties(labelProperties)

fun setLabelProperties(labelProperties: Any): LabelCaptureSettingsBuilder

Added in version 7.2.0

Set label properties to be used when creating the LabelCaptureSettings object.

build()

fun build(): LabelCaptureSettings

Added in version 6.21.0

Builds the settings object.

Builds the settings object. If mutually incompatible settings are used, an IllegalStateException is thrown.