com.cete.dynamicpdf.pageelements.barcoding
Class MacroPdf417

java.lang.Object
  |
  +--com.cete.dynamicpdf.PageElement
        |
        +--com.cete.dynamicpdf.pageelements.barcoding.Dim2Barcode
              |
              +--com.cete.dynamicpdf.pageelements.barcoding.Pdf417
                    |
                    +--com.cete.dynamicpdf.pageelements.barcoding.MacroPdf417

All Implemented Interfaces:

ICoordinate

public class MacroPdf417

extends Pdf417

Represents a MacroPdf417 bar code. This class can be used to generate more than one PDF417 bar codes by taking input from the file.

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

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

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

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

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

Method Summary

void	draw(PageWriter writer) Draws the barcode to the given PageWriter object.
java.lang.String	getAddress() Returns included address in the macro PDF417 bar code.
int	getFileId() Returns included file id in the macro PDF417 bar code.
java.lang.String	getFileName() Returns included file name in macro PDF417 bar code.
MacroPdf417	getOverflowMacroPdf417() Gets a new instance of MacroPdf417 object.
MacroPdf417	getOverflowMacroPdf417(float x, float y) Gets a new instance of MacroPdf417 object.
java.lang.String	getSender() Returns included sender in the macro PDF417 bar code.
float	getSymbolHeight() Gets required height for drawing macro PDF417 bar code.
float	getSymbolWidth() Gets required width for drawing macro PDF417 bar code.
void	includeCheckSum(boolean flag) Specifies whether check sum should be included in macro PDF417 bar code or not.
void	includeFileSize(boolean flag) Specifies whether file size should be included in macro PDF417 bar code or not.
void	includeTimeStamp(boolean flag) Specifies whether time stamp should be included in macro PDF417 bar code or not.
void	setAddress(java.lang.String address) Sets address to be included in the macro PDF417 bar code.
void	setFileId(int fileId) Sets file id to be included in the macro PDF417 bar code.
void	setFileName(java.lang.String fileName) Sets file name to be included in the macro PDF417 bar code.
void	setSender(java.lang.String sender) Sets sender to be included in the macro PDF417 bar code.

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

getCompaction, getCompactPdf417, getErrorCorrectionLevel, getValue, getXDimension, getXDimensionMilliMeters, getXDimensionMils, getXDimensionsPerCentiMeter, getXDimensionsPerInch, getYDimension, getYDimensionMilliMeters, getYDimensionMils, getYDimensionsPerCentiMeter, getYDimensionsPerInch, setCompaction, setCompactPdf417, setErrorCorrection, setValue, setXDimension, setXDimensionMilliMeters, setXDimensionMils, setXDimensionsPerCentiMeter, setXDimensionsPerInch, setYDimension, setYDimensionMilliMeters, setYDimensionMils, setYDimensionsPerCentiMeter, setYDimensionsPerInch

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

getAngle, getColor, getX, getY, setAngle, setColor, setX, setY

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

MacroPdf417

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

Creates a new instance of MacroPdf417.

Parameters:

value - The string to be encoded.

x - The X coordinate of the macro PDF417 bar code.

y - The Y coordinate of the macro PDF417 bar code.

columns - columns of the macro PDF417 bar code.

xDimension - The XDimension of the macro PDF417 bar code.

MacroPdf417

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

Creates a new instance of MacroPdf417.

Parameters:

value - The string to be encoded.

x - The X coordinate of the macro PDF417 bar code.

y - The Y coordinate of the macro PDF417 bar code.

columns - columns of the macro PDF417 bar code.

rows - rows of the macro PDF417 bar code.

xDimension - The XDimension of the macro PDF417 bar code.

MacroPdf417

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

Creates a new instance of MacroPdf417.

Parameters:

value - byte array to be encoded.

x - The X coordinate of the macro PDF417 bar code.

y - The Y coordinate of the macro PDF417 bar code.

columns - columns of the macro PDF417 bar code.

xDimension - The XDimension of the macro PDF417 bar code.

MacroPdf417

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

Creates a new instance of MacroPdf417.

Parameters:

value - byte array to be encoded.

x - The X coordinate of the macro PDF417 bar code.

y - The Y coordinate of the macro PDF417 bar code.

columns - columns of the macro PDF417 bar code.

rows - rows of the macro PDF417 bar code.

xDimension - The XDimension of the macro PDF417 bar code.

Method Detail

getFileName

public java.lang.String getFileName()

Returns included file name in macro PDF417 bar code.

Returns:

file name as a String.

setFileName

public void setFileName(java.lang.String fileName)

Sets file name to be included in the macro PDF417 bar code.

Parameters:

fileName - string file name to be included in macro PDF417 bar code.

getSender

public java.lang.String getSender()

Returns included sender in the macro PDF417 bar code.

Returns:

sender as a String.

setSender

public void setSender(java.lang.String sender)

Sets sender to be included in the macro PDF417 bar code.

Parameters:

sender - string sender to be included in macro PDF417 bar code.

getAddress

public java.lang.String getAddress()

Returns included address in the macro PDF417 bar code.

Returns:

address as a String.

setAddress

public void setAddress(java.lang.String address)

Sets address to be included in the macro PDF417 bar code.

Parameters:

address - string address to be included in macro PDF417 bar code.

includeFileSize

public void includeFileSize(boolean flag)

Specifies whether file size should be included in macro PDF417 bar code or not.

Parameters:

flag - boolean value specifies whether fie size should be included or not in macro PDF417 bar code.

includeCheckSum

public void includeCheckSum(boolean flag)

Specifies whether check sum should be included in macro PDF417 bar code or not.

Parameters:

flag - boolean value specifies whether check sum should be included or not in macro PDF417 bar code.

includeTimeStamp

public void includeTimeStamp(boolean flag)

Specifies whether time stamp should be included in macro PDF417 bar code or not.

Parameters:

flag - boolean value specifies whether time stamp should be included or not in macro PDF417 bar code.

draw

public void draw(PageWriter writer)

Draws the barcode to the given PageWriter object.

Overrides:

draw in class Pdf417

Parameters:

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

See Also:

PageWriter

getSymbolHeight

public float getSymbolHeight()

Gets required height for drawing macro PDF417 bar code.

Overrides:

getSymbolHeight in class Pdf417

Returns:

required height for drawing macro PDF417 bar code.

getSymbolWidth

public float getSymbolWidth()

Gets required width for drawing macro PDF417 bar code.

Overrides:

getSymbolWidth in class Pdf417

Returns:

required width for drawing macro PDF417 bar code.

getFileId

public int getFileId()

Returns included file id in the macro PDF417 bar code.

Returns:

file id as a integer value.

setFileId

public void setFileId(int fileId)

Sets file id to be included in the macro PDF417 bar code.

Parameters:

fileId - int value file id to be included in macro PDF417 bar code.

getOverflowMacroPdf417

public MacroPdf417 getOverflowMacroPdf417()

Gets a new instance of MacroPdf417 object. View Example

Returns:

MacroPdf417 object.

getOverflowMacroPdf417

public MacroPdf417 getOverflowMacroPdf417(float x,
                                          float y)

Gets a new instance of MacroPdf417 object. View Example

Parameters:

x - The X coordinate of the macro PDF417 bar code.

y - The Y coordinate of the macro PDF417 bar code.

Returns:

MacroPdf417 object.