public class DotCode extends PropertyGroup
DotCode is the class that configures the Dot Code.| Modifier and Type | Field and Description |
|---|---|
EnumProperty<CharacterSetMode> |
characterSetMode
characterSetMode controls the character set in use for the decoded label. |
BooleanProperty |
enable
enable enables or disables the symbology. |
NumericProperty |
Length1
Length1 is one of the two configurable label lengths. |
NumericProperty |
Length2
Length2 is one of the two configurable label lengths. |
EnumProperty<LengthControlMode> |
lengthMode
lengthMode is the LengthControlMode selected for a label. |
CharacterProperty |
userID
userID specifies the symbology identifier (if any).The symbology identifier is sent with the label when the global decode property Formatting.sendCodeId is set to
SendCodeID.USERDEFINED_IDENTIFIER_BEFORE_LABEL or SendCodeID.USERDEFINED_IDENTIFIER_AFTER_LABEL. |
| Constructor and Description |
|---|
DotCode(PropertyGetter editor)
This is the constructor of DotCode.
|
getGroups, getId, getName, getProperties, getPropertyById, getPropertyByName, getPropertyGroupById, getPropertyGroupByName, isFullySupported, isSupported, load, setToDefault, storepublic EnumProperty<CharacterSetMode> characterSetMode
characterSetMode controls the character set in use for the decoded label.public NumericProperty Length1
Length1 is one of the two configurable label lengths. It can be used
as a single fixed accepted length, when lengthMode is set to LengthControlMode.ONE_FIXED.
When LengthControlMode.TWO_FIXED is enabled, its value is one of the two possible accepted fixed lengths for a specific label.
It can also represent the minor or major length value whenever LengthControlMode.RANGE is selected.
If is set below the accepted minimum, the smallest accepted length will be used; instead it the set value exceed the maximum value, the
biggest accepted length will be used.
Note: Length1 allowed range of values is somehow related to the nature of the barcode (linear vs 2D) but it's not intended to document
in any way the scanner capabilities. An accepted minimum value and an accepted maximum value are introduced only to simplify length management in the
device Scanner settings app. The chance to read a barcode depends on it's printed quality, resolution, overall size, distance from the reader,
environmental light, etc...
LengthControlModepublic NumericProperty Length2
Length2 is one of the two configurable label lengths.
When LengthControlMode.TWO_FIXED is enabled, its value is one of the two possible accepted fixed lengths for a specific label.
It can also represent the minor or major length value whenever LengthControlMode.RANGE is selected.
If is set below the accepted minimum, the smallest accepted length will be used; instead it the set value exceed the maximum value, the
biggest accepted length will be used.
Note: Length2 allowed range of values is somehow related to the nature of the barcode (linear vs 2D) but it's not intended to document
in any way the scanner capabilities. An accepted minimum value and an accepted maximum value are introduced only to simplify length management in the
device Scanner settings app. The chance to read a barcode depends on it's printed quality, resolution, overall size, distance from the reader,
environmental light, etc...
LengthControlModepublic EnumProperty<LengthControlMode> lengthMode
lengthMode is the LengthControlMode selected for a label.
Selects the length control mode.LengthControlModepublic BooleanProperty enable
enable enables or disables the symbology.public CharacterProperty userID
userID specifies the symbology identifier (if any).Formatting.sendCodeId is set to
SendCodeID.USERDEFINED_IDENTIFIER_BEFORE_LABEL or SendCodeID.USERDEFINED_IDENTIFIER_AFTER_LABEL.public DotCode(PropertyGetter editor)
editor - A PropertyGetter used to load the current barcode family.