IlvScrollbar

IlvObject
  |
  +--IlvScrollbar

Category:

Common component

JavaScript File:

IlvScrollbar.js

Description:

IlvScrollbar is the abstract base class of all scroll bars.

IlvScrollbar

IlvScrollbar(left, top, length)

Creates an instance of IlvScrollbar.

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()

Returns the extent of the scrollbar.

getHeight()

Returns the height of this scrollbar.

getLeft()

Returns the left border of this scrollbar.

getMaxValue()

Returns the maximum value of the scrollbar.

getMinValue()

Returns the minimum value of the scrollbar.

getTop()

Returns the top border of this scrollbar.

getUnitIncrement()

Returns the unit increment of the scrollbar.

getValue()

Returns the value of the scrollbar.

getWidth()

Returns the width of this scrollbar.

isEnabled()

Returns whether the scrollbar is enabled.

isVisible()

Returns the visibility of this scrollbar.

removeValueListener(listener)

Removes a listener installed with addValueListener.

Parameters:

listener - The listener to remove.

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.

setEnabled(enabled)

Enables or disables the scrollbar.

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(increment)

Sets the unit increment of the scrollbar.

setValue(value)

Sets the value of the scrollbar.

Parameters:

value - The value of the scrollbar.

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(visible)

Sets the visibility of this scrollbar.

toHTML()

Creates the HTML for this scroll bar. This method must be called once in the body of the HTML page.