Previous Next

Using Java to Write an Event Handler

Using Java to Write an Event Handler

Creating a Java event handler is slightly more complex than creating a JavaScript event handler. You cannot simply enter Java code directly in the BIRT Report Designer.

To create a Java event handler class, you must compile the source for the Java class and make certain that the class is visible to BIRT. Creating a Java event handler for BIRT is simplified, however, by the fact that Eclipse is a robust Java development environment and supports integrating a Java project with a BIRT project.

How to create an event handler class and add it to the Java project

This section describes the process for using the Eclipse Java development environment to create an event handler class for a scriptable BIRT element.

1
1
Select your Java project and choose File->Properties->Java Build Path->Libraries. Java Build Path appears, as shown in Figure 24‑1.

Figure 24-1 Adding a JAR file to the compiler’s classpath

Figure 24-1
2
3
Navigate to Eclipse /plugins directory. In a default Eclipse installation, this directory is in the following location:
<ECLIPSE_INSTALL>\eclipse\plugins
4
5
2
Select your Java project and choose File->New->Other. Select a wizard appears.
3

Figure 24-2 The Select a wizard dialog

Figure 24-2
Choose Next. New Java Class appears, as shown in Figure 24‑3.

Figure 24-3 New Java Class

Figure 24-3
4
Navigate to the folder where you want the Java source file to reside by choosing the Browse button beside Source Folder.
5
6
7
8

Figure 24-4 Superclass Selection

Figure 24-4
9
In Choose a type, type the name of the adapter class for the ROM element. For example, enter Label EventAdapter for the Label element. Choose OK. New Java Class reappears.
10

Figure 24-5 The Java editor

Figure 24-5
11
Add the event handler method for your new event handler class. Figure 24‑6 shows the addition of an onPrepare( ) method that sets the background color of the label to red.

Figure 24-6 The onPrepare( ) method in the Java editor

Figure 24-6
The onPrepare( ) method in the Java editor

How to associate a Java class with a report element

The example in this procedure makes the following assumptions:

n
n
1

Figure 24-7 Selecting a report element

Figure 24-7
2
In Property Editor for the selected report element, select Event Handler and enter the fully qualified name of the event handler class, as shown in Figure 24‑8.

Figure 24-8 The event handler class name

Figure 24-8


(c) Copyright Actuate Corporation 2008