com.esri.arcgis.editor
Interface ITraverseWindowEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

ITraverseWindowEventsAdapter, ITraverseWindowEventsProxy

public interface ITraverseWindowEvents
extends EventListener, Serializable

Provides access to Traverse Window events. Implement it to listen to specific events that occur when the Traverse Window is used.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	onActivate(ITraverseWindowEventsOnActivateEvent theEvent) Called when the Traverse Window dialog is activated.
void	onAddCourse(ITraverseWindowEventsOnAddCourseEvent theEvent) Called after the course is added.
void	onChangeCourseType(ITraverseWindowEventsOnChangeCourseTypeEvent theEvent) Called when the course type changes.
void	onChangeCurveDirectionType(ITraverseWindowEventsOnChangeCurveDirectionTypeEvent theEvent) Called when the curve direction type changes.
void	onChangeCurveParameter(ITraverseWindowEventsOnChangeCurveParameterEvent theEvent) Called when a curve parameter is changed for either the tangent curve or curve course.
void	onChangeTurnDirection(ITraverseWindowEventsOnChangeTurnDirectionEvent theEvent) Called when the turn direction is changed.
void	onDeactivate(ITraverseWindowEventsOnDeactivateEvent theEvent) Called when the Traverse Window dialog is deactivated.
void	onLoadTraverse(ITraverseWindowEventsOnLoadTraverseEvent theEvent) Called when a traverse is added from a text file.
void	onPositionChanged(ITraverseWindowEventsOnPositionChangedEvent theEvent) Called when the position of the Traverse Window dialog changes.
void	onSetFinishPoint(ITraverseWindowEventsOnSetFinishPointEvent theEvent) Called when the finish point of the traverse is set.
void	onSetFocusToMeasure(ITraverseWindowEventsOnSetFocusToMeasureEvent theEvent) Called when the focus is set to one of the measure text controls.
void	onSetStartPoint(ITraverseWindowEventsOnSetStartPointEvent theEvent) Called when the start point of the traverse is set.

Method Detail

onChangeCourseType

void onChangeCourseType(ITraverseWindowEventsOnChangeCourseTypeEvent theEvent)
                        throws IOException,
                               AutomationException

Called when the course type changes.

Remarks

Whenever the course type is changed, in the Traverse dialog or with the ITraverseWindow::Type property, the OnChangeCourse event is fired.

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.

onSetFocusToMeasure

void onSetFocusToMeasure(ITraverseWindowEventsOnSetFocusToMeasureEvent theEvent)
                         throws IOException,
                                AutomationException

Called when the focus is set to one of the measure text controls.

Remarks

When a Measure control received focus, the OnSetFocusToMeasure event is fired. The index specifies which control received focus.

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.

onChangeCurveParameter

void onChangeCurveParameter(ITraverseWindowEventsOnChangeCurveParameterEvent theEvent)
                            throws IOException,
                                   AutomationException

Called when a curve parameter is changed for either the tangent curve or curve course.

Remarks

Whenever the value for a curve parameter changes, the OnChangeCurveParameter event is fired. The index specifies which control the change occurred within.

This event only makes sense when the course type is esriCTCurve or esriCTTangentCurve.

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.

onChangeTurnDirection

void onChangeTurnDirection(ITraverseWindowEventsOnChangeTurnDirectionEvent theEvent)
                           throws IOException,
                                  AutomationException

Called when the turn direction is changed.

Remarks

Whenever the value for the turn direction of a curve changes, the OnChangeTurnDirection event is fired.

This event only makes sense when the course type is esriCTCurve or esriCTTangentCurve.

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.

onChangeCurveDirectionType

void onChangeCurveDirectionType(ITraverseWindowEventsOnChangeCurveDirectionTypeEvent theEvent)
                                throws IOException,
                                       AutomationException

Called when the curve direction type changes.

Remarks

Whenever the value specifying the direction of a curve changes, the OnChangeCurveDirectionType event is fired.

This event only makes sense when the course type is esriCTCurve.

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.

onAddCourse

void onAddCourse(ITraverseWindowEventsOnAddCourseEvent theEvent)
                 throws IOException,
                        AutomationException

Called after the course is added.

Remarks

OnAddCourse is fired whenever a course is added to the traverse using the Add button on the Traverse dialog.

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.

onLoadTraverse

void onLoadTraverse(ITraverseWindowEventsOnLoadTraverseEvent theEvent)
                    throws IOException,
                           AutomationException

Called when a traverse is added from a text file.

Remarks

Whenever a traverse is loaded using the context menu on the Traverse dialog, the OnLoadTraverse event is fired.

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.

onSetStartPoint

void onSetStartPoint(ITraverseWindowEventsOnSetStartPointEvent theEvent)
                     throws IOException,
                            AutomationException

Called when the start point of the traverse is set.

Remarks

Whenever the start point for the traverse changes, the OnSetStartPoint event is fired.

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.

onSetFinishPoint

void onSetFinishPoint(ITraverseWindowEventsOnSetFinishPointEvent theEvent)
                      throws IOException,
                             AutomationException

Called when the finish point of the traverse is set.

Remarks

Whenever the finish point changes, the OnSetFinishPoint event is fired.

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.

onActivate

void onActivate(ITraverseWindowEventsOnActivateEvent theEvent)
                throws IOException,
                       AutomationException

Called when the Traverse Window dialog is activated.

Remarks

OnActivate is fired whenever the TraverseWindow receives focus.

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.

onDeactivate

void onDeactivate(ITraverseWindowEventsOnDeactivateEvent theEvent)
                  throws IOException,
                         AutomationException

Called when the Traverse Window dialog is deactivated.

Remarks

OnDeactivate is fired whenever the TraverseWindow loses focus.

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.

onPositionChanged

void onPositionChanged(ITraverseWindowEventsOnPositionChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Called when the position of the Traverse Window dialog changes.

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.