iText 8.0.5 API
iText.Barcodes.BarcodeEAN Class Reference

The implementation of the barcode EAN. More...

Inheritance diagram for iText.Barcodes.BarcodeEAN:
iText.Barcodes.Barcode1D

Public Member Functions

  BarcodeEAN (PdfDocument document)
  Creates new BarcodeEAN. More...
 
  BarcodeEAN (PdfDocument document, PdfFont font)
  Creates new BarcodeEAN More...
 
override Rectangle  GetBarcodeSize ()
  Gets the maximum area that the barcode and the text, if any, will occupy. More...
 
override Rectangle  PlaceBarcode (PdfCanvas canvas, Color barColor, Color textColor)
  Places the barcode in a PdfCanvas. More...
 
- Public Member Functions inherited from iText.Barcodes.Barcode1D
virtual float  GetX ()
  Gets the minimum bar width. More...
 
virtual void  SetX (float x)
  Sets the minimum bar width. More...
 
virtual float  GetN ()
  Gets the bar multiplier for wide bars. More...
 
virtual void  SetN (float n)
  Sets the bar multiplier for wide bars. More...
 
virtual PdfFont  GetFont ()
  Gets the text font. More...
 
virtual void  SetFont (PdfFont font)
  Sets the text font. More...
 
virtual float  GetSize ()
  Gets the size of the text. More...
 
virtual void  SetSize (float size)
  Sets the size of the text. More...
 
virtual float  GetBaseline ()
  Gets the text baseline. More...
 
virtual void  SetBaseline (float baseline)
  Sets the text baseline. More...
 
virtual float  GetBarHeight ()
  Gets the height of the bars. More...
 
virtual void  SetBarHeight (float barHeight)
  Sets the height of the bars. More...
 
virtual int  GetTextAlignment ()
  Gets the text alignment. More...
 
virtual void  SetTextAlignment (int textAlignment)
  Sets the text alignment. More...
 
virtual bool  IsGenerateChecksum ()
  Gets the optional checksum generation. More...
 
virtual void  SetGenerateChecksum (bool generateChecksum)
  Setter for property generateChecksum. More...
 
virtual bool  IsChecksumText ()
  Gets the property to show the generated checksum in the the text. More...
 
virtual void  SetChecksumText (bool checksumText)
  Sets the property to show the generated checksum in the the text. More...
 
virtual bool  IsStartStopText ()
  Sets the property to show the start and stop character '*' in the text for the barcode 39. More...
 
virtual void  SetStartStopText (bool startStopText)
  Gets the property to show the start and stop character '*' in the text for the barcode 39. More...
 
virtual bool  IsExtended ()
  Gets the property to generate extended barcode 39. More...
 
virtual void  SetExtended (bool extended)
  Sets the property to generate extended barcode 39. More...
 
virtual String  GetCode ()
  Gets the code to generate. More...
 
virtual void  SetCode (String code)
  Sets the code to generate. More...
 
virtual bool  IsGuardBars ()
  Gets the property to show the guard bars for barcode EAN. More...
 
virtual void  SetGuardBars (bool guardBars)
  Sets the property to show the guard bars for barcode EAN. More...
 
virtual int  GetCodeType ()
  Gets the code type. More...
 
virtual void  SetCodeType (int codeType)
  Sets the code type. More...
 
virtual float  GetInkSpreading ()
  Gets the amount of ink spreading. More...
 
virtual void  SetInkSpreading (float inkSpreading)
  Sets the amount of ink spreading. More...
 
virtual String  GetAltText ()
  Gets the alternate text. More...
 
virtual void  SetAltText (String altText)
  Sets the alternate text. More...
 
virtual PdfFormXObject  CreateFormXObject (PdfDocument document)
  Creates a PdfFormXObject with the barcode. More...
 
virtual PdfFormXObject  CreateFormXObject (Color barColor, Color textColor, PdfDocument document)
  Creates a PdfFormXObject with the barcode. More...
 
virtual void  FitWidth (float width)
  Make the barcode occupy the specified width. More...
 

Static Public Member Functions

static int  CalculateEANParity (String code)
  Calculates the EAN parity character. More...
 
static String  ConvertUPCAtoUPCE (String text)
  Converts an UPCA code into an UPCE code. More...
 
static byte[]  GetBarsEAN13 (String _code)
  Creates the bars for the barcode EAN13 and UPCA. More...
 
static byte[]  GetBarsEAN8 (String _code)
  Creates the bars for the barcode EAN8. More...
 
static byte[]  GetBarsUPCE (String _code)
  Creates the bars for the barcode UPCE. More...
 
static byte[]  GetBarsSupplemental2 (String _code)
  Creates the bars for the barcode supplemental 2. More...
 
static byte[]  GetBarsSupplemental5 (String _code)
  Creates the bars for the barcode supplemental 5. More...
 

Static Public Attributes

const int  EAN13 = 1
  A type of barcode More...
 
const int  EAN8 = 2
  A type of barcode More...
 
const int  UPCA = 3
  A type of barcode More...
 
const int  UPCE = 4
  A type of barcode More...
 
const int  SUPP2 = 5
  A type of barcode More...
 
const int  SUPP5 = 6
  A type of barcode More...
 
- Static Public Attributes inherited from iText.Barcodes.Barcode1D
const int  ALIGN_LEFT = 1
  Constant that defines left alignment. More...
 
const int  ALIGN_RIGHT = 2
  Constant that defines right alignment. More...
 
const int  ALIGN_CENTER = 3
  Constant that defines center alignment. More...
 

Additional Inherited Members

- Package Functions inherited from iText.Barcodes.Barcode1D
  Barcode1D (PdfDocument document)
  Creates new Barcode1D instance. More...
 
