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.controls
Interface IEngineEditor

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IEngineEditor2
All Known Implementing Classes:
EngineEditor, IEngineEditor2Proxy, IEngineEditorProxy
public interface IEngineEditor
extends java.io.Serializable

COM Interface 'IEngineEditor'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the behavior of the EngineEditor.' 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 IID9ae024af_2bae_4b4c_927f_8e6ff0ab55bd
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void abortOperation()
          Aborts an edit operation.
 void addTask(IEngineEditTask task)
          Adds a task to the EngineEditor.
 void enableUndoRedo(boolean enabled)
          Indicates if undo/redo capabilities are enabled.
 IEngineEditTask getCurrentTask()
          The current edit task.
 IEnumFeature getEditSelection()
          The selected features that are editable.
 int getEditSessionMode()
          The current edit session mode.
 int getEditState()
          The EngineEditor's current edit state.
 IWorkspace getEditWorkspace()
          The workspace being edited.
 IMap getMap()
          The map being edited.
 int getSelectionCount()
          The number of selected features that are editable.
 IEngineEditTask getTask(int index)
          The edit task at the specified index.
 IEngineEditTask getTaskByUniqueName(java.lang.String uniqueName)
          Retrieves a task by UniqueName from the EngineEditor.
 int getTaskCount()
          The number of edit tasks.
 boolean hasEdits()
          Indicates if edits have been made.
 void invertAgent(IPoint location, int hdc)
          Draws the EngineEditor's snapping agent.
 void setCurrentTaskByRef(IEngineEditTask task)
          The current edit task.
 void setEditSessionMode(int mode)
          The current edit session mode.
 void startEditing(IWorkspace workspace, IMap map)
          Starts an edit session.
 void startOperation()
          Starts an edit operation.
 void stopEditing(boolean saveChanges)
          Stops an edit session.
 void stopOperation(java.lang.String operationName)
          Stops an edit operation.
 

Field Detail

IID9ae024af_2bae_4b4c_927f_8e6ff0ab55bd

static final int IID9ae024af_2bae_4b4c_927f_8e6ff0ab55bd
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

getEditState

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

Returns:
A com.esri.arcgis.controls.esriEngineEditState constant
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
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.

startEditing

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

Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
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.

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 if edits have been made.

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 operationName)
                   throws java.io.IOException,
                          AutomationException
Stops an edit operation.

Parameters:
operationName - The operationName (in)
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
Indicates if undo/redo capabilities are enabled.

Parameters:
enabled - The enabled (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 that 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 that are editable.

Returns:
The selection
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

IEngineEditTask getTask(int index)
                        throws java.io.IOException,
                               AutomationException
The edit task at the specified index.

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

setCurrentTaskByRef

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

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

getCurrentTask

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

Returns:
A reference to a com.esri.arcgis.controls.IEngineEditTask
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
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.

invertAgent

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

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

addTask

void addTask(IEngineEditTask task)
             throws java.io.IOException,
                    AutomationException
Adds a task to the EngineEditor.

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

getTaskByUniqueName

IEngineEditTask getTaskByUniqueName(java.lang.String uniqueName)
                                    throws java.io.IOException,
                                           AutomationException
Retrieves a task by UniqueName from the EngineEditor.

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

setEditSessionMode

void setEditSessionMode(int mode)
                        throws java.io.IOException,
                               AutomationException
The current edit session mode.

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

getEditSessionMode

int getEditSessionMode()
                       throws java.io.IOException,
                              AutomationException
The current edit session mode.

Returns:
A com.esri.arcgis.controls.esriEngineEditSessionMode constant
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