com.vividsolutions.jump.workbench.ui.cursortool

Class AbstractCursorTool

java.lang.Object

com.vividsolutions.jump.workbench.ui.cursortool.AbstractCursorTool

All Implemented Interfaces:

CursorTool, MouseListener, MouseMotionListener, EventListener

Direct Known Subclasses:

DragTool, MultiClickTool, SnapIndicatorTool

public abstract class AbstractCursorTool
extends Object
implements CursorTool

A tool that draws an XOR visual indicator. Subclasses need not keep track of the XOR state of the indicator -- that logic is all handled by this class. Even if the LayerViewPanel is repainted while the XOR indicator is on-screen.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractCursorTool.Listener

Constructor Summary

Constructors

Constructor and Description
AbstractCursorTool()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(LayerViewPanel layerViewPanel)
void	add(AbstractCursorTool.Listener listener)
void	allowSnapping() Makes this CursorTool obey the snapping settings in the Options dialog.
void	cancelGesture() Notifies the CursorTool that a party is requesting that the gesture currently in progress be aborted.
protected boolean	check(EnableCheck check)
protected void	cleanup(Graphics2D graphics)
protected void	clearShape()
static Cursor	createCursor(Image image) The cursor will look best if the image is a 32 x 32 transparent GIF.
static Cursor	createCursor(Image image, Point hotSpot)
static List	createStandardSnappingPolicies(Blackboard blackboard)
void	deactivate()
protected void	drawShapeXOR(Graphics2D g)
protected void	drawShapeXOR(Shape shape, Graphics2D graphics)
protected void	execute(UndoableCommand command) Optional means of execution, with undoability.
protected void	fireGestureFinished()
protected abstract void	gestureFinished()
Color	getColor()
Cursor	getCursor()
String	getName() Returns a very brief description of this CursorTool.
protected LayerViewPanel	getPanel()
protected abstract Shape	getShape()
SnapManager	getSnapManager()
protected TaskFrame	getTaskFrame()
JUMPWorkbench	getWorkbench()
boolean	isGestureInProgress() Used by OrCompositeTool to determine whether a CursorTool is busy interacting with the user.
boolean	isRightMouseButtonUsed()
protected boolean	isRollingBackInvalidEdits()
boolean	isShapeOnScreen() Important for XOR drawing.
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
static String	name(CursorTool tool)
protected void	redrawShape()
protected void	reportNothingToUndoYet() Notifies the UndoManager that this PlugIn did not modify any model states, and therefore the undo history should remain unchanged.
void	setColor(Color color)
protected void	setFilling(boolean filling)
protected void	setStroke(Stroke stroke)
protected void	setStrokeWidth(int strokeWidth) Deprecated. Use #setStroke instead.
protected void	setup(Graphics2D graphics)
protected com.vividsolutions.jts.geom.Coordinate	snap(com.vividsolutions.jts.geom.Coordinate modelCoordinate)
protected com.vividsolutions.jts.geom.Coordinate	snap(Point2D viewPoint)
String	toString()
protected boolean	wasControlPressed()
protected boolean	wasShiftPressed()
static JUMPWorkbench	workbench(LayerViewPanel panel)
static WorkbenchFrame	workbenchFrame(LayerViewPanel layerViewPanel)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vividsolutions.jump.workbench.ui.cursortool.CursorTool

getIcon

Constructor Detail

AbstractCursorTool

public AbstractCursorTool()

Method Detail

allowSnapping

public void allowSnapping()

Makes this CursorTool obey the snapping settings in the Options dialog.

wasShiftPressed

protected boolean wasShiftPressed()

wasControlPressed

protected boolean wasControlPressed()

createCursor

public static Cursor createCursor(Image image)

The cursor will look best if the image is a 32 x 32 transparent GIF.

createCursor

public static Cursor createCursor(Image image,
                  Point hotSpot)

getCursor

public Cursor getCursor()

Specified by:

getCursor in interface CursorTool

isGestureInProgress

public boolean isGestureInProgress()

Used by OrCompositeTool to determine whether a CursorTool is busy interacting with the user.

Specified by:

isGestureInProgress in interface CursorTool

isRightMouseButtonUsed

public boolean isRightMouseButtonUsed()

Specified by:

isRightMouseButtonUsed in interface CursorTool

Returns:

true if this CursorTool uses the right mouse button; false to allow the panel to show a popup-menu on right-clicks

isShapeOnScreen

public boolean isShapeOnScreen()

Important for XOR drawing. Even if #getShape returns null, this method will return true between calls of #redrawShape and #clearShape.

activate

public void activate(LayerViewPanel layerViewPanel)

Specified by:

activate in interface CursorTool

workbenchFrame

public static WorkbenchFrame workbenchFrame(LayerViewPanel layerViewPanel)

createStandardSnappingPolicies

public static List createStandardSnappingPolicies(Blackboard blackboard)

isRollingBackInvalidEdits

protected boolean isRollingBackInvalidEdits()

deactivate

public void deactivate()

Specified by:

deactivate in interface CursorTool

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

setColor

public void setColor(Color color)

setFilling

protected void setFilling(boolean filling)

setStrokeWidth

protected void setStrokeWidth(int strokeWidth)

Deprecated. Use #setStroke instead.

setStroke

protected void setStroke(Stroke stroke)

setup

protected void setup(Graphics2D graphics)

getPanel

protected LayerViewPanel getPanel()

getShape

protected abstract Shape getShape()
                           throws Exception

Returns:

null if nothing should be drawn

Throws:

Exception

cleanup

protected void cleanup(Graphics2D graphics)

clearShape

protected void clearShape()

cancelGesture

public void cancelGesture()

Description copied from interface: CursorTool

Notifies the CursorTool that a party is requesting that the gesture currently in progress be aborted.

Specified by:

cancelGesture in interface CursorTool

drawShapeXOR

protected void drawShapeXOR(Graphics2D g)
                     throws Exception

Throws:

Exception

drawShapeXOR

protected void drawShapeXOR(Shape shape,
                Graphics2D graphics)

redrawShape

protected void redrawShape()
                    throws Exception

Throws:

Exception

snap

protected com.vividsolutions.jts.geom.Coordinate snap(Point2D viewPoint)
                                               throws NoninvertibleTransformException

Throws:

NoninvertibleTransformException

snap

protected com.vividsolutions.jts.geom.Coordinate snap(com.vividsolutions.jts.geom.Coordinate modelCoordinate)

getTaskFrame

protected TaskFrame getTaskFrame()

Returns:

null if the LayerViewPanel is not inside a TaskFrame

getWorkbench

public JUMPWorkbench getWorkbench()

workbench

public static JUMPWorkbench workbench(LayerViewPanel panel)

gestureFinished

protected abstract void gestureFinished()
                                 throws Exception

Throws:

Exception

fireGestureFinished

protected void fireGestureFinished()
                            throws Exception

Throws:

Exception

add

public void add(AbstractCursorTool.Listener listener)

execute

protected void execute(UndoableCommand command)

Optional means of execution, with undoability.

reportNothingToUndoYet

protected void reportNothingToUndoYet()

Notifies the UndoManager that this PlugIn did not modify any model states, and therefore the undo history should remain unchanged. Call this method inside #execute(PlugInContext).

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from interface: CursorTool

Returns a very brief description of this CursorTool.

Specified by:

getName in interface CursorTool

Returns:

the name of this CursorTool

name

public static String name(CursorTool tool)

check

protected boolean check(EnableCheck check)

getSnapManager

public SnapManager getSnapManager()

getColor

public Color getColor()