com.esri.arcgis.editor
Class IEditSketch3Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.editor.IEditSketchProxy
          extended by com.esri.arcgis.editor.IEditSketch2Proxy
              extended by com.esri.arcgis.editor.IEditSketch3Proxy
All Implemented Interfaces:
IEditSketch, IEditSketch2, IEditSketch3, Externalizable, Serializable

public class IEditSketch3Proxy
extends IEditSketch2Proxy
implements IEditSketch3, Serializable

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

Remarks

IEditSketch3 extends the functionality available on IEditSketch2 to support alternative methods for adding geometries to the edit sketch, and provides mechanisms to ensure the edit sketch geometry has appropriate z-values. Use this interface when manipulating or capturing z-aware features when you want to control the method of z-value assignment.

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
  IEditSketch3Proxy()
           
  IEditSketch3Proxy(Object obj)
           
protected IEditSketch3Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void clearSelectedVertices()
          Clears selected vertices.
 void clearWYSIWYGSketchSymbol()
          Clears the WYSIWYG Sketch symbol and its properties.
 int getSelectedVertexCount()
          The number of selected vertices.
 IShapeConstructor getShapeConstructor()
          The currently activated Shape Constructor.
 ISymbol getWYSIWYGSketchSymbol()
          The WYSIWYG symbol for the sketch.
 boolean isSketchSymbolIsWYSIWYG()
          Indicates whether the sketch symbol is WYSIWYG.
 boolean isSketchSymbolRespectsRefScale()
          Indicates whether the sketch symbol should respect the map's reference scale.
 boolean isVertexSelected(int part, int vertex)
          Is a vertex selected.
 void removeListener(String iidStr, Object theListener)
           
 void selectVertex(int part, int vertex)
          Selects a vertex.
 void setShapeConstructorByRef(IShapeConstructor shapeConstructor)
          The currently activated Shape Constructor.
 void setWYSIWYGSketchSymbol(ISymbol symbol, boolean isWYSIWYG, boolean respectsRefScale)
          The WYSIWYG Sketch symbol and its properties.
 void unselectVertex(int part, int vertex)
          Unselects a vertex.
 
Methods inherited from class com.esri.arcgis.editor.IEditSketch2Proxy
getCurrentZ, getEditSketchExtension, isMAware, isPartComplete, isZAware, setCurrentZ, setEditSketchExtensionByRef, setMAware, setZAware, vertexAdded, vertexDeleted, vertexMoved
 
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.IEditSketch2
getCurrentZ, getEditSketchExtension, isMAware, isPartComplete, isZAware, setCurrentZ, setEditSketchExtensionByRef, setMAware, setZAware, vertexAdded, vertexDeleted, vertexMoved
 
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

IEditSketch3Proxy

public IEditSketch3Proxy()

IEditSketch3Proxy

public IEditSketch3Proxy(Object obj)
                  throws IOException
Throws:
IOException

IEditSketch3Proxy

protected IEditSketch3Proxy(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 IEditSketch2Proxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class IEditSketch2Proxy
Throws:
IOException

isVertexSelected

public boolean isVertexSelected(int part,
                                int vertex)
                         throws IOException,
                                AutomationException
Is a vertex selected.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isVertexSelected in interface IEditSketch3
Parameters:
part - The part (in)
vertex - The vertex (in)
Returns:
The pbSelected
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearSelectedVertices

public void clearSelectedVertices()
                           throws IOException,
                                  AutomationException
Clears selected vertices.

Product Availability

Available with ArcGIS Desktop.

Specified by:
clearSelectedVertices in interface IEditSketch3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

selectVertex

public void selectVertex(int part,
                         int vertex)
                  throws IOException,
                         AutomationException
Selects a vertex.

Product Availability

Available with ArcGIS Desktop.

Specified by:
selectVertex in interface IEditSketch3
Parameters:
part - The part (in)
vertex - The vertex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unselectVertex

public void unselectVertex(int part,
                           int vertex)
                    throws IOException,
                           AutomationException
Unselects a vertex.

Product Availability

Available with ArcGIS Desktop.

Specified by:
unselectVertex in interface IEditSketch3
Parameters:
part - The part (in)
vertex - The vertex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedVertexCount

public int getSelectedVertexCount()
                           throws IOException,
                                  AutomationException
The number of selected vertices.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getSelectedVertexCount in interface IEditSketch3
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWYSIWYGSketchSymbol

public void setWYSIWYGSketchSymbol(ISymbol symbol,
                                   boolean isWYSIWYG,
                                   boolean respectsRefScale)
                            throws IOException,
                                   AutomationException
The WYSIWYG Sketch symbol and its properties.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setWYSIWYGSketchSymbol in interface IEditSketch3
Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
isWYSIWYG - The isWYSIWYG (in)
respectsRefScale - The respectsRefScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearWYSIWYGSketchSymbol

public void clearWYSIWYGSketchSymbol()
                              throws IOException,
                                     AutomationException
Clears the WYSIWYG Sketch symbol and its properties.

Product Availability

Available with ArcGIS Desktop.

Specified by:
clearWYSIWYGSketchSymbol in interface IEditSketch3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWYSIWYGSketchSymbol

public ISymbol getWYSIWYGSketchSymbol()
                               throws IOException,
                                      AutomationException
The WYSIWYG symbol for the sketch.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getWYSIWYGSketchSymbol in interface IEditSketch3
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSketchSymbolIsWYSIWYG

public boolean isSketchSymbolIsWYSIWYG()
                                throws IOException,
                                       AutomationException
Indicates whether the sketch symbol is WYSIWYG.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isSketchSymbolIsWYSIWYG in interface IEditSketch3
Returns:
The isWYSIWYG
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSketchSymbolRespectsRefScale

public boolean isSketchSymbolRespectsRefScale()
                                       throws IOException,
                                              AutomationException
Indicates whether the sketch symbol should respect the map's reference scale.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isSketchSymbolRespectsRefScale in interface IEditSketch3
Returns:
The respectsRefScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeConstructor

public IShapeConstructor getShapeConstructor()
                                      throws IOException,
                                             AutomationException
The currently activated Shape Constructor.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getShapeConstructor in interface IEditSketch3
Returns:
A reference to a com.esri.arcgis.editor.IShapeConstructor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShapeConstructorByRef

public void setShapeConstructorByRef(IShapeConstructor shapeConstructor)
                              throws IOException,
                                     AutomationException
The currently activated Shape Constructor.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setShapeConstructorByRef in interface IEditSketch3
Parameters:
shapeConstructor - A reference to a com.esri.arcgis.editor.IShapeConstructor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.