com.esri.arcgis.editor
Interface IShapeConstructor

All Superinterfaces:
Serializable
All Known Implementing Classes:
AngleDistanceConstructor, ArcConstructor, BezierCurveConstructor, DistanceDistanceConstructor, EndPointArcConstructor, IntersectionConstructor, IShapeConstructorProxy, MidpointConstructor, PointConstructor, RightAngleConstructor, SketchConstructor, StraightConstructor, TangentCurveConstructor, TraceConstructor

public interface IShapeConstructor
extends Serializable

Provides access to a Shape Constructor to be hosted by tools that build sketches.

Product Availability

Available with ArcGIS Desktop.


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.
 IPoint getAnchor()
          The anchor of the sketch.
 double getAngleConstraint()
          The sketch's angular constraint.
 int getConstraint()
          The sketch constraint.
 int getCursor()
          The mouse pointer for this constructor.
 double getDistanceConstraint()
          The sketch's distance constraint.
 String getID()
          Name string identifying this shape constructor.
 IPoint getLocation()
          The current location of the mouse.
 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 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.
 

Method Detail

initialize

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
pEditor - A reference to a com.esri.arcgis.editor.IEditor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

String getID()
             throws IOException,
                    AutomationException
Name string identifying this shape constructor.

Product Availability

Available with ArcGIS Desktop.

Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnabled

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

Product Availability

Available with ArcGIS Desktop.

Returns:
The enabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

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

Product Availability

Available with ArcGIS Desktop.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

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

Product Availability

Available with ArcGIS Desktop.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isActive

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

Product Availability

Available with ArcGIS Desktop.

Returns:
The active
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onMouseDown

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
button - The button (in)
shift - The shift (in)
x - The x (in)
y - The y (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onMouseMove

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
button - The button (in)
shift - The shift (in)
x - The x (in)
y - The y (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onMouseUp

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
button - The button (in)
shift - The shift (in)
x - The x (in)
y - The y (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onKeyDown

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
keyState - The keyState (in)
shift - The shift (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onKeyUp

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
keyState - The keyState (in)
shift - The shift (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onContextMenu

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
x - The x (in)
y - The y (in)
Returns:
The handled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
hdc - The hdc (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCursor

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

Product Availability

Available with ArcGIS Desktop.

Returns:
The cursor (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnchor

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

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocation

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

Product Availability

Available with ArcGIS Desktop.

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConstraint

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

Product Availability

Available with ArcGIS Desktop.

Returns:
A com.esri.arcgis.editor.esriSketchConstraint constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConstraint

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

Product Availability

Available with ArcGIS Desktop.

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

getAngleConstraint

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

Product Availability

Available with ArcGIS Desktop.

Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAngleConstraint

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
val - The val (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceConstraint

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

Product Availability

Available with ArcGIS Desktop.

Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceConstraint

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
val - The val (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStreaming

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

Product Availability

Available with ArcGIS Desktop.

Returns:
The isStreaming
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsStreaming

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

Product Availability

Available with ArcGIS Desktop.

Parameters:
isStreaming - The isStreaming (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addPoint

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

Product Availability

Available with ArcGIS Desktop.

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

sketchModified

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

Product Availability

Available with ArcGIS Desktop.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.