org.refcodes.checkerboard.GridModeChangedEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of refcodes-checkerboard Show documentation

Artifact for providing some easy means to visualize (state of) board games or (state of) cellular automatons.

There is a newer version: 3.3.8

Show newest version

package org.refcodes.checkerboard;

import org.refcodes.graphical.GridMode;
import org.refcodes.graphical.GridModeAccessor;

/**
 * The Class GridModeChangedEvent.
 *
 * @param  the generic type
 * @param  the generic type
 */
public class GridModeChangedEvent, S> extends AbstractCheckerboardEvent implements CheckerboardEvent, GridModeAccessor {

	// /////////////////////////////////////////////////////////////////////////
	// STATICS:
	// /////////////////////////////////////////////////////////////////////////

	// /////////////////////////////////////////////////////////////////////////
	// CONSTANTS:
	// /////////////////////////////////////////////////////////////////////////

	public static final CheckerboardAction ACTION = CheckerboardAction.GRID_MODE_CHANGED;

	// /////////////////////////////////////////////////////////////////////////
	// VARIABLES:
	// /////////////////////////////////////////////////////////////////////////

	private GridMode _gridMode;
	private GridMode _precedingGridMode;

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * Instantiates a new grid mode changed event.
	 *
	 * @param aGridMode the grid mode
	 * @param aPrecedingGridMode the preceding grid mode
	 * @param aSource The according source (origin).
	 */
	public GridModeChangedEvent( GridMode aGridMode, GridMode aPrecedingGridMode, Checkerboard aSource ) {
		super( ACTION, aSource );
		_gridMode = aGridMode;
		_precedingGridMode = aPrecedingGridMode;
	}

	// /////////////////////////////////////////////////////////////////////////
	// INJECTION:
	// /////////////////////////////////////////////////////////////////////////

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * {@inheritDoc}
	 */
	@Override
	public GridMode getGridMode() {
		return _gridMode;
	}

	/**
	 * Gets the preceding grid mode.
	 *
	 * @return the preceding grid mode
	 */
	public GridMode getPrecedingGridMode() {
		return _precedingGridMode;
	}

	// /////////////////////////////////////////////////////////////////////////
	// HOOKS:
	// /////////////////////////////////////////////////////////////////////////

	// /////////////////////////////////////////////////////////////////////////
	// HELPER:
	// /////////////////////////////////////////////////////////////////////////

	// /////////////////////////////////////////////////////////////////////////
	// INNER CLASSES:
	// /////////////////////////////////////////////////////////////////////////

}