com.esri.arcgis.addinframework
Class InternalDockableWindow

java.lang.Object
  com.esri.arcgis.addinframework.AddIn
      com.esri.arcgis.addinframework.InternalDockableWindow

All Implemented Interfaces:

IDockableWindowDef, IDockableWindowImageDef, IDockableWindowInitialPlacement, Serializable

public class InternalDockableWindow
extends AddIn
implements IDockableWindowDef, IDockableWindowInitialPlacement, IDockableWindowImageDef

Abstract base implementation of ArcGIS dockable windows.

This class should be subclassed by clients wishing to define new dockable windows. The name of the subclass should be given as the "class" attribute in a DockableWindow extension contributed to the ArcGIS application framework

For example, the add-in's XML markup might contain:

      <DockableWindows>
        <DockableWindow 
                id="com.acme.addins.AcmeDockable" 
                class="com.acme.addins.AcmeDockable" 
                caption="Selected Features Count"
                name="SelCountWindow">
                  <InitialPlacement 
                          height="300" 
                          width="300" 
                          state="pinned" 
                          position="right" 
                          neighbor=""/>
        </DockableWindow>
      </DockableWindows>
 

where com.acme.addins.AcmeDockable is the name of the DockableWindow subclass.

Subclasses must implement the following methods:

• createUI - to create the dockable window's user interface

Subclasses may extend or reimplement the following methods as required:

• init - to initializes this dockable window and get a reference to the hosting ArcGIS application
• dispose - extend to provide additional cleanup

See Also:

Serialized Form

Field Summary

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

IID, IID3d1fa10a_f154_11d3_a67e_0008c7df97b9, xxDummy

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

IID, IID1ec80980_7a02_426d_bd2b_c6d3beb2ed54, xxDummy

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

IID, IID08f4fc5d_c23f_4210_b289_1350ed5632ed, xxDummy

Constructor Summary

InternalDockableWindow()

Method Summary

void	dispose() Disposes this dockable window.
int	getBitmap() Provide a bitmap for dockviews
void	init(IApplication app) Initializes this dockable window with the ArcGIS application it is hosted in.
void	seed(Object delegate)

Methods inherited from class com.esri.arcgis.addinframework.AddIn

getApp, nativeGetPictureFromIStream, nativeGetPictureFromStream, read, readCursorFromStream, readPictureFromIStream, readPictureFromStream, readSubnode, setParameters

Methods inherited from class java.lang.Object

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

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

getCaption, getChildHWND, getName, getUserData, onCreate, onDestroy

Methods inherited from interface com.esri.arcgis.framework.IDockableWindowInitialPlacement

getDockPosition, getHeight, getNeighbor, getWidth

Constructor Detail

InternalDockableWindow

public InternalDockableWindow()

Method Detail

init

public void init(IApplication app)
          throws IOException,
                 AutomationException

Initializes this dockable window with the ArcGIS application it is hosted in.

This method is automatically called by the host ArcGIS application when the dockable window is initialized. It marks the start of the dockable window's lifecycle. Clients must not call this method.

Parameters:

app - the ArcGIS application that hosts this dockable window

Throws:

IOException - if there are interop problems.

AutomationException - if the component throws an ArcObjects exception.

dispose

public void dispose()

Disposes this dockable window.

This is the last method called on the DockableWindow. At this point the dockable window component's have been disposed.

Within this method a dockable window may release any resources, fonts, images, etc. held by this dockable window.

Clients should not call this method (the framework calls this method at appropriate times).

seed

public void seed(Object delegate)

Specified by:

seed in class AddIn

getBitmap

public int getBitmap()
              throws IOException,
                     AutomationException

Provide a bitmap for dockviews

Specified by:

getBitmap in interface IDockableWindowImageDef

Returns:

The bitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.