com.esri.arcgis.framework
Class IWindowPositionProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.framework.IWindowPositionProxy

All Implemented Interfaces:

IWindowPosition, Externalizable, Serializable

public class IWindowPositionProxy
extends com.esri.arcgis.interop.Dispatch
implements IWindowPosition, Serializable

Provides access to members that query or modify a window's position, size and state.

Remarks

The IWindowPosition interface has methods to move and resize a window. Any window object can implement this interface. All the ArcGIS application windows implement this interface.

Commandbars also support IWindowPostion. Use the State property to determine whether a toolbar is floating on the desktop.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IWindowPositionProxy()
	IWindowPositionProxy(Object obj)
protected	IWindowPositionProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getHeight() The height of the window.
int	getLeft() The distance between the internal left edge of the window and screen.
int	getState() The state of the window.
int	getTop() The distance between the internal top edge of the window and screen.
int	getWidth() The width of the window.
void	move(int left, int top, int width, int height) Moves and optionally resizes the windows in a single function.
void	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IWindowPositionProxy

public IWindowPositionProxy()

IWindowPositionProxy

public IWindowPositionProxy(Object obj)
                     throws IOException

Throws:

IOException

IWindowPositionProxy

protected IWindowPositionProxy(Object obj,
                               String iid)
                        throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setLeft

public void setLeft(int left)
             throws IOException,
                    AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setLeft in interface IWindowPosition

Parameters:

left - The left (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeft

public int getLeft()
            throws IOException,
                   AutomationException

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

Remarks

The Left property determines the position of the window in screen coordinates relative to the upper-left corner of the display screen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLeft in interface IWindowPosition

Returns:

The left

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTop

public void setTop(int top)
            throws IOException,
                   AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setTop in interface IWindowPosition

Parameters:

top - The top (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTop

public int getTop()
           throws IOException,
                  AutomationException

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

Remarks

The Top property determines the position of the window in screen coordinates relative to the upper-left corner of the display screen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTop in interface IWindowPosition

Returns:

The top

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int width)
              throws IOException,
                     AutomationException

The width of the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setWidth in interface IWindowPosition

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException

The width of the window.

Remarks

The Height and Width properties determine the size of the window. This is in screen units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getWidth in interface IWindowPosition

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int height)
               throws IOException,
                      AutomationException

The height of the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setHeight in interface IWindowPosition

Parameters:

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException

The height of the window.

Remarks

The Height and Width properties determine the size of the window. This is in screen units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHeight in interface IWindowPosition

Returns:

The height

Throws:

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 IOException,
                 AutomationException

Moves and optionally resizes the windows in a single function.

Remarks

You can use the Move method to set the Left, Top, Width, and Height properties all at the same time.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setState

public void setState(int windowState)
              throws IOException,
                     AutomationException

The state of the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setState in interface IWindowPosition

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws IOException,
                    AutomationException

The state of the window.

Remarks

The State property uses the esriWindowState enumeration to specify whether the window is normal, minimized, or maximized.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getState in interface IWindowPosition

Returns:

A com.esri.arcgis.framework.esriWindowState constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.