com.cete.dynamicpdf.pageelements.barcoding
Class UpcVersionESup5

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

All Implemented Interfaces:

ICoordinate

public class UpcVersionESup5

extends UpcVersionE

This class can be used to place a UPC version E, 5 digit supplement bar code on a page.

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

View Example

Constructor Summary

UpcVersionESup5(java.lang.String value, float x, float y)
Initializes a new instance of the UpcVersionESup5 class.

UpcVersionESup5(java.lang.String value, float x, float y, float scale)
Initializes a new instance of the UpcVersionESup5 class.

UpcVersionESup5(java.lang.String value, java.lang.String supplementalValue, float x, float y)
Initializes a new instance of the UpcVersionESup5 class.

UpcVersionESup5(java.lang.String value, java.lang.String supplementalValue, float x, float y, float scale)
Initializes a new instance of the UpcVersionESup5 class.

Method Summary

protected void	drawBarCode(PageWriter writer) Draws the barcode to the given PageWriter object.
float	getRequiredWidth() Deprecated. As of DynamicPDF v4.0.0, Use the UpcVersionESup5.getSymbolWidth() method instead.
java.lang.String	getSupplementalValue() Gets the supplemental value of the barcode.
float	getSymbolWidth() Returns the width required to display the full bar code.
void	setSupplementalValue(java.lang.String supplementalValue) Sets the supplemental value of the barcode.

Methods inherited from class com.cete.dynamicpdf.pageelements.barcoding.UpcBase

setScale

Methods inherited from class com.cete.dynamicpdf.pageelements.barcoding.BarCode

drawRotated, getColor, getValue, getXDimension, getXDimensionMilliMeters, getXDimensionMils, getXDimensionsPerCentiMeter, getXDimensionsPerInch, setColor, setValue, setXDimension, setXDimensionMilliMeters, setXDimensionMils, setXDimensionsPerCentiMeter, setXDimensionsPerInch

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

UpcVersionESup5

public UpcVersionESup5(java.lang.String value,
                       float x,
                       float y)

Initializes a new instance of the UpcVersionESup5 class.

Parameters:

value - The value (including supplemental value) of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

UpcVersionESup5

public UpcVersionESup5(java.lang.String value,
                       float x,
                       float y,
                       float scale)

Initializes a new instance of the UpcVersionESup5 class.

Parameters:

value - The value (including supplemental value) of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

scale - The scale of the barcode.

UpcVersionESup5

public UpcVersionESup5(java.lang.String value,
                       java.lang.String supplementalValue,
                       float x,
                       float y)

Initializes a new instance of the UpcVersionESup5 class.

Parameters:

value - The value of the barcode.

supplementalValue - The supplemental value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

UpcVersionESup5

public UpcVersionESup5(java.lang.String value,
                       java.lang.String supplementalValue,
                       float x,
                       float y,
                       float scale)

Initializes a new instance of the UpcVersionESup5 class.

Parameters:

value - The value of the barcode.

supplementalValue - The supplemental value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

scale - The scale of the barcode.

Method Detail

setSupplementalValue

public void setSupplementalValue(java.lang.String supplementalValue)

Sets the supplemental value of the barcode.

Parameters:

supplementalValue - The supplemental value of the barcode.

getSupplementalValue

public java.lang.String getSupplementalValue()

Gets the supplemental value of the barcode.

Returns:

The supplemental value of the barcode.

getRequiredWidth

public float getRequiredWidth()

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

Returns the width required to display the full bar code.

Overrides:

getRequiredWidth in class UpcVersionE

Returns:

value representing the required width.

getSymbolWidth

public float getSymbolWidth()

Returns the width required to display the full bar code.

Overrides:

getSymbolWidth in class UpcVersionE

Returns:

A value representing the required width.

drawBarCode

protected void drawBarCode(PageWriter writer)

Draws the barcode to the given PageWriter object.

Overrides:

drawBarCode in class UpcVersionE

Throws:

InvalidValueBarCodeException - If UPC Version is Invalid

Parameters:

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

See Also:

PageWriter