DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements.barcoding
Class TextBarCode

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
All Implemented Interfaces:
ICoordinate
Direct Known Subclasses:
AustraliaPost, Codabar, Code11, Code128, Code25, Code39, Code93, DeutschePostIdentcode, DeutschePostLeitcode, Ean14, GS1DataBar, Iata25, IntelligentMailBarCode, Interleaved25, Itf14, Kix, MsiBarcode, Rm4scc, SingaporePost

public abstract class TextBarCode
extends BarCode

Class provides base class from which bar code page elements that display text 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 TextBarCode(java.lang.String value, float x, float y, float height, float xDimension)
          Creates a new instance of TextBarCode.
protected TextBarCode(java.lang.String value, float x, float y, float height, float xDimension, boolean showText)
          Creates a new instance of TextBarCode.
protected TextBarCode(java.lang.String value, float x, float y, float height, float xDimension, boolean showText, Font font, float fontSize)
          Creates a new instance of TextBarCode.
 
Method Summary
 Font getFont()
          Gets the font to use when displaying the text.
 float getFontSize()
          Gets the font size to use when displaying the text.
 boolean getShowText()
          Gets a value indicating if the value should be placed as text below the barcode.
 Align getTextAlign()
          Gets the alignment of the text.
 Color getTextColor()
          Gets the color of the text.
 void setFont(Font value)
          Sets the font to use when displaying the text.
 void setFontSize(float value)
          Sets the font size to use when displaying the text.
 void setShowText(boolean value)
          Sets a value indicating if the value should be placed as text below the barcode.
 void setTextAlign(Align value)
          Sets the alignment of the text.
 void setTextColor(Color value)
          Sets the color of the text.
 
Methods inherited from class com.cete.dynamicpdf.pageelements.barcoding.BarCode
drawBarCode, drawRotated, getColor, getPixelsPerXDimension, getSymbolWidth, 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

TextBarCode

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

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.

TextBarCode

protected TextBarCode(java.lang.String value,
                      float x,
                      float y,
                      float height,
                      float xDimension,
                      boolean showText)
Creates a new instance of TextBarCode.

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.
showText - true, to display value of barcode as text. Otherwise, display barcode only.

TextBarCode

protected TextBarCode(java.lang.String value,
                      float x,
                      float y,
                      float height,
                      float xDimension,
                      boolean showText,
                      Font font,
                      float fontSize)
Creates a new instance of TextBarCode.

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.
showText - true, to display value of barcode as text. Otherwise, display barcode only.
font - The Font to use when displaying text.
fontSize - The font size to use when displaying text.
Method Detail

getShowText

public boolean getShowText()
Gets a value indicating if the value should be placed as text below the barcode.

Returns:
the text visible status.

setShowText

public void setShowText(boolean value)
Sets a value indicating if the value should be placed as text below the barcode.

Parameters:
value - the text visible status.

getTextColor

public Color getTextColor()
Gets the color of the text.

Returns:
the color of the text.

setTextColor

public void setTextColor(Color value)
Sets the color of the text.

Parameters:
value - the color of the text.

getFont

public Font getFont()
Gets the font to use when displaying the text.

Returns:
the font of the text.

setFont

public void setFont(Font value)
Sets the font to use when displaying the text.

Parameters:
value - the font of the text.

getFontSize

public float getFontSize()
Gets the font size to use when displaying the text.

Returns:
the font size of the text.

setFontSize

public void setFontSize(float value)
Sets the font size to use when displaying the text.

Parameters:
value - the font size of the text.

getTextAlign

public Align getTextAlign()
Gets the alignment of the text.

Returns:
the alignment of the text.

setTextAlign

public void setTextAlign(Align value)
Sets the alignment of the text.

Parameters:
value - the alignment of the text.

DynamicPDF by ceTe Software

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