Package com.idautomation.aztec

Class Aztec

java.lang.Object

java.awt.Component

java.awt.Canvas

com.idautomation.aztec.Aztec

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class Aztec
extends Canvas
implements Serializable

This is the main Aztec class that generates the Aztec barcode image.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field	Description
boolean	applyTilde	If true, ("Y") the tilde (~) will be processed according to the rules in the Aztec section of the user guide.
boolean	autoSize	If true, will automatically size the control canvas to fit the barcode at design or runtime; Default =True.
Color	backColor	Background color.
Color	barColor	Color of the modules.
String	code	Data to be painted in a Aztec symbol.
String	codeApp	Optional null-terminated ID field for Append.
int	dotPixels
int	ecl	Error correction Level, 0 = default error correction level; 01 to 99 = minimum error correction percentage; 101 to 104 = 1 to 4-layer Compact symbol; 201 to 232 = 1 to 32-layer Full-Range symbol; 300 = a simple Aztec "Rune"
int	height	Initial preferred height property of the bean
double	leftMarginCM	The left margin of the barcode (also know as quiet zone); The default is .06 CM.
int	numOfSym	Invokes message append across symbols the number of symbols specified.
int	pHeight	The preferred height of the barcode image in pixels after barcode is generated.
int	pWidth	The preferred width of the barcode image in pixels after barcode is generated.
boolean	readerInit	Adds the reader initialization symbol to the barcode for older scanners, which require it.
boolean	reBuild
int	resolution	The resolution used to create the X dimension and other measurements in pixels; Default is 38 Pixels Per CM which is about 96 DPI.
int	rotate	Rotation angle; valid values are 0 (default), 90, 180 & 270.
double	topMarginCM	The top margin of the barcode (also know as quiet zone); The default is .06 CM.
int	width	Initial preferred width property of the bean
double	X	The size in CM of modules, default is .06; usually adjustable in increments of .03CM because (X * resolution) is used to convert to pixels; use setPixelsPerCM to change; if X * resolution = < 1, X will be set to one pixel.

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
Aztec()

Method Summary

Modifier and Type	Method	Description
String	createEPS()
String	createSVG()
boolean	getApplyTilde()	Gets applyTilde the property.
boolean	getAutoSize()	Gets the autoSize property.
Color	getBackground()	Gets the backColor property.
String	getDataToEncode()	Gets the code property.
int	getErrorCorrectionLevel()	Gets the ecl property.
Color	getForeground()	Gets the barColor property.
double	getLeftMarginCM()	Gets the leftMarginCM property.
String	getMessageAppend()	Gets the codeApp property.
Dimension	getMinimumSize()	Gets the minimum size in pixels of the barcode image generated.
int	getNumberOfSymbols()	Gets the numOfSym property.
int	getPixelsPerCM()	Gets the resolution property.
Dimension	getPreferredSize()	Returns the size in pixels appropriate for the generated image after it is generated.
boolean	getReaderInitialization()	Gets the readerInit property.
int	getRotationAngle()	Gets the rotate property.
double	getTopMarginCM()	Gets the topMarginCM property.
double	getXDimensionCM()	Gets the X property.
void	paint(Graphics g2)	Paints the barcode and rotates it if necessary
void	setApplyTilde(boolean newVal)	Sets the applyTilde property.
void	setAutoSize(boolean newVal)	Sets the autoSize property.
void	setBackground(Color newColor)	Sets the backColor property.
void	setDataToEncode(String newCode)	Sets the code property.
void	setErrorCorrectionLevel(int value)	Sets the ecl property.
void	setForeground(Color newColor)	Sets the barColor property.
void	setImageSize(int imgWidth, int imgHeight)	Sets the size of the generated image, if used then autoSize is set to false.
void	setLeftMarginCM(double newMargin)	Sets the leftMarginCM property.
void	setMessageAppend(String value)	Sets the codeApp property.
void	setNumberOfSymbols(int value)	Sets the numOfSym property.
void	setPixelsPerCM(int newRes)	Sets the resolution property.
void	setReaderInitialization(boolean value)	Sets the readerInit property.
void	setRotationAngle(int newRotate)	Sets the rotate property.
void	setTopMarginCM(double newMargin)	Sets the topMarginCM property.
void	setXDimensionCM(double newX)	Sets the X property.

Methods inherited from class java.awt.Canvas

addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, dispatchEvent, doLayout, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

code

public String code

Data to be painted in a Aztec symbol.

See Also:

• setDataToEncode(String newCode)
• getDataToEncode()
• User Manual

leftMarginCM

public double leftMarginCM