virtual float  GetDescender ()
  Gets the descender value of the font. More...
 
- Package Attributes inherited from iText.Barcodes.Barcode1D
PdfDocument  document
 
float  x
  The minimum bar width. More...
 
float  n
  The bar multiplier for wide bars or the distance between bars for Postnet and Planet. More...
 
PdfFont  font
  The text font. More...
 
float  size
  The size of the text or the height of the shorter bar in Postnet. More...
 
float  baseline
  If positive, the text distance under the bars. More...
 
float  barHeight
  The height of the bars. More...
 
int  textAlignment
  The text alignment. More...
 
bool  generateChecksum
  The optional checksum generation. More...
 
bool  checksumText
  Shows the generated checksum in the the text. More...
 
bool  startStopText
  Show the start and stop character '*' in the text for the barcode 39 or 'ABCD' for codabar. More...
 
bool  extended
  Generates extended barcode 39. More...
 
String  code = ""
  The code to generate. More...
 
bool  guardBars
  Show the guard bars for barcode EAN. More...
 
int  codeType
  The code type. More...
 
float  inkSpreading = 0
  The ink spreading. More...
 
String  altText
  The alternate text to be used, if present. More...
 

Detailed Description

The implementation of the barcode EAN.

The implementation of the barcode EAN.

The International Article Number (also known as European Article Number or EAN) is a standard describing a barcode symbology and numbering system used in global trade to identify a specific retail product type, in a specific packaging configuration, from a specific manufacturer

Constructor & Destructor Documentation

◆ BarcodeEAN() [1/2]

iText.Barcodes.BarcodeEAN.BarcodeEAN ( PdfDocument  document )
inline

Creates new BarcodeEAN.

Creates new BarcodeEAN. To generate the font the iText.Kernel.Pdf.PdfDocument.GetDefaultFont() will be implicitly called. If you want to use this barcode in PDF/A documents, please consider using BarcodeEAN(iText.Kernel.Pdf.PdfDocument, iText.Kernel.Font.PdfFont).

Parameters
document The document to which the barcode will be added

◆ BarcodeEAN() [2/2]

iText.Barcodes.BarcodeEAN.BarcodeEAN ( PdfDocument  document,
PdfFont  font 
)
inline

Creates new BarcodeEAN

Parameters
document The document to which the barcode will be added
font The font to use

Member Function Documentation

◆ CalculateEANParity()

static int iText.Barcodes.BarcodeEAN.CalculateEANParity ( String  code )
inlinestatic

Calculates the EAN parity character.

Parameters
code the code
Returns
the parity character

◆ ConvertUPCAtoUPCE()

static String iText.Barcodes.BarcodeEAN.ConvertUPCAtoUPCE ( String  text )
inlinestatic

Converts an UPCA code into an UPCE code.

Converts an UPCA code into an UPCE code. If the code can not be converted a null is returned.

Parameters
text the code to convert. It must have 12 numeric characters
Returns
the 8 converted digits or null if the code could not be converted

◆ GetBarcodeSize()

override Rectangle iText.Barcodes.BarcodeEAN.GetBarcodeSize ( )
inlinevirtual

Gets the maximum area that the barcode and the text, if any, will occupy.

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.

Implements iText.Barcodes.Barcode1D.

◆ GetBarsEAN13()

static byte [] iText.Barcodes.BarcodeEAN.GetBarsEAN13 ( String  _code )
inlinestatic

Creates the bars for the barcode EAN13 and UPCA.

Parameters
_code the text with 13 digits
Returns
the barcode

◆ GetBarsEAN8()

static byte [] iText.Barcodes.BarcodeEAN.GetBarsEAN8 ( String  _code )
inlinestatic

Creates the bars for the barcode EAN8.

Parameters
_code the text with 8 digits
Returns
the barcode

◆ GetBarsSupplemental2()

static byte [] iText.Barcodes.BarcodeEAN.GetBarsSupplemental2 ( String  _code )
inlinestatic

Creates the bars for the barcode supplemental 2.

Parameters
_code the text with 2 digits
Returns
the barcode

◆ GetBarsSupplemental5()

static byte [] iText.Barcodes.BarcodeEAN.GetBarsSupplemental5 ( String  _code )
inlinestatic

Creates the bars for the barcode supplemental 5.

Parameters
_code the text with 5 digits
Returns
the barcode

◆ GetBarsUPCE()

static byte [] iText.Barcodes.BarcodeEAN.GetBarsUPCE ( String  _code )
inlinestatic

Creates the bars for the barcode UPCE.

Parameters
_code the text with 8 digits
Returns
the barcode

◆ PlaceBarcode()

override Rectangle iText.Barcodes.BarcodeEAN.PlaceBarcode ( PdfCanvas  canvas,
Color  barColor,
Color  textColor 
)
inlinevirtual

Places the barcode in a PdfCanvas.

Places the barcode in a PdfCanvas. 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:

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
canvas the PdfCanvas 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

Implements iText.Barcodes.Barcode1D.

Member Data Documentation

◆ EAN13

const int iText.Barcodes.BarcodeEAN.EAN13 = 1
static

A type of barcode

◆ EAN8

const int iText.Barcodes.BarcodeEAN.EAN8 = 2
static

A type of barcode

◆ SUPP2

const int iText.Barcodes.BarcodeEAN.SUPP2 = 5
static

A type of barcode

◆ SUPP5

const int iText.Barcodes.BarcodeEAN.SUPP5 = 6
static

A type of barcode

◆ UPCA

const int iText.Barcodes.BarcodeEAN.UPCA = 3
static

A type of barcode

◆ UPCE

const int iText.Barcodes.BarcodeEAN.UPCE = 4
static

A type of barcode