IDAutomation Java Barcode Package User Manual

• Properties of the Linear BarCode Class
• Linear Barcodes Types Supported
• PDF417 Class Properties
• DataMatrix Class Properties
• Maxicode Class Properties
• Applet Implementation
• JPEG and GIF File Encoder Implementation
• Java Barcode Servlet Implementation
• How to create the barcode in a java.awt.Image object
• Oracle Reports Implementation
• It is important to have the ability to test the barcodes printed with a barcode scanner. If a barcode scanner is not currently owned, IDAutomation also sells high quality complete barcode scanner kits.

This section explains the main properties, methods and configuration parameters of the package. This class is a descendant of java.awt.Canvas and may be used in any java container. IDAutomation suggests leaving all properties at their defaults unless they absolutely need to be changed.

High quality GIF and JPEG images may be easily created with the encoder. Before creating a JPEG file with the Java Package, the following requirements must be met:

1. Place the jar or class files in the CLASSPATH - in Windows®, this is accomplished by modifying the CLASSPATH environment variable to include the full path to the JAR file. For example, the following will add LinearBarCode.jar to the classpath:
   SET CLASSPATH=.;c:\java\classroot\;c:\jars\LinearBarCode.jar
   The files in the JAR file may also be extracted to the classpath root, making sure the proper directories defined in the JAR are created.
2. Make sure the period (this represents the current directory) is in the classpath as in the example above.

3. Install JDK 1.2 or above or verify that JDK 1.2 or above is installed on the server. The encoder requires Java 2 or JDK 1.2 or above to create the JPEG files used by the servlet.
   Special requirements for Linux and UNIX servers:

   • Be sure Java.awt GUI functions are available in the environment. If the Java environment has the java.awt library stripped out, then the encoder will be unable to create image files.
   • If the UNIX or Linux server does not have an X-Window environment, then either (1) use Headless Java or (2) connect to a remote X Server or (3) install the X Windows environment and run an X Windows session or (4) install an emulator, PJA library or virtual frame buffer as described in the XWindow Error KB Document.

How to create a JPEG or GIF image file:

This is a very simple example of the Java source code used to create an image file from the Linear Java Barcode Package.

import com.idautomation.linear.*;
import com.idautomation.linear.encoder.*;
class CreateImageExample {
   public static void main ( String [] args ) {
      BarCode bc=new BarCode();
      bc.code="123456789";
      bc.barType=bc.CODE39;
      barCodeEncoder bce = new barCodeEncoder(bc, "JPEG", "newfile.jpeg");
      // To create a GIF instead, use
      // barCodeEncoder bce = new barCodeEncoder(bc, "GIF", "newfile.gif");
      System.exit(0);
   }
}

Additional examples are provided in the package download for each symbology.

IDAutomation's Java Servlets may be used to add server-side barcode generation capability to a dedicated web server. IDAutomation's Servlet is compatible with all browsers and is easy to embed in HTML as an image with the <IMG> tag.

Servlet Implementation:

IDAutomation offers a tutorial for servlet implementation with Apache Tomcat. Additional examples are provided below.

Example Using JSDK:

1. Place the barcode JAR or class files in the CLASSPATH. In Windows®, this is accomplished by modifying the CLASSPATH environment variable to include the full path to the JAR file. As an example, the following will add LinearBarCode.jar to the classpath:
   SET CLASSPATH=.;c:\java\classroot\;c:\jars\LinearBarCode.jar

2. Install JDK 1.2 or above or verify that JDK 1.2 or above is installed on the server. The encoder requires Java 2 or JDK 1.2 or above to create the JPEG files used by the servlet.
   Special requirements for Linux and Unix servers:

   1. Be sure Java.awt GUI functions are available in the environment. If the Java environment has the java.awt library stripped out, then the encoder will be unable to create image files.
   2. If the UNIX or Linux server does not have an X-Window environment, then either (1) use Headless Java or (2) connect to a remote X Server or (3) install the X Windows environment and run an X Windows session or (4) install an emulator, PJA library or virtual frame buffer as described in the XWindow Error KB Document. If the server has problems with the X-Windows environment and the situation cannot be modified, consider using IDAutomation’s Dynamic Barcode Generation Service which is a fault tolerant, hosted product that performs the same functions of the Java servlet.
