com.esri.arcgis.controls
Class EngineEditor

java.lang.Object
  com.esri.arcgis.controls.EngineEditor

All Implemented Interfaces:

IConnectionPointContainer, IEngineEditProperties, IEngineEditProperties2, IEngineSnapEnvironment, ISupportErrorInfo, java.io.Serializable

public class EngineEditor

extends java.lang.Object

implements IConnectionPointContainer, IEngineSnapEnvironment, IEngineEditProperties, IEngineEditProperties2, ISupportErrorInfo

A singleton object representing Engine editing environment.

Product Availability

Available with ArcGIS Engine.

Description

The EngineEditor object is a singleton object (only one instance of the EngineEditor object is supported per process) that manages the editing environment for features stored in the ESRI vector geographic datasets: geodatabases and shapefiles. Use the EngineEditor object to control the editing properties, establish a snapping environment and manage snap agents.

See Also:

Serialized Form

Constructor Summary

EngineEditor()
Constructs a EngineEditor using ArcGIS Engine.

EngineEditor(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	addSnapAgent(IEngineSnapAgent snapAgent) Adds a new snap agent to the snap environment.
void	clearSnapAgents() Removes all snap agents.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) Supported Platforms
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) Supported Platforms
double	getAngularCorrectionOffset() Angular Correction Offset.
int	getAngularUnitPrecision() Precision used to display angular units.
IConnectionPointContainer	getAsIConnectionPointContainer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IEngineEditProperties	getAsIEngineEditProperties() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IEngineEditProperties2	getAsIEngineEditProperties2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IEngineSnapEnvironment	getAsIEngineSnapEnvironment() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
int	getDirectionType() Direction Type.
int	getDirectionUnits() Direction Units.
double	getDistanceCorrectionFactor() Distance Correction Factor.
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.
IEngineSnapAgent	getSnapAgent(int index) A snap agent at the given index.
int	getSnapAgentCount() The number of active snap agents.
IMarkerSymbol	getSnapSymbol() Symbol used to draw the snap location.
double	getSnapTolerance() The snap tolerance, measured in pixels or map units.
int	getSnapToleranceUnits() The units used for the snap tolerance.
int	getStickyMoveTolerance() Controls the sticky move tolerance.
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
boolean	isAutoSaveOnVersionRedefined() Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
boolean	isSnapTips() Indicates whether to show the snap tips.
boolean	isStretchGeometry() Indicates if the edit sketch is stretched when one of its vertices is moved.
boolean	isUseGroundToGrid() Indicates whether to use Ground to Grid.
void	removeSnapAgent(int index) Removes the snap agent at the given index.
void	setAngularCorrectionOffset(double angOffset) Angular Correction Offset.
void	setAngularUnitPrecision(int auPrecision) Precision used to display angular units.
void	setAutoSaveOnVersionRedefined(boolean stretch) Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
void	setDirectionType(int dirType) Direction Type.
void	setDirectionUnits(int dirUnits) Direction Units.
void	setDistanceCorrectionFactor(double distFactor) Distance Correction Factor.
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	setSnapTips(boolean tips) Indicates whether to show the snap tips.
void	setSnapTolerance(double tol) The snap tolerance, measured in pixels or map units.
void	setSnapToleranceUnits(int units) The units used for the snap tolerance.
void	setStickyMoveTolerance(int tol) Controls the sticky move tolerance.
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.
void	setUseGroundToGrid(boolean g2g) Indicates whether to use Ground to Grid.
boolean	snapPoint(IPoint point) Attempts to snap the point using the current snap environment.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EngineEditor

public EngineEditor()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a EngineEditor using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EngineEditor

public EngineEditor(java.lang.Object obj)
             throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a EngineEditor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EngineEditor.
EngineEditor theEngineEditor = (EngineEditor) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIConnectionPointContainer

public IConnectionPointContainer getAsIConnectionPointContainer()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIEngineSnapEnvironment

public IEngineSnapEnvironment getAsIEngineSnapEnvironment()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIEngineEditProperties

public IEngineEditProperties getAsIEngineEditProperties()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIEngineEditProperties2

