Package VASSAL.build.module.map

Class KeyBufferer

java.lang.Object

java.awt.event.MouseAdapter

VASSAL.build.module.map.KeyBufferer

All Implemented Interfaces:

MouseListener, MouseMotionListener, MouseWheelListener, EventListener, Buildable, Drawable

public class KeyBufferer
extends MouseAdapter
implements Buildable, MouseMotionListener, Drawable

This component listens for mouse clicks on a map and draws the selection rectangle. ... If the user clicks on a GamePiece, that piece is added to the KeyBuffer. draw(Graphics, Map) is responsible for drawing the mouse selection rectangle, and mouseDragged(MouseEvent) is responsible for triggering repaint events as the selection rectangle is moved.

See Also:

Map.addLocalMouseListener(java.awt.event.MouseListener)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	KeyBufferer.KBDeckVisitor

Field Summary

Fields

Modifier and Type	Field	Description
protected Point	anchor
protected GamePiece	bandSelectPiece
protected Color	color
protected Map	map
protected Rectangle	selection
protected int	thickness

Constructor Summary

Constructors

Constructor	Description
KeyBufferer()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Adds a child component.
void	addTo(Buildable b)	Adds this component to its parent.
void	build(Element e)	Build the object
protected PieceVisitorDispatcher	createDragSelector(boolean selecting, boolean altDown, Rectangle mapsel)	This PieceVisitorDispatcher determines what to do with pieces on the map when the player finished dragging a rectangle to select pieces
void	draw(Graphics g, Map map)
boolean	drawAboveCounters()
Element	getBuildElement(Document doc)
void	mouseDragged(MouseEvent e)	Sets the new location of the selection rectangle.
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
protected void	repaintSelectionRect()

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mouseEntered, mouseExited, mouseWheelMoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

map

protected Map map

selection

protected Rectangle selection

anchor

protected Point anchor

color

protected Color color

thickness

protected int thickness

bandSelectPiece

protected GamePiece bandSelectPiece

Constructor Details

KeyBufferer

public KeyBufferer()

Method Details

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

add

public void add(Buildable b)

Description copied from interface: Buildable

Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent

Specified by:

add in interface Buildable

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Returns:

an XML element from which this component can be built

build

public void build(Element e)

Description copied from interface: Buildable

Build the object

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class MouseAdapter

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class MouseAdapter

createDragSelector

protected PieceVisitorDispatcher createDragSelector(boolean selecting,
boolean altDown,
Rectangle mapsel)

This PieceVisitorDispatcher determines what to do with pieces on the map when the player finished dragging a rectangle to select pieces

Returns:

repaintSelectionRect

protected void repaintSelectionRect()

mouseDragged

public void mouseDragged(MouseEvent e)

Sets the new location of the selection rectangle.

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class MouseAdapter

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class MouseAdapter

draw

public void draw(Graphics g,
Map map)

Specified by:

draw in interface Drawable

drawAboveCounters

public boolean drawAboveCounters()

Specified by:

drawAboveCounters in interface Drawable