com.esri.arcgis.framework
Class IDockableWindowManagerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.framework.IDockableWindowManagerProxy

All Implemented Interfaces:

IDockableWindowManager, Externalizable, Serializable

public class IDockableWindowManagerProxy
extends com.esri.arcgis.interop.Dispatch
implements IDockableWindowManager, Serializable

Provides access to a method that finds a dockable window in the application.

Description

A dockable window is a window that can exist in a floating state or be attached to the main application window. The Table of Contents in ArcMap and the Tree View in ArcCatalog are examples of dockable windows.

Remarks

The following code finds the ArcMap Table of Contents dockable window and, if it's currently visible, the TOC is docked on the right side of the application. You would get m_app from the hook in ICommand::OnCreate().

When To Use

The Application object implements the IDockableWindowManager interface that is used to get access to a particular dockable window. The GetDockableWindow method finds a dockable window using the UID of the dockable window.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IDockableWindowManagerProxy()
	IDockableWindowManagerProxy(Object obj)
protected	IDockableWindowManagerProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IDockableWindow	getDockableWindow(IUID dockWnd) Finds a dockable window looking first in the collection and then in the category.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IDockableWindowManagerProxy

public IDockableWindowManagerProxy()

IDockableWindowManagerProxy

public IDockableWindowManagerProxy(Object obj)
                            throws IOException

Throws:

IOException

IDockableWindowManagerProxy

protected IDockableWindowManagerProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getDockableWindow

public IDockableWindow getDockableWindow(IUID dockWnd)
                                  throws IOException,
                                         AutomationException

Finds a dockable window looking first in the collection and then in the category.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDockableWindow in interface IDockableWindowManager

Parameters:

dockWnd - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

A reference to a com.esri.arcgis.framework.IDockableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.