Scrollbar

Description

A scrollbar with a draggable scroll indicator and stepper buttons to move the indicator.

The scrollbar control has a horizontal orientation if the width is greater than the height at creation time, or vertical if its height is greater than its width. Calls the?onChange()?callback after the position of the indicator is changed or if its?notify()?method is called. Calls the?onChanging()?callback repeatedly while the user is moving the indicator. Scrollbars are often created with an associated?EditText?field to display the current value of the scrollbar, and to allow setting the scrollbar’s position to a specific value.

Properties

active readonly True if this element is active.
alignment readonly The alignment style for this element. If defined, this value overrides the alignChildren setting for the parent container.
bounds readonly The boundaries of the element, in parent-relative coordinates.
children readonly An array of child elements.
enabled readonly True if this element is enabled.
graphics readonly The graphics object that can be used to customize the element’s appearance, in response to the?onDraw()?event.
helpTip readonly The help text that is displayed when the mouse hovers over the element.
indent readonly The number of pixels to indent the element during automatic layout.
jumpdelta readonly The amount to increment or decrement a scrollbar indicator’s position when the user clicks ahead or behind the moveable element.
location readonly The upper left corner of this element relative to its parent.
maximumSize readonly The maximum height and width to which the element can be resized.
maxvalue readonly The maximum value allowed in the value property.
minimumSize readonly The minimum height and width to which the element can be resized.
minvalue readonly The minimum value allowed in the value property.
parent readonly The parent element.
preferredSize readonly The preferred size, used by layout managers to determine the best size for each element.
properties readonly An object that contains one or more creation properties of the container (properties used only when the element is created).
shortcutKey readonly The key sequence that invokes the ?onShortcutKey()?callback for this element (in Windows only).
size readonly The current dimensions of this element.
stepdelta readonly The amount by which to increment or decrement a scrollbar element’s position when the user clicks a stepper button.
type readonly The element type, “scrollbar”.
value readonly The current position of the indicator.
visible readonly True if this element is shown, false if it is hidden.
window readonly The window that this element belongs to.
windowBounds readonly The bounds of this element relative to the top-level parent window.

Methods

addEventListener readonly Registers an event handler for a particular type of event occuring in this element.
dispatchEvent readonly Simulates the occurrence of an event in this target.
hide readonly Hides this element.
notify readonly Sends a notification message, simulating the specified user interaction event.
removeEventListener readonly Unregisters an event handler for a particular type of event occuring in this element.
show readonly Shows this element.

Events

onActivate readonly An event-handler callback function, called when the element acquires the keyboard focus.
onChange readonly An event-handler callback function, called when the user has finished dragging the position indicator, or has clicked the control.
onChanging readonly An event-handler callback function, called when the content of the element is in the process of changing
onDeactivate readonly An event-handler callback function, called when the element loses the keyboard focus.
onDraw readonly An event-handler callback function, called when the window is about to be drawn.
onShortcutKey readonly An event-handler callback function, called when the element’s?shortcutKey?sequence is typed in the active window.