Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.editor
Interface IAnnotationConstructor

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
CurvedAnnoConstructor, FollowFeatureAnnoConstructor, HorizontalAnnoConstructor, IAnnotationConstructorProxy, LeaderAnnoConstructor, StraightAnnoConstructor
public interface IAnnotationConstructor
extends java.io.Serializable

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

Description: 'Provides access to members that control the annotation feature edit sketch constructor.' 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 IIDe7df3443_4572_4056_b075_bf69e77a0fa6
           
static int xxDummy
          Deprecated. Internal use only
 
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.
 java.lang.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.
 

Field Detail

IIDe7df3443_4572_4056_b075_bf69e77a0fa6

static final int IIDe7df3443_4572_4056_b075_bf69e77a0fa6
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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the annotation constructor.

Returns:
The name
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 type of geometry used for the edit sketch constructor.

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.

isCanFinish

boolean isCanFinish(IGeometry sketchGeometry)
                    throws java.io.IOException,
                           AutomationException
Indicates if the annotation feature can be constructed given the number of points in the edit sketch.

Parameters:
sketchGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
The canFinish
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startup

void startup(IEditor pEditor)
             throws java.io.IOException,
                    AutomationException
The annotation editor extension.

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.

shutdown

void shutdown()
              throws java.io.IOException,
                     AutomationException
The constructor start event.

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
The display feedback for the constructor.

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
Starts the display feedback for the annotation constructor.

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.

addFeedbackPoint

void addFeedbackPoint(IPoint point)
                      throws java.io.IOException,
                             AutomationException
Adds a point to the display feedback.

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.

updateFeedback

void updateFeedback()
                    throws java.io.IOException,
                           AutomationException
Updates the display feedback with the current settings.

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

stopFeedback

void stopFeedback()
                  throws java.io.IOException,
                         AutomationException
Stops the display feedback.

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.

beforeStoreAnnotation

void beforeStoreAnnotation(IAnnotationFeature annotationFeature,
                           IGeometry sketchGeometry)
                           throws java.io.IOException,
                                  AutomationException
Lets the constructor know the annotation is about to be stored.

Parameters:
annotationFeature - A reference to a com.esri.arcgis.carto.IAnnotationFeature (in)
sketchGeometry - 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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD