GhostWire ScrollBar - Actionscript API

---

The following methods are available for the GhostWire ScrollBar:

GWScrollBar.getEnabled()
GWScrollBar.getSize()
GWScrollBar.getScrollPosition()
GWScrollBar.setEnabled(flag)
GWScrollBar.setHorizontal(flag)
GWScrollBar.setLargeScroll(num)
GWScrollBar.setScrollPosition(pos)
GWScrollBar.setSize(width,height)
GWScrollBar.setSmallScroll(num)

---

---

GWScrollBar.getSize()
Parameters
none

Returns
An object containing the width and height properties of the scrollbar, in pixels.

Description
Method; gets the width and height of the scrollbar, in pixels.

---

---

GWScrollBar.setSize(width, height)
Parameters
width An integer specifying the width of the scrollbar, in pixels.
height An integer specifying the height of the scrollbar, in pixels.

Returns
Nothing.

Description
Method; sets the width and height of the scrollbar at runtime. Calling this method overrides any sizing applied during authoring.

---

---

GWScrollBar.getScrollPosition()
Parameters
none

Returns
An integer specifying the current scroll position.

Description
Method; gets the current scroll position at runtime.

---

---

GWScrollBar.setScrollPosition(pos)
Parameters
pos An integer specifying the scroll position.

Returns
Nothing.

Description
Method; sets the current scroll position at runtime.

---

---

GWScrollBar.setSmallScroll(num)
Parameters
num An integer specifying the value to set.

Returns
Nothing.

Description
Method; sets the small scroll increment value of the scrollbar. This value controls the amount of scrolling executed when the up/down buttons of the scrollbar are pressed.

---

---

GWScrollBar.setLargeScroll(num)
Parameters
num An integer specifying the value to set.

Returns
Nothing.

Description
Method; sets the large scroll increment value of the scrollbar. This value controls the amount of scrolling executed when the track of the scrollbar is pressed.

---

---

GWScrollBar.setEnabled(flag)
Parameters
flag A boolean value specifying whether to set the scrollbar on/off.

Returns
Nothing.

Description
Method; force switch the scrollbar on/off. Unlike other components, the setEnabled method in the ScrollBar is a little special; it is actually used internally to switch the scrollbar on/off automatically when scrolling is available. Therefore, this method will usually not be used in your own actionscripts, unless you want to force disable the scrollbar at a specific time during runtime.

---

---

GWScrollBar.setScrollTarget(textfield)
Parameters
textfield A path to the target textfield.

Returns
Nothing.

Description
Method; sets the target of the scrollbar during runtime.

---