com.esri.arcgis.editor
Class SketchOperation

java.lang.Object
  extended by com.esri.arcgis.editor.SketchOperation
All Implemented Interfaces:
ISketchOperation, ISketchOperation2, com.esri.arcgis.interop.RemoteObjRef, IOperation, java.io.Serializable

public class SketchOperation
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISketchOperation, IOperation, ISketchOperation2

COM Class 'SketchOperation'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description 'Provides undo/redo capabilities for edit sketch modifications.' 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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.editor.ISketchOperation
IID, IID6d3a6f61_9115_11d1_8461_0000f875b9c6, xxDummy
 
Fields inherited from interface com.esri.arcgis.systemUI.IOperation
IID80a807ab_7bb9_11d0_87ec_080009ec732a
 
Fields inherited from interface com.esri.arcgis.editor.ISketchOperation2
IID, IID223ee90f_0d7d_4844_9f01_a62cb7407897, xxDummy
 
Constructor Summary
SketchOperation()
          Constructs a SketchOperation using ArcGIS Engine.
SketchOperation(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SketchOperation theSketchOperation = (SketchOperation) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 void esri_do()
          Performs the operation.
 void finish(IEnvelope invalEnv)
          Finishes the operation and puts it into the operation stack.
 void finish(IEnvelope invalEnv, int opType, java.lang.Object data)
          Finishes the operation and puts it into the operation stack.
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getMenuString()
          The menu string.
 int hashCode()
          the hashcode for this object
 boolean isCanRedo()
          Indicates if the operation can be redone.
 boolean isCanUndo()
          Indicates if the operation can be undone.
 void redo()
          Redoes the operation.
 void release()
          Release a SketchOperation.
 void setMenuString(java.lang.String rhs1)
          The text that appears in the undo menu choice.
 void start(IEditor editor)
          Starts the operation, caching the existing sketch.
 void undo()
          Undoes the operation.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SketchOperation

public SketchOperation()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a SketchOperation using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SketchOperation

public SketchOperation(java.lang.Object obj)
                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SketchOperation theSketchOperation = (SketchOperation) obj;

Construct a SketchOperation using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SketchOperation.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a SketchOperation.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setMenuString

public void setMenuString(java.lang.String rhs1)
                   throws java.io.IOException,
                          AutomationException
The text that appears in the undo menu choice.

Specified by:
setMenuString in interface ISketchOperation
Specified by:
setMenuString in interface ISketchOperation2
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

start

public void start(IEditor editor)
           throws java.io.IOException,
                  AutomationException
Starts the operation, caching the existing sketch. Call this before modifying the sketch.

Specified by:
start in interface ISketchOperation
Specified by:
start in interface ISketchOperation2
Parameters:
editor - A reference to a com.esri.arcgis.editor.IEditor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finish

public void finish(IEnvelope invalEnv)
            throws java.io.IOException,
                   AutomationException
Finishes the operation and puts it into the operation stack. Call this after the sketch has been modified.

Specified by:
finish in interface ISketchOperation
Parameters:
invalEnv - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMenuString

public java.lang.String getMenuString()
                               throws java.io.IOException,
                                      AutomationException
The menu string.

Specified by:
getMenuString in interface IOperation
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUndo

public boolean isCanUndo()
                  throws java.io.IOException,
                         AutomationException
Indicates if the operation can be undone.

Specified by:
isCanUndo in interface IOperation
Returns:
The result
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanRedo

public boolean isCanRedo()
                  throws java.io.IOException,
                         AutomationException
Indicates if the operation can be redone.

Specified by:
isCanRedo in interface IOperation
Returns:
The result
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_do

public void esri_do()
             throws java.io.IOException,
                    AutomationException
Performs the operation.

Specified by:
esri_do in interface IOperation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

undo

public void undo()
          throws java.io.IOException,
                 AutomationException
Undoes the operation.

Specified by:
undo in interface IOperation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

redo

public void redo()
          throws java.io.IOException,
                 AutomationException
Redoes the operation.

Specified by:
redo in interface IOperation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finish

public void finish(IEnvelope invalEnv,
                   int opType,
                   java.lang.Object data)
            throws java.io.IOException,
                   AutomationException
Finishes the operation and puts it into the operation stack. Call this after the sketch has been modified.

Specified by:
finish in interface ISketchOperation2
Parameters:
invalEnv - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
opType - A com.esri.arcgis.editor.esriSketchOperationType constant (in)
data - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.