com.esri.arcgis.controls
Interface IEngineEditSketch

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EngineEditor, IEngineEditSketchProxy

public interface IEngineEditSketch
extends java.io.Serializable

COM Interface 'IEngineEditSketch'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that manage the edit sketch.' 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	IIDa741844a_9abf_456e_b7c6_94b3c75fcb5f
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addPoint(IPoint point, boolean allowUndo) Adds a point to the edit sketch.
void	finishSketch() Completes the current edit sketch.
void	finishSketchPart() Completes a part for the current edit sketch.
double	getCurrentZ() Current Z value for the edit sketch.
IPoint	getEditLocation() A point that can be used by any custom editing commands.
IGeometry	getGeometry() Geometry stored in the edit sketch.
int	getGeometryType() Type of the geometry stored in the edit sketch.
IPoint	getLastPoint() The last point in the edit sketch.
int	getPart() The index of the current part of the sketch.
int	getSegment() The index of the current segment of the sketch.
int	getVertex() The index of the current vertex of the sketch.
boolean	isZAware() Indicates whether the edit sketch geometry can contain Zs.
void	modifySketch() Notifies listeners that the sketch has been changed.
void	refreshSketch() Invalidates the portion of the display that is occupied by the sketch.
void	setCurrentZ(double z) Current Z value for the edit sketch.
void	setEditLocation(int x, int y) Sets the part, segment and vertex of the edit sketch at the x,y location.
void	setGeometryByRef(IGeometry geometry) Geometry stored in the edit sketch.
void	setGeometryType(int geomType) Type of the geometry stored in the edit sketch.
void	setZAware(boolean aware) Indicates whether the edit sketch geometry can contain Zs.
void	vertexAdded(IPoint point) Notifies listeners that a vertex has been added to the sketch.
void	vertexDeleted(IPoint point) Notifies listeners that a vertex has been deleted from the sketch.
void	vertexMoved(IPoint point) Notifies listeners that a vertex has been moved in the sketch.

Field Detail

IIDa741844a_9abf_456e_b7c6_94b3c75fcb5f

static final int IIDa741844a_9abf_456e_b7c6_94b3c75fcb5f

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

getGeometryType

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

Type of the geometry stored in the edit sketch.

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryType

void setGeometryType(int geomType)
                     throws java.io.IOException,
                            AutomationException

Type of the geometry stored in the edit sketch.

Parameters:

geomType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

Geometry stored in the edit sketch.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

void setGeometryByRef(IGeometry geometry)
                      throws java.io.IOException,
                             AutomationException

Geometry stored in the edit sketch.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEditLocation

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

A point that can be used by any custom editing commands. This property is set by the SetEditLocation method.

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.

getPart

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

The index of the current part of the sketch.

Returns:

The part

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSegment

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

The index of the current segment of the sketch.

Returns:

The segment

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVertex

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

The index of the current vertex of the sketch.

Returns:

The vertex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addPoint

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

Adds a point to the edit sketch. If allowUndo is true, a new operation will be created.

Parameters:

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

allowUndo - The allowUndo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshSketch

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

Invalidates the portion of the display that is occupied by the sketch.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

finishSketch

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

Completes the current edit sketch.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

finishSketchPart

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

Completes a part for the current edit sketch.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastPoint

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

The last point in the edit 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.

modifySketch

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

Notifies listeners that the sketch has been changed.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

vertexAdded

void vertexAdded(IPoint point)
                 throws java.io.IOException,
                        AutomationException

Notifies listeners that a vertex has been added to the sketch.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

vertexDeleted

void vertexDeleted(IPoint point)
                   throws java.io.IOException,
                          AutomationException

Notifies listeners that a vertex has been deleted from the sketch.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

vertexMoved

void vertexMoved(IPoint point)
                 throws java.io.IOException,
                        AutomationException

Notifies listeners that a vertex has been moved in the sketch.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditLocation

void setEditLocation(int x,
                     int y)
                     throws java.io.IOException,
                            AutomationException

Sets the part, segment and vertex of the edit sketch at the x,y location.

Parameters:

x - The x (in)

y - The y (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isZAware

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

Indicates whether the edit sketch geometry can contain Zs.

Returns:

The aware

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZAware

void setZAware(boolean aware)
               throws java.io.IOException,
                      AutomationException

Indicates whether the edit sketch geometry can contain Zs.

Parameters:

aware - The aware (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentZ

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

Current Z value for the edit sketch.

Returns:

The z

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentZ

void setCurrentZ(double z)
                 throws java.io.IOException,
                        AutomationException

Current Z value for the edit sketch.

Parameters:

z - The z (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.