Package satin.uishell

Classes for accessing C++ UI Shell objects in an COMPANY application through Awesome Remote Objects.

See:
Description

Class Summary

AApplication	Represents a C++ AApplication object in an ARO server.
AColumn	Represents a C++ AColumn object in an ARO server, which represents a column in an ATableScape.
ACustomCheckBox	Represents a C++ ACustomCheckBox object in an ARO server.
AGadget	Represents a C++ AGadget object in an ARO server.
AListPane	Represents a C++ AListPane object in an ARO server.
APane	Represents a C++ APane object in an ARO server.
APaneBook	Represents a C++ APaneBook object in an ARO server.
APaneBookPage	Represents a C++ APaneBookPage object in an ARO server.
ARow	Represents a C++ ARow object in an ARO server, which represents a row in an ATableScape.
AScrollBar	Represents a C++ AScrollBar object in an ARO server.
ASlider	Represents a C++ ASlider object in an ARO server.
ATableScape	Represents a C++ ATableScape object in an ARO server.
ATextEntry	Represents a C++ ATextEntry object in an ARO server.
ATextListPane	Represents a C++ ATextListPane object in an ARO server.
AWindow	Represents a C++ AWindow object in an ARO server.
ModifierKey	Identifies one of several modifier (shift) keys on the keyboard.
TwistPane	Represents a C++ TwistPane object in an ARO server.

Exception Summary

PaneException	This exception is thrown when an operation on an existing APane fails.
PaneIDnotFound	This exception is thrown when a pane ID cannot be found.

Package satin.uishell Description

Classes for accessing C++ UI Shell objects in an COMPANY application through Awesome Remote Objects.

Most of the classes in this package are wrappers for the corresponding C++ classes of the same name in the ARO server. Most of their methods are thin wrappers that call the corresponding methods of the corresponding C++ object. In order to make this correspondence clear, those Java methods have the same name as their C++ counterparts, except that the initial letter is lower case, per the Java naming standard. Other Java naming standards may be violated.

A complete description of the UI Shell is beyond the scope of this documentation, but here is a quick overview:

AApplication represents an entire application (program). It does not represent any particular window. The UI Shell was developed on the MacIntosh, which lacks any concept of an application's "main window"; therefore, AApplication does not explicitly correspond to an application's main window (or any other window). There is only one AApplication object in a given application, so a given ARO server knows about at most one AApplication object. Thus, the AApplication constructors know how to find the corresponding C++ AApplication object in the application. The UI Shell itself does not provide any subclasses of AWindow, but in practice every application (such as the PRODUCT) does subclass it.

AWindow represents a top-level window; that is, something that can be independently opened, closed, moved, and/or resized by the user. The UI Shell itself does not provide subclasses of AWindow, but in practice every application (such as the PRODUCT) defines a number of subclasses of it.

APane represents a graphical component within an AWindow, usually some UI gadget such as a checkbox, radio button, text field, etc. APanes can be (and typically are) nested, so that there is a parent/child relationship between panes. Some panes are invisible and are used just for grouping other panes. The UI Shell provides a wide variety of subclasses of APane; most of the classes in this package are subclasses of APane. Each APane is identified by a string called the "pane ID", which often does not correspond to anything displayed on the screen.