public interface BarcodeControl extends Control
Modifier and Type | Field and Description |
---|---|
static int |
CODABAR
A constant to represent a Codabar barcode for use with setType() method.
|
static int |
CODE128
A constant to represent a Code 128 barcode for use with setType() method.
|
static int |
CODE39
A constant to represent a Code 39 barcode for use with setType() method.
|
static int |
DATAMATRIX
A constant to represent a Datamatrix barcode for use with setType() method.
|
static int |
EAN128
A constant to represent a EAN 128 barcode for use with setType() method.
|
static int |
EAN13
A constant to represent a EAN 13 barcode for use with setType() method.
|
static int |
EAN8
A constant to represent a EAN 8 barcode for use with setType() method.
|
static int |
INTERLEAVED
A constant to represent an Interleaved 2 of 5 barcode for use with setType() method.
|
static int |
PDF417
A constant to represent a PDF417 barcode for use with setType() method.
|
static int |
POSTNET
A constant to represent a Postnet barcode for use with setType() method.
|
static int |
QRCODE
A constant to represent a QR Code barcode for use with setType() method.
|
static int |
ROYALMAIL
A constant to represent a Royal Mail barcode for use with setType() method.
|
static int |
UPCA
A constant to represent a UPC-A barcode for use with setType() method.
|
static int |
UPCE
A constant to represent a UPC-E barcode for use with setType() method.
|
static int |
USPS
A constant to represent a Intelligent Mail barcode for use with setType() method.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAscenderHeight()
Returns the height of the ascender/descender.
|
java.lang.String |
getBarcodeHeight()
Returns the barcode height for the generated barcode.
|
java.lang.String |
getBarcodeWideFactor()
Returns the factor by which wide bars are broader than narrow bars.
|
java.lang.String |
getBaselinePosition()
Returns the position of the baseline on the barcode.
|
java.lang.String |
getChecksum()
Returns the checksum mode
|
java.lang.String |
getDataMatrixShape()
Returns the data matrix shape.
|
int |
getErrorCorrectionLevel()
Returns the error correction of the barcode
|
java.lang.String |
getFontName()
Returns the font name of the human readable part
|
int |
getFontSize()
Returns the font size of the human readable part
|
int |
getImageResolution()
Returns the image resolution (dots per inch)
|
java.lang.String |
getInterCharGap()
Returns the width between encoded characters.
|
int |
getMaxCols()
Returns the maximum number of columns of the barcode
|
int |
getMaxRows()
Returns the maximum number of rows of the barcode
|
Text |
getMessage()
Returns the text for the barcode.
|
java.lang.String |
getMessagePosition()
Returns the position of the message text of the barcode.
|
int |
getMinCols()
Returns the minimum number of columns of the barcode
|
int |
getMinRows()
Returns the minimum number of rows of the barcode
|
java.lang.String |
getModuleWidth()
Returns the width for the generated barcode.
|
int |
getOrientation()
Returns image orientation on the page.
|
java.lang.String |
getPattern()
Returns the pattern to be applied over the human readable message
|
java.lang.String |
getQuietZone()
Returns the width of the quiet zone left and right of the barcode in mm (gap either side of the barcode)
|
java.lang.String |
getQuietZoneVertical()
Returns the vertical quiet zone (gap above and below the barcode)
|
java.lang.String |
getShortBarHeight()
Returns the height of a short bar.
|
java.lang.String |
getTemplate()
Returns the message template with the fields for the EAN message
|
java.lang.String |
getTrackheight()
Returns the height of the track
|
int |
getType()
Returns the barcode type for the generated barcode.
|
java.lang.String |
getWidthToHeightRatio()
Returns the ratio of the barcode width to the height.
|
boolean |
isDisplayChecksum()
Returns whether to display the checksum digit at the end of the barcode
|
boolean |
isDisplayStartStop()
Indicates whether the start and stop character will be displayed as part of the human-readable message.
|
boolean |
isImageGrayscale()
Returns whether the image should be rendered gray scaled and anti aliased
|
boolean |
isOmitBrackets()
Returns whether to include the brackets in the human readable part of the message
|
boolean |
isQuietZoneEnabled()
Returns whether the quiet zone should be rendered
|
void |
setAscenderHeight(java.lang.String ascenderHeight)
Sets the height of the ascender/descender.
|
void |
setBarcodeHeight(java.lang.String barcodeHeight)
Sets the barcode height for the generated barcode.
|
void |
setBarcodeWideFactor(java.lang.String barcodeWideFactor)
Sets the factor by which wide bars are broader than narrow bars.
|
void |
setBaselinePosition(java.lang.String baselinePosition)
Sets the position of the baseline on the barcode.
|
void |
setChecksum(java.lang.String checksum)
Sets the checksum mode.
|
void |
setDataMatrixShape(java.lang.String dataMatrixShape)
Returns the data matrix shape.
|
void |
setDisplayChecksum(boolean displayChecksum)
Sets whether to display the checksum digit at the end of the barcode
|
void |
setDisplayStartStop(boolean displayStartStop)
Sets whether the start and stop character will be displayed as part of the human-readable message.
|
void |
setErrorCorrectionLevel(int errorCorrectionLevel)
Sets the error correction of the barcode
|
void |
setFontName(java.lang.String fontName)
Sets the font name of the human readable part
|
void |
setFontSize(int fontSize)
Sets the font size of the human readable part
|
void |
setImageGrayscale(boolean imageGrayscale)
Sets the image gray scale.
|
void |
setImageResolution(int imageResolution)
Sets the image resolution (dots per inch)
|
void |
setInterCharGap(java.lang.String interCharGap)
Sets the width between encoded characters.
|
void |
setMaxCols(int maxCols)
Sets the maximum number of columns of the barcode
|
void |
setMaxRows(int maxRows)
Sets the maximum number of rows of the barcode
|
void |
setMessagePosition(java.lang.String messagePosition)
Sets the position of the message text of the barcode.
|
void |
setMinCols(int minCols)
Sets the minimum number of columns of the barcode
|
void |
setMinRows(int minRows)
Sets the minimum number of rows of the barcode
|
void |
setModuleWidth(java.lang.String moduleWidth)
Sets the width for the generated barcode.
|
void |
setOmitBrackets(boolean omitBrackets)
Sets whether to include the brackets in the human readable part of the message
|
void |
setOrientation(int orientation)
Sets the image orientation on the page.
|
void |
setPattern(java.lang.String pattern)
Sets the pattern to be applied over the human readable message
|
void |
setQuietZone(java.lang.String quietZone)
Set the width of the quiet zone left and right of the barcode in mm (gap either side of the barcode)
|
void |
setQuietZoneEnabled(boolean quietZoneEnabled)
Set whether the quiet zone should be rendered.
|
void |
setQuietZoneVertical(java.lang.String quietZoneVertical)
Sets the vertical quiet zone (gap above and below the barcode)
|
void |
setShortBarHeight(java.lang.String shortBarHeight)
Sets the height of a short bar.
|
void |
setTemplate(java.lang.String template)
Sets the message template with the fields for the EAN message
|
void |
setTrackheight(java.lang.String trackheight)
Sets the height of the track
|
void |
setType(int type)
Sets the barcode type for this barcode.
|
void |
setWidthToHeightRatio(java.lang.String widthToHeightRatio)
Sets the ratio of the barcode width to the height.
|
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show
getElementName, getElementType
addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages
static final int CODABAR
static final int CODE128
static final int CODE39
static final int DATAMATRIX
static final int POSTNET
static final int INTERLEAVED
static final int PDF417
static final int EAN13
static final int EAN8
static final int UPCA
static final int UPCE
static final int ROYALMAIL
static final int USPS
static final int EAN128
static final int QRCODE
int getType()
setType(int)
void setType(int type)
getType()
java.lang.String getBarcodeHeight()
setBarcodeHeight(String)
void setBarcodeHeight(java.lang.String barcodeHeight)
double
number.
getBarcodeHeight()
java.lang.String getModuleWidth()
setModuleWidth(String)
void setModuleWidth(java.lang.String moduleWidth)
getModuleWidth()
boolean isQuietZoneEnabled()
setQuietZoneEnabled(boolean)
void setQuietZoneEnabled(boolean quietZoneEnabled)
isQuietZoneEnabled()
java.lang.String getQuietZone()
setQuietZone(String)
void setQuietZone(java.lang.String quietZone)
getQuietZone()
java.lang.String getMessagePosition()
setMessagePosition(String)
void setMessagePosition(java.lang.String messagePosition)
Value | Description |
---|---|
top | The human readable part is displayed at the top of the barcode |
bottom | The human readable part is displayed at the bottom of the barcode |
none | No text is shown |
getMessagePosition()
int getImageResolution()
setImageResolution(int)
void setImageResolution(int imageResolution)
setImageResolution(int)
boolean isImageGrayscale()
setImageGrayscale(boolean)
void setImageGrayscale(boolean imageGrayscale)
isImageGrayscale()
int getOrientation()
setOrientation(int)
void setOrientation(int orientation)
integer
value and represents degrees in a circle.setOrientation(int)
Text getMessage()
java.lang.String getBarcodeWideFactor()
setBarcodeWideFactor(String)
void setBarcodeWideFactor(java.lang.String barcodeWideFactor)
Codabar
and Interleaved
barcodes
getBarcodeWideFactor()
,
CODABAR
,
INTERLEAVED
int getFontSize()
setFontSize(int)
void setFontSize(int fontSize)
getFontSize()
java.lang.String getFontName()
setFontName(String)
void setFontName(java.lang.String fontName)
getFontSize()
java.lang.String getPattern()
setPattern(String)
void setPattern(java.lang.String pattern)
getPattern()
java.lang.String getChecksum()
This value is supported by the Code 39
, EAN 128
, Post Net
, Royal Mail
and Intelligent Mail
barcodes
setChecksum(String)
,
isDisplayChecksum()
,
CODE39
,
EAN128
,
POSTNET
,
ROYALMAIL
,
USPS
void setChecksum(java.lang.String checksum)
Checksum Mode Value | Description |
---|---|
add | Adds the necessary checksum to the message to be encoded |
auto | Chooses the barcode's default checksum behaviour |
ignore | Doesn't check nor add a checksum |
check | Requires the check character to be present in the message. This is a digitally generated digit appended to the end of the barcode to ensure the barcode is composed correctly |
This value is supported by the Code 39
, EAN 128
, Post Net
, Royal Mail
and Intelligent Mail
barcodes
getChecksum()
,
isDisplayChecksum()
,
CODE39
,
EAN128
,
POSTNET
,
ROYALMAIL
,
USPS
boolean isDisplayChecksum()
This value is supported by the Code 39
, EAN 128
, Post Net
, Royal Mail
and Intelligent Mail
barcodes
setChecksum(String)
,
setDisplayChecksum(boolean)
,
CODE39
,
EAN128
,
POSTNET
,
ROYALMAIL
,
USPS
void setDisplayChecksum(boolean displayChecksum)
This value is supported by the Code 39
, EAN 128
, Post Net
, Royal Mail
and Intelligent Mail
barcodes
setChecksum(String)
,
isDisplayChecksum()
,
CODE39
,
EAN128
,
POSTNET
,
ROYALMAIL
,
USPS
java.lang.String getInterCharGap()
double
value
This value is supported by the Code 39
, Post Net
, Royal Mail
and Intelligent Mail
barcodes
setInterCharGap(String)
,
CODE39
,
POSTNET
,
ROYALMAIL
,
USPS
void setInterCharGap(java.lang.String interCharGap)
double
value
This value is supported by the Code 39
, Post Net
, Royal Mail
and Intelligent Mail
barcodes
getInterCharGap()
,
CODE39
,
POSTNET
,
ROYALMAIL
,
USPS
boolean isDisplayStartStop()
This value is supported by the Code 39
barcode
setDisplayStartStop(boolean)
,
CODE39
void setDisplayStartStop(boolean displayStartStop)
This value is supported by the Code 39
barcode
isDisplayStartStop()
,
CODE39
java.lang.String getDataMatrixShape()
This value is supported by the Datamatrix
barcode
setDataMatrixShape(String)
,
DATAMATRIX
void setDataMatrixShape(java.lang.String dataMatrixShape)
This value is supported by the Datamatrix
barcode
Value | Description |
---|---|
force-none | The human-readable part is suppressed. |
force-square | The barcode is displayed as a square. |
force-rectangle | The barcode is displayed as a rectangle |
getDataMatrixShape()
,
DATAMATRIX
java.lang.String getBaselinePosition()
This value is supported by the Postnet
barcode
setBaselinePosition(String)
,
POSTNET
void setBaselinePosition(java.lang.String baselinePosition)
This value is supported by the Postnet
barcode
Value | Description |
---|---|
top | The bar is displayed at the top of the barcode |
bottom | The bar is displayed at the bottom of the barcode |
setBaselinePosition(String)
,
POSTNET
java.lang.String getShortBarHeight()
This value is supported by the Postnet
barcode
setShortBarHeight(String)
,
POSTNET
void setShortBarHeight(java.lang.String shortBarHeight)
This value is supported by the Postnet
barcode
getShortBarHeight()
,
POSTNET
java.lang.String getQuietZoneVertical()
This value is supported by the Postnet
barcode
setQuietZoneVertical(String)
,
POSTNET
void setQuietZoneVertical(java.lang.String quietZoneVertical)
This value is supported by the Postnet
barcode
getQuietZoneVertical()
int getMaxRows()
This value is supported by the PDF417
barcode
setMaxRows(int)
,
PDF417
void setMaxRows(int maxRows)
This value is supported by the PDF417
barcode
getMaxRows()
,
PDF417
int getMinRows()
This value is supported by the PDF417
barcode
setMinRows(int)
,
PDF417
void setMinRows(int minRows)
This value is supported by the PDF417
barcode
getMaxRows()
,
PDF417
int getMaxCols()
This value is supported by the PDF417
barcode
setMaxCols(int)
,
PDF417
void setMaxCols(int maxCols)
This value is supported by the PDF417
barcode
getMaxCols()
,
PDF417
int getMinCols()
This value is supported by the PDF417
barcode
setMinCols(int)
,
PDF417
void setMinCols(int minCols)
This value is supported by the PDF417
barcode
getMinCols()
,
PDF417
java.lang.String getWidthToHeightRatio()
This value is supported by the PDF417
barcode
setWidthToHeightRatio(String)
,
PDF417
void setWidthToHeightRatio(java.lang.String widthToHeightRatio)
This value is supported by the PDF417
barcode
getWidthToHeightRatio()
,
PDF417
int getErrorCorrectionLevel()
This value is supported by the PDF417
barcode
setErrorCorrectionLevel(int)
,
PDF417
void setErrorCorrectionLevel(int errorCorrectionLevel)
This value is supported by the PDF417
barcode
getErrorCorrectionLevel()
,
PDF417
java.lang.String getTemplate()
This value is supported by the EAN 128
barcode
setTemplate(String)
,
EAN128
void setTemplate(java.lang.String template)
This value is supported by the EAN 128
barcode
getTemplate()
,
EAN128
boolean isOmitBrackets()
This value is supported by the EAN 128
barcode
setOmitBrackets(boolean)
,
EAN128
void setOmitBrackets(boolean omitBrackets)
This value is supported by the EAN 128
barcode
isOmitBrackets()
,
EAN128
java.lang.String getTrackheight()
This value is supported by the Royal Mail
and Intelligent mail
barcode
setTrackheight(String)
,
ROYALMAIL
,
USPS
void setTrackheight(java.lang.String trackheight)
This value is supported by the Royal Mail
and Intelligent mail
barcode
getTrackheight()
,
ROYALMAIL
,
USPS
java.lang.String getAscenderHeight()
This value is supported by the Royal Mail
and Intelligent mail
barcode
setTrackheight(String)
,
ROYALMAIL
,
USPS
void setAscenderHeight(java.lang.String ascenderHeight)
This value is supported by the Royal Mail
and Intelligent mail
barcode
setTrackheight(String)
,
ROYALMAIL
,
USPS