Widget
Generic term for an object in a dialog column or dialog row, including dialog controls such as radio button groups, checkboxes, editboxes, dropdowns, and comboboxes; static text objects; enabling groups; border panels; and nested dialog columns and dialog rows. For information, see dialog column, dialog row, static text, border panel, enabling group, radiobutton group, checkbox control, angle editbox, angle combobox, integer editbox, integer combobox, measurement editbox, measurement combobox, percent editbox, percent combobox, real editbox, real combobox, and text editbox.
Superclass of AngleCombobox, AngleEditbox, BorderPanel, CheckboxControl, Dropdown, EnablingGroup, IntegerCombobox, IntegerEditbox, MeasurementCombobox, MeasurementEditbox, PercentCombobox, PercentEditbox, RadiobuttonControl, RadiobuttonGroup, RealCombobox, RealEditbox, StaticText, and TextEditbox
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| id | number | readonly | The unique ID of the Widget. |
| index | number | readonly | The index of the Widget within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| minWidth | number | r/w | The width of the control. For an editbox or combobox, specifies the minimum width of the box. |
| parent | BorderPanelDialogColumn DialogRow EnablingGroup RadiobuttonGroup |
readonly | The parent of the Widget (a DialogColumn, DialogRow, EnablingGroup, BorderPanel or RadiobuttonGroup). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of Widget getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the Widget.
Used in:
Widget Widgets.nextItem (obj: Widget)
Widget Widgets.previousItem (obj: Widget)
Return
Array of Widget Widget.getElements ()
Widget Widgets.[] (index: number)
Widget Widgets.anyItem ()
Array of Widget Widgets.everyItem ()
Widget Widgets.firstItem ()
Widget Widgets.item (index: varies)
Widget Widgets.itemByID (id: number)
Array of Widget Widgets.itemByRange (from: varies, to: varies)
Widget Widgets.lastItem ()
Widget Widgets.middleItem ()
Widget Widgets.nextItem (obj: Widget)
Widget Widgets.previousItem (obj: Widget)
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |