com.cete.dynamicpdf.pageelements.barcoding
Class BarCode

java.lang.Object
  |
  +--com.cete.dynamicpdf.PageElement
        |
        +--com.cete.dynamicpdf.pageelements.RotatingPageElement
              |
              +--com.cete.dynamicpdf.pageelements.barcoding.BarCode

All Implemented Interfaces:

ICoordinate

Direct Known Subclasses:

Postnet, TextBarCode, UpcBase

public abstract class BarCode

extends RotatingPageElement

implements ICoordinate

Class provides the base class from which bar code page elements are derived.

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

Constructor Summary

protected

BarCode(java.lang.String value, float x, float y, float height, float xDimension) Creates a new instance of BarCode.

Method Summary

protected abstract void	drawBarCode(PageWriter writer) Draws the barcode to the given PageWriter object.
protected void	drawRotated(PageWriter writer) Draws the rotated page element to the given PageWriter object.
Color	getColor() Gets the Color of the barcode.
abstract float	getRequiredWidth() Deprecated. As of DynamicPDF v4.0.0, Use the BarCode.getSymbolWidth() method instead.
abstract float	getSymbolWidth() Returns the width required to display the full bar code.
java.lang.String	getValue() Gets the value of the barcode.
float	getXDimension() Gets the XDimension of the barcode.
float	getXDimensionMilliMeters() Gets the XDimensionMilliMeters of the barcode.
float	getXDimensionMils() Gets the XDimensionMils of the barcode.
float	getXDimensionsPerCentiMeter() Gets the XDimensionsPerCentiMeter of the barcode.
float	getXDimensionsPerInch() Gets the XDimensionsPerInch of the barcode.
void	setColor(Color value) Sets the Color of the barcode.
void	setValue(java.lang.String value) Sets the value of the barcode.
void	setXDimension(float value) Sets the XDimension of the barcode.
void	setXDimensionMilliMeters(float value) Sets the XDimensionMilliMeters of the barcode.
void	setXDimensionMils(float value) Sets the XDimensionMils of the barcode.
void	setXDimensionsPerCentiMeter(float value) Sets the XDimensionsPerCentiMeter of the barcode.
void	setXDimensionsPerInch(float value) Sets the XDimensionsPerInch of the barcode.

Methods inherited from class com.cete.dynamicpdf.pageelements.RotatingPageElement

draw, getAngle, getHeight, getX, getY, setAngle, setHeight, setX, setY

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

Methods inherited from interface com.cete.dynamicpdf.pageelements.ICoordinate

getX, getY, setX, setY

Constructor Detail

BarCode

protected BarCode(java.lang.String value,
                  float x,
                  float y,
                  float height,
                  float xDimension)

Creates a new instance of BarCode.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

height - The height of the barcode.

xDimension - The XDimension of the barcode.

Method Detail

getValue

public java.lang.String getValue()

Gets the value of the barcode.

setValue

public void setValue(java.lang.String value)

Sets the value of the barcode.

getXDimension

public float getXDimension()

Gets the XDimension of the barcode.

setXDimension

public void setXDimension(float value)

Sets the XDimension of the barcode.

getXDimensionsPerInch

public float getXDimensionsPerInch()

Gets the XDimensionsPerInch of the barcode.

setXDimensionsPerInch

public void setXDimensionsPerInch(float value)

Sets the XDimensionsPerInch of the barcode.

getXDimensionsPerCentiMeter

public float getXDimensionsPerCentiMeter()

Gets the XDimensionsPerCentiMeter of the barcode.

setXDimensionsPerCentiMeter

public void setXDimensionsPerCentiMeter(float value)

Sets the XDimensionsPerCentiMeter of the barcode.

getXDimensionMils

public float getXDimensionMils()

Gets the XDimensionMils of the barcode.

setXDimensionMils

public void setXDimensionMils(float value)

Sets the XDimensionMils of the barcode.

getXDimensionMilliMeters

public float getXDimensionMilliMeters()

Gets the XDimensionMilliMeters of the barcode.

setXDimensionMilliMeters

public void setXDimensionMilliMeters(float value)

Sets the XDimensionMilliMeters of the barcode.

getColor

public Color getColor()

Gets the Color of the barcode.

setColor

public void setColor(Color value)

Sets the Color of the barcode.

getSymbolWidth

public abstract float getSymbolWidth()

Returns the width required to display the full bar code.

Returns:

A value representing the required width.

getRequiredWidth

public abstract float getRequiredWidth()

Deprecated. As of DynamicPDF v4.0.0, Use the BarCode.getSymbolWidth() method instead.

Returns the width required to display the full bar code.

Returns:

A value representing the required width.

drawBarCode

protected abstract void drawBarCode(PageWriter writer)

Draws the barcode to the given PageWriter object.

Parameters:

writer - PageWriter object to receive the page element's output.

See Also:

PageWriter

drawRotated

protected void drawRotated(PageWriter writer)

Draws the rotated page element to the given PageWriter object.

Specified by:

drawRotated in class RotatingPageElement

Parameters:

writer - PageWriter object to receive the page element's output.

See Also:

PageWriter