com.esri.arcgis.controls
Class CustomizeDialog

java.lang.Object
  com.esri.arcgis.controls.CustomizeDialog

All Implemented Interfaces:

ICustomizeDialog, ICustomizeDialog2, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class CustomizeDialog
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ICustomizeDialog, ICustomizeDialog2, ISupportErrorInfo, IConnectionPointContainer

COM Class 'CustomizeDialog'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'CustomizeDialog is a modeless dialog that allows customization of one or more ToolbarControls.' 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.controls.ICustomizeDialog2

IID, IID8fac651f_f709_45b4_954f_0ee2f5ace78d, xxDummy

Fields inherited from interface com.esri.arcgis.controls.ICustomizeDialog

IID16f2d139_2810_4241_b495_b7d1539cec64

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

CustomizeDialog()
Constructs a CustomizeDialog using ArcGIS Engine.

CustomizeDialog(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CustomizeDialog theCustomizeDialog = (CustomizeDialog) obj;

Method Summary

void	addICustomizeDialogEventsListener(ICustomizeDialogEvents theListener) addICustomizeDialogEventsListener.
void	closeDialog() Closes the customize dialog.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
static java.lang.String	getClsid() getClsid.
java.lang.String	getCommandsCategory() The GUID of the component category used for commands.
java.lang.String	getDialogTitle() The title of the customize dialog.
java.lang.Object	getDoubleClickDestination() The ToolbarControl commands are added to when double clicked.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMenusCategory() The GUID of the component category used for menu definitions.
java.lang.String	getPalettesCategory() The GUID of the component category used for palette definitions.
java.lang.String	getToolbarsCategory() The GUID of the component category used for toolbar definitions.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isDialogActive() Indicates if the customize dialog is active on the screen.
boolean	isShowAddFromFile() Indicates if the 'Add From File' button is available on the customize dialog.
void	release() Release a CustomizeDialog.
void	removeICustomizeDialogEventsListener(ICustomizeDialogEvents theListener) removeICustomizeDialogEventsListener.
void	setCommandsCategory(java.lang.String pVal) The GUID of the component category used for commands.
void	setDialogTitle(java.lang.String pVal) The title of the customize dialog.
void	setDoubleClickDestination(java.lang.Object pToolbarControl) Sets the ToolbarControl commands are added to when double clicked.
void	setMenusCategory(java.lang.String pVal) The GUID of the component category used for menu definitions.
void	setPalettesCategory(java.lang.String pVal) The GUID of the component category used for palette definitions.
void	setShowAddFromFile(boolean pVal) Indicates if the 'Add From File' button is available on the customize dialog.
void	setToolbarsCategory(java.lang.String pVal) The GUID of the component category used for toolbar definitions.
void	setWindowPosition(int left, int top) Positions the customize dialog at the given screen co-ordinates.
void	startDialog(int hWndParent) Starts the modeless customize dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomizeDialog

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

Constructs a CustomizeDialog using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CustomizeDialog

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

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

addICustomizeDialogEventsListener

public void addICustomizeDialogEventsListener(ICustomizeDialogEvents theListener)
                                       throws java.io.IOException

addICustomizeDialogEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ICustomizeDialogEvents interface.

Throws:

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

removeICustomizeDialogEventsListener

public void removeICustomizeDialogEventsListener(ICustomizeDialogEvents theListener)
                                          throws java.io.IOException

removeICustomizeDialogEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.controls.ICustomizeDialogEvents interface.

Throws:

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

release

public void release()

Release a CustomizeDialog.

Specified by:

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

startDialog

public void startDialog(int hWndParent)
                 throws java.io.IOException,
                        AutomationException

Starts the modeless customize dialog.

Specified by:

startDialog in interface ICustomizeDialog

Parameters:

hWndParent - The hWndParent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCommandsCategory

public java.lang.String getCommandsCategory()
                                     throws java.io.IOException,
                                            AutomationException

The GUID of the component category used for commands.

Specified by:

getCommandsCategory in interface ICustomizeDialog

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCommandsCategory

public void setCommandsCategory(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException

The GUID of the component category used for commands.

Specified by:

setCommandsCategory in interface ICustomizeDialog

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolbarsCategory

public java.lang.String getToolbarsCategory()
                                     throws java.io.IOException,
                                            AutomationException

The GUID of the component category used for toolbar definitions.

Specified by:

getToolbarsCategory in interface ICustomizeDialog

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolbarsCategory

public void setToolbarsCategory(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException

The GUID of the component category used for toolbar definitions.

Specified by:

setToolbarsCategory in interface ICustomizeDialog

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

closeDialog

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

Closes the customize dialog.

Specified by:

closeDialog in interface ICustomizeDialog

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDialogActive

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

Indicates if the customize dialog is active on the screen.

Specified by:

isDialogActive in interface ICustomizeDialog

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDialogTitle

public java.lang.String getDialogTitle()
                                throws java.io.IOException,
                                       AutomationException

The title of the customize dialog.

Specified by:

getDialogTitle in interface ICustomizeDialog

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDialogTitle

public void setDialogTitle(java.lang.String pVal)
                    throws java.io.IOException,
                           AutomationException

The title of the customize dialog.

Specified by:

setDialogTitle in interface ICustomizeDialog

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDoubleClickDestination

public java.lang.Object getDoubleClickDestination()
                                           throws java.io.IOException,
                                                  AutomationException

The ToolbarControl commands are added to when double clicked.

Specified by:

getDoubleClickDestination in interface ICustomizeDialog

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDoubleClickDestination

public void setDoubleClickDestination(java.lang.Object pToolbarControl)
                               throws java.io.IOException,
                                      AutomationException

Sets the ToolbarControl commands are added to when double clicked.

Specified by:

setDoubleClickDestination in interface ICustomizeDialog

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowAddFromFile

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

Indicates if the 'Add From File' button is available on the customize dialog.

Specified by:

isShowAddFromFile in interface ICustomizeDialog

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowAddFromFile

public void setShowAddFromFile(boolean pVal)
                        throws java.io.IOException,
                               AutomationException

Indicates if the 'Add From File' button is available on the customize dialog.

Specified by:

setShowAddFromFile in interface ICustomizeDialog

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMenusCategory

public java.lang.String getMenusCategory()
                                  throws java.io.IOException,
                                         AutomationException

The GUID of the component category used for menu definitions.

Specified by:

getMenusCategory in interface ICustomizeDialog

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMenusCategory

public void setMenusCategory(java.lang.String pVal)
                      throws java.io.IOException,
                             AutomationException

The GUID of the component category used for menu definitions.

Specified by:

setMenusCategory in interface ICustomizeDialog

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPalettesCategory

public java.lang.String getPalettesCategory()
                                     throws java.io.IOException,
                                            AutomationException

The GUID of the component category used for palette definitions.

Specified by:

getPalettesCategory in interface ICustomizeDialog2

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPalettesCategory

public void setPalettesCategory(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException

The GUID of the component category used for palette definitions.

Specified by:

setPalettesCategory in interface ICustomizeDialog2

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWindowPosition

public void setWindowPosition(int left,
                              int top)
                       throws java.io.IOException,
                              AutomationException

Positions the customize dialog at the given screen co-ordinates.

Specified by:

setWindowPosition in interface ICustomizeDialog2

Parameters:

left - The left (in)

top - The top (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

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

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.