Skip to main content
PREV CLASS NEXT CLASS FRAMES NO FRAMES

 

Class IlvScrollbar

IlvObject
   |
   +--IlvScrollbar

Category:
Common component
JavaScript File:
IlvScrollbar.js
Description:
IlvScrollbar is the abstract base class of all scroll bars.

Constructor Summary
Constructor Attributes Constructor Name and Description
 
IlvScrollbar(left, top, length)
Method Summary
Method Attributes Method Name and Description
 
addValueListener(listener)
Adds a listener to be called when the scroll bar's value is changed.
 
Returns the extent of the scrollbar.
 
Returns the height of this scrollbar.
 
Returns the left border of this scrollbar.
 
Returns the maximum value of the scrollbar.
 
Returns the minimum value of the scrollbar.
 
getTop()
Returns the top border of this scrollbar.
 
Returns the unit increment of the scrollbar.
 
Returns the value of the scrollbar.
 
Returns the width of this scrollbar.
 
Returns whether the scrollbar is enabled.
 
Returns the visibility of this scrollbar.
 
Removes a listener installed with addValueListener.
 
setBounds(left, top, length)
Changes the location and size of the scrollbar.
 
setButtonSize(buttonSize)
Sets the button size of scroll bar.
 
setEnabled(enabled)
Enables or disables the scrollbar.
 
setLocation(left, top)
Moves the scrollbar to the specified location.
 
setUnitIncrement(increment)
Sets the unit increment of the scrollbar.
 
setValue(value)
Sets the value of the scrollbar.
 
setValues(value, extent, min, max)
Sets the values of the scrollbar.
 
setVisible(visible)
Sets the visibility of this scrollbar.
 
toHTML(parentNode)
Creates the HTML for this scroll bar.
Methods inherited from class IlvObject
dispose, getClassName, hashCode, instanceOf, invoke, registerDispose, registerDisposeByClientId, removeHTML, setClassName, superConstructor, superInvoke, toString, updateVisibility
Constructor Detail
IlvScrollbar
IlvScrollbar(left, top, length)
Parameters:
left - The absolute x position of the scroll bar on the page.
top - The absolute y position of the scroll bar on the page.
length - The length of the scroll bar.
Method Detail
addValueListener
addValueListener(listener)
Adds a listener to be called when the scroll bar's value is changed.
Parameters:
listener - The listener function, which must have the following parameters:
  scrollbar: The IlvScrollbar.

getExtent
getExtent()
Returns the extent of the scrollbar.

getHeight
getHeight()
Returns the height of this scrollbar.

getLeft
getLeft()
Returns the left border of this scrollbar.

getMaxValue
getMaxValue()
Returns the maximum value of the scrollbar.

getMinValue
getMinValue()
Returns the minimum value of the scrollbar.

getTop
getTop()
Returns the top border of this scrollbar.

getUnitIncrement
getUnitIncrement()
Returns the unit increment of the scrollbar.

getValue
getValue()
Returns the value of the scrollbar.

getWidth
getWidth()
Returns the width of this scrollbar.

isEnabled
isEnabled()
Returns whether the scrollbar is enabled.

isVisible
isVisible()
Returns the visibility of this scrollbar.

removeValueListener
removeValueListener(listener)
Removes a listener installed with addValueListener.
Parameters:
listener - The listener to remove.

setBounds
setBounds(left, top, length)
Changes the location and size of the scrollbar.
Parameters:
left - The absolute x position of the scrollbar on the page.
top - The absolute y position of the scrollbar on the page.
length - The length of the scrollbar.

setButtonSize
setButtonSize(buttonSize)
Sets the button size of scroll bar.
Parameters:
buttonSize

setEnabled
setEnabled(enabled)
Enables or disables the scrollbar.
Parameters:
enabled

setLocation
setLocation(left, top)
Moves the scrollbar to the specified location.
Parameters:
left - Position of the left side, relative to the upper-left corner of the window.
top - Position of the top side, relative to the upper-left corner of the window.

setUnitIncrement
setUnitIncrement(increment)
Sets the unit increment of the scrollbar.
Parameters:
increment

setValue
setValue(value)
Sets the value of the scrollbar.
Parameters:
value - The value of the scrollbar.

setValues
setValues(value, extent, min, max)
Sets the values of the scrollbar. The values are forced to obey the constraints:
minimum <= value <= value+extent <= maximum
Parameters:
value - The value of the scrollbar.
extent - The extent of the scrollbar.
min - The minimum value of the scrollbar.
max - The maximum value of the scrollbar.

setVisible
setVisible(visible)
Sets the visibility of this scrollbar.
Parameters:
visible

toHTML
toHTML(parentNode)
Creates the HTML for this scroll bar. This method must be called once in the body of the HTML page.
Parameters:
parentNode

©Copyright Rogue Wave Software Inc. 1997, 2018. All Rights Reserved.