jwizard.java

Vyger offers a D & D and Rogue-like environment in a graphical online roleplay game.

/*
 * Light And Shadow. A Persistent Universe based on Robert Jordan's Wheel of Time Books.
 * Copyright (C) 2001-2002 WOTLAS Team
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package wotlas.libs.wizard;

import wotlas.libs.aswing.*;

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

/** A generic setup wizard that possesses buttons (previous/cancel/next) and displays
 *  a panel (JWizardStep) that can react when these buttons are pressed. <br>
 *  JWizard is abstract : the subclass must implement the method : onFinished() and
 *  onCanceled().
 *
 *  This class uses images found by using the provided WizardResourceLocator.
 *
 * @author Petrus, Aldiss
 * @see wotlas.libs.wizard.JWizardStep
 */

public abstract class JWizard extends JFrame {

 /*------------------------------------------------------------------------------------*/

  /** Where the images are stored.
   */
  protected WizardResourceLocator resourceLocator;

  /** The current wizard step
   */
  protected JWizardStep currentStep;

  /** The next wizard step
   */
  protected JWizardStep nextStep;

  /** Our factory for building JWizardStep.
   */
  protected JWizardStepFactory stepFactory;

  /** Title of the wizard
   */
  protected JPanel titlePanel;

  /** main panel of the wizard
   */
  protected JPanel mainPanel;

  /** panel of navigation buttons
   */
  protected JPanel buttonsPanel;

  /** title of the wizard
   */
  protected ALabel t_title;

  /** previous button
   */
  protected JButton b_previous;

  /** next button
   */
  protected JButton b_next;

  /** cancel button
   */
  protected JButton b_cancel;

  /** Context of the wizard.
   *  This object can be anything you want and is set by JWizard's subclass. 
   */
  protected Object context;
  
  /** pictures of the buttons
   */
  private ImageIcon im_okup, im_okdo, im_okun;
  private ImageIcon im_cancelup, im_canceldo, im_cancelun;  
  private ImageIcon im_nextup, im_nextdo, im_nextun;
  private ImageIcon im_previousup, im_previousdo, im_previousun;

  /** Wizard Image
   */
  private Image wizardImage;

 /*------------------------------------------------------------------------------------*/

  /*** ABSTRACT METHODS ***/

  /** Called when wizard is finished (after last step's end).
   */
   protected abstract void onFinished(Object context);

  /** Called when wizard is canceled ('cancel' button pressed).
   */
   protected abstract void onCanceled(Object context);

 /*------------------------------------------------------------------------------------*/

  /** Constructor of a wizard. We call the initSteps() method. We don't call any
   *  show() or setVisible().
   *
   * @param title wizard title
   * @param resourceLocator gives access to the images we need
   * @param titleFont font to use for the title
   * @param width wizard width
   * @param height wizard height   
   */
  public JWizard( String title, WizardResourceLocator resourceLocator,
                  Font titleFont, int width, int height) {
      super(title);
      this.resourceLocator = resourceLocator;

      stepFactory = new JWizardStepFactory();

      setSize(width+100,height);

      Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
      setLocation( (int) ((screenSize.getWidth() - getWidth()) / 2),
                   (int) ((screenSize.getHeight() - getHeight()) / 2) );

      setBackground(Color.white);
      setIconImage( resourceLocator.getGuiImage("icon.gif") );

      JPanel wizardPanel = new JPanel();
      wizardPanel.setBackground(Color.white);
      wizardPanel.setAlignmentX(LEFT_ALIGNMENT);
      getContentPane().add(wizardPanel, BorderLayout.CENTER);

      titlePanel = new JPanel(new GridLayout(1,1,5,5));
      titlePanel.setBackground(Color.white);
      titlePanel.setAlignmentX(LEFT_ALIGNMENT);
      titlePanel.setPreferredSize( new Dimension(width-10,24) );

      t_title = new ALabel(title);
      t_title.setFont( titleFont );

      t_title.setAlignmentX(LEFT_ALIGNMENT);
      titlePanel.add(t_title);
      wizardPanel.add(titlePanel, BorderLayout.NORTH);

      mainPanel = new JPanel(new GridLayout(1,1));
      mainPanel.setBackground(Color.yellow);
      mainPanel.setPreferredSize( new Dimension(width,height-110) );
      wizardPanel.add(mainPanel, BorderLayout.CENTER);

   // We load the wizard image
      MediaTracker mediaTracker = new MediaTracker(this);
      wizardImage  = resourceLocator.getGuiImage("wizard.jpg");
      mediaTracker.addImage(wizardImage,0);

      try{
            mediaTracker.waitForAll(); // wait for all images to be in memory
      }
      catch(InterruptedException e){
            e.printStackTrace();
      }

      JPanel leftPanel = new JPanel() {
      	  public void paintComponent(Graphics g) {
      	     g.drawImage( wizardImage, 0, 0, 100, this.getHeight(), this );
      	  }
      };

      leftPanel.setPreferredSize( new Dimension(100,height) );
      leftPanel.setMinimumSize( new Dimension(100,height) );
      leftPanel.setMaximumSize( new Dimension(100,height) );
      getContentPane().add( leftPanel, BorderLayout.WEST );


      buttonsPanel = new JPanel(new GridLayout(1,4,0,10));
      buttonsPanel.setBackground(Color.white);

    // *** Load images of buttons
      im_cancelup   = resourceLocator.getImageIcon("cancel-up.gif");
      im_canceldo   = resourceLocator.getImageIcon("cancel-do.gif");
      im_cancelun   = resourceLocator.getImageIcon("cancel-un.gif");
      im_okup       = resourceLocator.getImageIcon("ok-up.gif");
      im_okdo       = resourceLocator.getImageIcon("ok-do.gif");
      im_okun       = resourceLocator.getImageIcon("ok-un.gif");
      im_nextup     = resourceLocator.getImageIcon("next-up.gif");
      im_nextdo     = resourceLocator.getImageIcon("next-do.gif");
      im_nextun     = resourceLocator.getImageIcon("next-un.gif");
      im_previousup = resourceLocator.getImageIcon("previous-up.gif");
      im_previousdo = resourceLocator.getImageIcon("previous-do.gif");
      im_previousun = resourceLocator.getImageIcon("previous-un.gif");

    // *** Previous ***
      b_previous = new JButton(im_previousup);
      b_previous.setRolloverIcon(im_previousdo);
      b_previous.setPressedIcon(im_previousdo);
      b_previous.setDisabledIcon(im_previousun);
      b_previous.setBorderPainted(false);
      b_previous.setContentAreaFilled(false);
      b_previous.setFocusPainted(false);        
    
      b_previous.setActionCommand("previous");

      b_previous.addActionListener(
      new ActionListener()
      {
        public void actionPerformed(ActionEvent e) {
          nextStep = null;

          if( !currentStep.onPrevious(getContext(),JWizard.this) )
              return;

          if(nextStep==null)
              return; // not set by onPrevious

          showNextStep();
        }
      });

    // *** Next ***
      b_next = new JButton(im_nextup);
      b_next.setRolloverIcon(im_nextdo);