com.esri.arcgis.editor
Class IEditSketch2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.editor.IEditSketchProxy
          com.esri.arcgis.editor.IEditSketch2Proxy

All Implemented Interfaces:

IEditSketch, IEditSketch2, Externalizable, Serializable

Direct Known Subclasses:

IEditSketch3Proxy

public class IEditSketch2Proxy
extends IEditSketchProxy
implements IEditSketch2, Serializable

Provides access to members that access and manipulate the edit sketch.

Superseded By

IEditSketch3

Remarks

The IEditSketch2 interface is on the Editor CoClass.

When To Use

IEditSketch2 extends the functionality of the edit sketch by adding support for making the sketch z-aware and for setting Z values on a vertex as well as managing the current EditSketchExtension. IEditSketch2 also has three functions that fire event notifications when vertices are added, modified, or deleted. For example, whenever a vertex is deleted from an edit sketch, VertexDeleted should be called so that any clients listening for this event can respond.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
double	getCurrentZ() Current Z value for the edit sketch.
IEditSketchExtension	getEditSketchExtension() The current edit sketch extension.
boolean	isMAware() Indicates if the edit sketch geometry will contain Ms.
boolean	isPartComplete() Indicates whether FinishPart has been called on the edit sketch.
boolean	isZAware() Indicates if the edit sketch geometry will contain Zs.
void	removeListener(String iidStr, Object theListener)
void	setCurrentZ(double z) Current Z value for the edit sketch.
void	setEditSketchExtensionByRef(IEditSketchExtension extension) The current edit sketch extension.
void	setMAware(boolean aware) Indicates if the edit sketch geometry will contain Ms.
void	setZAware(boolean aware) Indicates if the edit sketch geometry will contain Zs.
void	vertexAdded(IPoint point) Call to notify listeners that a sketch vertex has been added.
void	vertexDeleted(IPoint point) Call to notify listeners that a sketch vertex has been deleted.
void	vertexMoved(IPoint point) Call to notify listeners that a sketch vertex has been moved.

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

addPoint, finishSketch, finishSketchPart, getGeometry, getGeometryType, getLastPoint, getPart, getSegment, getVertex, modifySketch, refreshSketch, setGeometryByRef, setGeometryType

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.IEditSketch

addPoint, finishSketch, finishSketchPart, getGeometry, getGeometryType, getLastPoint, getPart, getSegment, getVertex, modifySketch, refreshSketch, setGeometryByRef, setGeometryType

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IEditSketch2Proxy

public IEditSketch2Proxy()

IEditSketch2Proxy

public IEditSketch2Proxy(Object obj)
                  throws IOException

Throws:

IOException

IEditSketch2Proxy

protected IEditSketch2Proxy(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 IEditSketchProxy

Throws:

IOException

removeListener

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

Overrides:

removeListener in class IEditSketchProxy

Throws:

IOException

isZAware

public boolean isZAware()
                 throws IOException,
                        AutomationException

Indicates if the edit sketch geometry will contain Zs.

Remarks

If the EditSketch geometry contains elevation (z) values, the ZAware property will return a boolean value of True.

To view the z values for the edit sketch right click over a sketch segment and display the edit sketch properties dialog. If the sketch is ZAware, an additional column will appear next to the y column showing the z values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isZAware in interface IEditSketch2

Returns:

The aware

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZAware

public void setZAware(boolean aware)
               throws IOException,
                      AutomationException

Indicates if the edit sketch geometry will contain Zs.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setZAware in interface IEditSketch2

Parameters:

aware - The aware (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentZ

public double getCurrentZ()
                   throws IOException,
                          AutomationException

Current Z value for the edit sketch.

Remarks

The CurrentZ property returns or sets the Z value that is applied to all points added to the sketch.

To view the z values for the edit sketch right click over a sketch segment and display the properties dialog. If the sketch is ZAware, an additional column will appear next to the y column showing the z values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCurrentZ in interface IEditSketch2

Returns:

The z

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentZ

public void setCurrentZ(double z)
                 throws IOException,
                        AutomationException

Current Z value for the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCurrentZ in interface IEditSketch2

Parameters:

z - The z (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEditSketchExtensionByRef

public void setEditSketchExtensionByRef(IEditSketchExtension extension)
                                 throws IOException,
                                        AutomationException

The current edit sketch extension.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setEditSketchExtensionByRef in interface IEditSketch2

Parameters:

extension - A reference to a com.esri.arcgis.editor.IEditSketchExtension (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEditSketchExtension

public IEditSketchExtension getEditSketchExtension()
                                            throws IOException,
                                                   AutomationException

The current edit sketch extension.

Remarks

Returns the current edit sketch extension. Dimensions and Geodatabase annotation features utilize edit sketch extensions when creating and modifying their geometry.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getEditSketchExtension in interface IEditSketch2

Returns:

A reference to a com.esri.arcgis.editor.IEditSketchExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vertexAdded

public void vertexAdded(IPoint point)
                 throws IOException,
                        AutomationException

Call to notify listeners that a sketch vertex has been added.

Remarks

When IEditSketch2::VertexAdded is called, all clients listening to IEditEvents2::OnVertexAdded are notified. This may be used to ensure the maximum number of points in a particular sketch is not exceeded.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

vertexAdded in interface IEditSketch2

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vertexDeleted

public void vertexDeleted(IPoint point)
                   throws IOException,
                          AutomationException

Call to notify listeners that a sketch vertex has been deleted.

Remarks

When IEditSketch2::VertexDeleted is called, all clients listening to IEditEvents2::OnVertexDeleted are notified. This may be used to ensure the minimum number of points in a particular sketch is not exceeded.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

vertexDeleted in interface IEditSketch2

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vertexMoved

public void vertexMoved(IPoint point)
                 throws IOException,
                        AutomationException

Call to notify listeners that a sketch vertex has been moved.

Remarks

When IEditSketch2::VertexMoved is called, all clients listening to IEditEvents2::OnVertexMoved are notified.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

vertexMoved in interface IEditSketch2

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMAware

public boolean isMAware()
                 throws IOException,
                        AutomationException

Indicates if the edit sketch geometry will contain Ms.

Remarks

If the EditSketch geometry contains measures (Ms), the MAware property will return a boolean value of True.

To view the m values for the edit sketch right click over a sketch segment and display the properties dialog. If the sketch is MAware, an additional column will appear to the right showing the m values.

If the edit sketch is m-aware, all newly inserted vertices will have a value of NaN. Inserting an m-aware sketch into a feature that is not m-aware will return an error.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isMAware in interface IEditSketch2

Returns:

The aware

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMAware

public void setMAware(boolean aware)
               throws IOException,
                      AutomationException

Indicates if the edit sketch geometry will contain Ms.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setMAware in interface IEditSketch2

Parameters:

aware - The aware (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPartComplete

public boolean isPartComplete()
                       throws IOException,
                              AutomationException

Indicates whether FinishPart has been called on the edit sketch.

Remarks

Use this property to determine when the current part of the sketch is finished.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isPartComplete in interface IEditSketch2

Returns:

The complete

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.