public class Pdf417Parameters
extends java.lang.Object
PDF417 parameters. Contains PDF417, MacroPDF417 and MicroPDF417 parameters. MacroPDF417 requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional. MicroPDF417 in Structured Append mode (same as MacroPDF417 mode) requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional.
Modifier and Type | Method and Description |
---|---|
float |
getAspectRatio()
Height/Width ratio of 2D BarCode module.
|
Code128Emulation |
getCode128Emulation()
Function codeword for Code 128 emulation.
|
java.nio.charset.Charset |
getCodeTextEncoding()
Gets the encoding of codetext.
|
int |
getColumns()
Columns count.
|
Pdf417CompactionMode |
getPdf417CompactionMode()
Pdf417 symbology type of BarCode's compaction mode.
|
int |
getPdf417ECIEncoding()
Extended Channel Interpretation Identifiers.
|
Pdf417ErrorLevel |
getPdf417ErrorLevel()
Gets Pdf417 symbology type of BarCode's error correction level
ranging from level0 to level8, level0 means no error correction info,
level8 means best error correction which means a larger picture.
|
java.lang.String |
getPdf417MacroAddressee()
MacroPdf417 barcode addressee name (optional field).
|
int |
getPdf417MacroChecksum()
MacroPdf417 barcode checksum (optional field).
|
int |
getPdf417MacroECIEncoding()
Extended Channel Interpretation Identifiers.
|
int |
getPdf417MacroFileID()
MacroPdf417 barcode's file ID (Required field).
|
java.lang.String |
getPdf417MacroFileName()
MacroPdf417 barcode file name (optional field).
|
int |
getPdf417MacroFileSize()
MacroPdf417 file size (optional field).
|
int |
getPdf417MacroSegmentID()
MacroPdf417 barcode's segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1.
|
int |
getPdf417MacroSegmentsCount()
MacroPdf417 barcode segments count (optional field).
|
java.lang.String |
getPdf417MacroSender()
MacroPdf417 barcode sender name (optional field).
|
java.util.Date |
getPdf417MacroTimeStamp()
MacroPdf417 barcode time stamp (optional field).
|
boolean |
getPdf417Truncate()
Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
|
int |
getRows()
Rows count.
|
boolean |
isReaderInitialization()
Used to instruct the reader to interpret the data contained within the symbol
as programming for reader initialization.
|
void |
setAspectRatio(float value)
Height/Width ratio of 2D BarCode module.
|
void |
setCode128Emulation(Code128Emulation value)
Function codeword for Code 128 emulation.
|
void |
setCodeTextEncoding(java.nio.charset.Charset value)
Sets the encoding of codetext.
|
void |
setColumns(int value)
Columns count.
|
void |
setPdf417CompactionMode(Pdf417CompactionMode value)
Pdf417 symbology type of BarCode's compaction mode.
|
void |
setPdf417ECIEncoding(int value)
Extended Channel Interpretation Identifiers.
|
void |
setPdf417ErrorLevel(Pdf417ErrorLevel value)
Sets Pdf417 symbology type of BarCode's error correction level
ranging from level0 to level8, level0 means no error correction info,
level8 means best error correction which means a larger picture.
|
void |
setPdf417MacroAddressee(java.lang.String value)
MacroPdf417 barcode addressee name (optional field).
|
void |
setPdf417MacroChecksum(int value)
Sets macro Pdf417 barcode checksum.
|
void |
setPdf417MacroECIEncoding(int value)
Extended Channel Interpretation Identifiers.
|
void |
setPdf417MacroFileID(int value)
MacroPdf417 barcode's file ID (Required field).
|
void |
setPdf417MacroFileName(java.lang.String value)
MacroPdf417 barcode file name (optional field).
|
void |
setPdf417MacroFileSize(int value)
MacroPdf417 file size (optional field).
|
void |
setPdf417MacroSegmentID(int value)
MacroPdf417 barcode's segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1.
|
void |
setPdf417MacroSegmentsCount(int value)
MacroPdf417 barcode segments count (optional field).
|
void |
setPdf417MacroSender(java.lang.String value)
MacroPdf417 barcode sender name (optional field).
|
void |
setPdf417MacroTimeStamp(java.util.Date value)
MacroPdf417 barcode time stamp (optional field).
|
void |
setPdf417Truncate(boolean value)
Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
|
void |
setReaderInitialization(boolean value)
Used to instruct the reader to interpret the data contained within the symbol
as programming for reader initialization.
|
void |
setRows(int value)
Rows count.
|
java.lang.String |
toString()
Returns a human-readable String representation of this
Pdf417Parameters . |
public Pdf417CompactionMode getPdf417CompactionMode()
Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.AUTO.
public void setPdf417CompactionMode(Pdf417CompactionMode value)
Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.AUTO.
public Pdf417ErrorLevel getPdf417ErrorLevel()
Gets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.
public void setPdf417ErrorLevel(Pdf417ErrorLevel value)
Sets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.
public boolean getPdf417Truncate()
Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicator and right stop pattern are removed in this mode.
public void setPdf417Truncate(boolean value)
Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicator and right stop pattern are removed in this mode.
public int getColumns()
Columns count.
public void setColumns(int value)
Columns count.
public int getRows()
Rows count.
public void setRows(int value)
Rows count.
public float getAspectRatio()
Height/Width ratio of 2D BarCode module.
public void setAspectRatio(float value)
Height/Width ratio of 2D BarCode module.
public int getPdf417MacroFileID()
MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode).
public void setPdf417MacroFileID(int value)
MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode).
public int getPdf417MacroSegmentID()
MacroPdf417 barcode's segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode's segment ID (Required field for Structured Append mode)
public void setPdf417MacroSegmentID(int value)
MacroPdf417 barcode's segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode's segment ID (Required field for Structured Append mode)
public int getPdf417MacroSegmentsCount()
MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)
public void setPdf417MacroSegmentsCount(int value)
MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)
public java.lang.String getPdf417MacroFileName()
public void setPdf417MacroFileName(java.lang.String value)
public java.util.Date getPdf417MacroTimeStamp()
public void setPdf417MacroTimeStamp(java.util.Date value)
public java.lang.String getPdf417MacroSender()
public void setPdf417MacroSender(java.lang.String value)
public java.lang.String getPdf417MacroAddressee()
public void setPdf417MacroAddressee(java.lang.String value)
public int getPdf417MacroFileSize()
public void setPdf417MacroFileSize(int value)
public int getPdf417MacroChecksum()
public void setPdf417MacroChecksum(int value)
value
- The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.public java.nio.charset.Charset getCodeTextEncoding()
Gets the encoding of codetext. Default value: UTF-8
public void setCodeTextEncoding(java.nio.charset.Charset value)
Sets the encoding of codetext. Default value: UTF-8
public int getPdf417ECIEncoding()
public void setPdf417ECIEncoding(int value)
public int getPdf417MacroECIEncoding()
public void setPdf417MacroECIEncoding(int value)
public boolean isReaderInitialization()
public void setReaderInitialization(boolean value)
public Code128Emulation getCode128Emulation()
public void setCode128Emulation(Code128Emulation value)
public java.lang.String toString()
Returns a human-readable String representation of this Pdf417Parameters
.
toString
in class java.lang.Object
Pdf417Parameters
.