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()
@NonNull LabelDefinitionBuilder addLabel()

Added in version 6.21.0

Adds a new label definition to the settings.

addLabel(label)
@NonNull LabelCaptureSettingsBuilder addLabel(@NonNull LabelDefinition label)

Added in version 6.21.0

Adds a new label definition to the settings.

label(name, func)
void label(@NonNull String name,
        @NonNull Function1<@NonNull LabelDefinitionBuilder, @NonNull Unit> func)

Added in version 6.21.0

Adds a new label definition to the settings.

setHiddenProperty(key, value)
@NonNull LabelCaptureSettingsBuilder setHiddenProperty(
        @NonNull String key,
        @NonNull Object value)

Added in version 6.21.0

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

setHiddenProperties(hiddenProperties)
@NonNull LabelCaptureSettingsBuilder setHiddenProperties(
        @NonNull Map<@NonNull String, @NonNull Object> hiddenProperties)

Added in version 6.21.0

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

setLabelProperties(labelProperties)
@NonNull LabelCaptureSettingsBuilder setLabelProperties(
        @NonNull Object labelProperties)

Added in version 7.2.0

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

build()
@NonNull LabelCaptureSettings build()

Added in version 6.21.0

Builds the settings object.

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