com.esri.arcgis.catalogUI
Interface IGxDialog

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GxDialog, IGxDialogProxy

public interface IGxDialog
extends java.io.Serializable

COM Interface 'IGxDialog'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriCatalogUI.olb'

Description: 'Provides access to members that control the GxDialog.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDeab9ce29_e777_11d1_aee7_080009ec734b
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	doModalOpen(int parentWindow, IEnumGxObject[] selection) Opens the dialog to choose data.
boolean	doModalSave(int parentWindow) Opens the dialog to save data.
IGxObject	getFinalLocation() The dialog's final location.
IGxCatalog	getInternalCatalog() The catalog object used internally by the GxDialog.
java.lang.String	getName() The text in the Name text box (only for DoModalSave).
IGxObjectFilter	getObjectFilter() The object filter.
boolean	isReplacingObject() Indicates if an object already exists with the name supplied by the user, and is being replaced.
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.

Field Detail

IIDeab9ce29_e777_11d1_aee7_080009ec734b

static final int IIDeab9ce29_e777_11d1_aee7_080009ec734b

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setAllowMultiSelect

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

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTitle

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

The dialog's title.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setButtonCaption

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

The caption to use for the Open or Save button.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

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

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

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

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReplacingObject

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

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

Returns:

The replacingObject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStartingLocation

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.

Parameters:

rhs1 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFinalLocation

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

The dialog's final location.

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

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.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setObjectFilterByRef

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

The object filter.

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

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

The object filter.

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

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

The catalog object used internally by the GxDialog.

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

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

Opens the dialog to choose data.

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

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

Opens the dialog to save data.

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.