Apply MVC to a Swing app?

Question

Folks,
I got inspired by this thread: http://forum.java.sun.com/thread.jspa?threadID=5244847&start=23&tstart=0
and wrote the below version of MineSweeper (winmine.exe) in Swing as a learning exercise.
I'm about half way through my TODO list, and the code is "getting ugly". For instance, It took me a couple of hours to figure out what needed to change in order to keep track of the remaining bombs.
This leads me to believe that the best way forward might be to declare this version to be "The Prototype" and go back to torres.... taking what I've learned about the problems involved, and designing the whole thing from ground up, applying the MVC paradigm.
But I'm really unsure of how go about doing that... I studied program design back in the heyday of pseudo-code and structure charts, and I was hoping for some free advise (pretty please) or maybe some practical exercises/tutorials on OO program design. I've read some theory, but to be honest, it just goes over my head... in one ear and out the other. I hope that exercise of applying the principles espoused in the theory to a concrete example will help me to bring the theory into focus... at the moment GOF is rattling around in my brain, but it refuses coalesce into a coherent picture.
I have a rough design in mind... Please would anyone care to comment?
The Model
* A Field has Mine's
* Field would contain a matrix of Mine's ... mines[col][row]
* Mine would encapsulate the state of each mine, and expose the a low level set of mutators.
The View
* Form extends JFrame - the main form
* Top JPanel - much like the existing one
* Bottom JPanel
.... I'm wondering if a JTable would work in place of the existing matrix of JPanels.
.... or can this be done with a LayoutManager... I'm thinking GridBagLayout?
* Can I use a JPanel instead of the existing JPanel contains a JButton?
.... * I've got an issue with the existing MouseListener implementation. You have to hold
.... the mouse still and click each button rather deliberately. This ruins the fluidity of
.... the game-play, substantially reducing the players enjoyment. ie: it gives me the sh1ts.
.... Please does anyone have any ideas? I've used enough swing/awt apps to know
.... that this isn't an insoluble problem, but I've got no idea how to address it.
The Controler
* A Game class orchestrates the whole thing at the high level.
... + main - Creates a new Game and calls it's play method.
... - play - Creates and shows the gui on the EDT
* The MineLayer lays Mine's for the MineSweeper to clean up.
.... But I'm a but lost as to what should "own" the MineLayer and the MineSweeper.
.... To me it makes sense for the Controler to kick of the View, but from then on
.... we're event-driven by the View... so should the View "create and own" the
.... MineLayer and the MineSweeper? or should they be created by the controler
.... and passed into the constructor of the main form? This OO stuff always leaves me
.... feeling a bit thick. Back in my day you just called functions. It was ugly and simple.
.... OO is ugly and complicated.
package krc.games;
import java.util.Random;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JLabel;
import javax.swing.JButton;
import javax.swing.JOptionPane;
import java.awt.EventQueue;
import java.awt.Container;
import java.awt.Color;
import java.awt.Insets;
import java.awt.Font;
import java.awt.BorderLayout;
import java.awt.image.ColorModel;
import java.awt.event.MouseListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.ActionListener;
import java.awt.event.ActionEvent;
import javax.swing.ImageIcon;
import javax.swing.border.LineBorder;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
// TODO:
// * implement "you win"... track remaining bombs.                DONE
// * show "not a bomb" at end of game.                            DONE
// * display remaining bombs.                                     DONE
// * display a clock.                                             DONE
// * Resign/Refactor along MVC lines.
//   M = A Field has Mine's
//   V = The JFrame, some JPanels, a Grid?
//   C = Game orchestrates. The MineLayer lays Mine's for the MineSweeper to clean up.
// * beginner / intermediate / advanced / custom settings.
//   - Find out how to use menu's in swing
// * config board from command line args and/or properties file.
//   - Use an XML Properties file.
// * restart the same game. Reset the board with existing bombs. 
//   - TOO EASY - remember the seed used passed to Random.
// * high score.
//   - CAPTURE: JOptionPane("Enter your name")
//   - DISPLAY: A form with a grid
//   - STORE  : Java only database
// * save and load a game.
//   - A de/serialization exercise.
// * cheats - IDDKFA ;-)
//   - keyboard listener to show bombs.
import java.awt.image.BufferedImage;
public class MineSweeperGame extends JFrame
  private static final long serialVersionUID = 0L;
  private static final int ROWS = 15;
  private static final int COLS = 30;
  private static final int BOMBS = (int)(ROWS * COLS / 4.5);
  private JLabel bombs = null; //count down the bombs
  private int bombsRemaining = BOMBS;
  private JLabel clock = null; //seconds since first click
  private int elapsedTime;
  private volatile boolean isClockRunning = false;
  private static final String DIR = "C:/Java/home/src/krc/games/";
  private static final BufferedImage FLAG_IMAGE     = loadImage(DIR+"/flag.jpg");
  private static final BufferedImage QUESTION_IMAGE = loadImage(DIR+"/question.jpg");
  private static final BufferedImage BOMB_IMAGE     = loadImage(DIR+"/bomb.jpg");
  private static final BufferedImage EXPLODED_IMAGE = loadImage(DIR+"/exploded_bomb.jpg");
  private static final BufferedImage NOT_BOMB_IMAGE = loadImage(DIR+"/not_bomb.jpg");
  // number colors
  private static final Color[] COLORS = {
    Color.black         // 0 not used
  , Color.blue          // 1 blue
  , new Color(0,153,153)// 4 darkGreen
  , Color.red           // 3 red
  , new Color(0,0,204)  // 4 darkBlue
  , new Color(153,0,0)  // 5 brown
  , Color.pink          // 6 pink
  , Color.orange        // 7 orange
  , Color.white         // 8 white
  , Color.magenta       // 9 magenta
  private static final Font FONT = new Font("Dialog", Font.BOLD, 12);
  private MouseListener mouseListener = new MouseAdapter() {
    public void mouseClicked(MouseEvent event) {
      if(!isClockRunning) startClock();
      Cell cell = ((Cell.Button)event.getSource()).getParentCell();
      if ( event.getButton() == MouseEvent.BUTTON1 ) {
        if (cell.isBomb()) {
          if ( cell.isMarkedAsBomb() ) {
            java.awt.Toolkit.getDefaultToolkit().beep();
          } else {
            cell.explode();
            youLost();
        } else {
          revealCell(cell);
      } else if ( event.getButton() == MouseEvent.BUTTON3 ) {
        cell.nextState();
  private class Cell extends JPanel {
    private static final long serialVersionUID = 0L;
    public static final int WIDTH = 17;
    public static final int HEIGHT = 17;
    public static final float Y_OFFSET = 13F;
    public static final float X_OFFSET = 5F;
    private class Button extends JButton {
      private static final long serialVersionUID = 0L;
      private final Cell parentCell;
      public Button(int width, int height, Cell parentCell) {
        this.parentCell = parentCell;
        this.setBounds(0, 0, width, height);
        this.setMargin(new Insets(1,1,1,1));
        this.setFont(new Font("Dialog",0,8));
        this.addMouseListener(mouseListener); // handle right button
      public void reset() {
        this.setText("");
        this.setVisible(true);
        this.setIcon(null);
      public Cell getParentCell() {
        return this.parentCell;
    private final Button button;
    private final int row, col;
    private boolean isBomb = false;
    private boolean isRevealed = false;
    private boolean isExploded = false;
    private int neighbours = 0;
    private ImageIcon[] stateIcons = new ImageIcon[] {
      null,  new ImageIcon(FLAG_IMAGE), new ImageIcon(QUESTION_IMAGE)
    private int state = 0;
    public static final int STATE_UNMARKED = 0;
    public static final int STATE_MARKED_AS_A_BOMB = 1;
    public static final int STATE_MARKED_AS_A_QUESTION = 2;
    Cell(int row, int col) {
      this.row = row;
      this.col = col;
      this.setBounds(col*WIDTH, row*HEIGHT, WIDTH, HEIGHT);
      this.setLayout(null);
      button = new Button(WIDTH, HEIGHT, this);
      this.add(button);
    public boolean isBomb() { return this.isBomb; }
    public void setBomb(boolean isBomb) { this.isBomb = isBomb; }
    public boolean isRevealed() { return this.isRevealed; }
    public void reveal() {
      if(this.isRevealed) return;
      this.button.setVisible(false);
      this.isRevealed = true;
    public void revealNotABomb() {
      button.setText("");
      button.setIcon(new ImageIcon(NOT_BOMB_IMAGE));
    public boolean isExploded() { return this.isExploded; }
    public void explode() {this.isExploded = true;}
    public int getNeighbours() { return this.neighbours; }
    public void setNeighbours(int neighbours) {this.neighbours = neighbours;}
    public void reset() {
      this.isRevealed = false;
      this.isBomb = false;
      this.isExploded = false;
      this.state = STATE_UNMARKED;
      this.button.reset();
    public boolean isMarkedAsBomb() {
      return this.state == Cell.STATE_MARKED_AS_A_BOMB;
    public void nextState() {
      boolean wasMarkedAsABomb = this.isMarkedAsBomb();
      this.state = (this.state+1) % 3;
      button.setIcon(stateIcons[this.state]);
      if (this.isMarkedAsBomb()) {
        setBombsRemaining(getBombsRemaining()-1);
        if (getBombsRemaining() == 0) {
          if (allMarkedBombsAreReallyBombs()) {
            youWon();
          } else {
            youLost();
      } else if (wasMarkedAsABomb) {
        setBombsRemaining(getBombsRemaining()+1);
    @Override
    public void paintComponent(Graphics g) {
      super.paintComponent(g);
      if ( this.isRevealed() ) {
        Graphics2D g2d = (Graphics2D) g;
        if (this.isExploded) {
          g2d.drawImage(EXPLODED_IMAGE, 0, 0, null);
        } else if (this.isBomb) {
          g2d.drawImage(BOMB_IMAGE, 0, 0, null);
        } else if (this.neighbours > 0) {
          g2d.setColor(COLORS[this.neighbours]);
          g2d.setFont(FONT);
          g2d.drawString(""+this.neighbours, X_OFFSET, Y_OFFSET);
  private Cell[][] cells = new Cell[ROWS][COLS];
  MineSweeperGame() {
    super();
    buildAndShowGUI();
  private void buildAndShowGUI() {
    this.setTitle("Miner");
    final int CELLS_X = Cell.WIDTH*COLS;
    final int WASTE_X = 6;
    final int WIN_WIDTH = CELLS_X+WASTE_X;
    final int CELLS_Y = Cell.HEIGHT*ROWS;
    final int WASTE_Y = 32;
    final int TOP_FRAME_Y = 34;
    final int WIN_HEIGHT = CELLS_Y+WASTE_Y+TOP_FRAME_Y;
    this.setSize(WIN_WIDTH, WIN_HEIGHT);
    this.setDefaultCloseOperation(EXIT_ON_CLOSE);
    this.setResizable(false);
    Container pane = this.getContentPane();
    pane.setLayout(null);
    JPanel top = new JPanel();
    top.setBounds(0,0, WIN_WIDTH,TOP_FRAME_Y);
    top.setBorder(new LineBorder(Color.black));
    top.setLayout(null);
    bombs = new JLabel();
    bombs.setBounds(5,7, 23,17);
    bombs.setBorder(new LineBorder(Color.black));
    top.add(bombs);
    clock = new JLabel("0");
    clock.setBounds(WIN_WIDTH-35,7, 23,17);
    clock.setBorder(new LineBorder(Color.black));
    top.add(clock);
    pane.add(top);
    JPanel bot = new JPanel();
    bot.setLayout(null);
    bot.setBackground(Color.white);
    bot.setBounds(0, TOP_FRAME_Y+1, CELLS_X, CELLS_Y);
    for(int r=0; r<ROWS; r++) {
      for(int c=0; c<COLS; c++) {
        cells[r][c] = new Cell(r, c);
        bot.add(cells[r][c]);
    pane.add(bot);
    resetGame();
    this.setVisible(true);
  private void resetGame() {
    resetClock();
    resetCells();
    placeBombs();
    setBombsRemaining(BOMBS);
    countNeighbouringBombs();
  private void resetCells() {
    // reset all the cells
    for(int r=0; r<ROWS; r++) {
      for(int c=0; c<COLS; c++) {
        cells[r][c].reset();
  private void placeBombs() {
    // randomly place however many bombs in the minefield
    Random rand = new Random(System.currentTimeMillis());
    for(int i=0; i<BOMBS; i++) {
      while(true) {
        Cell cell = this.cells[rand.nextInt(ROWS)][rand.nextInt(COLS)];
        if (!cell.isBomb()) {
          cell.setBomb(true);
          cell.button.setText("b");
          break;
  // count the number of bombs neighbouring each cell
  private void countNeighbouringBombs() {
    for(int r=0; r<ROWS; r++) {
      for(int c=0; c<COLS; c++) {
        cells[r][c].setNeighbours(getNeighbourCount(r, c));
  // the number of bombs neighbouring the given cell
  private int getNeighbourCount(int row, int col) {
    int count = 0;
    int firstRow = Math.max(row-1, 0);
    int lastRow  = Math.min(row+1, ROWS-1);
    int firstCol = Math.max(col-1, 0);
    int lastCol  = Math.min(col+1, COLS-1);
    for(int r=firstRow; r<=lastRow; r++) {
      for(int c=firstCol; c<=lastCol; c++) {
        if( this.cells[r][c].isBomb ) count++;
    return count;
  public void setBombsRemaining(int bombsRemaining) {
    this.bombsRemaining = bombsRemaining;
    this.bombs.setText(""+this.bombsRemaining);
  public int getBombsRemaining() {
    return(this.bombsRemaining);
  private void showBombs() {
    for(int r=0; r<ROWS; r++) {
      for(int c=0; c<COLS; c++) {
        Cell cell = cells[r][c];
        if (cell.isBomb) {
          cell.reveal();
        } else if (cell.isMarkedAsBomb()) {
          cell.revealNotABomb();
  private boolean allMarkedBombsAreReallyBombs() {
    for(int r=0; r<ROWS; r++) {
      for(int c=0; c<COLS; c++) {
        Cell cell = this.cells[r][c];
        if (cell.isMarkedAsBomb() && !cell.isBomb() ) {
          return false;
    return true;
  private void revealCell(Cell cell) {
    if(cell.getNeighbours()==0) {
      revealCells(cell, new HashMap<Cell,Object>());
    } else {
      cell.reveal();
  private void revealCells(Cell cell, Map<Cell,Object> ancestors) {
    if (ancestors.containsKey(cell)) return;
    if (cell.isRevealed()) return;
    ancestors.put(cell, null);
    cell.reveal();
    if(cell.getNeighbours()==0) {
      int firstRow = Math.max(cell.row-1, 0);
      int lastRow  = Math.min(cell.row+1, ROWS-1);
      int firstCol = Math.max(cell.col-1, 0);
      int lastCol  = Math.min(cell.col+1, COLS-1);
      for(int r=firstRow; r<=lastRow; r++) {
        for(int c=firstCol; c<=lastCol; c++) {
          Cell x = cells[r][c];
          if (x == cell) continue;
          if( !x.isBomb() && !x.isRevealed() ) {
            revealCells(x, ancestors);
  private void youLost() {
    stopClock();
    showBombs();
    JOptionPane.showMessageDialog(this, "You Lost.", "Game Over", JOptionPane.WARNING_MESSAGE);
    resetGame();
  private void youWon() {
    stopClock();
    JOptionPane.showMessageDialog(this, "You Won. Congratulations.", "Game Over", JOptionPane.INFORMATION_MESSAGE);
    resetGame();
  private static BufferedImage loadImage(String filename) {
    try {
      return ImageIO.read(new File(filename));
    } catch (IOException e) {
      // the game will still kinda work, you just won't see this image.
      e.printStackTrace();
    return null;
  private void startClock() {
    isClockRunning = true;
    new Thread() {
      public void run() {
        while (isClockRunning) {
          clock.setText(""+(elapsedTime++));
          //repaint();
          try{Thread.sleep(1000);}catch(InterruptedException eaten){}
    }.start();
  private void stopClock() {
    this.isClockRunning = false;
  private void resetClock() {
    elapsedTime = 0;
    clock.setText("0");
  public static void main(String[] args) {
    try {
      EventQueue.invokeLater(
        new Runnable() {
          public void run() {
            MineSweeperGame game = new MineSweeperGame();
    } catch (Exception e) {
      e.printStackTrace();
}Thanx in advance for any ideas.
Cheers. Keith.
Edited by: corlettk on Dec 23, 2007 6:15 AM - typos.

Answer 1

For anyone who's interested... here's the latest (and complete, I think) version of the program.... there's quit a lot of code here, sorry. It should all compile first time... but you'll need to scrape your own set of images from minesweeper (ie: winmine.exe) and google for the wav files... It's a shame we can't post jar's or zip's here.
MineSweeperGame.java
package krc.games.sweeper;
import java.util.Random;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JLabel;
import javax.swing.JButton;
import javax.swing.JOptionPane;
import javax.swing.JMenuBar;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JRadioButtonMenuItem;
import javax.swing.ButtonGroup;
import java.awt.Color;
import java.awt.Insets;
import java.awt.Font;
import java.awt.event.MouseListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.ActionListener;
import java.awt.event.ActionEvent;
import javax.swing.ImageIcon;
import javax.swing.border.LineBorder;
import java.io.File;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.util.HashMap;
import java.util.Map;
import krc.utilz.sound.WavePlayer;
// TODO:
// * implement "you win"... track remaining bombs.                    DONE
// * show "not a bomb" at end of game.                                DONE
// * display remaining bombs.                                         DONE
// * display a clock.                                                 DONE
// * Resign/Refactor along MVC lines.                                 NOT DONE
//   M = A Field has Mine's
//   V = The JFrame, some JPanels, a Grid?
//   C = Controler orcestrates.
// * beginner / intermediate / advanced / custom settings.            DONE
//   - Find out how to use menu's in swing
// * config board from command line args and/or properties file.      DONE
//   - used a standard properties file
// * restart the same game. Reset the board with existing bombs.      DONE
//   - TOO EASY - remember the seed used passed to Random.
// * high score.
//   - CAPTURE: JOptionPane("Enter your name")
//   - DISPLAY: A form with a grid
//   - STORE  : Java only database
// * save and load a game.
//   - A de/serialization exercise.
// * cheats
//   until the first 0 is hit
//   - ctrl-click - is bomb proof (costs 5 seconds)                   DONE
//   - fifth click reveals the biggest patch of 0's                   DONE
//   god mode
//   - ctrl-alt-shift shows the position of all bombs.                DONE
//     // search for "b" - uncomment that line)
public class MineSweeperGame extends JFrame
  private static final long serialVersionUID = 0L;
  //these are read from properties files
  private GameSettings settings;
  private JFrame theFrame;
  private JLabel bombs = null; //count down the bombs
  private int bombsRemaining;
  private boolean replayCurrentGame = false;
  private long randomSeed = 0;
  private GameClock clock = null; //seconds since first click
  private static final String DIR = "C:/Java/home/src/krc/games/sweeper/";
  private static final String IMGDIR = DIR+"images/";
  private static final BufferedImage FLAG_IMAGE     = loadImage(IMGDIR+"flag.jpg");
  private static final BufferedImage QUESTION_IMAGE = loadImage(IMGDIR+"question.jpg");
  private static final BufferedImage BOMB_IMAGE     = loadImage(IMGDIR+"bomb.jpg");
  private static final BufferedImage EXPLODED_IMAGE = loadImage(IMGDIR+"exploded_bomb.jpg");
  private static final BufferedImage NOT_BOMB_IMAGE = loadImage(IMGDIR+"not_bomb.jpg");
  private static final String WAVDIR = DIR+"sounds/";
  // number colors
  private static final Color[] COLORS = {
    Color.black         // 0 not used
  , Color.blue          // 1 blue
  , new Color(0,153,153)// 4 darkGreen
  , Color.red           // 3 red
  , new Color(0,0,204)  // 4 darkBlue
  , new Color(153,0,0)  // 5 brown
  , Color.pink          // 6 pink
  , Color.orange        // 7 orange
  , Color.white         // 8 white
  , Color.magenta       // 9 magenta
  private static final Font FONT = new Font("Dialog", Font.BOLD, 12);
  private class GameMenuBar extends JMenuBar
    private static final long serialVersionUID = 0L;
    private ActionListener menuListener = new ActionListener() {
      public void actionPerformed(ActionEvent event) {
        String action = event.getActionCommand().toLowerCase();
        if ("new".equals(action)) {
          hideAndDestroyGUI();
          buildAndShowGUI();
        } else if ("restart".equals(action)) {
          hideAndDestroyGUI();
          replayCurrentGame = true;
          buildAndShowGUI();
        } else if ( "beginner,intermediate,expert,custom".indexOf(action) > -1 ) {
          hideAndDestroyGUI();
          if ( "custom".equals(action) ) {
            CustomSettingsDialog dialog = new CustomSettingsDialog(theFrame, properties.get("custom"));
            settings = dialog.getSettings();
            dialog.dispose();
            properties.set(settings);
          } else {
            settings = properties.get(action);
          buildAndShowGUI();
        } else if ("exit".equals(action)) {
          setVisible(false);
          dispose();
        } else {
          java.awt.Toolkit.getDefaultToolkit().beep();
          System.out.println("Menu item ["+event.getActionCommand()+"] was pressed.");
    public GameMenuBar(String level) {
      JMenu menu = new JMenu("Game");
      menu.add(newJMenuItem("New", 'N'));
      menu.add(newJMenuItem("Restart", 'R'));
      menu.addSeparator();
      ButtonGroup group = new ButtonGroup();
      menu.add(newJRadioButtonMenuItem(group, "Beginner", level));
      menu.add(newJRadioButtonMenuItem(group, "Intermediate", level));
      menu.add(newJRadioButtonMenuItem(group, "Expert", level));
      menu.add(newJRadioButtonMenuItem(group, "Custom", level));
      menu.addSeparator();
      menu.add(newJMenuItem("Exit", 'X'));
      this.add(menu);
    private JMenuItem newJMenuItem(String text, char mneumonic) {
      JMenuItem item = new JMenuItem(text, mneumonic);
      item.addActionListener(this.menuListener);
      return item;
    private JRadioButtonMenuItem newJRadioButtonMenuItem(ButtonGroup group, String text, String level) {
      JRadioButtonMenuItem item = new JRadioButtonMenuItem(text);
      item.addActionListener(this.menuListener);
      group.add(item);
      if(text.equalsIgnoreCase(level)) item.setSelected(true);
      return item;
  private class Cell extends JPanel
    private static final long serialVersionUID = 0L;
    public static final int WIDTH = 17;
    public static final int HEIGHT = 17;
    public static final float Y_OFFSET = 13F;
    public static final float X_OFFSET = 5F;
    private class Button extends JButton {
      private static final long serialVersionUID = 0L;
      private final Cell parentCell;
      public Button(int width, int height, Cell parentCell) {
        this.parentCell = parentCell;
        this.setBounds(0, 0, width, height);
        this.setMargin(new Insets(1,1,1,1));
        this.setFont(new Font("Dialog",0,8));
        this.addMouseListener(mouseListener); // handles left & right button
      public void reset() {
        this.setText("");
        this.setVisible(true);
        this.setIcon(null);
      public Cell getParentCell() {
        return this.parentCell;
      public void removeMouseListener() {
        this.removeMouseListener(mouseListener);
    private final Button button;
    private final int row, col;
    private boolean isBomb = false;
    private boolean isRevealed = false;
    private boolean isExploded = false;
    private int neighbours = 0;
    public static final int STATE_UNMARKED = 0;
    public static final int STATE_MARKED_AS_A_BOMB = 1;
    public static final int STATE_MARKED_AS_A_QUESTION = 2;
    private int state = 0;
    private ImageIcon[] stateIcons = new ImageIcon[] {
      null,  new ImageIcon(FLAG_IMAGE), new ImageIcon(QUESTION_IMAGE)
    Cell(int row, int col) {
      this.row = row;
      this.col = col;
      this.setBounds(col*WIDTH, row*HEIGHT, WIDTH, HEIGHT);
      this.setLayout(null);
      button = new Button(WIDTH, HEIGHT, this);
      this.add(button);
    public boolean isBomb() { return this.isBomb; }
    public void setBomb(boolean isBomb) { this.isBomb = isBomb; }
    public boolean isRevealed() { return this.isRevealed; }
    public void reveal() {
      if(this.isRevealed) return;
      this.button.setVisible(false);
      this.isRevealed = true;
    public void revealNotABomb() {
      button.setText("");
      button.setIcon(new ImageIcon(NOT_BOMB_IMAGE));
    public boolean isExploded() { return this.isExploded; }
    public void explode() {this.isExploded = true;}
    public int getNeighbours() { return this.neighbours; }
    public void setNeighbours(int neighbours) {this.neighbours = neighbours;}
    public void reset() {
      this.isRevealed = false;
      this.isBomb = false;
      this.isExploded = false;
      this.state = STATE_UNMARKED;
      this.button.reset();
    public boolean isMarkedAsBomb() {
      return this.state == Cell.STATE_MARKED_AS_A_BOMB;
    public void nextState() {
      boolean wasMarkedAsABomb = this.isMarkedAsBomb();
      this.state = (this.state+1) % 3;
      button.setIcon(stateIcons[this.state]);
      if (this.isMarkedAsBomb()) {
        setBombsRemaining(getBombsRemaining()-1);
        if (getBombsRemaining() == 0) {
          if (allMarkedBombsAreReallyBombs()) {
            youWon();
          } else {
            youLost();
      } else if (wasMarkedAsABomb) {
        setBombsRemaining(getBombsRemaining()+1);
    public void removeMouseListener() {
      button.removeMouseListener();
    @Override
    public void paintComponent(Graphics g) {
      super.paintComponent(g);
      if ( this.isRevealed() ) {
        Graphics2D g2 = (Graphics2D) g;
        if (this.isExploded) {
          g2.drawImage(EXPLODED_IMAGE, 0, 0, null);
        } else if (this.isBomb) {
          g2.drawImage(BOMB_IMAGE, 0, 0, null);
        } else if (this.neighbours > 0) {
          g2.setColor(COLORS[this.neighbours]);
          g2.setFont(FONT);
          g2.drawString(""+this.neighbours, X_OFFSET, Y_OFFSET);
  private MouseListener mouseListener = null;
  private GameProperties properties = null;
  private Cell[][] cells = null;
  // this game is a "virgin" until the user finds the first 0.
  private boolean isVirgin = false;
  // when the user clears fifth square of a virgin game the
  // largest patch of 0's is automagically cleared.
  private int numCleared = 0;
  MineSweeperGame() {
    theFrame = this;
    this.properties = new GameProperties();
    this.settings = this.properties.get();
    buildAndShowGUI();
  private void setMouseListener(){
    this.mouseListener = new MouseAdapter() {
      public void mouseClicked(MouseEvent event) {
        clock.start();
        Cell cell = ((Cell.Button)event.getSource()).getParentCell();
        if ( event.getButton() == MouseEvent.BUTTON1 ) {
          if(event.isControlDown()) clock.skip(5);
          if (cell.isBomb()) {
            if ( cell.isMarkedAsBomb() ) {
              java.awt.Toolkit.getDefaultToolkit().beep();
            } else if ( event.isControlDown() ) {
              WavePlayer.play(WAVDIR+"ricochet.wav");
            } else {
              WavePlayer.play(WAVDIR+"grenade.wav");
              cell.explode();
              youLost();
          } else {
            revealCell(cell);
            if ( isVirgin && ++numCleared==5 ) {
              WavePlayer.play(WAVDIR+"smokin.wav");
              revealTheBiggestFreePatch();
        } else if ( event.getButton() == MouseEvent.BUTTON3 ) {
          cell.nextState();
  private void hideAndDestroyGUI() {
    this.setVisible(false);
    for(int r=0; r<settings.rows; r++) {
      for(int c=0; c<settings.cols; c++) {
        cells[r][c].removeMouseListener(); // old mouse listeners send it crazy.
        cells[r][c] = null;
    this.getContentPane().removeAll();
    this.dispose();
  private void buildAndShowGUI() {
    final int CELLS_X = Cell.WIDTH*settings.cols;
    final int WASTE_X = 9;
    final int WIN_WIDTH = CELLS_X+WASTE_X;
    final int CELLS_Y = Cell.HEIGHT*settings.rows;
    final int WASTE_Y = 59;
    final int TOP_FRAME_Y = 34;
    final int WIN_HEIGHT = CELLS_Y+WASTE_Y+TOP_FRAME_Y;
    this.setTitle("Miner");
    this.setSize(WIN_WIDTH, WIN_HEIGHT);
    this.setResizable(false);
    this.setDefaultCloseOperation(EXIT_ON_CLOSE);
    this.setJMenuBar( new GameMenuBar(this.settings.level) );
    this.getContentPane().setLayout(null);
    // the top panel
    JPanel top = new JPanel(null);
    top.setBounds(0,0, WIN_WIDTH-6,TOP_FRAME_Y);
    top.setBorder(new LineBorder(Color.black));
    // the remaining-bomb-counter (on the left)
    bombs = new JLabel();
    bombs.setBounds(5,7, 23,17);
    bombs.setBorder(new LineBorder(Color.black));
    top.add(bombs);
    // the time-counter (on the right)
    this.clock = new GameClock();
    clock.setBounds(WIN_WIDTH-35,7, 23,17);
    top.add(clock);
    this.getContentPane().add(top);
    // the bottom panel
    setMouseListener();
    JPanel bot = new JPanel();
    bot.setLayout(null);
    bot.setBackground(Color.white);
    bot.setBounds(0, TOP_FRAME_Y+1, CELLS_X, CELLS_Y);
    this.cells = new Cell[settings.rows][settings.cols];
    for(int r=0; r<settings.rows; r++) {
      for(int c=0; c<settings.cols; c++) {
        cells[r][c] = new Cell(r, c);
        bot.add(cells[r][c]);
    this.getContentPane().add(bot);
    resetGame();
    this.setVisible(true);
  private void resetGame() {
    clock.reset();
    resetCells();
    isVirgin = true;
    numCleared = 0;
    placeBombs();
    setBombsRemaining(settings.bombs);
    countNeighbouringBombs();
  // reset the state of all the cells to default "empty" values.
  private void resetCells() {
    for(int r=0; r<settings.rows; r++) {
      for(int c=0; c<settings.cols; c++) {
        cells[r][c].reset();
  // randomly place however many bombs in the minefield
  // if replay then reuses the same seed to reproduce the same mine layout.
  private void placeBombs() {
    if(!this.replayCurrentGame) this.randomSeed = System.currentTimeMillis();
    this.replayCurrentGame = false;
    Random rand = new Random(this.randomSeed);
    for(int i=0; i<settings.bombs; i++) {
      while(true) {
        Cell cell = this.cells[rand.nextInt(settings.rows)][rand.nextInt(settings.cols)];
        if (!cell.isBomb()) {
          cell.setBomb(true);
          //cell.button.setText("b");
          break;
  // count the number of bombs neighbouring each cell
  private void countNeighbouringBombs() {
    for(int r=0; r<settings.rows; r++) {
      for(int c=0; c<settings.cols; c++) {
        cells[r][c].setNeighbours(getNeighbourCount(r, c));
  // return the number of bombs neighbouring the given cell
  private int getNeighbourCount(int row, int col) {
    int count = 0;
    int firstRow = Math.max(row-1, 0);
    int lastRow  = Math.min(row+1, settings.rows-1);
    int firstCol = Math.max(col-1, 0);
    int lastCol  = Math.min(col+1, settings.cols-1);
    for(int r=firstRow; r<=lastRow; r++) {
      for(int c=firstCol; c<=lastCol; c++) {
        if( this.cells[r][c].isBomb ) count++;
    return count;
  public void setBombsRemaining(int bombsRemaining) {
    this.bombsRemaining = bombsRemaining;
    this.bombs.setText(""+this.bombsRemaining);
  public int getBombsRemaining() {
    return(this.bombsRemaining);
  private void showBombs() {
    for(int r=0; r<settings.rows; r++) {
      for(int c=0; c<settings.cols; c++) {
        Cell cell = cells[r][c];
        if (cell.isBomb) {
          cell.reveal();
        } else if (cell.isMarkedAsBomb()) {
          cell.revealNotABomb();
  private boolean allMarkedBombsAreReallyBombs() {
    for(int r=0; r<settings.rows; r++) {
      for(int c=0; c<settings.cols; c++) {
        Cell cell = this.cells[r][c];
        if (cell.isMarkedAsBomb() && !cell.isBomb() ) {
          return false;
    return true;
  private void revealCell(Cell cell) {
    if(cell.getNeighbours()==0) {
      revealCells(cell, new HashMap<Cell,Object>());
    } else {
      cell.reveal();
  private void revealTheBiggestFreePatch() {
    Map<Cell,Object> counted = new HashMap<Cell,Object>();
    int count = 0;
    int max = 0;
    Cell maxCell = null;
    for(int r=0; r<settings.rows; r++) {
      for(int c=0; c<settings.cols; c++) {
        Cell cell = this.cells[r][c];
        if(cell.getNeighbours()==0) {
          count = countNeighbouringZeros(cell, counted);
          if(count > max) {
            max = count;
            maxCell = cell;
    revealCell(maxCell);
  private int countNeighbouringZeros(Cell cell, Map<Cell,Object> counted) {
    int count = 0;
    if (counted.containsKey(cell)) return 0;
    counted.put(cell, null);
    if(cell.getNeighbours()==0) {
      count++;
      int firstRow = Math.max(cell.row-1, 0);
      int lastRow  = Math.min(cell.row+1, settings.rows-1);
      int firstCol = Math.max(cell.col-1, 0);
      int lastCol  = Math.min(cell.col+1, settings.cols-1);
      for(int r=firstRow; r<=lastRow; r++) {
        for(int c=firstCol; c<=lastCol; c++) {
          Cell x = cells[r][c];
          if (x == cell) continue;
          if (x.getNeighbours()==0) {
            count += countNeighbouringZeros(x, counted);
    return count;
  private void revealCells(Cell cell, Map<Cell,Object> ancestors) {
    if (ancestors.containsKey(cell)) return;
    if (cell.isRevealed()) return;
    ancestors.put(cell, null);
    cell.reveal();
    if(cell.getNeighbours()==0) {
      isVirgin = false;
      int firstRow = Math.max(cell.row-1, 0);
      int lastRow  = Math.min(cell.row+1, settings.rows-1);
      int firstCol = Math.max(cell.col-1, 0);
      int lastCol  = Math.min(cell.col+1, settings.cols-1);
      for(int r=firstRow; r<=lastRow; r++) {
        for(int c=firstCol; c<=lastCol; c++) {
          Cell x = cells[r][c];
          if (x == cell) continue;
          if( !x.isBomb() && !x.isRevealed() ) {
            revealCells(x, ancestors);
  private void youLost() {
    clock.stop();
    showBombs();
    //WavePlayer.play(WAVDIR+"msstartup.wav");
    Object[] options = { "Replay", "New Game" };
    int choice = JOptionPane.showOptionDialog(
        null
      , "Replay?"
      , "Game Over."
      , JOptionPane.DEFAULT_OPTION
      , JOptionPane.QUESTION_MESSAGE
      , null
      , options
      , options[0]
    if (choice == 0) {
      replayCurrentGame = true;
    resetGame();
  private void youWon() {
    clock.stop();
    WavePlayer.play(WAVDIR+"applause.wav");
    JOptionPane.showMessageDialog(this, "Congratulations. You Won!", "Game Over", JOptionPane.INFORMATION_MESSAGE);
    resetGame();
  private static BufferedImage loadImage(String filename) {
    try {
      return ImageIO.read(new File(filename));
    } catch (Exception e) { //IOExcecption
      // the game will still kinda work, you just won't see the images.
      e.printStackTrace();
    return null;
  public static void main(String[] args) {
    java.awt.EventQueue.invokeLater(
      new Runnable() {
        public void run() {
          MineSweeperGame game = new MineSweeperGame();
CustomSettingsDialog.java
package krc.games.sweeper;
import javax.swing.JDialog;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JLabel;
import javax.swing.JTextField;
import javax.swing.JButton;
import javax.swing.JOptionPane;
import java.awt.event.ActionListener;
import java.awt.event.ActionEvent;
public class CustomSettingsDialog extends JDialog implements ActionListener
  private static final long serialVersionUID = 0L;
  private static final int ROW_HEIGHT = 24;
  private static final int PAD = 5;
  private boolean isOk = false;
  GameSettings settings;
  private JPanel panel;
  private JTextField rowsTextField;
  private JTextField colsTextField;
  private JTextField bombsTextField;
  private JButton okButton;
  private JButton cancelButton;
  CustomSettingsDialog(JFrame parentFrame, GameSettings settings) {
    super(parentFrame, true);
    this.settings = settings;
    this.setTitle("Custom Miner");
    this.setDefaultCloseOperation(JFrame.HIDE_ON_CLOSE);
    this.setSize(250, 200);
    this.setResizable(false);
    panel = new JPanel();
    panel.setLayout(null);
    addLabel(0, "rows"); rowsTextField = addField(0, ""+settings.rows);
    addLabel(1, "cols"); colsTextField = addField(1, ""+settings.cols);
    addLabel(2, "bombs"); bombsTextField = addField(2, ""+settings.bombs);
    okButton = addButton(3,0, "Ok");
    cancelButton = addButton(3,1, "Cancel");
    rowsTextField.selectAll();
    rowsTextField.requestFocusInWindow();
    this.add(panel);
    this.setVisible(true);
  boolean isOk() {
    return this.isOk;
  GameSettings getSettings() {
    return this.settings;
  private void addLabel(int row, String caption) {
    JLabel label = new JLabel(caption);
    label.setBounds(PAD, PAD+((ROW_HEIGHT+PAD)*row), 80, ROW_HEIGHT);
    panel.add(label);
  private JTextField addField(int row, String text) {
    JTextField field = new JTextField();
    field.setBounds(80, PAD+((ROW_HEIGHT+PAD)*row), 100, ROW_HEIGHT);
    field.setText(text);
    panel.add(field);
    return(field);
  private JButton addButton(int row, int col, String caption) {
    JButton button = new JButton(caption);
    button.setBounds(20+(col*85), PAD+((ROW_HEIGHT+PAD)*row), 80, ROW_HEIGHT);
    button.addActionListener(this);
    panel.add(button);
    return(button);
  public void actionPerformed(ActionEvent event) {
    if ( okButton == event.getSource() ) {
      try {
        this.settings.level = "custom";
        this.settings.rows = Integer.parseInt(rowsTextField.getText());
        this.settings.cols = Integer.parseInt(colsTextField.getText());
        this.settings.bombs = Integer.parseInt(bombsTextField.getText());
        this.isOk = true;
        this.setVisible(false);
      } catch(NumberFormatException e) {
        JOptionPane.showMessageDialog(this, e.getMessage(), "NumberFormatException", JOptionPane.ERROR_MESSAGE);
    } else if ( cancelButton == event.getSource() ) {
      this.isOk = false;
      this.setVisible(false);
    } else {
      java.awt.Toolkit.getDefaultToolkit().beep();
      System.out.println("CustomSettingsDialog.actionPerformed: Unknown event source "+event.getSource());
GameProperties.java
package krc.games.sweeper;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
class GameProperties extends java.util.Properties
  private static final long serialVersionUID = 0L;
  private static final String FILENAME = "MineSweeperGame.properties";
  public GameProperties() {
    super();
    load();
  public GameSettings get(String level) {
    return new GameSettings(
        level
      , getInt(level+"_rows")
      , getInt(level+"_cols")
      , getInt(level+"_bombs")
  public GameSettings get() {
    return get(getProperty("level"));
  public void set(GameSettings settings) {
    setProperty("level", settings.level);
    setProperty(settings.level+"_rows", ""+settings.rows);
    setProperty(settings.level+"_cols", ""+settings.cols);
    setProperty(settings.level+"_bombs", ""+settings.bombs);
  public void load() {
    try {
      load(new FileReader(FILENAME));
    } catch (Exception e) {
      System.err.println("Failed to load properties from "+FILENAME+" - "+e);
      e.printStackTrace();
  public void save() {
    try {
      store(new FileWriter(FILENAME), FILENAME);
    } catch (Exception e) {
      System.err.println("Failed to save properties to "+FILENAME+" - "+e);
      e.printStackTrace();
  private int getInt(String key) {
    try {
      return Integer.parseInt(getProperty(key));
    } catch (Exception e) {
      e.printStackTrace();
      throw new RuntimeException("Failed to getPropertyAsInt("+key+") from "+FILENAME+" - "+e);
GameSettings.java
package krc.games.sweeper;
class GameSettings
  public String level;
  public int rows;
  public int cols;
  public int bombs;
  GameSettings(String level, int rows, int cols, int bombs) {
    this.level = level;
    this.rows = rows;
    this.cols = cols;
    this.bombs = bombs;
GameClock.java
package krc.games.sweeper;
import javax.swing.JLabel;
import javax.swing.border.LineBorder;
import java.awt.Color;
class GameClock extends JLabel
  private static final long serialVersionUID = 0L;
  private volatile boolean isRunning = false;
  private volatile int elapsedTime;
  public GameClock() {
    super("0");
    elapsedTime = 0;
    this.setBorder(new LineBorder(Color.black));
  public void start() {
    if(isRunning) return;
    isRunning = true;
    new Thread() {
      public void run() {
        while (isRunning) {
          setText(""+(elapsedTime++));
          try{Thread.sleep(1000);}catch(InterruptedException eaten){}
    }.start();
  public void stop() {
    this.isRunning = false;
  public void skip(int seconds) {
    elapsedTime+=seconds;
  public void reset() {
    elapsedTime = 0;
    super.setText("0");
MineSweeperGame.properties
#MineSweeperGame.properties
#Sat Dec 29 18:56:47 GMT+10:00 2007
level=expert
beginner_rows=9
beginner_cols=9
beginner_bombs=10
intermediate_rows=16
intermediate_cols=16
intermediate_bombs=40
expert_rows=16
expert_cols=30
expert_bombs=99
custom_rows=30
custom_cols=50
custom_bombs=299-----
BTW... I gave up on the whole refactor thing... I just couldn't work out how to cleanly separate the view from the model... and my design was getting mighty complicated.... bigger than ben hurr... So I decided to revert to the "hack" version, and do a little refactoring to try to split out the more-easily-split-out sections, and tada - I (mostly) got through the TODO list.
Also... can anyone point me at a good serialization tutorial... sun's is a bit how's your dad.
Thanx all.