satin.uishell
Class TwistPane

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

public class TwistPane
extends APane

Represents a C++ TwistPane object in an ARO server. A twist page is a small triangle that "opens" and "closes" (reveals or hides additional information below it) when you click on it.

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

TwistPane(APane pane)
Constructs an object representing a TwistPane.

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

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

Method Summary

boolean	getIsOpen() Returns whether the twist pane is in the open position.
void	openClose() Toggles the state (open or closed) of the twist pane.

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

TwistPane

public TwistPane(AROremoteServer rs,
                 AROobjectID id)

Constructs an object representing a TwistPane.

Parameters:

rs

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

id

the ARO object ID of the APane.

TwistPane

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

Constructs an object representing a TwistPane.

Parameters:

window

the pane's parent window.

paneID

the pane ID of the pane.

TwistPane

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

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

Parameters:

pane

the pane's parent window.

paneID

the pane ID of the pane.

Method Detail

getIsOpen

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

Returns whether the twist pane is in the open position. This is a front-end to the C++ method of the same name.

Returns:

true if the twist pane is open, false if it is closed.

openClose

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

Toggles the state (open or closed) of the twist pane. This is a front-end to the C++ method of the same name.

Revision History

7/26/01 - code review.

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

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

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