com.esri.arcgis.editor
Interface IAnnotationConstructor

All Superinterfaces:

Serializable

All Known Implementing Classes:

CurvedAnnoConstructor, FollowFeatureAnnoConstructor, HorizontalAnnoConstructor, IAnnotationConstructorProxy, LeaderAnnoConstructor, StraightAnnoConstructor

public interface IAnnotationConstructor
extends Serializable

Provides access to members that control the annotation feature edit sketch constructor.

Remarks

Annotation Constructors provide specialized behavior for creating new annotation features. All annotation constructors implement the IAnnotationConstructor interface and are registered in the ESRI Annotation Constructors component category.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addFeedbackPoint(IPoint point) Adds a point to the display feedback.
void	beforeStoreAnnotation(IAnnotationFeature annotationFeature, IGeometry sketchGeometry) Lets the constructor know the annotation is about to be stored.
IDisplayFeedback	createFeedback() The display feedback for the constructor.
String	getName() Name of the annotation constructor.
int	getSketchGeometryType() The type of geometry used for the edit sketch constructor.
boolean	isCanFinish(IGeometry sketchGeometry) Indicates if the annotation feature can be constructed given the number of points in the edit sketch.
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	shutdown() The constructor start event.
void	startFeedback(IPoint point) Starts the display feedback for the annotation constructor.
void	startup(IEditor pEditor) The annotation editor extension.
void	stopFeedback() Stops the display feedback.
void	updateFeedback() Updates the display feedback with the current settings.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the annotation constructor.

Remarks

Returns the name of the annotation constructor. This is the name listed in the Annotation Constructors control on the Annotation toolbar.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSketchGeometryType

int getSketchGeometryType()
                          throws IOException,
                                 AutomationException

The type of geometry used for the edit sketch constructor.

Remarks

Returns the geometry type of the annotation constructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanFinish

boolean isCanFinish(IGeometry sketchGeometry)
                    throws IOException,
                           AutomationException

Indicates if the annotation feature can be constructed given the number of points in the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Parameters:

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

Returns:

The canFinish

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startup

void startup(IEditor pEditor)
             throws IOException,
                    AutomationException

The annotation editor extension.

Remarks

Startup is called when the constructor is instantiated by the AnnotationEditExtension. If you are implementing this interface Startup is where you should obtain a reference to IAnnotationEditExtension from the Editor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.

shutdown

void shutdown()
              throws IOException,
                     AutomationException

The constructor start event.

Remarks

Shutdown is called when the AnnotationEditExtension's destructor is called, typically when ArcMap is shut down.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFeedback

IDisplayFeedback createFeedback()
                                throws IOException,
                                       AutomationException

The display feedback for the constructor.

Remarks

When implementing IAnnotationConstructor CreateFeedback is where the chosen feedback object should be instantiated. This includes both standard feedback objects like MoveFeedback, NewFeedback, RotateFeedback, or custom feedback objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startFeedback

void startFeedback(IPoint point)
                   throws IOException,
                          AutomationException

Starts the display feedback for the annotation constructor.

Remarks

StartFeedback will start the display of the feedback object when the first point is added to the edit sketch. All properties required by the feedback object should be specified at this point and the feedback should be started.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFeedbackPoint

void addFeedbackPoint(IPoint point)
                      throws IOException,
                             AutomationException

Adds a point to the display feedback.

Remarks

AddFeedbackPoint is called whenever a point is added to the edit sketch. The point can be used to update the feedback if desired.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateFeedback

void updateFeedback()
                    throws IOException,
                           AutomationException

Updates the display feedback with the current settings.

Remarks

Use UpdateFeedback when you change the characteristics of the feedback. An example of when you might use this method is when a new point is added to the sketch and the new point sets the angle at which the feedback is displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopFeedback

void stopFeedback()
                  throws IOException,
                         AutomationException

Stops the display feedback.

Remarks

StopFeedback will stop the display feedback. StopFeedback is automatically called when IAnnotationConstructor::CanFinish returns True.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

Called when a key is pressed.

Remarks

OnKeyDown may be used to listen for one or more keys being depressed and expose additional functionality. All annotation constructors have a set of keys that they respond to. See the list of hotkeys in the online help. Each constructor implements the 'W' key functionality to derive the text from the first feature under the cursor; this functionality is available to new annotation constructors.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

Called when a key is pressed.

Remarks

OnKeyUp may be used to listen for one or more keys being released.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

keyState - The keyState (in)

shift - The shift (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeStoreAnnotation

void beforeStoreAnnotation(IAnnotationFeature annotationFeature,
                           IGeometry sketchGeometry)
                           throws IOException,
                                  AutomationException

Lets the constructor know the annotation is about to be stored.

Remarks

Use BeforeStoreAnnotation to apply changes to the annotation feature being created before it is stored in the Geodatabase. At this time the location of the feature should be updated from its initial position if required. BeforeStoreAnnotation is called automatically when IAnnotationConstructor::CanFinish returns True.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

annotationFeature - A reference to a com.esri.arcgis.carto.IAnnotationFeature (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.