com.cete.dynamicpdf.pageelements.barcoding
Class Aztec

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

All Implemented Interfaces:

ICoordinate

public class Aztec
extends Dim2Barcode

This class can be used to place an Aztec barcode on a page.

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

Aztec(byte[] value, float x, float y, AztecSymbolSize size)
Creates a new instance of Aztec.

Aztec(byte[] value, float x, float y, AztecSymbolSize size, float xDimension)
Creates a new instance of Aztec.

Aztec(java.lang.String value, float x, float y, AztecSymbolSize size)
Creates a new instance of Aztec.

Aztec(java.lang.String value, float x, float y, AztecSymbolSize size, float xDimension)
Creates a new instance of Aztec.

Method Summary

void	draw(PageWriter writer) Draws the Aztec barcode to the given PageWriter object.
boolean	getAllowStructuredAppend() Gets a boolean indicating whether to allow structured append of the overflow barcodes.
int	getErrorCorrection() Gets the error correction value.
boolean	getIsReaderInitializationSymbol() Gets a boolean representing if the barcode is a reader initialization symbol.
java.lang.String	getMessageID() Gets the message id for the overflow barcodes.
Aztec	getOverflowAztec() Returns a new Aztec object.
Aztec	getOverflowAztec(float x, float y) Returns a new Aztec object.
boolean	getProcessTilde() Gets a boolean indicating whether to process tilde symbol in the input.
AztecSymbolSize	getSize() Gets the barcode size.
float	getSymbolHeight() Returns the Height required to display the aztec barcode.
float	getSymbolWidth() Returns the Width required to display the aztec barcode.
java.lang.String	getValue() Gets the barocode value only if the string value is set.
void	setAllowStructuredAppend(boolean value) Sets a boolean indicating whether to allow structured append of the overflow barcodes.
void	setErrorCorrection(int value) Sets the error correction value.
void	setIsReaderInitializationSymbol(boolean value) Sets a boolean representing if the barcode is a reader initialization symbol.
void	setMessageID(java.lang.String value) Sets the message id for the overflow barcodes.
void	setProcessTilde(boolean value) Sets a boolean indicating whether to process tilde symbol in the input.

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

getAngle, getColor, getPixelsPerXDimension, getX, getXDimension, getXDimensionMilliMeters, getXDimensionMils, getXDimensionsPerCentiMeter, getXDimensionsPerInch, getY, setAngle, setColor, setPixelsPerXDimension, setX, setXDimension, setXDimensionMilliMeters, setXDimensionMils, 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

Aztec

public Aztec(java.lang.String value,
             float x,
             float y,
             AztecSymbolSize size,
             float xDimension)

Creates a new instance of Aztec.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

size - The AztecSymbolSize of the barcode.

xDimension - The xDimension of the barcode.

Aztec

public Aztec(java.lang.String value,
             float x,
             float y,
             AztecSymbolSize size)

Creates a new instance of Aztec.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

size - The AztecSymbolSize of the barcode.

Aztec

public Aztec(byte[] value,
             float x,
             float y,
             AztecSymbolSize size,
             float xDimension)

Creates a new instance of Aztec.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

size - The AztecSymbolSize of the barcode.

xDimension - The xDimension of the barcode.

Aztec

public Aztec(byte[] value,
             float x,
             float y,
             AztecSymbolSize size)

Creates a new instance of Aztec.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

size - The AztecSymbolSize of the barcode.

Method Detail

getErrorCorrection

public int getErrorCorrection()

Gets the error correction value.

Returns:

the error correction value.

setErrorCorrection

public void setErrorCorrection(int value)

Sets the error correction value.

Parameters:

value - the error correction value.

getAllowStructuredAppend

public boolean getAllowStructuredAppend()

Gets a boolean indicating whether to allow structured append of the overflow barcodes.

Returns:

a boolean indicating whether to allow structured append of the overflow barcodes.

setAllowStructuredAppend

public void setAllowStructuredAppend(boolean value)

Sets a boolean indicating whether to allow structured append of the overflow barcodes.

Parameters:

value - a boolean indicating whether to allow structured append of the overflow barcodes.

getMessageID

public java.lang.String getMessageID()

Gets the message id for the overflow barcodes.

Returns:

the message id for the overflow barcodes.

setMessageID

public void setMessageID(java.lang.String value)

Sets the message id for the overflow barcodes.

Parameters:

value - the message id for the overflow barcodes.

getSize

public AztecSymbolSize getSize()

Gets the barcode size.

Returns:

the barcode size

getValue

public java.lang.String getValue()

Gets the barocode value only if the string value is set.

Returns:

the barocode value only if the string value is set.

getIsReaderInitializationSymbol

public boolean getIsReaderInitializationSymbol()

Gets a boolean representing if the barcode is a reader initialization symbol.

Returns:

a boolean representing if the barcode is a reader initialization symbol.

setIsReaderInitializationSymbol

public void setIsReaderInitializationSymbol(boolean value)

Sets a boolean representing if the barcode is a reader initialization symbol.

Parameters:

value - a boolean representing if the barcode is a reader initialization symbol.

getProcessTilde

public boolean getProcessTilde()

Gets a boolean indicating whether to process tilde symbol in the input.

Returns:

a boolean indicating whether to process tilde symbol in the input.

setProcessTilde

public void setProcessTilde(boolean value)

Sets a boolean indicating whether to process tilde symbol in the input.

Parameters:

value - a boolean indicating whether to process tilde symbol in the input.

draw

public void draw(PageWriter writer)

Draws the Aztec 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

getOverflowAztec

public Aztec getOverflowAztec()

Returns a new Aztec object. View Example

Returns:

an Aztec object.

getOverflowAztec

public Aztec getOverflowAztec(float x,
                              float y)

Returns a new Aztec object. View Example

Parameters:

x - X coordinate of the new object.

y - Y coordinate of the new object.

Returns:

an Aztec object.

getSymbolWidth

public float getSymbolWidth()

Returns the Width required to display the aztec barcode.

Specified by:

getSymbolWidth in class Dim2Barcode

Returns:

a value representing the required width.

getSymbolHeight

public float getSymbolHeight()

Returns the Height required to display the aztec barcode.

Specified by:

getSymbolHeight in class Dim2Barcode

Returns:

a value representing the required width.