org.refcodes.checkerboard.GridDimensionChangedEvent 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.GridDimension;
import org.refcodes.graphical.GridDimensionImpl;

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

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

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

	public static final CheckerboardAction ACTION = CheckerboardAction.GRID_DIMENSION_CHANGED;

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

	private int _height;
	private int _width;
	private GridDimension _precedingDimension;

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

	/**
	 * Instantiates a new grid dimension changed event.
	 *
	 * @param aWidth the width
	 * @param aHeight the height
	 * @param aPrecedingWidth the preceding width
	 * @param aPrecedingHeigt the preceding heigt
	 * @param aSource The according source (origin).
	 */
	public GridDimensionChangedEvent( int aWidth, int aHeight, int aPrecedingWidth, int aPrecedingHeigt, Checkerboard aSource ) {
		super( ACTION, aSource );
		_width = aWidth;
		_height = aHeight;
		_precedingDimension = new GridDimensionImpl( aPrecedingWidth, aPrecedingHeigt );
	}

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

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int getGridHeight() {
		return _height;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int getGridWidth() {
		return _width;
	}

	/**
	 * Gets the preceding grid dimension.
	 *
	 * @return the preceding grid dimension
	 */
	public GridDimension getPrecedingGridDimension() {
		return _precedingDimension;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString() {
		return getClass().getSimpleName() + "(" + _width + ":" + _height + ")@" + hashCode();
	}

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

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

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

}