Package VASSAL.build.module.map

Class PieceMover

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.module.map.PieceMover

All Implemented Interfaces:

MouseListener, Comparator<GamePiece>, EventListener, Buildable, GameComponent, PropertyNameSource, ValidityChecker

public class PieceMover
extends AbstractBuildable
implements MouseListener, GameComponent, Comparator<GamePiece>

This is a MouseListener that moves pieces onto a Map window

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PieceMover.AbstractDragHandler	Common functionality for DragHandler for cases with and without drag image support.
static class	PieceMover.DragHandler	Implementation of AbstractDragHandler when DragImage is supported by JRE
static class	PieceMover.DragHandlerMacOSX
static class	PieceMover.DragHandlerNoImage	Implements a psudo-cursor that follows the mouse cursor when user drags gamepieces.

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUTO_REPORT	The Preferences key for autoreporting moves.
protected Point	dragBegin
protected GamePiece	dragging
protected PieceFinder	dragTargetSelector
protected PieceFinder	dropTargetSelector
static String	HOTKEY
static String	ICON_NAME
protected String	iconName
protected Map	map
protected LaunchButton	markUnmovedButton
protected String	markUnmovedIcon
protected String	markUnmovedText
static String	NAME
protected Comparator<GamePiece>	pieceSorter
protected PieceVisitorDispatcher	selectionProcessor

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Constructor Summary

Constructors

Constructor	Description
PieceMover()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable b)	Adds this component to its parent.
protected Command	applyKeyAfterMove(List<GamePiece> pieces, KeyStroke key)
protected void	applyKeyAfterMove(List<GamePiece> pieces, Command comm, KeyStroke key)	Deprecated, for removal: This API element is subject to removal in a future version. Use applyKeyAfterMove(List, KeyStroke) to return Commands
protected boolean	canHandleEvent(MouseEvent e)
int	compare(GamePiece p1, GamePiece p2)	Implement Comparator to sort the contents of the drag buffer before completing the drag.
protected PieceFinder	createDragTargetSelector()	Returns the PieceFinder instance that will select a GamePiece for processing when the user clicks on the map.
protected PieceFinder	createDropTargetSelector()	When the user completes a drag-drop operation, the pieces being dragged will either be combined with an existing piece on the map or else placed on the map without stack.
protected MovementReporter	createMovementReporter(Command c)
protected PieceVisitorDispatcher	createSelectionProcessor()	When the user clicks on the map, a piece from the map is selected by the dragTargetSelector.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String key)
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
protected void	initButton()
boolean	isClick(Point pt)	Return true if this point is "close enough" to the point at which the user pressed the mouse to be considered a mouse click (such that no moves are done)
protected boolean	isMultipleSelectionEvent(MouseEvent e)
Command	markMoved(GamePiece p, boolean hasMoved)
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)	This listener is used for faking drag-and-drop on Java 1.1 systems
void	mouseReleased(MouseEvent e)
protected Command	movedPiece(GamePiece p, Point loc)	Invoked just before a piece is moved
Command	movePieces(Map map, Point p)	Moves pieces in DragBuffer to point p by generating a Command for each element in DragBuffer
protected void	performDrop(Point p)
protected void	selectMovablePieces(MouseEvent e)	Place the clicked-on piece into the DragBuffer
protected void	selectMovablePieces(Point point)	Deprecated, for removal: This API element is subject to removal in a future version. Use selectMovablePieces(MouseEvent).
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
protected void	setOldLocation(GamePiece p)	Deprecated, for removal: This API element is subject to removal in a future version. setOldLocations(GamePiece) to return generated Commands
protected Command	setOldLocations(GamePiece p)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
protected boolean	shouldMarkMoved()

Methods inherited from class VASSAL.build.AbstractBuildable

add, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

AUTO_REPORT

public static final String AUTO_REPORT

The Preferences key for autoreporting moves.

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

HOTKEY

public static final String HOTKEY

See Also:

Constant Field Values

map

protected Map map

dragBegin

protected Point dragBegin

dragging

protected GamePiece dragging

markUnmovedButton

