com.esri.arcgis.arcmapui
Class TOCDockableWindow

java.lang.Object
  extended by com.esri.arcgis.arcmapui.TOCDockableWindow
All Implemented Interfaces:
IDockableWindowDef, IDockableWindowImageDef, IDockableWindowInitialPlacement, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class TOCDockableWindow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDockableWindowDef, IDockableWindowImageDef, IDockableWindowInitialPlacement

ESRI TOC Dockable Window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.IDockableWindowImageDef
IID, IID08f4fc5d_c23f_4210_b289_1350ed5632ed, xxDummy
 
Fields inherited from interface com.esri.arcgis.framework.IDockableWindowInitialPlacement
IID, IID1ec80980_7a02_426d_bd2b_c6d3beb2ed54, xxDummy
 
Constructor Summary
TOCDockableWindow()
          Constructs a TOCDockableWindow using ArcGIS Engine.
TOCDockableWindow(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TOCDockableWindow theTOCDockableWindow = (TOCDockableWindow) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 int getBitmap()
          Provide a bitmap for dockviews
 String getCaption()
          The caption of the dockable window.
 int getChildHWND()
          The hWnd of the window to be embedded in a dockable window.
static String getClsid()
          getClsid.
 int getDockPosition()
          DockPosition
 int getHeight()
          Height
 String getName()
          The name of the dockable window.
 IUID getNeighbor()
          Neighbor
 Object getUserData()
          User defined data.
 int getWidth()
          Width
 int hashCode()
          the hashcode for this object
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TOCDockableWindow

public TOCDockableWindow()
                  throws IOException,
                         UnknownHostException
Constructs a TOCDockableWindow using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TOCDockableWindow

public TOCDockableWindow(Object obj)
                  throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TOCDockableWindow theTOCDockableWindow = (TOCDockableWindow) obj;

Construct a TOCDockableWindow using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TOCDockableWindow.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

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.

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.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException
Height

Specified by:
getHeight in interface IDockableWindowInitialPlacement
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException
Width

Specified by:
getWidth in interface IDockableWindowInitialPlacement
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDockPosition

public int getDockPosition()
                    throws IOException,
                           AutomationException
DockPosition

Specified by:
getDockPosition in interface IDockableWindowInitialPlacement
Returns:
A com.esri.arcgis.framework.esriDockFlags constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNeighbor

public IUID getNeighbor()
                 throws IOException,
                        AutomationException
Neighbor

Specified by:
getNeighbor in interface IDockableWindowInitialPlacement
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.