satin.uishell
Class ACustomCheckBox

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

public class ACustomCheckBox
extends APane

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

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

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

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

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

Method Summary

boolean	getValue() Returns the state of the checkbox.
void	setValue(boolean on) Sets the state of the checkbox.

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

ACustomCheckBox

public ACustomCheckBox(AROremoteServer rs,
                       AROobjectID id)

Constructs an object representing an ACustomCheckBox.

Parameters:

rs

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

id

the ARO object ID of the APane.

ACustomCheckBox

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

Constructs an object representing an ACustomCheckBox.

Parameters:

window

the pane's parent window.

paneID

the pane ID of the pane.

ACustomCheckBox

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

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

Parameters:

pane

the pane's parent window.

paneID

the pane ID of the pane.

Method Detail

getValue

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

Returns the state of the checkbox. This is a front-end to the C++ method of the same name.

Returns:

true if the checkbox is checked, false if it is not.

setValue

public void setValue(boolean on)
              throws java.io.IOException,
                     AROexception

Sets the state of the checkbox. This is a front-end to the C++ method of the same name.

Parameters:

on

true to select the checkbox, false to clear it.

Revision History

7/26/01 - code review.

7/21/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.