com.esri.arcgis.editor
Class IEditPropertiesProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.editor.IEditPropertiesProxy

All Implemented Interfaces:

IEditProperties, Externalizable, Serializable

public class IEditPropertiesProxy
extends com.esri.arcgis.interop.Dispatch
implements IEditProperties, Serializable

Provides access to members that control the properties of an edit session.

When To Use

The IEditProperties interface is used to manage all of the properties an edit session has. Properties include: AutoSaveOnVersion, ReportPrecision, SelectedVertexSymbol, SketchSymbol, SketchVertexSymbol, SnapSymbol, StreamGroupingCount, StreamTolerance, and StretchGeometry.

Product Availability

Available with ArcGIS Desktop.

See Also:

ICharacterMarkerSymbol, ISnapEnvironment, IPictureMarkerSymbol, IMarkerSymbol, IEditProperties, ILineSymbol, IEditTask.activate(com.esri.arcgis.editor.IEditor, com.esri.arcgis.editor.IEditTask), IEditor, IEditLayers, IEditTask.deactivate(), IEditAttributeProperties, IEditEvents2, IEditTask.onFinishSketch(), IArrowMarkerSymbol, IDatasetEdit, IDatasetEditInfo, IEditTask.onDeleteSketch(), IEditTask.getName(), IEditEvents, IMultiLayerMarkerSymbol, ICartographicMarkerSymbol, Editor, IEditSketch, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IEditPropertiesProxy()
	IEditPropertiesProxy(Object obj)
protected	IEditPropertiesProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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.
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IEditPropertiesProxy

public IEditPropertiesProxy()

IEditPropertiesProxy

public IEditPropertiesProxy(Object obj)
                     throws IOException

Throws:

IOException

IEditPropertiesProxy

protected IEditPropertiesProxy(Object obj,
                               String iid)
                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getReportPrecision

public int getReportPrecision()
                       throws IOException,
                              AutomationException

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

Remarks

Use this property to control the number of decimal places the editor reports in all dialog boxes. Three decimal places is the default. This property does not interfere with the input of numbers into a dialog box. For example, setting ReportPrecision to two decimal places will not prevent the editor from accepting an angle of 25.12345.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getReportPrecision in interface IEditProperties

Returns:

The numDecs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportPrecision

public void setReportPrecision(int numDecs)
                        throws IOException,
                               AutomationException

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

Remarks

Use this property to control the number of decimal places the editor reports in all dialog boxes. Four decimal places is the default. This property does not interfere with the input of numbers into a dialog box. For example, setting ReportPrecision to two decimal places will not prevent the editor from accepting an angle of 25.12345.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setReportPrecision in interface IEditProperties

Parameters:

numDecs - The numDecs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreamTolerance

public double getStreamTolerance()
                          throws IOException,
                                 AutomationException

Controls the streaming tolerance, measured in map units.

Remarks

Use the StreamTolerance property to access or modify the tolerance value used to control the number of points that get added to the map when the Sketch Tool is in stream mode.

The StreamTolerance value is in map units.

Use the IsStreaming property found on the interface ISketchTool to turn stream mode digitizing on or off.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getStreamTolerance in interface IEditProperties

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStreamTolerance

public void setStreamTolerance(double tol)
                        throws IOException,
                               AutomationException

Controls the streaming tolerance, measured in map units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setStreamTolerance in interface IEditProperties

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreamGroupingCount

public int getStreamGroupingCount()
                           throws IOException,
                                  AutomationException

Controls the number of points to group together when streaming.

Remarks

The StreamGroupingCount property establishes how many grouped points to add to the undo stack for the sketch operation when ISketchTool :: IsStreaming is TRUE. This means that if the value is set to 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.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getStreamGroupingCount in interface IEditProperties

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStreamGroupingCount

public void setStreamGroupingCount(int tol)
                            throws IOException,
                                   AutomationException

Controls the number of points to group together when streaming.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setStreamGroupingCount in interface IEditProperties

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStretchGeometry

public boolean isStretchGeometry()
                          throws IOException,
                                 AutomationException

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

Remarks

This property determines whether or not the edit sketch is stretched proportionally when a vertex is moved. 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 StrechGeometry set to False:

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isStretchGeometry in interface IEditProperties

