Package | com.adobe.incopy |
Class | public class Sound |
Inheritance | Sound ![]() ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
absoluteFlip : Flip [override]
Indicates whether the Sound has been flipped independently of its parent object and, if yes, the direction in which the Sound was flipped. | Sound | ||
absoluteHorizontalScale : Number [override] [read-only]
The horizontal scale of the Sound relative to its containing object. | Sound | ||
absoluteRotationAngle : Number [override] [read-only]
The rotation angle of the Sound relative to its containing object. | Sound | ||
absoluteShearAngle : Number [override] [read-only]
The skewing angle of the Sound relative to its containing object. | Sound | ||
absoluteVerticalScale : Number [override] [read-only]
The vertical scale of the Sound relative to its containing object. | Sound | ||
AFTER_ATTRIBUTE_CHANGED : String [static] [read-only]
Dispatched when the value of a property changes on this Sound. | Sound | ||
AFTER_PLACE : String [static] [read-only]
Dispatched after a Sound is placed. | Sound | ||
allGraphics : Object [override] [read-only]
Lists all graphics contained by the Sound. | Sound | ||
allowOverrides : Boolean [override]
If true, the master page item can be overridden. | Sound | ||
allPageItems : Object [override] [read-only]
Lists all page items contained by the Sound. | Sound | ||
associatedXMLElement : XMLItem [override] [read-only]
The XML element associated with the Sound. | Sound | ||
BEFORE_PLACE : String [static] [read-only]
Dispatched before a Sound is placed. | Sound | ||
bottomLeftCornerOption : CornerOptions [override] [read-only]
The shape to apply to the bottom left corner of rectangular shapes. | Sound | ||
bottomLeftCornerRadius : Object [override] [read-only]
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
| Sound | ||
bottomRightCornerOption : CornerOptions [override] [read-only]
The shape to apply to the bottom right corner of rectangular shapes. | Sound | ||
bottomRightCornerRadius : Object [override] [read-only]
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
| Sound | ||
description : String
The description of the Sound. | Sound | ||
doNotPrintPoster : Boolean
If true, the sound poster does not print with the document. | Sound | ||
embedInPDF : Boolean
If true, the file is embedded in the PDF. | Sound | ||
endCap : EndCap [override] [read-only]
The end shape of an open path. | Sound | ||
endJoin : EndJoin [override] [read-only]
The corner join applied to the Sound. | Sound | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | Sound | ||
events : Events [override] [read-only]
A collection of events. | Sound | ||
filePath : String
The file path (colon delimited on the Mac OS). | Sound | ||
fillColor : Swatch [override] [read-only]
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Sound. | Sound | ||
fillTint : Number [override] [read-only]
The percent of tint to use in the Sound's fill color. | Sound | ||
flip : Flip [override]
The direction in which to flip the printed image. | Sound | ||
gapColor : Swatch [override] [read-only]
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. | Sound | ||
gapTint : Number [override] [read-only]
The tint as a percentage of the gap color. | Sound | ||
geometricBounds : Object [override] [read-only]
The bounds of the Sound excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | Sound | ||
gradientFillAngle : Number [override] [read-only]
The angle of a linear gradient applied to the fill of the Sound. | Sound | ||
gradientFillLength : Object [override] [read-only]
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Sound. | Sound | ||
gradientFillStart : Object [override] [read-only]
The starting point (in page coordinates) of a gradient applied to the fill of the Sound, in the format [x, y]. | Sound | ||
gradientStrokeAngle : Number [override] [read-only]
The angle of a linear gradient applied to the stroke of the Sound. | Sound | ||
gradientStrokeLength : Object [override] [read-only]
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Sound. | Sound | ||
gradientStrokeStart : Object [override] [read-only]
The starting point (in page coordinates) of a gradient applied to the stroke of the Sound, in the format [x, y]. | Sound | ||
graphics : Graphics [read-only]
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). | Sound | ||
horizontalScale : Number [override] [read-only]
The horizontal scaling applied to the Sound. | Sound | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [override] [read-only]
The unique ID of the Sound. | Sound | ||
images : Images [read-only]
A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). | Sound | ||
index : Number [override] [read-only]
The index of the Sound within its containing object. | Sound | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | Sound | ||
itemLayer : Layer [override] [read-only]
The layer that the Sound is on. | Sound | ||
itemLink : Link [read-only]
The source file of the link. | Sound | ||
label : String [override]
A property that can be set to any string. | Sound | ||
leftLineEnd : ArrowHead [override] [read-only]
The arrowhead applied to the start of the path. | Sound | ||
localDisplaySetting : DisplaySettingOptions [override] [read-only]
Display performance options for the Sound. | Sound | ||
locked : Boolean [override] [read-only]
If true, the Sound is locked. | Sound | ||
miterLimit : Number [override] [read-only]
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | Sound | ||
name : String [override]
The name of the Sound. | Sound | ||
nonprinting : Boolean [override] [read-only]
If true, the Sound does not print. | Sound | ||
overprintFill : Boolean [override] [read-only]
If true, the Sound's fill color overprints any underlying objects. | Sound | ||
overprintGap : Boolean [override] [read-only]
If true, the gap color overprints any underlying colors. | Sound | ||
overprintStroke : Boolean [override] [read-only]
If true, the Sound's stroke color overprints any underlying objects. | Sound | ||
overridden : Boolean [override] [read-only]
If true, the object originated on a master spread and was overridden. | Sound | ||
overriddenMasterPageItem : Object [override] [read-only]
An object that originated on a master page and has been overridden. | Sound | ||
pageItems : PageItems [read-only]
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. | Sound | ||
parent : Object [override] [read-only]
The parent of the Sound (a SplineItem, Polygon, GraphicLine, Rectangle or Oval). | Sound | ||
parentPage : Page [override] [read-only]
The page on which this page item appears. | Sound | ||
paths : Paths [override] [read-only]
A collection of paths. | Sound | ||
playOnPageTurn : Boolean
If true, the movie plays automatically when a user views the page that contains the movie poster in the PDF document. | Sound | ||
posterFile : String
The poster file. | Sound | ||
preferences : Preferences [override] [read-only]
A collection of preferences objects. | Sound | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | Sound | ||
rightLineEnd : ArrowHead [override] [read-only]
The arrowhead applied to the end of the path. | Sound | ||
rotationAngle : Number [override] [read-only]
The rotatation angle of the Sound. | Sound | ||
shearAngle : Number [override] [read-only]
The skewing angle applied to the Sound. | Sound | ||
soundLoop : Boolean
If true, sound loops forever (SWF only). | Sound | ||
soundPosterType : SoundPosterTypes
The type of sound poster. | Sound | ||
stopOnPageTurn : Boolean
If true, sounds stops playing when its page turns. | Sound | ||
strokeAlignment : StrokeAlignment [override] [read-only]
The stroke alignment applied to the Sound. | Sound | ||
strokeColor : Swatch [override] [read-only]
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Sound. | Sound | ||
strokeCornerAdjustment : StrokeCornerAdjustment [override] [read-only]
The corner adjustment applied to the Sound. | Sound | ||
strokeDashAndGap : Object [override] [read-only]
The dash and gap measurements that define the pattern of a custom dashed line. | Sound | ||
strokeTint : Number [override] [read-only]
The percent of tint to use in object's stroke color. | Sound | ||
strokeType : StrokeStyle [override] [read-only]
The name of the stroke style to apply. | Sound | ||
strokeWeight : Object [override] [read-only]
The weight (in points) to apply to the Sound's stroke. | Sound | ||
textWrapPreferences : TextWrapPreference [override] [read-only]
The text wrap preference properties that define the default formatting for wrapping text around objects. | Sound | ||
topLeftCornerOption : CornerOptions [override] [read-only]
The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. | Sound | ||
topLeftCornerRadius : Object [override] [read-only]
The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
| Sound | ||
topRightCornerOption : CornerOptions [override] [read-only]
The shape to apply to the top right corner of rectangular shapes
| Sound | ||
topRightCornerRadius : Object [override] [read-only]
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
| Sound | ||
verticalScale : Number [override] [read-only]
The vertical scaling applied to the Sound. | Sound | ||
visible : Boolean [override]
If true, the Sound is visible. | Sound | ||
visibleBounds : Object [override] [read-only]
The bounds of the Sound including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. | Sound |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerMediaItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | MediaItem | |
![]() | addEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PageItem | |
addEventListenerSound(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Sound | ||
autoTag():void [override]
Tag the object or the parent story using default tags defined in XML preference. | Sound | ||
changeObject(reverseOrderParam:Boolean):Object [override]
Finds objects that match the find what value and replace the objects with the change to value. | Sound | ||
clearTransformations():void [override]
Clears transformations from the Sound. | Sound | ||
convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void [override]
Converts the Sound to a different shape. | Sound | ||
extractLabel(keyParam:String = null):String [override]
Gets the label value associated with the specified key. | Sound | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
findObject(reverseOrderParam:Boolean):Object [override]
Finds objects that match the find what value. | Sound | ||
fit(givenParam:FitOptions = null):void [override]
Applies the specified fit option to content in a frame. | Sound | ||
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object [override]
Resolves the object specifier, creating an array of object references. | Sound | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
insertLabel(keyParam:String = null, valueParam:String = null):void [override]
Sets the label to the value associated with the specified key. | Sound | ||
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object [override]
Places the file. | Sound | ||
placeXML(usingParam:XMLElement = null):void [override]
Places XML content into the specified object. | Sound | ||
redefineScaling(toParam:Array = null):void [override]
Apply an item's scaling to its content if possible. | Sound | ||
reframe(inParam:Object = null, opposingCornersParam:Array = null):void [override]
Move the bounding box of the page item
| Sound | ||
![]() | removeEventListenerMediaItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | MediaItem | |
![]() | removeEventListenerPageItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PageItem | |
removeEventListenerSound(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Sound | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void [override]
Resize the page item. | Sound | ||
resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object [override]
Get the coordinates of the given location in the specified coordinate system. | Sound | ||
toSpecifier():String [override]
Retrieves the object specifier. | Sound | ||
transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void [override]
Transform the page item. | Sound | ||
transformValuesOf(inParam:CoordinateSpaces = null):Object [override]
Get the transformation values of the page item. | Sound | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
absoluteFlip | property |
absoluteFlip:Flip
[override] Since : | CS5 |
Indicates whether the Sound has been flipped independently of its parent object and, if yes, the direction in which the Sound was flipped.
public function get absoluteFlip():Flip
public function set absoluteFlip(value:Flip):void
absoluteHorizontalScale | property |
absoluteHorizontalScale:Number
[read-only] [override] Since : | CS5 |
The horizontal scale of the Sound relative to its containing object.
public function get absoluteHorizontalScale():Number
absoluteRotationAngle | property |
absoluteRotationAngle:Number
[read-only] [override] Since : | CS5 |
The rotation angle of the Sound relative to its containing object. (Range: -360 to 360)
public function get absoluteRotationAngle():Number
absoluteShearAngle | property |
absoluteShearAngle:Number
[read-only] [override] Since : | CS5 |
The skewing angle of the Sound relative to its containing object. (Range: -360 to 360)
public function get absoluteShearAngle():Number
absoluteVerticalScale | property |
absoluteVerticalScale:Number
[read-only] [override] Since : | CS5 |
The vertical scale of the Sound relative to its containing object.
public function get absoluteVerticalScale():Number
AFTER_ATTRIBUTE_CHANGED | property |
AFTER_ATTRIBUTE_CHANGED:String
[read-only] Since : | CS5 |
Dispatched when the value of a property changes on this Sound. This event bubbles. This event is not cancelable.
public static function get AFTER_ATTRIBUTE_CHANGED():String
AFTER_PLACE | property |
AFTER_PLACE:String
[read-only] Since : | CS5 |
Dispatched after a Sound is placed. This event bubbles. This event is not cancelable.
public static function get AFTER_PLACE():String
allGraphics | property |
allGraphics:Object
[read-only] [override] Since : | CS5 |
Lists all graphics contained by the Sound.
public function get allGraphics():Object
allowOverrides | property |
allowOverrides:Boolean
[override] Since : | CS5 |
If true, the master page item can be overridden.
public function get allowOverrides():Boolean
public function set allowOverrides(value:Boolean):void
allPageItems | property |
allPageItems:Object
[read-only] [override] Since : | CS5 |
Lists all page items contained by the Sound.
public function get allPageItems():Object
associatedXMLElement | property |
associatedXMLElement:XMLItem
[read-only] [override] Since : | CS5 |
The XML element associated with the Sound.
public function get associatedXMLElement():XMLItem
BEFORE_PLACE | property |
BEFORE_PLACE:String
[read-only] Since : | CS5 |
Dispatched before a Sound is placed. This event bubbles. This event is cancelable.
public static function get BEFORE_PLACE():String
bottomLeftCornerOption | property |
bottomLeftCornerOption:CornerOptions
[read-only] [override] Since : | CS5 |
The shape to apply to the bottom left corner of rectangular shapes.
public function get bottomLeftCornerOption():CornerOptions
bottomLeftCornerRadius | property |
bottomLeftCornerRadius:Object
[read-only] [override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
public function get bottomLeftCornerRadius():Object
bottomRightCornerOption | property |
bottomRightCornerOption:CornerOptions
[read-only] [override] Since : | CS5 |
The shape to apply to the bottom right corner of rectangular shapes.
public function get bottomRightCornerOption():CornerOptions
bottomRightCornerRadius | property |
bottomRightCornerRadius:Object
[read-only] [override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
public function get bottomRightCornerRadius():Object
description | property |
description:String
Since : | CS5 |
The description of the Sound.
public function get description():String
public function set description(value:String):void
doNotPrintPoster | property |
doNotPrintPoster:Boolean
Since : | CS5 |
If true, the sound poster does not print with the document.
public function get doNotPrintPoster():Boolean
public function set doNotPrintPoster(value:Boolean):void
embedInPDF | property |
embedInPDF:Boolean
Since : | CS5 |
If true, the file is embedded in the PDF. If false, the file is linked to the PDF. Note: To embed movie files, acrobat compatibility must be acrobat 6 or higher.
public function get embedInPDF():Boolean
public function set embedInPDF(value:Boolean):void
endCap | property |
endCap:EndCap
[read-only] [override] Since : | CS5 |
The end shape of an open path.
public function get endCap():EndCap
endJoin | property |
endJoin:EndJoin
[read-only] [override] Since : | CS5 |
The corner join applied to the Sound.
public function get endJoin():EndJoin
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
filePath | property |
filePath:String
Since : | CS5 |
The file path (colon delimited on the Mac OS). Can also accept: File.
public function get filePath():String
public function set filePath(value:String):void
fillColor | property |
fillColor:Swatch
[read-only] [override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Sound. . Can also accept: String.
public function get fillColor():Swatch
fillTint | property |
fillTint:Number
[read-only] [override] Since : | CS5 |
The percent of tint to use in the Sound's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get fillTint():Number
flip | property |
flip:Flip
[override] Since : | CS5 |
The direction in which to flip the printed image.
public function get flip():Flip
public function set flip(value:Flip):void
gapColor | property |
gapColor:Swatch
[read-only] [override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
public function get gapColor():Swatch
gapTint | property |
gapTint:Number
[read-only] [override] Since : | CS5 |
The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get gapTint():Number
geometricBounds | property |
geometricBounds:Object
[read-only] [override] Since : | CS5 |
The bounds of the Sound excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
public function get geometricBounds():Object
gradientFillAngle | property |
gradientFillAngle:Number
[read-only] [override] Since : | CS5 |
The angle of a linear gradient applied to the fill of the Sound. (Range: -180 to 180)
public function get gradientFillAngle():Number
gradientFillLength | property |
gradientFillLength:Object
[read-only] [override] Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Sound.
public function get gradientFillLength():Object
gradientFillStart | property |
gradientFillStart:Object
[read-only] [override] Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the fill of the Sound, in the format [x, y].
public function get gradientFillStart():Object
gradientStrokeAngle | property |
gradientStrokeAngle:Number
[read-only] [override] Since : | CS5 |
The angle of a linear gradient applied to the stroke of the Sound. (Range: -180 to 180)
public function get gradientStrokeAngle():Number
gradientStrokeLength | property |
gradientStrokeLength:Object
[read-only] [override] Since : | CS5 |
The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Sound.
public function get gradientStrokeLength():Object
gradientStrokeStart | property |
gradientStrokeStart:Object
[read-only] [override] Since : | CS5 |
The starting point (in page coordinates) of a gradient applied to the stroke of the Sound, in the format [x, y].
public function get gradientStrokeStart():Object
graphics | property |
graphics:Graphics
[read-only] Since : | CS5 |
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
public function get graphics():Graphics
horizontalScale | property |
horizontalScale:Number
[read-only] [override] Since : | CS5 |
The horizontal scaling applied to the Sound.
public function get horizontalScale():Number
id | property |
id:Number
[read-only] [override] Since : | CS5 |
The unique ID of the Sound.
public function get id():Number
images | property |
images:Images
[read-only] Since : | CS5 |
A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
public function get images():Images
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the Sound within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
itemLayer | property |
itemLayer:Layer
[read-only] [override] Since : | CS5 |
The layer that the Sound is on.
public function get itemLayer():Layer
itemLink | property |
itemLink:Link
[read-only] Since : | CS5 |
The source file of the link.
public function get itemLink():Link
label | property |
label:String
[override] Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
leftLineEnd | property |
leftLineEnd:ArrowHead
[read-only] [override] Since : | CS5 |
The arrowhead applied to the start of the path.
public function get leftLineEnd():ArrowHead
localDisplaySetting | property |
localDisplaySetting:DisplaySettingOptions
[read-only] [override] Since : | CS5 |
Display performance options for the Sound.
public function get localDisplaySetting():DisplaySettingOptions
locked | property |
locked:Boolean
[read-only] [override] Since : | CS5 |
If true, the Sound is locked.
public function get locked():Boolean
miterLimit | property |
miterLimit:Number
[read-only] [override] Since : | CS5 |
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
public function get miterLimit():Number
name | property |
name:String
[override] Since : | CS5 |
The name of the Sound.
public function get name():String
public function set name(value:String):void
nonprinting | property |
nonprinting:Boolean
[read-only] [override] Since : | CS5 |
If true, the Sound does not print.
public function get nonprinting():Boolean
overprintFill | property |
overprintFill:Boolean
[read-only] [override] Since : | CS5 |
If true, the Sound's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
public function get overprintFill():Boolean
overprintGap | property |
overprintGap:Boolean
[read-only] [override] Since : | CS5 |
If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
public function get overprintGap():Boolean
overprintStroke | property |
overprintStroke:Boolean
[read-only] [override] Since : | CS5 |
If true, the Sound's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
public function get overprintStroke():Boolean
overridden | property |
overridden:Boolean
[read-only] [override] Since : | CS5 |
If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
public function get overridden():Boolean
overriddenMasterPageItem | property |
overriddenMasterPageItem:Object
[read-only] [override] Since : | CS5 |
An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
public function get overriddenMasterPageItem():Object
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
public function get pageItems():PageItems
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the Sound (a SplineItem, Polygon, GraphicLine, Rectangle or Oval).
public function get parent():Object
parentPage | property |
parentPage:Page
[read-only] [override] Since : | CS5 |
The page on which this page item appears.
public function get parentPage():Page
paths | property |
paths:Paths
[read-only] [override] Since : | CS5 |
A collection of paths.
public function get paths():Paths
playOnPageTurn | property |
playOnPageTurn:Boolean
Since : | CS5 |
If true, the movie plays automatically when a user views the page that contains the movie poster in the PDF document.
public function get playOnPageTurn():Boolean
public function set playOnPageTurn(value:Boolean):void
posterFile | property |
posterFile:String
Since : | CS5 |
The poster file.
public function get posterFile():String
public function set posterFile(value:String):void
preferences | property |
preferences:Preferences
[read-only] [override] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rightLineEnd | property |
rightLineEnd:ArrowHead
[read-only] [override] Since : | CS5 |
The arrowhead applied to the end of the path.
public function get rightLineEnd():ArrowHead
rotationAngle | property |
rotationAngle:Number
[read-only] [override] Since : | CS5 |
The rotatation angle of the Sound. (Range: -360 to 360)
public function get rotationAngle():Number
shearAngle | property |
shearAngle:Number
[read-only] [override] Since : | CS5 |
The skewing angle applied to the Sound. (Range: -360 to 360)
public function get shearAngle():Number
soundLoop | property |
soundLoop:Boolean
Since : | CS5 |
If true, sound loops forever (SWF only).
public function get soundLoop():Boolean
public function set soundLoop(value:Boolean):void
soundPosterType | property |
soundPosterType:SoundPosterTypes
Since : | CS5 |
The type of sound poster.
public function get soundPosterType():SoundPosterTypes
public function set soundPosterType(value:SoundPosterTypes):void
stopOnPageTurn | property |
stopOnPageTurn:Boolean
Since : | CS5 |
If true, sounds stops playing when its page turns.
public function get stopOnPageTurn():Boolean
public function set stopOnPageTurn(value:Boolean):void
strokeAlignment | property |
strokeAlignment:StrokeAlignment
[read-only] [override] Since : | CS5 |
The stroke alignment applied to the Sound.
public function get strokeAlignment():StrokeAlignment
strokeColor | property |
strokeColor:Swatch
[read-only] [override] Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Sound. Can also accept: String.
public function get strokeColor():Swatch
strokeCornerAdjustment | property |
strokeCornerAdjustment:StrokeCornerAdjustment
[read-only] [override] Since : | CS5 |
The corner adjustment applied to the Sound.
public function get strokeCornerAdjustment():StrokeCornerAdjustment
strokeDashAndGap | property |
strokeDashAndGap:Object
[read-only] [override] Since : | CS5 |
The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
public function get strokeDashAndGap():Object
strokeTint | property |
strokeTint:Number
[read-only] [override] Since : | CS5 |
The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
public function get strokeTint():Number
strokeType | property |
strokeType:StrokeStyle
[read-only] [override] Since : | CS5 |
The name of the stroke style to apply. Can also accept: String.
public function get strokeType():StrokeStyle
strokeWeight | property |
strokeWeight:Object
[read-only] [override] Since : | CS5 |
The weight (in points) to apply to the Sound's stroke.
public function get strokeWeight():Object
textWrapPreferences | property |
textWrapPreferences:TextWrapPreference
[read-only] [override] Since : | CS5 |
The text wrap preference properties that define the default formatting for wrapping text around objects.
public function get textWrapPreferences():TextWrapPreference
topLeftCornerOption | property |
topLeftCornerOption:CornerOptions
[read-only] [override] Since : | CS5 |
The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
public function get topLeftCornerOption():CornerOptions
topLeftCornerRadius | property |
topLeftCornerRadius:Object
[read-only] [override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
public function get topLeftCornerRadius():Object
topRightCornerOption | property |
topRightCornerOption:CornerOptions
[read-only] [override] Since : | CS5 |
The shape to apply to the top right corner of rectangular shapes
public function get topRightCornerOption():CornerOptions
topRightCornerRadius | property |
topRightCornerRadius:Object
[read-only] [override] Since : | CS5 |
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
public function get topRightCornerRadius():Object
verticalScale | property |
verticalScale:Number
[read-only] [override] Since : | CS5 |
The vertical scaling applied to the Sound.
public function get verticalScale():Number
visible | property |
visible:Boolean
[override] Since : | CS5 |
If true, the Sound is visible.
public function get visible():Boolean
public function set visible(value:Boolean):void
visibleBounds | property |
visibleBounds:Object
[read-only] [override] Since : | CS5 |
The bounds of the Sound including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
public function get visibleBounds():Object
addEventListenerSound | () | method |
public function addEventListenerSound(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
autoTag | () | method |
override public function autoTag():void
Since : | CS5 |
Tag the object or the parent story using default tags defined in XML preference.
changeObject | () | method |
override public function changeObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value and replace the objects with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
clearTransformations | () | method |
override public function clearTransformations():void
Since : | CS5 |
Clears transformations from the Sound. Transformations include rotation, scaling, flipping, fitting, and shearing.
convertShape | () | method |
override public function convertShape(givenParam:ConvertShapeOptions = null, numberOfSidesParam:Number, insetPercentageParam:Number, cornerRadiusParam:Object = null):void
Since : | CS5 |
Converts the Sound to a different shape.
Parameters
givenParam:ConvertShapeOptions (default = null ) — (ConvertShapeOptions) The Sound's new shape.
| |
numberOfSidesParam:Number (default = NaN ) — (Number) The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
| |
insetPercentageParam:Number (default = NaN ) — (Number) The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
| |
cornerRadiusParam:Object (default = null ) — (Object) The corner radius of the resulting rectangle. (Optional)
|
extractLabel | () | method |
override public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
findObject | () | method |
override public function findObject(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds objects that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
fit | () | method |
override public function fit(givenParam:FitOptions = null):void
Since : | CS5 |
Applies the specified fit option to content in a frame.
Parameters
givenParam:FitOptions (default = null ) — (FitOptions) The fit option to use.
|
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
override public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
place | () | method |
override public function place(fileNameParam:File = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):Object
Since : | CS5 |
Places the file.
Parameters
fileNameParam:File (default = null ) — (File) The file to place
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Whether to display the import options dialog (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the placed object(s) (Optional)
|
Object |
placeXML | () | method |
override public function placeXML(usingParam:XMLElement = null):void
Since : | CS5 |
Places XML content into the specified object. Note: Replaces any existing content.
Parameters
usingParam:XMLElement (default = null ) — (XMLElement) The XML element whose content you want to place.
|
redefineScaling | () | method |
override public function redefineScaling(toParam:Array = null):void
Since : | CS5 |
Apply an item's scaling to its content if possible.
Parameters
toParam:Array (default = null ) — (Array) The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)
|
reframe | () | method |
override public function reframe(inParam:Object = null, opposingCornersParam:Array = null):void
Since : | CS5 |
Move the bounding box of the page item
Parameters
inParam:Object (default = null ) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
| |
opposingCornersParam:Array (default = null ) — (Array) Opposing corners of new bounding box in the given coordinate space
|
removeEventListenerSound | () | method |
public function removeEventListenerSound(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
resize | () | method |
override public function resize(inParam:Object = null, fromParam:Object = null, byParam:ResizeMethods = null, valuesParam:Array = null, resizeIndividuallyParam:Boolean = true, consideringRulerUnitsParam:Boolean = false):void
Since : | CS5 |
Resize the page item.
Parameters
inParam:Object (default = null ) — (Object) The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
| |
fromParam:Object (default = null ) — (Object) The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
| |
byParam:ResizeMethods (default = null ) — (ResizeMethods) How the current dimensions are affected by the given values
| |
valuesParam:Array (default = null ) — (Array) The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.
| |
resizeIndividuallyParam:Boolean (default = true ) — (Boolean) If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional)
| |
consideringRulerUnitsParam:Boolean (default = false ) — (Boolean) If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)
|
resolve | () | method |
override public function resolve(locationParam:Object = null, inParam:CoordinateSpaces = null, consideringRulerUnitsParam:Boolean = false):Object
Since : | CS5 |
Get the coordinates of the given location in the specified coordinate system.
Parameters
locationParam:Object (default = null ) — (Object) The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
| |
inParam:CoordinateSpaces (default = null ) — (CoordinateSpaces) The coordinate space to use.
| |
consideringRulerUnitsParam:Boolean (default = false ) — (Boolean) If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)
|
Object |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
transform | () | method |
override public function transform(inParam:CoordinateSpaces = null, fromParam:Object = null, withMatrixParam:Object = null, replacingCurrentParam:Object = null, consideringRulerUnitsParam:Boolean = false):void
Since : | CS5 |
Transform the page item.
Parameters
inParam:CoordinateSpaces (default = null ) — (CoordinateSpaces) The coordinate space to use
| |
fromParam:Object (default = null ) — (Object) The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
| |
withMatrixParam:Object (default = null ) — (Object) Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
| |
replacingCurrentParam:Object (default = null ) — (Object) Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional)
| |
consideringRulerUnitsParam:Boolean (default = false ) — (Boolean) If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)
|
transformValuesOf | () | method |
override public function transformValuesOf(inParam:CoordinateSpaces = null):Object
Since : | CS5 |
Get the transformation values of the page item.
Parameters
inParam:CoordinateSpaces (default = null ) — (CoordinateSpaces) The coordinate space to use
|
Object |