Package oracle.spatial.network.nfe.vis.mapcanvas.tool

Class NFETool

java.lang.Object

oracle.spatial.network.nfe.vis.maps.layer.BasicLayer

oracle.spatial.network.nfe.vis.maps.tools.BasicTool

oracle.spatial.network.nfe.vis.mapcanvas.tool.NFETool

All Implemented Interfaces:

Layer, Tool, PropertySupport

Direct Known Subclasses:

NFEAddFeatureElementTool, NFEAddFeatureTool, NFEEditVertexTool, NFEManipulateTool, NFESelectionTool

public class NFETool
extends BasicTool

The basic class every NFE tool should implement. It provides common methods for NFE-related tasks.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.awt.Cursor	invalidStateCursor
protected java.awt.Cursor	readyStateCursor

Fields inherited from class oracle.spatial.network.nfe.vis.maps.layer.BasicLayer

canvas, properties

Fields inherited from interface oracle.spatial.network.nfe.vis.maps.core.Layer

PROPERTY_NAME, PROPERTY_PROVIDERID, PROPERTY_SRID, PROPERTY_VISIBLE

Constructor Summary

Constructors

Constructor	Description
NFETool(MapCanvas canvas, NFEModel model)

Method Summary

Modifier and Type	Method	Description
NFEModel	getModel()	Gets the current model
double	getTolerance()	Gets the tolerance used by the tool
boolean	handleEvent(java.util.EventObject evt)	The main method that performs event handling for this tool.
protected boolean	isAllowedScreenPoint(java.awt.geom.Point2D screenPoint)	Tells whether the screen point is valid according to the model's dimension boundaries
boolean	isEnabled()	Tells whether the tool is enabled or not
protected boolean	keyPressed(java.awt.event.KeyEvent keyEvent)	Called when a key pressed event is registered
protected boolean	keyReleased(java.awt.event.KeyEvent keyEvent)	Called when a key released event is registered
protected boolean	mouseClicked(java.awt.event.MouseEvent evt)	Called when a mouse clicked event is registered
protected boolean	mouseDragged(java.awt.event.MouseEvent evt)	Called when a mouse dragged event is registered
protected boolean	mouseExited(java.awt.event.MouseEvent evt)	Called when a mouse exited event is registered
protected boolean	mouseMoved(java.awt.event.MouseEvent evt)	Called when a mouse moved event is registered
protected boolean	mousePressed(java.awt.event.MouseEvent evt)	Called when a mouse pressed event is registered
protected boolean	mouseReleased(java.awt.event.MouseEvent evt)	Called when a mouse released event is registered
void	setEnabled(boolean enabled)	Sets whether the tool is enabled or not
protected java.awt.geom.Point2D	toDataCRS(java.awt.geom.Point2D screenPoint)	Converts a point in screen's coordinate system to model's coordinate system
protected java.awt.geom.Point2D	toScreenCRS(java.awt.geom.Point2D dataPoint2D)	Converts a point in model's coordinate system to screen's coordinate system

Methods inherited from class oracle.spatial.network.nfe.vis.maps.tools.BasicTool

isInAction

Methods inherited from class oracle.spatial.network.nfe.vis.maps.layer.BasicLayer

added, addPropertyChangeListener, addPropertyChangeListener, clear, fromXMLElement, getCanvas, getDataMBR, getFullExtent, getIcon, getName, getProperties, getProperty, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, getProviderID, getSRID, handleTheEvent, hitTest, hitTest, isMyEvent, isVisible, mapRegionChanged, propagateEvent, removed, removePropertyChangeListener, removePropertyChangeListener, render, repaint, setCanvas, setMyCursor, setName, setProperty, setProviderID, setSRID, setVisible, toXMLElement, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.spatial.network.nfe.vis.maps.core.Layer

