<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE document PUBLIC "-//CNX//DTD CNXML 0.5 plus MathML//EN" "http://cnx.rice.edu/cnxml/0.5/DTD/cnxml_mathml.dtd">
<document xmlns="http://cnx.rice.edu/cnxml" xmlns:md="http://cnx.rice.edu/mdml/0.4" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:bib="http://bibtexml.sf.net/" id="id9861183">
  <name>More Java GUI Programming</name>
  <metadata>
  <md:version>1.2</md:version>
  <md:created>2008/07/03 22:22:56 GMT-5</md:created>
  <md:revised>2008/07/24 19:11:54.134 GMT-5</md:revised>
  <md:authorlist>
      <md:author id="swong">
      <md:firstname>Stephen</md:firstname>
      
      <md:surname>Wong</md:surname>
      <md:email>swong@rice.edu</md:email>
    </md:author>
      <md:author id="dxnguyen">
      <md:firstname>Dung</md:firstname>
      <md:othername>X.</md:othername>
      <md:surname>Nguyen</md:surname>
      <md:email>dxnguyen@rice.edu</md:email>
    </md:author>
  </md:authorlist>

  <md:maintainerlist>
    <md:maintainer id="prat">
      <md:firstname>Alex</md:firstname>
      
      <md:surname>Tribble</md:surname>
      <md:email>prat@rice.edu</md:email>
    </md:maintainer>
    <md:maintainer id="swong">
      <md:firstname>Stephen</md:firstname>
      
      <md:surname>Wong</md:surname>
      <md:email>swong@rice.edu</md:email>
    </md:maintainer>
    <md:maintainer id="dxnguyen">
      <md:firstname>Dung</md:firstname>
      <md:othername>X.</md:othername>
      <md:surname>Nguyen</md:surname>
      <md:email>dxnguyen@rice.edu</md:email>
    </md:maintainer>
  </md:maintainerlist>
  
  <md:keywordlist>
    <md:keyword>command</md:keyword>
    <md:keyword>command design pattern</md:keyword>
    <md:keyword>gui</md:keyword>
    <md:keyword>java</md:keyword>
    <md:keyword>java gui</md:keyword>
    <md:keyword>java gui programming</md:keyword>
    <md:keyword>null-object pattern</md:keyword>
    <md:keyword>programming</md:keyword>
  </md:keywordlist>

  <md:abstract>Java GUI programming including basic event handling, adapters, and the command and null-object design patterns.</md:abstract>
</metadata>
  <content>
    <section id="Frame2">
      <name>1. JFrame with JButtons and event handlers (Frame2.java)</name>
      <note type="Source code">Click here to view <term src="#Frame2.java">Frame2.java</term>, or download the entire <link src="GUI2.zip">archive</link></note>
      <section id="commandpattern">
        <name>Command Design Pattern</name>
        <para id="id9130178">When a user clicks on a button, an <code>ActionEvent</code> object is delivered to the button. In order for the button to perform an application specific task, we must register an <code>ActionEventListener</code> to the button and program this event listener to perform the task we want. The <code>ActionListener</code> class is an example of what is called a "<term>command</term>" from the <link src="http://www.exciton.cs.rice.edu/JavaResources/DesignPatterns/command.htm">Command Design Pattern</link>. The code to add an <code>ActionListener</code> to a button looks like:</para>
        <code type="block">myButton.addActionListener(new ActionListener() {
    public void actionPerformed(ActionEvent e) {
        // code to perform a task goes here...
    }
});</code>
        <para id="id3294320">The example <term src="#Frame2.java">Frame2</term> shows how to dynamically change the layout manager for a <code>JFrame</code> by calling its <code>setLayout(...)</code> method resulting in a dynamic re-arrangement of the GUI components in the <code>JFrame</code>.</para>
      </section>
    </section>
    <section id="Frame3">
      <name>2. JFrame with JButtons and Adapters (Frame3.java)</name>
      <note type="Source code">Click here to view <term src="#Frame3.java">Frame3.java</term>, or download the entire <link src="GUI2.zip">archive</link></note>
      <para id="id11242012"><term src="#Frame3.java">Frame3</term> illustrates how to decouple the view from the rest of the world by having the view communicate to an interface called "adapter". A controller object, <term src="#Frame3Controller.java">Frame3Controller</term> connects the view <code>Frame3</code> to the world by installing a concrete adapter into the view. The adapter is instantiated as anonymous inner object and has access to all of its outer object. The view does not and should not know anything about the world to which it is connected. This adds flexibility to the design.</para>
      <figure id="viewAndController"><media type="image/png" src="ViewAndController.png">
