com.esri.arcgis.editor
Class IEditorProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.editor.IEditorProxy
All Implemented Interfaces:
IEditor, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IEditor2Proxy

public class IEditorProxy
extends com.esri.arcgis.interop.Dispatch
implements IEditor, java.io.Serializable

Internal use class Proxy for 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 =

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.editor.IEditor
IID, IID2866e6b0_c00b_11d0_802b_0000f8037368
 
Constructor Summary
  IEditorProxy()
          For internal use only
  IEditorProxy(java.lang.Object obj)
           
protected IEditorProxy(java.lang.Object obj, java.lang.String iid)
           
  IEditorProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IEditorProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void abortOperation()
          Aborts an edit operation.
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 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.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 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.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IEditorProxy

public IEditorProxy(java.lang.String CLSID,
                    java.lang.String host,
                    com.esri.arcgis.interop.AuthInfo authInfo)
             throws java.net.UnknownHostException,
                    java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IEditorProxy

public IEditorProxy()
For internal use only


IEditorProxy

public IEditorProxy(java.lang.Object obj)
             throws java.io.IOException
Throws:
java.io.IOException

IEditorProxy

protected IEditorProxy(java.lang.Object obj,
                       java.lang.String iid)
                throws java.io.IOException
Throws:
java.io.IOException

IEditorProxy

protected IEditorProxy(java.lang.String CLSID,
                       java.lang.String iid,
                       java.lang.String host,
                       com.esri.arcgis.interop.AuthInfo authInfo)
                throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

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.