Class PieceMover.DragHandler

java.lang.Object

VASSAL.build.module.map.PieceMover.AbstractDragHandler

VASSAL.build.module.map.PieceMover.DragHandler

All Implemented Interfaces:

DragGestureListener, DragSourceListener, DragSourceMotionListener, DropTargetListener, EventListener

Direct Known Subclasses:

PieceMover.DragHandlerMacOSX

Enclosing class:

PieceMover

public static class PieceMover.DragHandler
extends PieceMover.AbstractDragHandler

VASSAL's front-line drag handler for drag-and-drop of pieces. Implementation of AbstractDragHandler when DragImage is supported by JRE. PieceMover.DragHandlerMacOSX extends this for special Mac platform

Author:

Pieter Geerkens

Nested Class Summary

Nested classes/interfaces inherited from class PieceMover.AbstractDragHandler

PieceMover.AbstractDragHandler.AbstractDragHandlerFactory

Modifier and Type	Class	Description
static class	PieceMover.AbstractDragHandler.AbstractDragHandlerFactory	Picks the correct drag handler based on our OS, DragSource, and preferences.

Field Summary

Fields inherited from class PieceMover.AbstractDragHandler

boundingBox, boundingBoxComp, currentPieceOffsetX, currentPieceOffsetY, CURSOR_ALPHA, dragCursor, dragCursorZoom, dragPieceOffCenterZoom, dropTargetListeners, EXTRA_BORDER, lastDragLocation, pieceMovers

Modifier and Type	Field	Description
protected Rectangle	boundingBox
protected Rectangle	boundingBoxComp
protected int	currentPieceOffsetX
protected int	currentPieceOffsetY
protected static final int	CURSOR_ALPHA
protected JLabel	dragCursor
protected double	dragCursorZoom
protected double	dragPieceOffCenterZoom
protected Map<Component, DropTargetListener>	dropTargetListeners
protected static final int	EXTRA_BORDER
protected Point	lastDragLocation
protected static List<PieceMover>	pieceMovers

Constructor Summary

Constructors

Constructor	Description
DragHandler()

Method Summary

Modifier and Type	Method	Description
void	dragGestureRecognized(DragGestureEvent dge)	DRAG GESTURE LISTENER INTERFACE EVENT uses SCALED, DRAG-SOURCE coordinate system.
protected double	getDeviceScale(DragGestureEvent dge)
protected double	getDeviceScale(DropTargetDragEvent e)
protected int	getOffsetMult()

Methods inherited from class PieceMover.AbstractDragHandler

addPieceMover, beginDragging, calcDrawOffset, dragDropEnd, dragEnter, dragEnter, dragExit, dragExit, dragGestureRecognizedPrep, dragMouseMoved, dragOver, dragOver, drop, dropActionChanged, dropActionChanged, getListener, getTheDragHandler, makeDragCursor, makeDragImageCursorCommon, makeDragImageCursorCommon, makeDropTarget, moveDragCursor, removeDragCursor, removeDropTarget, resetDragHandler, resetRecursivePieceSlots, setDrawWinToOwnerOf, setTheDragHandler

