satin.uishell
Class AScrollBar

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

public class AScrollBar
extends APane

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

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

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

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

Method Summary

void	doScroll(int delta) Changes the value (position) of the scrollbar, and updates the contents of the pane being scrolled.
AROrectangle	getDownButtonRect() Returns a rectangle for the scrollbar's "down" (or "left") button.
int	getMax() Returns the maximum value of the scrollbar.
int	getMin() Returns the minimum value of the scrollbar.
AROrectangle	getThumbRect() Returns a rectangle for the "thumb" (slider) of the scrollbar.
AROrectangle	getUpButtonRect() Returns a rectangle for the scrollbar's "up" (or "right") button.
int	getValue() Returns the current value (position) of the scrollbar.
boolean	isVertical() Returns whether the scrollbar is vertical or horizontal.
boolean	setValue(int value) Sets the value (position) of the scrollbar, and returns whether it changed.

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

AScrollBar

public AScrollBar(AROremoteServer rs,
                  AROobjectID id)

Constructs an object representing an AScrollBar.

Parameters:

rs

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

id

the ARO object ID of the APane.

AScrollBar

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

Constructs an object representing an AScrollBar.

Parameters:

window

the pane's parent window.

paneID

the pane ID of the pane.

AScrollBar

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

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

Parameters:

pane

the pane's parent window.

paneID

the pane ID of the pane.

Method Detail

getValue

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

Returns the current value (position) of the scrollbar. This is a front-end to the C++ method of the same name.

Returns:

the current value.

setValue

public boolean setValue(int value)
                 throws java.io.IOException,
                        AROexception

Sets the value (position) of the scrollbar, and returns whether it changed. This method does not update the contents of the pane being scrolled. This is a front-end to the C++ method of the same name.

Parameters:

value

the new value.

Returns:

true if the value changed, false if it did not.

doScroll

public void doScroll(int delta)
              throws java.io.IOException,
                     AROexception

Changes the value (position) of the scrollbar, and updates the contents of the pane being scrolled. This is a front-end to the C++ method of the same name.

Parameters:

delta

the amount by which to change the value.

Returns:

true if the value changed, false if it did not.

getMin

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

Returns the minimum value of the scrollbar. This is a front-end to the C++ method of the same name.

Returns:

the minimum value.

getMax

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

Returns the maximum value of the scrollbar. This is a front-end to the C++ method of the same name.

Returns:

the maximum value.

isVertical

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

Returns whether the scrollbar is vertical or horizontal. This is a front-end to the C++ method of the same name.

Returns:

true if the scrollbar is vertical, false if it is horizontal.

getThumbRect

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

Returns a rectangle for the "thumb" (slider) of the scrollbar. This is a front-end to the C++ method of the same name.

Returns:

the rectangle in window-relative coordinates.

getUpButtonRect

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

Returns a rectangle for the scrollbar's "up" (or "right") button. This is a front-end to the C++ method of the same name.

Returns:

the rectangle in window-relative coordinates.

getDownButtonRect

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

Returns a rectangle for the scrollbar's "down" (or "left") button. This is a front-end to the C++ method of the same name.

Returns:

the rectangle in window-relative coordinates.

Revision History

7/26/01 - code review.

7/22/01 Ed Stauff - added doScroll.

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

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

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