com.esri.arcgis.addins.desktop
Class DockableWindow

java.lang.Object
  com.esri.arcgis.addins.desktop.DockableWindow

public abstract class DockableWindow
extends Object

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

Constructor Summary

DockableWindow()

Method Summary

abstract Component	createUI() Called when the user interface of the dockable window is being initialized.
void	dispose() Disposes this dockable window.
void	init(IApplication app) Initializes this dockable window with the ArcGIS application it is hosted in.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockableWindow

public DockableWindow()

Method Detail

createUI

public abstract Component createUI()

Called when the user interface of the dockable window is being initialized. Subclasses must implement this method to define the dockable window's user interface.

Parameters:

component - the Swing or AWT component (or container) that constitutes the dockable window's UI

Throws:

IOException - if there are interop problems.

AutomationException - if the component throws an ArcObjects exception.

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).