com.esri.arcgis.controls
Class EngineFeatureInspector

java.lang.Object
  extended by com.esri.arcgis.controls.EngineFeatureInspector
All Implemented Interfaces:
IEngineExtendedObjectInspector, IEngineObjectInspector, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class EngineFeatureInspector
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IEngineObjectInspector, IEngineExtendedObjectInspector

Feature Inspector for Engine.

Description

This object is new at ArcGIS 9.3.

This CoClass represents the default feature inspector associated with the EngineEditor. It has been made CoCreateable so that customized feature inspectors can incorporate it.

To create your own custom property inspector for a specific feature class, implement the IEngineFeatureInspector interface. For example, you may want to have a custom Property Inspector that displays the area and perimeter of selected polygons or one that displays an image relating to the selected feature.

To create your own custom property inspector for features in a specific feature class, implement the IEngineObjectInspector and IClassExtension interfaces, then add your extensionís GUID to the EXTCLSID field for that feature class in the GDB_ObjectClasses table. When the user opens the Attributes dialog box, it will display the custom inspector instead of the default inspector.

Instantiate a new EngineFeatureInspector when you want to incorporate the default Property Inspector with your custom one.

Product Availability

Available with ArcGIS Engine.

See Also:
Serialized Form

Constructor Summary
EngineFeatureInspector()
          Constructs a EngineFeatureInspector using ArcGIS Engine.
EngineFeatureInspector(Object obj)
          Construct a EngineFeatureInspector using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void addISelectionEventsListener(ISelectionEvents theListener)
          addISelectionEventsListener.
 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(IEngineEnumRow objects, IEngineEditor editor)
          Inspects the properties of the features.
 boolean isDisableEditOperations()
          Indicates if the object inspector is under a non-versioned editing model and to not start or stop edit operations as an edit operation is currently in effect.
 void removeISelectionEventsListener(ISelectionEvents theListener)
          removeISelectionEventsListener.
 void setDisableEditOperations(boolean pDisableEditOperations)
          Indicates if the object inspector is under a non-versioned editing model and to not start or stop edit operations as an edit operation is currently in effect.
 
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

EngineFeatureInspector

public EngineFeatureInspector()
                       throws IOException,
                              UnknownHostException
Constructs a EngineFeatureInspector using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

EngineFeatureInspector

public EngineFeatureInspector(Object obj)
                       throws IOException
Construct a EngineFeatureInspector using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EngineFeatureInspector.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems EngineFeatureInspector theEngineFeatureInspector = (EngineFeatureInspector) 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

addISelectionEventsListener

public void addISelectionEventsListener(ISelectionEvents theListener)
                                 throws IOException
addISelectionEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.
Throws:
IOException - If there are communications problems.

removeISelectionEventsListener

public void removeISelectionEventsListener(ISelectionEvents theListener)
                                    throws IOException
removeISelectionEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.
Throws:
IOException - If there are communications problems.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException
The window handle for the inspector.

Description

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

Specified by:
getHWnd in interface IEngineObjectInspector
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(IEngineEnumRow objects,
                    IEngineEditor editor)
             throws IOException,
                    AutomationException
Inspects the properties of the features.

Description

Use this 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 EngineEditor singleton object. Use the row enumeration to retrieve properties of a feature. Then you can use the EngineEditor object reference to modify properties of a row within the context of an edit operation.

Product Availability

Available with ArcGIS Engine.

Specified by:
inspect in interface IEngineObjectInspector
Parameters:
objects - A reference to a com.esri.arcgis.controls.IEngineEnumRow (in)
editor - A reference to a com.esri.arcgis.controls.IEngineEditor (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.

Description

Use this 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 Engine.

Specified by:
clear in interface IEngineObjectInspector
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.

Description

Use this property to get rows that have been copied using the context menu in the tree control of the Attributes Dialog.

Product Availability

Available with ArcGIS Engine.

Specified by:
copy in interface IEngineObjectInspector
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.

isDisableEditOperations

public boolean isDisableEditOperations()
                                throws IOException,
                                       AutomationException
Indicates if the object inspector is under a non-versioned editing model and to not start or stop edit operations as an edit operation is currently in effect.

Product Availability

Available with ArcGIS Engine.

Specified by:
isDisableEditOperations in interface IEngineExtendedObjectInspector
Returns:
The pDisableEditOperations
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisableEditOperations

public void setDisableEditOperations(boolean pDisableEditOperations)
                              throws IOException,
                                     AutomationException
Indicates if the object inspector is under a non-versioned editing model and to not start or stop edit operations as an edit operation is currently in effect.

Product Availability

Available with ArcGIS Engine.

Specified by:
setDisableEditOperations in interface IEngineExtendedObjectInspector
Parameters:
pDisableEditOperations - The pDisableEditOperations (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.