Module com.github.librepdf.openpdf
Package com.lowagie.text.pdf

Class BarcodePDF417

java.lang.Object
com.lowagie.text.pdf.BarcodePDF417
@Deprecated public class BarcodePDF417 extends Object
Deprecated.
Generates the 2D barcode PDF417. Supports dimensioning auto-sizing, fixed and variable sizes, automatic and manual error levels, raw codeword input, codeword size optimization and bitmap inversion. The output can be a CCITT G4 Image or a raw bitmap.
Author:
Paulo Soares (psoares@consiste.pt)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    BarcodePDF417.Segment
    Deprecated.
     
    protected static class 
    BarcodePDF417.SegmentList
    Deprecated.
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final int
    ABSOLUTE_MAX_TEXT_SIZE
    Deprecated.
     
    protected static final int
    AL
    Deprecated.
     
    protected static final int
    ALPHA
    Deprecated.
     
    protected static final int
    AS
    Deprecated.
     
    protected int
    bitPtr
    Deprecated.
     
    protected static final int
    BYTE_MODE
    Deprecated.
     
    protected static final int
    BYTE_MODE_6
    Deprecated.
     
    protected static final int
    BYTESHIFT
    Deprecated.
     
    protected int
    cwPtr
    Deprecated.
     
    protected static final int
    ISBYTE
    Deprecated.
     
    protected static final int
    LL
    Deprecated.
     
    protected static final int
    LOWER
    Deprecated.
     
    protected static final int
    MACRO_LAST_SEGMENT
    Deprecated.
     
    protected static final int
    MACRO_SEGMENT_ID
    Deprecated.
     
    protected static final int
    MAX_DATA_CODEWORDS
    Deprecated.
     
    protected static final int
    MIXED
    Deprecated.
     
    protected static final int
    ML
    Deprecated.
     
    protected static final int
    MOD
    Deprecated.
     
    protected static final int
    NUMERIC_MODE
    Deprecated.
     
    protected static final int
    PAL
    Deprecated.
     
    static final int
    PDF417_AUTO_ERROR_LEVEL
    Deprecated.
    The error level correction is set automatically according to ISO 15438 recommendations.
    static final int
    PDF417_FIXED_COLUMNS
    Deprecated.
    The size will be at least codeColumns with a variable number of codeRows.
    static final int
    PDF417_FIXED_RECTANGLE
    Deprecated.
    The size of the barcode will be at least codeColumns*codeRows.
    static final int
    PDF417_FIXED_ROWS
    Deprecated.
    The size will be at least codeRows with a variable number of codeColumns.
    static final int
    PDF417_FORCE_BINARY
    Deprecated.
    One single binary segment is used
    static final int
    PDF417_INVERT_BITMAP
    Deprecated.
    Inverts the output bits of the raw bitmap that is normally bit one for black.
    static final int
    PDF417_USE_ASPECT_RATIO
    Deprecated.
    Auto-size is made based on aspectRatio and yHeight.
    static final int
    PDF417_USE_ERROR_LEVEL
    Deprecated.
    The error level correction is set by the user.
    static final int
    PDF417_USE_MACRO
    Deprecated.
    Use Macro PDF417 Encoding
    static final int
    PDF417_USE_RAW_CODEWORDS
    Deprecated.
    No text interpretation is done and the content of codewords is used directly.
    protected static final int
    PL
    Deprecated.
     
    protected static final int
    PS
    Deprecated.
     
    protected static final int
    PUNCTUATION
    Deprecated.
     
    protected BarcodePDF417.SegmentList
    segmentList
    Deprecated.
     
    protected static final int
    SPACE
    Deprecated.
     
    protected static final int
    START_CODE_SIZE
    Deprecated.
     
    protected static final int
    START_PATTERN
    Deprecated.
     
    protected static final int
    STOP_PATTERN
    Deprecated.
     
    protected static final int
    STOP_SIZE
    Deprecated.
     
    protected static final int
    TEXT_MODE
    Deprecated.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    BarcodePDF417()
    Deprecated.
    Creates a new BarcodePDF417 with the default settings.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    assemble()
    Deprecated.
     
    protected void
    basicNumberCompaction(int start, int length)
    Deprecated.
     
    protected void
    byteCompaction6(int start)
    Deprecated.
     
    protected void
    calculateErrorCorrection(int dest)
    Deprecated.
     
    protected boolean
    checkSegmentType(BarcodePDF417.Segment segment, char type)
    Deprecated.
     
    Image
    createAwtImage(Color foreground, Color background)
    Deprecated.
    Creates a java.awt.Image.
    float
    getAspectRatio()
    Deprecated.
    Gets the barcode aspect ratio.
    int
    getBitColumns()
    Deprecated.
    Gets the number of X pixels of outBits.
    int
    getCodeColumns()
    Deprecated.
    Gets the number of barcode data columns.
    int
    getCodeRows()
    Deprecated.
    Gets the number of Y pixels of outBits.
    int[]
    getCodewords()
    Deprecated.
    Gets the codeword array.
    int
    getErrorLevel()
    Deprecated.
    Gets the error level correction used for the barcode.
    Image
    getImage()
    Deprecated.
    Gets an Image with the barcode.
    int
    getLenCodewords()
    Deprecated.
    Gets the length of the codewords.
    protected int
    getMaxSquare()
    Deprecated.
     
    int
    getOptions()
    Deprecated.
    Gets the options to generate the barcode.
    byte[]
    getOutBits()
    Deprecated.
    Gets the raw image bits of the barcode.
    protected int
    getSegmentLength(BarcodePDF417.Segment segment)
    Deprecated.
     
    byte[]
    getText()
    Deprecated.
    Gets the bytes that form the barcode.
    protected int
    getTextTypeAndValue(int maxLength, int idx)
    Deprecated.
     
    float
    getYHeight()
    Deprecated.
    Gets the Y pixel height relative to X.
    protected static int
    maxPossibleErrorLevel(int remain)
    Deprecated.
     
    protected void
    numberCompaction(int start, int length)
    Deprecated.
     
    protected void
    outCodeword(int codeword)
    Deprecated.
     
    protected void
    outCodeword17(int codeword)
    Deprecated.
     
    protected void
    outCodeword18(int codeword)
    Deprecated.
     
    protected void
    outPaintCode()
    Deprecated.
     
    protected void
    outStartPattern()
    Deprecated.
     
    protected void
    outStopPattern()
    Deprecated.
     
    void
    paintCode()
    Deprecated.
    Paints the barcode.
    void
    setAspectRatio(float aspectRatio)
    Deprecated.
    Sets the barcode aspect ratio.
    void
    setCodeColumns(int codeColumns)
    Deprecated.
    Sets the number of barcode data columns.
    void
    setCodeRows(int codeRows)
    Deprecated.
    Sets the number of barcode rows.
    void
    setDefaultParameters()
    Deprecated.
    Set the default settings that correspond to PDF417_USE_ASPECT_RATIO and PDF417_AUTO_ERROR_LEVEL.
    void
    setErrorLevel(int errorLevel)
    Deprecated.
    Sets the error level correction for the barcode.
    void
    setLenCodewords(int lenCodewords)
    Deprecated.
    Sets the length of the codewords.
    void
    setMacroFileId(String id)
    Deprecated.
    Sets the File ID for macro PDF417 encoding
    void
    setMacroSegmentCount(int cnt)
    Deprecated.
    Sets the segment count for macro PDF417 encoding
    void
    setMacroSegmentId(int id)
    Deprecated.
    Sets the segment id for macro PDF417 encoding
    void
    setOptions(int options)
    Deprecated.
    Sets the options to generate the barcode.
    void
    setText(byte[] text)
    Deprecated.
    Sets the bytes that form the barcode.
    void
    setText(String s)
    Deprecated.
    Sets the text that will form the barcode.
    void
    setYHeight(float yHeight)
    Deprecated.
    Sets the Y pixel height relative to X.
    protected void
    textCompaction(int start, int length)
    Deprecated.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • PDF417_USE_ASPECT_RATIO

      public static final int PDF417_USE_ASPECT_RATIO
      Deprecated.
      Auto-size is made based on aspectRatio and yHeight.
      See Also:

    • PDF417_FIXED_RECTANGLE

      public static final int PDF417_FIXED_RECTANGLE
      Deprecated.
      The size of the barcode will be at least codeColumns*codeRows.
      See Also:

    • PDF417_FIXED_COLUMNS

      public static final int PDF417_FIXED_COLUMNS
      Deprecated.
      The size will be at least codeColumns with a variable number of codeRows.
      See Also:

    • PDF417_FIXED_ROWS

      public static final int PDF417_FIXED_ROWS
      Deprecated.
      The size will be at least codeRows with a variable number of codeColumns.
      See Also:

    • PDF417_AUTO_ERROR_LEVEL

      public static final int PDF417_AUTO_ERROR_LEVEL
      Deprecated.
      The error level correction is set automatically according to ISO 15438 recommendations.
      See Also:

    • PDF417_USE_ERROR_LEVEL

      public static final int PDF417_USE_ERROR_LEVEL
      Deprecated.
      The error level correction is set by the user. It can be 0 to 8.
      See Also:

    • PDF417_FORCE_BINARY

      public static final int PDF417_FORCE_BINARY
      Deprecated.
      One single binary segment is used
      See Also:

    • PDF417_USE_RAW_CODEWORDS

      public static final int PDF417_USE_RAW_CODEWORDS
      Deprecated.
      No text interpretation is done and the content of codewords is used directly.
      See Also:

    • PDF417_INVERT_BITMAP

      public static final int PDF417_INVERT_BITMAP
      Deprecated.
      Inverts the output bits of the raw bitmap that is normally bit one for black. It has only effect for the raw bitmap.
      See Also:

    • PDF417_USE_MACRO

      public static final int PDF417_USE_MACRO
      Deprecated.
      Use Macro PDF417 Encoding
      See Also:

    • START_PATTERN

      protected static final int START_PATTERN
      Deprecated.
      See Also:

    • STOP_PATTERN

      protected static final int STOP_PATTERN
      Deprecated.
      See Also:

    • START_CODE_SIZE

      protected static final int START_CODE_SIZE
      Deprecated.
      See Also:

    • STOP_SIZE

      protected static final int STOP_SIZE
      Deprecated.
      See Also:

    • MOD

      protected static final int MOD
      Deprecated.
      See Also:

    • ALPHA

      protected static final int ALPHA
      Deprecated.
      See Also:

    • LOWER

      protected static final int LOWER
      Deprecated.
      See Also:

    • MIXED

      protected static final int MIXED
      Deprecated.
      See Also:

    • PUNCTUATION

      protected static final int PUNCTUATION
      Deprecated.
      See Also:

    • ISBYTE

      protected static final int ISBYTE
      Deprecated.
      See Also:

    • BYTESHIFT

      protected static final int BYTESHIFT
      Deprecated.
      See Also:

    • PL

      protected static final int PL
      Deprecated.
      See Also:

    • LL

      protected static final int LL
      Deprecated.
      See Also:

    • AS

      protected static final int AS
      Deprecated.
      See Also:

    • ML

      protected static final int ML
      Deprecated.
      See Also:

    • AL

      protected static final int AL
      Deprecated.
      See Also:

    • PS

      protected static final int PS
      Deprecated.
      See Also:

    • PAL

      protected static final int PAL
      Deprecated.
      See Also:

    • SPACE

      protected static final int SPACE
      Deprecated.
      See Also:

    • TEXT_MODE

      protected static final int TEXT_MODE
      Deprecated.
      See Also:

    • BYTE_MODE_6

      protected static final int BYTE_MODE_6
      Deprecated.
      See Also:

    • BYTE_MODE

      protected static final int BYTE_MODE
      Deprecated.
      See Also:

    • NUMERIC_MODE

      protected static final int NUMERIC_MODE
      Deprecated.
      See Also:

    • ABSOLUTE_MAX_TEXT_SIZE

      protected static final int ABSOLUTE_MAX_TEXT_SIZE
      Deprecated.
      See Also:

    • MAX_DATA_CODEWORDS

      protected static final int MAX_DATA_CODEWORDS
      Deprecated.
      See Also:

    • MACRO_SEGMENT_ID

      protected static final int MACRO_SEGMENT_ID
      Deprecated.
      See Also:

    • MACRO_LAST_SEGMENT

      protected static final int MACRO_LAST_SEGMENT
      Deprecated.
      See Also:

    • bitPtr

      protected int bitPtr
      Deprecated.

    • cwPtr

      protected int cwPtr
      Deprecated.

    • segmentList

      protected BarcodePDF417.SegmentList segmentList
      Deprecated.

  • Constructor Details

    • BarcodePDF417

      public BarcodePDF417()
      Deprecated.
      Creates a new BarcodePDF417 with the default settings.

  • Method Details

    • maxPossibleErrorLevel

      protected static int maxPossibleErrorLevel(int remain)
      Deprecated.

    • setMacroSegmentId

      public void setMacroSegmentId(int id)
      Deprecated.
      Sets the segment id for macro PDF417 encoding
      Parameters:
      id - the id (starting at 0)
      See Also:

    • setMacroSegmentCount

      public void setMacroSegmentCount(int cnt)
      Deprecated.
      Sets the segment count for macro PDF417 encoding
      Parameters:
      cnt - the number of macro segments
      See Also:

    • setMacroFileId

      public void setMacroFileId(String id)
      Deprecated.
      Sets the File ID for macro PDF417 encoding
      Parameters:
      id - the file id

    • checkSegmentType

      protected boolean checkSegmentType(BarcodePDF417.Segment segment, char type)
      Deprecated.

    • getSegmentLength

      protected int getSegmentLength(BarcodePDF417.Segment segment)
      Deprecated.

    • setDefaultParameters

      public void setDefaultParameters()
      Deprecated.
      Set the default settings that correspond to PDF417_USE_ASPECT_RATIO and PDF417_AUTO_ERROR_LEVEL.

    • outCodeword17

      protected void outCodeword17(int codeword)
      Deprecated.

    • outCodeword18

      protected void outCodeword18(int codeword)
      Deprecated.

    • outCodeword

      protected void outCodeword(int codeword)
      Deprecated.

    • outStopPattern

      protected void outStopPattern()
      Deprecated.

    • outStartPattern

      protected void outStartPattern()
      Deprecated.

    • outPaintCode

      protected void outPaintCode()
      Deprecated.

    • calculateErrorCorrection

      protected void calculateErrorCorrection(int dest)
      Deprecated.

    • getTextTypeAndValue

      protected int getTextTypeAndValue(int maxLength, int idx)
      Deprecated.

    • textCompaction

      protected void textCompaction(int start, int length)
      Deprecated.

    • basicNumberCompaction

      protected void basicNumberCompaction(int start, int length)
      Deprecated.

    • numberCompaction

      protected void numberCompaction(int start, int length)
      Deprecated.

    • byteCompaction6

      protected void byteCompaction6(int start)
      Deprecated.

    • assemble

      protected void assemble()
      Deprecated.

    • getMaxSquare

      protected int getMaxSquare()
      Deprecated.

    • paintCode

      public void paintCode()
      Deprecated.
      Paints the barcode. If no exception was thrown a valid barcode is available.

    • getImage

      public Image getImage() throws BadElementException
      Deprecated.
      Gets an Image with the barcode. The image will have to be scaled in the Y direction by yHeightfor the barcode to have the right printing aspect.
      Returns:
      the barcode Image
      Throws:
      BadElementException - on error

    • createAwtImage

      public Image createAwtImage(Color foreground, Color background)
      Deprecated.
      Creates a java.awt.Image.
      Parameters:
      foreground - the color of the bars
      background - the color of the background
      Returns:
      the image

    • getOutBits

      public byte[] getOutBits()
      Deprecated.
      Gets the raw image bits of the barcode. The image will have to be scaled in the Y direction by yHeight.
      Returns:
      The raw barcode image

    • getBitColumns

      public int getBitColumns()
      Deprecated.
      Gets the number of X pixels of outBits.
      Returns:
      the number of X pixels of outBits

    • getCodeRows

      public int getCodeRows()
      Deprecated.
      Gets the number of Y pixels of outBits. It is also the number of rows in the barcode.
      Returns:
      the number of Y pixels of outBits

    • setCodeRows

      public void setCodeRows(int codeRows)
      Deprecated.
      Sets the number of barcode rows. This number may be changed to keep the barcode valid.
      Parameters:
      codeRows - the number of barcode rows

    • getCodeColumns

      public int getCodeColumns()
      Deprecated.
      Gets the number of barcode data columns.
      Returns:
      he number of barcode data columns

    • setCodeColumns

      public void setCodeColumns(int codeColumns)
      Deprecated.
      Sets the number of barcode data columns. This number may be changed to keep the barcode valid.
      Parameters:
      codeColumns - the number of barcode data columns

    • getCodewords

      public int[] getCodewords()
      Deprecated.
      Gets the codeword array. This array is always 928 elements long. It can be written to if the option PDF417_USE_RAW_CODEWORDS is set.
      Returns:
      the codeword array

    • getLenCodewords

      public int getLenCodewords()
      Deprecated.
      Gets the length of the codewords.
      Returns:
      the length of the codewords

    • setLenCodewords

      public void setLenCodewords(int lenCodewords)
      Deprecated.
      Sets the length of the codewords.
      Parameters:
      lenCodewords - the length of the codewords

    • getErrorLevel

      public int getErrorLevel()
      Deprecated.
      Gets the error level correction used for the barcode. It may different from the previously set value.
      Returns:
      the error level correction used for the barcode

    • setErrorLevel

      public void setErrorLevel(int errorLevel)
      Deprecated.
      Sets the error level correction for the barcode.
      Parameters:
      errorLevel - the error level correction for the barcode

    • getText

      public byte[] getText()
      Deprecated.
      Gets the bytes that form the barcode. This bytes should be interpreted in the codepage Cp437.
      Returns:
      the bytes that form the barcode

    • setText

      public void setText(byte[] text)
      Deprecated.
      Sets the bytes that form the barcode. This bytes should be interpreted in the codepage Cp437.
      Parameters:
      text - the bytes that form the barcode

    • setText

      public void setText(String s)
      Deprecated.
      Sets the text that will form the barcode. This text is converted to bytes using the encoding Cp437.
      Parameters:
      s - the text that will form the barcode

    • getOptions

      public int getOptions()
      Deprecated.
      Gets the options to generate the barcode.
      Returns:
      the options to generate the barcode

    • setOptions

      public void setOptions(int options)
      Deprecated.
      Sets the options to generate the barcode. This can be all the PDF417_* constants.
      Parameters:
      options - the options to generate the barcode

    • getAspectRatio

      public float getAspectRatio()
      Deprecated.
      Gets the barcode aspect ratio.
      Returns:
      the barcode aspect ratio

    • setAspectRatio

      public void setAspectRatio(float aspectRatio)
      Deprecated.
      Sets the barcode aspect ratio. A ratio or 0.5 will make the barcode width twice as large as the height.
      Parameters:
      aspectRatio - the barcode aspect ratio

    • getYHeight

      public float getYHeight()
      Deprecated.
      Gets the Y pixel height relative to X.
      Returns:
      the Y pixel height relative to X

    • setYHeight

      public void setYHeight(float yHeight)
      Deprecated.
      Sets the Y pixel height relative to X. It is usually 3.
      Parameters:
      yHeight - the Y pixel height relative to X