com.esri.arcgis.editor
Class IEditProperties4Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.editor.IEditProperties4Proxy
All Implemented Interfaces:
IEditProperties4, Externalizable, Serializable

public class IEditProperties4Proxy
extends com.esri.arcgis.interop.Dispatch
implements IEditProperties4, Serializable

Provides access to more members that control the properties of an edit session.

When To Use

The IEditProperties4 interface is used to control the z editing capabilities of the editor. Properties include: ZCaptureType, UseZFactor, ZFactor, UseZOffset, ZOffset, UseZDrapingTolerance, ZDrapingTolerance, Draping, Surface and ZSnapSymbol.

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
  IEditProperties4Proxy()
           
  IEditProperties4Proxy(Object obj)
           
protected IEditProperties4Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 boolean isClassicSnapping()
          Indicates whether the classic editing snapping will be used.
 boolean isShowConstructionToolbars()
          Indicates whether construction toolbars will be displayed while drawing a sketch.
 boolean isSnapToSketch()
          Indicates whether the sketch will be added to the snapping cache.
 boolean isUseWYSIWYGSketchSymbol()
          Indicates whether the sketch is drawn with WYSIWYG symbology.
 void removeListener(String iidStr, Object theListener)
           
 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 setClassicSnapping(boolean snap)
          Indicates whether the classic editing snapping will be used.
 void setShowConstructionToolbars(boolean showConstructionToolbars)
          Indicates whether construction toolbars will be displayed while drawing a sketch.
 void setSnapToSketch(boolean snap)
          Indicates whether the sketch will be added to the snapping cache.
 void setUseWYSIWYGSketchSymbol(boolean useWYSIWYGSketchSymbol)
          Indicates whether the sketch is drawn with WYSIWYG symbology.
 
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

noncastable

public boolean noncastable
Constructor Detail

IEditProperties4Proxy

public IEditProperties4Proxy()

IEditProperties4Proxy

public IEditProperties4Proxy(Object obj)
                      throws IOException
Throws:
IOException

IEditProperties4Proxy

protected IEditProperties4Proxy(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 com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

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

isUseWYSIWYGSketchSymbol

public boolean isUseWYSIWYGSketchSymbol()
                                 throws IOException,
                                        AutomationException
Indicates whether the sketch is drawn with WYSIWYG symbology.

Remarks

This property determines whether or not the feature being edited or created is drawn using the rendererís symbol, or the classic edit sketch symbology.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isUseWYSIWYGSketchSymbol in interface IEditProperties4
Returns:
The useWYSIWYGSketchSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseWYSIWYGSketchSymbol

public void setUseWYSIWYGSketchSymbol(boolean useWYSIWYGSketchSymbol)
                               throws IOException,
                                      AutomationException
Indicates whether the sketch is drawn with WYSIWYG symbology.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setUseWYSIWYGSketchSymbol in interface IEditProperties4
Parameters:
useWYSIWYGSketchSymbol - The useWYSIWYGSketchSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isClassicSnapping

public boolean isClassicSnapping()
                          throws IOException,
                                 AutomationException
Indicates whether the classic editing snapping will be used.

Remarks

Setting this property to true enables classic snapping (ArcGIS 9.3.1 and prior versions snapping environment UI).

In the UI this is set in the general tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isClassicSnapping in interface IEditProperties4
Returns:
The snap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClassicSnapping

public void setClassicSnapping(boolean snap)
                        throws IOException,
                               AutomationException
Indicates whether the classic editing snapping will be used.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setClassicSnapping in interface IEditProperties4
Parameters:
snap - The snap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSnapToSketch

public boolean isSnapToSketch()
                       throws IOException,
                              AutomationException
Indicates whether the sketch will be added to the snapping cache. It is used when not using classic snapping.

Remarks

Setting this property to true adds the sketch to the snapping cache.

In the UI this property is set via the Snap to Sketch menu item on the Snapping toolbar.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isSnapToSketch in interface IEditProperties4
Returns:
The snap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSnapToSketch

public void setSnapToSketch(boolean snap)
                     throws IOException,
                            AutomationException
Indicates whether the sketch will be added to the snapping cache. It is used when not using classic snapping.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setSnapToSketch in interface IEditProperties4
Parameters:
snap - The snap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowConstructionToolbars

public boolean isShowConstructionToolbars()
                                   throws IOException,
                                          AutomationException
Indicates whether construction toolbars will be displayed while drawing a sketch.

Remarks

Setting this property to true will display the construction mini toolbar during sketch construction.

In the UI this is set in the General tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isShowConstructionToolbars in interface IEditProperties4
Returns:
The showConstructionToolbars
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowConstructionToolbars

public void setShowConstructionToolbars(boolean showConstructionToolbars)
                                 throws IOException,
                                        AutomationException
Indicates whether construction toolbars will be displayed while drawing a sketch.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setShowConstructionToolbars in interface IEditProperties4
Parameters:
showConstructionToolbars - The showConstructionToolbars (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveSketchVertexSymbol

public IMarkerSymbol getActiveSketchVertexSymbol()
                                          throws IOException,
                                                 AutomationException
Symbol used to draw the selected vertices of the edit sketch.

Remarks

Use this property to change the symbology of the selected vertices in the edit sketch. By default, selected edit sketch vertices are drawn as hollow green squares.

In the UI this is set in the general tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getActiveSketchVertexSymbol in interface IEditProperties4
Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IEditProperties.getSketchVertexSymbol(), IEditProperties.getSketchSymbol()

setActiveSketchVertexSymbolByRef

public void setActiveSketchVertexSymbolByRef(IMarkerSymbol symbol)
                                      throws IOException,
                                             AutomationException
Symbol used to draw the selected vertices of the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setActiveSketchVertexSymbolByRef in interface IEditProperties4
Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveSelectedVertexSymbol

public IMarkerSymbol getActiveSelectedVertexSymbol()
                                            throws IOException,
                                                   AutomationException
Symbol used to draw the selected active vertex of the edit sketch.

Remarks

Use this property to change the symbology of the last point in the edit sketch when it is selected. By default this point is drawn as a red hollow square.

In the UI this is set in the general tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getActiveSelectedVertexSymbol in interface IEditProperties4
Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IEditProperties.getSketchVertexSymbol(), IEditProperties.getSketchSymbol()

setActiveSelectedVertexSymbolByRef

public void setActiveSelectedVertexSymbolByRef(IMarkerSymbol symbol)
                                        throws IOException,
                                               AutomationException
Symbol used to draw the selected active vertex of the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setActiveSelectedVertexSymbolByRef in interface IEditProperties4
Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.