Adobe InDesign CS3 (5.0) Object Model JS: Widget

InDesign CS3

Class

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

getElements, toSource, toSpecifier

Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup
Widget
AngleCombobox | AngleEditbox | BorderPanel | CheckboxControl | Dropdown | EnablingGroup | IntegerCombobox | IntegerEditbox | MeasurementCombobox | MeasurementEditbox | PercentCombobox | PercentEditbox | RadiobuttonControl | RadiobuttonGroup | RealCombobox | RealEditbox | StaticText | TextEditbox

Properties

PropertyTypeAccessDescription
idnumber readonlyThe unique ID of the Widget.
indexnumber readonlyThe index of the Widget within its containing object.
minWidthnumber r/wThe width of the control. For an editbox or combobox, specifies the minimum width of the box.
parentBorderPanelDialogColumn
DialogRow
EnablingGroup
readonlyThe parent of the Widget (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

Array of Widget getElements ()
Resolves the object specifier, creating an array of object references.

string toSource ()
Generates a string which, if executed, will return the Widget.

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of Widget Widgets.itemByRange (from: any, to: any)

Widget Widgets.nextItem (obj: Widget)

Widget Widgets.previousItem (obj: Widget)

Return

Array of Widget Widget.getElements ()

Widget Widgets.anyItem ()

Array of Widget Widgets.everyItem ()

Widget Widgets.firstItem ()

Widget Widgets.item (index: any)

Widget Widgets.itemByID (id: number)

Widget Widgets.itemByName (name: string)

Array of Widget Widgets.itemByRange (from: any, to: any)

Widget Widgets.lastItem ()

Widget Widgets.middleItem ()

Widget Widgets.nextItem (obj: Widget)

Widget Widgets.previousItem (obj: Widget)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index