DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements.barcoding
Class AustraliaPost

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
                  extended by com.cete.dynamicpdf.pageelements.barcoding.TextBarCode
                      extended by com.cete.dynamicpdf.pageelements.barcoding.AustraliaPost
All Implemented Interfaces:
ICoordinate

public class AustraliaPost
extends TextBarCode

This class can be used to place an Australia Post barcode on a page.

Licensing:
This class is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

View Example


Constructor Summary
AustraliaPost(java.lang.String value, float x, float y)
          Creates a new instance of AustraliaPost.
AustraliaPost(java.lang.String value, float x, float y, boolean showText)
          Creates a new instance of AustraliaPost.
 
Method Summary
protected  void drawBarCode(PageWriter writer)
          Draws the barcode to the given PageWriter object.
 AustraliaPostEncodingType getCustomerDataEncoding()
          Gets an encoding used to encode customer data.
 boolean getShowTextAbove()
          Gets a boolean representing whether the text is displayed above the barcode.
 float getSymbolWidth()
          Returns the width required to display the full bar code.
 void setCustomerDataEncoding(AustraliaPostEncodingType value)
          Sets an encoding to encode customer data.
 void setShowTextAbove(boolean value)
          Sets a boolean representing whether the text is displayed above 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

AustraliaPost

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

Parameters:
value - The value of the barcode.
x - The X coordinate of the barcode.
y - The Y coordinate of the barcode.

AustraliaPost

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

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

getShowTextAbove

public boolean getShowTextAbove()
Gets a boolean representing whether the text is displayed above the barcode.

Returns:
a boolean representing whether the text is displayed above the barcode.

setShowTextAbove

public void setShowTextAbove(boolean value)
Sets a boolean representing whether the text is displayed above the barcode.

Parameters:
value - true, to display the text above the barcode.

setCustomerDataEncoding

public void setCustomerDataEncoding(AustraliaPostEncodingType value)
Sets an encoding to encode customer data.

Parameters:
value - The AustraliaPostEncodingType used to encode the customer data.

getCustomerDataEncoding

public AustraliaPostEncodingType getCustomerDataEncoding()
Gets an encoding used to encode customer data.

Returns:
The AustraliaPostEncodingType used to encode the customer data.

getSymbolWidth

public float getSymbolWidth()
Description copied from class: BarCode
Returns the width required to display the full bar code.

Specified by:
getSymbolWidth in class BarCode
Returns:
A value representing the required width.

drawBarCode

protected void drawBarCode(PageWriter writer)
Description copied from class: BarCode
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

DynamicPDF by ceTe Software

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