net.sourceforge.barbecue.linear.upc

Class UPCABarcode

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

net.sourceforge.barbecue.Barcode

net.sourceforge.barbecue.linear.LinearBarcode

net.sourceforge.barbecue.linear.upc.UPCABarcode

All Implemented Interfaces:

ImageObserver, MenuContainer, Printable, Serializable

Direct Known Subclasses:

EAN13Barcode

public class UPCABarcode
extends LinearBarcode

This is a concrete implementation of the UPC-A barcode.

Author:

James Jenner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	BARCODE_LENGTH
protected static int	CHECKSUM_WEIGHT_EVEN
protected static int	CHECKSUM_WEIGHT_ODD
protected String	label
protected boolean	requiresChecksum
static String[]	TYPES A list of type identifiers for the UPC-A barcode format
protected int	width

Fields inherited from class net.sourceforge.barbecue.Barcode

barHeight, barWidth, data, drawingQuietSection, drawingText

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
UPCABarcode(String data) Constructs a basic mode UPC-A barcode with the specified data and an optional checksum.
UPCABarcode(String data, boolean randomWeight)

Method Summary

Methods

Modifier and Type	Method and Description
protected Module	calculateChecksum() Returns the checksum for the barcode, pre-encoded as a Module.
protected static int	calculateChecksum(int value, boolean even)
protected Dimension	draw(Output output, int x, int y, int barWidth, int barHeight)
protected Module[]	encodeData() Returns the encoded data for the barcode.
protected int	getBarcodeLength()
protected double	getBarcodeWidth(int resolution) Returns the barcode width for the given resolution.
protected Module	getCentreGuard() Returns the middle bar for the barcode.
protected int	getGuardCharSize()
String	getLabel() Returns the text that will be displayed underneath the barcode (if requested).
protected Module	getLeftMargin()
protected int	getLeftWidth()
static int	getMod10CheckDigit(String data)
protected Module	getPostAmble() Returns the post-amble for the barcode.
protected Module	getPreAmble() Returns the pre-amble for the barcode.
protected Module	getRightMargin()

Methods inherited from class net.sourceforge.barbecue.linear.LinearBarcode

drawTextLabel

Methods inherited from class net.sourceforge.barbecue.Barcode

beautify, calculateMinimumBarHeight, draw, drawModule, getBounds, getBounds, getData, getHeight, getMaximumSize, getMinimumSize, getPreferredSize, getResolution, getSize, getWidth, getX, getY, isDrawingQuietSection, isDrawingText, output, paintComponent, print, setBarHeight, setBarWidth, setDrawingQuietSection, setDrawingText, setFont, setLabel, setResolution, toString

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

TYPES

public static final String[] TYPES

A list of type identifiers for the UPC-A barcode format

requiresChecksum

protected boolean requiresChecksum

label

protected final String label

width

protected int width

CHECKSUM_WEIGHT_EVEN

protected static final int CHECKSUM_WEIGHT_EVEN

See Also:

Constant Field Values

CHECKSUM_WEIGHT_ODD

protected static final int CHECKSUM_WEIGHT_ODD

See Also:

Constant Field Values

BARCODE_LENGTH

public static final int BARCODE_LENGTH

See Also:

Constant Field Values

Constructor Detail

UPCABarcode

public UPCABarcode(String data)
            throws BarcodeException

Constructs a basic mode UPC-A barcode with the specified data and an optional checksum. The length of the barcode is 11, 12 with a checksum. If the length passed is only 11, then a checksum will be automaticaly added. If the length is not 11 or 12 then a barcode exception will be thrown.

Parameters:

data - The data to encode

Throws:

BarcodeException - If the data to be encoded is invalid

UPCABarcode

public UPCABarcode(String data,
           boolean randomWeight)
            throws BarcodeException

Throws:

BarcodeException

Method Detail

getBarcodeLength

protected int getBarcodeLength()

draw

protected Dimension draw(Output output,
             int x,
             int y,
             int barWidth,
             int barHeight)
                  throws OutputException

Overrides:

draw in class LinearBarcode

Throws:

OutputException

getLabel

public String getLabel()

Returns the text that will be displayed underneath the barcode (if requested).

Overrides:

getLabel in class Barcode

Returns:

The text label for the barcode

getBarcodeWidth

protected double getBarcodeWidth(int resolution)

Returns the barcode width for the given resolution.

Parameters:

resolution - The output resolution

Returns:

The barcode width

encodeData

protected Module[] encodeData()

Returns the encoded data for the barcode.

Specified by:

encodeData in class Barcode

Returns:

An array of modules that represent the data as a barcode

calculateChecksum

protected Module calculateChecksum()

Returns the checksum for the barcode, pre-encoded as a Module.

Specified by:

calculateChecksum in class Barcode

Returns:

a Mod-10 caclulated checksum, if no checksum is required Null

getGuardCharSize

protected int getGuardCharSize()

getLeftWidth

protected int getLeftWidth()

getLeftMargin

protected Module getLeftMargin()

getRightMargin

protected Module getRightMargin()

getPreAmble

protected Module getPreAmble()

Returns the pre-amble for the barcode.

Specified by:

getPreAmble in class Barcode

Returns:

pre amble for the barcode

getCentreGuard

protected Module getCentreGuard()

Returns the middle bar for the barcode.

Returns:

pre amble for the barcode

getPostAmble

protected Module getPostAmble()

Returns the post-amble for the barcode.

Specified by:

getPostAmble in class Barcode

Returns:

postamble for the barcode

getMod10CheckDigit

public static int getMod10CheckDigit(String data)

calculateChecksum

protected static int calculateChecksum(int value,
                    boolean even)