com.esri.arcgis.controls
Interface IEngineEditProperties

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
EngineEditor, IEngineEditPropertiesProxy

public interface IEngineEditProperties
extends java.io.Serializable

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

Description: 'Provides access to members that control the properties of an edit session.' 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 IID74ff9f4f_b6f3_4165_9543_b57908e153c5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getReportPrecision()
          Controls the number of decimal places the editor reports numbers with.
 IMarkerSymbol getSelectedVertexSymbol()
          Symbol used to draw the active vertex of the edit sketch.
 ILineSymbol getSketchSymbol()
          Symbol used to draw the lines of the edit sketch.
 IMarkerSymbol getSketchVertexSymbol()
          Symbol used to draw the vertices of the edit sketch.
 IMarkerSymbol getSnapSymbol()
          Symbol used to draw the snap location.
 int getStreamGroupingCount()
          Controls the number of points to group together when streaming.
 double getStreamTolerance()
          Controls the streaming tolerance, measured in map units.
 ILayer getTargetLayer()
          The editor's target layer.
 boolean isAutoSaveOnVersionRedefined()
          Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
 boolean isStretchGeometry()
          Indicates if the edit sketch is stretched when one of its vertices is moved.
 void setAutoSaveOnVersionRedefined(boolean stretch)
          Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
 void setReportPrecision(int numDecs)
          Controls the number of decimal places the editor reports numbers with.
 void setSelectedVertexSymbolByRef(IMarkerSymbol symbol)
          Symbol used to draw the active vertex of the edit sketch.
 void setSketchSymbolByRef(ILineSymbol symbol)
          Symbol used to draw the lines of the edit sketch.
 void setSketchVertexSymbolByRef(IMarkerSymbol symbol)
          Symbol used to draw the vertices of the edit sketch.
 void setSnapSymbolByRef(IMarkerSymbol symbol)
          Symbol used to draw the snap location.
 void setStreamGroupingCount(int tol)
          Controls the number of points to group together when streaming.
 void setStreamTolerance(double tol)
          Controls the streaming tolerance, measured in map units.
 void setStretchGeometry(boolean stretch)
          Indicates if the edit sketch is stretched when one of its vertices is moved.
 

Field Detail

IID74ff9f4f_b6f3_4165_9543_b57908e153c5

static final int IID74ff9f4f_b6f3_4165_9543_b57908e153c5
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

getReportPrecision

int getReportPrecision()
                       throws java.io.IOException,
                              AutomationException
Controls the number of decimal places the editor reports numbers with.

Returns:
The numDecs
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReportPrecision

void setReportPrecision(int numDecs)
                        throws java.io.IOException,
                               AutomationException
Controls the number of decimal places the editor reports numbers with.

Parameters:
numDecs - The numDecs (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStreamTolerance

double getStreamTolerance()
                          throws java.io.IOException,
                                 AutomationException
Controls the streaming tolerance, measured in map units.

Returns:
The tol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStreamTolerance

void setStreamTolerance(double tol)
                        throws java.io.IOException,
                               AutomationException
Controls the streaming tolerance, measured in map units.

Parameters:
tol - The tol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStreamGroupingCount

int getStreamGroupingCount()
                           throws java.io.IOException,
                                  AutomationException
Controls the number of points to group together when streaming.

Returns:
The tol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStreamGroupingCount

void setStreamGroupingCount(int tol)
                            throws java.io.IOException,
                                   AutomationException
Controls the number of points to group together when streaming.

Parameters:
tol - The tol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStretchGeometry

boolean isStretchGeometry()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the edit sketch is stretched when one of its vertices is moved.

Returns:
The stretch
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchGeometry

void setStretchGeometry(boolean stretch)
                        throws java.io.IOException,
                               AutomationException
Indicates if the edit sketch is stretched when one of its vertices is moved.

Parameters:
stretch - The stretch (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSketchSymbol

ILineSymbol getSketchSymbol()
                            throws java.io.IOException,
                                   AutomationException
Symbol used to draw the lines of the edit sketch.

Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSketchSymbolByRef

void setSketchSymbolByRef(ILineSymbol symbol)
                          throws java.io.IOException,
                                 AutomationException
Symbol used to draw the lines of the edit sketch.

Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSketchVertexSymbol

IMarkerSymbol getSketchVertexSymbol()
                                    throws java.io.IOException,
                                           AutomationException
Symbol used to draw the vertices of the edit sketch.

Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSketchVertexSymbolByRef

void setSketchVertexSymbolByRef(IMarkerSymbol symbol)
                                throws java.io.IOException,
                                       AutomationException
Symbol used to draw the vertices of the edit sketch.

Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedVertexSymbol

IMarkerSymbol getSelectedVertexSymbol()
                                      throws java.io.IOException,
                                             AutomationException
Symbol used to draw the active vertex of the edit sketch.

Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectedVertexSymbolByRef

void setSelectedVertexSymbolByRef(IMarkerSymbol symbol)
                                  throws java.io.IOException,
                                         AutomationException
Symbol used to draw the active vertex of the edit sketch.

Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSnapSymbol

IMarkerSymbol getSnapSymbol()
                            throws java.io.IOException,
                                   AutomationException
Symbol used to draw the snap location.

Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSnapSymbolByRef

void setSnapSymbolByRef(IMarkerSymbol symbol)
                        throws java.io.IOException,
                               AutomationException
Symbol used to draw the snap location.

Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoSaveOnVersionRedefined

boolean isAutoSaveOnVersionRedefined()
                                     throws java.io.IOException,
                                            AutomationException
Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.

Returns:
The stretch
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoSaveOnVersionRedefined

void setAutoSaveOnVersionRedefined(boolean stretch)
                                   throws java.io.IOException,
                                          AutomationException
Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.

Parameters:
stretch - The stretch (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTargetLayer

ILayer getTargetLayer()
                      throws java.io.IOException,
                             AutomationException
The editor's target layer.

Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.