com.esri.arcgis.editor
Class HorizontalAnnoConstructor

java.lang.Object
  com.esri.arcgis.editor.HorizontalAnnoConstructor

All Implemented Interfaces:

IAnnotationConstructor, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class HorizontalAnnoConstructor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotationConstructor, ISupportErrorInfo

An annotation feature constructor for creating horizontal annotation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

HorizontalAnnoConstructor()
Constructs a HorizontalAnnoConstructor using ArcGIS Engine.

HorizontalAnnoConstructor(Object obj)
Construct a HorizontalAnnoConstructor using a reference to such an object returned from ArcGIS Engine or Server.

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.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getName() Name of the annotation constructor.
int	getSketchGeometryType() The type of geometry used for the edit sketch constructor.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

HorizontalAnnoConstructor

public HorizontalAnnoConstructor()
                          throws IOException,
                                 UnknownHostException

Constructs a HorizontalAnnoConstructor using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

HorizontalAnnoConstructor

public HorizontalAnnoConstructor(Object obj)
                          throws IOException

Construct a HorizontalAnnoConstructor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to HorizontalAnnoConstructor.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems HorizontalAnnoConstructor theHorizontalAnnoConstructor = (HorizontalAnnoConstructor) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public 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

Specified by:

getName in interface IAnnotationConstructor

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSketchGeometryType

public 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

Specified by:

getSketchGeometryType in interface IAnnotationConstructor

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanFinish

public 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.

Specified by:

isCanFinish in interface IAnnotationConstructor

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

public 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

Specified by:

startup in interface IAnnotationConstructor

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

public 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

Specified by:

shutdown in interface IAnnotationConstructor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFeedback

public 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

Specified by:

createFeedback in interface IAnnotationConstructor

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

public 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

Specified by:

startFeedback in interface IAnnotationConstructor

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

public 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

Specified by:

addFeedbackPoint in interface IAnnotationConstructor

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

public 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

Specified by:

updateFeedback in interface IAnnotationConstructor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopFeedback

public 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

Specified by:

stopFeedback in interface IAnnotationConstructor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onKeyDown

public 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

Specified by:

onKeyDown in interface IAnnotationConstructor

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

public 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

Specified by:

onKeyUp in interface IAnnotationConstructor

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

public 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

Specified by:

beforeStoreAnnotation in interface IAnnotationConstructor

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.