added, clear, fromXMLElement, getCanvas, getDataMBR, getFullExtent, getIcon, getName, getProviderID, getSRID, hitTest, hitTest, isVisible, mapRegionChanged, removed, render, repaint, setCanvas, setName, setProviderID, setSRID, setVisible, toXMLElement, update

Methods inherited from interface oracle.spatial.network.nfe.vis.maps.util.PropertySupport

addPropertyChangeListener, addPropertyChangeListener, getProperties, getProperty, getProperty, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener, setProperty

Field Detail

readyStateCursor

protected java.awt.Cursor readyStateCursor

invalidStateCursor

protected java.awt.Cursor invalidStateCursor

Constructor Detail

NFETool

public NFETool(MapCanvas canvas,
               NFEModel model)

Method Detail

getModel

public NFEModel getModel()

Gets the current model

Returns:

an NFE model instance

setEnabled

public void setEnabled(boolean enabled)

Sets whether the tool is enabled or not

Parameters:

enabled - true for enabled

isEnabled

public boolean isEnabled()

Tells whether the tool is enabled or not

Returns:

true for enabled

handleEvent

public boolean handleEvent(java.util.EventObject evt)

Description copied from interface: Layer

The main method that performs event handling for this tool. Returns whether the event should be propagated to other layers down stream (further down the layer stack) after the event has been handled.

Specified by:

handleEvent in interface Layer

Overrides:

handleEvent in class BasicLayer

mouseMoved

protected boolean mouseMoved(java.awt.event.MouseEvent evt)

Called when a mouse moved event is registered

Parameters:

evt - a mouse event event

Returns:

true if the event should be propagated

mouseClicked

protected boolean mouseClicked(java.awt.event.MouseEvent evt)

Called when a mouse clicked event is registered

Parameters:

evt - a mouse event

Returns:

true if the event should be propagated

mousePressed

protected boolean mousePressed(java.awt.event.MouseEvent evt)

Called when a mouse pressed event is registered

Parameters:

evt - a mouse event

Returns:

true if the event should be propagated

mouseDragged

protected boolean mouseDragged(java.awt.event.MouseEvent evt)

Called when a mouse dragged event is registered

Parameters:

evt - a mouse event

Returns:

true if the event should be propagated

mouseReleased

protected boolean mouseReleased(java.awt.event.MouseEvent evt)

Called when a mouse released event is registered

Parameters:

evt - a mouse event

Returns:

true if the event should be propagated

mouseExited

protected boolean mouseExited(java.awt.event.MouseEvent evt)

Called when a mouse exited event is registered

Parameters:

evt - a mouse event

Returns:

true if the event should be propagated

keyReleased

protected boolean keyReleased(java.awt.event.KeyEvent keyEvent)

Called when a key released event is registered

Parameters:

keyEvent - a key event

Returns:

true if the event should be propagated

keyPressed

protected boolean keyPressed(java.awt.event.KeyEvent keyEvent)

Called when a key pressed event is registered

Parameters:

keyEvent - a key event

Returns:

true if the event should be propagated

toScreenCRS

protected java.awt.geom.Point2D toScreenCRS(java.awt.geom.Point2D dataPoint2D)

Converts a point in model's coordinate system to screen's coordinate system

Parameters:

dataPoint2D - a java point in model's coordinate system

Returns:

a java point in screen's coordinate system

toDataCRS

protected java.awt.geom.Point2D toDataCRS(java.awt.geom.Point2D screenPoint)

Converts a point in screen's coordinate system to model's coordinate system

Parameters:

screenPoint - a java point in screen's coordinate system

Returns:

a java point in model's coordinate system

getTolerance

public double getTolerance()

Gets the tolerance used by the tool

Returns:

the tolerance value in model's coordinate system

isAllowedScreenPoint

protected boolean isAllowedScreenPoint(java.awt.geom.Point2D screenPoint)

Tells whether the screen point is valid according to the model's dimension boundaries

Parameters:

screenPoint - a java point in screen's coordinate system

Returns:

true is the point is valid