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
Interface IEditor

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IEditor2, IEditor3
All Known Implementing Classes:
Editor, IEditor2Proxy, IEditor3Proxy, IEditorProxy
public interface IEditor
extends java.io.Serializable

COM Interface 'IEditor'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to members that control the behavior of the editor.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID2866e6b0_c00b_11d0_802b_0000f8037368
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void abortOperation()
          Aborts an edit operation.
 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 enableUndoRedo(boolean enabled)
          Enable/disable the undo/redo capabilities.
 IExtension findExtension(IUID extensionID)
          Finds the extension given an id.
 IEditTask getCurrentTask()
          The current edit task.
 IScreenDisplay getDisplay()
          Reference to the current display.
 IEnumFeature getEditSelection()
          The selected features which are editable.
 int getEditState()
          The editor's current edit state.
 IWorkspace getEditWorkspace()
          Reference to the workspace being edited.
 IPoint getLocation()
          The last known location of the mouse.
 IMap getMap()
          Reference to the map being edited.
 IApplication getParent()
          Reference to the parent application.
 IWorkspace getScratchWorkspace()
          Reference to the editor's scratch workspace.
 IAnchorPoint getSelectionAnchor()
          The selection anchor point.
 int getSelectionCount()
          The number of selected features which are editable.
 IEditTask getTask(int index)
          An edit task by index.
 int getTaskCount()
          The number of edit tasks.
 boolean hasEdits()
          Indicates whether edits have been made during the session.
 void invertAgent(IPoint loc, int hdc)
          Draws the editor's snapping agent.
 void redoOperation()
          Redo an edit operation.
 IEnumFeature searchSelection(IPoint point)
          Searches the edit selection using the given location.
 void setCurrentTaskByRef(IEditTask task)
          The current edit task.
 void startEditing(IWorkspace workspace)
          Starts an edit session.
 void startOperation()
          Starts an edit operation.
 void stopEditing(boolean saveChanges)
          Stops an edit session.
 void stopOperation(java.lang.String menuText)
          Stops an edit operation.
 void undoOperation()
          Undo an edit operation.
 

Field Detail

IID2866e6b0_c00b_11d0_802b_0000f8037368

static final int IID2866e6b0_c00b_11d0_802b_0000f8037368
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getParent

IApplication getParent()
                       throws java.io.IOException,
                              AutomationException
Reference to the parent application.

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

int getEditState()
                 throws java.io.IOException,
                        AutomationException
The editor's current edit state.

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

IMap getMap()
            throws java.io.IOException,
                   AutomationException
Reference to the map being edited.

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

IScreenDisplay getDisplay()
                          throws java.io.IOException,
                                 AutomationException
Reference to the current display.

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

IWorkspace getEditWorkspace()
                            throws java.io.IOException,
                                   AutomationException
Reference to the workspace being edited.

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

IWorkspace getScratchWorkspace()
                               throws java.io.IOException,
                                      AutomationException
Reference to the editor's scratch workspace.

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

void startEditing(IWorkspace workspace)
                  throws java.io.IOException,
                         AutomationException
Starts an edit session.

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

void stopEditing(boolean saveChanges)
                 throws java.io.IOException,
                        AutomationException
Stops an edit session.

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

hasEdits

boolean hasEdits()
                 throws java.io.IOException,
                        AutomationException
Indicates whether edits have been made during the session.

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

startOperation

void startOperation()
                    throws java.io.IOException,
                           AutomationException
Starts an edit operation.

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

abortOperation

void abortOperation()
                    throws java.io.IOException,
                           AutomationException
Aborts an edit operation.

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

stopOperation

void stopOperation(java.lang.String menuText)
                   throws java.io.IOException,
                          AutomationException
Stops an edit operation.

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

undoOperation

void undoOperation()
                   throws java.io.IOException,
                          AutomationException
Undo an edit operation.

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

redoOperation

void redoOperation()
                   throws java.io.IOException,
                          AutomationException
Redo an edit operation.

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

enableUndoRedo

void enableUndoRedo(boolean enabled)
                    throws java.io.IOException,
                           AutomationException
Enable/disable the undo/redo capabilities.

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

delayEvents

void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException
Used to batch operations together and minimize notifications.

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

getEditSelection

IEnumFeature getEditSelection()
                              throws java.io.IOException,
                                     AutomationException
The selected features which are editable.

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

int getSelectionCount()
                      throws java.io.IOException,
                             AutomationException
The number of selected features which are editable.

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

findExtension

IExtension findExtension(IUID extensionID)
                         throws java.io.IOException,
                                AutomationException
Finds the extension given an id.

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

int getTaskCount()
                 throws java.io.IOException,
                        AutomationException
The number of edit tasks.

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

getTask

IEditTask getTask(int index)
                  throws java.io.IOException,
                         AutomationException
An edit task by index.

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

void setCurrentTaskByRef(IEditTask task)
                         throws java.io.IOException,
                                AutomationException
The current edit task.

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

IEditTask getCurrentTask()
                         throws java.io.IOException,
                                AutomationException
The current edit task.

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

IGeometry createSearchShape(IPoint point)
                            throws java.io.IOException,
                                   AutomationException
Creates a geometry using the point and the current search tolerance.

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

IEnumFeature searchSelection(IPoint point)
                             throws java.io.IOException,
                                    AutomationException
Searches the edit selection using the given location.

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

void invertAgent(IPoint loc,
                 int hdc)
                 throws java.io.IOException,
                        AutomationException
Draws the editor's snapping agent.

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

IAnchorPoint getSelectionAnchor()
                                throws java.io.IOException,
                                       AutomationException
The selection anchor point.

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

IPoint getLocation()
                   throws java.io.IOException,
                          AutomationException
The last known location of the mouse.

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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD