com.esri.arcgis.arcmapui
Class TableDockWindow

java.lang.Object
  com.esri.arcgis.arcmapui.TableDockWindow

All Implemented Interfaces:

ITableDockWindowAdmin, IDockableWindowDef, IDockableWindowImageDef, IDockableWindowInitialPlacement, com.esri.arcgis.interop.RemoteObjRef, Serializable

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

Table dock window

Product Availability

Available with ArcGIS Desktop.

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

TableDockWindow()
Constructs a TableDockWindow using ArcGIS Engine.

TableDockWindow(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TableDockWindow theTableDockWindow = (TableDockWindow) obj;

Method Summary

void	close(ITableWindow pTableWindow) Close table pane.
void	closeAllTables() Close all table panes.
boolean	equals(Object o) Compare this object with another
void	findOpenTableWindows(ISet[] pTableWindows) Gets all the open table windows.
ITableWindow	findViaFeatureLayer(IFeatureLayer pFeatureLayer, boolean showSelected) Is table (of a featurelayer) already being displayed.
ITableWindow	findViaLayer(ILayer pLayer) Is table (of a layer) already being displayed.
ITableWindow	findViaStandaloneTable(IStandaloneTable pStandaloneTable) Is table (of a standalonetable) already being displayed.
ITableWindow	findViaTable(ITable pTable, boolean showSelected) Is table already being displayed.
ITableWindow	findViaUnknown(Object pUnknown) Is table already being displayed.
ITableWindow	getActiveTableWindow() Gets the active table window.
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	isOpen(ITableWindow pTableWindow, boolean[] pIsOpen) Is Table window open.
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	setActiveWindow(ITableWindow pTableWindow) Set the active window.
void	show(ITableWindow pTableWindow, boolean show) Show Table pane.
void	showNextTable(boolean forward) Show next table pane.
void	updateTitle(ITableWindow pTableWindow) Update the pane title.

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

TableDockWindow

public TableDockWindow()
                throws IOException,
                       UnknownHostException

Constructs a TableDockWindow using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TableDockWindow

public TableDockWindow(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TableDockWindow theTableDockWindow = (TableDockWindow) obj;

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

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.

show

public void show(ITableWindow pTableWindow,
                 boolean show)
          throws IOException,
                 AutomationException

Show Table pane.

Product Availability

Available with ArcGIS Desktop.

Specified by:

show in interface ITableDockWindowAdmin

Parameters:

pTableWindow - A reference to a com.esri.arcgis.arcmapui.ITableWindow (in)

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

public void close(ITableWindow pTableWindow)
           throws IOException,
                  AutomationException

Close table pane.

Product Availability

Available with ArcGIS Desktop.

Specified by:

close in interface ITableDockWindowAdmin

Parameters:

pTableWindow - A reference to a com.esri.arcgis.arcmapui.ITableWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeAllTables

public void closeAllTables()
                    throws IOException,
                           AutomationException

Close all table panes.

Product Availability

Available with ArcGIS Desktop.

Specified by:

closeAllTables in interface ITableDockWindowAdmin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOpen

public void isOpen(ITableWindow pTableWindow,
                   boolean[] pIsOpen)
            throws IOException,
                   AutomationException

Is Table window open.

Product Availability

Available with ArcGIS Desktop.

Specified by:

isOpen in interface ITableDockWindowAdmin

Parameters:

pTableWindow - A reference to a com.esri.arcgis.arcmapui.ITableWindow (in)

pIsOpen - The pIsOpen (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaTable

public ITableWindow findViaTable(ITable pTable,
                                 boolean showSelected)
                          throws IOException,
                                 AutomationException

Is table already being displayed.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaTable in interface ITableDockWindowAdmin

Parameters:

pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

showSelected - The showSelected (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaLayer

public ITableWindow findViaLayer(ILayer pLayer)
                          throws IOException,
                                 AutomationException

Is table (of a layer) already being displayed.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaLayer in interface ITableDockWindowAdmin

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaFeatureLayer

public ITableWindow findViaFeatureLayer(IFeatureLayer pFeatureLayer,
                                        boolean showSelected)
                                 throws IOException,
                                        AutomationException

Is table (of a featurelayer) already being displayed.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaFeatureLayer in interface ITableDockWindowAdmin

Parameters:

pFeatureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

showSelected - The showSelected (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaStandaloneTable

public ITableWindow findViaStandaloneTable(IStandaloneTable pStandaloneTable)
                                    throws IOException,
                                           AutomationException

Is table (of a standalonetable) already being displayed.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaStandaloneTable in interface ITableDockWindowAdmin

Parameters:

pStandaloneTable - A reference to a com.esri.arcgis.carto.IStandaloneTable (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findViaUnknown

public ITableWindow findViaUnknown(Object pUnknown)
                            throws IOException,
                                   AutomationException

Is table already being displayed.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findViaUnknown in interface ITableDockWindowAdmin

Parameters:

pUnknown - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findOpenTableWindows

public void findOpenTableWindows(ISet[] pTableWindows)
                          throws IOException,
                                 AutomationException

Gets all the open table windows.

Product Availability

Available with ArcGIS Desktop.

Specified by:

findOpenTableWindows in interface ITableDockWindowAdmin

Parameters:

pTableWindows - A reference to a com.esri.arcgis.system.ISet (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTitle

public void updateTitle(ITableWindow pTableWindow)
                 throws IOException,
                        AutomationException

Update the pane title.

Product Availability

Available with ArcGIS Desktop.

Specified by:

updateTitle in interface ITableDockWindowAdmin

Parameters:

pTableWindow - A reference to a com.esri.arcgis.arcmapui.ITableWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveWindow

public void setActiveWindow(ITableWindow pTableWindow)
                     throws IOException,
                            AutomationException

Set the active window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setActiveWindow in interface ITableDockWindowAdmin

Parameters:

pTableWindow - A reference to a com.esri.arcgis.arcmapui.ITableWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showNextTable

public void showNextTable(boolean forward)
                   throws IOException,
                          AutomationException

Show next table pane.

Product Availability

Available with ArcGIS Desktop.

Specified by:

showNextTable in interface ITableDockWindowAdmin

Parameters:

forward - The forward (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveTableWindow

public ITableWindow getActiveTableWindow()
                                  throws IOException,
                                         AutomationException

Gets the active table window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getActiveTableWindow in interface ITableDockWindowAdmin

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.