com.esri.arcgis.editor
Class DigitizerExtension

java.lang.Object
  extended by com.esri.arcgis.editor.DigitizerExtension
All Implemented Interfaces:
IDigitizerButtons, IDigitizerSetup, com.esri.arcgis.interop.RemoteObjRef, IExtension, java.io.Serializable

public class DigitizerExtension
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IExtension, IDigitizerSetup, IDigitizerButtons

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

Description 'Extension for working with the digitizer.' 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.system.IExtension
IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy
 
Fields inherited from interface com.esri.arcgis.editor.IDigitizerSetup
IID, IIDd319724c_db13_11d2_9f26_00c04f6bc979, xxDummy
 
Fields inherited from interface com.esri.arcgis.editor.IDigitizerButtons
IID, IIDd319724d_db13_11d2_9f26_00c04f6bc979, xxDummy
 
Constructor Summary
DigitizerExtension(java.lang.Object obj)
          Construct a DigitizerExtension using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void addControlPoint(double xDigitizer, double yDigitizer, double xMap, double yMap)
          Adds a control point to the transformation.
 void clearControlPoints()
          Removes all control points.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IUID getButton(int button)
          Button to map on the digitizer puck.
 void getControlPoint(int index, double[] xDigitizer, double[] yDigitizer, double[] xMap, double[] yMap)
          A control point's X,Y coordinates in Digitizer and Map units.
 int getControlPointCount()
          The number of control points used for digitizing.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          The name of the extension.
 ITransformation getTransformation()
          The transformation used by the digitizer.
 int hashCode()
          the hashcode for this object
 void release()
          Release a DigitizerExtension.
 void setButton(int button, IUID cmdID)
          Button to map on the digitizer puck.
 void setTransformationByRef(ITransformation transform)
          The transformation used by the digitizer.
 void shutdown()
          Shuts down the extension.
 void startup(java.lang.Object initializationData)
          Starts up the extension with the given initialization data.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DigitizerExtension

public DigitizerExtension(java.lang.Object obj)
                   throws java.io.IOException
Construct a DigitizerExtension using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DigitizerExtension.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
DigitizerExtension o = (DigitizerExtension)obj; // will not work

DigitizerExtension o = new DigitizerExtension(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems DigitizerExtension theDigitizerExtension = (DigitizerExtension) obj;
Method Detail

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

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the extension.

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

startup

public void startup(java.lang.Object initializationData)
             throws java.io.IOException,
                    AutomationException
Starts up the extension with the given initialization data.

Specified by:
startup in interface IExtension
Parameters:
initializationData - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws java.io.IOException,
                     AutomationException
Shuts down the extension.

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

setTransformationByRef

public void setTransformationByRef(ITransformation transform)
                            throws java.io.IOException,
                                   AutomationException
The transformation used by the digitizer.

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

getTransformation

public ITransformation getTransformation()
                                  throws java.io.IOException,
                                         AutomationException
The transformation used by the digitizer.

Specified by:
getTransformation in interface IDigitizerSetup
Returns:
A reference to a com.esri.arcgis.geometry.ITransformation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getControlPointCount

public int getControlPointCount()
                         throws java.io.IOException,
                                AutomationException
The number of control points used for digitizing.

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

clearControlPoints

public void clearControlPoints()
                        throws java.io.IOException,
                               AutomationException
Removes all control points.

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

getControlPoint

public void getControlPoint(int index,
                            double[] xDigitizer,
                            double[] yDigitizer,
                            double[] xMap,
                            double[] yMap)
                     throws java.io.IOException,
                            AutomationException
A control point's X,Y coordinates in Digitizer and Map units.

Specified by:
getControlPoint in interface IDigitizerSetup
Parameters:
index - The index (in)
xDigitizer - The xDigitizer (out: use single element array)
yDigitizer - The yDigitizer (out: use single element array)
xMap - The xMap (out: use single element array)
yMap - The yMap (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addControlPoint

public void addControlPoint(double xDigitizer,
                            double yDigitizer,
                            double xMap,
                            double yMap)
                     throws java.io.IOException,
                            AutomationException
Adds a control point to the transformation.

Specified by:
addControlPoint in interface IDigitizerSetup
Parameters:
xDigitizer - The xDigitizer (in)
yDigitizer - The yDigitizer (in)
xMap - The xMap (in)
yMap - The yMap (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setButton

public void setButton(int button,
                      IUID cmdID)
               throws java.io.IOException,
                      AutomationException
Button to map on the digitizer puck.

Specified by:
setButton in interface IDigitizerButtons
Parameters:
button - The button (in)
cmdID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getButton

public IUID getButton(int button)
               throws java.io.IOException,
                      AutomationException
Button to map on the digitizer puck.

Specified by:
getButton in interface IDigitizerButtons
Parameters:
button - The button (in)
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.