Package com.dynamicpdf.api.elements

Class AztecBarcodeElement

java.lang.Object

com.dynamicpdf.api.elements.Element

com.dynamicpdf.api.elements.BarcodeElement

com.dynamicpdf.api.elements.Dim2BarcodeElement

com.dynamicpdf.api.elements.AztecBarcodeElement

public class AztecBarcodeElement
extends Dim2BarcodeElement

Represents an Aztec barcode element.

With some of the .Net runtimes (example: .Net Core 2.0) the ECI values 20, 28, 29 and 30 will give the error "No data is available for encoding 'code page number'. For information on defining a custom encoding, see the documentation for the Encoding.RegisterProvider method.".

Constructor Summary

Constructors

Constructor	Description
AztecBarcodeElement(byte[] value, ElementPlacement placement)	Initializes a new instance of the AztecBarcodeElement class.
AztecBarcodeElement(byte[] value, ElementPlacement placement, float xOffset, float yOffset)	Initializes a new instance of the AztecBarcodeElement class.
AztecBarcodeElement(String value, ElementPlacement placement)	Initializes a new instance of the AztecBarcodeElement class.
AztecBarcodeElement(String value, ElementPlacement placement, float xOffset, float yOffset)	Initializes a new instance of the AztecBarcodeElement class.

Method Summary

Modifier and Type	Method	Description
int	getAztecErrorCorrection()	Gets the error correction value.
boolean	getProcessTilde()	Gets a boolean indicating whether to process tilde symbol in the input.
boolean	getReaderInitializationSymbol()	Gets a boolean representing if the barcode is a reader initialization symbol.
AztecSymbolSize	getSymbolSize()	Gets the barcode size, @see AztecSymbolSize.
void	setAztecErrorCorrection(int value)	Sets the error correction value.
void	setProcessTilde(boolean value)	Sets a boolean indicating whether to process tilde symbol in the input.
void	setReaderInitializationSymbol(boolean value)	Sets a boolean representing if the barcode is a reader initialization symbol.
void	setSymbolSize(AztecSymbolSize value)	Sets the barcode size, @see AztecSymbolSize.

Methods inherited from class com.dynamicpdf.api.elements.BarcodeElement

getColor, getValue, getXDimension, setColor, setValue, setXDimension

Methods inherited from class com.dynamicpdf.api.elements.Element

getEvenPages, getOddPages, getPlacement, getResource, getTextFont, getXOffset, getYOffset, setEvenPages, setOddPages, setPlacement, setXOffset, setYOffset

Methods inherited from class java.lang.Object

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

Constructor Details

AztecBarcodeElement

public AztecBarcodeElement(String value,
 ElementPlacement placement,
 float xOffset,
 float yOffset)

Initializes a new instance of the AztecBarcodeElement class.

Parameters:

value - The value of the barcode.

placement - The placement of the barcode on the page.

xOffset - The X coordinate of the barcode.

yOffset - The Y coordinate of the barcode.

AztecBarcodeElement

public AztecBarcodeElement(String value,
 ElementPlacement placement)

Initializes a new instance of the AztecBarcodeElement class.

Parameters:

value - The value of the barcode.

placement - The placement of the barcode on the page.

AztecBarcodeElement

public AztecBarcodeElement(byte[] value,
 ElementPlacement placement,
 float xOffset,
 float yOffset)

Initializes a new instance of the AztecBarcodeElement class.

Parameters:

value - The value of the barcode.

placement - The placement of the barcode on the page.

xOffset - The X coordinate of the barcode.

yOffset - The Y coordinate of the barcode.

AztecBarcodeElement

public AztecBarcodeElement(byte[] value,
 ElementPlacement placement)

Initializes a new instance of the AztecBarcodeElement class.

Parameters:

value - The value of the barcode.

placement - The placement of the barcode on the page.

Method Details

getProcessTilde

public boolean getProcessTilde()

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

Setting true will check for ~ character and processes it for FNC1 or ECI characters.

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.

Setting true will check for ~ character and processes it for FNC1 or ECI characters.

Parameters:

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

getSymbolSize

public AztecSymbolSize getSymbolSize()

Gets the barcode size, @see AztecSymbolSize.

Returns:

The barcode size, @see AztecSymbolSize.

setSymbolSize

public void setSymbolSize(AztecSymbolSize value)

Sets the barcode size, @see AztecSymbolSize.

Parameters:

value - The barcode size, @see AztecSymbolSize.

getAztecErrorCorrection

public int getAztecErrorCorrection()

Gets the error correction value.

Error correction value may be between 5% to 95%.

Returns:

The error correction value.

setAztecErrorCorrection

public void setAztecErrorCorrection(int value)

Sets the error correction value.

Error correction value may be between 5% to 95%.

Parameters:

value - The error correction value.

getReaderInitializationSymbol

public boolean getReaderInitializationSymbol()

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

Setting true will mark the symbol as reader initialization symbol and the size of the symbol should be one of the following, R15xC15 Compact, R19xC19, R23xC23, R27xC27, R31xC31, R37xC37, R41xC41, R45xC45, R49xC49, R53xC53, R57xC57, R61xC61, R67xC67, R71xC71, R75xC75, R79xC79, R83xC83, R87xC87, R91xC91, R95xC95, R101xC101, R105xC105, R109xC109, however it is recommended to set Auto.

Returns:

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

setReaderInitializationSymbol

public void setReaderInitializationSymbol(boolean value)

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

Setting true will mark the symbol as reader initialization symbol and the size of the symbol should be one of the following, R15xC15 Compact, R19xC19, R23xC23, R27xC27, R31xC31, R37xC37, R41xC41, R45xC45, R49xC49, R53xC53, R57xC57, R61xC61, R67xC67, R71xC71, R75xC75, R79xC79, R83xC83, R87xC87, R91xC91, R95xC95, R101xC101, R105xC105, R109xC109, however it is recommended to set Auto.

Parameters:

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