satin.uishell
Class AListPane

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

Direct Known Subclasses:

ATextListPane

public class AListPane
extends APane

Represents a C++ AListPane 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

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

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

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

Method Summary

AROrectangle	getEntryRect(int entry) Returns a rectangle for the given entry.
int	getNumEntries() Returns the number of entries.
boolean	isEntrySelected(int entry) Returns whether the given entry is selected.
void	selectAll(boolean select) Selects or de-selects all the entries.
void	selectEntry(int entry, boolean select) Selects or de-selects the given entry.

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

AListPane

public AListPane(AROremoteServer rs,
                 AROobjectID id)

Constructs an object representing an AListPane.

Parameters:

rs

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

id

the ARO object ID of the APane.

AListPane

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

Constructs an object representing an AListPane.

Parameters:

window

the pane's parent window.

paneID

the pane ID of the pane.

AListPane

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

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

Parameters:

pane

the pane's parent window.

paneID

the pane ID of the pane.

Method Detail

getEntryRect

public AROrectangle getEntryRect(int entry)
                          throws java.io.IOException,
                                 AROexception

Returns a rectangle for the given entry. This is a front-end to the C++ method of the same name, but uses 0-based numbering instead of 1-based.

Returns:

the rectangle in window-relative coordinates.

getNumEntries

public int getNumEntries()
                  throws java.io.IOException,
                         AROexception

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

Returns:

the number of entries.

isEntrySelected

public boolean isEntrySelected(int entry)
                        throws java.io.IOException,
                               AROexception

Returns whether the given entry is selected. This is a front-end to the C++ method of the same name, but uses 0-based numbering instead of 1-based.

Parameters:

entry

the entry number.

Returns:

true if the entry is selected, false if it is not.

selectEntry

public void selectEntry(int entry,
                        boolean select)
                 throws java.io.IOException,
                        AROexception

Selects or de-selects the given entry. This is a front-end to the C++ method of the same name, but uses 0-based numbering instead of 1-based.

Parameters:

entry

the entry number.

select

true to select the entry, false to de-select it.

selectAll

public void selectAll(boolean select)
               throws java.io.IOException,
                      AROexception

Selects or de-selects all the entries. This is a front-end to the C++ method of the same name.

Parameters:

select

true to select, false to de-select.

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.