Editor (ArcObjects Java API 10.4)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.editor
Class Editor

java.lang.Object
  com.esri.arcgis.editor.Editor

All Implemented Interfaces:: IActiveViewEvents, IAttributeTransferType, IEditAnnotationProperties, IEditAttributeProperties, IEditLayers, IEditor, IEditor2, IEditor3, IEditorZ, IEditProperties, IEditProperties2, IEditProperties3, IEditProperties4, IEditSketch, IEditSketch2, IEditSketch3, IEditTaskSearch, ISnapEnvironment, ISnapEnvironment2, ISnapEnvironment3, com.esri.arcgis.interop.RemoteObjRef, IExtension, IExtensionAccelerators, IExtensionManager, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable, java.util.EventListener

public class Editor
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEditor, IEditor2, IEditor3, IEditSketch, IEditSketch2, IEditSketch3, IExtension, IActiveViewEvents, ISnapEnvironment, ISnapEnvironment2, ISnapEnvironment3, IEditLayers, IEditProperties, IEditProperties2, IEditProperties3, IEditProperties4, IAttributeTransferType, IExtensionManager, IExtensionAccelerators, IPersist, IPersistStream, ISupportErrorInfo, IEditAnnotationProperties, IEditAttributeProperties, IEditTaskSearch, IEditorZ, java.io.Externalizable
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEditor, IEditor2, IEditor3, IEditSketch, IEditSketch2, IEditSketch3, IExtension, IActiveViewEvents, ISnapEnvironment, ISnapEnvironment2, ISnapEnvironment3, IEditLayers, IEditProperties, IEditProperties2, IEditProperties3, IEditProperties4, IAttributeTransferType, IExtensionManager, IExtensionAccelerators, IPersist, IPersistStream, ISupportErrorInfo, IEditAnnotationProperties, IEditAttributeProperties, IEditTaskSearch, IEditorZ, java.io.Externalizable

COM Class 'Editor'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description 'The Object Editor Extension.' 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 =

See Also:: Serialized Form

Field Summary
`static long`	`serialVersionUID`

Fields inherited from interface com.esri.arcgis.editor.IEditor3
`IID, IIDc207ef01_f8b2_405b_a12a_ec94505090bb, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditor2
`IID7fa2aabd_a885_4f52_b538_969e8b464cbc`

Fields inherited from interface com.esri.arcgis.editor.IEditor
`IID2866e6b0_c00b_11d0_802b_0000f8037368`

Fields inherited from interface com.esri.arcgis.editor.IEditSketch3
`IID, IID560640d2_81cb_4070_b73a_5f9e4d52df00, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditSketch2
`IIDf8cf41ac_6f8a_4892_b0f7_2e0668b8cba0`

Fields inherited from interface com.esri.arcgis.editor.IEditSketch
`IID6d3a6f67_9115_11d1_8461_0000f875b9c6`

Fields inherited from interface com.esri.arcgis.system.IExtension
`IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy`

Fields inherited from interface com.esri.arcgis.carto.IActiveViewEvents
`IID, IIDe79c5940_52dd_11d0_98be_00805f7ced21, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.ISnapEnvironment3
`IID, IID013e7acc_014a_40df_b883_2fec1694c979, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.ISnapEnvironment2
`IID80571989_6e71_4203_a38c_855db22099d5`

Fields inherited from interface com.esri.arcgis.editor.ISnapEnvironment
`IID99305f46_ef10_11d0_aaca_0000f804eb00`

Fields inherited from interface com.esri.arcgis.editor.IEditLayers
`IID, IID6cd39a83_b457_11d1_8470_0000f875b9c6, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditProperties
`IID, IID199b7810_b38e_11d1_846f_0000f875b9c6, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditProperties2
`IID, IID44dda459_de7c_4ac0_98ff_abb32a6d8669, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditProperties3
`IID, IID2315d713_e21c_4be1_93af_f17624a051cc, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditProperties4
`IID, IID026cfef7_33dd_4adc_b12d_8c2ba25d60a1, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IAttributeTransferType
`IID, IID9c610c6d_e4e5_40d3_831d_b87207eeccdc, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IExtensionManager
`IID, IID05c71634_d9d5_4d6f_b68e_d7661142fa06, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IExtensionAccelerators
`IID, IID35d9879a_db68_4a2f_87cc_7206f0060b71, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IPersistStream
`IID, IID00000109_0000_0000_c000_000000000046, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IPersist
`IID0000010c_0000_0000_c000_000000000046`

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
`IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditAnnotationProperties
`IID, IID7b3b76df_d88d_4940_a388_842f253982b7, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditAttributeProperties
`IID, IID7d5464cb_6b99_46ac_8626_c215353b741c, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditTaskSearch
`IID, IIDb8d14de9_0cf7_4695_ba44_0f9aa9c3f93e, xxDummy`

Fields inherited from interface com.esri.arcgis.editor.IEditorZ
`IID, IIDf697a79e_e55f_4a63_83a8_7676725d56a4, xxDummy`

