QREncodeMode (Aspose.Barcode)

java.lang.Object
- java.lang.Enum<QREncodeMode>
- - com.aspose.barcode.generation.QREncodeMode

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<QREncodeMode>

public enum QREncodeMode
extends java.lang.Enum<QREncodeMode>

Encoding mode for QR barcodes. These samples show how to encode and save QR barcode with extended data formats.

{@code
 //This sample shows how to use ECI encoding and save a BarCode image.
 
 BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
 generator.setCodeText("12345TEXT");
 generator.getParameters().getBarcode().getQR().setEncodeMode(QREncodeMode.ECI_ENCODING);
 generator.getParameters().getBarcode().getQR().setQrECIEncoding(ECIEncodings.UTF8);
 generator.save("test.png");
 
 //This sample shows how to use FNC1 first position in Extended Mode.
 Extended Channel mode which supports FNC1 first position, FNC1 second position and multi ECI modes.
 It is better to use QrExtCodetextBuilder for extended codetext generation.
 Use Display2DText property to set visible text by removing managing characters.
 Encoding Principles:
 All symbols "\" must be doubled "\\" in the codetext.
 FNC1 in first position is set in codetext as "<FNC1>".
 FNC1 in second position is set in codetext as "<FNC1(value)>". The value must be a single character from a-z or A-Z, or a two-digit number from 00 to 99.
 Group Separator for FNC1 modes is set as 0x1D character ''.
 If you need to insert "<FNC1>" string into barcode write it as "<\FNC1>".
 ECI identifiers are set as single slash and six digits identifier, for example "\000026" for UTF8 ECI identifier.
 The default ECI mode is ISO/IEC 8859-1 ECI identifier "\000003". It does not need to be encoded at the beginning of the codetext.
 To switch from another ECI mode to the default ECI mode, use "\000003".
 All unicode characters after ECI identifier are automatically encoded into correct character codeset.
 QR compaction mode selectors are set as single slash and mode name: "\auto", "\num", "\alnum", "\byte", "\kanji".
 "\auto" sets automatic compaction mode, "\num" sets Numeric mode, "\alnum" sets AlphaNumeric mode, "\byte" sets Bytes mode, and "\kanji" sets Kanji mode.
 The default compaction mode is "\auto".
 Compaction mode selectors define the encoding mode for the following data until the next compaction mode selector or ECI identifier is found.
 If the data cannot be encoded in the selected compaction mode, an ArgumentException is thrown.
 This mode is not supported by MicroQR barcodes.
 
 //create codetext
 QrExtCodetextBuilder textBuilder = new QrExtCodetextBuilder();
 textBuilder.addFNC1FirstPosition();
 textBuilder.addPlainCodetext("000%89%%0");
 textBuilder.addFNC1GroupSeparator();
 textBuilder.addPlainCodetext("12345<FNC1>");
 //generate barcode
 BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
 generator.setCodeText(textBuilder.GetExtendedCodetext();
 generator.getParameters().getBarcode().getQR().setEncodeMode(QREncodeMode.Extended);
 generator.getParameters().getBarcode().getCodeTextParameters().setTwoDDisplayText("My Text");
 generator.save("test.png");
 
 //This sample shows how to use FNC1 second position in Extended Mode.
 //create codetext
 QrExtCodetextBuilder textBuilder = new QrExtCodetextBuilder();
 textBuilder.addFNC1SecondPosition("12");
 textBuilder.addPlainCodetext("TRUE3456");
 //generate barcode
 BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
 generator.setCodeText(textBuilder.GetExtendedCodetext();
 generator.getParameters().getBarcode().getQR().setEncodeMode(QREncodeMode.Extended);
 generator.getParameters().getBarcode().getCodeTextParameters().setTwoDDisplayText("My Text");
 generator.save("test.png");
 
 //This sample shows how to use multi ECI mode in Extended Mode.
 //create codetext
 QrExtCodetextBuilder textBuilder = new QrExtCodetextBuilder();
 textBuilder.addECICodetext(ECIEncodings.Win1251, "Will");
 textBuilder.addECICodetext(ECIEncodings.UTF8, "Right");
 textBuilder.addECICodetext(ECIEncodings.UTF16BE, "Power");
 textBuilder.addPlainCodetext"t\e\\st");
 textBuilder.addAlphaNumericCodetext("ASPOSE2001");
 textBuilder.addNumericCodetext(@"20012026");
 //generate barcode
 BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
 generator.setCodeText(textBuilder.getExtendedCodetext();
 generator.getParameters().getBarcode().getQR().setEncodeMode(QREncodeMode.EXTENDED);
 generator.getParameters().getBarcode().getCodeTextParameters().setTwoDDisplayText("My Text";
 generator.save("test.png");

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTO` In Auto mode, the CodeText is encoded with maximum data compactness.
`BINARY` In Binary mode, the CodeText is encoded with maximum data compactness.
`BYTES` Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method to convert the message to byte array with specified encoding.
`ECI` In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier.
`ECI_ENCODING` Deprecated. This property is obsolete and will be removed in future releases. Instead, use ECI option.
`EXTENDED` Extended Channel mode which supports FNC1 first position, FNC1 second position and multi ECI modes.
`EXTENDED_CODETEXT` Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'Extended' encode mode.
`UTF_16_BEBOM` Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method with BigEndianUnicode encoding to add a byte order mark (BOM) and encode the message. After that, the CodeText can be encoded using the 'Auto' mode.
`UTF_8_BOM` Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method with UTF8 encoding to add a byte order mark (BOM) and encode the message. After that, the CodeText can be encoded using the 'Auto' mode.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getValue()`
`static QREncodeMode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static QREncodeMode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AUTO
```
public static final QREncodeMode AUTO
```
    In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are encoded in kanji mode if possible, or they are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown.
  - BYTES
```
@Deprecated
public static final QREncodeMode BYTES
```
    Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method to convert the message to byte array with specified encoding.
    
    Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first.
  - UTF_8_BOM
```
@Deprecated
public static final QREncodeMode UTF_8_BOM
```
    Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method with UTF8 encoding to add a byte order mark (BOM) and encode the message. After that, the CodeText can be encoded using the 'Auto' mode.
    
    Encode codetext with UTF8 encoding with first ByteOfMark character.
  - UTF_16_BEBOM
```
@Deprecated
public static final QREncodeMode UTF_16_BEBOM
```
    Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method with BigEndianUnicode encoding to add a byte order mark (BOM) and encode the message. After that, the CodeText can be encoded using the 'Auto' mode.
    
    Encode codetext with UTF8 encoding with first ByteOfMark character. It can be problems with some barcode scanners.
  - ECI_ENCODING
```
@Deprecated
public static final QREncodeMode ECI_ENCODING
```
    Deprecated. This property is obsolete and will be removed in future releases. Instead, use ECI option.
    
    Encode codetext with value set in the ECIEncoding property. It can be problems with some old (pre 2006) barcode scanners. This mode is not supported by MicroQR barcodes.
  - EXTENDED_CODETEXT
```
public static final QREncodeMode EXTENDED_CODETEXT
```
    Deprecated. This property is obsolete and will be removed in future releases. Instead, use the 'Extended' encode mode.
    
    Extended Channel mode which supports FNC1 first position, FNC1 second position and multi ECI modes. It is better to use QrExtCodetextBuilder for extended codetext generation. Use Display2DText property to set visible text by removing managing characters. Encoding Principles: All symbols "\" must be doubled "\\" in the codetext. FNC1 in first position is set in codetext as "<FNC1>". FNC1 in second position is set in codetext as "<FNC1(value)>". The value must be a single character from a-z or A-Z, or a two-digit number from 00 to 99. Group Separator for FNC1 modes is set as 0x1D character ''. If you need to insert "<FNC1>" string into barcode write it as "<\FNC1>". ECI identifiers are set as single slash and six digits identifier, for example "\000026" for UTF8 ECI identifier. The default ECI mode is ISO/IEC 8859-1 ECI identifier "\000003". It does not need to be encoded at the beginning of the codetext. To switch from another ECI mode to the default ECI mode, use "\000003". All unicode characters after ECI identifier are automatically encoded into correct character codeset. QR compaction mode selectors are set as single slash and mode name: "\auto", "\num", "\alnum", "\byte", "\kanji". "\auto" sets automatic compaction mode, "\num" sets Numeric mode, "\alnum" sets AlphaNumeric mode, "\byte" sets Bytes mode, and "\kanji" sets Kanji mode. The default compaction mode is "\auto". Compaction mode selectors define the encoding mode for the following data until the next compaction mode selector or ECI identifier is found. If the data cannot be encoded in the selected compaction mode, an ArgumentException is thrown. This mode is not supported by MicroQR barcodes.
  - EXTENDED
```
public static final QREncodeMode EXTENDED
```
    Extended Channel mode which supports FNC1 first position, FNC1 second position and multi ECI modes. It is better to use QrExtCodetextBuilder for extended codetext generation. Use Display2DText property to set visible text by removing managing characters. Encoding Principles: All symbols "\" must be doubled "\\" in the codetext. FNC1 in first position is set in codetext as "<FNC1>". FNC1 in second position is set in codetext as "<FNC1(value)>". The value must be a single character from a-z or A-Z, or a two-digit number from 00 to 99. Group Separator for FNC1 modes is set as 0x1D character ''. If you need to insert "<FNC1>" string into barcode write it as "<\FNC1>". ECI identifiers are set as single slash and six digits identifier, for example "\000026" for UTF8 ECI identifier. The default ECI mode is ISO/IEC 8859-1 ECI identifier "\000003". It does not need to be encoded at the beginning of the codetext. To switch from another ECI mode to the default ECI mode, use "\000003". All unicode characters after ECI identifier are automatically encoded into correct character codeset. QR compaction mode selectors are set as single slash and mode name: "\auto", "\num", "\alnum", "\byte", "\kanji". "\auto" sets automatic compaction mode, "\num" sets Numeric mode, "\alnum" sets AlphaNumeric mode, "\byte" sets Bytes mode, and "\kanji" sets Kanji mode. The default compaction mode is "\auto". Compaction mode selectors define the encoding mode for the following data until the next compaction mode selector or ECI identifier is found. If the data cannot be encoded in the selected compaction mode, an ArgumentException is thrown. This mode is not supported by MicroQR barcodes.
  - BINARY
```
public static final QREncodeMode BINARY
```
    In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown.
  - ECI
```
public static final QREncodeMode ECI
```
    In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. This mode is not supported by MicroQR barcodes.
- Method Detail
  - values
```
public static QREncodeMode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (QREncodeMode c : QREncodeMode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static QREncodeMode valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getValue
```
public int getValue()
```

Enum QREncodeMode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTO

BYTES

UTF_8_BOM

UTF_16_BEBOM

ECI_ENCODING

EXTENDED_CODETEXT

EXTENDED

BINARY

ECI

Method Detail

values

valueOf

getValue