The left margin of the barcode (also know as quiet zone); The default is .06 CM.

See Also:

• setLeftMarginCM(double newMargin)
• getLeftMarginCM()
• User Manual

topMarginCM

public double topMarginCM

The top margin of the barcode (also know as quiet zone); The default is .06 CM.

See Also:

• setTopMarginCM(double newMargin)
• getTopMarginCM()
• User Manual

backColor

public Color backColor

Background color.

See Also:

• setBackground(Color newColor)
• getBackground()
• User Manual

resolution

public int resolution

The resolution used to create the X dimension and other measurements in pixels; Default is 38 Pixels Per CM which is about 96 DPI. 96 DPI is the resolution of the web browser; this setting works best when using the servlet. Enter 118 to create a 300 DPI image

See Also:

• setPixelsPerCM(int newRes)
• getPixelsPerCM()
• User Manual

X

public double X

The size in CM of modules, default is .06; usually adjustable in increments of .03CM because (X * resolution) is used to convert to pixels; use setPixelsPerCM to change; if X * resolution = < 1, X will be set to one pixel.

See Also:

• setXDimensionCM(double newX)
• getXDimensionCM()
• User Manual

width

public int width

Initial preferred width property of the bean

height

public int height

Initial preferred height property of the bean

pWidth

public int pWidth

The preferred width of the barcode image in pixels after barcode is generated.

See Also:

• getPreferredSize()
• User Manual

pHeight

public int pHeight

The preferred height of the barcode image in pixels after barcode is generated.

See Also:

• getPreferredSize()
• User Manual

autoSize

public boolean autoSize

If true, will automatically size the control canvas to fit the barcode at design or runtime; Default =True.

See Also:

• setAutoSize(boolean newVal)
• getAutoSize()
• User Manual

barColor

public Color barColor

Color of the modules.

See Also:

• setForeground(Color newColor)
• getForeground()
• User Manual

rotate

public int rotate

Rotation angle; valid values are 0 (default), 90, 180 & 270.

See Also:

• setRotationAngle(int newRotate)
• getRotationAngle()
• User Manual

numOfSym

public int numOfSym

Invokes message append across symbols the number of symbols specified.

See Also:

• setNumberOfSymbols(int value)
• getNumberOfSymbols()
• User Manual

ecl

public int ecl

Error correction Level, 0 = default error correction level; 01 to 99 = minimum error correction percentage; 101 to 104 = 1 to 4-layer Compact symbol; 201 to 232 = 1 to 32-layer Full-Range symbol; 300 = a simple Aztec "Rune"

See Also:

• setErrorCorrectionLevel(int value)
• getErrorCorrectionLevel()
• User Manual

codeApp

public String codeApp

Optional null-terminated ID field for Append.

See Also:

• setMessageAppend(String value)
• getMessageAppend()
• User Manual

readerInit

public boolean readerInit

Adds the reader initialization symbol to the barcode for older scanners, which require it.

See Also:

• setReaderInitialization(boolean value)
• getReaderInitialization()
• User Manual

dotPixels

public int dotPixels

applyTilde

public boolean applyTilde

If true, ("Y") the tilde (~) will be processed according to the rules in the Aztec section of the user guide. If not it will be treated as a normal character; Default =False.

See Also:

• setApplyTilde(boolean newVal)
• getApplyTilde()
• User Manual

reBuild

public boolean reBuild

Constructor Details

Aztec

public Aztec()

Method Details

setDataToEncode

public void setDataToEncode(String newCode)

Sets the code property.

Parameters:

newCode - the new value for the code variable.

See Also:

• code
• User Manual

getDataToEncode

public String getDataToEncode()

Gets the code property.

Returns:

the current value of the code variable.

See Also:

• code
• User Manual

setLeftMarginCM

public void setLeftMarginCM(double newMargin)

Sets the leftMarginCM property.

Parameters:

newMargin - the new value for the leftMarginCM variable.

See Also:

• leftMarginCM
• User Manual

getLeftMarginCM

public double getLeftMarginCM()

Gets the leftMarginCM property.

Returns:

the current value of the leftMarginCM variable.

See Also:

• leftMarginCM
• User Manual

setTopMarginCM

public void setTopMarginCM(double newMargin)

Sets the topMarginCM property.

Parameters:

newMargin - the new value for the topMarginCM variable.

See Also:

• topMarginCM
• User Manual

getTopMarginCM

public double getTopMarginCM()

Gets the topMarginCM property.

Returns:

the current value of the topMarginCM variable.

See Also:

• topMarginCM
• User Manual

setBackground

public void setBackground(Color newColor)

Sets the backColor property.

Overrides:

