DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements.barcoding
Class BarCode

java.lang.Object
  extended by com.cete.dynamicpdf.PageElement
      extended by com.cete.dynamicpdf.pageelements.TaggablePageElement
          extended by com.cete.dynamicpdf.pageelements.RotatingPageElement
              extended by 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:


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.
 int getPixelsPerXDimension()
          Gets the pixels per XDimension
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 setPixelsPerXDimension(int value)
          Sets the pixels per XDimension
 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.pageelements.TaggablePageElement
getTag, getTagOrder, setTag, setTagOrder
 
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

getPixelsPerXDimension

public int getPixelsPerXDimension()
Gets the pixels per XDimension

Returns:
Gets the value of the pixels per XDimension.

setPixelsPerXDimension

public void setPixelsPerXDimension(int value)
Sets the pixels per XDimension

Parameters:
value - the pixels per XDimension

getValue

public java.lang.String getValue()
Gets the value of the barcode.

Returns:
Gets the value of the barcode.

setValue

public void setValue(java.lang.String value)
Sets the value of the barcode.

Parameters:
value - Gets the value of the barcode.

getXDimension

public float getXDimension()
Gets the XDimension of the barcode.

Returns:
the XDimension of the barcode.

setXDimension

public void setXDimension(float value)
Sets the XDimension of the barcode.

Parameters:
value - the XDimension of the barcode.

getXDimensionsPerInch

public float getXDimensionsPerInch()
Gets the XDimensionsPerInch of the barcode.

Returns:
the XDimensionsPerInch of the barcode.

setXDimensionsPerInch

public void setXDimensionsPerInch(float value)
Sets the XDimensionsPerInch of the barcode.

Parameters:
value - the XDimensionsPerInch of the barcode.

getXDimensionsPerCentiMeter

public float getXDimensionsPerCentiMeter()
Gets the XDimensionsPerCentiMeter of the barcode.

Returns:
the XDimensionsPerCentiMeter of the barcode.

setXDimensionsPerCentiMeter

public void setXDimensionsPerCentiMeter(float value)
Sets the XDimensionsPerCentiMeter of the barcode.

Parameters:
value - the XDimensionsPerCentiMeter of the barcode.

getXDimensionMils

public float getXDimensionMils()
Gets the XDimensionMils of the barcode.

Returns:
the XDimensionMils of the barcode.

setXDimensionMils

public void setXDimensionMils(float value)
Sets the XDimensionMils of the barcode.

Parameters:
value - the XDimensionMils of the barcode.

getXDimensionMilliMeters

public float getXDimensionMilliMeters()
Gets the XDimensionMilliMeters of the barcode.

Returns:
the XDimensionMilliMeters of the barcode.

setXDimensionMilliMeters

public void setXDimensionMilliMeters(float value)
Sets the XDimensionMilliMeters of the barcode.

Parameters:
value - the XDimensionMilliMeters of the barcode.

getColor

public Color getColor()
Gets the Color of the barcode.

Returns:
the color of the barcode.

setColor

public void setColor(Color value)
Sets the Color of the barcode.

Parameters:
value - 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.

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

DynamicPDF by ceTe Software

API Reference for DynamicPDF v10.07 for Java generated on Aug 12, 2020
© Copyright 2020, ceTe Software