com.esri.arcgis.carto
Class SimpleRasterIdentifyObj

java.lang.Object
  com.esri.arcgis.carto.SimpleRasterIdentifyObj

All Implemented Interfaces:

IIdentifyObj, IIdentifyObject, IRasterIdentifyObj, IRasterIdentifyObj2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SimpleRasterIdentifyObj
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIdentifyObj, IRasterIdentifyObj, IRasterIdentifyObj2, IIdentifyObject

A simplified raster object identified on the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

SimpleRasterIdentifyObj(Object obj)
Construct a SimpleRasterIdentifyObj using a reference to such an object returned from ArcGIS Engine or Server.

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.
int	getHWnd() The window handle.
ILayer	getLayer() Target layer for identification.
IPoint	getLocation() Identified location.
String	getMapTip() Property value.
String	getName() Name of the identify object.
void	getPropAndValues(int index, String[] property, String[] value) Gets the next pair of property and value of the Identify Object.
IPropertySet	getPropertySet() PropertySet of the identify object.
int	hashCode() the hashcode for this object
void	insertPropAndValue(String property, String value) Inserts a property name and value pair to the RasterIdentifyObj.
void	popUpMenu(int x, int y) Displays a context sensitive popup menu at the specified location.
void	setLocationByRef(IPoint pPoint) Identified location.
void	setMapTip(String bMapTip) Property value.
void	setName(String bName) Property name.
void	setPropertySetByRef(IPropertySet propertySet) PropertySet of 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

SimpleRasterIdentifyObj

public SimpleRasterIdentifyObj(Object obj)
                        throws IOException

Construct a SimpleRasterIdentifyObj using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SimpleRasterIdentifyObj.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
SimpleRasterIdentifyObj o = (SimpleRasterIdentifyObj)obj; // will not work

SimpleRasterIdentifyObj o = new SimpleRasterIdentifyObj(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems SimpleRasterIdentifyObj theSimpleRasterIdentifyObj = (SimpleRasterIdentifyObj) obj;

Method Detail

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

Specified by:

getName in interface IIdentifyObject

Specified by:

getName in interface IRasterIdentifyObj

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.

insertPropAndValue

public void insertPropAndValue(String property,
                               String value)
                        throws IOException,
                               AutomationException

Inserts a property name and value pair to the RasterIdentifyObj.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

insertPropAndValue in interface IRasterIdentifyObj

Parameters:

property - The property (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String bName)
             throws IOException,
                    AutomationException

Property name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IIdentifyObject

Specified by:

setName in interface IRasterIdentifyObj

Parameters:

bName - The bName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapTip

public String getMapTip()
                 throws IOException,
                        AutomationException

Property value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMapTip in interface IRasterIdentifyObj

Returns:

The bMapTip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapTip

public void setMapTip(String bMapTip)
               throws IOException,
                      AutomationException

Property value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapTip in interface IRasterIdentifyObj

Parameters:

bMapTip - The bMapTip (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocation

public IPoint getLocation()
                   throws IOException,
                          AutomationException

Identified location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLocation in interface IRasterIdentifyObj

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationByRef

public void setLocationByRef(IPoint pPoint)
                      throws IOException,
                             AutomationException

Identified location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLocationByRef in interface IRasterIdentifyObj

Parameters:

pPoint - 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

Gets the next pair of property and value of the Identify Object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropAndValues in interface IRasterIdentifyObj2

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.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet of the identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertySet in interface IIdentifyObject

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertySetByRef

public void setPropertySetByRef(IPropertySet propertySet)
                         throws IOException,
                                AutomationException

PropertySet of the identify object.

Product Availability

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

Specified by:

setPropertySetByRef in interface IIdentifyObject

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.