com.webrenderer
Class ScrollBarInfo

java.lang.Object
  extended bycom.webrenderer.ScrollBarInfo

public class ScrollBarInfo
extends java.lang.Object

Stores information about the current scroll bar status of an IDocument.


Constructor Summary
ScrollBarInfo(int th, int ch, int y, int tw, int cw, int x)
          Constructs a ScrollBarInfo object.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Compares the scroll bar with another object
 int getCurrentHeight()
          Gets the current showing-height of the scroll bar.
 int getCurrentWidth()
          Gets the current showing-width of the scroll bar.
 int getTotalHeight()
          Gets the total height of the scroll bar.
 int getTotalWidth()
          Gets the total width of the scroll bar.
 int getXPos()
          Gets the current x position of the scroll bar.
 int getYPos()
          Gets the current y position of the scroll bar.
 java.lang.String toString()
          Gets the scroll bar information as a String.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScrollBarInfo

public ScrollBarInfo(int th,
                     int ch,
                     int y,
                     int tw,
                     int cw,
                     int x)
Constructs a ScrollBarInfo object.

Parameters:
th - total height.
ch - current height.
y - y position.
tw - total width.
cw - current width.
x - x position.
Method Detail

getCurrentHeight

public int getCurrentHeight()
Gets the current showing-height of the scroll bar.

Returns:
the current showing-height

getTotalHeight

public int getTotalHeight()
Gets the total height of the scroll bar.

Returns:
the total height of the page

getYPos

public int getYPos()
Gets the current y position of the scroll bar.

Returns:
the current Y position

getCurrentWidth

public int getCurrentWidth()
Gets the current showing-width of the scroll bar.

Returns:
the current showing width

getTotalWidth

public int getTotalWidth()
Gets the total width of the scroll bar.

Returns:
the total width of the page

getXPos

public int getXPos()
Gets the current x position of the scroll bar.

Returns:
the current X position

toString

public java.lang.String toString()
Gets the scroll bar information as a String.

Returns:
String showing scroll bar information in the form "ScrollBarInfo[ totalWidth, totalHeight, currentWidth, currentHeight, xPos, yPos ]

equals

public boolean equals(java.lang.Object obj)
Compares the scroll bar with another object

Parameters:
obj - an object to compare against
Returns:
true if the object passed has the size and position as this object.