com.esri.arcgis.editor
Class AnnotationInspector

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

All Implemented Interfaces:

IObjectInspector, IObjectClassEvents, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class AnnotationInspector
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IObjectInspector, IObjectClassEvents

A property inspector for annotation features.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

AnnotationInspector()
Constructs a AnnotationInspector using ArcGIS Engine.

AnnotationInspector(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnnotationInspector theAnnotationInspector = (AnnotationInspector) obj;

Method Summary

void	clear() Clear the inspector before inspecting another object.
void	copy(IRow srcRow) Copies the values from srcRow to the row being edited.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getHWND() The window handle for the inspector.
int	hashCode() the hashcode for this object
void	inspect(IEnumRow objects, IEditor editor) Inspects the properties of the features.
void	onChange(IObjectClassEventsOnChangeEvent theEvent) This event is fired when an object's attributes or geometry is updated.
void	onCreate(IObjectClassEventsOnCreateEvent theEvent) This event is fired when a new object is created in the object class.
void	onDelete(IObjectClassEventsOnDeleteEvent theEvent) This event is fired when an object is deleted from the object class.

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

AnnotationInspector

public AnnotationInspector()
                    throws IOException,
                           UnknownHostException

Constructs a AnnotationInspector using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AnnotationInspector

public AnnotationInspector(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnnotationInspector theAnnotationInspector = (AnnotationInspector) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

getHWND

public int getHWND()
            throws IOException,
                   AutomationException

The window handle for the inspector.

Remarks

The Object Inpector reads this property to determine what it will display in its right pane. Custom Object Inspectors must supply the hWnd property of the window or control that is going to be displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWND in interface IObjectInspector

Returns:

The hWND (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

inspect

public void inspect(IEnumRow objects,
                    IEditor editor)
             throws IOException,
                    AutomationException

Inspects the properties of the features.

Remarks

Use the Inspect method to display your custom Feature Inspector.

The Inspect method provides you with an enumeration of row objects to inspect as well as a pointer to the Editor extension. Use the row enumeration to retrieve properties of a feature. Then you can use the Editor object reference to modify properties of a row within the context of an edit operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

inspect in interface IObjectInspector

Parameters:

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

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

clear

public void clear()
           throws IOException,
                  AutomationException

Clear the inspector before inspecting another object.

Remarks

Use the Clear property to reset your custom Feature Inspector control(s). The Clear property is called prior to updating the Inspect property with a new row enumeration.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

clear in interface IObjectInspector

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IRow srcRow)
          throws IOException,
                 AutomationException

Copies the values from srcRow to the row being edited.

Remarks

Use the Copy property to get rows that have been copied using the context menu in the tree control of the Attributes Dialog located on the Editor Toolbar.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

copy in interface IObjectInspector

Parameters:

srcRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(IObjectClassEventsOnCreateEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when a new object is created in the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onCreate in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDelete

public void onDelete(IObjectClassEventsOnDeleteEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when an object is deleted from the object class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDelete in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChange

public void onChange(IObjectClassEventsOnChangeEvent theEvent)
              throws IOException,
                     AutomationException

This event is fired when an object's attributes or geometry is updated.

Remarks

In the event that a feature should be deleted due to an OnChange event, it is not recommended that the event handler delete the feature itself. Instead, an exception should be thrown to the application, where it can be made responsible for deleting the feature.

The OnChange event is not fired during a Topology Validation for performance reasons as a large number of features may be changed during a Validate. In addition, features may be changed many times.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onChange in interface IObjectClassEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.