com.esri.arcgis.editor
Interface ISketchTool

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISketchToolProxy

public interface ISketchTool
extends java.io.Serializable

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

Description: 'Provides access to members that control the main sketch tool.' 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	IID014ee842_a498_11d1_846b_0000f875b9c6
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addPoint(IPoint point, boolean esri_clone, boolean allowUndo) Adds a point to the sketch.
IPoint	getAnchor() The anchor of the sketch.
double	getAngleConstraint() The sketch's angular constraint.
int	getConstraint() The sketch constraint.
double	getDistanceConstraint() The sketch's distance constraint.
IPoint	getLocation() The current location of the mouse.
boolean	isStreaming() Indicates whether stream mode digitizing is enabled.
void	setAngleConstraint(double val) The sketch's angular constraint.
void	setConstraint(int constraint) The sketch constraint.
void	setDistanceConstraint(double val) The sketch's distance constraint.
void	setIsStreaming(boolean isStreaming) Indicates whether stream mode digitizing is enabled.

Field Detail

IID014ee842_a498_11d1_846b_0000f875b9c6

static final int IID014ee842_a498_11d1_846b_0000f875b9c6

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

getAnchor

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

The anchor of the sketch.

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.

getLocation

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

The current location of the mouse.

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.

getConstraint

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

The sketch constraint.

Returns:

A com.esri.arcgis.editor.esriSketchConstraint constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConstraint

void setConstraint(int constraint)
                   throws java.io.IOException,
                          AutomationException

The sketch constraint.

Parameters:

constraint - A com.esri.arcgis.editor.esriSketchConstraint constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAngleConstraint

double getAngleConstraint()
                          throws java.io.IOException,
                                 AutomationException

The sketch's angular constraint.

Returns:

The val

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAngleConstraint

void setAngleConstraint(double val)
                        throws java.io.IOException,
                               AutomationException

The sketch's angular constraint.

Parameters:

val - The val (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDistanceConstraint

double getDistanceConstraint()
                             throws java.io.IOException,
                                    AutomationException

The sketch's distance constraint.

Returns:

The val

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDistanceConstraint

void setDistanceConstraint(double val)
                           throws java.io.IOException,
                                  AutomationException

The sketch's distance constraint.

Parameters:

val - The val (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStreaming

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

Indicates whether stream mode digitizing is enabled.

Returns:

The isStreaming

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsStreaming

void setIsStreaming(boolean isStreaming)
                    throws java.io.IOException,
                           AutomationException

Indicates whether stream mode digitizing is enabled.

Parameters:

isStreaming - The isStreaming (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addPoint

void addPoint(IPoint point,
              boolean esri_clone,
              boolean allowUndo)
              throws java.io.IOException,
                     AutomationException

Adds a point to the sketch.

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

esri_clone - The esri_clone (in)

allowUndo - The allowUndo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.