3. Install the appropriate servlet server code on the server and make sure it is specified in the CLASSPATH. For example:
   SET CLASSPATH=.;c:\java\classroot\;c:\jars\LinearBarCode.jar;c:\jsdk2.1\server.jar;c:\jsdk2.1\servlet.jar
4. Per the JSDK instructions, edit c:\jsdk2.1\examples\WEB-INF\servlets.properties to include the following statement:
   LinearServlet.code=com.idautomation.linear.IDAutomationServlet
5. Next, start the servlet server by executing C:\jsdk2.1\startserver.bat.
6. After the servlet server is started, type the following code into the browser and specify applet parameters to create the barcode. This URL creates the a barcode encoding "12345678" with a height if .8cm:
   http://localhost:8080/examples/servlet/LinearServlet?BARCODE=12345678&BAR_HEIGHT=.8

Servlet Implementation Using ServletExec ISAPI on Windows® Server:

1. In the servlet administration area choose Configure.
2. Choose Add Servlet and enter the servlet name, class and code base.
3. Choose Submit and choose to Reload the new servlet.
4. The servlet should now be viewable online by entering a URL such as
   http://yourserver.com/servlet/LinearServlet?BARCODE=12345678

Inserting barcodes into HTML - after the servlet is working:

1. Barcodes may be integrated within web pages and HTML forms by using an IMG tag, for example:
   <img src="http://idautomation.reinvent.ws/servlet/LinearServlet?HEIGHT=80&WIDTH=170&BARCODE=12345678&BAR_HEIGHT=.8">
   Notice in the above code that the HEIGHT and BAR_HEIGHT are different. The HEIGHT and WIDTH parameter should be set to the maximum allowed barcode size within a form.

2. The image that is created defaults to the screen resolution of 96 DPI and may be compressed if necessary to obtain smaller X dimensions or precision. Because of the screen’s resolution, the X dimension can only be adjusted within increments of .03cm. For example, if an X dimension of .015 is needed, the image on the web page must be compressed by 50%. The following HTML tag reduces the image by 50%; it will not look correct on the screen but it will print correctly.
   <IMG height=40 alt="Barcode Image" src="http://javabarcoding.com/servlet/lin?HEIGHT=80&WIDTH=160&BARCODE=12345678" width=80>

Creating secure servlets:

Other methods of servlet operation can be accomplished by developers that modify the servlet source code provided. This may be necessary to make sure the end-user cannot manipulate the servlet. A working example is provided in the IDAutomationSecureServlet.java file which is in the source code ZIP file in the package.

Auto-sizing and performance considerations:

When using the Servlet, auto sizing of the image is disabled if the HEIGHT and WIDTH are manually specified. Because a temp image is created to determine the size, performance is improved by specifying the size.

The following code illustrates how to create a barcode in a java.awt.Image object:

BarCode bc=new BarCode();
bc.setSize(400,200);
// create image
java.awt.image.BufferedImage image = new java.awt.image.BufferedImage( bc.getSize().width,bc.getSize().height,java.awt.image.BufferedImage.TYPE_BYTE_INDEXED );

// get graphic context of image
java.awt.Graphics imgGraphics = image.createGraphics();

// paint barcode in graphics context of image
bc.paint(imgGraphics );

An applet can easily display barcodes in HTML pages. However, applets do not always work on all web browsers, more about applet problems....

Example of how to use the applet in HTML:

<APPLET CODEBASE = "./"
ARCHIVE = "LinearBarCode.jar"
CODE = "com.idautomation.linear.BCApplet.class"
NAME = "TestApplet"
WIDTH = 500 HEIGHT = 200 HSPACE = 0 VSPACE = 0 ALIGN = middle >
<PARAM NAME = "BARCODE" VALUE = "123456789012">
<PARAM NAME = "CODE_TYPE" VALUE = "CODE39">
<PARAM NAME = "LEFT_MARGIN" VALUE = "1">
<PARAM NAME = "TOP_MARGIN" VALUE = "1">
<PARAM NAME = "FONT_COLOR" VALUE = "BLUE">
<PARAM NAME = "TEXT_FONT" VALUE = "ARIAL|BOLD|14">
<PARAM NAME = "CHECK_CHAR" VALUE = "N">
<PARAM NAME = "BAR_HEIGHT" VALUE = "2"> </APPLET>

