org.refcodes.checkerboard.ViewportOffsetChangedEvent 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.ViewportOffset;
import org.refcodes.graphical.ViewportOffsetImpl;

/**
 * The Class ViewportOffsetChangedEvent.
 *
 * @param  the generic type
 * @param  the generic type
 */
public class ViewportOffsetChangedEvent, S> extends AbstractCheckerboardViewerEvent implements CheckerboardViewerEvent, ViewportOffset {

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

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

	public static final CheckerboardViewerAction ACTION = CheckerboardViewerAction.VIEWPORT_OFFSET_CHANGED;

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

	private int _offsetX;
	private int _offsetY;
	private ViewportOffset _precedingOffset;

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

	/**
	 * Instantiates a new viewport offset changed event.
	 *
	 * @param aOffsetY the offset Y
	 * @param aOffsetX the offset X
	 * @param aPrecedingOffsetX the preceding offset X
	 * @param aPrecedingOffsetY the preceding offset Y
	 * @param aSource The according source (origin).
	 */
	public ViewportOffsetChangedEvent( int aOffsetY, int aOffsetX, int aPrecedingOffsetX, int aPrecedingOffsetY, CheckerboardViewer aSource ) {
		super( ACTION, aSource );
		_offsetX = aOffsetX;
		_offsetY = aOffsetY;
		_precedingOffset = new ViewportOffsetImpl( aPrecedingOffsetX, aPrecedingOffsetY );
	}

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

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int getViewportOffsetX() {
		return _offsetX;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int getViewportOffsetY() {
		return _offsetY;
	}

	/**
	 * Gets the preceding viewport offset.
	 *
	 * @return the preceding viewport offset
	 */
	public ViewportOffset getPrecedingViewportOffset() {
		return _precedingOffset;
	}

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

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

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

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

}