com.esri.arcgis.editor
Class IEditEvents2Adapter

java.lang.Object
  extended by com.esri.arcgis.editor.IEditEvents2Adapter
All Implemented Interfaces:
IEditEvents2, Serializable, EventListener

public class IEditEvents2Adapter
extends Object
implements IEditEvents2

See Also:
Serialized Form

Constructor Summary
IEditEvents2Adapter()
           
 
Method Summary
 void beforeStopEditing(IEditEvents2BeforeStopEditingEvent theEvent)
          Fired before StopEditing happens.
 void beforeStopOperation(IEditEvents2BeforeStopOperationEvent theEvent)
          Called before StopOperation is called.
 void onAbort(IEditEvents2OnAbortEvent theEvent)
          Called when AbortOperation is called.
 void onCurrentZChanged(IEditEvents2OnCurrentZChangedEvent theEvent)
          Called when the CurrentZ changes.
 void onSaveEdits(IEditEvents2OnSaveEditsEvent theEvent)
          Called when edits are saved.
 void onStartOperation(IEditEvents2OnStartOperationEvent theEvent)
          Called when StartOperation is called.
 void onStopOperation(IEditEvents2OnStopOperationEvent theEvent)
          Called when StopOperation is called.
 void onVertexAdded(IEditEvents2OnVertexAddedEvent theEvent)
          Called after a point/vertex is added to the sketch.
 void onVertexDeleted(IEditEvents2OnVertexDeletedEvent theEvent)
          Called after a point is deleted from the sketch.
 void onVertexMoved(IEditEvents2OnVertexMovedEvent theEvent)
          Called after a vertex/point has been moved in the sketch.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IEditEvents2Adapter

public IEditEvents2Adapter()
Method Detail

onCurrentZChanged

public void onCurrentZChanged(IEditEvents2OnCurrentZChangedEvent theEvent)
                       throws IOException,
                              AutomationException
Called when the CurrentZ changes.

Remarks

The OnCurrentZChanged event is fired when the value for IEditor::CurrentZ is modified. IEditor::CurrentZ can be altered programmatically or through the Current Z control available under the Editor category in the Customize dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onCurrentZChanged in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onVertexMoved

public void onVertexMoved(IEditEvents2OnVertexMovedEvent theEvent)
                   throws IOException,
                          AutomationException
Called after a vertex/point has been moved in the sketch.

Remarks

OnVertexMoved is fired when the location of a vertex in the edit sketch is modified. If the an edit sketch vertex is modified programmatically, call IEditSketch2::VertexMoved to ensure all clients listening for this event are notified.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onVertexMoved in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onVertexAdded

public void onVertexAdded(IEditEvents2OnVertexAddedEvent theEvent)
                   throws IOException,
                          AutomationException
Called after a point/vertex is added to the sketch.

Remarks

When IEditSketch2::VertexAdded is called, all clients listening to IEditEvents2::OnVertexAdded are notified. This may be used to ensure the maximum number of points in a particular sketch is not exceeded, or if vertex attributes need to be set on each vertex when it is added to the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onVertexAdded in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onVertexDeleted

public void onVertexDeleted(IEditEvents2OnVertexDeletedEvent theEvent)
                     throws IOException,
                            AutomationException
Called after a point is deleted from the sketch.

Remarks

When IEditSketch2::VertexDeleted is called, all clients listening to IEditEvents2::OnVertexDeleted are notified.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onVertexDeleted in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beforeStopEditing

public void beforeStopEditing(IEditEvents2BeforeStopEditingEvent theEvent)
                       throws IOException,
                              AutomationException
Fired before StopEditing happens.

Remarks

The BeforeStopEditing event is called before edits are committed or discarded. Use this event to perform any processing of the features before the edits are committed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
beforeStopEditing in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onAbort

public void onAbort(IEditEvents2OnAbortEvent theEvent)
             throws IOException,
                    AutomationException
Called when AbortOperation is called.

Remarks

OnAbort is called whenever an edit operation is aborted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onAbort in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onStartOperation

public void onStartOperation(IEditEvents2OnStartOperationEvent theEvent)
                      throws IOException,
                             AutomationException
Called when StartOperation is called.

Remarks

OnStartOperation is raised when IEditor::StartOperation is called. The OnStartOperation event is not fired for SketchOperations.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onStartOperation in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beforeStopOperation

public void beforeStopOperation(IEditEvents2BeforeStopOperationEvent theEvent)
                         throws IOException,
                                AutomationException
Called before StopOperation is called.

Remarks

BeforeStopOperation is called before the operation is finished (when the sketch is discarded). Use this event to manipulate the sketch geometry before it is committed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
beforeStopOperation in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onStopOperation

public void onStopOperation(IEditEvents2OnStopOperationEvent theEvent)
                     throws IOException,
                            AutomationException
Called when StopOperation is called.

Remarks

OnStopOperation is called when the operation is successfully completed. At this point the feature has been created but the edit sketch is still available.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onStopOperation in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onSaveEdits

public void onSaveEdits(IEditEvents2OnSaveEditsEvent theEvent)
                 throws IOException,
                        AutomationException
Called when edits are saved.

Remarks

The OnSaveEdits event is fired whenever a user issues the Save Edits command in the Editor. This event is not raised when a user stops an edit session and chooses to save edits, or if IEditor::StopEditing is called.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
onSaveEdits in interface IEditEvents2
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.