com.esri.arcgis.catalog
Class SearchResultsIdentifyObj

java.lang.Object
  extended by com.esri.arcgis.catalog.SearchResultsIdentifyObj
All Implemented Interfaces:
IIdentifyObj, ISearchResultsIdentifyObject, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SearchResultsIdentifyObj
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIdentifyObj, ISearchResultsIdentifyObject

An object for identifying the contents of a search results layer. This object is not supported on ArcGIS version 10.1. or later.

Product Availability

Available with ArcGIS Desktop.

See Also:
Serialized Form

Constructor Summary
SearchResultsIdentifyObj()
          Constructs a SearchResultsIdentifyObj using ArcGIS Engine.
SearchResultsIdentifyObj(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SearchResultsIdentifyObj theSearchResultsIdentifyObj = (SearchResultsIdentifyObj) 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.
 int hashCode()
          the hashcode for this object
 void popUpMenu(int x, int y)
          Displays a context sensitive popup menu at the specified location.
 void select()
          Selects a shortcut in the Catalog tree.
 void setExtentByRef(IEnvelope rhs1)
          Extent of a shortcut.
 void setShortcutByRef(IGxShortcut rhs1)
          Shortcut to identify.
 
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

SearchResultsIdentifyObj

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

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

SearchResultsIdentifyObj

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

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

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

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.

setExtentByRef

public void setExtentByRef(IEnvelope rhs1)
                    throws IOException,
                           AutomationException
Extent of a shortcut.

Product Availability

Available with ArcGIS Desktop.

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

setShortcutByRef

public void setShortcutByRef(IGxShortcut rhs1)
                      throws IOException,
                             AutomationException
Shortcut to identify.

Product Availability

Available with ArcGIS Desktop.

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

select

public void select()
            throws IOException,
                   AutomationException
Selects a shortcut in the Catalog tree.

Product Availability

Available with ArcGIS Desktop.

Specified by:
select in interface ISearchResultsIdentifyObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.