com.cete.dynamicpdf.pageelements.barcoding
Class StackedGS1DataBar

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.barcoding.StackedGS1DataBar

All Implemented Interfaces:

ICoordinate

public class StackedGS1DataBar
extends TaggablePageElement
implements ICoordinate

This class can be used to place a StackedGS1DataBar 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:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

StackedGS1DataBar(java.lang.String value, float x, float y, float rowHeight, StackedGS1DataBarType gs1type)
Creates a new instance of StackedGS1DataBar.

StackedGS1DataBar(java.lang.String value, float x, float y, float rowHeight, StackedGS1DataBarType gs1type, boolean showText)
Creates a new instance of StackedGS1DataBar.

StackedGS1DataBar(java.lang.String value, float x, float y, float rowHeight, StackedGS1DataBarType gs1type, float xDimension)
Creates a new instance of StackedGS1DataBar.

StackedGS1DataBar(java.lang.String value, float x, float y, float rowHeight, StackedGS1DataBarType gs1type, float xDimension, boolean showText)
Creates a new instance of StackedGS1DataBar.

StackedGS1DataBar(java.lang.String value, float x, float y, float rowHeight, StackedGS1DataBarType gs1type, float xDimension, Font font, float fontSize)
Creates a new instance of StackedGS1DataBar.

StackedGS1DataBar(java.lang.String value, float x, float y, float rowHeight, StackedGS1DataBarType gs1type, Font font, float fontSize)
Creates a new instance of StackedGS1DataBar.

Method Summary

void	draw(PageWriter writer) Draws the StackedGS1DataBar barcode to the given PageWriter object.
float	getAngle() Gets the angle of the barcode.
Color	getColor() Gets the color for the barcode.
int	getExpandedStackedSegmentCount() Gets the segment count of the Expanded Stacked barcode.
Font	getFont() Gets the font to use when displaying the text.
float	getFontSize() Gets the font size to use when displaying the text.
int	getPixelsPerXDimension() Gets the number of Pixels to write per xDimension.
int	getRowCount() Gets the row count.
float	getRowHeight() Gets the row height of the Barcode.
boolean	getShowText() Gets a boolean indicating whether the text to be displayed.
float	getSymbolHeight() Returns the height required to display the full barcode.
float	getSymbolWidth() Returns the width required to display the full bar code.
Align	getTextAlign() Gets the alignment to use when displaying the text.
Color	getTextColor() Gets the color of the text.
float	getX() Gets the X coordinate of the barcode.
float	getXDimension() Gets the xDimension of the barcode.
float	getY() Gets the Y coordinate of the barcode.
void	setAngle(float value) Sets the angle of the barcode.
void	setColor(Color value) Sets the color for the barcode.
void	setExpandedStackedSegmentCount(int value) Sets the segment count of the Expanded Stacked barcode.
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	setPixelsPerXDimension(int value) Sets the number of Pixels to write per xDimension.
void	setRowHeight(float value) Sets the row height of the Barcode.
void	setShowText(boolean value) Sets a boolean indicating whether the text to be displayed.
void	setTextAlign(Align value) Sets the alignment to use when displaying the text.
void	setTextColor(Color value) Sets the color of the text.
void	setX(float value) Sets the X coordinate of the barcode.
void	setXDimension(float value) Sets the xDimension of the barcode.
void	setY(float value) Sets the Y coordinate of the barcode.

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

Constructor Detail

StackedGS1DataBar

public StackedGS1DataBar(java.lang.String value,
                         float x,
                         float y,
                         float rowHeight,
                         StackedGS1DataBarType gs1type)

Creates a new instance of StackedGS1DataBar.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

rowHeight - The height of the barcode.

gs1type - The GS1DataBarType of the barcode.

StackedGS1DataBar

public StackedGS1DataBar(java.lang.String value,
                         float x,
                         float y,
                         float rowHeight,
                         StackedGS1DataBarType gs1type,
                         boolean showText)

Creates a new instance of StackedGS1DataBar.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

rowHeight - The height of the barcode.

gs1type - The GS1DataBarType of the barcode.

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

StackedGS1DataBar

public StackedGS1DataBar(java.lang.String value,
                         float x,
                         float y,
                         float rowHeight,
                         StackedGS1DataBarType gs1type,
                         Font font,
                         float fontSize)

Creates a new instance of StackedGS1DataBar.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

rowHeight - The height of the barcode.

gs1type - The GS1DataBarType of the barcode.

font - The font to use when displaying text.

fontSize - The font size to use when displaying text.

StackedGS1DataBar

public StackedGS1DataBar(java.lang.String value,
                         float x,
                         float y,
                         float rowHeight,
                         StackedGS1DataBarType gs1type,
                         float xDimension)

Creates a new instance of StackedGS1DataBar.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

rowHeight - The height of the barcode.

gs1type - The GS1DataBarType of the barcode.

