Class PieceMover.DragHandlerNoImage

java.lang.Object

VASSAL.build.module.map.PieceMover.AbstractDragHandler

VASSAL.build.module.map.PieceMover.DragHandlerNoImage

All Implemented Interfaces:

DragGestureListener, DragSourceListener, DragSourceMotionListener, DropTargetListener, EventListener

Enclosing class:

PieceMover

public static class PieceMover.DragHandlerNoImage
extends PieceMover.AbstractDragHandler

Fallback drag-handler when DragImage not supported by JRE. Implements a pseudo-cursor that follows the mouse cursor when user drags game pieces. Supports map zoom by resizing cursor when it enters a drop target of type Map.View.

Version:

0.4.2

Author:

Jim Urbas

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

Modifier and Type	Field	Description
protected Component	dragWin
protected final Point	drawOffset
protected JLayeredPane	drawWin
protected Component	dropWin

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
DragHandlerNoImage()

Method Summary

Modifier and Type	Method	Description
protected void	calcDrawOffset()	calculates the offset between cursor dragCursor positions
void	dragDropEnd(DragSourceDropEvent e)	DRAG SOURCE LISTENER INTERFACE
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	dragGestureRecognized(DragGestureEvent dge)	DRAG GESTURE LISTENER INTERFACE EVENT uses SCALED, DRAG-SOURCE coordinate system.
void	dragMouseMoved(DragSourceDragEvent e)	DRAG SOURCE MOTION LISTENER INTERFACE EVENT uses UNSCALED, SCREEN coordinate system Moves cursor after mouse.
void	drop(DropTargetDropEvent e)	DROP TARGET INTERFACE EVENT uses UNSCALED, DROP-TARGET coordinate system drop() - Last event of the drop operation.
protected double	getDeviceScale(DragGestureEvent dge)
protected double	getDeviceScale(DropTargetDragEvent e)
protected int	getOffsetMult()
protected void	makeDragCursor(double zoom)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	makeDragCursor(double zoom, double os_scale)	Installs the cursor image into our dragCursor JLabel.
protected void	moveDragCursor(int dragX, int dragY)	Moves the drag cursor on the current draw window
protected void	removeDragCursor()	Removes the drag cursor from the current draw window
void	setDrawWinToOwnerOf(Component newDropWin)	creates or moves cursor object to given window.

Methods inherited from class PieceMover.AbstractDragHandler

addPieceMover, beginDragging, dragEnter, dragExit, dragExit, dragGestureRecognizedPrep, dragOver, dragOver, dropActionChanged, dropActionChanged, getListener, getTheDragHandler, makeDragImageCursorCommon, makeDragImageCursorCommon, makeDropTarget, removeDropTarget, resetDragHandler, resetRecursivePieceSlots, 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.
void	dragEnter(DragSourceDragEvent e)
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	dragOver(DragSourceDragEvent e)
void	dragOver(DropTargetDragEvent e)	Passes event along listener chain
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 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.
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
static void	setTheDragHandler(PieceMover.AbstractDragHandler myHandler)

Methods inherited from class Object

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

Field Details

dragWin

protected Component dragWin

dropWin

protected Component dropWin

drawWin

protected JLayeredPane drawWin

drawOffset

protected final Point drawOffset

Constructor Details

DragHandlerNoImage

public DragHandlerNoImage()

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

makeDragCursor

@Deprecated(since="2023-05-15",
            forRemoval=true)
protected void makeDragCursor(double zoom)

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

Overrides:

makeDragCursor in class PieceMover.AbstractDragHandler

makeDragCursor

protected void makeDragCursor(double zoom,
 double os_scale)

Installs the cursor image into our dragCursor JLabel. Sets current zoom. Should be called at beginning of drag and whenever zoom changes. INPUT: DragBuffer.getBuffer OUTPUT: dragCursorZoom cursorOffCenterX cursorOffCenterY boundingBox

Parameters:

zoom - DragBuffer.getBuffer

moveDragCursor

protected void moveDragCursor(int dragX,
 int dragY)

Moves the drag cursor on the current draw window

Overrides:

moveDragCursor in class PieceMover.AbstractDragHandler

Parameters:

dragX - x position

dragY - y position

removeDragCursor

protected void removeDragCursor()

Removes the drag cursor from the current draw window

Overrides:

removeDragCursor in class PieceMover.AbstractDragHandler

calcDrawOffset

protected void calcDrawOffset()

calculates the offset between cursor dragCursor positions

Overrides:

calcDrawOffset in class PieceMover.AbstractDragHandler

setDrawWinToOwnerOf

public void setDrawWinToOwnerOf(Component newDropWin)

creates or moves cursor object to given window. Called when drag operation begins in a window or the cursor is dragged over a new drop-target window

Overrides:

setDrawWinToOwnerOf in class PieceMover.AbstractDragHandler

Parameters:

newDropWin - window component to be our new draw window.

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

dragDropEnd

public void dragDropEnd(DragSourceDropEvent e)

Description copied from class: PieceMover.AbstractDragHandler

DRAG SOURCE LISTENER INTERFACE

Specified by:

dragDropEnd in interface DragSourceListener

Overrides:

dragDropEnd in class PieceMover.AbstractDragHandler

Parameters:

e - DragSourceDropEvent

dragMouseMoved

public void dragMouseMoved(DragSourceDragEvent e)

Description copied from class: PieceMover.AbstractDragHandler

DRAG SOURCE MOTION LISTENER INTERFACE EVENT uses UNSCALED, SCREEN coordinate system Moves cursor after mouse. Used to check for real mouse movement. Warning: dragMouseMoved fires 8 times for each point on development system (Win2k)

Specified by:

dragMouseMoved in interface DragSourceMotionListener

Overrides:

dragMouseMoved in class PieceMover.AbstractDragHandler

dragEnter

public void dragEnter(DropTargetDragEvent e)

Description copied from class: PieceMover.AbstractDragHandler

DROP TARGET INTERFACE EVENT uses UNSCALED, DROP-TARGET coordinate system dragEnter - switches current drawWin when mouse enters a new DropTarget

Specified by:

dragEnter in interface DropTargetListener

Overrides:

dragEnter in class PieceMover.AbstractDragHandler

drop

public void drop(DropTargetDropEvent e)

Description copied from class: PieceMover.AbstractDragHandler

DROP TARGET INTERFACE EVENT uses UNSCALED, DROP-TARGET coordinate system drop() - Last event of the drop operation. We adjust the drop point for off-center drag, remove the cursor, and pass the event along listener chain.

Specified by:

drop in interface DropTargetListener

Overrides:

drop in class PieceMover.AbstractDragHandler