com.esri.arcgis.arcmapui
Class MapServerIdentifyObject

java.lang.Object
  com.esri.arcgis.arcmapui.MapServerIdentifyObject

All Implemented Interfaces:

IBasicMapIdentifyObject, IIdentifyObj, IIdentifyObject, IMapIdentifyObject, IMapServerIdentifyObject, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MapServerIdentifyObject
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIdentifyObj, IIdentifyObject, IMapServerIdentifyObject, IMapIdentifyObject, IBasicMapIdentifyObject

Provides programmatic access to a map server identify object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

MapServerIdentifyObject()
Constructs a MapServerIdentifyObject using ArcGIS Engine.

MapServerIdentifyObject(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapServerIdentifyObject theMapServerIdentifyObject = (MapServerIdentifyObject) 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.
IMapServerIdentifyResult	getMapServerIdentifyResult() The Map Server Identify Result.
String	getName() Name of the identify object.
IPropertySet	getPropertySet() PropertySet 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	setBasicMapByRef(IBasicMap rhs1) The basic map into an identify object.
void	setMapByRef(IMap rhs1) The map into an identify object.
void	setMapServerIdentifyResult(IMapServerIdentifyResult result) The Map Server Identify Result.
void	setName(String name) Name of the identify object.
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

MapServerIdentifyObject

public MapServerIdentifyObject()
                        throws IOException,
                               UnknownHostException

Constructs a MapServerIdentifyObject using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MapServerIdentifyObject

public MapServerIdentifyObject(Object obj)
                        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MapServerIdentifyObject theMapServerIdentifyObject = (MapServerIdentifyObject) obj;

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

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

Specified by:

getName in interface IIdentifyObject

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.

setName

public void setName(String name)
             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:

setName in interface IIdentifyObject

Parameters:

name - The name (in)

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.

setMapServerIdentifyResult

public void setMapServerIdentifyResult(IMapServerIdentifyResult result)
                                throws IOException,
                                       AutomationException

The Map Server Identify Result.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapServerIdentifyResult in interface IMapServerIdentifyObject

Parameters:

result - A reference to a com.esri.arcgis.carto.IMapServerIdentifyResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapServerIdentifyResult

public IMapServerIdentifyResult getMapServerIdentifyResult()
                                                    throws IOException,
                                                           AutomationException

The Map Server Identify Result.

Product Availability

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

Specified by:

getMapServerIdentifyResult in interface IMapServerIdentifyObject

Returns:

A reference to a com.esri.arcgis.carto.IMapServerIdentifyResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapByRef

public void setMapByRef(IMap rhs1)
                 throws IOException,
                        AutomationException

The map into an identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMapByRef in interface IMapIdentifyObject

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBasicMapByRef

public void setBasicMapByRef(IBasicMap rhs1)
                      throws IOException,
                             AutomationException

The basic map into an identify object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBasicMapByRef in interface IBasicMapIdentifyObject

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.