net.sourceforge.barbecue.linear.code128
Class Code128Barcode

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.code128.Code128Barcode

All Implemented Interfaces:

ImageObserver, MenuContainer, Printable, Serializable

Direct Known Subclasses:

UCCEAN128Barcode

public class Code128Barcode
extends LinearBarcode

This is a concrete implementation of the Code 128 barcode. It fully supports all three available character sets (A, B and C), and also fully supports code shifts and set changes on-the-fly, providing an automatic optimisation mode.

Author:

Ian Bourke

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

static int	A Character set A flag
static int	B Character set B flag
protected static int[]	BUF_SIZES
static int	C Character set c flag
static String	CHANGE_TO_A Code set change from current to A character
static String	CHANGE_TO_B Code set change from current to B character
static String	CHANGE_TO_C Code set change from current to c character
static String	FNC_1 FNC1 start character
protected int	mode
static int	O Auto character set flag
protected static Module	QUIET_SECTION
static String	SHIFT Code shift character
static Module	START_A
static Module	START_B
static Module	START_C
protected static int[]	START_INDICES
protected int	startIndex
protected static Module	STOP

Fields inherited from class net.sourceforge.barbecue.Barcode

barHeight, barWidth, data, drawingQuietSection, drawingText, label

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

Code128Barcode(String data)
Create a new Code 128 barcode using character set B.

Code128Barcode(String data, int mode)
Creates a new Coded 128 barcode with the specified data and the specified character set.

Method Summary

Module	calculateChecksum() Calculates the check sum digit for the barcode.
protected int	calculateMinimumBarHeight(int resolution) Calculates the minimum allowed barcode height for the barcode.
Module[]	encodeData() Encodes the data of the barcode into bars.
int	getCharacterSet() Returns the current character set being used in this barcode.
String	getLabel() Returns the text label to be displayed underneath the barcode/
protected Module	getPostAmble() Returns the post amble for the barcode.
protected Module	getPreAmble() Returns the pre-amble for the barcode.
protected double	getSymbolWidth(int resolution) Returns the width of the encoded symbol portion of the barcode in pixels for the given resolution.

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

draw, drawTextLabel

Methods inherited from class net.sourceforge.barbecue.Barcode

beautify, 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, 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

A

public static final int A

Character set A flag

See Also:

Constant Field Values

B

public static final int B

Character set B flag

See Also:

Constant Field Values

C

public static final int C

Character set c flag

See Also:

Constant Field Values

O

public static final int O

Auto character set flag

See Also:

Constant Field Values

SHIFT

public static final String SHIFT

Code shift character

See Also:

Constant Field Values

CHANGE_TO_A

public static final String CHANGE_TO_A

Code set change from current to A character

See Also:

Constant Field Values

CHANGE_TO_B

public static final String CHANGE_TO_B

Code set change from current to B character

See Also:

Constant Field Values

CHANGE_TO_C

public static final String CHANGE_TO_C

Code set change from current to c character

See Also:

Constant Field Values

FNC_1

public static final String FNC_1

FNC1 start character

See Also:

Constant Field Values

START_A

public static final Module START_A

START_B

public static final Module START_B

START_C

public static final Module START_C

STOP

protected static final Module STOP

QUIET_SECTION

protected static final Module QUIET_SECTION

START_INDICES

protected static final int[] START_INDICES

BUF_SIZES

protected static final int[] BUF_SIZES

startIndex

protected int startIndex

mode

protected int mode

Constructor Detail

Code128Barcode

public Code128Barcode(String data)
               throws BarcodeException

Create a new Code 128 barcode using character set B.

Parameters:

data - The data to encode

Throws:

BarcodeException - If the data to be encoded is invalid

Code128Barcode

public Code128Barcode(String data,
                      int mode)
               throws BarcodeException

Creates a new Coded 128 barcode with the specified data and the specified character set.

Parameters:

data - The data to encode

mode - The character set to use for encoding

Throws:

BarcodeException - If the data to be encoded is invalid

Method Detail

getCharacterSet

public int getCharacterSet()

Returns the current character set being used in this barcode.

Returns:

The flag indicating the current character set

getLabel

public String getLabel()

Returns the text label to be displayed underneath the barcode/

Overrides:

getLabel in class Barcode

Returns:

The text label for the barcode

getSymbolWidth

protected double getSymbolWidth(int resolution)

Returns the width of the encoded symbol portion of the barcode in pixels for the given resolution.

Parameters:

resolution - The resolution to calculate the width for

Returns:

The width of the encoded portion of the barcode

calculateMinimumBarHeight

protected int calculateMinimumBarHeight(int resolution)

Calculates the minimum allowed barcode height for the barcode. The height must be at least .15 times the length of the symbol (excluding quiet zones) and .25 inches (whichever is larger).

Overrides:

calculateMinimumBarHeight in class Barcode

Parameters:

resolution - The output resolution (for calculating the width)

Returns:

The minimum height

encodeData

public Module[] encodeData()

Encodes the data of the barcode into bars.

Specified by:

encodeData in class Barcode

Returns:

The encoded bar data

calculateChecksum

public Module calculateChecksum()

Calculates the check sum digit for the barcode.

Specified by:

calculateChecksum in class Barcode

Returns:

The check sum digit

getPreAmble

protected Module getPreAmble()

Returns the pre-amble for the barcode. This is a combination of a quiet section and the start character for the character set that the barcode was constructed with.

Specified by:

getPreAmble in class Barcode

Returns:

The pre-amble

getPostAmble

protected Module getPostAmble()

Returns the post amble for the barcode. This is the combination of the stop character anda quiet section.

Specified by:

getPostAmble in class Barcode

Returns:

The post amble