com.esri.arcgis.editor
Interface IShapeConstructor

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AngleDistanceConstructor, ArcConstructor, BezierCurveConstructor, DistanceDistanceConstructor, EndPointArcConstructor, IntersectionConstructor, IShapeConstructorProxy, MidpointConstructor, PointConstructor, RightAngleConstructor, SketchConstructor, StraightConstructor, TangentCurveConstructor, TraceConstructor

public interface IShapeConstructor
extends java.io.Serializable

COM Interface 'IShapeConstructor'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to a Shape Constructor to be hosted by tools that build sketches.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID14a69cae_fea8_4b8d_a5b4_03ecbedd11b6
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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.

Field Detail

IID14a69cae_fea8_4b8d_a5b4_03ecbedd11b6

static final int IID14a69cae_fea8_4b8d_a5b4_03ecbedd11b6

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

initialize

void initialize(IEditor pEditor)
                throws java.io.IOException,
                       AutomationException

Initializes a newly constructed shape constructor.

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

java.lang.String getID()
                       throws java.io.IOException,
                              AutomationException

Name string identifying this shape constructor.

Returns:

The iD

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException

Indicates whether the constructor is enabled.

Returns:

The enabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

void activate()
              throws java.io.IOException,
                     AutomationException

Prepares a shape constructor to begin receiving events.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

void deactivate()
                throws java.io.IOException,
                       AutomationException

Resets a shape constructor.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isActive

boolean isActive()
                 throws java.io.IOException,
                        AutomationException

Indicates whether the constructor is currently active.

Returns:

The active

Throws:

java.io.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 java.io.IOException,
                        AutomationException

Occurs when a mouse button is pressed when this constructor is active.

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

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.

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

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.

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

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.

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

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.

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

boolean onContextMenu(int x,
                      int y)
                      throws java.io.IOException,
                             AutomationException

Context menu event occured at the given xy location.

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

void refresh(int hdc)
             throws java.io.IOException,
                    AutomationException

Occurs when a screen display in the application is refreshed.

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

int getCursor()
              throws java.io.IOException,
                     AutomationException

The mouse pointer for this constructor.

Returns:

The cursor (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnchor

IPoint getAnchor()
                 throws java.io.IOException,
                        AutomationException

The anchor of the sketch.

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

IPoint getLocation()
                   throws java.io.IOException,
                          AutomationException

The current location of the mouse.

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

int getConstraint()
                  throws java.io.IOException,
                         AutomationException

The sketch constraint.

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

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

The sketch constraint.

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

double getAngleConstraint()
                          throws java.io.IOException,
                                 AutomationException

The sketch's angular constraint.

Returns:

The val

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngleConstraint

void setAngleConstraint(double val)
                        throws java.io.IOException,
                               AutomationException

The sketch's angular constraint.

Parameters:

val - The val (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceConstraint

double getDistanceConstraint()
                             throws java.io.IOException,
                                    AutomationException

The sketch's distance constraint.

Returns:

The val

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceConstraint

void setDistanceConstraint(double val)
                           throws java.io.IOException,
                                  AutomationException

The sketch's distance constraint.

Parameters:

val - The val (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStreaming

boolean isStreaming()
                    throws java.io.IOException,
                           AutomationException

Indicates whether stream mode digitizing is enabled.

Returns:

The isStreaming

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsStreaming

void setIsStreaming(boolean isStreaming)
                    throws java.io.IOException,
                           AutomationException

Indicates whether stream mode digitizing is enabled.

Parameters:

isStreaming - The isStreaming (in)

Throws:

java.io.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 java.io.IOException,
                     AutomationException

Adds a point to the sketch.

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

void sketchModified()
                    throws java.io.IOException,
                           AutomationException

Called when Sketch is modified.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.