PERGOLA LOGO

pergola.Scrollbar

System events: YES.

User events and functions: NO.

System component. You never need to instantiate this class, or invoke any of its methods explicitly (the pergola.Slider is instead a user widget).

Listed: class properties/methods; prototype properties and methods; instance properties. Prototype properties and methods inherited by the Class superclass are not listed.

class

None

prototype

PROPERTIES

parent

pergola.user. Overridden by controls using scrollbars.

fill

Defined in pergola.presentationAttributes – string.

stroke

Defined in pergola.presentationAttributes – string.

horTrackFill

Defined in pergola.presentationAttributes – string.

vertTrackFill

Defined in pergola.presentationAttributes – string.

rx

Defined in pergola.presentationAttributes – number (user space units).

size

Defined in pergola.presentationAttributes – number (user space units).

padding

Defined in pergola.presentationAttributes – number (user space units).

min

0 – number; the low threshold of displacement.

extent

0 – number; the high threshold of displacement.

scrollType

"regular" – string; allowed values: "regular"; "navigation".

initial

"start" – string; allowed values: "start"; "middle".

sliderClearance

2 – number.

step

Defined in pergola.presentationAttributes – number; the scroll units for step scrolling by buttons.

delay

Defined in pergola.presentationAttributes – number; the delay before repetition for step scrolling by buttons.

stepFrequence

Defined in pergola.presentationAttributes – number; the repetition frequence for step scrolling by buttons.

pageFrequence

Defined in pergola.presentationAttributes – number; the repetition frequence for page scrolling by track.

mapPageFrequence

Defined in pergola.presentationAttributes – number; the repetition frequence for page scrolling by track in maps.

METHODS

updateHor(x, y)

System. Updates geometry of horizontal scrollbar.

updateVert(x, y)

System. Updates geometry of vertical scrollbar.

horScrollBySliderInit(evt)

System. Initialization of horizontal scrollbar slider. Returns an object for initialization of pergola.dragarea, specifying the appropriate callback function for "regular" or "navigation" (maps) scrollType.

vertScrollBySliderInit(evt)

System. Initialization of vertical scrollbar slider. Returns an object for initialization of pergola.dragarea, specifying the appropriate callback function for "regular" or "navigation" (maps) scrollType.

horScrollByPageInit(evt)

System. Initialization of horizontal scrollbar track Timer, specifying the appropriate callback function for "regular" or "navigation" (maps) scrollType.

vertScrollByPageInit(evt)

System. Initialization of vertical scrollbar track Timer, specifying the appropriate callback function for "regular" or "navigation" (maps) scrollType.

stepScrollTimerInit(evt, button, callback)

button is this backScroll or this fwdScroll; callback specifies appropriate function depending on this scrollType. Initializes a pergola.Timer instance with the appropriate callback function for "regular" or "navigation" (maps) scrollType, this delay, and this stepFrequence. You never need to invoke this methods explicitly.

horScrollBySlider(evt)

System. Applies horizontal scrolling by slider. You don't normally need to invoke this methods explicitly.

vertScrollBySlider(evt)

System. Applies vertical scrolling by slider. You don't normally need to invoke this methods explicitly.

horFwdStepScroll()

System. Applies horizontal forward scroll by button. You don't normally need to invoke this methods explicitly.

vertFwdStepScroll()

System. Applies vertical forward scroll by button. You don't normally need to invoke this methods explicitly.

horBackStepScroll()

System. Applies horizontal back scroll by button. You don't normally need to invoke this methods explicitly.

vertBackStepScroll()

System. Applies vertical back scroll by button. You don't normally need to invoke this methods explicitly.

horScrollByPage()

System. Horizontal scroll by page. You don't normally need to invoke this methods explicitly.

vertScrollByPage()

System. Vertical scroll by page. You don't normally need to invoke this methods explicitly.

overflow(s)

s is this slider. Tests positive and negative overflow. You don't normally need to invoke this methods explicitly.

positiveOverflow(s)

s is this slider. Tests positive overflow. You don't normally need to invoke this methods explicitly.

negativeOverflow(s)

s is this slider. Tests negative overflow. You don't normally need to invoke this methods explicitly.

mapHorScrollBySlider(evt)

System. Applies horizontal scrolling by slider. Acts on maps panning. You don't normally need to invoke this methods explicitly.

mapVertScrollBySlider(evt)

System. Applies vertical scrolling by slider. Acts on maps panning. You don't normally need to invoke this methods explicitly.

mapHorFwdStepScroll()

System. Applies horizontal forward scroll by button. Acts on maps panning. You don't normally need to invoke this methods explicitly.

mapVertFwdStepScroll()

System. Applies vertical forward scroll by button. Acts on maps panning. You don't normally need to invoke this methods explicitly.

mapHorBackStepScroll()

System. Applies horizontal back scroll by button. Acts on maps panning. You don't normally need to invoke this methods explicitly.

mapVertBackStepScroll()

System. Applies vertical back scroll by button. Acts on maps panning. You don't normally need to invoke this methods explicitly.

mapHorScrollByPage()

System. Horizontal scroll by page. Acts on maps panning. You don't normally need to invoke this methods explicitly.

mapVertScrollByPage()

System. Vertical scroll by page. Acts on maps panning. You don't normally need to invoke this methods explicitly.

release()

Invoked upon termination of the scrolling process. You never need to invoke this methods explicitly.

handleEvent(evt)

buildH(object)

Specialized build method for horizontal scrollbar. this inherits the properties specified in object. Prototype properties specified in object are overridden. Creates elements. Returns this.

buildV(object)

Specialized build method for vertical scrollbar. this inherits the properties specified in object. Prototype properties specified in object are overridden. Creates elements. Returns this.

instance

name

String. If not passed to the constructor, gets a generated XML name (Class).

id

String. The return value of this name.toXML(). This container ID. Used as prefix where other elements' IDs are attributed.

owner

Must be specified in the initialization object; designates the owner object.

container

<g> element.

track

<rect> element.

slider

pergola.ScrollSlider instance.

backScroll

pergola.ScrollButton instance.

fwdScroll

pergola.ScrollButton instance.

Other properties related to internal dynamics are not listed.