com.esri.arcgis.arcmapui
Class GenericWindow

java.lang.Object
  com.esri.arcgis.arcmapui.GenericWindow

All Implemented Interfaces:

IDataWindow, IGenericWindow, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GenericWindow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGenericWindow

User data windows.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GenericWindow()
Constructs a GenericWindow using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IGenericWindow	getFindWindow(String windowName) Find an already displayed window.
int	getHWnd() The window's handle.
String	getName() Name of data window.
int	hashCode() the hashcode for this object
boolean	isDockable() Indicates if the window is dockable.
boolean	isVisible() Indicates if the window is visible.
void	putPosition(int left, int top, int right, int bottom) The window's position in screen pixels.
void	queryPosition(int[] left, int[] top, int[] right, int[] bottom) The window's position in screen pixels.
void	refresh() Cause the window to redraw.
void	setActiveXUID(IUID rhs1) UID of ActiveX component to place in data window.
void	setApplicationByRef(Object rhs1) Provides the window with a reference to the application.
void	setName(String pWindowName) Name of data window.
void	setTitle(String rhs1) Name displayed on form.
void	show(boolean show) Indicates if the window is shown.

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

GenericWindow

public GenericWindow()
              throws IOException,
                     UnknownHostException

Constructs a GenericWindow using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GenericWindow

public GenericWindow(Object obj)
              throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems GenericWindow theGenericWindow = (GenericWindow) obj;

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

setTitle

public void setTitle(String rhs1)
              throws IOException,
                     AutomationException

Name displayed on form.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setTitle in interface IGenericWindow

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pWindowName)
             throws IOException,
                    AutomationException

Name of data window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setName in interface IGenericWindow

Parameters:

pWindowName - The pWindowName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of data window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGenericWindow

Returns:

The pWindowName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveXUID

public void setActiveXUID(IUID rhs1)
                   throws IOException,
                          AutomationException

UID of ActiveX component to place in data window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setActiveXUID in interface IGenericWindow

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFindWindow

public IGenericWindow getFindWindow(String windowName)
                             throws IOException,
                                    AutomationException

Find an already displayed window.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getFindWindow in interface IGenericWindow

Parameters:

windowName - The windowName (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.IGenericWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplicationByRef

public void setApplicationByRef(Object rhs1)
                         throws IOException,
                                AutomationException

Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setApplicationByRef in interface IDataWindow

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

public int getHWnd()
            throws IOException,
                   AutomationException

The window's handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHWnd in interface IDataWindow

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPosition

public void queryPosition(int[] left,
                          int[] top,
                          int[] right,
                          int[] bottom)
                   throws IOException,
                          AutomationException

The window's position in screen pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryPosition in interface IDataWindow

Parameters:

left - The left (out: use single element array)

top - The top (out: use single element array)

right - The right (out: use single element array)

bottom - The bottom (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putPosition

public void putPosition(int left,
                        int top,
                        int right,
                        int bottom)
                 throws IOException,
                        AutomationException

The window's position in screen pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

putPosition in interface IDataWindow

Parameters:

left - The left (in)

top - The top (in)

right - The right (in)

bottom - The bottom (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 window is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isVisible in interface IDataWindow

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDockable

public boolean isDockable()
                   throws IOException,
                          AutomationException

Indicates if the window is dockable.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isDockable in interface IDataWindow

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show(boolean show)
          throws IOException,
                 AutomationException

Indicates if the window is shown.

Description

Show specifies whether the data window should be shown or hidden. Use True to show the window and False to hide the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IDataWindow

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Cause the window to redraw.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IDataWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.