The JavaTM Tutorial
Previous Page Lesson Contents Next Page Start of Tutorial > Start of Trail > Start of Lesson Search
Feedback Form

Trail: Creating a GUI with JFC/Swing
Lesson: Learning Swing by Example

Example Two: SwingApplication

Topics illustrated in this example: Letís look at another simple program, SwingApplication (in a .java source file). Each time the user clicks the button (JButton), the label (JLabel) is updated.

The simple GUI of SwingApplication presents a JButton and a JLabel.

Look and Feel

The following screenshots show the GUI of the SwingApplication, each one with a different look and feel.

Java look and feel

Java look and feel

GTK+ look and feel

GTK+ look and feel

Windows look and feel

Windows look and feel

Mac OS look and feel

Mac OS look and feel



Version Note: The appearance of many look and feels changes from release to release. For example, in v1.5 we expect the Java look and feel to use slightly different colors and decorations, though components will stay the same size as before.
Swing allows you to specify which look and feel your program uses--Java, GTK+, Windows, and so on. The code in bold in the following snippet shows you how SwingApplication specifies that it should use the Java look and feel:
String lookAndFeel = null;
...
lookAndFeel = UIManager.getCrossPlatformLookAndFeelClassName();
...
try {
    UIManager.setLookAndFeel(lookAndFeel);
} catch (Exception e) { }
...// Create and show the GUI...
This code essentially says, "I donít care what the user has chosen. Use the cross-platform (Java) look and feel." You can learn more in the section How to Set the Look and Feel (in the Creating a GUI with JFC/Swing trail).

Setting Up Buttons and Labels

Like most GUIs, the SwingApplication GUI contains a button and a label. (Unlike most GUIs, that's about all that SwingApplication contains.) Here's the code that initializes the button:
JButton button = new JButton("I'm a Swing button!");
button.setMnemonic('i'); 
button.addActionListener(/*...create an action listener...*/);
The first line creates the button. The second sets the letter "i" as the mnemonic that the user can use to simulate a click of the button. For example, in the Java look and feel, typing Alt-i does this. The third line registers an event handler for the button click, as discussed later in this section.

Here's the code that initializes and manipulates the label:

...// where instance variables are declared:
private static String labelPrefix = "Number of button clicks: ";
private int numClicks = 0;

...// in GUI initialization code:
final JLabel label = new JLabel(labelPrefix + "0    ");
...
label.setLabelFor(button);

...// in the event handler for button clicks:
label.setText(labelPrefix + numClicks);
It's pretty straightforward, except for the line that invokes the setLabelFor method. That code exists solely as a hint to assistive technologies, such as screen readers, that the label describes the button.

Now that you know how to set up buttons, you also know much of whatís needed to set up check boxes and radio buttons, as they all inherit from the AbstractButton class. Check boxes are similar to radio buttons, but by convention their selection models are different. Any number of check boxes in a group--none, some, or all--can be selected. On the other hand, by convention only one button can be selected from a group of radio buttons. The following figures show two programs that use check boxes and radio buttons.

CheckBoxDemo

RadioButtonDemo

You'll get a chance to take a closer look at radio buttons in the section Example Six: VoteDialog (in the Creating a GUI with JFC/Swing trail).

Adding Components to Containers

SwingApplication groups its label and button in a container (a JPanel) before adding the components to the frame. Hereís the code that initializes the container:
JPanel panel = new JPanel(new GridLayout(0,1));
panel.add(button);
panel.add(label);
panel.setBorder(BorderFactory.createEmptyBorder(...));
The first line creates the container and assigns it a layout manager--an object that determines the size and position of each component added to the container. The code new GridLayout(0,1) creates a layout manager that forces the containerís contents to be displayed in a single column, with every component having the same size.

The next two lines add the button and the label to the container. The last line adds a border to it. Weíll discuss the border in the next section.

Layout management concepts and individual layout managers are covered in Laying Out Components Within a Container (in the Creating a GUI with JFC/Swing trail).

Adding Borders Around Components

If you take another look at the snapshot of SwingApplication, you'll notice that there is extra space surrounding the JPanel on all four edges.

Screenshot of SwingApplication

Here's the code that adds a border to the panel:
pane.setBorder(BorderFactory.createEmptyBorder(
                                30, //top
                                30, //left
                                10, //bottom
                                30) //right
                                );
The code creates and sets a border that provides some empty space around the containerís contents--30 extra pixels on the top, left, and right and 10 extra pixels on the bottom. Borders are a feature that JPanel inherits from the JComponent class. A Border object isnít a JComponent; instead, itís used by one or more JComponents to paint the componentís edges. You can learn more in How to Use Borders (in the Creating a GUI with JFC/Swing trail).

Handling Events

Every time the user types a character or pushes a mouse button, an event occurs. Any object can be notified of the event. All the object has to do is implement the appropriate interface and be registered as an event listener on the appropriate event source.

SwingApplication class implements an event handler for button clicks (action events). Hereís the relevant code:

 
public class SwingApplication implements ActionListener {
    ...
        JButton button = new JButton("I'm a Swing button!");
        button.addActionListener(this);
    ....

    public void actionPerformed(ActionEvent e) {
        numClicks++;
        label.setText(labelPrefix + numClicks);
   }
}
Every event handler requires three pieces of code:
  1. In the declaration for the event handler class, one line of code specifies that the class either implements a listener interface or extends a class that implements a listener interface. For example:
    public class MyClass implements ActionListener { 
    
  2. Another line of code registers an instance of the event handler class as a listener on one or more components. For example:
    someComponent.addActionListener(instanceOfMyClass);
    
  3. The event handler class has code that implements the methods in the listener interface. For example:
    public void actionPerformed(ActionEvent e) { 
        ...//code that reacts to the action... 
    } 
    
In general, to detect when the user clicks an onscreen button (or does the keyboard equivalent), a program must have an object that implements the ActionListener interface. The program must register this object as an action listener on the button (the event source), using the addActionListener method. When the user clicks the onscreen button, the button fires an action event. This results in the invocation of the action listener's actionPerformed method (the only method in the ActionListener interface). The single argument to the method is an ActionEvent object that gives information about the event and its source.

When the user clicks a button, the button's action listeners are notified.

Swing components can generate many kinds of events. The following table lists a few examples.
Some Events and Their Associated Event Listeners
Act that Results in the Event Listener Type
User clicks a button, presses Enter while typing
in a text field, or chooses a menu item
ActionListener
User closes a frame (main window) WindowListener
User presses a mouse button while the cursor is
over a component
MouseListener
User moves the mouse over a component MouseMotionListener
Component becomes visible ComponentListener
Component gets the keyboard focus FocusListener
Table or list selection changes ListSelectionListener
Any property in a component changes such as
the text on a label
PropertyChangeListener

To learn more about how to detect events from a particular component, refer to each component's how-to section in Using Swing Components (in the Creating a GUI with JFC/Swing trail).


Note: Event-handling code executes in an single thread, the event-dispatching thread. This ensures that each event handler finishes execution before the next one executes. For instance, the actionPerformed method in the preceding example executes in the event-dispatching thread. Painting code also executes in the event-dispatching thread. Therefore, event-handling code should execute quickly so that the programís GUI stays responsive. If an event takes too long to execute, the GUI will freeze--that is, it wonít repaint or respond to mouse clicks. Writing Event Listeners (in the Creating a GUI with JFC/Swing trail) has for more information.


Previous Page Lesson Contents Next Page Start of Tutorial > Start of Trail > Start of Lesson Search
Feedback Form

Copyright 1995-2005 Sun Microsystems, Inc. All rights reserved.