Adobe InDesign CS6 (8.0) Object Model JS: OpacityGradientStop

InDesign CS6

Class

OpacityGradientStop

 An opacity gradient stop.

QuickLinks

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

FindChangeGradientFeatherSetting | GradientFeatherSetting
OpacityGradientStop
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
indexnumber readonlyThe index of the OpacityGradientStop within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
locationnumber (range: 0 - 100) r/wThe location of the opacity gradient stop, as a percentage of the OpacityGradientStop size. (Range: 0 to 100)
midpointnumber (range: 13 - 87) r/wThe mid-point of the opacity gradient stop, as a percentage of the OpacityGradientStop size. (Range: 13 to 87)
opacitynumber (range: 0 - 100) r/wThe opacity of the opacity gradient stop (as a percentage). (Range: 0 to 100)
parentFindChangeGradientFeatherSettingGradientFeatherSetting readonlyThe parent of the OpacityGradientStop (a GradientFeatherSetting or FindChangeGradientFeatherSetting).
propertiesObject r/wA 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.

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 OpacityGradientStop getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the OpacityGradientStop.

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 OpacityGradientStop.

string toSpecifier ()
Retrieves the object specifier.

Used in:

OpacityGradientStop OpacityGradientStops.nextItem (obj: OpacityGradientStop)

OpacityGradientStop OpacityGradientStops.previousItem (obj: OpacityGradientStop)

Return

Array of OpacityGradientStop OpacityGradientStop.getElements ()

OpacityGradientStop OpacityGradientStops.[] (index: number)

OpacityGradientStop OpacityGradientStops.add ([withProperties: Object])

OpacityGradientStop OpacityGradientStops.anyItem ()

Array of OpacityGradientStop OpacityGradientStops.everyItem ()

OpacityGradientStop OpacityGradientStops.firstItem ()

OpacityGradientStop OpacityGradientStops.item (index: varies)

Array of OpacityGradientStop OpacityGradientStops.itemByRange (from: varies, to: varies)

OpacityGradientStop OpacityGradientStops.lastItem ()

OpacityGradientStop OpacityGradientStops.middleItem ()

OpacityGradientStop OpacityGradientStops.nextItem (obj: OpacityGradientStop)

OpacityGradientStop OpacityGradientStops.previousItem (obj: OpacityGradientStop)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index