GameOfLifeControlsEvent.java

Go to the documentation of this file.

/* This page is part of the Game of Life source code */

package org.bitstorm.gameoflife;

import java.awt.Event;

/**
 * Event class for GameOfLifeControls.
 * Can pass speed, cellSize and shapeName.
 * Objects from this class are generated by GameOfLifeControls
 * @see GameOfLifeControls
 * @author Edwin Martin
 */
public class GameOfLifeControlsEvent extends Event {
  private int speed;
  private int zoom;
  private String shapeName;

  /**
   * Construct a GameOfLifeControls.ControlsEvent
   * @param source source of event
   */
  public GameOfLifeControlsEvent(Object source) {
    super(source, 0, null);
  }

  /**
   * Constructs a event due to the speed changed.
   * @param source source of the event
   * @param speed new speed
   * @return new event object
   */
  public static GameOfLifeControlsEvent getSpeedChangedEvent( Object source, int speed ) {
    GameOfLifeControlsEvent event = new GameOfLifeControlsEvent(source);
    event.setSpeed(speed);
    return event;
  }
  
  /**
   * Constructs a event due to the zoom changed.
   * @param source source of the event
   * @param zoom new zoom (cell size in pixels)
   * @return new event object
   */
  public static GameOfLifeControlsEvent getZoomChangedEvent( Object source, int zoom ) {
    GameOfLifeControlsEvent event = new GameOfLifeControlsEvent(source);
    event.setZoom(zoom);
    return event;
  }
  
  /**
   * Constructs a event due to the shape changed.
   * @param source source of the event
   * @param shapeName name of selected shape
   * @return new event object
   */
  public static GameOfLifeControlsEvent getShapeSelectedEvent( Object source, String shapeName ) {
    GameOfLifeControlsEvent event = new GameOfLifeControlsEvent(source);
    event.setShapeName(shapeName);
    return event;
  }
  
  /**
   * Gets speed of Game
   * @return speed (10 is fast, 1000 is slow)
   */
  public int getSpeed() {
    return speed;
  }

  /**
   * Sets speed of Game
   * @param speed (10 is fast, 1000 is slow)
   */
  public void setSpeed( int speed ) {
    this.speed = speed;
  }

  /**
   * Gets size of cell
   * @return speed (10 is big, 2 is small)
   */
  public int getZoom() {
    return zoom;
  }

  /**
   * Sets zoom of Game
   * @param zoom size of cell in pixels
   */
  public void setZoom( int zoom ) {
    this.zoom = zoom;
  }

  /**
   * Gets name of shape
   * @return name of selected shape
   */
  public String getShapeName() {
    return shapeName;
  }

  /**
   * Sets name of shape
   * @param shapeName name of shape
   */
  public void setShapeName( String shapeName ) {
    this.shapeName = shapeName;
  }

}