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

Class Barcode

java.lang.Object
com.lowagie.text.pdf.Barcode
Direct Known Subclasses:
Barcode128, Barcode39, BarcodeCodabar, BarcodeEAN, BarcodeEANSUPP, BarcodeInter25, BarcodePostnet
@Deprecated public abstract class Barcode extends Object
Deprecated.
Base class containing properties and methods common to all barcode types.
Author:
Paulo Soares (psoares@consiste.pt)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    altText
    Deprecated.
    The alternate text to be used, if present.
    protected float
    barHeight
    Deprecated.
    The height of the bars.
    protected float
    baseline
    Deprecated.
    If positive, the text distance under the bars.
    protected boolean
    checksumText
    Deprecated.
    Shows the generated checksum in the the text.
    static final int
    CODABAR
    Deprecated.
    A type of barcode
    protected String
    code
    Deprecated.
    The code to generate.
    static final int
    CODE128
    Deprecated.
    A type of barcode
    static final int
    CODE128_RAW
    Deprecated.
    A type of barcode
    static final int
    CODE128_UCC
    Deprecated.
    A type of barcode
    protected int
    codeType
    Deprecated.
    The code type.
    static final int
    EAN13
    Deprecated.
    A type of barcode
    static final int
    EAN8
    Deprecated.
    A type of barcode
    protected boolean
    extended
    Deprecated.
    Generates extended barcode 39.
    protected BaseFont
    font
    Deprecated.
    The text font.
    protected boolean
    generateChecksum
    Deprecated.
    The optional checksum generation.
    protected boolean
    guardBars
    Deprecated.
    Show the guard bars for barcode EAN.
    protected float
    inkSpreading
    Deprecated.
    The ink spreading.
    protected float
    n
    Deprecated.
    The bar multiplier for wide bars or the distance between bars for Postnet and Planet.
    static final int
    PLANET
    Deprecated.
    A type of barcode
    static final int
    POSTNET
    Deprecated.
    A type of barcode
    protected float
    size
    Deprecated.
    The size of the text or the height of the shorter bar in Postnet.
    protected boolean
    startStopText
    Deprecated.
    Show the start and stop character '*' in the text for the barcode 39 or 'ABCD' for codabar.
    static final int
    SUPP2
    Deprecated.
    A type of barcode
    static final int
    SUPP5
    Deprecated.
    A type of barcode
    protected int
    textAlignment
    Deprecated.
    The text alignment.
    static final int
    UPCA
    Deprecated.
    A type of barcode
    static final int
    UPCE
    Deprecated.
    A type of barcode
    protected float
    x
    Deprecated.
    The minimum bar width.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Barcode()
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract Image
    createAwtImage(Color foreground, Color background)
    Deprecated.
    Creates a java.awt.Image.
    Image
    createImageWithBarcode(PdfContentByte cb, Color barColor, Color textColor)
    Deprecated.
    Creates an Image with the barcode.
    PdfTemplate
    createTemplateWithBarcode(PdfContentByte cb, Color barColor, Color textColor)
    Deprecated.
    Creates a template with the barcode.
    String
    getAltText()
    Deprecated.
    Gets the alternate text.
    abstract Rectangle
    getBarcodeSize()
    Deprecated.
    Gets the maximum area that the barcode and the text, if any, will occupy.
    float
    getBarHeight()
    Deprecated.
    Gets the height of the bars.
    float
    getBaseline()
    Deprecated.
    Gets the text baseline.
    String
    getCode()
    Deprecated.
    Gets the code to generate.
    int
    getCodeType()
    Deprecated.
    Gets the code type.
    BaseFont
    getFont()
    Deprecated.
    Gets the text font.
    float
    getInkSpreading()
    Deprecated.
    Gets the amount of ink spreading.
    float
    getN()
    Deprecated.
    Gets the bar multiplier for wide bars.
    float
    getSize()
    Deprecated.
    Gets the size of the text.
    int
    getTextAlignment()
    Deprecated.
    Gets the text alignment.
    float
    getX()
    Deprecated.
    Gets the minimum bar width.
    boolean
    isChecksumText()
    Deprecated.
    Gets the property to show the generated checksum in the the text.
    boolean
    isExtended()
    Deprecated.
    Gets the property to generate extended barcode 39.
    boolean
    isGenerateChecksum()
    Deprecated.
    Gets the optional checksum generation.
    boolean
    isGuardBars()
    Deprecated.
    Gets the property to show the guard bars for barcode EAN.
    boolean
    isStartStopText()
    Deprecated.
    Sets the property to show the start and stop character '*' in the text for the barcode 39.
    abstract Rectangle
    placeBarcode(PdfContentByte cb, Color barColor, Color textColor)
    Deprecated.
    Places the barcode in a PdfContentByte.
    void
    setAltText(String altText)
    Deprecated.
    Sets the alternate text.
    void
    setBarHeight(float barHeight)
    Deprecated.
    Sets the height of the bars.
    void
    setBaseline(float baseline)
    Deprecated.
    Sets the text baseline.
    void
    setChecksumText(boolean checksumText)
    Deprecated.
    Sets the property to show the generated checksum in the the text.
    void
    setCode(String code)
    Deprecated.
    Sets the code to generate.
    void
    setCodeType(int codeType)
    Deprecated.
    Sets the code type.
    void
    setExtended(boolean extended)
    Deprecated.
    Sets the property to generate extended barcode 39.
    void
    setFont(BaseFont font)
    Deprecated.
    Sets the text font.
    void
    setGenerateChecksum(boolean generateChecksum)
    Deprecated.
    Setter for property generateChecksum.
    void
    setGuardBars(boolean guardBars)
    Deprecated.
    Sets the property to show the guard bars for barcode EAN.
    void
    setInkSpreading(float inkSpreading)
    Deprecated.
    Sets the amount of ink spreading.
    void
    setN(float n)
    Deprecated.
    Sets the bar multiplier for wide bars.
    void
    setSize(float size)
    Deprecated.
    Sets the size of the text.
    void
    setStartStopText(boolean startStopText)
    Deprecated.
    Gets the property to show the start and stop character '*' in the text for the barcode 39.
    void
    setTextAlignment(int textAlignment)
    Deprecated.
    Sets the text alignment.
    void
    setX(float x)
    Deprecated.
    Sets the minimum bar width.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • EAN13

      public static final int EAN13
      Deprecated.
      A type of barcode
      See Also:

    • EAN8

      public static final int EAN8
      Deprecated.
      A type of barcode
      See Also:

    • UPCA

      public static final int UPCA
      Deprecated.
      A type of barcode
      See Also:

    • UPCE

      public static final int UPCE
      Deprecated.
      A type of barcode
      See Also:

    • SUPP2

      public static final int SUPP2
      Deprecated.
      A type of barcode
      See Also:

    • SUPP5

      public static final int SUPP5
      Deprecated.
      A type of barcode
      See Also:

    • POSTNET

      public static final int POSTNET
      Deprecated.
      A type of barcode
      See Also:

    • PLANET

      public static final int PLANET
      Deprecated.
      A type of barcode
      See Also:

    • CODE128

      public static final int CODE128
      Deprecated.
      A type of barcode
      See Also:

    • CODE128_UCC

      public static final int CODE128_UCC
      Deprecated.
      A type of barcode
      See Also:

    • CODE128_RAW

      public static final int CODE128_RAW
      Deprecated.
      A type of barcode
      See Also:

    • CODABAR

      public static final int CODABAR
      Deprecated.
      A type of barcode
      See Also:

    • x

      protected float x
      Deprecated.
      The minimum bar width.

    • n

      protected float n
      Deprecated.
      The bar multiplier for wide bars or the distance between bars for Postnet and Planet.

    • font

      protected BaseFont font
      Deprecated.
      The text font. null if no text.

    • size

      protected float size
      Deprecated.
      The size of the text or the height of the shorter bar in Postnet.

    • baseline

      protected float baseline
      Deprecated.
      If positive, the text distance under the bars. If zero or negative, the text distance above the bars.

    • barHeight

      protected float barHeight
      Deprecated.
      The height of the bars.

    • textAlignment

      protected int textAlignment
      Deprecated.
      The text alignment. Can be Element.ALIGN_LEFT, Element.ALIGN_CENTER or Element.ALIGN_RIGHT.

    • generateChecksum

      protected boolean generateChecksum
      Deprecated.
      The optional checksum generation.

    • checksumText

      protected boolean checksumText
      Deprecated.
      Shows the generated checksum in the the text.

    • startStopText

      protected boolean startStopText
      Deprecated.
      Show the start and stop character '*' in the text for the barcode 39 or 'ABCD' for codabar.

    • extended

      protected boolean extended
      Deprecated.
      Generates extended barcode 39.

    • code

      protected String code
      Deprecated.
      The code to generate.

    • guardBars

      protected boolean guardBars
      Deprecated.
      Show the guard bars for barcode EAN.

    • codeType

      protected int codeType
      Deprecated.
      The code type.

    • inkSpreading

      protected float inkSpreading
      Deprecated.
      The ink spreading.

    • altText

      protected String altText
      Deprecated.
      The alternate text to be used, if present.

  • Constructor Details

    • Barcode

      public Barcode()
      Deprecated.

  • Method Details

    • getX

      public float getX()
      Deprecated.
      Gets the minimum bar width.
      Returns:
      the minimum bar width

    • setX

      public void setX(float x)
      Deprecated.
      Sets the minimum bar width.
      Parameters:
      x - the minimum bar width

    • getN

      public float getN()
      Deprecated.
      Gets the bar multiplier for wide bars.
      Returns:
      the bar multiplier for wide bars

    • setN

      public void setN(float n)
      Deprecated.
      Sets the bar multiplier for wide bars.
      Parameters:
      n - the bar multiplier for wide bars

    • getFont

      public BaseFont getFont()
      Deprecated.
      Gets the text font. null if no text.
      Returns:
      the text font. null if no text

    • setFont

      public void setFont(BaseFont font)
      Deprecated.
      Sets the text font.
      Parameters:
      font - the text font. Set to null to suppress any text

    • getSize

      public float getSize()
      Deprecated.
      Gets the size of the text.
      Returns:
      the size of the text

    • setSize

      public void setSize(float size)
      Deprecated.
      Sets the size of the text.
      Parameters:
      size - the size of the text

    • getBaseline

      public float getBaseline()
      Deprecated.
      Gets the text baseline. If positive, the text distance under the bars. If zero or negative, the text distance above the bars.
      Returns:
      the baseline.

    • setBaseline

      public void setBaseline(float baseline)
      Deprecated.
      Sets the text baseline. If positive, the text distance under the bars. If zero or negative, the text distance above the bars.
      Parameters:
      baseline - the baseline.

    • getBarHeight

      public float getBarHeight()
      Deprecated.
      Gets the height of the bars.
      Returns:
      the height of the bars

    • setBarHeight

      public void setBarHeight(float barHeight)
      Deprecated.
      Sets the height of the bars.
      Parameters:
      barHeight - the height of the bars

    • getTextAlignment

      public int getTextAlignment()
      Deprecated.
      Gets the text alignment. Can be Element.ALIGN_LEFT, Element.ALIGN_CENTER or Element.ALIGN_RIGHT.
      Returns:
      the text alignment

    • setTextAlignment

      public void setTextAlignment(int textAlignment)
      Deprecated.
      Sets the text alignment. Can be Element.ALIGN_LEFT, Element.ALIGN_CENTER or Element.ALIGN_RIGHT.
      Parameters:
      textAlignment - the text alignment

    • isGenerateChecksum

      public boolean isGenerateChecksum()
      Deprecated.
      Gets the optional checksum generation.
      Returns:
      the optional checksum generation

    • setGenerateChecksum

      public void setGenerateChecksum(boolean generateChecksum)
      Deprecated.
      Setter for property generateChecksum.
      Parameters:
      generateChecksum - New value of property generateChecksum.

    • isChecksumText

      public boolean isChecksumText()
      Deprecated.
      Gets the property to show the generated checksum in the the text.
      Returns:
      value of property checksumText

    • setChecksumText

      public void setChecksumText(boolean checksumText)
      Deprecated.
      Sets the property to show the generated checksum in the the text.
      Parameters:
      checksumText - new value of property checksumText

    • isStartStopText

      public boolean isStartStopText()
      Deprecated.
      Sets the property to show the start and stop character '*' in the text for the barcode 39.
      Returns:
      value of property startStopText

    • setStartStopText

      public void setStartStopText(boolean startStopText)
      Deprecated.
      Gets the property to show the start and stop character '*' in the text for the barcode 39.
      Parameters:
      startStopText - new value of property startStopText

    • isExtended

      public boolean isExtended()
      Deprecated.
      Gets the property to generate extended barcode 39.
      Returns:
      value of property extended.

    • setExtended

      public void setExtended(boolean extended)
      Deprecated.
      Sets the property to generate extended barcode 39.
      Parameters:
      extended - new value of property extended

    • getCode

      public String getCode()
      Deprecated.
      Gets the code to generate.
      Returns:
      the code to generate

    • setCode

      public void setCode(String code)
      Deprecated.
      Sets the code to generate.
      Parameters:
      code - the code to generate

    • isGuardBars

      public boolean isGuardBars()
      Deprecated.
      Gets the property to show the guard bars for barcode EAN.
      Returns:
      value of property guardBars

    • setGuardBars

      public void setGuardBars(boolean guardBars)
      Deprecated.
      Sets the property to show the guard bars for barcode EAN.
      Parameters:
      guardBars - new value of property guardBars

    • getCodeType

      public int getCodeType()
      Deprecated.
      Gets the code type.
      Returns:
      the code type

    • setCodeType

      public void setCodeType(int codeType)
      Deprecated.
      Sets the code type.
      Parameters:
      codeType - the code type

    • getBarcodeSize

      public abstract Rectangle getBarcodeSize()
      Deprecated.
      Gets the maximum area that the barcode and the text, if any, will occupy. The lower left corner is always (0, 0).
      Returns:
      the size the barcode occupies.

    • placeBarcode

      public abstract Rectangle placeBarcode(PdfContentByte cb, Color barColor, Color textColor)
      Deprecated.
      Places the barcode in a PdfContentByte. The barcode is always placed at coordinates (0, 0). Use the translation matrix to move it elsewhere.

      The bars and text are written in the following colors:

      table of the colors of the bars and text

      barColor

      textColor

      Result

      null

      null

      bars and text painted with current fill color

      barColor

      null

      bars and text painted with barColor

      null

      textColor

      bars painted with current color
      text painted with textColor

      barColor

      textColor

      bars painted with barColor
      text painted with textColor
      Parameters:
      cb - the PdfContentByte where the barcode will be placed
      barColor - the color of the bars. It can be null
      textColor - the color of the text. It can be null
      Returns:
      the dimensions the barcode occupies

    • createTemplateWithBarcode

      public PdfTemplate createTemplateWithBarcode(PdfContentByte cb, Color barColor, Color textColor)
      Deprecated.
      Creates a template with the barcode.
      Parameters:
      cb - the PdfContentByte to create the template. It serves no other use
      barColor - the color of the bars. It can be null
      textColor - the color of the text. It can be null
      Returns:
      the template
      See Also:

    • createImageWithBarcode

      public Image createImageWithBarcode(PdfContentByte cb, Color barColor, Color textColor)
      Deprecated.
      Creates an Image with the barcode.
      Parameters:
      cb - the PdfContentByte to create the Image. It serves no other use
      barColor - the color of the bars. It can be null
      textColor - the color of the text. It can be null
      Returns:
      the Image
      See Also:

    • createAwtImage

      public abstract Image createAwtImage(Color foreground, Color background)
      Deprecated.
      Creates a java.awt.Image. This image only contains the bars without any text.
      Parameters:
      foreground - the color of the bars
      background - the color of the background
      Returns:
      the image

    • getInkSpreading

      public float getInkSpreading()
      Deprecated.
      Gets the amount of ink spreading.
      Returns:
      the ink spreading

    • setInkSpreading

      public void setInkSpreading(float inkSpreading)
      Deprecated.
      Sets the amount of ink spreading. This value will be subtracted to the width of each bar. The actual value will depend on the ink and the printing medium.
      Parameters:
      inkSpreading - the ink spreading

    • getAltText

      public String getAltText()
      Deprecated.
      Gets the alternate text.
      Returns:
      the alternate text

    • setAltText

      public void setAltText(String altText)
      Deprecated.
      Sets the alternate text. If present, this text will be used instead of the text derived from the supplied code.
      Parameters:
      altText - the alternate text