com.esri.arcgis.cartoUI
Class FeatureIdentifyObject

java.lang.Object
  extended by com.esri.arcgis.cartoUI.FeatureIdentifyObject
All Implemented Interfaces:
IBasicMapIdentifyObject, IFeatureIdentifyObj, IIdentifyObj, IMapIdentifyObject, IRowIdentifyObject, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FeatureIdentifyObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureIdentifyObj, IBasicMapIdentifyObject, IMapIdentifyObject, IIdentifyObj, IRowIdentifyObject

Feature Identify Object.

Remarks

A FeatureIdentifyObject object provides access to the identified feature and has methods that can operate on that feature.

When used on a map layer, the IIdentify::Identify method returns an array of FeatureIndentifyObject objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
IIdentify, Serialized Form

Constructor Summary
FeatureIdentifyObject()
          Constructs a FeatureIdentifyObject using ArcGIS Engine.
FeatureIdentifyObject(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureIdentifyObject theFeatureIdentifyObject = (FeatureIdentifyObject) obj;
 
Method Summary
 boolean canIdentify(ILayer pLayer)
          Indicates if the object can identify the specified layer.
 boolean equals(Object o)
          Compare this object with another
 void flash(IScreenDisplay pDisplay)
          Flashes the identified object on the screen.
static String getClsid()
          getClsid.
 int getHWnd()
          The window handle.
 ILayer getLayer()
          Target layer for identification.
 String getName()
          Name of the identify object.
 IRow getRow()
          The row used by the identify object.
 int hashCode()
          the hashcode for this object
 void popUpMenu(int x, int y)
          Displays a context sensitive popup menu at the specified location.
 void setBasicMapByRef(IBasicMap rhs1)
          The basic map into an identify object.
 void setFeature(IFeature rhs1)
          The feature to be identified.
 void setMapByRef(IMap rhs1)
          The map into an identify object.
 void setRow(IRow row)
          The row used by the identify object.
 
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

FeatureIdentifyObject

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

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

FeatureIdentifyObject

public FeatureIdentifyObject(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureIdentifyObject theFeatureIdentifyObject = (FeatureIdentifyObject) obj;

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

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

setFeature

public void setFeature(IFeature rhs1)
                throws IOException,
                       AutomationException
The feature to be identified.

Remarks

The Feature property is write-only. However, you can get a reference to the identified feature by casting to IRowIdentifyObject and then using the Row property. This could be coded as follows.

Example:

 

IFeatureIdentifyObj pFeatIdObj = null;   
IRowIdentifyObject pRowObj = null;   
IFeature pFeature = null;   
// Do something that sets pFeatIdObj...   
//    
// Get the feature that was identified by casting to IRowIdentifyObject   
pRowObj = new IRowIdentifyObjectProxy(pFeatIdObj);   
pFeature = new IFeatureProxy( pRowObj.getRow());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFeature in interface IFeatureIdentifyObj
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBasicMapByRef

public void setBasicMapByRef(IBasicMap rhs1)
                      throws IOException,
                             AutomationException
The basic map into an identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBasicMapByRef in interface IBasicMapIdentifyObject
Parameters:
rhs1 - A reference to a com.esri.arcgis.carto.IBasicMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapByRef

public void setMapByRef(IMap rhs1)
                 throws IOException,
                        AutomationException
The map into an identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMapByRef in interface IMapIdentifyObject
Parameters:
rhs1 - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canIdentify

public boolean canIdentify(ILayer pLayer)
                    throws IOException,
                           AutomationException
Indicates if the object can identify the specified layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
canIdentify in interface IIdentifyObj
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The b
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHWnd in interface IIdentifyObj
Returns:
The hWnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IIdentifyObj
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException
Target layer for identification.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLayer in interface IIdentifyObj
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flash

public void flash(IScreenDisplay pDisplay)
           throws IOException,
                  AutomationException
Flashes the identified object on the screen.

Remarks

The Flash method is not supported with ArcGIS Engine, use the IHookActions.DoActions() method with the esriHookActionsFlash for this functionality.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
flash in interface IIdentifyObj
Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IScreenDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

popUpMenu

public void popUpMenu(int x,
                      int y)
               throws IOException,
                      AutomationException
Displays a context sensitive popup menu at the specified location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
popUpMenu in interface IIdentifyObj
Parameters:
x - The x (in)
y - The y (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRow

public void setRow(IRow row)
            throws IOException,
                   AutomationException
The row used by the identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRow in interface IRowIdentifyObject
Parameters:
row - 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.

getRow

public IRow getRow()
            throws IOException,
                   AutomationException
The row used by the identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRow in interface IRowIdentifyObject
Returns:
A reference to a com.esri.arcgis.geodatabase.IRow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.