com.esri.arcgis.editor
Interface IEditSketchExtension2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AnnotationEditExtension, IEditSketchExtension2Proxy

public interface IEditSketchExtension2
extends java.io.Serializable

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

Description: 'Provides access to members that extend the edit sketch.' 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	IID26ca7bb7_17f5_42d6_8aec_d8a231b7f92e
static int	xxDummy Deprecated. Internal use only

Method Summary

void	activate(IEditor editor) Called when the sketch extension is about to be used.
boolean	applies(IEditor editor) Indicates whether this extension applies to the current edit environment.
void	beforeStoreFeature(IFeature feature, IGeometry geometry) Lets the extension know the feature is about to be stored.
IDisplayFeedback	createFeedback() Called when a new feedback is needed.
IDisplayFeedback	createPreSketchFeedback() Called when a new feedback is needed before the sketch starts.
IGeometry	createSketchGeometry(IFeature feature) The geometry that will be used in the sketch when modifying a feature.
void	deactivate() Called when the sketch extension is no longer needed.
int	getSketchGeometryType() The geometry type used for the edit sketch when creating new features.
boolean	isCanDeleteVertices() Indicates whether the sketch allows the deleting of vertices.
boolean	isCanInsertVertices() Indicates whether the sketch allows the inserting of additional vertices.
boolean	isCanMoveVertices() Indicates whether the sketch allows the moving of vertices.
boolean	isHasFeedback() Indicates whether the SketchExtension will use a custom feedback.
boolean	isHasPreSketchFeedback() Indicates whether the SketchExtension will use a custom feedback before the sketch starts.
void	onKeyDown(int keyState, int shift) Called when a key is pressed.
void	onKeyUp(int keyState, int shift) Called when a key is pressed.
void	startFeedback(IPoint point) Called when the feedback needs to be started.
void	startFeedbackFromShape(IGeometry shape) Called when the feedback needs to be started using an existing geometry.
void	startPreSketchFeedback(IPoint point) Called when the feedback needs to be started.
IGeometry	stopFeedback() Called when the feedback is no longer necessary.
void	stopPreSketchFeedback() Called when the feedback needs to be stopped.

Field Detail

IID26ca7bb7_17f5_42d6_8aec_d8a231b7f92e

static final int IID26ca7bb7_17f5_42d6_8aec_d8a231b7f92e

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

applies

boolean applies(IEditor editor)
                throws java.io.IOException,
                       AutomationException

Indicates whether this extension applies to the current edit environment.

Parameters:

editor - A reference to a com.esri.arcgis.editor.IEditor (in)

Returns:

The applies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

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

Called when the sketch extension is about to be used.

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.

deactivate

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

Called when the sketch extension is no longer needed.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beforeStoreFeature

void beforeStoreFeature(IFeature feature,
                        IGeometry geometry)
                        throws java.io.IOException,
                               AutomationException

Lets the extension know the feature is about to be stored.

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanInsertVertices

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

Indicates whether the sketch allows the inserting of additional vertices.

Returns:

The canInsert

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanDeleteVertices

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

Indicates whether the sketch allows the deleting of vertices.

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanMoveVertices

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

Indicates whether the sketch allows the moving of vertices.

Returns:

The canMove

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSketchGeometryType

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

The geometry type used for the edit sketch when creating new features.

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createSketchGeometry

IGeometry createSketchGeometry(IFeature feature)
                               throws java.io.IOException,
                                      AutomationException

The geometry that will be used in the sketch when modifying a feature.

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasFeedback

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

Indicates whether the SketchExtension will use a custom feedback.

Returns:

The hasFeedback

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFeedback

IDisplayFeedback createFeedback()
                                throws java.io.IOException,
                                       AutomationException

Called when a new feedback is needed.

Returns:

A reference to a com.esri.arcgis.display.IDisplayFeedback

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startFeedback

void startFeedback(IPoint point)
                   throws java.io.IOException,
                          AutomationException

Called when the feedback needs to be started.

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopFeedback

IGeometry stopFeedback()
                       throws java.io.IOException,
                              AutomationException

Called when the feedback is no longer necessary.

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startFeedbackFromShape

void startFeedbackFromShape(IGeometry shape)
                            throws java.io.IOException,
                                   AutomationException

Called when the feedback needs to be started using an existing geometry.

Parameters:

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasPreSketchFeedback

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

Indicates whether the SketchExtension will use a custom feedback before the sketch starts.

Returns:

The hasFeedback

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createPreSketchFeedback

IDisplayFeedback createPreSketchFeedback()
                                         throws java.io.IOException,
                                                AutomationException

Called when a new feedback is needed before the sketch starts.

Returns:

A reference to a com.esri.arcgis.display.IDisplayFeedback

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startPreSketchFeedback

void startPreSketchFeedback(IPoint point)
                            throws java.io.IOException,
                                   AutomationException

Called when the feedback needs to be started.

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopPreSketchFeedback

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

Called when the feedback needs to be stopped.

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

Called when a key is pressed.

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

Called when a key is pressed.

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.