satin.uishell
Class AWindow

java.lang.Object
  |
  +--satin.aro.AROobject
        |
        +--satin.aro.AROremoteObject
              |
              +--satin.core.AObject
                    |
                    +--satin.uishell.AWindow

Direct Known Subclasses:

BinWindow, CalcWindow, ComposerWindow, DigitizeWindow, MCconsoleWindow, OpenProjectDlg, ProjectWindow, TimelineWindow

public class AWindow
extends AObject

Represents a C++ AWindow object in an ARO server.

Author:

Ed Stauff

Fields inherited from class satin.aro.AROremoteObject

server

Fields inherited from class satin.aro.AROobject

id

Constructor Summary

protected	AWindow(AROremoteServer rs) Constructor for derived classes.
	AWindow(AROremoteServer rs, AROobjectID id) Constructs an object representing an AWindow.

Method Summary

void	closeWhenIdle() Tells the window to close itself when it becomes idle.
APane	findPaneByID(java.lang.String paneID) Looks in the window for a pane with the given ID.
java.lang.String	getClassAndTitle() Returns a string containing the window's C++ class name and its title.
boolean	getIsModal() Returns whether the window is modal (i.e., a dialog).
MacWindow	getMacWindow() Returns the MacIntosh window for this window.
APane	getMainPane() Returns the window's main pane.
java.lang.String	getTitle() Returns the window's title (caption).
AROrectangle	getWindowRect() Returns the window's rectangle in global coordinates.
void	goHome(int top, int left) Moves the window to its "home" location.
boolean	isActiveWindow() Returns whether the window is the active window.
boolean	isVisible() Returns whether the window is visible.
void	makeActive() Makes the window (and its application) active.
void	postClickEvent(int x, int y) Posts (asynchronously) a click event at the location given in window coordinates.
void	selectAndShow() Makes the window active.
void	setContentSize(int width, int height) Resizes the window, based on the dimensions of its interior.
void	setCursorPos(int x, int y) Moves the mouse cursor to the position given in window coordinates.
void	setWindowTopLeft(int top, int left) Moves the window without resizing it.
void	setWindowToRect(int left, int top, int right, int bottom) Moves the window to the position given in global coordinates.
void	setWindowWidHei(int width, int height) Resizes the window, based on its exterior dimensions.

Methods inherited from class satin.core.AObject

className, isInstanceOf

Methods inherited from class satin.aro.AROremoteObject

equals, exists, getAROclassName

Methods inherited from class satin.aro.AROobject

getID, setID, toAROstring, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AWindow

public AWindow(AROremoteServer rs,
               AROobjectID id)

Constructs an object representing an AWindow.

Parameters:

rs

the ARO server in which the C++ object lives.

id

the ARO object ID of the AWindow.

AWindow

protected AWindow(AROremoteServer rs)

Constructor for derived classes. The overridden constructor must call the setID method.

Parameters:

rs

the ARO server in which the C++ object lives.

Method Detail

getTitle

public java.lang.String getTitle()
                          throws java.io.IOException,
                                 AROexception

Returns the window's title (caption). This is a front-end for the C++ method of the same name.

Returns:

the window's title.

getMainPane

public APane getMainPane()
                  throws java.io.IOException,
                         AROexception

Returns the window's main pane. This is obtained from the C++ method's mainPane field.

Returns:

the window's main pane, or null if it doesn't have one.

findPaneByID

public APane findPaneByID(java.lang.String paneID)
                   throws java.io.IOException,
                          AROexception

Looks in the window for a pane with the given ID. This is a front-end for the C++ method of the same name.

Returns:

the found pane, or null if it wasn't found.

selectAndShow

public void selectAndShow()
                   throws java.io.IOException,
                          AROexception

Makes the window active. This method only makes the window active with respect to the application; if the application is not active, this method will not make it active. See makeActive. This is a front-end for the C++ method of the same name.

getMacWindow

public MacWindow getMacWindow()
                       throws java.io.IOException,
                              AROexception

Returns the MacIntosh window for this window.

makeActive

public void makeActive()
                throws java.io.IOException,
                       AROexception

Makes the window (and its application) active.

closeWhenIdle

public void closeWhenIdle()
                   throws java.io.IOException,
                          AROexception

Tells the window to close itself when it becomes idle. Note that some windows may put up a confirmation dialog before closing; this method does not handle such dialogs. This is a front-end for the C++ method of the same name.

isVisible

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

Returns whether the window is visible. This does not take into consideration whether the window is obscured by (behind) other windows. This is a front-end for the C++ method of the same name.

Returns:

true if the window is visible; false otherwise.

isActiveWindow

public boolean isActiveWindow()
                       throws java.io.IOException,
                              AROexception

Returns whether the window is the active window. This is a front-end for the C++ method of the same name.

Returns:

true if the window is active, false otherwise.

getIsModal

public boolean getIsModal()
                   throws java.io.IOException,
                          AROexception

Returns whether the window is modal (i.e., a dialog). This is a front-end for the C++ method of the same name.

Returns:

true if the window is modal, false if it is non-modal.

setCursorPos

public void setCursorPos(int x,
                         int y)
                  throws java.io.IOException,
                         AROexception

Moves the mouse cursor to the position given in window coordinates. This is a front-end for the C++ routine "SetRawMouse".

Parameters:

x

the x-coordinate.

y

the y-coordinate.

setWindowToRect

public void setWindowToRect(int left,
                            int top,
                            int right,
                            int bottom)
                     throws java.io.IOException,
                            AROexception

Moves the window to the position given in global coordinates. This is a front-end for the C++ method of the same name.

Parameters:

left

the new left edge of the window.

right

the new right edge of the window.

setWindowWidHei

public void setWindowWidHei(int width,
                            int height)
                     throws java.io.IOException,
                            AROexception

Resizes the window, based on its exterior dimensions. This is a front-end for the C++ method of the same name.

setContentSize

public void setContentSize(int width,
                           int height)
                    throws java.io.IOException,
                           AROexception

Resizes the window, based on the dimensions of its interior. This is a front-end for the C++ method of the same name.

setWindowTopLeft

public void setWindowTopLeft(int top,
                             int left)
                      throws java.io.IOException,
                             AROexception

Moves the window without resizing it. This is a front-end for the C++ method of the same name.

goHome

public void goHome(int top,
                   int left)
            throws java.io.IOException,
                   AROexception

Moves the window to its "home" location. This is a front-end for the C++ method of the same name.

getWindowRect

public AROrectangle getWindowRect()
                           throws java.io.IOException,
                                  AROexception

Returns the window's rectangle in global coordinates. This is a front-end to the C++ method of the same name.

getClassAndTitle

public java.lang.String getClassAndTitle()
                                  throws java.io.IOException,
                                         AROexception

Returns a string containing the window's C++ class name and its title.

postClickEvent

public void postClickEvent(int x,
                           int y)
                    throws java.io.IOException,
                           AROexception

Posts (asynchronously) a click event at the location given in window coordinates.

Revision History

7/26/01 - code review.

7/27/01 Ed Stauff - added setContentSize per C++ code review.

7/13/01 Ed Stauff - added getClassAndTitle.

4/6/01 Ed Stauff - changes per review.

3/28/01 Ed Stauff - initial review by Satin team.