com.esri.arcgis.framework
Class DockableWindow

java.lang.Object
  com.esri.arcgis.framework.DockableWindow

All Implemented Interfaces:

IDockableWindow, IWindowPosition, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class DockableWindow
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDockableWindow, ISupportErrorInfo, IWindowPosition

COM Class 'DockableWindow'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description 'DockableWindow object.' 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 =

See Also:

Serialized Form

Field Summary

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

IID, IID3ee6d0c3_e3f2_11d3_a679_0008c7df97b9, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IID88c995ae_64a7_43f5_bf12_88ac179b25a6, xxDummy

Constructor Summary

DockableWindow(java.lang.Object obj)
Construct a DockableWindow using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	dock(int dockFlags) Docks or undocks this docking window.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCaption() The caption of the dockable window.
int	getHeight() The height of the window.
IUID	getID() The unique id for this dockable window.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLeft() The distance between the internal left edge of the window and screen.
java.lang.String	getName() The name of the dockable window.
int	getState() The state of the window.
int	getTop() The distance between the internal top edge of the window and screen.
java.lang.Object	getUserData() User defined data.
int	getWidth() The width of the window.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isVisible() Indicates if this docking window is visible.
void	move(int left, int top, int width, int height) Moves and optionally resizes the windows in a single function.
void	release() Release a DockableWindow.
void	setCaption(java.lang.String caption) The caption of the dockable window.
void	setHeight(int height) The height of the window.
void	setLeft(int left) The distance between the internal left edge of the window and screen.
void	setState(int windowState) The state of the window.
void	setTop(int top) The distance between the internal top edge of the window and screen.
void	setWidth(int width) The width of the window.
void	show(boolean show) Hides or shows the dockable window.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockableWindow

public DockableWindow(java.lang.Object obj)
               throws java.io.IOException

Construct a DockableWindow using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DockableWindow.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
DockableWindow o = (DockableWindow)obj; // will not work

DockableWindow o = new DockableWindow(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems DockableWindow theDockableWindow = (DockableWindow) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a DockableWindow.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

The name of the dockable window.

Specified by:

getName in interface IDockableWindow

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCaption

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

The caption of the dockable window.

Specified by:

getCaption in interface IDockableWindow

Returns:

The caption

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCaption

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

The caption of the dockable window.

Specified by:

setCaption in interface IDockableWindow

Parameters:

caption - The caption (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

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

The unique id for this dockable window.

Specified by:

getID in interface IDockableWindow

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

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

Hides or shows the dockable window.

Specified by:

show in interface IDockableWindow

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

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

Indicates if this docking window is visible.

Specified by:

isVisible in interface IDockableWindow

Returns:

The bVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

dock

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

Docks or undocks this docking window.

Specified by:

dock in interface IDockableWindow

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

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

User defined data.

Specified by:

getUserData in interface IDockableWindow

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeft

public void setLeft(int left)
             throws java.io.IOException,
                    AutomationException

The distance between the internal left edge of the window and screen.

Specified by:

setLeft in interface IWindowPosition

Parameters:

left - The left (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeft

public int getLeft()
            throws java.io.IOException,
                   AutomationException

The distance between the internal left edge of the window and screen.

Specified by:

getLeft in interface IWindowPosition

Returns:

The left

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTop

public void setTop(int top)
            throws java.io.IOException,
                   AutomationException

The distance between the internal top edge of the window and screen.

Specified by:

setTop in interface IWindowPosition

Parameters:

top - The top (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTop

public int getTop()
           throws java.io.IOException,
                  AutomationException

The distance between the internal top edge of the window and screen.

Specified by:

getTop in interface IWindowPosition

Returns:

The top

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int width)
              throws java.io.IOException,
                     AutomationException

The width of the window.

Specified by:

setWidth in interface IWindowPosition

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws java.io.IOException,
                    AutomationException

The width of the window.

Specified by:

getWidth in interface IWindowPosition

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int height)
               throws java.io.IOException,
                      AutomationException

The height of the window.

Specified by:

setHeight in interface IWindowPosition

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws java.io.IOException,
                     AutomationException

The height of the window.

Specified by:

getHeight in interface IWindowPosition

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

move

public void move(int left,
                 int top,
                 int width,
                 int height)
          throws java.io.IOException,
                 AutomationException

Moves and optionally resizes the windows in a single function.

Specified by:

move in interface IWindowPosition

Parameters:

left - The left (in)

top - The top (in)

width - The width (in, optional, pass 0 if not required)

height - The height (in, optional, pass 0 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setState

public void setState(int windowState)
              throws java.io.IOException,
                     AutomationException

The state of the window.

Specified by:

setState in interface IWindowPosition

Parameters:

windowState - A com.esri.arcgis.framework.esriWindowState constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws java.io.IOException,
                    AutomationException

The state of the window.

Specified by:

getState in interface IWindowPosition

Returns:

A com.esri.arcgis.framework.esriWindowState constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.