net.refractions.udig.project.ui.tool
Class SimpleTool

java.lang.Object
  net.refractions.udig.project.ui.tool.AbstractTool
      net.refractions.udig.project.ui.tool.AbstractModalTool
          net.refractions.udig.project.ui.tool.SimpleTool

All Implemented Interfaces:

java.util.EventListener, MapMouseListener, MapMouseMotionListener, MapMouseWheelListener, ModalTool, Tool

Direct Known Subclasses:

AbstractContextMenuTool

public class SimpleTool
extends AbstractModalTool

An abstract class for all tools that wish to be "selection" tools. A selection tool is distinquished from other tools as it opens a context menu with the normal context menu mouse button.

Since:

0.9.0

Author:

jeichar

Field Summary

Fields inherited from class net.refractions.udig.project.ui.tool.AbstractTool

context, DRAG_DROP, enabled, MOTION, MOUSE, NONE, WHEEL

Fields inherited from interface net.refractions.udig.project.ui.tool.ModalTool

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NO_CURSOR, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from interface net.refractions.udig.project.ui.tool.Tool

EDIT, EXTENSION_ID, VIEW

Constructor Summary

SimpleTool()
By default SimpleTool will simply respond to MOUSE.

SimpleTool(int targets)

Method Summary

void	mouseDoubleClicked(MapMouseEvent e) Consumes the event if the second mouse button is doubleclicked and calls onContextMouseDoubleClicked().
void	mouseDragged(MapMouseEvent e) This method may be overridden by subclasses
void	mouseEntered(MapMouseEvent e) This method may be overridden by subclasses
void	mouseExited(MapMouseEvent e) This method may be overridden by subclasses
void	mouseHovered(MapMouseEvent e) This method may be overridden by subclasses
void	mouseMoved(MapMouseEvent e) This method may be overridden by subclasses
void	mousePressed(MapMouseEvent e) Opens the context menu if the second mouse button is pressed and calls noContextMouseReleased().
void	mouseReleased(MapMouseEvent e) Consumes the event if the second mouse button is released and calls noContextMousePressed().
void	mouseWheelMoved(MapMouseWheelEvent e) This method may be overridden by subclasses
protected void	onMouseDoubleClicked(MapMouseEvent e) Called when a double clicked event occurs.
protected void	onMouseDragged(MapMouseEvent e) Called when a mouse dragged event occurs.
protected void	onMouseEntered(MapMouseEvent e) Called when a entered event occurs.
protected void	onMouseExited(MapMouseEvent e) Called when a exited event occurs.
protected void	onMouseHovered(MapMouseEvent e) Called when a hovered event occurs.
protected void	onMouseMoved(MapMouseEvent e) Called when a moved event occurs.
protected void	onMousePressed(MapMouseEvent e) Called when a mouse pressed event occurs.
protected void	onMouseReleased(MapMouseEvent e) Called when a mouse released event occurs.
protected void	onMouseWheelMoved(MapMouseWheelEvent e) Called when a mouse wheel moved event occurs.

Methods inherited from class net.refractions.udig.project.ui.tool.AbstractModalTool

getCursorID, isActive, setActive, setContext, setCursorID, setEnabled

Methods inherited from class net.refractions.udig.project.ui.tool.AbstractTool

addListener, deregisterMouseListeners, dispose, fireEvent, getContext, getProperty, getSelectionProvider, init, isEnabled, isNotifyListeners, registerMouseListeners, removeListener, setNotifyListeners, setProperty, setSelectionProvider

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.refractions.udig.project.ui.tool.ModalTool

getSelectionProvider, setSelectionProvider

Methods inherited from interface net.refractions.udig.project.ui.tool.Tool

addListener, dispose, getContext, getProperty, isEnabled, removeListener, setProperty

Constructor Detail

SimpleTool

public SimpleTool()

By default SimpleTool will simply respond to MOUSE.

To respond to additional stimulus please override your constuctor to call SimpleTool( targets ):

 public class MyTool extends SimpleTool {
      public MyTool(){ // default constructor called by extention point
          super( MOUSE | WHEEL );
      }
      ...
 }
 

SimpleTool

public SimpleTool(int targets)

See Also:

AbstractModalTool.AbstractModalTool(int)

Method Detail

onMouseDoubleClicked

protected void onMouseDoubleClicked(MapMouseEvent e)

Called when a double clicked event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMousePressed

protected void onMousePressed(MapMouseEvent e)

Called when a mouse pressed event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMouseReleased

protected void onMouseReleased(MapMouseEvent e)

Called when a mouse released event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMouseEntered

protected void onMouseEntered(MapMouseEvent e)

Called when a entered event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMouseMoved

protected void onMouseMoved(MapMouseEvent e)

Called when a moved event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMouseHovered

protected void onMouseHovered(MapMouseEvent e)

Called when a hovered event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMouseExited

protected void onMouseExited(MapMouseEvent e)

Called when a exited event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMouseWheelMoved

protected void onMouseWheelMoved(MapMouseWheelEvent e)

Called when a mouse wheel moved event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

onMouseDragged

protected void onMouseDragged(MapMouseEvent e)

Called when a mouse dragged event occurs. It will never be a context-menu request

Parameters:

e - the mouse event

mousePressed

public final void mousePressed(MapMouseEvent e)

Opens the context menu if the second mouse button is pressed and calls noContextMouseReleased().

Specified by:

mousePressed in interface MapMouseListener

Overrides:

mousePressed in class AbstractTool

Parameters:

e - the mouse event

See Also:

AbstractTool.mousePressed(MapMouseEvent), MapMouseEvent

mouseReleased

public final void mouseReleased(MapMouseEvent e)

Consumes the event if the second mouse button is released and calls noContextMousePressed().

Specified by:

mouseReleased in interface MapMouseListener

Overrides:

mouseReleased in class AbstractTool

Parameters:

e - the event data.

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseReleased(net.refractions.udig.project.render.displayAdapter.MapMouseEvent), MapMouseEvent

mouseDoubleClicked

public final void mouseDoubleClicked(MapMouseEvent e)

Consumes the event if the second mouse button is doubleclicked and calls onContextMouseDoubleClicked().

Specified by:

mouseDoubleClicked in interface MapMouseListener

Overrides:

mouseDoubleClicked in class AbstractTool

Parameters:

e - the event data.

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseDoubleClicked(net.refractions.udig.project.render.displayAdapter.MapMouseEvent), MapMouseEvent

mouseDragged

public final void mouseDragged(MapMouseEvent e)

Description copied from class: AbstractTool

This method may be overridden by subclasses

Specified by:

mouseDragged in interface MapMouseMotionListener

Overrides:

mouseDragged in class AbstractTool

Parameters:

e - The event data.

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseDragged(net.refractions.udig.project.render.displayAdapter.MapMouseEvent), MapMouseEvent

mouseEntered

public final void mouseEntered(MapMouseEvent e)

Description copied from class: AbstractTool

This method may be overridden by subclasses

Specified by:

mouseEntered in interface MapMouseListener

Overrides:

mouseEntered in class AbstractTool

Parameters:

e - the event data.

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseEntered(net.refractions.udig.project.render.displayAdapter.MapMouseEvent), MapMouseEvent

mouseMoved

public final void mouseMoved(MapMouseEvent e)

Description copied from class: AbstractTool

This method may be overridden by subclasses

Specified by:

mouseMoved in interface MapMouseMotionListener

Overrides:

mouseMoved in class AbstractTool

Parameters:

e - The event data.

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseMoved(net.refractions.udig.project.render.displayAdapter.MapMouseEvent), MapMouseEvent

mouseHovered

public final void mouseHovered(MapMouseEvent e)

Description copied from class: AbstractTool

This method may be overridden by subclasses

Specified by:

mouseHovered in interface MapMouseMotionListener

Overrides:

mouseHovered in class AbstractTool

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseMoved(net.refractions.udig.project.render.displayAdapter.MapMouseEvent), MapMouseEvent

mouseExited

public final void mouseExited(MapMouseEvent e)

Description copied from class: AbstractTool

This method may be overridden by subclasses

Specified by:

mouseExited in interface MapMouseListener

Overrides:

mouseExited in class AbstractTool

Parameters:

e - the event data.

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseExited(net.refractions.udig.project.render.displayAdapter.MapMouseEvent)

mouseWheelMoved

public final void mouseWheelMoved(MapMouseWheelEvent e)

Description copied from class: AbstractTool

This method may be overridden by subclasses

Specified by:

mouseWheelMoved in interface MapMouseWheelListener

Overrides:

mouseWheelMoved in class AbstractTool

Parameters:

e - The mouse wheel event.

See Also:

net.refractions.udig.project.ui.tool.AbstractTool#mouseWheelMoved(net.refractions.udig.project.render.displayAdapter.MapMouseWheelEvent), MapMouseEvent