com.esri.arcgis.editor
Class SketchConstructor

java.lang.Object
  extended by com.esri.arcgis.editor.SketchConstructor
All Implemented Interfaces:
IShapeConstructor, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class SketchConstructor
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IShapeConstructor

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

Description 'Constructor for the Sketch Tool.' 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.IShapeConstructor
IID, IID14a69cae_fea8_4b8d_a5b4_03ecbedd11b6, xxDummy
 
Constructor Summary
SketchConstructor()
          Constructs a SketchConstructor using ArcGIS Engine.
SketchConstructor(java.lang.Object obj)
          Construct a SketchConstructor using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void activate()
          Prepares a shape constructor to begin receiving events.
 void addPoint(IPoint point, boolean esri_clone, boolean allowUndo)
          Adds a point to the sketch.
 void deactivate()
          Resets a shape constructor.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IPoint getAnchor()
          The anchor of the sketch.
 double getAngleConstraint()
          The sketch's angular constraint.
static java.lang.String getClsid()
          getClsid.
 int getConstraint()
          The sketch constraint.
 int getCursor()
          The mouse pointer for this constructor.
 double getDistanceConstraint()
          The sketch's distance constraint.
 java.lang.String getID()
          Name string identifying this shape constructor.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IPoint getLocation()
          The current location of the mouse.
 int hashCode()
          the hashcode for this object
 void initialize(IEditor pEditor)
          Initializes a newly constructed shape constructor.
 boolean isActive()
          Indicates whether the constructor is currently active.
 boolean isEnabled()
          Indicates whether the constructor is enabled.
 boolean isStreaming()
          Indicates whether stream mode digitizing is enabled.
 boolean onContextMenu(int x, int y)
          Context menu event occured at the given xy location.
 void onKeyDown(int keyState, int shift)
          Occurs when a key on the keyboard is pressed when this constructor is active.
 void onKeyUp(int keyState, int shift)
          Occurs when a key on the keyboard is released when this constructor is active.
 void onMouseDown(int button, int shift, int x, int y)
          Occurs when a mouse button is pressed when this constructor is active.
 void onMouseMove(int button, int shift, int x, int y)
          Occurs when the mouse is moved when this constructor is active.
 void onMouseUp(int button, int shift, int x, int y)
          Occurs when a mouse button is released when this constructor is active.
 void refresh(int hdc)
          Occurs when a screen display in the application is refreshed.
 void release()
          Release a SketchConstructor.
 void setAngleConstraint(double val)
          The sketch's angular constraint.
 void setConstraint(int constraint)
          The sketch constraint.
 void setDistanceConstraint(double val)
          The sketch's distance constraint.
 void setIsStreaming(boolean isStreaming)
          Indicates whether stream mode digitizing is enabled.
 void sketchModified()
          Called when Sketch is modified.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SketchConstructor

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

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

SketchConstructor

public SketchConstructor(java.lang.Object obj)
                  throws java.io.IOException
Construct a SketchConstructor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SketchConstructor.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems SketchConstructor theSketchConstructor = (SketchConstructor) obj;
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 SketchConstructor.

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

initialize

public void initialize(IEditor pEditor)
                throws java.io.IOException,
                       AutomationException
Initializes a newly constructed shape constructor.

Specified by:
initialize in interface IShapeConstructor
Parameters:
pEditor - 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.

getID

public java.lang.String getID()
                       throws java.io.IOException,
                              AutomationException
Name string identifying this shape constructor.

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

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException
Indicates whether the constructor is enabled.

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

activate

public void activate()
              throws java.io.IOException,
                     AutomationException
Prepares a shape constructor to begin receiving events.

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

deactivate

public void deactivate()
                throws java.io.IOException,
                       AutomationException
Resets a shape constructor.

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

isActive

public boolean isActive()
                 throws java.io.IOException,
                        AutomationException
Indicates whether the constructor is currently active.

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

onMouseDown

public void onMouseDown(int button,
                        int shift,
                        int x,
                        int y)
                 throws java.io.IOException,
                        AutomationException
Occurs when a mouse button is pressed when this constructor is active.

