Select your printer model
addBarcode
Adds a barcode print command to the command buffer.
Syntax
public void addBarcode(String data, int type, int hri, int font, int width, int height) throws Epos2Exception |
Parameter
data
Specifies barcode data as a text string.
Specify a string in accordance with the standard of the barcode specified in type.
Type |
Description |
---|---|
UPC-A |
If an 11-digit figure is specified, the check digit is automatically appended. If a 12-digit figure is specified, the 12th digit is used as the check digit but verification is not performed. |
UPC-E |
Specify 0 in the first digit. Specify the manufacturer code in the 2nd to 6th digits. Specify the item code in right justification in the 7th to 11th digits. The number of digits of the item code depends on the manufacturer code. Specify 0 in each unused data. If an 11-digit figure is specified, the check digit is automatically appended. If a 12-digit figure is specified, the 12th digit is used as the check digit but verification is not performed. |
EAN13 |
If an 12-digit figure is specified, the check digit is automatically appended. If a 13-digit figure is specified, the 13th digit is used as the check digit but verification is not performed. |
JAN13 |
|
EAN8 |
If an 7-digit figure is specified, the check digit is automatically appended. If an 8-digit figure is specified, the 8th digit is used as the check digit but verification is not performed. |
JAN8 |
|
CODE39 |
If the first character is * , this character is processed as the start character. If it is not , the start character is automatically added. |
ITF |
The start and stop codes are automatically added. Addition and verification of the check digit are not performed. |
CODABAR |
Specify the start character ((A to D, a to d). Specify the stop character ((A to D, a to d). Addition and verification of the check digit are not performed. |
CODE93 |
The start and stop characters are automatically added. The check digit is automatically calculated and added. |
CODE128 |
Specify the start character (CODE A, CODE B, CODE C). The stop character is automatically added. The check digit is automatically calculated and added. To encode the following characters, specify the corresponding 2-digit code starting with { :
When specifying CODE C, specify the barcode data as the control code of the escape sequence. |
CODE128 auto |
The start character, check digit, and stop character are automatically added. The character string added to make the overall width of the CODE128 symbol as mini-mum is automatically converted. In this function, there is no need to specify the code set, and the barcode is printed simply by entering the data to be converted to symbols. Example) When entering numbers: "123", etc. When entering alphabets: "ABCabc", etc. Data from 0 to 255 (control codes and character codes) can be specified. Since the overall width changes automatically, use this function after confirming that the barcode fits into the print area and is printed without any problem. When using FNC1, etc., use CODE128 rather than CODE128 auto. |
GS1-128 |
The start character, FNC1, check digit, and stop characters are automatically added. However, FNC1 used as a data separator is not added. To automatically calculate and add the application ID (AI) and the following check digit, specify "*" at the check digit position. The application ID (AI) can be put in parentheses. The parentheses are used as print characters for HRI and not encoded as data. A blank space can be inserted between the application ID (AI) and data. The blank space is used as print characters for HRI and not encoded as data. To encode the following characters, specify the corresponding 2-digit code starting with { :
|
GS1 DataBar Omnidirectional |
Specify a 13-digit product ID (GTIN) excluding the application ID (AI) and check digit. |
GS1 DataBar Truncated |
|
GS1 DataBar Limited |
|
GS1 DataBar Expanded |
The application ID (AI) can be put in parentheses. The parentheses are used as print characters for HRI and not encoded as data. To encode the following characters, specify the corresponding 2-digit code starting with { :
|
When specifying binary data which cannot be represented as a string, use the following escape sequences.
String |
Description |
---|---|
\xnn |
Control code (set nn in hexadecimal) |
\\ |
Back slash |
type
Specifies the barcode type.
Value |
Description |
---|---|
Printer.BARCODE_UPC_A |
UPC-A |
Printer.BARCODE_UPC_E |
UPC-E |
Printer.BARCODE_EAN13 |
EAN13 |
Printer.BARCODE_JAN13 |
JAN13 |
Printer.BARCODE_EAN8 |
EAN8 |
Printer.BARCODE_JAN8 |
JAN8 |
Printer.BARCODE_CODE39 |
CODE39 |
Printer.BARCODE_ITF |
ITF |
Printer.BARCODE_CODABAR |
CODABAR |
Printer.BARCODE_CODE93 |
CODE93 |
Printer.BARCODE_CODE128 |
CODE128 |
Printer.BARCODE_CODE128_AUTO |
CODE128_AUTO |
Printer.BARCODE_GS1_128 |
GS1-128 |
Printer.BARCODE_GS1_DATABAR_OMNIDIRECTIONAL |
GS1 DataBar Omnidirectional |
Printer.BARCODE_GS1_DATABAR_TRUNCATED |
GS1 DataBar Truncated |
Printer.BARCODE_GS1_DATABAR_LIMITED |
GS1 DataBar Limited |
Printer.BARCODE_GS1_DATABAR_EXPANDED |
GS1 DataBar Expanded |
hri
Specifies the HRI position.
Value |
Description |
---|---|
Printer.HRI_NONE (default) |
No printing. |
Printer.HRI_ABOVE |
Above the barcode |
Printer.HRI_BELOW |
Below the barcode |
Printer.HRI_BOTH |
Both above and below the barcode |
Printer.PARAM_DEFAULT |
Specifies the default value (no printing). |
Printer.PARAM_UNSPECIFIED |
<Obsolete> Not specify. |
font
Specifies the HRI font.
Value |
Description |
---|---|
Printer.FONT_A (default) |
Font A |
Printer.FONT_B |
Font B |
Printer.FONT_C |
Font C |
Printer.FONT_D |
Font D |
Printer.FONT_E |
Font E |
Printer.PARAM_DEFAULT |
Specifies the default value (font A). |
Printer.PARAM_UNSPECIFIED |
<Obsolete> Not specify. |
width
Specifies the width of a single module in dots.
Value |
Description |
---|---|
Integer from 2 to 6 |
Width of a single module (in dots) |
Printer.PARAM_UNSPECIFIED |
<Obsolete> Not specify. |
height
Specifies the height of the barcode in dots.
Value |
Description |
---|---|
Integer from 1 to 255 |
Height of the barcode (in dots) |
Printer.PARAM_UNSPECIFIED |
<Obsolete> Not specify. |
Exception
When the process fails, Epos2Exception with one of the following error status occurs.
Error status |
Description |
---|---|
ERR_PARAM |
An invalid parameter was passed. |
ERR_MEMORY |
Memory necessary for processing could not be allocated. |
ERR_FAILURE |
An unknown error occurred. |
Supplementary explanation
- Use this API at the "beginning of a line."
- When the barcode data specified in data does not conform to the barcode type specified in type, an error will not be returned as an exception and the barcode will not be printed.
- The "CODE 128 auto" type of barcode can be specified when the printer is TM-m30II, TM-m30II-H, TM-m30II-NT, TMm30II-S, TM-m30II-SL, TM-m30III, TM-m30III-H, TM-m50, TM-m50II, TM-m50II-H, TM-T88VII, TM-L100, TM-P20II or TM-P80II.
Quick Access
- [Name]
- [Format]
- [Range]
- [Description]
- [Notes]
- Introduction
- help
- Printer class
- Printer
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- requestPrintJobStatus
- clearCommandBuffer
- addTextAlign
- addLineSpace
- addTextRotate
- addText
- addTextLang
- addTextFont
- addTextSmooth
- addTextSize
- addTextStyle
- addHPosition
- addFeedUnit
- addFeedLine
- addImage
- addLogo
- addBarcode
- addSymbol
- addHLine
- addVLineBegin
- addVLineEnd
- addPageBegin
- addPageEnd
- addPageArea
- addPageDirection
- addPagePosition
- addPageLine
- addPageRectangle
- addRotateBegin
- addRotateEnd
- addCut
- addPulse
- addSound
- addFeedPosition
- addLayout
- addCommand
- getMaintenanceCounter
- resetMaintenanceCounter
- getPrinterSetting
- setPrinterSetting
- getPrinterSettingEx
- setPrinterSettingEx
- setPrinterSettingEx[Obsolete]
- verifyPassword
- getPrinterInformation
- downloadFirmwareList
- getPrinterFirmwareInfo
- verifyUpdate
- updateFirmware
- forceRecover
- forcePulse
- forceStopSound
- forceCommand
- forceReset
- setStatusChangeEventListener
- setReceiveEventListener
- setGetPrinterSettingExListener
- setSetPrinterSettingExListener
- setVerifyPasswordListener
- interval
- LFCPrinter class
- HybridPrinter class
- HybridPrinter
- connect
- disconnect
- startMonitor
- stopMonitor
- getStatus
- sendData
- beginTransaction
- endTransaction
- clearCommandBuffer
- selectPaperType
- waitInsertion
- cancelInsertion
- ejectPaper
- readMicrData
- cleanMicrReader
- forceRecover
- forcePulse
- forceCommand
- forceReset
- paperType
- interval
- waitTime
- mode40Cpl
- setStatusChangeEventListener
- setReceiveEventListener
- LineDisplay class
- LineDisplay
- connect
- disconnect
- getStatus
- sendData
- clearCommandBuffer
- addInitialize
- addCreateWindow
- addDestroyWindow
- addSetCurrentWindow
- addClearCurrentWindow
- addCreateScreen
- addCreateScreenCustom
- addCreateTextArea
- addDestroyTextArea
- addSetCurrentTextArea
- addClearCurrentTextArea
- addSetCursorPosition
- addMoveCursorPosition
- addSetCursorType
- addText
- addReverseText
- addMarqueeText
- addSetBlink
- addSetBrightness
- addBackgroundColor
- addStartSlideShow
- addStopSlideShow
- addDownloadImage
- addRegisterDownloadImage
- addNVImage
- addClearImage
- addSymbol
- addClearSymbol
- addShowClock
- addCommand
- setReceiveEventListener
- Keyboard class
- POSKeyboard class
- BarcodeScanner class
- MSR class
- SimpleSerial class
- GermanyFiscalElement class
- OtherPeripheral class
- CommBox class
- Common to all classes
- Discovery class
- Epos2Exception class
- Log class
- EasySelect class
- EasySelectInfo class
- Appendix
- Status list
- Key code list
- List of Supported Classes
- List of Supported APIs
- Printer-specific Support Information
- TM-m10
- TM-m30
- TM-m30II
- TM-m30II-H
- TM-m30II-NT
- TM-m30II-S
- TM-m30II-SL
- TM-m30III
- TM-m30III-H
- TM-m50
- TM-m50II
- TM-m50II-H
- TM-T20
- TM-T20II
- TM-T20III
- TM-T20IIIL
- TM-T20IV-L
- TM-T20X
- TM-T20X-II
- TM-T60
- TM-T70
- TM-T70II
- TM-T81II
- TM-T81III
- TM-T82
- TM-T82II
- TM-T82III
- TM-T82IIIL
- TM-T82IV-L
- TM-T82X
- TM-T82X-II
- TM-T83II
- TM-T83III
- TM-T83IV
- TM-T88V
- TM-T88VI
- TM-T88VII
- TM-T100
- TM-L90 Liner-Free Label Printer Model
- TM-L100
- TM-U220
- TM-U330
- EU-m30
- TM-P20
- TM-P20II
- TM-P60 (Receipt)
- TM-P60 (Peeler)
- TM-P60II (Receipt)
- TM-P60II (Peeler)
- TM-P80
- TM-P80II
- TM-H6000V
- TM-T20II-i
- TM-T70-i
- TM-T82II-i
- TM-T83II-i
- TM-T88V-i
- TM-T88VI-iHUB
- TM-U220-i
- TM-T70II-DT
- TM-T70II-DT2
- TM-T88V-DT
- TM-T88VI-DT2
- TM-H6000IV-DT
- TM-T88IV
- TM-T90
- TM-L90
- TM-H6000IV