com.esri.arcgis.carto
Class RasterIdentifyObj

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

All Implemented Interfaces:

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

public class RasterIdentifyObj
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterIdentifyObj, IRasterIdentifyObj2, IIdentifyObj, IRowIdentifyObject

A raster object identified on the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

IIdentifyObj, Serialized Form

Constructor Summary

RasterIdentifyObj(Object obj)
Construct a RasterIdentifyObj 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() Property name.
void	getPropAndValues(int index, String[] property, String[] value) Gets the next pair of property and value of the Identify Object.
IRow	getRow() The row used by 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	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

RasterIdentifyObj

public RasterIdentifyObj(Object obj)
                  throws IOException

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

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

Throws:

IOException - if there are interop problems RasterIdentifyObj theRasterIdentifyObj = (RasterIdentifyObj) 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

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.

getName

public String getName()
               throws IOException,
                      AutomationException

Property name.

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 IRasterIdentifyObj

Returns:

The bName

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

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.

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.