com.esri.arcgis.editor
Interface IEditToolEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

IEditToolEventsAdapter, IEditToolEventsProxy

public interface IEditToolEvents
extends EventListener, Serializable

Provides access to events generated by the edit tool.

Remarks

These events are only broadcast if the user is moving the tool around the map with the left mouse button depressed.

When To Use

Wire up this event interface if you are interested in tracking the outbound events triggered by the interaction of the Edit Tool over the map.

Product Availability

Available with ArcGIS Desktop.

See Also:

ISnapEnvironment, IEditProperties, IEditTask.activate(com.esri.arcgis.editor.IEditor, com.esri.arcgis.editor.IEditTask), IEditor, IEditLayers, IEditTask.deactivate(), IEditAttributeProperties, IEditEvents2, IEditTask.onFinishSketch(), IDatasetEdit, IDatasetEditInfo, IEditTask.onDeleteSketch(), IEditTask.getName(), IEditEvents, Editor, IEditSketch

Method Summary

void	onBeginMove(IEditToolEventsOnBeginMoveEvent theEvent) Called when the mouse button is first depressed.
void	onFinishMove(IEditToolEventsOnFinishMoveEvent theEvent) Called when the left mouse button is released.
void	onMove(IEditToolEventsOnMoveEvent theEvent) Called when mouse moves while left mouse button is depressed.

Method Detail

onBeginMove

void onBeginMove(IEditToolEventsOnBeginMoveEvent theEvent)
                 throws IOException,
                        AutomationException

Called when the mouse button is first depressed.

Remarks

This event is fired in conjuction with the Edit Tool.

In order for this event to fire, the user must 1) have the Edit Tool set as the active tool, 2) have the left mouse button depressed, 3) have one or more features selected and 4) start to move over the map.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISnapEnvironment, IEditProperties, IEditTask.activate(com.esri.arcgis.editor.IEditor, com.esri.arcgis.editor.IEditTask), IEditor, IEditLayers, IEditTask.deactivate(), IEditAttributeProperties, IEditEvents2, IEditTask.onFinishSketch(), IDatasetEdit, IDatasetEditInfo, IEditTask.onDeleteSketch(), IEditTask.getName(), IEditEvents, Editor, IEditSketch

onMove

void onMove(IEditToolEventsOnMoveEvent theEvent)
            throws IOException,
                   AutomationException

Called when mouse moves while left mouse button is depressed.

Remarks

This event is fired in conjuction with the Edit Tool.

In order for this event to fire, the user must 1) have the Edit Tool set as the active tool, 2) have the left mouse button depressed, 3) have at least one feature selected, and 4) be moving over the map.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISnapEnvironment, IEditProperties, IEditTask.activate(com.esri.arcgis.editor.IEditor, com.esri.arcgis.editor.IEditTask), IEditor, IEditLayers, IEditTask.deactivate(), IEditAttributeProperties, IEditEvents2, IEditTask.onFinishSketch(), IDatasetEdit, IDatasetEditInfo, IEditTask.onDeleteSketch(), IEditTask.getName(), IEditEvents, Editor, IEditSketch

onFinishMove

void onFinishMove(IEditToolEventsOnFinishMoveEvent theEvent)
                  throws IOException,
                         AutomationException

Called when the left mouse button is released.

Remarks

This event is fired in conjuction with the Edit Tool.

In order for this event to fire, the user must 1) have the Edit Tool set as the active tool, 2) have at least one feature selected, and 3) release the left mouse button after having been moving around the map.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISnapEnvironment, IEditProperties, IEditTask.activate(com.esri.arcgis.editor.IEditor, com.esri.arcgis.editor.IEditTask), IEditor, IEditLayers, IEditTask.deactivate(), IEditAttributeProperties, IEditEvents2, IEditTask.onFinishSketch(), IDatasetEdit, IDatasetEditInfo, IEditTask.onDeleteSketch(), IEditTask.getName(), IEditEvents, Editor, IEditSketch