ListBox

Description

Displays a list of choices, represented by?ListItem?objects.

When you create the object, you specify whether it allows the user to select only one or multiple items. If a list contains more items than can be displayed in the available area, a scrollbar may appear that allows the user to scroll through all the list items.You can specify the items on creation of the list object, or afterward using the list object?s?add()?method. You can remove items programmatically with the list object?s?remove()?and?removeAll()?methods. You can create a list box with multiple columns; in this case, each row is a selectable choice, and each?ListItem?represents one row.

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?ListItem?elements.
columns readonly For a multi-column list box, the column properties.
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.
itemSize readonly The width and height in pixels of each item in the list.
items readonly The array of choice items displayed in the list.
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.
minimumSize readonly The minimum height and width to which the element can be resized.
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 control (properties used only when the element is created).
selection readonly The currently selected item for a single-selection list, or an array of items for current selection in a multi-selection list.
shortcutKey readonly The key sequence that invokes the?onShortcutKey()?callback for this element (in Windows only).
size readonly The current dimensions of this element.
type readonly The element type; “listbox”.
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

add readonly Adds an item to the choices in this list.
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.
find readonly Retrieves an item object from the list that has a given text label.
hide readonly Hides this element.
notify readonly Sends a notification message, simulating the specified user interaction event.
remove readonly Removes a child item from the list.
removeAll readonly Removes all child items from the list.
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 content of the element has been changed
onDeactivate readonly An event-handler callback function, called when the element loses the keyboard focus.
onDoubleClick readonly An event-handler callback function, called when an item in the listbox is double-clicked
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.