</media></figure>
      <section id="nullobjectpattern">
        <name>Null-Object Pattern</name>
        <para id="id12469155">In much of the current programming practice, the special value <code>null</code> is often used as a flag to represent a gamut of different and often disconnected concepts such as emptiness and falseness. This can result in a lot of confusion and complex control structures in the code. In our view, <code>null</code> should only be used to denote the non-existence of an object. <code>null</code> is not an object and has no "intelligence" (i.e. behavior) for other objects to interact with. Therefore, whenever we work with a <emphasis>union</emphasis> of objects and discover that one or more of these objects may be referencing a <code>null</code> value, we almost always have to write code to distinguish <code>null</code> as a special case. To avoid this problem, we should think of adding a special object, called the <term>null object</term>, to the <emphasis>union</emphasis> with appropriate behavior that will allow us to treat all object references in a consistent and uniform way, devoid of special case consideration. This design pattern is called the null object pattern. We have used the null object pattern in one occasion: the <code>EmptyNode</code> to represent the empty state of a (mutable) list (<code>LRStruct</code>).</para>
        <para id="id8698550">In Frame3 the view adapter, <code>_v2wAdapter</code>, is initialized to an (anonymous) <term src="#IView2World.java">IView2World</term> object. It is there to guarantee that _<code>v2wAdapter</code> is always referencing a concrete <code>IView2World</code> object, and , since <code>setV2WAdapter(...)</code> only allows a non-null assignment, we can always call on _<code>v2WAdapter</code> to perform any method without checking for <code>null</code>.</para>
      </section>
    </section>
  </content>
  <glossary id="glossary1">
    <definition id="Frame2.java">
      <term>Frame2.java</term>
      <meaning>
        <code type="block">package view;

import java.awt.*;       // to use Container.
import java.awt.event.*; // to use WindowAdpater and WindowEvent.
import javax.swing.*;    // to use JFrame.

/**
 * A subclass of AFrame containing two JButtons that have event handler called
 * "commands" to dynamically switch layout managers when the buttons are clicked
 * upon.
 * @author D.X. Nguyen
 */
public class Frame2 extends AFrame {

    public Frame2(String title) {
        super(title);
    }

    protected void initialize() {
        Container cp = getContentPane();
        cp.setLayout(new FlowLayout());
        JButton jb1 = new JButton("Grid Layout");
        JButton jb2 = new JButton("Flow Layout");
        cp.add(jb1);
        cp.add(jb2);
        pack();

        /**
         * Registers an anonymous event handler for the clicking of button jb1.
         * When jb1 is clicked upon, this event handler will respond by
         * executing its actionPerformed(...) method.
         */
        jb1.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {
                jb1Clicked(e);
            }
        });

        /**
         * Same as the above.
         */
        jb2.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {
                jb2Clicked(e);
            }
        });
    }

    /**
     * Dynamically changes to a GridLayout with 2 rows and 1 column.
     */
    protected void jb1Clicked(ActionEvent e) {
        System.out.println("Set GridLayout...");
        getContentPane().setLayout(new GridLayout(2,1));
        validate();  // forces this frame to re-layout.
    }

    /**
     * Dynamically changes to FlowLayout.
     */
    protected void jb2Clicked(ActionEvent e) {
        System.out.println("Set FlowLayout...");
        getContentPane().setLayout(new FlowLayout());
        validate();  // forces this frame to re-layout.
    }
}</code>
      </meaning>
    </definition>
    <definition id="Frame2App.java">
      <term>Frame2App.java</term>
      <meaning>
        <code type="block">package app;

import javax.swing.*;
import view.*;