Returns:

The stretch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStretchGeometry

public void setStretchGeometry(boolean stretch)
                        throws IOException,
                               AutomationException

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

Remarks

This property determines whether or not the edit sketch is stretched proportionally when a vertex is moved. 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 StrechGeometry set to False:

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setStretchGeometry in interface IEditProperties

Parameters:

stretch - The stretch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSketchSymbol

public ILineSymbol getSketchSymbol()
                            throws IOException,
                                   AutomationException

Symbol used to draw the lines of the edit sketch.

Remarks

Use this property to change the symbology for lines (segments) in the edit sketch. The default line symbol is a solid green line with a width of one.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSketchSymbol in interface IEditProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEditProperties.getSelectedVertexSymbol(), IEditProperties.getSketchVertexSymbol(), IEditProperties.getSnapSymbol()

setSketchSymbolByRef

public void setSketchSymbolByRef(ILineSymbol symbol)
                          throws IOException,
                                 AutomationException

Symbol used to draw the lines of the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSketchSymbolByRef in interface IEditProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSketchVertexSymbol

public IMarkerSymbol getSketchVertexSymbol()
                                    throws IOException,
                                           AutomationException

Symbol used to draw the vertices of the edit sketch.

Remarks

Use this property to change the symbology of the vertices in the edit sketch. Edit sketch vertices are drawn in green by default.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSketchVertexSymbol in interface IEditProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEditProperties.getSelectedVertexSymbol(), IEditProperties.getSnapSymbol(), IEditProperties.getSketchSymbol()

setSketchVertexSymbolByRef

public void setSketchVertexSymbolByRef(IMarkerSymbol symbol)
                                throws IOException,
                                       AutomationException

Symbol used to draw the vertices of the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSketchVertexSymbolByRef in interface IEditProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedVertexSymbol

public IMarkerSymbol getSelectedVertexSymbol()
                                      throws IOException,
                                             AutomationException

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

Remarks

Use this property to change the symbology of the last point in the edit sketch. By default this point is drawn in red and has a size of 4.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSelectedVertexSymbol in interface IEditProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEditProperties.getSketchVertexSymbol(), IEditProperties.getSnapSymbol(), IEditProperties.getSketchSymbol()

setSelectedVertexSymbolByRef

public void setSelectedVertexSymbolByRef(IMarkerSymbol symbol)
                                  throws IOException,
                                         AutomationException

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

Remarks

Use this property to change the symbology of the edit sketch's last point. By default this unique vertex is drawn as a red square.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSelectedVertexSymbolByRef in interface IEditProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapSymbol

public IMarkerSymbol getSnapSymbol()
                            throws IOException,
                                   AutomationException

Symbol used to draw the snap location.

Remarks

Use this property to change the editor's snap symbol when classic snapping is enabled. The snap symbol is 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 its ROP property (on the ISymbol interface) to esriROPNotXOrPen . This setting allows the symbol to erase itself when drawn twice in the same location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSnapSymbol in interface IEditProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEditProperties.getSketchVertexSymbol(), IEditProperties.getSelectedVertexSymbol(), IEditor.invertAgent(com.esri.arcgis.geometry.IPoint, int)

setSnapSymbolByRef

public void setSnapSymbolByRef(IMarkerSymbol symbol)
                        throws IOException,
                               AutomationException

Symbol used to draw the snap location.

Remarks

Use this property to change the editor's snap symbol. The snap symbol is displayed whenever you are working with the edit sketch.

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setSnapSymbolByRef in interface IEditProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoSaveOnVersionRedefined

public boolean isAutoSaveOnVersionRedefined()
                                     throws IOException,
                                            AutomationException

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

Remarks

AutoReconciliation 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.

If AutoSaveOnVersionRedefined = 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 = 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.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isAutoSaveOnVersionRedefined in interface IEditProperties

Returns:

The stretch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoSaveOnVersionRedefined

public void setAutoSaveOnVersionRedefined(boolean stretch)
                                   throws IOException,
                                          AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setAutoSaveOnVersionRedefined in interface IEditProperties

Parameters:

stretch - The stretch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.