The size must be specified when using the applet. Parameters can be provided in the Applet PARAM tag or from Javascript. For example, the following code will set a new value for the barcode:

TestApplet.setParameter(BARCODE,"new value");
TestApplet.refresh();

An example of using the applet is provided in the ZIP file download. The file is named "LinearAppletTest.html".

Applet Pre-Loading

The time it takes to create barcodes on web pages using applets can be reduced by pre-loading the applet on a previous page. This type of implementation places the JAR file in the browser's cache and allows quick barcode generation - even over slow dial-up lines. The following JavaScript code pre-loads the Linear Barcode Package.

<APPLET
CODE = "com.idautomation.linear.BCApplet"
ARCHIVE = "LinearBarCode.jar"
NAME = "PreloadApplet"
WIDTH = 1 HEIGHT = 1 HSPACE = 0 VSPACE = 0 ALIGN = top >
</APPLET>

The following is a short description of some of the barcode types:

• CODE128: Code 128 is a full ASCII barcode type. This barcode selection will always calculate the mandatory check character (modulus 103). Code 128 has several capabilities when the character set is "0" for automatic (the default setting), these include:
  UCC/EAN-128 Encoding: to encode alpha-numeric UCC/EAN128, the character set must be "0" or "AUTO" for automatic (the default setting). ASCII 202 or character Ê is recognized as the FNC1 before each AI. When a barcode begins with an AI, the required start C is included automatically. For example, the UCC number of (8100)712345(21)12WH5678 should be entered as: Ê8100712345Ê2112WH5678. In most cases, the AIs will be properly represented in the human readable text. If the parenthesis is not around the correct number for the AI, enter the following extended ASCII character as the FNC1 for the correct number of digits in your AI:
  ASCII 212 or ~212 = 2 digits        ASCII 213 or ~213  = 3 digits
  ASCII 214 or ~214 = 4 digits        ASCII 215 or ~215  = 5 digits
  ASCII 216 or ~216 = 6 digits      ASCII 217 or ~217  = 7 digits
  For example, to encode (1277)56, enter Ö127756.
  However, there are exceptions. When using the servlet, the FNC1 must be encoded as ~nnn where nnn is the ASCII code to encode. This is because certain characters are reserved in HTML for special purposes. For example, the UCC number of (8100) 712345 (21) 12WH5678 should be entered as: ~2148100712345~2122112WH5678.
  Process Tilde Options - when the symbology is Code 128, the character set is AUTO and processTilde is enabled (the default setting), the following options are available:
  • Encode ASCII characters: the format ~ddd may be used to specify the ASCII code of the character to be encoded. For example, if entering the following text in the Data field: 128~029TEST it will actually be encoding 128GSTEST where GS is a delimiter ASCII 29 character. Other commonly used ASCII codes are ~032 the space, ~202 the FNC1, ~197 the FNC2, ~009 the tab and ~013 which is a return function. For encoding other functions, please refer to the ASCII chart.
  • Create a Mod 10 Check digit: to create a Mod 10 check digit for xx number of characters add the following to the DataToEncode: ~mnn (where nn is a 2 digit number representing the number of characters preceding the tilde in which to base the Mod 10 calculation). The additional MOD 10 check digit is commonly used in UCC or EAN barcode types.
