satin.uishell
Class APaneBook

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

public class APaneBook
extends APane

Represents a C++ APaneBook object in an ARO server. This is a pane that contains several "tabbed" pages, each containing a different set of controls.

Author:

Ed Stauff

Fields inherited from class satin.uishell.APane

uiName

Fields inherited from class satin.aro.AROremoteObject

server

Fields inherited from class satin.aro.AROobject

id

Constructor Summary

APaneBook(APane pane)
Constructs an object representing an APaneBook.

APaneBook(AROremoteServer rs, AROobjectID id)
Constructs an object representing an APaneBook.

APaneBook(AWindow window, java.lang.String paneID)
Constructs an object representing an APaneBook.

Method Summary

APaneBookPage	findPageByID(java.lang.String paneID) Returns the page, or null if there isn't one.
APaneBookPage	findPageByNum(int n) Returns the nth page, or null if there isn't one.
APane	findPagePaneByID(java.lang.String paneID) Returns the page, or null if there isn't one.
APane	findPagePaneByNum(int n) Returns the nth page, or null if there isn't one.
APaneBookPage	getCurPage() Returns the currently displayed page.
APane[]	getPagePanes() Returns an array of page panes.
APaneBookPage[]	getPages() Returns an array of pages.
void	showPage(APaneBookPage page) Sets the current page to display.
void	showPage(int pageNum) Sets the current page to display.
void	showPage(java.lang.String label) Sets the current page to display.

Methods inherited from class satin.uishell.APane

doClick, doClick, doClick, doClick, doClick, doClick, getBounds, getClassAndID, getFrame, getLabel, getPaneID, getParent, getSubPanes, getText, getUIname, getWindow, isActive, isVisible, postClickEvent, toString

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

Methods inherited from class java.lang.Object

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

Constructor Detail

APaneBook

public APaneBook(AROremoteServer rs,
                 AROobjectID id)

Constructs an object representing an APaneBook.

Parameters:

rs

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

id

the ARO object ID of the APane.

APaneBook

public APaneBook(AWindow window,
                 java.lang.String paneID)
          throws java.io.IOException,
                 AROexception,
                 PaneIDnotFound

Constructs an object representing an APaneBook.

Parameters:

window

the pane's parent window.

paneID

the pane ID of the pane.

APaneBook

public APaneBook(APane pane)
          throws java.io.IOException,
                 AROexception

Constructs an object representing an APaneBook. Use this constructor to "cast" an APane object to an APaneBook object. Throws an assertion if the APane in the application is not a member of the class APaneBook.

Parameters:

pane

the pane's parent window.

paneID

the pane ID of the pane.

Method Detail

findPageByNum

public APaneBookPage findPageByNum(int n)
                            throws java.io.IOException,
                                   AROexception

Returns the nth page, or null if there isn't one. This is a front-end to the C++ method of the same name, but uses 0-based numbering instead of 1-based.

Parameters:

n

the page number.

Returns:

the nth page, or null.

findPageByID

public APaneBookPage findPageByID(java.lang.String paneID)
                           throws java.io.IOException,
                                  AROexception

Returns the page, or null if there isn't one. This is a front-end to the C++ method of the same name.

Parameters:

paneID

the pane ID of the desired page.

Returns:

the page, or null.

findPagePaneByNum

public APane findPagePaneByNum(int n)
                        throws java.io.IOException,
                               AROexception

Returns the nth page, or null if there isn't one. This is a front-end to the C++ method of the same name, but uses 0-based numbering instead of 1-based.

Parameters:

n

the page number.

Returns:

the nth page pane.

findPagePaneByID

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

Returns the page, or null if there isn't one. This is a front-end to the C++ method of the same name.

Parameters:

paneID

the pane ID of the desired page.

Returns:

the page pane.

getPagePanes

public APane[] getPagePanes()
                     throws java.io.IOException,
                            AROexception

Returns an array of page panes.

getPages

public APaneBookPage[] getPages()
                         throws java.io.IOException,
                                AROexception

Returns an array of pages.

getCurPage

public APaneBookPage getCurPage()
                         throws java.io.IOException,
                                AROexception

Returns the currently displayed page. This is obtained from the C++ method's iCurPage field.

Returns:

the current page.

showPage

public void showPage(int pageNum)
              throws java.io.IOException,
                     AROexception

Sets the current page to display. This is a front-end to the C++ method of the same name, but uses 0-based numbering instead of 1-based.

Parameters:

pageNum

the number of the page to display.

showPage

public void showPage(java.lang.String label)
              throws java.io.IOException,
                     AROexception

Sets the current page to display. This is a front-end to the C++ method of the same name.

Parameters:

label

the label of the page to display.

showPage

public void showPage(APaneBookPage page)
              throws java.io.IOException,
                     AROexception

Sets the current page to display. This is a front-end to the C++ method of the same name.

Parameters:

page

the page to display.

Revision History

7/26/01 - code review.

7/13/01 Ed Stauff - added constructor that takes an APane.

5/1/01 Ed Stauff - replaced Vectors with arrays.

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

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