Package com.aspose.barcode.component

Class Pdf417ParametersUI

java.lang.Object
com.aspose.barcode.component.Pdf417ParametersUI
public class Pdf417ParametersUI extends Object
UI wrapper for com.aspose.barcode.generation.Pdf417Parameters class.

  • Method Details

    • getEncodeMode

      public final Pdf417EncodeMode getEncodeMode()

      Pdf417 symbology type of BarCode's encode mode. Default value: Pdf417EncodeMode.Auto.

    • setEncodeMode

      public final void setEncodeMode(Pdf417EncodeMode value)

      Pdf417 symbology type of BarCode's encode mode. Default value: Pdf417EncodeMode.Auto.

    • getPdf417EncodeMode

      @Deprecated public final Pdf417EncodeMode getPdf417EncodeMode()
      Deprecated.
      Use EncodeMode instead

      Pdf417 symbology type of BarCode's encode mode. Default value: Pdf417EncodeMode.Auto.

    • setPdf417EncodeMode

      @Deprecated public final void setPdf417EncodeMode(Pdf417EncodeMode value)
      Deprecated.
      Use EncodeMode instead

      Pdf417 symbology type of BarCode's encode mode. Default value: Pdf417EncodeMode.Auto.

    • getPdf417CompactionMode

      public final Pdf417CompactionMode getPdf417CompactionMode()

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

    • setPdf417CompactionMode

      public final void setPdf417CompactionMode(Pdf417CompactionMode value)

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

    • getErrorLevel

      public final Pdf417ErrorLevel getErrorLevel()

      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.

      Returns:
      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.

    • setErrorLevel

      public final void setErrorLevel(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.

      Parameters:
      value - 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.

    • getPdf417ErrorLevel

      @Deprecated public final Pdf417ErrorLevel getPdf417ErrorLevel()
      Deprecated.
      Use ErrorLevel instead

      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.

      Returns:
      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

      @Deprecated public final void setPdf417ErrorLevel(Pdf417ErrorLevel value)
      Deprecated.
      Use ErrorLevel instead

      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.

      Parameters:
      value - 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.

    • getTruncate

      public final boolean getTruncate()

      Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

    • setTruncate

      public final void setTruncate(boolean value)

      Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

    • getPdf417Truncate

      @Deprecated public final boolean getPdf417Truncate()
      Deprecated.
      Use Truncate instead

      Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

    • setPdf417Truncate

      @Deprecated public final void setPdf417Truncate(boolean value)
      Deprecated.
      Use Truncate instead

      Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

    • getColumns

      public final int getColumns()

      Columns count.

    • setColumns

      public final void setColumns(int value)

      Columns count.

    • getRows

      public final int getRows()

      Rows count.

    • setRows

      public final void setRows(int value)

      Rows count.

    • getAspectRatio

      public final float getAspectRatio()

      Height/Width ratio of 2D BarCode module.

    • setAspectRatio

      public final void setAspectRatio(float value)

      Height/Width ratio of 2D BarCode module.

    • getMacroPdf417FileID

      public final int getMacroPdf417FileID()

      Gets macro Pdf417 barcode's file ID. Used for MacroPdf417.

      Returns:
      macro Pdf417 barcode's file ID.

    • setMacroPdf417FileID

      public final void setMacroPdf417FileID(int value)

      Sets macro Pdf417 barcode's file ID. Used for MacroPdf417.

      Parameters:
      value - macro Pdf417 barcode's file ID.

    • getPdf417MacroFileID

      @Deprecated public final int getPdf417MacroFileID()
      Deprecated.
      Use MacroPdf417FileID instead

      Gets macro Pdf417 barcode's file ID. Used for MacroPdf417.

      Returns:
      macro Pdf417 barcode's file ID.

    • setPdf417MacroFileID

      @Deprecated public final void setPdf417MacroFileID(int value)
      Deprecated.
      Use MacroPdf417FileID instead

      Sets macro Pdf417 barcode's file ID. Used for MacroPdf417.

      Parameters:
      value - macro Pdf417 barcode's file ID.

    • getMacroPdf417SegmentID

      public final int getMacroPdf417SegmentID()

      Gets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

      Returns:
      macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

    • setMacroPdf417SegmentID

      public final void setMacroPdf417SegmentID(int value)

      Sets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

      Parameters:
      value - macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

    • getPdf417MacroSegmentID

      @Deprecated public final int getPdf417MacroSegmentID()
      Deprecated.
      Use MacroPdf417SegmentID instead

      Gets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

      Returns:
      macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

    • setPdf417MacroSegmentID

      @Deprecated public final void setPdf417MacroSegmentID(int value)
      Deprecated.
      Use MacroPdf417SegmentID instead

      Sets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

      Parameters:
      value - macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

    • getMacroPdf417SegmentsCount

      public final int getMacroPdf417SegmentsCount()

      Gets macro Pdf417 barcode segments count.

      Returns:
      macro Pdf417 barcode segments count.

    • setMacroPdf417SegmentsCount

      public final void setMacroPdf417SegmentsCount(int value)

      Sets macro Pdf417 barcode segments count.

      Parameters:
      value - macro Pdf417 barcode segments count.

    • getPdf417MacroSegmentsCount

      @Deprecated public final int getPdf417MacroSegmentsCount()
      Deprecated.
      Use MacroPdf417SegmentsCount instead

      Gets macro Pdf417 barcode segments count.

      Returns:
      macro Pdf417 barcode segments count.

    • setPdf417MacroSegmentsCount

      @Deprecated public final void setPdf417MacroSegmentsCount(int value)
      Deprecated.
      Use MacroPdf417SegmentsCount instead

      Sets macro Pdf417 barcode segments count.

      Parameters:
      value - macro Pdf417 barcode segments count.

    • getMacroPdf417FileName

      public final String getMacroPdf417FileName()

      MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

    • setMacroPdf417FileName

      public final void setMacroPdf417FileName(String value)

      MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

    • getPdf417MacroFileName

      @Deprecated public final String getPdf417MacroFileName()
      Deprecated.
      Use MacroPdf417FileName instead

      MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

    • setPdf417MacroFileName

      @Deprecated public final void setPdf417MacroFileName(String value)
      Deprecated.
      Use MacroPdf417FileName instead

      MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

    • getMacroPdf417TimeStamp

      public final LocalDateTime getMacroPdf417TimeStamp()

      MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

    • setMacroPdf417TimeStamp

      public final void setMacroPdf417TimeStamp(LocalDateTime value)

      MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

    • getPdf417MacroTimeStamp

      @Deprecated public final LocalDateTime getPdf417MacroTimeStamp()
      Deprecated.
      Use MacroPdf417TimeStamp instead

      MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

    • setPdf417MacroTimeStamp

      @Deprecated public final void setPdf417MacroTimeStamp(LocalDateTime value)
      Deprecated.
      Use MacroPdf417TimeStamp instead

      MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

    • getMacroPdf417Sender

      public final String getMacroPdf417Sender()

      MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

    • setMacroPdf417Sender

      public final void setMacroPdf417Sender(String value)

      MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

    • getPdf417MacroSender

      @Deprecated public final String getPdf417MacroSender()
      Deprecated.
      Use MacroPdf417Sender instead

      MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

    • setPdf417MacroSender

      @Deprecated public final void setPdf417MacroSender(String value)
      Deprecated.
      Use MacroPdf417Sender instead

      MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

    • getMacroPdf417Addressee

      public final String getMacroPdf417Addressee()

      MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

    • setMacroPdf417Addressee

      public final void setMacroPdf417Addressee(String value)

      MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

    • getPdf417MacroAddressee

      @Deprecated public final String getPdf417MacroAddressee()
      Deprecated.
      Use MacroPdf417Addressee instead

      MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

    • setPdf417MacroAddressee

      @Deprecated public final void setPdf417MacroAddressee(String value)
      Deprecated.
      Use MacroPdf417Addressee instead

      MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

    • getMacroPdf417FileSize

      public final int getMacroPdf417FileSize()

      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.

    • setMacroPdf417FileSize

      public final void setMacroPdf417FileSize(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.

    • getPdf417MacroFileSize

      @Deprecated public final int getPdf417MacroFileSize()
      Deprecated.
      Use MacroPdf417FileSize instead

      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

      @Deprecated public final void setPdf417MacroFileSize(int value)
      Deprecated.
      Use MacroPdf417FileSize instead

      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.

    • getMacroPdf417Checksum

      public final int getMacroPdf417Checksum()

      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

    • setMacroPdf417Checksum

      public final void setMacroPdf417Checksum(int value)

      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

    • getPdf417MacroChecksum

      @Deprecated public final int getPdf417MacroChecksum()
      Deprecated.
      Use MacroPdf417Checksum instead

      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

      @Deprecated public final void setPdf417MacroChecksum(int value)
      Deprecated.
      Use MacroPdf417Checksum instead

      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

    • getECIEncoding

      public final int getECIEncoding()

      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.

    • setECIEncoding

      public final void setECIEncoding(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.

    • getPdf417ECIEncoding

      @Deprecated public final int getPdf417ECIEncoding()
      Deprecated.
      Use ECIEncoding instead

      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

      @Deprecated public final void setPdf417ECIEncoding(int value)
      Deprecated.
      Use ECIEncoding instead

      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.

    • getMacroPdf417ECIEncoding

      public final int getMacroPdf417ECIEncoding()

      Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

    • setMacroPdf417ECIEncoding

      public final void setMacroPdf417ECIEncoding(int value)

      Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

    • getPdf417MacroECIEncoding

      @Deprecated public final int getPdf417MacroECIEncoding()
      Deprecated.
      Use MacroPdf417ECIEncoding instead

      Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

    • setPdf417MacroECIEncoding

      @Deprecated public final void setPdf417MacroECIEncoding(int value)
      Deprecated.
      Use MacroPdf417ECIEncoding instead

      Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

    • getMacroPdf417Terminator

      public final Pdf417MacroTerminator getMacroPdf417Terminator()

      Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

    • setMacroPdf417Terminator

      public final void setMacroPdf417Terminator(Pdf417MacroTerminator value)

      Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

    • getPdf417MacroTerminator

      @Deprecated public final Pdf417MacroTerminator getPdf417MacroTerminator()
      Deprecated.
      Use MacroPdf417Terminator instead

      Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

    • setPdf417MacroTerminator

      @Deprecated public final void setPdf417MacroTerminator(Pdf417MacroTerminator value)
      Deprecated.
      Use MacroPdf417Terminator instead

      Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

    • isReaderInitialization

      public final boolean isReaderInitialization()

      Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.

    • setReaderInitialization

      public final void setReaderInitialization(boolean value)

      Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.

    • getMacroCharacters

      public final MacroCharacter getMacroCharacters()

      Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.

    • setMacroCharacters

      public final void setMacroCharacters(MacroCharacter value)

      Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.

    • isLinked

      public final boolean isLinked()

      Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC

    • setLinked

      public final void setLinked(boolean value)

      Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC

    • isCode128Emulation

      public final boolean isCode128Emulation()

      Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128

    • setCode128Emulation

      public final void setCode128Emulation(boolean value)

      Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128

    • toString

      public String toString()

      Returns a human-readable string representation of this Pdf417Parameters.

      Overrides:
      toString in class Object
      Returns:
      A string that represents this Pdf417Parameters.