com.esri.arcgis.framework
Class IDockableWindowProxy

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

All Implemented Interfaces:

IDockableWindow, Externalizable, Serializable

public class IDockableWindowProxy
extends com.esri.arcgis.interop.Dispatch
implements IDockableWindow, Serializable

Provides access to members that define and control a dockable window.

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 IDockableWindow interface is used to query the properties of a dockable window such as the Caption, Name, and ID. This interface also has methods to return whether the window is currently visible, to display the window, and to dock the window in a particular location on the application.

Use the IDockableWindowManager::GetDockableWindow method to get a reference to a particular 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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	dock(int dockFlags) Docks or undocks this docking window.
String	getCaption() The caption of the dockable window.
IUID	getID() The unique id for this dockable window.
String	getName() The name of the dockable window.
Object	getUserData() User defined data.
boolean	isVisible() Indicates if this docking window is visible.
void	removeListener(String iidStr, Object theListener)
void	setCaption(String caption) The caption of the dockable window.
void	show(boolean show) Hides or shows the dockable window.

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

IDockableWindowProxy

public IDockableWindowProxy()

IDockableWindowProxy

public IDockableWindowProxy(Object obj)
                     throws IOException

Throws:

IOException

IDockableWindowProxy

protected IDockableWindowProxy(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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IDockableWindow

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException

The caption of the dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCaption in interface IDockableWindow

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCaption

public void setCaption(String caption)
                throws IOException,
                       AutomationException

The caption of the dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCaption in interface IDockableWindow

Parameters:

caption - The caption (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public IUID getID()
           throws IOException,
                  AutomationException

The unique id for this dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getID in interface IDockableWindow

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show(boolean show)
          throws IOException,
                 AutomationException

Hides or shows the dockable window.

Description

Show specifies whether the dockable window should be shown or hidden. Use True to show the window and False to hide the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IDockableWindow

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if this docking window is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isVisible in interface IDockableWindow

Returns:

The bVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dock

public void dock(int dockFlags)
          throws IOException,
                 AutomationException

Docks or undocks this docking window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

dock in interface IDockableWindow

Parameters:

dockFlags - A com.esri.arcgis.framework.esriDockFlags constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserData

public Object getUserData()
                   throws IOException,
                          AutomationException

User defined data.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getUserData in interface IDockableWindow

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.