EncodeHintType enum

These are a set of hints that you may pass to Writers to specify their behavior.

@author dswitkin@google.com (Daniel Switkin)

Inheritance

Constructors

EncodeHintType()
const

Values

ERROR_CORRECTION → const EncodeHintType

Specifies what degree of error correction to use, for example in QR Codes. Type depends on the encoder. For example for QR codes it's type {@link com.google.zxing.qrcode.decoder.ErrorCorrectionLevel ErrorCorrectionLevel}. For Aztec it is of type Integer, representing the minimal percentage of error correction words. For PDF417 it is of type Integer, valid values being 0 to 8. In all cases, it can also be a String representation of the desired value as well. Note: an Aztec symbol should have a minimum of 25% EC words.

CHARACTER_SET → const EncodeHintType

Specifies what character encoding to use where applicable (type String)

DATA_MATRIX_SHAPE → const EncodeHintType

Specifies the matrix shape for Data Matrix (type {@link com.google.zxing.datamatrix.encoder.SymbolShapeHint})

DATA_MATRIX_COMPACT → const EncodeHintType

Specifies whether to use compact mode for Data Matrix (type bool, or "true" or "false" String value) The compact encoding mode also supports the encoding of characters that are not in the ISO-8859-1 character set via ECIs. Please note that in that case, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the {@link #CHARACTER_SET} encoding hint. Compact encoding also provides GS1-FNC1 support when {@link #GS1_FORMAT} is selected. In this case group-separator character (ASCII 29 decimal) can be used to encode the positions of FNC1 codewords for the purpose of delimiting AIs. This option and FORCE_C40 are mutually exclusive.

MIN_SIZE → const EncodeHintType

Specifies a minimum barcode size (type Dimension). Only applicable to Data Matrix now.

@deprecated use width/height params in {@link com.google.zxing.datamatrix.DataMatrixWriter#encode(String, BarcodeFormat, int, int)}

MAX_SIZE → const EncodeHintType

Specifies a maximum barcode size (type Dimension). Only applicable to Data Matrix now.

@deprecated without replacement

MARGIN → const EncodeHintType

Specifies margin, in pixels, to use when generating the barcode. The meaning can vary by format; for example it controls margin before and after the barcode horizontally for most 1D formats. (Type Integer, or String representation of the integer value).

PDF417_COMPACT → const EncodeHintType

Specifies whether to use compact mode for PDF417 (type bool, or "true" or "false" String value).

PDF417_COMPACTION → const EncodeHintType

Specifies what compaction mode to use for PDF417 (type {@link com.google.zxing.pdf417.encoder.Compaction Compaction} or String value of one of its enum values).

PDF417_DIMENSIONS → const EncodeHintType

Specifies the minimum and maximum number of rows and columns for PDF417 (type {@link com.google.zxing.pdf417.encoder.Dimensions Dimensions}).

PDF417_AUTO_ECI → const EncodeHintType

Specifies whether to automatically insert ECIs when encoding PDF417 (type bool).

AZTEC_LAYERS → const EncodeHintType

Specifies the required number of layers for an Aztec code. A negative number (-1, -2, -3, -4) specifies a compact Aztec code. 0 indicates to use the minimum number of layers (the default). A positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code. (Type Integer, or String representation of the integer value).

QR_VERSION → const EncodeHintType

Specifies the exact version of QR code to be encoded. (Type Integer, or String representation of the integer value).

QR_MASK_PATTERN → const EncodeHintType

Specifies the QR code mask pattern to be used. Allowed values are 0..QRCode.NUM_MASK_PATTERNS-1. By default the code will automatically select the optimal mask pattern. (Type Integer, or String representation of the integer value).

QR_COMPACT → const EncodeHintType

Specifies whether to use compact mode for QR code (type bool, or "true" or "false" String value) Please note that when compaction is performed, the most compact character encoding is chosen for characters in the input that are not in the ISO-8859-1 character set. Based on experience, some scanners do not support encodings like cp-1256 (Arabic). In such cases the encoding can be forced to UTF-8 by means of the Encoding encoding hint.

GS1_FORMAT → const EncodeHintType

Specifies whether the data should be encoded to the GS1 standard (type bool, or "true" or "false" String value).

FORCE_CODE_SET → const EncodeHintType

Forces which encoding will be used. Currently only used for Code-128 code sets (Type String). Valid values are "A", "B", "C". This option and CODE128_COMPACT are mutually exclusive.

FORCE_C40 → const EncodeHintType

Forces C40 encoding for data-matrix (type bool, or "true" or "false" String value). This option and DATA_MATRIX_COMPACT are mutually exclusive.

CODE128_COMPACT → const EncodeHintType

Specifies whether to use compact mode for Code-128 code (type bool, or "true" or "false" String value) This can yield slightly smaller bar codes. This option and FORCE_CODE_SET are mutually exclusive.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<EncodeHintType>
A constant List of the values in this enum, in order of their declaration.