public IEngineEditProperties2 getAsIEngineEditProperties2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IConnectionPointContainer

Supported Platforms

Windows, Solaris, Linux

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

snapPoint

public boolean snapPoint(IPoint point)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IEngineSnapEnvironment

Attempts to snap the point using the current snap environment.

Description

SnapPoint passes the required point parameter to each of the added snap agents in the order that these agents were added. The agents attempt, in turn, to find point coordinates that fulfill its snap properties for the incoming point. If a new snap location is found, the relevant snap agent modifies the original point's coordinates to that of the new location. The same point is then returned to SnapPoint. Once a snap agent is found that satisfies the point subsequent snap agents are not tested.

As an example: there may be several feature snap agents present. Each receives a point from the current cursor location, which is passed to the agent via the SnapPoint method. If the conditions for a snap are met, the boolean value of the agent returns TRUE, the point's coordinates are updated based on the active feature snap conditions and the same point is returned to SnapPoint.

Specified by:

snapPoint in interface IEngineSnapEnvironment

Parameters:

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

Returns:

The snapped

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapToleranceUnits

public int getSnapToleranceUnits()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IEngineSnapEnvironment

The units used for the snap tolerance.

Description

SnapToleranceUnits defines the units used to define the radius used by active snap agents. Bydefault The default SnapToleranceUnits is esriSnapTolerancePixels.

Specified by:

getSnapToleranceUnits in interface IEngineSnapEnvironment

Returns:

A com.esri.arcgis.controls.esriEngineSnapToleranceUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

public void setSnapToleranceUnits(int units)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IEngineSnapEnvironment

The units used for the snap tolerance.

Specified by:

setSnapToleranceUnits in interface IEngineSnapEnvironment

Parameters:

units - A com.esri.arcgis.controls.esriEngineSnapToleranceUnits constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSnapTolerance

public double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEngineSnapEnvironment

The snap tolerance, measured in pixels or map units.

Description

SnapTolerance determines the size of the region bounding the input point location. It is given as a radius, measured in pixels, and the search for a potential snap point candidate is made within this region. By default SnapTolerance is 7.

Specified by:

getSnapTolerance in interface IEngineSnapEnvironment

Returns:

The tol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSnapTolerance

public void setSnapTolerance(double tol)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IEngineSnapEnvironment

The snap tolerance, measured in pixels or map units.

Specified by:

setSnapTolerance in interface IEngineSnapEnvironment

Parameters:

tol - The tol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSnapAgentCount

public int getSnapAgentCount()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IEngineSnapEnvironment

The number of active snap agents.

Description

SnapAgentCount returns the number of currently active snap agents.

Specified by:

getSnapAgentCount in interface IEngineSnapEnvironment

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSnapAgent

public IEngineSnapAgent getSnapAgent(int index)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IEngineSnapEnvironment

A snap agent at the given index.

Description

The snap agent at the specified index.

Specified by:

getSnapAgent in interface IEngineSnapEnvironment

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IEngineSnapAgent

Throws:

AutomationException - If the ArcObject component throws an exception.

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

clearSnapAgents

public void clearSnapAgents()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IEngineSnapEnvironment

Removes all snap agents.

Description

ClearSnapAgents deactivates all snap agents and sets ClearSnapAgents to zero.

Specified by:

clearSnapAgents in interface IEngineSnapEnvironment

Throws:

AutomationException - If the ArcObject component throws an exception.

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

removeSnapAgent

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

Description copied from interface: IEngineSnapEnvironment

Removes the snap agent at the given index.

Description

RemoveSnapAgent removes the snap agent at the specified index.

Specified by:

removeSnapAgent in interface IEngineSnapEnvironment

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSnapAgent

public void addSnapAgent(IEngineSnapAgent snapAgent)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IEngineSnapEnvironment

Adds a new snap agent to the snap environment.

Description

AddSnapAgent activates and adds to the snap environment any valid snap agent.

Specified by:

addSnapAgent in interface IEngineSnapEnvironment

Parameters:

snapAgent - A reference to a com.esri.arcgis.controls.IEngineSnapAgent (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getReportPrecision

public int getReportPrecision()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IEngineEditProperties

Controls the number of decimal places the editor reports numbers with.

Description

Use ReportPrecision to control the number of decimal places reported back from editing functions. By default ReportPrecision is set to 3.

Specified by:

getReportPrecision in interface IEngineEditProperties

Returns:

The numDecs

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setReportPrecision

public void setReportPrecision(int numDecs)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEngineEditProperties

Controls the number of decimal places the editor reports numbers with.

Specified by:

setReportPrecision in interface IEngineEditProperties

Parameters:

numDecs - The numDecs (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getStreamTolerance

public double getStreamTolerance()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IEngineEditProperties

Controls the streaming tolerance, measured in map units.

Description

Use StreamTolerance to set the number of points that get added to a map (in map units) by the ControlsEditingSketchTool when in stream mode. By default StreamTolerance is 0.

Use the ControlsEditingSketchStreamingCommand to set the ControlsEditingSketchTool in stream mode.

Specified by:

getStreamTolerance in interface IEngineEditProperties

Returns:

The tol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setStreamTolerance

public void setStreamTolerance(double tol)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEngineEditProperties

Controls the streaming tolerance, measured in map units.

Specified by:

setStreamTolerance in interface IEngineEditProperties

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStreamGroupingCount

public int getStreamGroupingCount()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IEngineEditProperties

Controls the number of points to group together when streaming.

Description

The StreamGroupingCount property controls how many grouped points are added to the undo stack by the ControlsEditingSketchTool when in stream mode. By default StreamGroupingCount is 50.

If StreamGroupingCount is 1 each streamed point added will be undoable and redoable. If the streaming tolerance is low, however, you may wish to make the grouping larger so that groups of added points can be undone or redone by the user with only one undo or redo.

Use the ControlsEditingSketchStreamingCommand to set the ControlsEditingSketchTool in stream mode.

Specified by:

getStreamGroupingCount in interface IEngineEditProperties

Returns:

The tol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setStreamGroupingCount

public void setStreamGroupingCount(int tol)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IEngineEditProperties

Controls the number of points to group together when streaming.

Specified by:

setStreamGroupingCount in interface IEngineEditProperties

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStretchGeometry

public boolean isStretchGeometry()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IEngineEditProperties

Indicates if the edit sketch is stretched when one of its vertices is moved.

Description

StretchGeometry determines whether or not the edit sketch is stretched proportionally when a vertex is moved. By default StretchGeometryis false.

The following diagrams illustrate this point better. In both cases, the upper right vertex was moved.

Moving a vertex with StretchGeometry set to True:

Moving a vertex with StretchGeometry set to False:

Specified by:

isStretchGeometry in interface IEngineEditProperties

Returns:

The stretch

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStretchGeometry

public void setStretchGeometry(boolean stretch)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEngineEditProperties

Indicates if the edit sketch is stretched when one of its vertices is moved.

Specified by:

setStretchGeometry in interface IEngineEditProperties

Parameters:

stretch - The stretch (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSketchSymbol

public ILineSymbol getSketchSymbol()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the lines of the edit sketch.

Description

The SketchSymbol used for lines segments in the edit sketch. The default line symbol is a solid green line with a width of one.

Specified by:

getSketchSymbol in interface IEngineEditProperties

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

public void setSketchSymbolByRef(ILineSymbol symbol)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the lines of the edit sketch.

Specified by:

setSketchSymbolByRef in interface IEngineEditProperties

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSketchVertexSymbol

public IMarkerSymbol getSketchVertexSymbol()
                                    throws java.io.IOException,
                                           AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the vertices of the edit sketch.

Description

The SketchVertexSymbol used for vertices in the edit sketch. Edit sketch vertices are drawn in green by default.

Specified by:

getSketchVertexSymbol in interface IEngineEditProperties

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSketchVertexSymbolByRef

public void setSketchVertexSymbolByRef(IMarkerSymbol symbol)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the vertices of the edit sketch.

Specified by:

setSketchVertexSymbolByRef in interface IEngineEditProperties

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSelectedVertexSymbol

public IMarkerSymbol getSelectedVertexSymbol()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the active vertex of the edit sketch.

Description

The SelectedVertexSymbol used for the last point (active point) in the edit sketch. By default this point is drawn in red and has a size of 4.

Specified by:

getSelectedVertexSymbol in interface IEngineEditProperties

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSelectedVertexSymbolByRef

public void setSelectedVertexSymbolByRef(IMarkerSymbol symbol)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the active vertex of the edit sketch.

Specified by:

setSelectedVertexSymbolByRef in interface IEngineEditProperties

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSnapSymbol

public IMarkerSymbol getSnapSymbol()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the snap location.

Description

The SnapSymbol displayed whenever you are working with the edit sketch. The default snap symbol is a blue dot.

The snap agent knows to draw the snap symbol twice, once to get rid of the old symbol and once to draw the symbol at its new location. When setting the symbol, don't forget to set the ISymbol::ROP2 to esriROPNotXOrPen. This setting allows the symbol to erase itself when drawn twice in the same location.

Specified by:

getSnapSymbol in interface IEngineEditProperties

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSnapSymbolByRef

public void setSnapSymbolByRef(IMarkerSymbol symbol)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEngineEditProperties

Symbol used to draw the snap location.

Specified by:

setSnapSymbolByRef in interface IEngineEditProperties

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

public boolean isAutoSaveOnVersionRedefined()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IEngineEditProperties

Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.

Description

Auto reconciliation provides the user the ability to delay the save process for after the reconciliation. This allows the user to inspect the results of the reconciliation prior to saving. By default AutoSaveOnVersionRedefined is false.

If AutoSaveOnVersionRedefined is true, auto reconciliation will automatically reconcile the edit session with the version's current database state and save, making changes available to others using the database.

If AutoSaveOnVersionRedefined is false, when a save occurs, the edit session will be reconciled with the version's current database state, and then a message will inform the user that the edit session has been reconciled but has not been saved.

Specified by:

isAutoSaveOnVersionRedefined in interface IEngineEditProperties

Returns:

The stretch

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setAutoSaveOnVersionRedefined

public void setAutoSaveOnVersionRedefined(boolean stretch)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IEngineEditProperties

Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.

Specified by:

setAutoSaveOnVersionRedefined in interface IEngineEditProperties

Parameters:

stretch - The stretch (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTargetLayer

public ILayer getTargetLayer()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IEngineEditProperties

The editor's target layer.

Description

The target layer (or current layer) to be editied. For example, if the target layer is set to 'Buildings' any new features created will be part of the 'Buildings' layer.

The TargetLayer gets set when the end user interactively selects a layer using the ControlsEditingTargetToolControl.

Specified by:

getTargetLayer in interface IEngineEditProperties

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getStickyMoveTolerance

public int getStickyMoveTolerance()
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IEngineEditProperties2

Controls the sticky move tolerance.

Description

StickyMoveTolerance determines the minimum distance (measured in pixels) the cursor must move before the edit is completed. This can be helpful in preventing small inadvertent shifts of features when editing. By default StickyMoveTolerance is 0.

Specified by:

getStickyMoveTolerance in interface IEngineEditProperties2

Returns:

The tol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setStickyMoveTolerance

public void setStickyMoveTolerance(int tol)
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IEngineEditProperties2

Controls the sticky move tolerance.

Specified by:

setStickyMoveTolerance in interface IEngineEditProperties2

Parameters:

tol - The tol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isSnapTips

public boolean isSnapTips()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IEngineEditProperties2

Indicates whether to show the snap tips.

Description

Use SnapTips to determine whether snap tips are displayed when using the snapping envionrment. By default SnapTips is false.

Snap tips provide feedback in the form of a tool tip and a message in the status bar identifying the snap agent that was used to modify the current point. If the snap agent used is a feature snap agent, the layer name and hit type are displayed; otherwise the snap agent name is displayed.

Specified by:

isSnapTips in interface IEngineEditProperties2

Returns:

The tips

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapTips

public void setSnapTips(boolean tips)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IEngineEditProperties2

Indicates whether to show the snap tips.

Specified by:

setSnapTips in interface IEngineEditProperties2

Parameters:

tips - The tips (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAngularUnitPrecision

public void setAngularUnitPrecision(int auPrecision)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IEngineEditProperties2

Precision used to display angular units.

Specified by:

setAngularUnitPrecision in interface IEngineEditProperties2

Parameters:

auPrecision - The auPrecision (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAngularUnitPrecision

public int getAngularUnitPrecision()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IEngineEditProperties2

Precision used to display angular units.

Description

AngularUnitPrecision determines the number of digits displayed after the decimal place. By default AngularUnitPrecision is 4.

Specified by:

getAngularUnitPrecision in interface IEngineEditProperties2

Returns:

The auPrecision

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionType

public void setDirectionType(int dirType)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IEngineEditProperties2

Direction Type.

Specified by:

setDirectionType in interface IEngineEditProperties2

Parameters:

dirType - A com.esri.arcgis.controls.esriEngineDirectionType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirectionType

public int getDirectionType()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IEngineEditProperties2

Direction Type.

Description

DirectionType determines the method of measurement for direction values. By default DirectionType is esriDTPolar.

Specified by:

getDirectionType in interface IEngineEditProperties2

Returns:

A com.esri.arcgis.controls.esriEngineDirectionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionUnits

public void setDirectionUnits(int dirUnits)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IEngineEditProperties2

Direction Units.

Specified by:

setDirectionUnits in interface IEngineEditProperties2

Parameters:

dirUnits - A com.esri.arcgis.controls.esriEngineDirectionUnits constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDirectionUnits

public int getDirectionUnits()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IEngineEditProperties2

Direction Units.

Description

DirectionUnits defines how angles are specified; how many parts a complete circle is divided into; and how to interpret the angle value. By default DirectionUnits is esriDUDecimalDegrees.

Specified by:

getDirectionUnits in interface IEngineEditProperties2

Returns:

A com.esri.arcgis.controls.esriEngineDirectionUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDistanceCorrectionFactor

public void setDistanceCorrectionFactor(double distFactor)
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IEngineEditProperties2

Distance Correction Factor.

Specified by:

setDistanceCorrectionFactor in interface IEngineEditProperties2

Parameters:

distFactor - The distFactor (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDistanceCorrectionFactor

public double getDistanceCorrectionFactor()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IEngineEditProperties2

Distance Correction Factor.

Description

DistanceCorrectionFactor determines the distance amount applied when length measurements are input into the editor. The value may be accessed or modified at any time; however, it is applied only when UseGroundToGrid is set to true. By default DistanceCorrectionFactor is 1.

Specified by:

getDistanceCorrectionFactor in interface IEngineEditProperties2

Returns:

The distFactor

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setAngularCorrectionOffset

public void setAngularCorrectionOffset(double angOffset)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IEngineEditProperties2

Angular Correction Offset.

Specified by:

setAngularCorrectionOffset in interface IEngineEditProperties2

Parameters:

angOffset - The angOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAngularCorrectionOffset

public double getAngularCorrectionOffset()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IEngineEditProperties2

Angular Correction Offset.

Description

AngularCorrectionOffset determines the amount of correction applied to each entered angular value. The offset is specified in radians. This property may be accessed at any time; it is only applied when the UseGroundToGrid is set to true. By default AngularCorrectionOffset is 0 (no correction).

Specified by:

getAngularCorrectionOffset in interface IEngineEditProperties2

Returns:

The angOffset

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setUseGroundToGrid

public void setUseGroundToGrid(boolean g2g)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IEngineEditProperties2

Indicates whether to use Ground to Grid.

Specified by:

setUseGroundToGrid in interface IEngineEditProperties2

Parameters:

g2g - The g2g (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isUseGroundToGrid

public boolean isUseGroundToGrid()
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IEngineEditProperties2

Indicates whether to use Ground to Grid.

Description

UseGroundToGrid determines whether any distance or direction offsets are applied to angle or length values respectively when using the editor. By default UseGroundToGrid is false.

If UseGroundToGrid is true then the distance offset specified by DistanceCorrectionFactor and the angular offset specified by AngularCorrectionOffset are used.

Specified by:

isUseGroundToGrid in interface IEngineEditProperties2

Returns:

The g2g

Throws:

AutomationException - If the ArcObject component throws an exception.

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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