com.esri.arcgis.cartoUI
Class IdentifyDialog

java.lang.Object
  com.esri.arcgis.cartoUI.IdentifyDialog

All Implemented Interfaces:

IIdentifyDialog, IIdentifyDialog2, IIdentifyDialogProps, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class IdentifyDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIdentifyDialog, IIdentifyDialog2, IIdentifyDialogProps

Identifying layers by OID or a point.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

IdentifyDialog()
Constructs a IdentifyDialog using ArcGIS Engine.

IdentifyDialog(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IdentifyDialog theIdentifyDialog = (IdentifyDialog) obj;

Method Summary

void	addLayerIdentifyObject(ILayer pLayer, Object object, IPoint location) Add layer and show object hit at given location.
void	addLayerIdentifyOID(ILayer pLayer, int oid) Add layer and show object of the given OID.
void	addLayerIdentifyPoint(ILayer pLayer, int x, int y) Add layer and show objects that contain the given point.
void	addLayerIdentifyPoint(ILayer pLayer, int x, int y, int tolerance, ITrackCancel trackCancel) Add layer and show objects that contain the given point.
void	addTableIdentifyOID(ITable pSTable, ITable pNewOIDCopyTable, int oid) Add table and show row of the given OID.
void	clearLayers() Clear shown layers.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
short	getFlashEffect() The flash effect.
IEnumLayer	getLayers() The layers eligible for searching.
int	hashCode() the hashcode for this object
boolean	isHideContextMenu() Indicates if the context menu for identify results should be hidden when the user right-clicks.
boolean	isHideLayersComboBox() Indicates whether to hide Layers ComboBox in Identify Dialog.
boolean	isTopmostOnly() Indicates if the search stops once a result has been found.
boolean	isVisible() Indicates if the Identify Dialog is visible.
void	selectLayer(ILayer pLayer) Select a specific layer in the combobox.
void	setBasicMapByRef(IBasicMap rhs1) The basic map of identifying layers.
void	setDisplayByRef(IDisplay rhs1) The display.
void	setFlashEffect(short effect) The flash effect.
void	setHideContextMenu(boolean hide) Indicates if the context menu for identify results should be hidden when the user right-clicks.
void	setHideLayersComboBox(boolean pHide) Indicates whether to hide Layers ComboBox in Identify Dialog.
void	setMapByRef(IMap rhs1) The map of identifying layers.
void	setVisible(boolean vis) Indicates if the Identify Dialog is visible.
void	show() Show 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

IdentifyDialog

public IdentifyDialog()
               throws IOException,
                      UnknownHostException

Constructs a IdentifyDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IdentifyDialog

public IdentifyDialog(Object obj)
               throws IOException

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

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

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

setMapByRef

public void setMapByRef(IMap rhs1)
                 throws IOException,
                        AutomationException

The map of identifying layers.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setMapByRef in interface IIdentifyDialog

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.

setDisplayByRef

public void setDisplayByRef(IDisplay rhs1)
                     throws IOException,
                            AutomationException

The display.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDisplayByRef in interface IIdentifyDialog

Parameters:

rhs1 - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearLayers

public void clearLayers()
                 throws IOException,
                        AutomationException

Clear shown layers.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

clearLayers in interface IIdentifyDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayerIdentifyPoint

public void addLayerIdentifyPoint(ILayer pLayer,
                                  int x,
                                  int y)
                           throws IOException,
                                  AutomationException

Add layer and show objects that contain the given point.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addLayerIdentifyPoint in interface IIdentifyDialog

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

x - The x (in)

y - The y (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayerIdentifyOID

public void addLayerIdentifyOID(ILayer pLayer,
                                int oid)
                         throws IOException,
                                AutomationException

Add layer and show object of the given OID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addLayerIdentifyOID in interface IIdentifyDialog

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

oid - The oid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show()
          throws IOException,
                 AutomationException

Show dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IIdentifyDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTableIdentifyOID

public void addTableIdentifyOID(ITable pSTable,
                                ITable pNewOIDCopyTable,
                                int oid)
                         throws IOException,
                                AutomationException

Add table and show row of the given OID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addTableIdentifyOID in interface IIdentifyDialog2

Parameters:

pSTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

pNewOIDCopyTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

oid - The oid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the Identify Dialog is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isVisible in interface IIdentifyDialog2

Returns:

The vis

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean vis)
                throws IOException,
                       AutomationException

Indicates if the Identify Dialog is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setVisible in interface IIdentifyDialog2

Parameters:

vis - The vis (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideLayersComboBox

public void setHideLayersComboBox(boolean pHide)
                           throws IOException,
                                  AutomationException

Indicates whether to hide Layers ComboBox in Identify Dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setHideLayersComboBox in interface IIdentifyDialog2

Parameters:

pHide - The pHide (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideLayersComboBox

public boolean isHideLayersComboBox()
                             throws IOException,
                                    AutomationException

Indicates whether to hide Layers ComboBox in Identify Dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isHideLayersComboBox in interface IIdentifyDialog2

Returns:

The pHide

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 of identifying layers.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setBasicMapByRef in interface IIdentifyDialog2

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.

addLayerIdentifyPoint

public void addLayerIdentifyPoint(ILayer pLayer,
                                  int x,
                                  int y,
                                  int tolerance,
                                  ITrackCancel trackCancel)
                           throws IOException,
                                  AutomationException

Add layer and show objects that contain the given point.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addLayerIdentifyPoint in interface IIdentifyDialog2

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

x - The x (in)

y - The y (in)

tolerance - The tolerance (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideContextMenu

public boolean isHideContextMenu()
                          throws IOException,
                                 AutomationException

Indicates if the context menu for identify results should be hidden when the user right-clicks.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isHideContextMenu in interface IIdentifyDialog2

Returns:

The hide

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideContextMenu

public void setHideContextMenu(boolean hide)
                        throws IOException,
                               AutomationException

Indicates if the context menu for identify results should be hidden when the user right-clicks.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setHideContextMenu in interface IIdentifyDialog2

Parameters:

hide - The hide (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayerIdentifyObject

public void addLayerIdentifyObject(ILayer pLayer,
                                   Object object,
                                   IPoint location)
                            throws IOException,
                                   AutomationException

Add layer and show object hit at given location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

addLayerIdentifyObject in interface IIdentifyDialog2

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

object - A reference to another Object (IUnknown) (in)

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

selectLayer

public void selectLayer(ILayer pLayer)
                 throws IOException,
                        AutomationException

Select a specific layer in the combobox. This only works if the dialog is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

selectLayer in interface IIdentifyDialog2

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayers

public IEnumLayer getLayers()
                     throws IOException,
                            AutomationException

The layers eligible for searching.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLayers in interface IIdentifyDialogProps

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTopmostOnly

public boolean isTopmostOnly()
                      throws IOException,
                             AutomationException

Indicates if the search stops once a result has been found.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isTopmostOnly in interface IIdentifyDialogProps

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlashEffect

public short getFlashEffect()
                     throws IOException,
                            AutomationException

The flash effect.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFlashEffect in interface IIdentifyDialogProps

Returns:

The effect

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlashEffect

public void setFlashEffect(short effect)
                    throws IOException,
                           AutomationException

The flash effect.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setFlashEffect in interface IIdentifyDialogProps

Parameters:

effect - The effect (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.