com.esri.arcgis.editor
Interface ITraverseWindow

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ITraverseWindowProxy, TraverseWindow

public interface ITraverseWindow
extends java.io.Serializable

COM Interface 'ITraverseWindow'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to members that interact with the Traverse Window dialog.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID3fba17c0_f4ae_406e_b028_1c96d9f789c5
static int	xxDummy Deprecated. Internal use only

Method Summary

void	add() Add the course that is defined by the current course parameters.
ICourse	getCourse(int index) A reference to the ith course.
int	getCourseCount() The number of courses in the traverse.
int	getCourseType() The type of the course being added.
int	getCurveDirectionType() If the course type is esriCTCurve, defines the direction type of the curve.
int	getCurveParameter(int index) If the course type is esriCTCurve or esriCTTangentCurve, describes the type of curve paramater that the ith measure text represents.
IPoint	getFinishPoint() The specified end point of the traverse.
int	getMeasureHWND(int index) The handle of the ith measure text control.
java.lang.String	getMeasureText(int index) The ith value that defines the course to add.
IPoint	getStartPoint() The specified start point of the traverse.
int	getTurnDirection() If the course type is esriCTCurve or esriCTTangentCurve, indicates if the curve turns to the left or right.
boolean	isAddEnabled() Indicates if the Add command on the Traverse Window dialog is enabled.
boolean	isMeasureSelected(int index) Indicates if the text in the ith measure is selected.
boolean	isVisible() Indicates if Traverse Window is visible.
void	setCourseType(int type) The type of the course being added.
void	setCurveDirectionType(int direction) If the course type is esriCTCurve, defines the direction type of the curve.
void	setCurveParameter(int index, int curveParam) If the course type is esriCTCurve or esriCTTangentCurve, describes the type of curve paramater that the ith measure text represents.
void	setFocusToMeasure(int index) Change the focus to the ith measure text control.
void	setMeasureSelected(int index, boolean sel) Indicates if the text in the ith measure is selected.
void	setMeasureText(int index, java.lang.String text) The ith value that defines the course to add.
void	setTurnDirection(int direction) If the course type is esriCTCurve or esriCTTangentCurve, indicates if the curve turns to the left or right.
void	setVisible(boolean vis) Indicates if Traverse Window is visible.

Field Detail

IID3fba17c0_f4ae_406e_b028_1c96d9f789c5

static final int IID3fba17c0_f4ae_406e_b028_1c96d9f789c5

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setVisible

void setVisible(boolean vis)
                throws java.io.IOException,
                       AutomationException

Indicates if Traverse Window is visible.

Parameters:

vis - The vis (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if Traverse Window is visible.

Returns:

The vis

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartPoint

IPoint getStartPoint()
                     throws java.io.IOException,
                            AutomationException

The specified start point of the traverse.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFinishPoint

IPoint getFinishPoint()
                      throws java.io.IOException,
                             AutomationException

The specified end point of the traverse.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCourseCount

int getCourseCount()
                   throws java.io.IOException,
                          AutomationException

The number of courses in the traverse.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCourse

ICourse getCourse(int index)
                  throws java.io.IOException,
                         AutomationException

A reference to the ith course.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.editor.ICourse

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCourseType

int getCourseType()
                  throws java.io.IOException,
                         AutomationException

The type of the course being added.

Returns:

A com.esri.arcgis.editor.esriCourseType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCourseType

void setCourseType(int type)
                   throws java.io.IOException,
                          AutomationException

The type of the course being added.

Parameters:

type - A com.esri.arcgis.editor.esriCourseType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMeasureSelected

boolean isMeasureSelected(int index)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the text in the ith measure is selected.

Parameters:

index - The index (in)

Returns:

The sel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeasureSelected

void setMeasureSelected(int index,
                        boolean sel)
                        throws java.io.IOException,
                               AutomationException

Indicates if the text in the ith measure is selected.

Parameters:

index - The index (in)

sel - The sel (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasureText

java.lang.String getMeasureText(int index)
                                throws java.io.IOException,
                                       AutomationException

The ith value that defines the course to add.

Parameters:

index - The index (in)

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMeasureText

void setMeasureText(int index,
                    java.lang.String text)
                    throws java.io.IOException,
                           AutomationException

The ith value that defines the course to add.

Parameters:

index - The index (in)

text - The text (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasureHWND

int getMeasureHWND(int index)
                   throws java.io.IOException,
                          AutomationException

The handle of the ith measure text control.

Parameters:

index - The index (in)

Returns:

The hWND (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurveParameter

int getCurveParameter(int index)
                      throws java.io.IOException,
                             AutomationException

If the course type is esriCTCurve or esriCTTangentCurve, describes the type of curve paramater that the ith measure text represents.

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.editor.esriCurveParameter constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurveParameter

void setCurveParameter(int index,
                       int curveParam)
                       throws java.io.IOException,
                              AutomationException

If the course type is esriCTCurve or esriCTTangentCurve, describes the type of curve paramater that the ith measure text represents.

Parameters:

index - The index (in)

curveParam - A com.esri.arcgis.editor.esriCurveParameter constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTurnDirection

int getTurnDirection()
                     throws java.io.IOException,
                            AutomationException

If the course type is esriCTCurve or esriCTTangentCurve, indicates if the curve turns to the left or right.

Returns:

A com.esri.arcgis.editor.esriTurnDirection constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTurnDirection

void setTurnDirection(int direction)
                      throws java.io.IOException,
                             AutomationException

If the course type is esriCTCurve or esriCTTangentCurve, indicates if the curve turns to the left or right.

Parameters:

direction - A com.esri.arcgis.editor.esriTurnDirection constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurveDirectionType

int getCurveDirectionType()
                          throws java.io.IOException,
                                 AutomationException

If the course type is esriCTCurve, defines the direction type of the curve.

Returns:

A com.esri.arcgis.editor.esriCurveDirectionType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurveDirectionType

void setCurveDirectionType(int direction)
                           throws java.io.IOException,
                                  AutomationException

If the course type is esriCTCurve, defines the direction type of the curve.

Parameters:

direction - A com.esri.arcgis.editor.esriCurveDirectionType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddEnabled

boolean isAddEnabled()
                     throws java.io.IOException,
                            AutomationException

Indicates if the Add command on the Traverse Window dialog is enabled.

Returns:

The enabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add()
         throws java.io.IOException,
                AutomationException

Add the course that is defined by the current course parameters.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFocusToMeasure

void setFocusToMeasure(int index)
                       throws java.io.IOException,
                              AutomationException

Change the focus to the ith measure text control.

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.