com.esri.arcgis.carto
Class SimpleTinIdentifyObj

java.lang.Object
  extended by com.esri.arcgis.carto.SimpleTinIdentifyObj
All Implemented Interfaces:
IIdentifyObj, ITinIdentifyObj, ITinIdentifyObj2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SimpleTinIdentifyObj
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIdentifyObj, ITinIdentifyObj, ITinIdentifyObj2

Object that mantains information collected during the identify operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
SimpleTinIdentifyObj()
          Constructs a SimpleTinIdentifyObj using ArcGIS Engine.
SimpleTinIdentifyObj(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SimpleTinIdentifyObj theSimpleTinIdentifyObj = (SimpleTinIdentifyObj) 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.
 void getLocation(IPoint[] ppPoint)
          Retrieves the coordinates of the location that was identified.
 String getName()
          Name of the identify object.
 void getPropAndValues(int index, String[] property, String[] value)
          Used to get the set of properties ancd values from an TinIdentifyObject.
 int hashCode()
          the hashcode for this object
 void popUpMenu(int x, int y)
          Displays a context sensitive popup menu at the specified location.
 void setFeature(IFeature rhs1)
          The Feature property as IFeature.
 void setLocation(IPoint rhs1)
          The Location property as IPoint.
 void setupEntity()
          Initializes the array that stores the properties and values which are to be displayed by the ID dialog.
 
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

SimpleTinIdentifyObj

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

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

SimpleTinIdentifyObj

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

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

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.

setFeature

public void setFeature(IFeature rhs1)
                throws IOException,
                       AutomationException
The Feature property as IFeature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFeature in interface ITinIdentifyObj
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.

setLocation

public void setLocation(IPoint rhs1)
                 throws IOException,
                        AutomationException
The Location property as IPoint.

Product Availability

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

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

getPropAndValues

public void getPropAndValues(int index,
                             String[] property,
                             String[] value)
                      throws IOException,
                             AutomationException
Used to get the set of properties ancd values from an TinIdentifyObject.

Product Availability

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

Specified by:
getPropAndValues in interface ITinIdentifyObj2
Parameters:
index - The index (in)
property - The property (out: use single element array)
value - The value (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setupEntity

public void setupEntity()
                 throws IOException,
                        AutomationException
Initializes the array that stores the properties and values which are to be displayed by the ID dialog.

Product Availability

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

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

getLocation

public void getLocation(IPoint[] ppPoint)
                 throws IOException,
                        AutomationException
Retrieves the coordinates of the location that was identified.

Product Availability

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

Specified by:
getLocation in interface ITinIdentifyObj2
Parameters:
ppPoint - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.