satin.uishell
Class ARow

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

public class ARow
extends AObject

Represents a C++ ARow object in an ARO server, which represents a row in an ATableScape.

Author:

Ed Stauff

Fields inherited from class satin.aro.AROremoteObject

server

Fields inherited from class satin.aro.AROobject

id

Constructor Summary

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

Method Summary

void	collapse() Causes the row to collapse.
void	expand() Causes the row to expand.
int	getIndentLevel() Returns the row's indent level.
boolean	getIsExpandable() Returns whether the row is expandable.
boolean	getIsExpanded() Returns whether the row is expanded.
int	getNumSubRows() Returns the number of sub-rows for this row.
ARow	getParent() Returns the row's parent row, or null if it doesn't have one.
AROrectangle	getRowRect() Returns the row's rectangle in landscape coordinates.
AROrectangle	getRowWindowRect() Returns the row's rectangle in window coordinates.
boolean	getSelect() Returns whether the row is currently selected.
void	setSelect(boolean select) Selects or de-selects the row.

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ARow

public ARow(AROremoteServer rs,
            AROobjectID id)

Constructs an object representing an AColumn.

Parameters:

rs

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

id

the ARO object ID of the ARow.

Method Detail

getRowRect

public AROrectangle getRowRect()
                        throws java.io.IOException,
                               AROexception

Returns the row's rectangle in landscape coordinates. Landscape coordinates define the virtual space through which the tablescape scrolls.

getRowWindowRect

public AROrectangle getRowWindowRect()
                              throws java.io.IOException,
                                     AROexception

Returns the row's rectangle in window coordinates.

getIndentLevel

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

Returns the row's indent level.

getIsExpandable

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

Returns whether the row is expandable.

getIsExpanded

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

Returns whether the row is expanded.

getParent

public ARow getParent()
               throws java.io.IOException,
                      AROexception

Returns the row's parent row, or null if it doesn't have one.

getNumSubRows

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

Returns the number of sub-rows for this row.

setSelect

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

Selects or de-selects the row. The selection state of other rows is not affected.

Parameters:

select

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

getSelect

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

Returns whether the row is currently selected.

expand

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

Causes the row to expand. If the row is not expandable, an exception is thrown.

collapse

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

Causes the row to collapse. If the row is not expandable, an exception is thrown.

Revision History

7/26/01 - code review.