Modifier and Type	Method	Description
static void	addPieceMover(PieceMover pm)	Registers a PieceMover
protected void	beginDragging(DragGestureEvent dge)	The the Drag Gesture Recognizer that we're officially beginning a drag.
protected void	calcDrawOffset()	calculates the offset between cursor dragCursor positions
void	dragDropEnd(DragSourceDropEvent e)	DRAG SOURCE LISTENER INTERFACE
void	dragEnter(DragSourceDragEvent e)
void	dragEnter(DropTargetDragEvent e)	DROP TARGET INTERFACE EVENT uses UNSCALED, DROP-TARGET coordinate system dragEnter - switches current drawWin when mouse enters a new DropTarget
void	dragExit(DragSourceEvent e)
void	dragExit(DropTargetEvent e)	Passes event along listener chain
protected Point	dragGestureRecognizedPrep(DragGestureEvent dge)	Sets things up at the beginning of a drag-and-drop operation: - Screen out any immovable pieces - Account for any offsets on in the window - Sets dragWin to our source window
void	dragMouseMoved(DragSourceDragEvent dsde)	DRAG SOURCE MOTION LISTENER INTERFACE EVENT uses UNSCALED, SCREEN coordinate system Moves cursor after mouse.
void	dragOver(DragSourceDragEvent e)
void	dragOver(DropTargetDragEvent e)	Passes event along listener chain
void	drop(DropTargetDropEvent e)	DROP TARGET INTERFACE EVENT uses UNSCALED, DROP-TARGET coordinate system drop() - Last event of the drop operation.
void	dropActionChanged(DragSourceDragEvent e)
void	dropActionChanged(DropTargetDragEvent e)	Passes event along listener chain
protected DropTargetListener	getListener(DropTargetEvent e)
static PieceMover.AbstractDragHandler	getTheDragHandler()	returns the singleton DragHandler instance
protected void	makeDragCursor(double zoom)	Deprecated, for removal: This API element is subject to removal in a future version.
protected BufferedImage	makeDragImageCursorCommon(double zoom, boolean doOffset, Component target, boolean setSize)	Deprecated, for removal: This API element is subject to removal in a future version.
protected BufferedImage	makeDragImageCursorCommon(double mapzoom, double os_scale, boolean doOffset, Component target)
static DropTarget	makeDropTarget(Component theComponent, int dndContants, DropTargetListener dropTargetListener)	Creates a new DropTarget and hooks us into the beginning of a DropTargetListener chain.
protected void	moveDragCursor(int dragX, int dragY)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	removeDragCursor()	Deprecated, for removal: This API element is subject to removal in a future version.
static void	removeDropTarget(Component theComponent)	Removes a dropTarget component
static void	resetDragHandler()	Reset our drag handler, e.g. if our preferences change.
static void	resetRecursivePieceSlots(AbstractBuildable target)	Finds all the piece slots in a module and resets their drop targets to use a new DragHandler
void	setDrawWinToOwnerOf(Component newDropWin)	Deprecated, for removal: This API element is subject to removal in a future version.
static void	setTheDragHandler(PieceMover.AbstractDragHandler myHandler)

Methods inherited from class Object

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

Constructor Details

DragHandler

public DragHandler()

Method Details

dragGestureRecognized

public void dragGestureRecognized(DragGestureEvent dge)

Description copied from class: PieceMover.AbstractDragHandler

DRAG GESTURE LISTENER INTERFACE EVENT uses SCALED, DRAG-SOURCE coordinate system. ("component coordinates") PIECE uses SCALED, OWNER (arbitrary) coordinate system ("map coordinates") Fires after user begins moving the mouse several pixels over a map. This method will be overridden, but called as a super(), by the Drag Gesture extension that is used, which will either be PieceMover.DragHandler if DragImage is supported by the JRE, or PieceMover.DragHandlerNoImage if not. Either one will have called PieceMover.AbstractDragHandler.dragGestureRecognizedPrep(java.awt.dnd.DragGestureEvent), immediately below, before it calls this method.

Specified by:

dragGestureRecognized in interface DragGestureListener

Overrides:

dragGestureRecognized in class PieceMover.AbstractDragHandler

getOffsetMult

protected int getOffsetMult()

Specified by:

getOffsetMult in class PieceMover.AbstractDragHandler

Returns:

platform-dependent offset multiplier

getDeviceScale

protected double getDeviceScale(DragGestureEvent dge)

Specified by:

getDeviceScale in class PieceMover.AbstractDragHandler

Parameters:

dge - DG event

Returns:

platform-dependent device scale

getDeviceScale

protected double getDeviceScale(DropTargetDragEvent e)

Specified by:

getDeviceScale in class PieceMover.AbstractDragHandler