xDimension - The XDimension of the barcode.

StackedGS1DataBar

public StackedGS1DataBar(java.lang.String value,
                         float x,
                         float y,
                         float rowHeight,
                         StackedGS1DataBarType gs1type,
                         float xDimension,
                         boolean showText)

Creates a new instance of StackedGS1DataBar.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

rowHeight - The height of the barcode.

gs1type - The GS1DataBarType of the barcode.

xDimension - The XDimension of the barcode.

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

StackedGS1DataBar

public StackedGS1DataBar(java.lang.String value,
                         float x,
                         float y,
                         float rowHeight,
                         StackedGS1DataBarType gs1type,
                         float xDimension,
                         Font font,
                         float fontSize)

Creates a new instance of StackedGS1DataBar.

Parameters:

value - The value of the barcode.

x - The X coordinate of the barcode.

y - The Y coordinate of the barcode.

rowHeight - The height of the barcode.

gs1type - The GS1DataBarType of the barcode.

xDimension - The XDimension of the barcode.

font - The font to use when displaying text.

fontSize - The font size to use when displaying text.

Method Detail

getPixelsPerXDimension

public int getPixelsPerXDimension()

Gets the number of Pixels to write per xDimension.

Returns:

the number of Pixels to write per xDimension.

setPixelsPerXDimension

public void setPixelsPerXDimension(int value)

Sets the number of Pixels to write per xDimension.

Parameters:

value - the number of Pixels to write per xDimension.

getX

public float getX()

Gets the X coordinate of the barcode.

Specified by:

getX in interface ICoordinate

Returns:

the X coordinate of the barcode.

setX

public void setX(float value)

Sets the X coordinate of the barcode.

Specified by:

setX in interface ICoordinate

Parameters:

value - the X coordinate of the barcode.

getY

public float getY()

Gets the Y coordinate of the barcode.

Specified by:

getY in interface ICoordinate

Returns:

the Y coordinate of the barcode.

setY

public void setY(float value)

Sets the Y coordinate of the barcode.

Specified by:

setY in interface ICoordinate

Parameters:

value - the Y coordinate of the barcode.

getAngle

public float getAngle()

Gets the angle of the barcode.

Returns:

the angle of the barcode.

setAngle

public void setAngle(float value)

Sets the angle of the barcode.

Parameters:

value - the angle 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.

getExpandedStackedSegmentCount

public int getExpandedStackedSegmentCount()

Gets the segment count of the Expanded Stacked barcode.

Returns:

the segment count of the Expanded Stacked barcode.

setExpandedStackedSegmentCount

public void setExpandedStackedSegmentCount(int value)

Sets the segment count of the Expanded Stacked barcode.

Parameters:

value - the segment count of the Expanded Stacked barcode.

getRowCount

public int getRowCount()

Gets the row count.

Returns:

the row count.

getRowHeight

public float getRowHeight()

Gets the row height of the Barcode.

Returns:

the row height of the Barcode.

setRowHeight

public void setRowHeight(float value)

Sets the row height of the Barcode.

Parameters:

value - the row height of the Barcode.

getShowText

public boolean getShowText()

Gets a boolean indicating whether the text to be displayed.

Returns:

a boolean indicating whether the text to be displayed.

setShowText

public void setShowText(boolean value)

Sets a boolean indicating whether the text to be displayed.

Parameters:

value - a boolean indicating whether the text to be displayed.

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.

getColor

public Color getColor()

Gets the color for the barcode.

Returns:

the color for the barcode.

setColor

public void setColor(Color value)

Sets the color for the barcode.

Parameters:

value - the color for the barcode.

getFont

public Font getFont()

Gets the font to use when displaying the text.

Returns:

the font to use when displaying the text.

setFont

public void setFont(Font value)

Sets the font to use when displaying the text.

Parameters:

value - the font to use when displaying the text.

getTextAlign

public Align getTextAlign()

Gets the alignment to use when displaying the text.

Returns:

the alignment to use when displaying the text.

setTextAlign

public void setTextAlign(Align value)

Sets the alignment to use when displaying the text.

Parameters:

value - the alignment to use when displaying the text.

getFontSize

public float getFontSize()

Gets the font size to use when displaying the text.

Returns:

the font size to use when displaying the text.

setFontSize

public void setFontSize(float value)

Sets the font size to use when displaying the text.

Parameters:

value - the font size to use when displaying the text.

getSymbolWidth

public float getSymbolWidth()

Returns the width required to display the full bar code.

Returns:

value representing the required width.

getSymbolHeight

public float getSymbolHeight()

Returns the height required to display the full barcode.

Returns:

value representing the required height.

draw

public void draw(PageWriter writer)

Draws the StackedGS1DataBar barcode to the given PageWriter object.

Overrides:

draw in class TaggablePageElement

Parameters:

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

See Also:

PageWriter