Adobe InDesign CS5 (7.0) Object Model JS: GradientFeatherSetting

InDesign CS5

Class

GradientFeatherSetting

 

Gradient feather effect settings. Base Class: Preference

Superclass of FindChangeGradientFeatherSetting

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

ContentTransparencySetting | FillTransparencySetting | StrokeTransparencySetting | TransparencySetting
Preference
GradientFeatherSetting
FindChangeGradientFeatherSetting
Event | EventListener | MutationEvent | OpacityGradientStop

Properties

PropertyTypeAccessDescription
anglenumber (range: -180 - 180) r/wThe angle of the gradient feather.
appliedbool r/wIf true, the gradient feather effect is applied.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
gradientStartArray of Measurement Unit (Number or String) r/wThe center point (for a radial gradient) or starting point (for a linear gradient) applied to the fill, as page coordinates in the format [x, y].
hiliteAnglenumber r/wThe hilite angle of the radial gradient feather.
hiliteLengthMeasurement Unit (Number or String) r/wThe hilite length of the radial gradient feather.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
lengthMeasurement Unit (Number or String) r/wThe length of the axial gradient, or radius of the radial gradient.
opacityGradientStopsOpacityGradientStops readonlyA collection of opacity gradient stops.
parentContentTransparencySettingFillTransparencySetting
StrokeTransparencySetting
TransparencySetting
readonlyThe parent of the GradientFeatherSetting (a TransparencySetting, StrokeTransparencySetting, FillTransparencySetting or ContentTransparencySetting).
propertiesObject r/wA property that allows setting of several properties at the same time.
typeGradientType:
GradientType.LINEAR
GradientType.RADIAL
r/wThe type of gradient.

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

string toSpecifier ()
Retrieves the object specifier.

Element of

ContentTransparencySetting.gradientFeatherSettings

FillTransparencySetting.gradientFeatherSettings

OpacityGradientStop.parent

StrokeTransparencySetting.gradientFeatherSettings

TransparencySetting.gradientFeatherSettings

Return

Array of GradientFeatherSetting GradientFeatherSetting.getElements ()

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