com.esri.arcgis.catalogUI
Class GxDialog

java.lang.Object
  com.esri.arcgis.catalogUI.GxDialog

All Implemented Interfaces:

IGxObjectFilterCollection, IGxSelectionEvents, IGxDialog, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable, java.util.EventListener

public class GxDialog
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxDialog, IGxObjectFilterCollection, IGxSelectionEvents

COM Class 'GxDialog'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalogUI.olb'

Description 'Provides access to GX browser dialog.' 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.catalogUI.IGxDialog

IID, IIDeab9ce29_e777_11d1_aee7_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectFilterCollection

IID, IID41f5c02d_d9c8_11d3_a67d_0008c7d3ae8d, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxSelectionEvents

IID, IIDbdbbb3f9_d0b2_11d1_aed9_080009ec734b, xxDummy

Constructor Summary

GxDialog()
Constructs a GxDialog using ArcGIS Engine.

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

Method Summary

void	addFilter(IGxObjectFilter filter, boolean defaultFilter) Add a filter to the filter collection, and specify if it is to selected by default.
boolean	doModalOpen(int parentWindow, IEnumGxObject[] selection) Opens the dialog to choose data.
boolean	doModalSave(int parentWindow) Opens the dialog to save data.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IGxObject	getFinalLocation() The dialog's final location.
IGxCatalog	getInternalCatalog() The catalog object used internally by the GxDialog.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The text in the Name text box (only for DoModalSave).
IGxObjectFilter	getObjectFilter() The object filter.
int	hashCode() the hashcode for this object
boolean	isReplacingObject() Indicates if an object already exists with the name supplied by the user, and is being replaced.
void	onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent) Called when the selection contents have changed.
void	release() Release a GxDialog.
void	removeAllFilters() Remove all filters from the filter collection.
void	setAllowMultiSelect(boolean rhs1) Indicates if multiple items may be selected.
void	setButtonCaption(java.lang.String rhs1) The caption to use for the Open or Save button.
void	setName(java.lang.String name) The text in the Name text box (only for DoModalSave).
void	setObjectFilterByRef(IGxObjectFilter filter) The object filter.
void	setRememberLocation(boolean rhs1) Indicates if the dialog should use the final location as the next starting location.
void	setStartingLocation(java.lang.Object rhs1) The dialog's starting location.
void	setTitle(java.lang.String rhs1) The dialog's title.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GxDialog

public GxDialog()
         throws java.io.IOException,
                java.net.UnknownHostException

Constructs a GxDialog using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxDialog

public GxDialog(java.lang.Object obj)
         throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems GxDialog theGxDialog = (GxDialog) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

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

Specified by:

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

setAllowMultiSelect

public void setAllowMultiSelect(boolean rhs1)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setAllowMultiSelect in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(java.lang.String rhs1)
              throws java.io.IOException,
                     AutomationException

The dialog's title.

Specified by:

setTitle in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setButtonCaption

public void setButtonCaption(java.lang.String rhs1)
                      throws java.io.IOException,
                             AutomationException

The caption to use for the Open or Save button.

Specified by:

setButtonCaption in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

The text in the Name text box (only for DoModalSave).

Specified by:

setName in interface IGxDialog

Parameters:

name - The name (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

The text in the Name text box (only for DoModalSave).

Specified by:

getName in interface IGxDialog

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReplacingObject

public boolean isReplacingObject()
                          throws java.io.IOException,
                                 AutomationException

Indicates if an object already exists with the name supplied by the user, and is being replaced.

Specified by:

isReplacingObject in interface IGxDialog

Returns:

The replacingObject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartingLocation

public void setStartingLocation(java.lang.Object rhs1)
                         throws java.io.IOException,
                                AutomationException

The dialog's starting location. This can be an IGxObject or a text-string containing the full name of an object.

Specified by:

setStartingLocation in interface IGxDialog

Parameters:

rhs1 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFinalLocation

public IGxObject getFinalLocation()
                           throws java.io.IOException,
                                  AutomationException

The dialog's final location.

Specified by:

getFinalLocation in interface IGxDialog

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRememberLocation

public void setRememberLocation(boolean rhs1)
                         throws java.io.IOException,
                                AutomationException

Indicates if the dialog should use the final location as the next starting location. True, by default.

Specified by:

setRememberLocation in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setObjectFilterByRef

public void setObjectFilterByRef(IGxObjectFilter filter)
                          throws java.io.IOException,
                                 AutomationException

The object filter.

Specified by:

setObjectFilterByRef in interface IGxDialog

Parameters:

filter - A reference to a com.esri.arcgis.catalog.IGxObjectFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getObjectFilter

public IGxObjectFilter getObjectFilter()
                                throws java.io.IOException,
                                       AutomationException

The object filter.

Specified by:

getObjectFilter in interface IGxDialog

Returns:

A reference to a com.esri.arcgis.catalog.IGxObjectFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInternalCatalog

public IGxCatalog getInternalCatalog()
                              throws java.io.IOException,
                                     AutomationException

The catalog object used internally by the GxDialog.

Specified by:

getInternalCatalog in interface IGxDialog

Returns:

A reference to a com.esri.arcgis.catalog.IGxCatalog

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doModalOpen

public boolean doModalOpen(int parentWindow,
                           IEnumGxObject[] selection)
                    throws java.io.IOException,
                           AutomationException

Opens the dialog to choose data.

Specified by:

doModalOpen in interface IGxDialog

Parameters:

parentWindow - The parentWindow (A COM typedef) (in)

selection - A reference to a com.esri.arcgis.catalog.IEnumGxObject (out: use single element array)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

doModalSave

public boolean doModalSave(int parentWindow)
                    throws java.io.IOException,
                           AutomationException

Opens the dialog to save data.

Specified by:

doModalSave in interface IGxDialog

Parameters:

parentWindow - The parentWindow (A COM typedef) (in)

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addFilter

public void addFilter(IGxObjectFilter filter,
                      boolean defaultFilter)
               throws java.io.IOException,
                      AutomationException

Add a filter to the filter collection, and specify if it is to selected by default.

Specified by:

addFilter in interface IGxObjectFilterCollection

Parameters:

filter - A reference to a com.esri.arcgis.catalog.IGxObjectFilter (in)

defaultFilter - The defaultFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllFilters

public void removeAllFilters()
                      throws java.io.IOException,
                             AutomationException

Remove all filters from the filter collection.

Specified by:

removeAllFilters in interface IGxObjectFilterCollection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onSelectionChanged

public void onSelectionChanged(IGxSelectionEventsOnSelectionChangedEvent theEvent)
                        throws java.io.IOException,
                               AutomationException

Called when the selection contents have changed.

Specified by:

onSelectionChanged in interface IGxSelectionEvents

Parameters:

theEvent - The event

Throws:

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

AutomationException - If the ArcObject component throws an exception.