com.cete.dynamicpdf.pageelements.barcoding
Class IntelligentMailBarCode

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.RotatingPageElement
              com.cete.dynamicpdf.pageelements.barcoding.BarCode
                  com.cete.dynamicpdf.pageelements.barcoding.TextBarCode
                      com.cete.dynamicpdf.pageelements.barcoding.IntelligentMailBarCode

All Implemented Interfaces:

ICoordinate

public class IntelligentMailBarCode
extends TextBarCode

Represents a Intelligent Mail bar code. This class can be used to generate Intelligent Mail bar code

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

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

IntelligentMailBarCode(java.lang.String value, float x, float y, boolean showText)
Creates a new instance of IntelligentMailBarCode.

Method Summary

protected void	drawBarCode(PageWriter writer) Draws the barcode to the given PageWriter object.
MailerIDLength	getMailerIDLength() Gets a MailerIDLength indicating the length of mailer ID.
boolean	getShowTextAbove() Gets a boolean value indicating if the text should be placed above or below the barcode.
float	getSymbolHeight() Returns the height of the barcode excluding the text height.
float	getSymbolWidth() Gets required width for drawing Intelligent Mail bar code.
void	setMailerIDLength(MailerIDLength value) Sets a MailerIDLength indicating the length of mailer ID.
void	setShowTextAbove(boolean value) Sets a boolean value indicating if the text should be placed above or below the barcode.

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

getFont, getFontSize, getShowText, getTextAlign, getTextColor, setFont, setFontSize, setShowText, setTextAlign, setTextColor

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

drawRotated, getColor, getPixelsPerXDimension, getValue, getXDimension, getXDimensionMilliMeters, getXDimensionMils, getXDimensionsPerCentiMeter, getXDimensionsPerInch, setColor, setPixelsPerXDimension, 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.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

IntelligentMailBarCode

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

Creates a new instance of IntelligentMailBarCode.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

IntelligentMailBarCode

public IntelligentMailBarCode(java.lang.String value,
                              float x,
                              float y,
                              boolean showText)

Creates a new instance of IntelligentMailBarCode.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

showText - True to display value of barcode as text. Otherwise, display barcode only.

Method Detail

drawBarCode

protected void drawBarCode(PageWriter writer)

Draws the barcode to the given PageWriter object.

Specified by:

drawBarCode in class BarCode

Parameters:

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

See Also:

PageWriter

getSymbolWidth

public float getSymbolWidth()

Gets required width for drawing Intelligent Mail bar code.

Specified by:

getSymbolWidth in class BarCode

Returns:

Required width for drawing Intelligent Mail bar code.

getShowTextAbove

public boolean getShowTextAbove()

Gets a boolean value indicating if the text should be placed above or below the barcode.

Returns:

Indicates the position of the text for the barcode.

setShowTextAbove

public void setShowTextAbove(boolean value)

Sets a boolean value indicating if the text should be placed above or below the barcode.

Parameters:

value - Indicates the position of the text for the barcode.

getMailerIDLength

public MailerIDLength getMailerIDLength()

Gets a MailerIDLength indicating the length of mailer ID.

Returns:

The length of mailer ID.

setMailerIDLength

public void setMailerIDLength(MailerIDLength value)

Sets a MailerIDLength indicating the length of mailer ID.

Parameters:

value - The length of mailer ID.

getSymbolHeight

public float getSymbolHeight()

Returns the height of the barcode excluding the text height.

Returns:

a value representing the height of the barcode excluding the text height.