public class Frame2App {

    public static void main(String[] args) {
        JFrame f = new Frame2("A JFrame with 2 JButtons with event listeners");
        f.setVisible(true);
        f.setSize(300, 100);  // Guess what this does!
        f.setLocation(200, 200);  // Guess what this does!

        // Forces the frame to re-layout its components:
        f.validate();
    }
}</code>
      </meaning>
    </definition>
    <definition id="Frame3.java">
      <term>Frame3.java</term>
      <meaning>
        <code type="block">package view;

import java.awt.*;
import java.awt.event.*;
import javax.swing.*;

/**
 * Same functionality as Frame2 but uses an adapter interface to communicate
 * with the outside world instead.  This design allows varying the communication
 * with the outside world.  How the outside world reacts to the events that
 * happen to the view is a variant behavior!
 * Uses the Null-Object Pattern to initialize the adapter avoiding checking for
 * null.
 * @author DXN
 */
public class Frame3 extends Frame2 {

    // Initializes the adapter to a null object:
    private IView2World _v2wAdapter = new IView2World() {
        public Object button1Clicked (ActionEvent e) {
            return null; // does nothing!
        }
        public Object button2Clicked (ActionEvent e) {
            return null; // does nothing!
        }
    };

    public Frame3(String title) {
        super(title);
    }

    public void setV2WAdapter(IView2World v2w) {
        if (null == v2w) {
            throw new IllegalArgumentException("Argument cannot be null!");
        }
        _v2wAdapter = v2w;
    }

    /**
     * Tells _v2wAdapter the button click event happens on jb1.
     */
    protected void jb1Clicked(ActionEvent e) {
        _v2wAdapter.button1Clicked(e);
    }

    /**
     * Tells _v2wAdapter the button click event happens on jb2.
     */
    protected void jb2Clicked(ActionEvent e) {
        _v2wAdapter.button2Clicked(e);
    }

}</code>
      </meaning>
    </definition>
    <definition id="IView2World.java">
      <term>IView2World.java</term>
      <meaning>
        <code type="block">package view;

import java.awt.event.*;

/**
 * Adapter connecting Frame3 (the View) to the outside world.
 */
public interface IView2World {
    /**
     * Called by Frame3 when its button 1 is clicked.
     */
    public Object button1Clicked (ActionEvent e);

    /**
     * Called by Frame3 when its button 2 is clicked.
     */
    public Object button2Clicked (ActionEvent e);
}</code>
      </meaning>
    </definition>
    <definition id="Frame3Controller.java">
      <term>Frame3Controller.java</term>
      <meaning>
        <code type="block">package controller;

import view.*;
import java.awt.event.*;
import javax.swing.JFrame;
import java.awt.*; // For layout managers.

/**
 * The controller that instantiates a concrete IView2World object and connects
 * the world outside of Frame3 (the view) to Frame3.
 * The concrete adapter is implemented as an anonymous inner classe.
 */
public class Frame3Controller {

    public JFrame constructFrame()  {
        // Local variable needs to be final so that the local inner class
        // can access it:
        final Frame3 frame = new Frame3("View and Controller");

        /**
         * Install as concrete anonymous IView2World adapter in frame, without
         * frame knowing what the adapter does.
         */
        frame.setV2WAdapter(new IView2World()  {

            public Object button1Clicked (ActionEvent e) {
                frame.getContentPane().setLayout(new GridLayout(2,1));
                frame.validate();
                return null;
            }

            public Object button2Clicked (ActionEvent e) {
                frame.getContentPane().setLayout(new FlowLayout());
                frame.validate();
                return null;
            }
        });
        frame.setVisible(true);
        return frame;
    }
}</code>
      </meaning>
    </definition>
    <definition id="Frame3App.java">
      <term>Frame3App.java</term>
      <meaning>
        <code type="block">package app;

import view.*;
import controller.*;

/**
 * Instantiates the controller and builds the frame!
 */
public class Frame3App {

    public static void main(String[] args) {
        new Frame3Controller().constructFrame().validate();
    }
}</code>
      </meaning>
    </definition>
  </glossary>
</document>
