com.aspose.barcode.generation

Class Pdf417Parameters

  • java.lang.Object
    • com.aspose.barcode.generation.Pdf417Parameters


  • 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.

    • Method Detail

      • getPdf417CompactionMode

        public Pdf417CompactionMode getPdf417CompactionMode()

        Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.AUTO.

      • setPdf417CompactionMode

        public void setPdf417CompactionMode(Pdf417CompactionMode value)

        Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.AUTO.

      • getPdf417ErrorLevel

        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.

      • setPdf417ErrorLevel

        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.

      • getPdf417Truncate

        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.

      • setPdf417Truncate

        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.

      • getColumns

        public int getColumns()

        Columns count.

      • setColumns

        public void setColumns(int value)

        Columns count.

      • getRows

        public int getRows()

        Rows count.

      • setRows

        public void setRows(int value)

        Rows count.

      • getAspectRatio

        public float getAspectRatio()

        Height/Width ratio of 2D BarCode module.

      • setAspectRatio

        public void setAspectRatio(float value)

        Height/Width ratio of 2D BarCode module.

      • getPdf417MacroFileID

        public int getPdf417MacroFileID()

        MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode).

      • setPdf417MacroFileID

        public void setPdf417MacroFileID(int value)

        MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode).

      • getPdf417MacroSegmentID

        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)

      • setPdf417MacroSegmentID

        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)

      • getPdf417MacroSegmentsCount

        public int getPdf417MacroSegmentsCount()

        MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)

      • setPdf417MacroSegmentsCount

        public void setPdf417MacroSegmentsCount(int value)

        MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)

      • getPdf417MacroFileName

        public java.lang.String getPdf417MacroFileName()
        MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)
      • setPdf417MacroFileName

        public void setPdf417MacroFileName(java.lang.String value)
        MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)
      • getPdf417MacroTimeStamp

        public java.util.Date getPdf417MacroTimeStamp()
        MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)
      • setPdf417MacroTimeStamp

        public void setPdf417MacroTimeStamp(java.util.Date value)
        MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)
      • getPdf417MacroSender

        public java.lang.String getPdf417MacroSender()
        MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)
      • setPdf417MacroSender

        public void setPdf417MacroSender(java.lang.String value)
        MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)
      • getPdf417MacroAddressee

        public java.lang.String getPdf417MacroAddressee()
        MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)
      • setPdf417MacroAddressee

        public void setPdf417MacroAddressee(java.lang.String value)
        MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)
      • getPdf417MacroFileSize

        public int getPdf417MacroFileSize()
        MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size field contains the size in bytes of the entire source file.
      • setPdf417MacroFileSize

        public void setPdf417MacroFileSize(int value)
        MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size field contains the size in bytes of the entire source file.
      • getPdf417MacroChecksum

        public int getPdf417MacroChecksum()
        MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode) The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial. x^16 + x^12 + x^5 + 1
      • setPdf417MacroChecksum

        public void setPdf417MacroChecksum(int value)
        Sets macro Pdf417 barcode checksum.
        Parameters:
        value - The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.
      • getCodeTextEncoding

        public java.nio.charset.Charset getCodeTextEncoding()

        Gets the encoding of codetext. Default value: UTF-8

      • setCodeTextEncoding

        public void setCodeTextEncoding(java.nio.charset.Charset value)

        Sets the encoding of codetext. Default value: UTF-8

      • getPdf417ECIEncoding

        public int getPdf417ECIEncoding()
        Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.
      • setPdf417ECIEncoding

        public void setPdf417ECIEncoding(int value)
        Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.
      • getPdf417MacroECIEncoding

        public int getPdf417MacroECIEncoding()
        Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
      • setPdf417MacroECIEncoding

        public void setPdf417MacroECIEncoding(int value)
        Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
      • isReaderInitialization

        public boolean isReaderInitialization()
        Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.
      • setReaderInitialization

        public void setReaderInitialization(boolean value)
        Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.
      • getCode128Emulation

        public Code128Emulation getCode128Emulation()
        Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.
      • setCode128Emulation

        public void setCode128Emulation(Code128Emulation value)
        Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.
      • toString

        public java.lang.String toString()

        Returns a human-readable String representation of this Pdf417Parameters.

        Overrides:
        toString in class java.lang.Object
        Returns:
        A String that represents this Pdf417Parameters.