com.esri.arcgis.framework
Interface IDockableWindow

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DockableWindow, IDockableWindowProxy

public interface IDockableWindow
extends java.io.Serializable

COM Interface 'IDockableWindow'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that define and control a dockable window.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID3ee6d0c3_e3f2_11d3_a679_0008c7df97b9
static int	xxDummy Deprecated. Internal use only

Method Summary

void	dock(int dockFlags) Docks or undocks this docking window.
java.lang.String	getCaption() The caption of the dockable window.
IUID	getID() The unique id for this dockable window.
java.lang.String	getName() The name of the dockable window.
java.lang.Object	getUserData() User defined data.
boolean	isVisible() Indicates if this docking window is visible.
void	setCaption(java.lang.String caption) The caption of the dockable window.
void	show(boolean show) Hides or shows the dockable window.

Field Detail

IID3ee6d0c3_e3f2_11d3_a679_0008c7df97b9

static final int IID3ee6d0c3_e3f2_11d3_a679_0008c7df97b9

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the dockable window.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCaption

java.lang.String getCaption()
                            throws java.io.IOException,
                                   AutomationException

The caption of the dockable window.

Returns:

The caption

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCaption

void setCaption(java.lang.String caption)
                throws java.io.IOException,
                       AutomationException

The caption of the dockable window.

Parameters:

caption - The caption (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

IUID getID()
           throws java.io.IOException,
                  AutomationException

The unique id for this dockable window.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

void show(boolean show)
          throws java.io.IOException,
                 AutomationException

Hides or shows the dockable window.

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if this docking window is visible.

Returns:

The bVisible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dock

void dock(int dockFlags)
          throws java.io.IOException,
                 AutomationException

Docks or undocks this docking window.

Parameters:

dockFlags - A com.esri.arcgis.framework.esriDockFlags constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserData

java.lang.Object getUserData()
                             throws java.io.IOException,
                                    AutomationException

User defined data.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.