protected LaunchButton markUnmovedButton

markUnmovedText

protected String markUnmovedText

markUnmovedIcon

protected String markUnmovedIcon

ICON_NAME

public static final String ICON_NAME

See Also:

Constant Field Values

iconName

protected String iconName

dragTargetSelector

protected PieceFinder dragTargetSelector

dropTargetSelector

protected PieceFinder dropTargetSelector

selectionProcessor

protected PieceVisitorDispatcher selectionProcessor

pieceSorter

protected Comparator<GamePiece> pieceSorter

Constructor Details

PieceMover

public PieceMover()

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

createMovementReporter

protected MovementReporter createMovementReporter(Command c)

createDropTargetSelector

protected PieceFinder createDropTargetSelector()

When the user completes a drag-drop operation, the pieces being dragged will either be combined with an existing piece on the map or else placed on the map without stack.

Returns:

a PieceFinder instance that determines which GamePiece (if any) to combine the being-dragged pieces with.

createSelectionProcessor

protected PieceVisitorDispatcher createSelectionProcessor()

When the user clicks on the map, a piece from the map is selected by the dragTargetSelector. What happens to that piece is determined by the PieceVisitorDispatcher instance returned by this method. The default implementation does the following: If a Deck, add the top piece to the drag buffer If a stack, add it to the drag buffer. Otherwise, add the piece and any other multi-selected pieces to the drag buffer.

Returns:

Dispatcher

See Also:

createDragTargetSelector()

createDragTargetSelector

protected PieceFinder createDragTargetSelector()

Returns the PieceFinder instance that will select a GamePiece for processing when the user clicks on the map. The default implementation is to return the first piece whose shape contains the point clicked on.

Returns:

Piece Finder

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

initButton

protected void initButton()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeValueString

public String getAttributeValueString(String key)

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).

setAttribute

public void setAttribute(String key,
Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

isMultipleSelectionEvent

protected boolean isMultipleSelectionEvent(MouseEvent e)

movedPiece

protected Command movedPiece(GamePiece p,
Point loc)

Invoked just before a piece is moved

setOldLocation

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void setOldLocation(GamePiece p)

Deprecated, for removal: This API element is subject to removal in a future version.

setOldLocations(GamePiece) to return generated Commands

Parameters:

p - Piece

setOldLocations

protected Command setOldLocations(GamePiece p)

markMoved

public Command markMoved(GamePiece p,
boolean hasMoved)

shouldMarkMoved

protected boolean shouldMarkMoved()

movePieces

public Command movePieces(Map map,
Point p)

Moves pieces in DragBuffer to point p by generating a Command for each element in DragBuffer

Parameters:

map - Map

p - Point mouse released

applyKeyAfterMove

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void applyKeyAfterMove(List<GamePiece> pieces,
Command comm,
KeyStroke key)

Deprecated, for removal: This API element is subject to removal in a future version.

Use applyKeyAfterMove(List, KeyStroke) to return Commands

applyKeyAfterMove

protected Command applyKeyAfterMove(List<GamePiece> pieces,
KeyStroke key)

mousePressed

public void mousePressed(MouseEvent e)

This listener is used for faking drag-and-drop on Java 1.1 systems

Specified by:

mousePressed in interface MouseListener

Parameters:

e - Event

selectMovablePieces

protected void selectMovablePieces(MouseEvent e)

Place the clicked-on piece into the DragBuffer

selectMovablePieces

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void selectMovablePieces(Point point)

Deprecated, for removal: This API element is subject to removal in a future version.

Use selectMovablePieces(MouseEvent).

canHandleEvent

protected boolean canHandleEvent(MouseEvent e)

isClick

public boolean isClick(Point pt)

Return true if this point is "close enough" to the point at which the user pressed the mouse to be considered a mouse click (such that no moves are done)

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

performDrop

protected void performDrop(Point p)

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

compare

public int compare(GamePiece p1,
GamePiece p2)

Implement Comparator to sort the contents of the drag buffer before completing the drag. This sorts the contents to be in the same order as the pieces were in their original parent stack.

Specified by:

compare in interface Comparator<GamePiece>