Specified by:
onMouseDown in interface IShapeConstructor
Parameters:
button - The button (in)
shift - The shift (in)
x - The x (in)
y - The y (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onMouseMove

public void onMouseMove(int button,
                        int shift,
                        int x,
                        int y)
                 throws java.io.IOException,
                        AutomationException
Occurs when the mouse is moved when this constructor is active.

Specified by:
onMouseMove in interface IShapeConstructor
Parameters:
button - The button (in)
shift - The shift (in)
x - The x (in)
y - The y (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onMouseUp

public void onMouseUp(int button,
                      int shift,
                      int x,
                      int y)
               throws java.io.IOException,
                      AutomationException
Occurs when a mouse button is released when this constructor is active.

Specified by:
onMouseUp in interface IShapeConstructor
Parameters:
button - The button (in)
shift - The shift (in)
x - The x (in)
y - The y (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onKeyDown

public void onKeyDown(int keyState,
                      int shift)
               throws java.io.IOException,
                      AutomationException
Occurs when a key on the keyboard is pressed when this constructor is active.

Specified by:
onKeyDown in interface IShapeConstructor
Parameters:
keyState - The keyState (in)
shift - The shift (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onKeyUp

public void onKeyUp(int keyState,
                    int shift)
             throws java.io.IOException,
                    AutomationException
Occurs when a key on the keyboard is released when this constructor is active.

Specified by:
onKeyUp in interface IShapeConstructor
Parameters:
keyState - The keyState (in)
shift - The shift (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onContextMenu

public boolean onContextMenu(int x,
                             int y)
                      throws java.io.IOException,
                             AutomationException
Context menu event occured at the given xy location.

Specified by:
onContextMenu in interface IShapeConstructor
Parameters:
x - The x (in)
y - The y (in)
Returns:
The handled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(int hdc)
             throws java.io.IOException,
                    AutomationException
Occurs when a screen display in the application is refreshed.

Specified by:
refresh in interface IShapeConstructor
Parameters:
hdc - The hdc (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCursor

public int getCursor()
              throws java.io.IOException,
                     AutomationException
The mouse pointer for this constructor.

Specified by:
getCursor in interface IShapeConstructor
Returns:
The cursor (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnchor

public IPoint getAnchor()
                 throws java.io.IOException,
                        AutomationException
The anchor of the sketch.

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

getLocation

public IPoint getLocation()
                   throws java.io.IOException,
                          AutomationException
The current location of the mouse.

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

getConstraint

public int getConstraint()
                  throws java.io.IOException,
                         AutomationException
The sketch constraint.

Specified by:
getConstraint in interface IShapeConstructor
Returns:
A com.esri.arcgis.editor.esriSketchConstraint constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConstraint

public void setConstraint(int constraint)
                   throws java.io.IOException,
                          AutomationException
The sketch constraint.

Specified by:
setConstraint in interface IShapeConstructor
Parameters:
constraint - A com.esri.arcgis.editor.esriSketchConstraint constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAngleConstraint

public double getAngleConstraint()
                          throws java.io.IOException,
                                 AutomationException
The sketch's angular constraint.

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

setAngleConstraint

public void setAngleConstraint(double val)
                        throws java.io.IOException,
                               AutomationException
The sketch's angular constraint.

Specified by:
setAngleConstraint in interface IShapeConstructor
Parameters:
val - The val (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceConstraint

public double getDistanceConstraint()
                             throws java.io.IOException,
                                    AutomationException
The sketch's distance constraint.

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

setDistanceConstraint

public void setDistanceConstraint(double val)
                           throws java.io.IOException,
                                  AutomationException
The sketch's distance constraint.

Specified by:
setDistanceConstraint in interface IShapeConstructor
Parameters:
val - The val (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStreaming

public boolean isStreaming()
                    throws java.io.IOException,
                           AutomationException
Indicates whether stream mode digitizing is enabled.

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

setIsStreaming

public void setIsStreaming(boolean isStreaming)
                    throws java.io.IOException,
                           AutomationException
Indicates whether stream mode digitizing is enabled.

Specified by:
setIsStreaming in interface IShapeConstructor
Parameters:
isStreaming - The isStreaming (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addPoint

public void addPoint(IPoint point,
                     boolean esri_clone,
                     boolean allowUndo)
              throws java.io.IOException,
                     AutomationException
Adds a point to the sketch.

Specified by:
addPoint in interface IShapeConstructor
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
esri_clone - The esri_clone (in)
allowUndo - The allowUndo (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sketchModified

public void sketchModified()
                    throws java.io.IOException,
                           AutomationException
Called when Sketch is modified.

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