setBackground in class Component

Parameters:

newColor - the new value for the backColor variable.

See Also:

• backColor
• User Manual

getBackground

public Color getBackground()

Gets the backColor property.

Overrides:

getBackground in class Component

Returns:

the current value of the backColor variable.

See Also:

• backColor
• User Manual

setPixelsPerCM

public void setPixelsPerCM(int newRes)

Sets the resolution property.

Parameters:

newRes - the new value for the resolution variable.

See Also:

• resolution
• User Manual

getPixelsPerCM

public int getPixelsPerCM()

Gets the resolution property.

Returns:

the current value of the resolution variable.

See Also:

• resolution
• User Manual

setXDimensionCM

public void setXDimensionCM(double newX)

Sets the X property.

Parameters:

newX - the new value for the X variable.

See Also:

• X
• User Manual

getXDimensionCM

public double getXDimensionCM()

Gets the X property.

Returns:

the current value of the X variable.

See Also:

• X
• User Manual

setAutoSize

public void setAutoSize(boolean newVal)

Sets the autoSize property.

Parameters:

newVal - the new value for the autoSize variable.

See Also:

• autoSize
• User Manual

getAutoSize

public boolean getAutoSize()

Gets the autoSize property.

Returns:

the current value of the autoSize variable.

See Also:

• autoSize
• User Manual

setImageSize

public void setImageSize(int imgWidth,
 int imgHeight)

Sets the size of the generated image, if used then autoSize is set to false.

getPreferredSize

public Dimension getPreferredSize()

Returns the size in pixels appropriate for the generated image after it is generated.

Overrides:

getPreferredSize in class Component

getMinimumSize

public Dimension getMinimumSize()

Gets the minimum size in pixels of the barcode image generated.

Overrides:

getMinimumSize in class Component

Returns:

Dimension(8,8)

See Also:

• User Manual

setForeground

public void setForeground(Color newColor)

Sets the barColor property.

Overrides:

setForeground in class Component

Parameters:

newColor - the new value for the barColor variable.

See Also:

• barColor
• User Manual

getForeground

public Color getForeground()

Gets the barColor property.

Overrides:

getForeground in class Component

Returns:

the current value of the barColor variable.

See Also:

• barColor
• User Manual

setRotationAngle

public void setRotationAngle(int newRotate)

Sets the rotate property.

Parameters:

newRotate - the new value for the rotate variable.

See Also:

• rotate
• User Manual

getRotationAngle

public int getRotationAngle()

Gets the rotate property.

Returns:

the current value of the rotate variable.

See Also:

• rotate
• User Manual

setNumberOfSymbols

public void setNumberOfSymbols(int value)

Sets the numOfSym property.

Parameters:

value - the new value for the numOfSym variable.

See Also:

• numOfSym
• User Manual

getNumberOfSymbols

public int getNumberOfSymbols()

Gets the numOfSym property.

Returns:

the current value of the numOfSym variable.

See Also:

• numOfSym
• User Manual

setErrorCorrectionLevel

public void setErrorCorrectionLevel(int value)

Sets the ecl property.

Parameters:

value - the new value for the ecl variable.

See Also:

• ecl
• User Manual

getErrorCorrectionLevel

public int getErrorCorrectionLevel()

Gets the ecl property.

Returns:

the current value of the ecl variable.

See Also:

• ecl
• User Manual

setMessageAppend

public void setMessageAppend(String value)

Sets the codeApp property.

Parameters:

value - the new value for the codeApp variable.

See Also:

• codeApp
• User Manual

getMessageAppend

public String getMessageAppend()

Gets the codeApp property.

Returns:

the current value of the codeApp variable.

See Also:

• codeApp
• User Manual

setReaderInitialization

public void setReaderInitialization(boolean value)

Sets the readerInit property.

Parameters:

value - the new value for the readerInit variable.

See Also:

• readerInit
• User Manual

getReaderInitialization

public boolean getReaderInitialization()

Gets the readerInit property.

Returns:

the current value of the readerInit variable.

See Also:

• readerInit
• User Manual

setApplyTilde

public void setApplyTilde(boolean newVal)

Sets the applyTilde property.

Parameters:

the - newVal new value for the newVal variable.

See Also:

• applyTilde
• User Manual

getApplyTilde

public boolean getApplyTilde()

Gets applyTilde the property.

Returns:

the current value of the applyTilde variable.

See Also:

• applyTilde
• User Manual

createSVG

public String createSVG()

createEPS

public String createEPS()

paint

public void paint(Graphics g2)

Paints the barcode and rotates it if necessary

Overrides:

paint in class Canvas