• CODE39: Code 39 is an alphanumeric barcode that can encode numbers, upper case letters, and the following special symbols: _ . * $ / % +. If the CHECK_CHAR flag is set to true, the Java BarCode Class will calculate the optional check character (modulus 43) which is recommended for LOGMARS.
• CODE39EXT: Extended Code 39 encodes the full 128 character ASCII character set.
• INTERLEAVED25 or ITF: Interleaved 2 of 5 code is a numeric only bar code. If the CHECK_CHAR flag is set to true, the Java BarCode Class will calculate the optional modulus 10 check character.
• UPCA: UPC-A is used for marking retail products in the USA.
• UPCE: The UPC-E code is a compressed barcode which is intended for use on small items. Compression works by squeezing extra zeroes or ones out of the barcode and then automatically re-inserting them at the scanner. It will automatically switch to the correction suppression mode depending on if the first digit is a zero (0) or a one (1).
• EAN8: EAN-8 is a shortened version of the EAN-13 code.
• EAN13: EAN-13 encodes 13 digits: the first two or three are a country code which identify the country in which the manufacturer is registered (not necessarily where the product is actually made). The country code is followed by 9 or 10 data digits (depending on the length of the country code) and a checksum digit.
• MSI: The MSI Code is a numeric barcode that has been used primarily in libraries and retail applications such as grocery store shelves. If the CHECK_CHAR flag is set to true, the Java BarCode Class will calculate the modulus 10 check character.
• CODE11: Code 11 is a numeric, high density code with one special character "-". If the CHECK_CHAR flag is set to true, the Java BarCode Class will calculate check character. If the value to be encoded is longer than 10 digits, a second check character will be calculated and added.
• CODE93: Code 93 is a more compact version of Code 39. It encodes exactly the same characters as Code 39, but uses 9 barcode elements per character instead of 15. If the CHECK_CHAR flag is set to true, the Java BarCode Class will calculate the two required checksum characters.
• IND25: Industrial 2 of 5 (also called Code 2 of 5) is a numeric-only barcode that has been in use a long time. Unlike Interleaved 2 of 5, all of the information is encoded in the bars; the spaces are fixed width and are used only to separate the bars. The code is self-checking and does not include a checksum.
• CODABAR: Codabar is a discrete, numeric code with special characters (-$:/.+). If the CHECK_CHAR flag is set to true, the Java BarCode Class will calculate the optional modulus 16 check character.
• POSTNET and PLANET: This barcode type is specific to the USPS. For barcodes to be easily scanned at the US post offices, they must be between 22 and 24 bars per inch. The default X dimension setting may need to be adjusted accordingly. The resolution may also need to be adjusted.
• UCC128: This symbology option encodes an even number of number digits and includes the FNC1 character in set C as required. Use Code 128 Auto to encode additional FNC1 codes or data containing text or odd numbers. Use the UCC128 function only for UCC-128 applications where the input data is an even number such as in SSCC-18 and SCC-14 barcodes. For example, to encode an SSCC-18 barcode, you would enter 00000123455555555558 as the data input. For more information, please visit UCC/EAN 128 website.
• ONECODE: OneCode is the United States Post Office's new barcode solution. It is also known as the USPS 4-State Customer Barcode (abbreviated USPS4CB, 4CB or 4-CB). For more information, please visit the OneCode website. For barcodes to be easily scanned at the US post offices, they must be between 22 and 24 bars per inch. The default X dimension setting may need to be adjusted accordingly. The resolution may also need to be adjusted.

This section explains the main properties, methods and configuration parameters of the PDF417 package. For a more complete list, review the index of fields and methods. Specific implementation examples and code may be found within the 2D package. Additional information about this symbology is provided in the PDF417 Symbology FAQ.

This section explains the main properties, methods and configuration parameters of the package. For a more complete list, review the index of fields and methods. Specific implementation examples and code may be found within the 2D package. Additional information about this symbology is provided in the DataMatrix Symbology FAQ.

This section explains the main configuration parameters of the MaxiCode class. For a more complete list, review the index of fields and methods. Specific implementation examples and code may be found within the 2D package. Additional information about this symbology is provided in the Maxicode Symbology FAQ.

For more information about the various barcode symbologies, please visit the IDAutomation.com Support Site and select the symbology from the list of symbology FAQs.

To stay informed about software updates or new products, subscribe to IDAutomation's Newsletter or RSS Feed.
 

Product Quick Links: [Barcode Fonts | Font Tools | Components | Label Software | Scanners | Printers | RFID]

Copyright © 2000-2006 IDAutomation.com, Inc. IDAutomation and BizFonts are registered trademarks of IDAutomation.com, Inc. All other trademarks mentioned are the property of their respective owners.