com.cete.dynamicpdf.pageelements.barcoding
Class Pdf417

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.barcoding.Dim2Barcode
              com.cete.dynamicpdf.pageelements.barcoding.Pdf417

All Implemented Interfaces:

ICoordinate

Direct Known Subclasses:

MacroPdf417

public class Pdf417
extends Dim2Barcode

Represents Pdf417 bar code. This class can be used to generate Pdf417 bar code.

Licensing:
This class is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

Pdf417(byte[] value, float x, float y, int columns, float xDimension)
Creates a new instance of Pdf417.

Pdf417(java.lang.String value, float x, float y, int columns, float xDimension)
Creates a new instance of Pdf417.

Method Summary

void	draw(PageWriter writer) Draws the barcode to the given PageWriter object.
Compaction	getCompaction() Gets the type of compaction.
boolean	getCompactPdf417() Gets boolean value true for compact pdf417.
ErrorCorrection	getErrorCorrectionLevel() Gets the error correction level for the PDF417 bar code.
float	getSymbolHeight() Gets required height for drawing PDF417 bar code.
float	getSymbolWidth() Gets required width for drawing PDF417 bar code.
java.lang.String	getValue() Gets the value of the PDF417 barcode.
float	getXDimensionMilliMeters() Gets the XDimensionMilliMeters of the PDF417 barcode.
float	getXDimensionMils() Gets the XDimensionMils of the PDF417 barcode.
float	getYDimension() Gets the YDimension of the PDF417 barcode.
float	getYDimensionMilliMeters() Gets the YDimensionMilliMeters of the PDF417 barcode.
float	getYDimensionMils() Gets the YDimensionMils of the PDF417 barcode.
float	getYDimensionsPerCentiMeter() Gets the YDimensionsPerCentiMeter of the PDF417 barcode.
float	getYDimensionsPerInch() Gets the YDimensionsPerInch of the PDF417 barcode.
void	setCompaction(Compaction value) Sets the type of comapction
void	setCompactPdf417(boolean compact) Sets PDF417 as compact one.
void	setErrorCorrection(ErrorCorrection level) Sets the error correcton level for PDF417 barcode.
void	setValue(java.lang.String value) Sets the value of the PDF417 barcode.
void	setXDimensionMilliMeters(float value) Sets the XDimensionMilliMeters of the PDF417 barcode.
void	setXDimensionMils(float value) Sets the XDimensionMils of the PDF417 barcode.
void	setYDimension(float value) Sets the YDimension of the PDF417 barcode.
void	setYDimensionMilliMeters(float value) Sets the YDimensionMilliMeters of the PDF417 barcode.
void	setYDimensionMils(float value) Sets the YDimensionMils of the PDF417 barcode.
void	setYDimensionsPerCentiMeter(float value) Sets the YDimensionsPerCentiMeter of the PDF417 barcode.
void	setYDimensionsPerInch(float value) Sets the YDimensionsPerInch of the PDF417 barcode.

Methods inherited from class com.cete.dynamicpdf.pageelements.barcoding.Dim2Barcode

getAngle, getColor, getPixelsPerXDimension, getX, getXDimension, getXDimensionsPerCentiMeter, getXDimensionsPerInch, getY, setAngle, setColor, setPixelsPerXDimension, setX, setXDimension, setXDimensionsPerCentiMeter, setXDimensionsPerInch, setY

Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement

getTag, getTagOrder, setTag, setTagOrder

Methods inherited from class com.cete.dynamicpdf.PageElement

getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID

Methods inherited from class java.lang.Object

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

Constructor Detail

Pdf417

public Pdf417(java.lang.String value,
              float x,
              float y,
              int columns,
              float xDimension)

Creates a new instance of Pdf417.

Parameters:

value - The string to be encoded.

x - The X coordinate of the PDF417 bar code.

y - The Y coordinate of the PDF417 bar code.

columns - columns of the PDF417 bar code.

xDimension - The XDimension of the PDF417 bar code.

Pdf417

public Pdf417(byte[] value,
              float x,
              float y,
              int columns,
              float xDimension)

Creates a new instance of Pdf417.

Parameters:

value - byte array to be encoded.

x - The X coordinate of the PDF417 bar code.

y - The Y coordinate of the PDF417 bar code.

columns - columns of the PDF417 bar code.

xDimension - The XDimension of the PDF417 bar code.

Method Detail

getErrorCorrectionLevel

public ErrorCorrection getErrorCorrectionLevel()

Gets the error correction level for the PDF417 bar code.

Returns:

ErrorCorrection object.

See Also:

ErrorCorrection

setErrorCorrection

public void setErrorCorrection(ErrorCorrection level)

Sets the error correcton level for PDF417 barcode.

Throws:

GeneratorException - in case of Data and ErrorCorrection Level mismatch.

