com.esri.arcgis.framework
Class ModelessFrame

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

All Implemented Interfaces:

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

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

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

Description 'Object that implements a ModelessFrame.' 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.IModelessFrame

IID, IID06861e43_9020_49eb_b949_824552ee2de0, xxDummy

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

IID, IID88c995ae_64a7_43f5_bf12_88ac179b25a6, xxDummy

Constructor Summary

ModelessFrame()
Constructs a ModelessFrame using ArcGIS Engine.

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

Method Summary

void	create(java.lang.Object vbForm) Creates the modeless frame around the specified VisualBasic form object.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCaption() The caption of the modeless frame.
static java.lang.String	getClsid() getClsid.
int	getHeight() The height of the 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.
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	release() Release a ModelessFrame.
void	setCaption(java.lang.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

Constructor Detail

ModelessFrame

public ModelessFrame()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a ModelessFrame using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ModelessFrame

public ModelessFrame(java.lang.Object obj)
              throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

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 ModelessFrame.

Specified by:

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

create

public void create(java.lang.Object vbForm)
            throws java.io.IOException,
                   AutomationException

Creates the modeless frame around the specified VisualBasic form object.

Specified by:

create in interface IModelessFrame

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

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

Indicates if the modeless frame is visible.

Specified by:

setVisible in interface IModelessFrame

Parameters:

bVisible - The bVisible (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 the modeless frame is visible.

Specified by:

isVisible in interface IModelessFrame

Returns:

The bVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCaption

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

The caption of the modeless frame.

Specified by:

setCaption in interface IModelessFrame

Parameters:

pCaption - The pCaption (in)

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

Specified by:

getCaption in interface IModelessFrame

Returns:

The pCaption

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.