satin.uishell
Class ATextListPane

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

public class ATextListPane
extends AListPane

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

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

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

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

Method Summary

java.lang.String[]	getAllLines() Returns the contents of all the lines, in order.
java.lang.String	getLine(int lineNumber) Returns the contents of a given line.
void	selectEntry(java.lang.String entry, boolean select) Selects or de-selects the entry whose text equals the given string.

Methods inherited from class satin.uishell.AListPane

getEntryRect, getNumEntries, isEntrySelected, selectAll, selectEntry

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

ATextListPane

public ATextListPane(AROremoteServer rs,
                     AROobjectID id)

Constructs an object representing an ATextListPane.

Parameters:

rs

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

id

the ARO object ID of the APane.

ATextListPane

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

Constructs an object representing an AGadget.

Parameters:

window

the pane's parent window.

paneID

the pane ID of the pane.

ATextListPane

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

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

Parameters:

pane

the pane's parent window.

paneID

the pane ID of the pane.

Method Detail

getLine

public java.lang.String getLine(int lineNumber)
                         throws java.io.IOException,
                                AROexception

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

Parameters:

lineNumber

the line number.

getAllLines

public java.lang.String[] getAllLines()
                               throws java.io.IOException,
                                      AROexception

Returns the contents of all the lines, in order.

Returns:

an array of String objects, one for each line.

selectEntry

public void selectEntry(java.lang.String entry,
                        boolean select)
                 throws java.io.IOException,
                        AROexception,
                        PaneException

Selects or de-selects the entry whose text equals the given string. If more than one entry matches, and exception is thrown.

Parameters:

entry

the name of the desired entry.

select

true to select it, false to deselect it.

Revision History

9/3/01 - added selectEntry.

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 review.

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