com.esri.arcgis.editor
Class IEditor3Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.editor.IEditorProxy
          com.esri.arcgis.editor.IEditor2Proxy
              com.esri.arcgis.editor.IEditor3Proxy

All Implemented Interfaces:

IEditor, IEditor2, IEditor3, Externalizable, Serializable

public class IEditor3Proxy
extends IEditor2Proxy
implements IEditor3, Serializable

Provides access to methods that extend the IEditor interface. The additional members control the behavior of the template construction and snapping.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	addTemplates(IArray editTemplateArray) Adds the specified edit template.
IEditTemplate	getCurrentTemplate() The current edit template.
IEditTemplate	getTemplate(int index) The edit template for the specified index.
int	getTemplateCount() The number of edit templates.
void	removeAllTemplatesInLayer(ILayer layer) Removes all templates from the specified layer.
void	removeAllTemplatesInMap(IMap map) Removes all templates from the specified map.
void	removeListener(String iidStr, Object theListener)
void	removeTemplate(IEditTemplate editTemplate) Removes the specified edit template.
void	setCurrentTemplateByRef(IEditTemplate editTemplate) The current edit template.
void	templateModified(IEditTemplate editTemplate) Broadcasts the change to the rest of the system.

Methods inherited from class com.esri.arcgis.editor.IEditor2Proxy

getAuxiliarySelectionAnchor, isAuxiliarySelectionAnchorEnabled, resetAuxiliarySelectionAnchorLocation, setAuxiliarySelectionAnchorEnabled

Methods inherited from class com.esri.arcgis.editor.IEditorProxy

abortOperation, createSearchShape, delayEvents, enableUndoRedo, findExtension, getCurrentTask, getDisplay, getEditSelection, getEditState, getEditWorkspace, getLocation, getMap, getParent, getScratchWorkspace, getSelectionAnchor, getSelectionCount, getTask, getTaskCount, hasEdits, invertAgent, redoOperation, searchSelection, setCurrentTaskByRef, startEditing, startOperation, stopEditing, stopOperation, undoOperation

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

Methods inherited from interface com.esri.arcgis.editor.IEditor2

getAuxiliarySelectionAnchor, isAuxiliarySelectionAnchorEnabled, resetAuxiliarySelectionAnchorLocation, setAuxiliarySelectionAnchorEnabled

Methods inherited from interface com.esri.arcgis.editor.IEditor

abortOperation, createSearchShape, delayEvents, enableUndoRedo, findExtension, getCurrentTask, getDisplay, getEditSelection, getEditState, getEditWorkspace, getLocation, getMap, getParent, getScratchWorkspace, getSelectionAnchor, getSelectionCount, getTask, getTaskCount, hasEdits, invertAgent, redoOperation, searchSelection, setCurrentTaskByRef, startEditing, startOperation, stopEditing, stopOperation, undoOperation

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IEditor3Proxy

public IEditor3Proxy()

IEditor3Proxy

public IEditor3Proxy(Object obj)
              throws IOException

Throws:

IOException

IEditor3Proxy

protected IEditor3Proxy(Object obj,
                        String iid)
                 throws IOException

Throws:

IOException

Method Detail

addListener

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

Overrides:

addListener in class IEditor2Proxy

Throws:

IOException

removeListener

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

Overrides:

removeListener in class IEditor2Proxy

Throws:

IOException

getTemplateCount

public int getTemplateCount()
                     throws IOException,
                            AutomationException

The number of edit templates.

Remarks

This method returns the total number of templates for all layers within the current edit workspace. The returned value will be 0 if you are not in an edit session. To examine templates for layers outside an edit session refer to IEditTemplateManager in the Carto assembly.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTemplateCount in interface IEditor3

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplate

public IEditTemplate getTemplate(int index)
                          throws IOException,
                                 AutomationException

The edit template for the specified index.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTemplate in interface IEditor3

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTemplates

public void addTemplates(IArray editTemplateArray)
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Specified by:

addTemplates in interface IEditor3

Parameters:

editTemplateArray - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTemplate

public void removeTemplate(IEditTemplate editTemplate)
                    throws IOException,
                           AutomationException

Removes the specified edit template.

Product Availability

Available with ArcGIS Desktop.

Specified by:

removeTemplate in interface IEditor3

Parameters:

editTemplate - A reference to a com.esri.arcgis.carto.IEditTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllTemplatesInLayer

public void removeAllTemplatesInLayer(ILayer layer)
                               throws IOException,
                                      AutomationException

Removes all templates from the specified layer.

Product Availability

Available with ArcGIS Desktop.

Specified by:

removeAllTemplatesInLayer in interface IEditor3

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllTemplatesInMap

public void removeAllTemplatesInMap(IMap map)
                             throws IOException,
                                    AutomationException

Removes all templates from the specified map.

Product Availability

Available with ArcGIS Desktop.

Specified by:

removeAllTemplatesInMap in interface IEditor3

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTemplate

public IEditTemplate getCurrentTemplate()
                                 throws IOException,
                                        AutomationException

The current edit template.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getCurrentTemplate in interface IEditor3

Returns:

A reference to a com.esri.arcgis.carto.IEditTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentTemplateByRef

public void setCurrentTemplateByRef(IEditTemplate editTemplate)
                             throws IOException,
                                    AutomationException

The current edit template.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setCurrentTemplateByRef in interface IEditor3

Parameters:

editTemplate - A reference to a com.esri.arcgis.carto.IEditTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

templateModified

public void templateModified(IEditTemplate editTemplate)
                      throws IOException,
                             AutomationException

Broadcasts the change to the rest of the system.

Product Availability

Available with ArcGIS Desktop.

Specified by:

templateModified in interface IEditor3

Parameters:

editTemplate - A reference to a com.esri.arcgis.carto.IEditTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.