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, java.io.Serializable

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

COM Class 'RasterIdentifyObj'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A raster object identified on the display.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.IRasterIdentifyObj

IID, IIDefd47fdc_de27_11d2_9fce_00c04f799f23, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IRasterIdentifyObj2

IID, IIDff3bac13_e1c4_47ab_807a_4c8233341d11, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IRowIdentifyObject

IID, IID061bded1_1486_11d4_9fec_00c04f6bc78e, xxDummy

Constructor Summary

RasterIdentifyObj(java.lang.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(java.lang.Object o) Compare this object with another
void	flash(IScreenDisplay pDisplay) Flashes the identified object on the screen.
int	getHWnd() The window handle.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILayer	getLayer() Target layer for identification.
IPoint	getLocation() Identified location.
java.lang.String	getMapTip() Property value.
java.lang.String	getName() Property name.
void	getPropAndValues(int index, java.lang.String[] property, java.lang.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(java.lang.String property, java.lang.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	release() Release a RasterIdentifyObj.
void	setLocationByRef(IPoint pPoint) Identified location.
void	setMapTip(java.lang.String bMapTip) Property value.
void	setName(java.lang.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

Constructor Detail

RasterIdentifyObj

public RasterIdentifyObj(java.lang.Object obj)
                  throws java.io.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:

java.io.IOException - if there are interop problems RasterIdentifyObj theRasterIdentifyObj = (RasterIdentifyObj) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a RasterIdentifyObj.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

insertPropAndValue

public void insertPropAndValue(java.lang.String property,
                               java.lang.String value)
                        throws java.io.IOException,
                               AutomationException

Inserts a property name and value pair to the RasterIdentifyObj.

Specified by:

insertPropAndValue in interface IRasterIdentifyObj

Parameters:

property - The property (in)

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Property name.

Specified by:

getName in interface IIdentifyObj

Specified by:

getName in interface IRasterIdentifyObj

Returns:

The bName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String bName)
             throws java.io.IOException,
                    AutomationException

Property name.

Specified by:

setName in interface IRasterIdentifyObj

Parameters:

bName - The bName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapTip

public java.lang.String getMapTip()
                           throws java.io.IOException,
                                  AutomationException

Property value.

Specified by:

getMapTip in interface IRasterIdentifyObj

Returns:

The bMapTip

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapTip

public void setMapTip(java.lang.String bMapTip)
               throws java.io.IOException,
                      AutomationException

Property value.

Specified by:

setMapTip in interface IRasterIdentifyObj

Parameters:

bMapTip - The bMapTip (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocation

public IPoint getLocation()
                   throws java.io.IOException,
                          AutomationException

Identified location.

Specified by:

getLocation in interface IRasterIdentifyObj

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationByRef

public void setLocationByRef(IPoint pPoint)
                      throws java.io.IOException,
                             AutomationException

Identified location.

Specified by:

setLocationByRef in interface IRasterIdentifyObj

Parameters:

pPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropAndValues

public void getPropAndValues(int index,
                             java.lang.String[] property,
                             java.lang.String[] value)
                      throws java.io.IOException,
                             AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canIdentify

public boolean canIdentify(ILayer pLayer)
                    throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flash

public void flash(IScreenDisplay pDisplay)
           throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

popUpMenu

public void popUpMenu(int x,
                      int y)
               throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRow

public void setRow(IRow row)
            throws java.io.IOException,
                   AutomationException

The row used by the identify object.

Specified by:

setRow in interface IRowIdentifyObject

Parameters:

row - A reference to a com.esri.arcgis.geodatabase.IRow (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRow

public IRow getRow()
            throws java.io.IOException,
                   AutomationException

The row used by the identify object.

Specified by:

getRow in interface IRowIdentifyObject

Returns:

A reference to a com.esri.arcgis.geodatabase.IRow

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.