Adobe InCopy CS5 (7.0) Object Model JS: EnablingGroup

InCopy CS5

Class

EnablingGroup

 A bordered panel that contains an enabling checkbox. A user makes the enabling group active or inactive by clicking the checkbox. An enabling group can contain any type and number of controls. Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

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

Properties

PropertyTypeAccessDescription
angleComboboxesAngleComboboxes readonlyA collection of angle comboboxes.
angleEditboxesAngleEditboxes readonlyA collection of angle editboxes.
borderPanelsBorderPanels readonlyA collection of border panels.
checkboxControlsCheckboxControls readonlyA collection of checkbox controls.
checkedStatebool r/wIf true, the control is checked by default in the dialog.
dialogColumnsDialogColumns readonlyA collection of dialog columns.
dropdownsDropdowns readonlyA collection of dropdowns.
enablingGroupsEnablingGroups readonlyA collection of enabling groups.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the EnablingGroup.
indexnumber readonlyThe index of the EnablingGroup within its containing object.
integerComboboxesIntegerComboboxes readonlyA collection of integer comboboxes.
integerEditboxesIntegerEditboxes readonlyA collection of integer editboxes.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
measurementComboboxesMeasurementComboboxes readonlyA collection of measurement comboboxes.
measurementEditboxesMeasurementEditboxes readonlyA collection of measurement editboxes.
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 EnablingGroup (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
percentComboboxesPercentComboboxes readonlyA collection of percent comboboxes.
percentEditboxesPercentEditboxes readonlyA collection of percent editboxes.
propertiesObject r/wA property that allows setting of several properties at the same time.
radiobuttonGroupsRadiobuttonGroups readonlyA collection of radiobutton groups.
realComboboxesRealComboboxes readonlyA collection of real number comboboxes.
realEditboxesRealEditboxes readonlyA collection of real number editboxes.
staticLabelstring r/wText that appears in the EnablingGroup.
staticTextsStaticTexts readonlyA collection of static text objects.
textEditboxesTextEditboxes readonlyA collection of text editboxes.
widgetsWidgets readonlyA collection of widgets.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

AngleCombobox.parent

AngleEditbox.parent

BorderPanel.parent

CheckboxControl.parent

DialogColumn.parent

Dropdown.parent

EnablingGroup.parent

IntegerCombobox.parent

IntegerEditbox.parent

MeasurementCombobox.parent

MeasurementEditbox.parent

PercentCombobox.parent

PercentEditbox.parent

RadiobuttonGroup.parent

RealCombobox.parent

RealEditbox.parent

StaticText.parent

TextEditbox.parent

Used in:

EnablingGroup EnablingGroups.nextItem (obj: EnablingGroup)

EnablingGroup EnablingGroups.previousItem (obj: EnablingGroup)

Return

Array of EnablingGroup EnablingGroup.getElements ()

EnablingGroup EnablingGroups.[] (index: number)

EnablingGroup EnablingGroups.add ([withProperties: Object])

EnablingGroup EnablingGroups.anyItem ()

Array of EnablingGroup EnablingGroups.everyItem ()

EnablingGroup EnablingGroups.firstItem ()

EnablingGroup EnablingGroups.item (index: varies)

EnablingGroup EnablingGroups.itemByID (id: number)

Array of EnablingGroup EnablingGroups.itemByRange (from: varies, to: varies)

EnablingGroup EnablingGroups.lastItem ()

EnablingGroup EnablingGroups.middleItem ()

EnablingGroup EnablingGroups.nextItem (obj: EnablingGroup)

EnablingGroup EnablingGroups.previousItem (obj: EnablingGroup)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index