Constructor Summary
`Editor(java.lang.Object obj)` Construct a Editor using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary
`void`	`abortOperation()` Aborts an edit operation.
`void`	`addIEditEvents2Listener(IEditEvents2 theListener)` addIEditEvents2Listener.
`void`	`addIEditEvents3Listener(IEditEvents3 theListener)` addIEditEvents3Listener.
`void`	`addIEditEvents4Listener(IEditEvents4 theListener)` addIEditEvents4Listener.
`void`	`addIEditEvents5Listener(IEditEvents5 theListener)` addIEditEvents5Listener.
`void`	`addIEditEventsListener(IEditEvents theListener)` addIEditEventsListener.
`void`	`addPoint(IPoint point, boolean allowUndo)` Adds a point to the edit sketch.
`void`	`addSnapAgent(ISnapAgent snapAgent)` Adds a new snap agent to the snap environment.
`void`	`addTemplates(IArray editTemplateArray)` Adds the specified edit template.
`void`	`afterDraw(IActiveViewEventsAfterDrawEvent theEvent)` Fired after the specified phase is drawn.
`void`	`afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)` Fired after an individual view item is drawn.
`void`	`applyZ(IPoint point)` Applies editor's Z-capture logic to point if it isn't already z-aware.
`void`	`clearSelectedVertices()` Clears selected vertices.
`void`	`clearSnapAgents()` Removes all snap agents.
`void`	`clearWYSIWYGSketchSymbol()` Clears the WYSIWYG Sketch symbol and its properties.
`void`	`contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)` Fired when the contents of the view changes.
`void`	`contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)` Fired when the contents of the view is cleared.
`void`	`createAccelerators()` Called to create the keyboard accelerators for this extension.
`IGeometry`	`createSearchShape(IPoint point)` Creates a geometry using the point and the current search tolerance.
`void`	`delayEvents(boolean delay)` Used to batch operations together and minimize notifications.
`void`	`drapeGeometry(IGeometry geometry, boolean addVertices, IGeometry[] outputGeometry)` Drapes a geometry to the current surface..
`void`	`enableUndoRedo(boolean enabled)` Enable/disable the undo/redo capabilities.
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`void`	`finalizeZs(IGeometry geometry)` Resolves NaN Zs to definite values.
`IExtension`	`findExtension(IUID extensionID)` Finds the extension given an id.
`IExtension`	`findExtension(java.lang.Object nameOrID)` Finds the extension by CLSID (IUID) or name (String).
`void`	`finishSketch()` Completes the current edit sketch.
`void`	`finishSketchPart()` Completes a part for the current edit sketch.
`void`	`focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)` Fired when a new map is made active.
`boolean`	`fullPointSnap(IPoint point)` Always attempts to snap the point using the current snap environment.
`IMarkerSymbol`	`getActiveSelectedVertexSymbol()` Symbol used to draw the selected active vertex of the edit sketch.
`IMarkerSymbol`	`getActiveSketchVertexSymbol()` Symbol used to draw the selected vertices of the edit sketch.
`double`	`getAngularCorrectionOffset()` Angular Correction Offset.
`int`	`getAngularUnitPrecision()` Precision used to display angular units.
`ISet`	`getAttributeEditClasses()` The list of applicable feature classes.
`IAttributeTransfer`	`getAttributeTransfer()` The current attribute type.
`IAnchorPoint`	`getAuxiliarySelectionAnchor()` The auxiliary selection anchor.
`void`	`getClassID(GUID[] pClassID)` getClassID
`IFeatureLayer`	`getCurrentLayer()` Indicates the editor's target layer which new features are added to.
`int`	`getCurrentSubtype()` The sub type for new features in the CurrentLayer.
`IEditTask`	`getCurrentTask()` The current edit task.
`IEditTemplate`	`getCurrentTemplate()` The current edit template.
`double`	`getCurrentZ()` Current Z value for the edit sketch.
`int`	`getDirectionType()` Direction Type.
`int`	`getDirectionUnits()` Direction Units.
`IScreenDisplay`	`getDisplay()` Reference to the current display.
`double`	`getDistanceCorrectionFactor()` Distance Correction Factor.
`IEnumFeature`	`getEditSelection()` The selected features which are editable.
`IEditSketchExtension`	`getEditSketchExtension()` The current edit sketch extension.
`int`	`getEditState()` The editor's current edit state.
`IWorkspace`	`getEditWorkspace()` Reference to the workspace being edited.
`IExtension`	`getExtension(int index)` The extension at the specified index.
`IUID`	`getExtensionCLSID(int index)` The CLSID of the extension at the specified index.
`int`	`getExtensionCount()` The number of extensions loaded in the application.
`IGeometry`	`getGeometry()` Geometry stored in the edit sketch.
`int`	`getGeometryType()` Type of the geometry stored in the edit sketch.
`com.esri.arcgis.interop.Dispatch`	`getJintegraDispatch()` Deprecated. Internal use only.
`IPoint`	`getLastPoint()` The last point in the edit sketch.
`ICallout`	`getLeaderSymbol()` Symbol used to draw a leader.
`IPoint`	`getLocation()` The last known location of the mouse.
`IMap`	`getMap()` Reference to the map being edited.
`int`	`getMultiuserEditSessionMode()` The multiuser session mode that is used when editing.
`ISymbol`	`getMultiWordSelectionSymbol()` Symbol used to draw selected words in multiword annotation.
`java.lang.String`	`getName()` The name of the extension.
`INotifyZFinalize`	`getNotifyZFinalize()` Callback used to notify if ZCapture mode fails.
`IApplication`	`getParent()` Reference to the parent application.
`int`	`getPart()` The index of the current part of the sketch.
`int`	`getReportPrecision()` Controls the number of decimal places the editor reports numbers with.
`IWorkspace`	`getScratchWorkspace()` Reference to the editor's scratch workspace.
`int`	`getSegment()` The index of the current segment of the sketch.
`int`	`getSelectedVertexCount()` The number of selected vertices.
`IMarkerSymbol`	`getSelectedVertexSymbol()` Symbol used to draw the active vertex of the edit sketch.
`IAnchorPoint`	`getSelectionAnchor()` The selection anchor point.
`int`	`getSelectionCount()` The number of selected features which are editable.
`IShapeConstructor`	`getShapeConstructor()` The currently activated Shape Constructor.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`ILineSymbol`	`getSketchSymbol()` Symbol used to draw the lines of the edit sketch.
`IMarkerSymbol`	`getSketchVertexSymbol()` Symbol used to draw the vertices of the edit sketch.
`ISnapAgent`	`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.
`double`	`getSnapZTolerance()` The snap tolerance used for z-values, measured in map units.
`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.
`IFunctionalSurface`	`getSurface()` Surface used for Z capture.
`IEditTask`	`getTask(int index)` An edit task by index.
`IEditTask`	`getTaskByUniqueName(java.lang.String uniqueName)` An edit task by unique name.
`int`	`getTaskCount()` The number of edit tasks.
`IEditTemplate`	`getTemplate(int index)` The edit template for the specified index.
`int`	`getTemplateCount()` The number of edit templates.
`int`	`getVertex()` The index of the current vertex of the sketch.
`ISymbol`	`getWYSIWYGSketchSymbol()` The WYSIWYG symbol for the sketch.
`int`	`getZCaptureType()` Determines method used for z-capture.
`double`	`getZDrapingTolerance()` Determines the allowable error from the surface when draping.
`double`	`getZOffset()` Determines offset applied to z-value when new vertex is added to edit sketch.
`IMarkerSymbol`	`getZSnapSymbol()` Symbol used to indicate when vertex is snapped in Z.
`boolean`	`hasEdits()` Indicates whether edits have been made during the session.
`int`	`hashCode()` the hashcode for this object
`IFeatureConstruction`	`initializeFeatureConstruction()` Initialize a FeatureConstruction object that will use the Editor's ZEnvironment settings.
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`void`	`invertAgent(IPoint loc, int hdc)` Draws the editor's snapping agent.
`boolean`	`isAttributeEditAll()` Indicates if the pre-populate attributes dialog is used for all layers or just the selected layers.
`boolean`	`isAutoReconcileConflictsByAttribute()` Indicates whether conflicts will be detected and resolved by attributes.
`boolean`	`isAutoReconcileEditSessionWins()` Indicates whether conflicts are resolved in favor of the edit session.
`boolean`	`isAutoSaveChecksConflicts()` Indicates whether the editor checks if conflicts were detected during auto reconciliation prior to automatically saving.
`boolean`	`isAutoSaveOnVersionRedefined()` Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
`boolean`	`isAuxiliarySelectionAnchorEnabled()` Indicates whether the selection anchor is drawn.
`boolean`	`isClassicSnapping()` Indicates whether the classic editing snapping will be used.
`void`	`isDirty()` isDirty
`boolean`	`isDraping()` Indicates whether sketches are draped onto the surface.
`boolean`	`isEditable(IFeatureLayer layer)` Determines if a specific feature layer is editable.
`boolean`	`isMAware()` Indicates if the edit sketch geometry will contain Ms.
`boolean`	`isNonversionedAttributionEnabled()` Indicates if the attribute query for newly created features is enabled.
`boolean`	`isPartComplete()` Indicates whether FinishPart has been called on the edit sketch.
`boolean`	`isShowAnnoHandles()` Indicates whether the edit annotation tool will show the resize and rotate handles.
`boolean`	`isShowConstructionToolbars()` Indicates whether construction toolbars will be displayed while drawing a sketch.
`boolean`	`isSketchSymbolIsWYSIWYG()` Indicates whether the sketch symbol is WYSIWYG.
`boolean`	`isSketchSymbolRespectsRefScale()` Indicates whether the sketch symbol should respect the map's reference scale.
`boolean`	`isSnapTips()` Indicates whether to show the snap tips.
`boolean`	`isSnapToSketch()` Indicates whether the sketch will be added to the snapping cache.
`boolean`	`isStretchGeometry()` Indicates if the edit sketch is stretched when one of its vertices is moved.
`boolean`	`isUseFollowLineFeatureMode()` Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.
`boolean`	`isUseFollowPolygonFeatureMode()` Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.
`boolean`	`isUseGroundToGrid()` Indicates whether to use Ground to Grid.
`boolean`	`isUseSnapZTolerance()` Indicates whether the SnapZTolerance property is used when Z snapping.
`boolean`	`isUseWYSIWYGSketchSymbol()` Indicates whether the sketch is drawn with WYSIWYG symbology.
`boolean`	`isUseZDrapingTolerance()` Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.
`boolean`	`isUseZOffset()` Indicates whether new z-values are modified by the ZOffset property.
`boolean`	`isVertexSelected(int part, int vertex)` Is a vertex selected.
`boolean`	`isZAware()` Indicates if the edit sketch geometry will contain Zs.
`void`	`itemAdded(IActiveViewEventsItemAddedEvent theEvent)` Fired when an item is added to the view.
`void`	`itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)` Fired when an item is deleted from the view.
`void`	`itemReordered(IActiveViewEventsItemReorderedEvent theEvent)` Fired when a view item is reordered.
`void`	`load(IStream pstm)` load
`void`	`modifySketch()` Call to notify listeners that the sketch has been changed.
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`redoOperation()` Redo an edit operation.
`void`	`refreshSketch()` Invalidates the portion of the display that is occupied by the sketch.
`void`	`release()` Release a Editor.
`void`	`removeAllTemplatesInLayer(ILayer layer)` Removes all templates from the specified layer.
`void`	`removeAllTemplatesInMap(IMap map)` Removes all templates from the specified map.
`void`	`removeIEditEvents2Listener(IEditEvents2 theListener)` removeIEditEvents2Listener.
`void`	`removeIEditEvents3Listener(IEditEvents3 theListener)` removeIEditEvents3Listener.
`void`	`removeIEditEvents4Listener(IEditEvents4 theListener)` removeIEditEvents4Listener.
`void`	`removeIEditEvents5Listener(IEditEvents5 theListener)` removeIEditEvents5Listener.
`void`	`removeIEditEventsListener(IEditEvents theListener)` removeIEditEventsListener.
`void`	`removeSnapAgent(int index)` Removes the snap agent at the given index.
`void`	`removeTemplate(IEditTemplate editTemplate)` Removes the specified edit template.
`void`	`resetAuxiliarySelectionAnchorLocation()` Places the auxiliary selection anchor near the main anchor.
`void`	`save(IStream pstm, int fClearDirty)` save
`IEnumFeature`	`searchSelection(IPoint point)` Searches the edit selection using the given location.
`void`	`selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)` Call this function to fire the selection changed event.
`void`	`selectVertex(int part, int vertex)` Selects a vertex.
`void`	`setActiveSelectedVertexSymbolByRef(IMarkerSymbol symbol)` Symbol used to draw the selected active vertex of the edit sketch.
`void`	`setActiveSketchVertexSymbolByRef(IMarkerSymbol symbol)` Symbol used to draw the selected vertices of the edit sketch.
`void`	`setAngularCorrectionOffset(double angOffset)` Angular Correction Offset.
`void`	`setAngularUnitPrecision(int auPrecision)` Precision used to display angular units.
`void`	`setAttributeEditAll(boolean pFlag)` Indicates if the pre-populate attributes dialog is used for all layers or just the selected layers.
`void`	`setAttributeEditClassesByRef(ISet ppClasses)` The list of applicable feature classes.
`void`	`setAttributeTransferType(java.lang.String rhs1)` The current attribute type.
`void`	`setAutoReconcileConflictsByAttribute(boolean byatt)` Indicates whether conflicts will be detected and resolved by attributes.
`void`	`setAutoReconcileEditSessionWins(boolean editWins)` Indicates whether conflicts are resolved in favor of the edit session.
`void`	`setAutoSaveChecksConflicts(boolean checksConflicts)` Indicates whether the editor checks if conflicts were detected during auto reconciliation prior to automatically saving.
`void`	`setAutoSaveOnVersionRedefined(boolean stretch)` Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
`void`	`setAuxiliarySelectionAnchorEnabled(boolean auxSelAnchorEnabled)` Indicates whether the selection anchor is drawn.
`void`	`setClassicSnapping(boolean snap)` Indicates whether the classic editing snapping will be used.
`void`	`setCurrentLayer(IFeatureLayer layer, int subtype)` The editor's target layer and subtype for new features.
`void`	`setCurrentTaskByRef(IEditTask task)` The current edit task.
`void`	`setCurrentTemplateByRef(IEditTemplate editTemplate)` The current edit template.
`void`	`setCurrentZ(double z)` Current Z value for the edit sketch.
`void`	`setDirectionType(int dirType)` Direction Type.
`void`	`setDirectionUnits(int dirUnits)` Direction Units.
`void`	`setDistanceCorrectionFactor(double distFactor)` Distance Correction Factor.
`void`	`setDraping(boolean useDraping)` Indicates whether sketches are draped onto the surface.
`void`	`setEditSketchExtensionByRef(IEditSketchExtension extension)` The current edit sketch extension.
`void`	`setGeometryByRef(IGeometry geometry)` Geometry stored in the edit sketch.
`void`	`setGeometryType(int geomType)` Type of the geometry stored in the edit sketch.
`void`	`setLeaderSymbolByRef(ICallout callout)` Symbol used to draw a leader.
`void`	`setMAware(boolean aware)` Indicates if the edit sketch geometry will contain Ms.
`void`	`setMultiuserEditSessionMode(int esm)` The multiuser session mode that is used when editing.
`void`	`setMultiWordSelectionSymbolByRef(ISymbol symbol)` Symbol used to draw selected words in multiword annotation.
`void`	`setNonversionedAttributionEnabled(boolean pFlag)` Indicates if the attribute query for newly created features is enabled.
`void`	`setNotifyZFinalizeByRef(INotifyZFinalize callback)` Callback used to notify if ZCapture mode fails.
`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`	`setShapeConstructorByRef(IShapeConstructor shapeConstructor)` The currently activated Shape Constructor.
`void`	`setShowAnnoHandles(boolean flag)` Indicates whether the edit annotation tool will show the resize and rotate handles.
`void`	`setShowConstructionToolbars(boolean showConstructionToolbars)` Indicates whether construction toolbars will be displayed while drawing a 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`	`setSnapToSketch(boolean snap)` Indicates whether the sketch will be added to the snapping cache.
`void`	`setSnapZTolerance(double tolerance)` The snap tolerance used for z-values, measured in map units.
`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`	`setSurfaceByRef(IFunctionalSurface surface)` Surface used for Z capture.
`void`	`setUseFollowLineFeatureMode(boolean flag)` Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.
`void`	`setUseFollowPolygonFeatureMode(boolean flag)` Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.
`void`	`setUseGroundToGrid(boolean g2g)` Indicates whether to use Ground to Grid.
`void`	`setUseSnapZTolerance(boolean useSnapZTolerance)` Indicates whether the SnapZTolerance property is used when Z snapping.
`void`	`setUseWYSIWYGSketchSymbol(boolean useWYSIWYGSketchSymbol)` Indicates whether the sketch is drawn with WYSIWYG symbology.
`void`	`setUseZDrapingTolerance(boolean useZDrapingTolerance)` Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.
`void`	`setUseZOffset(boolean useZOffset)` Indicates whether new z-values are modified by the ZOffset property.
`void`	`setWYSIWYGSketchSymbol(ISymbol symbol, boolean isWYSIWYG, boolean respectsRefScale)` The WYSIWYG Sketch symbol and its properties.
`void`	`setZAware(boolean aware)` Indicates if the edit sketch geometry will contain Zs.
`void`	`setZCaptureType(int zCaptureType)` Determines method used for z-capture.
`void`	`setZDrapingTolerance(double zDrapingTolerance)` Determines the allowable error from the surface when draping.
`void`	`setZOffset(double zOffset)` Determines offset applied to z-value when new vertex is added to edit sketch.
`void`	`setZSnapSymbolByRef(IMarkerSymbol symbol)` Symbol used to indicate when vertex is snapped in Z.
`void`	`shutdown()` Shuts down the extension.
`boolean`	`snapPoint(IPoint point)` Attempts to snap the point using the current snap environment.
`boolean`	`snapToIntersection(IPoint point, IGeometry pIntersection)` Attempts to snap the specified point to the given intersection.
`void`	`spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)` Fired when the spatial reference is changed.
`void`	`startEditing(IWorkspace workspace)` Starts an edit session.
`void`	`startOperation()` Starts an edit operation.
`void`	`startup(java.lang.Object initializationData)` Starts up the extension with the given initialization data.
`void`	`stopEditing(boolean saveChanges)` Stops an edit session.
`void`	`stopOperation(java.lang.String menuText)` Stops an edit operation.
`void`	`templateModified(IEditTemplate editTemplate)` Broadcasts the change to the rest of the system.
`void`	`undoOperation()` Undo an edit operation.
`void`	`unselectVertex(int part, int vertex)` Unselects a vertex.
`void`	`vertexAdded(IPoint point)` Call to notify listeners that a sketch vertex has been added.
`void`	`vertexDeleted(IPoint point)` Call to notify listeners that a sketch vertex has been deleted.
`void`	`vertexMoved(IPoint point)` Call to notify listeners that a sketch vertex has been moved.
`void`	`viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)` Fired when view is refreshed before draw happens.
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:: Constant Field Values

Constructor Detail

Editor

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

Construct a Editor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Editor.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.

   * 
Editor o = (Editor)obj; // will not work 

 
Editor o = new Editor(obj); // Use this constructor instead

* @param obj an object returned from ArcGIS Engine or Server

Throws:: java.io.IOException - if there are interop problems Editor theEditor = (Editor) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:: equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:: getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIEditEventsListener

public void addIEditEventsListener(IEditEvents theListener)
                            throws java.io.IOException

addIEditEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents interface.
Throws:: java.io.IOException - If there are communications problems.

removeIEditEventsListener

public void removeIEditEventsListener(IEditEvents theListener)
                               throws java.io.IOException

removeIEditEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents interface.
Throws:: java.io.IOException - If there are communications problems.

addIEditEvents2Listener

public void addIEditEvents2Listener(IEditEvents2 theListener)
                             throws java.io.IOException

addIEditEvents2Listener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents2 interface.
Throws:: java.io.IOException - If there are communications problems.

removeIEditEvents2Listener

public void removeIEditEvents2Listener(IEditEvents2 theListener)
                                throws java.io.IOException

removeIEditEvents2Listener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents2 interface.
Throws:: java.io.IOException - If there are communications problems.

addIEditEvents3Listener

public void addIEditEvents3Listener(IEditEvents3 theListener)
                             throws java.io.IOException

addIEditEvents3Listener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents3 interface.
Throws:: java.io.IOException - If there are communications problems.

removeIEditEvents3Listener

public void removeIEditEvents3Listener(IEditEvents3 theListener)
                                throws java.io.IOException

removeIEditEvents3Listener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents3 interface.
Throws:: java.io.IOException - If there are communications problems.

addIEditEvents4Listener

public void addIEditEvents4Listener(IEditEvents4 theListener)
                             throws java.io.IOException

addIEditEvents4Listener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents4 interface.
Throws:: java.io.IOException - If there are communications problems.

removeIEditEvents4Listener

public void removeIEditEvents4Listener(IEditEvents4 theListener)
                                throws java.io.IOException

removeIEditEvents4Listener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents4 interface.
Throws:: java.io.IOException - If there are communications problems.

addIEditEvents5Listener

public void addIEditEvents5Listener(IEditEvents5 theListener)
                             throws java.io.IOException

addIEditEvents5Listener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents5 interface.
Throws:: java.io.IOException - If there are communications problems.

removeIEditEvents5Listener

public void removeIEditEvents5Listener(IEditEvents5 theListener)
                                throws java.io.IOException

removeIEditEvents5Listener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.editor.IEditEvents5 interface.
Throws:: java.io.IOException - If there are communications problems.

release

public void release()

Release a Editor.

Specified by:: release in interface com.esri.arcgis.interop.RemoteObjRef

getParent

public IApplication getParent()
                       throws java.io.IOException,
                              AutomationException

Reference to the parent application.

Specified by:: getParent in interface IEditor

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

getEditState

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

The editor's current edit state.

Specified by:: getEditState in interface IEditor

Returns:: A com.esri.arcgis.editor.esriEditState constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws java.io.IOException,
                   AutomationException

Reference to the map being edited.

Specified by:: getMap in interface IEditor

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

getDisplay

public IScreenDisplay getDisplay()
                          throws java.io.IOException,
                                 AutomationException

Reference to the current display.

Specified by:: getDisplay in interface IEditor

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

getEditWorkspace

public IWorkspace getEditWorkspace()
                            throws java.io.IOException,
                                   AutomationException

Reference to the workspace being edited.

Specified by:: getEditWorkspace in interface IEditor

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

getScratchWorkspace

public IWorkspace getScratchWorkspace()
                               throws java.io.IOException,
                                      AutomationException

Reference to the editor's scratch workspace.

Specified by:: getScratchWorkspace in interface IEditor

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

startEditing

public void startEditing(IWorkspace workspace)
                  throws java.io.IOException,
                         AutomationException

Starts an edit session.

Specified by:: startEditing in interface IEditor

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

stopEditing

public void stopEditing(boolean saveChanges)
                 throws java.io.IOException,
                        AutomationException

Stops an edit session.

Specified by:: stopEditing in interface IEditor

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

hasEdits

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

Indicates whether edits have been made during the session.

Specified by:: hasEdits in interface IEditor

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

startOperation

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

Starts an edit operation.

Specified by:: startOperation in interface IEditor

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

abortOperation

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

Aborts an edit operation.

Specified by:: abortOperation in interface IEditor

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

stopOperation

public void stopOperation(java.lang.String menuText)
                   throws java.io.IOException,
                          AutomationException

Stops an edit operation.

Specified by:: stopOperation in interface IEditor

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

undoOperation

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

Undo an edit operation.

Specified by:: undoOperation in interface IEditor

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

redoOperation

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

Redo an edit operation.

Specified by:: redoOperation in interface IEditor

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

enableUndoRedo

public void enableUndoRedo(boolean enabled)
                    throws java.io.IOException,
                           AutomationException

Enable/disable the undo/redo capabilities.

Specified by:: enableUndoRedo in interface IEditor

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

delayEvents

public void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException

Used to batch operations together and minimize notifications.

Specified by:: delayEvents in interface IEditor

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

getEditSelection

public IEnumFeature getEditSelection()
                              throws java.io.IOException,
                                     AutomationException

The selected features which are editable.

Specified by:: getEditSelection in interface IEditor

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

getSelectionCount

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

The number of selected features which are editable.

Specified by:: getSelectionCount in interface IEditor

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

findExtension

public IExtension findExtension(IUID extensionID)
                         throws java.io.IOException,
                                AutomationException

Finds the extension given an id.

Specified by:: findExtension in interface IEditor

Parameters:: extensionID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:: A reference to a com.esri.arcgis.system.IExtension
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTaskCount

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

The number of edit tasks.

Specified by:: getTaskCount in interface IEditor

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

getTask

public IEditTask getTask(int index)
                  throws java.io.IOException,
                         AutomationException

An edit task by index.

Specified by:: getTask in interface IEditor

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.editor.IEditTask
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setCurrentTaskByRef

public void setCurrentTaskByRef(IEditTask task)
                         throws java.io.IOException,
                                AutomationException

The current edit task.

Specified by:: setCurrentTaskByRef in interface IEditor

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

getCurrentTask

public IEditTask getCurrentTask()
                         throws java.io.IOException,
                                AutomationException

The current edit task.

Specified by:: getCurrentTask in interface IEditor

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

createSearchShape

public IGeometry createSearchShape(IPoint point)
                            throws java.io.IOException,
                                   AutomationException

Creates a geometry using the point and the current search tolerance.

Specified by:: createSearchShape in interface IEditor

Parameters:: point - A reference to a com.esri.arcgis.geometry.IPoint (in)
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.

searchSelection

public IEnumFeature searchSelection(IPoint point)
                             throws java.io.IOException,
                                    AutomationException

Searches the edit selection using the given location.

Specified by:: searchSelection in interface IEditor

Parameters:: point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Returns:: A reference to a com.esri.arcgis.geodatabase.IEnumFeature
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

invertAgent

public void invertAgent(IPoint loc,
                        int hdc)
                 throws java.io.IOException,
                        AutomationException

Draws the editor's snapping agent.

Specified by:: invertAgent in interface IEditor

Parameters:: loc - A reference to a com.esri.arcgis.geometry.IPoint (in); hdc - The hdc (A COM typedef) (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSelectionAnchor

public IAnchorPoint getSelectionAnchor()
                                throws java.io.IOException,
                                       AutomationException

The selection anchor point.

Specified by:: getSelectionAnchor in interface IEditor

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

getLocation

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

The last known location of the mouse.

Specified by:: getLocation in interface IEditor

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.

getAuxiliarySelectionAnchor

public IAnchorPoint getAuxiliarySelectionAnchor()
                                         throws java.io.IOException,
                                                AutomationException

The auxiliary selection anchor.

Specified by:: getAuxiliarySelectionAnchor in interface IEditor2

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

isAuxiliarySelectionAnchorEnabled

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

Indicates whether the selection anchor is drawn.

Specified by:: isAuxiliarySelectionAnchorEnabled in interface IEditor2

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

setAuxiliarySelectionAnchorEnabled

public void setAuxiliarySelectionAnchorEnabled(boolean auxSelAnchorEnabled)
                                        throws java.io.IOException,
                                               AutomationException

Indicates whether the selection anchor is drawn.

Specified by:: setAuxiliarySelectionAnchorEnabled in interface IEditor2

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

resetAuxiliarySelectionAnchorLocation

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

Places the auxiliary selection anchor near the main anchor.

Specified by:: resetAuxiliarySelectionAnchorLocation in interface IEditor2

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

getTemplateCount

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

The number of edit templates.

Specified by:: getTemplateCount in interface IEditor3

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

getTemplate

public IEditTemplate getTemplate(int index)
                          throws java.io.IOException,
                                 AutomationException

The edit template for the specified index.

Specified by:: getTemplate in interface IEditor3

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IEditTemplate
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addTemplates

public void addTemplates(IArray editTemplateArray)
                  throws java.io.IOException,
                         AutomationException

Adds the specified edit template. The template was created with the EditTemplateFactory.

Specified by:: addTemplates in interface IEditor3

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

removeTemplate

public void removeTemplate(IEditTemplate editTemplate)
                    throws java.io.IOException,
                           AutomationException

Removes the specified edit template.

Specified by:: removeTemplate in interface IEditor3

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

removeAllTemplatesInLayer

public void removeAllTemplatesInLayer(ILayer layer)
                               throws java.io.IOException,
                                      AutomationException

Removes all templates from the specified layer.

Specified by:: removeAllTemplatesInLayer in interface IEditor3

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

removeAllTemplatesInMap

public void removeAllTemplatesInMap(IMap map)
                             throws java.io.IOException,
                                    AutomationException

Removes all templates from the specified map.

Specified by:: removeAllTemplatesInMap in interface IEditor3

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

getCurrentTemplate

public IEditTemplate getCurrentTemplate()
                                 throws java.io.IOException,
                                        AutomationException

The current edit template.

Specified by:: getCurrentTemplate in interface IEditor3

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

setCurrentTemplateByRef

public void setCurrentTemplateByRef(IEditTemplate editTemplate)
                             throws java.io.IOException,
                                    AutomationException

The current edit template.

Specified by:: setCurrentTemplateByRef in interface IEditor3

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

templateModified

public void templateModified(IEditTemplate editTemplate)
                      throws java.io.IOException,
                             AutomationException

Broadcasts the change to the rest of the system.

Specified by:: templateModified in interface IEditor3

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

getPart

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

The index of the current part of the sketch.

Specified by:: getPart in interface IEditSketch

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

getSegment

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

The index of the current segment of the sketch.

Specified by:: getSegment in interface IEditSketch

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

getVertex

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

The index of the current vertex of the sketch.

Specified by:: getVertex in interface IEditSketch

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

getGeometryType

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

Type of the geometry stored in the edit sketch.

Specified by:: getGeometryType in interface IEditSketch

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

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

Type of the geometry stored in the edit sketch.

Specified by:: setGeometryType in interface IEditSketch

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

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

Geometry stored in the edit sketch.

Specified by:: getGeometry in interface IEditSketch

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

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

Geometry stored in the edit sketch.

Specified by:: setGeometryByRef in interface IEditSketch

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.

addPoint

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

Specified by:: addPoint in interface IEditSketch

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

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

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

Specified by:: refreshSketch in interface IEditSketch

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

finishSketch

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

Completes the current edit sketch.

Specified by:: finishSketch in interface IEditSketch

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

finishSketchPart

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

Completes a part for the current edit sketch.

Specified by:: finishSketchPart in interface IEditSketch

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

getLastPoint

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

The last point in the edit sketch.

Specified by:: getLastPoint in interface IEditSketch

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

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

Call to notify listeners that the sketch has been changed.

Specified by:: modifySketch in interface IEditSketch

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

isZAware

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

Indicates if the edit sketch geometry will contain Zs.

Specified by:: isZAware in interface IEditSketch2

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

setZAware

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

Indicates if the edit sketch geometry will contain Zs.

Specified by:: setZAware in interface IEditSketch2

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

getCurrentZ

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

Current Z value for the edit sketch.

Specified by:: getCurrentZ in interface IEditSketch2

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

setCurrentZ

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

Current Z value for the edit sketch.

Specified by:: setCurrentZ in interface IEditSketch2

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

setEditSketchExtensionByRef

public void setEditSketchExtensionByRef(IEditSketchExtension extension)
                                 throws java.io.IOException,
                                        AutomationException

The current edit sketch extension.

Specified by:: setEditSketchExtensionByRef in interface IEditSketch2

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

getEditSketchExtension

public IEditSketchExtension getEditSketchExtension()
                                            throws java.io.IOException,
                                                   AutomationException

The current edit sketch extension.

Specified by:: getEditSketchExtension in interface IEditSketch2

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

vertexAdded

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

Call to notify listeners that a sketch vertex has been added.

Specified by:: vertexAdded in interface IEditSketch2

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

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

Call to notify listeners that a sketch vertex has been deleted.

Specified by:: vertexDeleted in interface IEditSketch2

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

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

Call to notify listeners that a sketch vertex has been moved.

Specified by:: vertexMoved in interface IEditSketch2

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.

isMAware

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

Indicates if the edit sketch geometry will contain Ms.

Specified by:: isMAware in interface IEditSketch2

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

setMAware

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

Indicates if the edit sketch geometry will contain Ms.

Specified by:: setMAware in interface IEditSketch2

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

isPartComplete

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

Indicates whether FinishPart has been called on the edit sketch.

Specified by:: isPartComplete in interface IEditSketch2

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

isVertexSelected

public boolean isVertexSelected(int part,
                                int vertex)
                         throws java.io.IOException,
                                AutomationException

Is a vertex selected.

Specified by:: isVertexSelected in interface IEditSketch3

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

clearSelectedVertices

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

Clears selected vertices.

Specified by:: clearSelectedVertices in interface IEditSketch3

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

selectVertex

public void selectVertex(int part,
                         int vertex)
                  throws java.io.IOException,
                         AutomationException

Selects a vertex.

Specified by:: selectVertex in interface IEditSketch3

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

unselectVertex

public void unselectVertex(int part,
                           int vertex)
                    throws java.io.IOException,
                           AutomationException

Unselects a vertex.

Specified by:: unselectVertex in interface IEditSketch3

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

getSelectedVertexCount

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

The number of selected vertices.

Specified by:: getSelectedVertexCount in interface IEditSketch3

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

setWYSIWYGSketchSymbol

public void setWYSIWYGSketchSymbol(ISymbol symbol,
                                   boolean isWYSIWYG,
                                   boolean respectsRefScale)
                            throws java.io.IOException,
                                   AutomationException

The WYSIWYG Sketch symbol and its properties.

Specified by:: setWYSIWYGSketchSymbol in interface IEditSketch3

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

clearWYSIWYGSketchSymbol

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

Clears the WYSIWYG Sketch symbol and its properties.

Specified by:: clearWYSIWYGSketchSymbol in interface IEditSketch3

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

getWYSIWYGSketchSymbol

public ISymbol getWYSIWYGSketchSymbol()
                               throws java.io.IOException,
                                      AutomationException

The WYSIWYG symbol for the sketch.

Specified by:: getWYSIWYGSketchSymbol in interface IEditSketch3

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

isSketchSymbolIsWYSIWYG

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

Indicates whether the sketch symbol is WYSIWYG.

Specified by:: isSketchSymbolIsWYSIWYG in interface IEditSketch3

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

isSketchSymbolRespectsRefScale

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

Indicates whether the sketch symbol should respect the map's reference scale.

Specified by:: isSketchSymbolRespectsRefScale in interface IEditSketch3

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

getShapeConstructor

public IShapeConstructor getShapeConstructor()
                                      throws java.io.IOException,
                                             AutomationException

The currently activated Shape Constructor.

Specified by:: getShapeConstructor in interface IEditSketch3

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

setShapeConstructorByRef

public void setShapeConstructorByRef(IShapeConstructor shapeConstructor)
                              throws java.io.IOException,
                                     AutomationException

The currently activated Shape Constructor.

Specified by:: setShapeConstructorByRef in interface IEditSketch3

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the extension.

Specified by:: getName in interface IExtension

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

startup

public void startup(java.lang.Object initializationData)
             throws java.io.IOException,
                    AutomationException

Starts up the extension with the given initialization data.

Specified by:: startup in interface IExtension

Parameters:: initializationData - A Variant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

shutdown

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

Shuts down the extension.

Specified by:: shutdown in interface IExtension

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

contentsChanged

public void contentsChanged(IActiveViewEventsContentsChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view changes.

Specified by:: contentsChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

contentsCleared

public void contentsCleared(IActiveViewEventsContentsClearedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when the contents of the view is cleared.

Specified by:: contentsCleared in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

itemAdded

public void itemAdded(IActiveViewEventsItemAddedEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired when an item is added to the view.

Specified by:: itemAdded in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

itemDeleted

public void itemDeleted(IActiveViewEventsItemDeletedEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when an item is deleted from the view.

Specified by:: itemDeleted in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

itemReordered

public void itemReordered(IActiveViewEventsItemReorderedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when a view item is reordered.

Specified by:: itemReordered in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectionChanged

public void selectionChanged(IActiveViewEventsSelectionChangedEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Call this function to fire the selection changed event.

Specified by:: selectionChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

viewRefreshed

public void viewRefreshed(IActiveViewEventsViewRefreshedEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired when view is refreshed before draw happens.

Specified by:: viewRefreshed in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

afterDraw

public void afterDraw(IActiveViewEventsAfterDrawEvent theEvent)
               throws java.io.IOException,
                      AutomationException

Fired after the specified phase is drawn.

Specified by:: afterDraw in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

afterItemDraw

public void afterItemDraw(IActiveViewEventsAfterItemDrawEvent theEvent)
                   throws java.io.IOException,
                          AutomationException

Fired after an individual view item is drawn. Example: view items include layers in a map or elements in a page layout.

Specified by:: afterItemDraw in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

focusMapChanged

public void focusMapChanged(IActiveViewEventsFocusMapChangedEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when a new map is made active.

Specified by:: focusMapChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

spatialReferenceChanged

public void spatialReferenceChanged(IActiveViewEventsSpatialReferenceChangedEvent theEvent)
                             throws java.io.IOException,
                                    AutomationException

Fired when the spatial reference is changed.

Specified by:: spatialReferenceChanged in interface IActiveViewEvents

Parameters:: theEvent - The event
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

snapPoint

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

Attempts to snap the point using the current snap environment.

Specified by:: snapPoint in interface ISnapEnvironment

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

The units used for the snap tolerance.

Specified by:: getSnapToleranceUnits in interface ISnapEnvironment

Returns:: A com.esri.arcgis.editor.esriSnapToleranceUnits 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

The units used for the snap tolerance.

Specified by:: setSnapToleranceUnits in interface ISnapEnvironment

Parameters:: units - A com.esri.arcgis.editor.esriSnapToleranceUnits constant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

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

The snap tolerance, measured in pixels or map units.

Specified by:: getSnapTolerance in interface ISnapEnvironment

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

setSnapTolerance

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

The snap tolerance, measured in pixels or map units.

Specified by:: setSnapTolerance in interface ISnapEnvironment

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

getSnapAgentCount

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

The number of active snap agents.

Specified by:: getSnapAgentCount in interface ISnapEnvironment

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

getSnapAgent

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

A snap agent at the given index.

Specified by:: getSnapAgent in interface ISnapEnvironment

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.editor.ISnapAgent
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

clearSnapAgents

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

Removes all snap agents.

Specified by:: clearSnapAgents in interface ISnapEnvironment

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

removeSnapAgent

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

Removes the snap agent at the given index.

Specified by:: removeSnapAgent in interface ISnapEnvironment

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(ISnapAgent snapAgent)
                  throws java.io.IOException,
                         AutomationException

Adds a new snap agent to the snap environment.

Specified by:: addSnapAgent in interface ISnapEnvironment

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

isUseSnapZTolerance

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

Indicates whether the SnapZTolerance property is used when Z snapping.

Specified by:: isUseSnapZTolerance in interface ISnapEnvironment2

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

setUseSnapZTolerance

public void setUseSnapZTolerance(boolean useSnapZTolerance)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether the SnapZTolerance property is used when Z snapping.

Specified by:: setUseSnapZTolerance in interface ISnapEnvironment2

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

getSnapZTolerance

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

The snap tolerance used for z-values, measured in map units.

Specified by:: getSnapZTolerance in interface ISnapEnvironment2

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

setSnapZTolerance

public void setSnapZTolerance(double tolerance)
                       throws java.io.IOException,
                              AutomationException

The snap tolerance used for z-values, measured in map units.

Specified by:: setSnapZTolerance in interface ISnapEnvironment2

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

snapToIntersection

public boolean snapToIntersection(IPoint point,
                                  IGeometry pIntersection)
                           throws java.io.IOException,
                                  AutomationException

Attempts to snap the specified point to the given intersection.

Specified by:: snapToIntersection in interface ISnapEnvironment3

Parameters:: point - A reference to a com.esri.arcgis.geometry.IPoint (in); pIntersection - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The snapped
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

fullPointSnap

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

Always attempts to snap the point using the current snap environment. This should not be used to snap mouse position in a tool.

Specified by:: fullPointSnap in interface ISnapEnvironment3

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.

setCurrentLayer

public void setCurrentLayer(IFeatureLayer layer,
                            int subtype)
                     throws java.io.IOException,
                            AutomationException

The editor's target layer and subtype for new features.

Specified by:: setCurrentLayer in interface IEditLayers

Parameters:: layer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in); subtype - The subtype (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCurrentLayer

public IFeatureLayer getCurrentLayer()
                              throws java.io.IOException,
                                     AutomationException

Indicates the editor's target layer which new features are added to.

Specified by:: getCurrentLayer in interface IEditLayers

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

getCurrentSubtype

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

The sub type for new features in the CurrentLayer.

Specified by:: getCurrentSubtype in interface IEditLayers

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

isEditable

public boolean isEditable(IFeatureLayer layer)
                   throws java.io.IOException,
                          AutomationException

Determines if a specific feature layer is editable.

Specified by:: isEditable in interface IEditLayers

Parameters:: layer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
Returns:: The pEditable
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getReportPrecision

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

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

Specified by:: getReportPrecision in interface IEditProperties

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

setReportPrecision

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

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

Specified by:: setReportPrecision in interface IEditProperties

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

getStreamTolerance

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

Controls the streaming tolerance, measured in map units.

Specified by:: getStreamTolerance in interface IEditProperties

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

setStreamTolerance

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

Controls the streaming tolerance, measured in map units.

Specified by:: setStreamTolerance in interface IEditProperties

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

Controls the number of points to group together when streaming.

Specified by:: getStreamGroupingCount in interface IEditProperties

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

setStreamGroupingCount

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

Controls the number of points to group together when streaming.

Specified by:: setStreamGroupingCount in interface IEditProperties

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

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

Specified by:: isStretchGeometry in interface IEditProperties

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

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

Specified by:: setStretchGeometry in interface IEditProperties

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

getSketchSymbol

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

Symbol used to draw the lines of the edit sketch.

Specified by:: getSketchSymbol in interface IEditProperties

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

Symbol used to draw the lines of the edit sketch.

Specified by:: setSketchSymbolByRef in interface IEditProperties

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

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

Symbol used to draw the vertices of the edit sketch.

Specified by:: getSketchVertexSymbol in interface IEditProperties

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

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

Symbol used to draw the vertices of the edit sketch.

Specified by:: setSketchVertexSymbolByRef in interface IEditProperties

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

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

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

Specified by:: getSelectedVertexSymbol in interface IEditProperties

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

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

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

Specified by:: setSelectedVertexSymbolByRef in interface IEditProperties

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

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

Symbol used to draw the snap location.

Specified by:: getSnapSymbol in interface IEditProperties

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

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

Symbol used to draw the snap location.

Specified by:: setSnapSymbolByRef in interface IEditProperties

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

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

Specified by:: isAutoSaveOnVersionRedefined in interface IEditProperties

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

setAutoSaveOnVersionRedefined

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

Specified by:: setAutoSaveOnVersionRedefined in interface IEditProperties

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

getStickyMoveTolerance

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

Controls the sticky move tolerance.

Specified by:: getStickyMoveTolerance in interface IEditProperties2

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

setStickyMoveTolerance

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

Controls the sticky move tolerance.

Specified by:: setStickyMoveTolerance in interface IEditProperties2

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

isSnapTips

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

Indicates whether to show the snap tips.

Specified by:: isSnapTips in interface IEditProperties2

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

Indicates whether to show the snap tips.

Specified by:: setSnapTips in interface IEditProperties2

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

Precision used to display angular units.

Specified by:: setAngularUnitPrecision in interface IEditProperties2

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

getAngularUnitPrecision

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

Precision used to display angular units.

Specified by:: getAngularUnitPrecision in interface IEditProperties2

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

Direction Type.

Specified by:: setDirectionType in interface IEditProperties2

Parameters:: dirType - A com.esri.arcgis.system.esriDirectionType 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

Direction Type.

Specified by:: getDirectionType in interface IEditProperties2

Returns:: A com.esri.arcgis.system.esriDirectionType 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

Direction Units.

Specified by:: setDirectionUnits in interface IEditProperties2

Parameters:: dirUnits - A com.esri.arcgis.system.esriDirectionUnits constant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDirectionUnits

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

Direction Units.

Specified by:: getDirectionUnits in interface IEditProperties2

Returns:: A com.esri.arcgis.system.esriDirectionUnits 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

Distance Correction Factor.

Specified by:: setDistanceCorrectionFactor in interface IEditProperties2

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

getDistanceCorrectionFactor

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

Distance Correction Factor.

Specified by:: getDistanceCorrectionFactor in interface IEditProperties2

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

setAngularCorrectionOffset

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

Angular Correction Offset.

Specified by:: setAngularCorrectionOffset in interface IEditProperties2

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

Angular Correction Offset.

Specified by:: getAngularCorrectionOffset in interface IEditProperties2

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

setUseGroundToGrid

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

Indicates whether to use Ground to Grid.

Specified by:: setUseGroundToGrid in interface IEditProperties2

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

isUseGroundToGrid

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

Indicates whether to use Ground to Grid.

Specified by:: isUseGroundToGrid in interface IEditProperties2

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

getMultiuserEditSessionMode

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

The multiuser session mode that is used when editing.

Specified by:: getMultiuserEditSessionMode in interface IEditProperties3

Returns:: A com.esri.arcgis.geodatabase.esriMultiuserEditSessionMode constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMultiuserEditSessionMode

public void setMultiuserEditSessionMode(int esm)
                                 throws java.io.IOException,
                                        AutomationException

The multiuser session mode that is used when editing.

Specified by:: setMultiuserEditSessionMode in interface IEditProperties3

Parameters:: esm - A com.esri.arcgis.geodatabase.esriMultiuserEditSessionMode constant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isAutoSaveChecksConflicts

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

Indicates whether the editor checks if conflicts were detected during auto reconciliation prior to automatically saving.

Specified by:: isAutoSaveChecksConflicts in interface IEditProperties3

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

setAutoSaveChecksConflicts

public void setAutoSaveChecksConflicts(boolean checksConflicts)
                                throws java.io.IOException,
                                       AutomationException

Indicates whether the editor checks if conflicts were detected during auto reconciliation prior to automatically saving.

Specified by:: setAutoSaveChecksConflicts in interface IEditProperties3

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

isAutoReconcileConflictsByAttribute

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

Indicates whether conflicts will be detected and resolved by attributes.

Specified by:: isAutoReconcileConflictsByAttribute in interface IEditProperties3

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

setAutoReconcileConflictsByAttribute

public void setAutoReconcileConflictsByAttribute(boolean byatt)
                                          throws java.io.IOException,
                                                 AutomationException

Indicates whether conflicts will be detected and resolved by attributes.

Specified by:: setAutoReconcileConflictsByAttribute in interface IEditProperties3

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

isAutoReconcileEditSessionWins

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

Indicates whether conflicts are resolved in favor of the edit session.

Specified by:: isAutoReconcileEditSessionWins in interface IEditProperties3

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

setAutoReconcileEditSessionWins

public void setAutoReconcileEditSessionWins(boolean editWins)
                                     throws java.io.IOException,
                                            AutomationException

Indicates whether conflicts are resolved in favor of the edit session.

Specified by:: setAutoReconcileEditSessionWins in interface IEditProperties3

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

isUseWYSIWYGSketchSymbol

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

Indicates whether the sketch is drawn with WYSIWYG symbology.

Specified by:: isUseWYSIWYGSketchSymbol in interface IEditProperties4

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

setUseWYSIWYGSketchSymbol

public void setUseWYSIWYGSketchSymbol(boolean useWYSIWYGSketchSymbol)
                               throws java.io.IOException,
                                      AutomationException

Indicates whether the sketch is drawn with WYSIWYG symbology.

Specified by:: setUseWYSIWYGSketchSymbol in interface IEditProperties4

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

isClassicSnapping

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

Indicates whether the classic editing snapping will be used.

Specified by:: isClassicSnapping in interface IEditProperties4

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

setClassicSnapping

public void setClassicSnapping(boolean snap)
                        throws java.io.IOException,
                               AutomationException

Indicates whether the classic editing snapping will be used.

Specified by:: setClassicSnapping in interface IEditProperties4

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

isSnapToSketch

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

Indicates whether the sketch will be added to the snapping cache. It is used when not using classic snapping.

Specified by:: isSnapToSketch in interface IEditProperties4

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

setSnapToSketch

public void setSnapToSketch(boolean snap)
                     throws java.io.IOException,
                            AutomationException

Indicates whether the sketch will be added to the snapping cache. It is used when not using classic snapping.

Specified by:: setSnapToSketch in interface IEditProperties4

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

isShowConstructionToolbars

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

Indicates whether construction toolbars will be displayed while drawing a sketch.

Specified by:: isShowConstructionToolbars in interface IEditProperties4

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

setShowConstructionToolbars

public void setShowConstructionToolbars(boolean showConstructionToolbars)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether construction toolbars will be displayed while drawing a sketch.

Specified by:: setShowConstructionToolbars in interface IEditProperties4

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

getActiveSketchVertexSymbol

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

Symbol used to draw the selected vertices of the edit sketch.

Specified by:: getActiveSketchVertexSymbol in interface IEditProperties4

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.

setActiveSketchVertexSymbolByRef

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

Symbol used to draw the selected vertices of the edit sketch.

Specified by:: setActiveSketchVertexSymbolByRef in interface IEditProperties4

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.

getActiveSelectedVertexSymbol

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

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

Specified by:: getActiveSelectedVertexSymbol in interface IEditProperties4

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.

setActiveSelectedVertexSymbolByRef

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

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

Specified by:: setActiveSelectedVertexSymbolByRef in interface IEditProperties4

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.

getAttributeTransfer

public IAttributeTransfer getAttributeTransfer()
                                        throws java.io.IOException,
                                               AutomationException

The current attribute type.

Specified by:: getAttributeTransfer in interface IAttributeTransferType

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

setAttributeTransferType

public void setAttributeTransferType(java.lang.String rhs1)
                              throws java.io.IOException,
                                     AutomationException

The current attribute type.

Specified by:: setAttributeTransferType in interface IAttributeTransferType

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

getExtensionCount

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

The number of extensions loaded in the application.

Specified by:: getExtensionCount in interface IExtensionManager

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

getExtension

public IExtension getExtension(int index)
                        throws java.io.IOException,
                               AutomationException

The extension at the specified index.

Specified by:: getExtension in interface IExtensionManager

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.system.IExtension
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionCLSID

public IUID getExtensionCLSID(int index)
                       throws java.io.IOException,
                              AutomationException

The CLSID of the extension at the specified index.

Specified by:: getExtensionCLSID in interface IExtensionManager

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.system.IUID
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findExtension

public IExtension findExtension(java.lang.Object nameOrID)
                         throws java.io.IOException,
                                AutomationException

Finds the extension by CLSID (IUID) or name (String).

Specified by:: findExtension in interface IExtensionManager

Parameters:: nameOrID - A Variant (in)
Returns:: A reference to a com.esri.arcgis.system.IExtension
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createAccelerators

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

Called to create the keyboard accelerators for this extension.

Specified by:: createAccelerators in interface IExtensionAccelerators

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:: load in interface IPersistStream

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

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

interfaceSupportsErrorInfo

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getLeaderSymbol

public ICallout getLeaderSymbol()
                         throws java.io.IOException,
                                AutomationException

Symbol used to draw a leader.

Specified by:: getLeaderSymbol in interface IEditAnnotationProperties

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

setLeaderSymbolByRef

public void setLeaderSymbolByRef(ICallout callout)
                          throws java.io.IOException,
                                 AutomationException

Symbol used to draw a leader.

Specified by:: setLeaderSymbolByRef in interface IEditAnnotationProperties

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

isShowAnnoHandles

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

Indicates whether the edit annotation tool will show the resize and rotate handles.

Specified by:: isShowAnnoHandles in interface IEditAnnotationProperties

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

setShowAnnoHandles

public void setShowAnnoHandles(boolean flag)
                        throws java.io.IOException,
                               AutomationException

Indicates whether the edit annotation tool will show the resize and rotate handles.

Specified by:: setShowAnnoHandles in interface IEditAnnotationProperties

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

isUseFollowLineFeatureMode

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

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.

Specified by:: isUseFollowLineFeatureMode in interface IEditAnnotationProperties

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

setUseFollowLineFeatureMode

public void setUseFollowLineFeatureMode(boolean flag)
                                 throws java.io.IOException,
                                        AutomationException

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to lines.

Specified by:: setUseFollowLineFeatureMode in interface IEditAnnotationProperties

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

isUseFollowPolygonFeatureMode

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

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.

Specified by:: isUseFollowPolygonFeatureMode in interface IEditAnnotationProperties

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

setUseFollowPolygonFeatureMode

public void setUseFollowPolygonFeatureMode(boolean flag)
                                    throws java.io.IOException,
                                           AutomationException

Indicates whether the edit annotation tool will use follow feature mode when moving annotation related to polygons.

Specified by:: setUseFollowPolygonFeatureMode in interface IEditAnnotationProperties

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

getMultiWordSelectionSymbol

public ISymbol getMultiWordSelectionSymbol()
                                    throws java.io.IOException,
                                           AutomationException

Symbol used to draw selected words in multiword annotation.

Specified by:: getMultiWordSelectionSymbol in interface IEditAnnotationProperties

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

setMultiWordSelectionSymbolByRef

public void setMultiWordSelectionSymbolByRef(ISymbol symbol)
                                      throws java.io.IOException,
                                             AutomationException

Symbol used to draw selected words in multiword annotation.

Specified by:: setMultiWordSelectionSymbolByRef in interface IEditAnnotationProperties

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

isNonversionedAttributionEnabled

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

Indicates if the attribute query for newly created features is enabled.

Specified by:: isNonversionedAttributionEnabled in interface IEditAttributeProperties

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

setNonversionedAttributionEnabled

public void setNonversionedAttributionEnabled(boolean pFlag)
                                       throws java.io.IOException,
                                              AutomationException

Indicates if the attribute query for newly created features is enabled.

Specified by:: setNonversionedAttributionEnabled in interface IEditAttributeProperties

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

isAttributeEditAll

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

Indicates if the pre-populate attributes dialog is used for all layers or just the selected layers.

Specified by:: isAttributeEditAll in interface IEditAttributeProperties

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

setAttributeEditAll

public void setAttributeEditAll(boolean pFlag)
                         throws java.io.IOException,
                                AutomationException

Indicates if the pre-populate attributes dialog is used for all layers or just the selected layers.

Specified by:: setAttributeEditAll in interface IEditAttributeProperties

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

getAttributeEditClasses

public ISet getAttributeEditClasses()
                             throws java.io.IOException,
                                    AutomationException

The list of applicable feature classes.

Specified by:: getAttributeEditClasses in interface IEditAttributeProperties

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

setAttributeEditClassesByRef

public void setAttributeEditClassesByRef(ISet ppClasses)
                                  throws java.io.IOException,
                                         AutomationException

The list of applicable feature classes.

Specified by:: setAttributeEditClassesByRef in interface IEditAttributeProperties

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

getTaskByUniqueName

public IEditTask getTaskByUniqueName(java.lang.String uniqueName)
                              throws java.io.IOException,
                                     AutomationException

An edit task by unique name.

Specified by:: getTaskByUniqueName in interface IEditTaskSearch

Parameters:: uniqueName - The uniqueName (in)
Returns:: A reference to a com.esri.arcgis.editor.IEditTask
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

drapeGeometry

public void drapeGeometry(IGeometry geometry,
                          boolean addVertices,
                          IGeometry[] outputGeometry)
                   throws java.io.IOException,
                          AutomationException

Drapes a geometry to the current surface.. If addVertices is false, existing vertex Z's will be modified but no new vertices added.

Specified by:: drapeGeometry in interface IEditorZ

Parameters:: geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in); addVertices - The addVertices (in); outputGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

applyZ

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

Applies editor's Z-capture logic to point if it isn't already z-aware.

Specified by:: applyZ in interface IEditorZ

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.

finalizeZs

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

Resolves NaN Zs to definite values.

Specified by:: finalizeZs in interface IEditorZ

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.

getZCaptureType

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

Determines method used for z-capture.

Specified by:: getZCaptureType in interface IEditorZ

Returns:: A com.esri.arcgis.editor.esriZCaptureType constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setZCaptureType

public void setZCaptureType(int zCaptureType)
                     throws java.io.IOException,
                            AutomationException

Determines method used for z-capture.

Specified by:: setZCaptureType in interface IEditorZ

Parameters:: zCaptureType - A com.esri.arcgis.editor.esriZCaptureType constant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isUseZOffset

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

Indicates whether new z-values are modified by the ZOffset property.

Specified by:: isUseZOffset in interface IEditorZ

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

setUseZOffset

public void setUseZOffset(boolean useZOffset)
                   throws java.io.IOException,
                          AutomationException

Indicates whether new z-values are modified by the ZOffset property.

Specified by:: setUseZOffset in interface IEditorZ

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

getZOffset

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

Determines offset applied to z-value when new vertex is added to edit sketch.

Specified by:: getZOffset in interface IEditorZ

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

setZOffset

public void setZOffset(double zOffset)
                throws java.io.IOException,
                       AutomationException

Determines offset applied to z-value when new vertex is added to edit sketch.

Specified by:: setZOffset in interface IEditorZ

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

isUseZDrapingTolerance

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

Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.

Specified by:: isUseZDrapingTolerance in interface IEditorZ

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

setUseZDrapingTolerance

public void setUseZDrapingTolerance(boolean useZDrapingTolerance)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.

Specified by:: setUseZDrapingTolerance in interface IEditorZ

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

getZDrapingTolerance

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

Determines the allowable error from the surface when draping.

Specified by:: getZDrapingTolerance in interface IEditorZ

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

setZDrapingTolerance

public void setZDrapingTolerance(double zDrapingTolerance)
                          throws java.io.IOException,
                                 AutomationException

Determines the allowable error from the surface when draping.

Specified by:: setZDrapingTolerance in interface IEditorZ

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

isDraping

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

Indicates whether sketches are draped onto the surface.

Specified by:: isDraping in interface IEditorZ

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

setDraping

public void setDraping(boolean useDraping)
                throws java.io.IOException,
                       AutomationException

Indicates whether sketches are draped onto the surface.

Specified by:: setDraping in interface IEditorZ

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

getSurface

public IFunctionalSurface getSurface()
                              throws java.io.IOException,
                                     AutomationException

Surface used for Z capture.

Specified by:: getSurface in interface IEditorZ

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

setSurfaceByRef

public void setSurfaceByRef(IFunctionalSurface surface)
                     throws java.io.IOException,
                            AutomationException

Surface used for Z capture.

Specified by:: setSurfaceByRef in interface IEditorZ

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

getZSnapSymbol

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

Symbol used to indicate when vertex is snapped in Z.

Specified by:: getZSnapSymbol in interface IEditorZ

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.

setZSnapSymbolByRef

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

Symbol used to indicate when vertex is snapped in Z.

Specified by:: setZSnapSymbolByRef in interface IEditorZ

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.

getNotifyZFinalize

public INotifyZFinalize getNotifyZFinalize()
                                    throws java.io.IOException,
                                           AutomationException

Callback used to notify if ZCapture mode fails.

Specified by:: getNotifyZFinalize in interface IEditorZ

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

setNotifyZFinalizeByRef

public void setNotifyZFinalizeByRef(INotifyZFinalize callback)
                             throws java.io.IOException,
                                    AutomationException

Callback used to notify if ZCapture mode fails.

Specified by:: setNotifyZFinalizeByRef in interface IEditorZ

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

initializeFeatureConstruction

public IFeatureConstruction initializeFeatureConstruction()
                                                   throws java.io.IOException,
                                                          AutomationException

Initialize a FeatureConstruction object that will use the Editor's ZEnvironment settings.

Specified by:: initializeFeatureConstruction in interface IEditorZ

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

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:: writeExternal in interface java.io.Externalizable

Throws:: java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:: readExternal in interface java.io.Externalizable

Throws:: java.io.IOException; java.lang.ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.editor Class Editor

serialVersionUID

Editor

equals

hashCode

getJintegraDispatch

addIEditEventsListener

removeIEditEventsListener

addIEditEvents2Listener

removeIEditEvents2Listener

addIEditEvents3Listener

removeIEditEvents3Listener

addIEditEvents4Listener

removeIEditEvents4Listener

addIEditEvents5Listener

removeIEditEvents5Listener

release

getParent

getEditState

getMap

getDisplay

getEditWorkspace

getScratchWorkspace

startEditing

stopEditing

hasEdits

startOperation

abortOperation

stopOperation

undoOperation

redoOperation

enableUndoRedo

delayEvents

getEditSelection

getSelectionCount

findExtension

getTaskCount

getTask

setCurrentTaskByRef

getCurrentTask

createSearchShape

searchSelection

invertAgent

getSelectionAnchor

getLocation

getAuxiliarySelectionAnchor

isAuxiliarySelectionAnchorEnabled

setAuxiliarySelectionAnchorEnabled

resetAuxiliarySelectionAnchorLocation

getTemplateCount

getTemplate

addTemplates

removeTemplate

removeAllTemplatesInLayer

removeAllTemplatesInMap

getCurrentTemplate

setCurrentTemplateByRef

templateModified

getPart

getSegment

getVertex

getGeometryType

setGeometryType

getGeometry

setGeometryByRef

addPoint

refreshSketch

finishSketch

finishSketchPart

getLastPoint

modifySketch

isZAware

setZAware

getCurrentZ

setCurrentZ

setEditSketchExtensionByRef

getEditSketchExtension

vertexAdded

vertexDeleted

vertexMoved

com.esri.arcgis.editor
Class Editor