Java Barcode Package User Manual & Tutorial

INDEX:

• Java Barcode Package Overview
• Java Barcode Installation and Implementation
  • Installing and Testing the JAR File
  • JPEG & GIF Encoder Example
  • Applet
  • Servlet
  • Image Object with java.awt.Image
  • Oracle Reports
• Properties:
  • Linear
  • Aztec
  • Data Matrix
  • Maxicode
  • PDF417
• Support

If a barcode scanner is needed, IDAutomation provides several types of high-quality USB Barcode Scanners.

IDAutomation's Java Barcode Packages are mature barcode generator components that have been in use since 2000. Multiple capabilities of this product are provided in a single JAR file to ease installation, use and upgrades. All IDAutomation Java Barcode Packages include the following components:

1. Barcode class library - includes all necessary class files for java barcode generation.
2. Applet - allows easy applet implementation.
3. Servlet - enables servlet use with applet parameters.
4. Encoder - used to convert java.awt images obtained from the barcode class into JPEG or GIF files.
5. Source code - includes source code to the applet, servlet, encoder and examples. The source code for the java barcode generator class should not be needed; however, it is available with the purchase of the Unlimited Developer License and a signed Source Code License Agreement.

This Java library is easily utilized after the JAR file is installed in the Java classpath environment. There are some exceptions, such as when integrating source code or class files directly, or servlet implementation with Apache Tomcat. However, for most purposes, the JAR file must be installed.

Installing and Testing the Barcode JAR File:

The following example uses the Linear Java Barcode Package. When using other packages, the associated file should be replaced accordingly.

1. Install Java and ensure the Java executables are included in the search path. For example: after installing JDK 1.3 in Windows, c:\jdk1.3\bin must be appended to the path environment variable so that the complete path looks something like %SystemRoot%\system32;%SystemRoot%;c:\jdk1.3\bin. In Windows®, the path environment is created or edited by choosing My Computer - Properties - Advanced System Settings - Environment Variables.
2. Copy LinearBarCode.jar from the package to C:\IDAutomation or a production directory of choice.
3. Add both the JAR file and the period to the classpath environment variable. The specification of the JAR file enables the barcode library to be available for Java programs. The period allows Java applications to run in the current directory, which is convenient for testing. In Windows, the classpath environment variable may be created or edited by choosing My Computer - Properties - Advanced System Settings - Environment Variables. The classpath should look something like C:\IDAutomation\LinearBarCode.jar;. The "SET CLASSPATH" command may be used from the command prompt to verify that classpath.
4. Download IDAutomation_LinearJavaEncoderTestApplication.zip and extract the files into a temp directory such as c:\temp. From the temp files extracted, execute the CreateJPEG class file in Java; Windows users may simply execute run.bat instead. When asked, enter the data of "IDAUTOMATION" and verify a JPEG file is created.
5. If problems are encountered, verify the above steps were completed properly and ensure the Java.awt GUI functions are available. If the Java environment has the java.awt library stripped out or the system running Java does not have an active GUI environment, 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.

Java Applets are included with all IDAutomation JAR files of the Java Barcode Packages. An applet may be used to easily display barcodes in web pages with compatible web browsers. An example of using the applet in HTML is provided in the package download. Properties are modified by changing the appropriate Applet Parameter.

HTML Code Example:

<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 may 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();

Applet Pre-Loading

The time it takes to create barcodes on web pages using applets may 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. 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 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="123456789012";
      barCodeEncoder bce = new barCodeEncoder(bc, "GIF", "newfile.gif");
      System.exit(0);
   }
}

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

Java Servlets are included with all IDAutomation JAR files of the Java Barcode Packages and may be used to add server-side barcode generator capability to a dedicated web server. IDAutomation servlets are compatible with all browsers and are easy to embed in HTML as an image with the <IMG> tag. In addition, IDAutomation java servlet barcodes may be streamed into reports that support dynamic image objects, including Crystal Reports and FileMaker. Properties of the servlet are modified by changing the appropriate Applet Parameter.

Java Barcode Servlet Implementation:

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

Servlet Example with Java Servlet SDK:

1. Install and test the barcode JAR file.
2. Install Java Servlet SDK 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
3. Per the Java Servlet SDK instructions, edit c:\jsdk2.1\examples\WEB-INF\servlets.properties to include the following statement:
   LinearServlet.code=com.idautomation.linear.IDAutomationServlet
4. Start the servlet server by executing C:\jsdk2.1\startserver.bat.
5. After the servlet server is started, paste the following text into a web browser:
   http://localhost:8080/examples/servlet/LinearServlet?BARCODE=12345678

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 Java Barcodes in HTML:

1. Barcodes may be integrated within web pages and HTML forms by use of the IMG tag, for example:
   <img src="http://yourserver.com/servlet/LinearServlet?BARCODE=12345678">
2. The image that is created defaults to 96 dpi and may be compressed or expanded if necessary to obtain better precision.

Creating Secure Servlets:

Other methods of servlet operation may be accomplished by developers that modify the servlet source code provided. This may be necessary to ensure 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 );

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.

Free product support may be obtained by reviewing articles that are documented at the Java Support Site and by searching resolved public help desk issues. Priority phone, e-mail and help desk support is provided up to 30 days after purchase. Additional priority phone, e-mail and help desk support may be obtained if a Priority Support and Upgrade Subscription is active.

© Copyright 2000-2008 IDAutomation.com, Inc., All Rights Reserved. Legal Notices.