com.esri.arcgis.trackinganalyst
Class TxCatalogDialog

java.lang.Object
  com.esri.arcgis.trackinganalyst.TxCatalogDialog

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITxCatalogDialog, Serializable

public class TxCatalogDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITxCatalogDialog, ISupportErrorInfo

This object provides a Dialog that can be used to graphically browse for GIS data.

Description

This object provides a Dialog that can be used to graphically browse for GIS data. This object also controls the dialog’s title, button caption and section property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:

Serialized Form

Constructor Summary

TxCatalogDialog()
Constructs a TxCatalogDialog using ArcGIS Engine.

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

Method Summary

boolean	doModalOpen(int lParentWindow, IEnumTxObject[] ppiSelection) Opens the dialog to choose data.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
ITxCatalog	getInternalCatalog() The catalog object used internally by the GxDialog.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	setAllowMultiSelect(boolean rhs1) Indicates if multiple items may be selected.
void	setButtonCaption(String rhs1) The caption to use for the Open or Save button.
void	setTitle(String rhs1) The dialog's title.

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

TxCatalogDialog

public TxCatalogDialog()
                throws IOException,
                       UnknownHostException

Constructs a TxCatalogDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TxCatalogDialog

public TxCatalogDialog(Object obj)
                throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems TxCatalogDialog theTxCatalogDialog = (TxCatalogDialog) obj;

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

getInternalCatalog

public ITxCatalog getInternalCatalog()
                              throws IOException,
                                     AutomationException

The catalog object used internally by the GxDialog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

getInternalCatalog in interface ITxCatalogDialog

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITxCatalog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setButtonCaption

public void setButtonCaption(String rhs1)
                      throws IOException,
                             AutomationException

The caption to use for the Open or Save button.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setButtonCaption in interface ITxCatalogDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(String rhs1)
              throws IOException,
                     AutomationException

The dialog's title.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setTitle in interface ITxCatalogDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModalOpen

public boolean doModalOpen(int lParentWindow,
                           IEnumTxObject[] ppiSelection)
                    throws IOException,
                           AutomationException

Opens the dialog to choose data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

doModalOpen in interface ITxCatalogDialog

Parameters:

lParentWindow - The lParentWindow (in)

ppiSelection - A reference to a com.esri.arcgis.trackinganalyst.IEnumTxObject (out: use single element array)

Returns:

The pbvarResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllowMultiSelect

public void setAllowMultiSelect(boolean rhs1)
                         throws IOException,
                                AutomationException

Indicates if multiple items may be selected. False, by default.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Specified by:

setAllowMultiSelect in interface ITxCatalogDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.