com.esri.arcgis.editor
Class FeatureInspector

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

All Implemented Interfaces:

IConnectionPointContainer, IExtendedObjectInspector, IObjectInspector, IObjectInspectorPanel, IObjectClassEvents, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class FeatureInspector
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IObjectInspector, IExtendedObjectInspector, IObjectInspectorPanel, IConnectionPointContainer, IObjectClassEvents

COM Class 'FeatureInspector'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description 'Default feature inspector for the Editor.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.editor.IObjectInspector

IID, IID014ee841_a498_11d1_846b_0000f875b9c6, xxDummy

Fields inherited from interface com.esri.arcgis.editor.IExtendedObjectInspector

IID, IID84a3fd64_54a6_44e7_8cb6_cbfaa8ce49af, xxDummy

Fields inherited from interface com.esri.arcgis.editor.IObjectInspectorPanel

IID, IID606fd6e5_2f5a_4126_84a2_67c281e0de8b, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

FeatureInspector()
Constructs a FeatureInspector using ArcGIS Engine.

FeatureInspector(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureInspector theFeatureInspector = (FeatureInspector) obj;

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.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
static java.lang.String	getClsid() getClsid.
IField	getField(int index) Attribute field by index.
int	getFieldCount() The number of attribute fields displayed.
int	getHWND() The window handle for the inspector.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IEnumRow	getRows() The row or rows being inspected.
int	getSelectedField() The index of the selected field, or -1.
ITable	getTable() The table being edited.
int	hashCode() the hashcode for this object
void	inspect(IEnumRow objects, IEditor 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	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.
void	release() Release a FeatureInspector.
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.
void	setSelectedField(int index) The index of the selected field, or -1.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureInspector

public FeatureInspector()
                 throws java.io.IOException,
                        java.net.UnknownHostException

Constructs a FeatureInspector using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FeatureInspector

public FeatureInspector(java.lang.Object obj)
                 throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addISelectionEventsListener

public void addISelectionEventsListener(ISelectionEvents theListener)
                                 throws java.io.IOException

addISelectionEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.

Throws:

java.io.IOException - If there are communications problems.

removeISelectionEventsListener

public void removeISelectionEventsListener(ISelectionEvents theListener)
                                    throws java.io.IOException

removeISelectionEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.ISelectionEvents interface.

Throws:

java.io.IOException - If there are communications problems.

release

public void release()

Release a FeatureInspector.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getHWND

public int getHWND()
            throws java.io.IOException,
                   AutomationException

The window handle for the inspector.

Specified by:

getHWND in interface IObjectInspector

Returns:

The hWND (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

inspect

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

Inspects the properties of the features.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException

Clear the inspector before inspecting another object.

Specified by:

clear in interface IObjectInspector

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IRow srcRow)
          throws java.io.IOException,
                 AutomationException

Copies the values from srcRow to the row being edited.

Specified by:

copy in interface IObjectInspector

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisableEditOperations

public boolean isDisableEditOperations()
                                throws java.io.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.

Specified by:

isDisableEditOperations in interface IExtendedObjectInspector

Returns:

The pDisableEditOperations

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisableEditOperations

public void setDisableEditOperations(boolean pDisableEditOperations)
                              throws java.io.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.

Specified by:

setDisableEditOperations in interface IExtendedObjectInspector

Parameters:

pDisableEditOperations - The pDisableEditOperations (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws java.io.IOException,
                       AutomationException

The table being edited.

Specified by:

getTable in interface IObjectInspectorPanel

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRows

public IEnumRow getRows()
                 throws java.io.IOException,
                        AutomationException

The row or rows being inspected.

Specified by:

getRows in interface IObjectInspectorPanel

Returns:

A reference to a com.esri.arcgis.editor.IEnumRow

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldCount

public int getFieldCount()
                  throws java.io.IOException,
                         AutomationException

The number of attribute fields displayed.

Specified by:

getFieldCount in interface IObjectInspectorPanel

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

public IField getField(int index)
                throws java.io.IOException,
                       AutomationException

Attribute field by index.

Specified by:

getField in interface IObjectInspectorPanel

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IField

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedField

public int getSelectedField()
                     throws java.io.IOException,
                            AutomationException

The index of the selected field, or -1.

Specified by:

getSelectedField in interface IObjectInspectorPanel

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedField

public void setSelectedField(int index)
                      throws java.io.IOException,
                             AutomationException

The index of the selected field, or -1.

Specified by:

setSelectedField in interface IObjectInspectorPanel

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onCreate

public void onCreate(IObjectClassEventsOnCreateEvent theEvent)
              throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDelete

public void onDelete(IObjectClassEventsOnDeleteEvent theEvent)
              throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChange

public void onChange(IObjectClassEventsOnChangeEvent theEvent)
              throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.