com.esri.arcgis.framework
Class IDockableWindowDefProxy

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

All Implemented Interfaces:

IDockableWindowDef, Externalizable, Serializable

public class IDockableWindowDefProxy
extends com.esri.arcgis.interop.Dispatch
implements IDockableWindowDef, Serializable

Provides access to members that define a dockable window.

Description

A dockable window definition is used by the application to create a dockable window. A dockable window is an auxilary window that can be used to display data. This window can exist in a modeless floating state or be attached to the main application window.

Remarks

This interface allows you to set properties such as caption and name. You use the ChildHWND property to define what the window will consist of by passing in an hWnd of a control such as a form, listbox, etc. The OnCreate method provides a hook to the application and allows you to perform any necessary initialization of the window. The OnDestroy method is called when the window is about to be destroyed.

The class you create is a definition for a dockable window; it is not actually a dockable window object. Once your class is registered in one of the dockable window component categories, the application uses the definition of the dockable window in your class to create the actual dockable window.

When To Use

To create your own dockable window, you would implement the IDockableWindowDef interface.

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

Fields inherited from interface com.esri.arcgis.framework.IDockableWindowDef

IID, IID3d1fa10a_f154_11d3_a67e_0008c7df97b9, xxDummy

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getCaption() The caption of the dockable window.
int	getChildHWND() The hWnd of the window to be embedded in a dockable window.
String	getName() The name of the dockable window.
Object	getUserData() User defined data.
void	onCreate(Object hook) Occurs when this dockable window is created and provides access to the application.
void	onDestroy() Occurs when the docking window is about to be destroyed.
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

IDockableWindowDefProxy

public IDockableWindowDefProxy()

IDockableWindowDefProxy

public IDockableWindowDefProxy(Object obj)
                        throws IOException

Throws:

IOException

IDockableWindowDefProxy

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

onCreate

public void onCreate(Object hook)
              throws IOException,
                     AutomationException

Occurs when this dockable window is created and provides access to the application.

Specified by:

onCreate in interface IDockableWindowDef

Parameters:

hook - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildHWND

public int getChildHWND()
                 throws IOException,
                        AutomationException

The hWnd of the window to be embedded in a dockable window.

Specified by:

getChildHWND in interface IDockableWindowDef

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the dockable window.

Specified by:

getName in interface IDockableWindowDef

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.

Specified by:

getCaption in interface IDockableWindowDef

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDestroy

public void onDestroy()
               throws IOException,
                      AutomationException

Occurs when the docking window is about to be destroyed.

Specified by:

onDestroy in interface IDockableWindowDef

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.

Specified by:

getUserData in interface IDockableWindowDef

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.