com.esri.arcgis.framework
Class ModelessFrame

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

All Implemented Interfaces:

IModelessFrame, IWindowPosition, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ModelessFrame
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IModelessFrame, IWindowPosition

Object that implements a ModelessFrame.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

ModelessFrame()
Constructs a ModelessFrame using ArcGIS Engine.

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

Method Summary

void	create(Object vbForm) Creates the modeless frame around the specified VisualBasic form object.
boolean	equals(Object o) Compare this object with another
String	getCaption() The caption of the modeless frame.
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
boolean	isVisible() Indicates if the modeless frame is visible.
void	move(int left, int top, int width, int height) Moves and optionally resizes the windows in a single function.
void	setCaption(String pCaption) The caption of the modeless frame.
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	setVisible(boolean bVisible) Indicates if the modeless frame is visible.
void	setWidth(int width) The width of the window.

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

ModelessFrame

public ModelessFrame()
              throws IOException,
                     UnknownHostException

Constructs a ModelessFrame using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ModelessFrame

public ModelessFrame(Object obj)
              throws IOException

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

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

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

create

public void create(Object vbForm)
            throws IOException,
                   AutomationException

Creates the modeless frame around the specified VisualBasic form object.

Description

The ModelessFrame object controls the life cycle of the Visual Basic form. You should pass an instance of the VBForm and not the Form itself. For example, you should use the following style when you create the ModelessFrame object;

  Dim pForm As Form1

  Set pForm = New Form1

  Dim pFrame As IModelessFrame

  Set pFrame = New ModelessFrame

  pFrame.Create pForm

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

create in interface IModelessFrame

Parameters:

vbForm - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean bVisible)
                throws IOException,
                       AutomationException

Indicates if the modeless frame is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setVisible in interface IModelessFrame

Parameters:

bVisible - The bVisible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the modeless frame is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isVisible in interface IModelessFrame

Returns:

The bVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCaption

public void setCaption(String pCaption)
                throws IOException,
                       AutomationException

The caption of the modeless frame.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCaption in interface IModelessFrame

Parameters:

pCaption - The pCaption (in)

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 modeless frame.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCaption in interface IModelessFrame

Returns:

The pCaption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.