Parameters:

level - ErrorCorrection level of the PDF417 bar code.

getCompactPdf417

public boolean getCompactPdf417()

Gets boolean value true for compact pdf417.

Returns:

the boolean value which specifies whether pdf417 bar code is compact or not.

setCompactPdf417

public void setCompactPdf417(boolean compact)

Sets PDF417 as compact one.

Parameters:

compact - the boolean value to be used to set compact pdf417.

draw

public void draw(PageWriter writer)

Draws the barcode to the given PageWriter object.

Specified by:

draw in class Dim2Barcode

Parameters:

writer - PageWriter object to receive the page element's output.

See Also:

PageWriter

getCompaction

public Compaction getCompaction()

Gets the type of compaction.

Returns:

Comapction object.

See Also:

Compaction

setCompaction

public void setCompaction(Compaction value)

Sets the type of comapction

Parameters:

value - Compaction type of compaction to be applied.

See Also:

Compaction

getSymbolHeight

public float getSymbolHeight()

Gets required height for drawing PDF417 bar code.

Specified by:

getSymbolHeight in class Dim2Barcode

Returns:

required height for drawing PDF417 bar code.

getSymbolWidth

public float getSymbolWidth()

Gets required width for drawing PDF417 bar code.

Specified by:

getSymbolWidth in class Dim2Barcode

Returns:

required width for drawing PDF417 bar code.

getValue

public java.lang.String getValue()

Gets the value of the PDF417 barcode.

Returns:

the value of the PDF417 barcode.

setValue

public void setValue(java.lang.String value)

Sets the value of the PDF417 barcode.

Parameters:

value - the value of the PDF417 barcode.

getXDimensionMils

public float getXDimensionMils()

Gets the XDimensionMils of the PDF417 barcode.

Overrides:

getXDimensionMils in class Dim2Barcode

Returns:

the XDimensionMils of the PDF417 barcode.

setXDimensionMils

public void setXDimensionMils(float value)

Sets the XDimensionMils of the PDF417 barcode.

Overrides:

setXDimensionMils in class Dim2Barcode

Parameters:

value - the XDimensionMils of the PDF417 barcode.

getXDimensionMilliMeters

public float getXDimensionMilliMeters()

Gets the XDimensionMilliMeters of the PDF417 barcode.

Overrides:

getXDimensionMilliMeters in class Dim2Barcode

Returns:

the XDimensionMilliMeters of the PDF417 barcode.

setXDimensionMilliMeters

public void setXDimensionMilliMeters(float value)

Sets the XDimensionMilliMeters of the PDF417 barcode.

Overrides:

setXDimensionMilliMeters in class Dim2Barcode

Parameters:

value - the XDimensionMilliMeters of the PDF417 barcode.

getYDimension

public float getYDimension()

Gets the YDimension of the PDF417 barcode.

Returns:

the YDimension of the PDF417 barcode.

setYDimension

public void setYDimension(float value)

Sets the YDimension of the PDF417 barcode.

Parameters:

value - the YDimension of the PDF417 barcode.

getYDimensionsPerInch

public float getYDimensionsPerInch()

Gets the YDimensionsPerInch of the PDF417 barcode.

Returns:

the YDimensionsPerInch of the PDF417 barcode.

setYDimensionsPerInch

public void setYDimensionsPerInch(float value)

Sets the YDimensionsPerInch of the PDF417 barcode.

Parameters:

value - the YDimensionsPerInch of the PDF417 barcode.

getYDimensionsPerCentiMeter

public float getYDimensionsPerCentiMeter()

Gets the YDimensionsPerCentiMeter of the PDF417 barcode.

Returns:

YDimensionsPerCentiMeter of the PDF417 barcode.

setYDimensionsPerCentiMeter

public void setYDimensionsPerCentiMeter(float value)

Sets the YDimensionsPerCentiMeter of the PDF417 barcode.

Parameters:

value - YDimensionsPerCentiMeter of the PDF417 barcode.

getYDimensionMils

public float getYDimensionMils()

Gets the YDimensionMils of the PDF417 barcode.

Returns:

the YDimensionMils of the PDF417 barcode.

setYDimensionMils

public void setYDimensionMils(float value)

Sets the YDimensionMils of the PDF417 barcode.

Parameters:

value - the YDimensionMils of the PDF417 barcode.

getYDimensionMilliMeters

public float getYDimensionMilliMeters()

Gets the YDimensionMilliMeters of the PDF417 barcode.

Returns:

the YDimensionMilliMeters of the PDF417 barcode.

setYDimensionMilliMeters

public void setYDimensionMilliMeters(float value)

Sets the YDimensionMilliMeters of the PDF417 barcode.

Parameters:

value - the YDimensionMilliMeters of the PDF417 barcode.