Adobe Extending Flash Professional CS4 Manuel d'utilisateur

Extending ADOBE® FLASH® CS4 PROFESSIONAL

xChapter 16: Filter objectfilter.angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

78EXTENDING FLASH CS4 PROFESSIONALDocument objectThe following example sets the autoLabel property to true, telling Flash to automatically label objec

79EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.canEditSymbol()AvailabilityFlash MX 2004.Usage document.canEditSymbol()ParametersNone. Retur

80EXTENDING FLASH CS4 PROFESSIONALDocument object if(fl.getDocumentDOM().canRevert()){ fl.getDocumentDOM().revert(); }document.canSaveAVersion(

81EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; determines whether you can use the document.testMovie() method successfully. Examp

82EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.changeFilterOrder(oldIndex, newIndex)ParametersoldIndex An integer that represents th

83EXTENDING FLASH CS4 PROFESSIONALDocument objectReturnsNothing. DescriptionMethod; copies the current selection from the document to the Clipboard. T

84EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.clipPaste([bInPlace])ParametersbInPlace A Boolean value that, when set to true, cause

85EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().close();The following example closes the current document without saving changes

86EXTENDING FLASH CS4 PROFESSIONALDocument objectReturnsAn object for the newly created symbol, or null if it cannot create the symbol.DescriptionMeth

87EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.currentPublishProfileDescriptionProperty; a string that specifies the name of the acti

xifl.findObjectInDocByName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.deleteEnvelope()AvailabilityFlash 8.Usage document.deleteEnvelope()ParametersNone.ReturnsA B

89EXTENDING FLASH CS4 PROFESSIONALDocument object alert(fl.getDocumentDOM().deletePublishProfile());See alsodocument.addNewPublishProfile()document.de

90EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; deletes the current selection on the Stage. Displays an error message if there is

91EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example disables all filters on the selected objects: fl.getDocumentDOM().disabl

92EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersenabledFilterIndex An integer representing the zero-based index of the filter that should

93EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().distribute("top edge", false);The following example distributes the se

94EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example specifies that the ActionScript 3.0 class associated with the document i

95EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersprofileName A string that specifies the unique name of the duplicated profile. If you do n

96EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.duplicateSelection()ParametersNone. ReturnsNothing. DescriptionMethod; duplicates the

97EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.enableAllFilters()ParametersNone.ReturnsNothing.DescriptionMethod; enables all the fil

xiiFLfile.exists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.enterEditMode()AvailabilityFlash MX 2004.Usage document.enterEditMode([editMode])Parameterse

99EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; exits from symbol-editing mode and returns focus to the next level up from the edi

100EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.exportPublishProfile()AvailabilityFlash MX 2004.Usage document.exportPublishProfile(fileURI

101EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example stores an XML string that represents the current profile in a variable

102EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.externalLibraryPathAvailabilityFlash CS4 Professional.Usage document.externalLibraryPathDes

103EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.frameRateAvailabilityFlash MX 2004.Usage document.frameRateDescriptionProperty; a float val

104EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.getBlendMode()AvailabilityFlash 8.Usage document.getBlendMode()ParametersNone.ReturnsA stri

105EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; retrieves the fill object of the selected shape or, if specified, of the Tools pa

106EXTENDING FLASH CS4 PROFESSIONALDocument object var stroke = fl.getDocumentDOM().getCustomStroke("selection"); stroke.thickness = 2;

107EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.getElementProperty(propertyName)ParameterspropertyName A string that specifies the

xiiiframe.tweenEasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

108EXTENDING FLASH CS4 PROFESSIONALDocument objectReturnsIf one text field is selected, the property is returned if there is only one value used withi

109EXTENDING FLASH CS4 PROFESSIONALDocument objectSee alsodocument.addFilter(), document.changeFilterOrder(), document.setFilters(), Filter objectdocu

110EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example displays the XML settings string for the current document: fl.trace(fl.

111EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.getSelectionRect()AvailabilityFlash MX 2004.Usage document.getSelectionRect()ParametersNone

112EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; gets the currently selected text. If the optional parameters are not passed, the

113EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().enterEditMode("inPlace"); fl.getDocumentDOM().getTimeline().insertF

114EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.group()ParametersNone. ReturnsNothing. DescriptionMethod; converts the current select

115EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.idDescriptionRead-only property; a unique integer (assigned automatically) that ident

116EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.importPublishProfile()AvailabilityFlash MX 2004.Usage document.importPublishProfile( fileUR

117EXTENDING FLASH CS4 PROFESSIONALDocument objectvar profileXML=fl.getDocumentDOM().exportPublishProfileString('Default'); fl.trace(profil

xivlibrary.deleteItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

118EXTENDING FLASH CS4 PROFESSIONALDocument objectReturnsA Boolean value: true if successful; false otherwise.DescriptionMethod; creates an intersecti

119EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionProperty; a string that contains a list of items in the document’s ActionScript 3.0 Libra

120EXTENDING FLASH CS4 PROFESSIONALDocument objectbHeight A Boolean value that, when set to true, causes the method to make the heights of the select

121EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().mouseClick({x:300, y:200}, false, false);See alsodocument.mouseDblClk()document

122EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersdelta A pair of floating-point values that specify the x and y coordinates in pixels by w

123EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.nameAvailabilityFlash MX 2004.Usage document.nameDescriptionRead-only property; a string th

124EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().optimizeCurves(50, true);document.pathAvailabilityFlash MX 2004.Usage document.

125EXTENDING FLASH CS4 PROFESSIONALDocument objectSee alsodocument.pathdocument.publish()AvailabilityFlash MX 2004.Usage document.publish()ParametersN

126EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.punch()AvailabilityFlash 8.Usage document.punch()ParametersNone.ReturnsA Boolean value: tru

127EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().removeAllFilters();See alsodocument.addFilter(), document.changeFilterOrder(),

xvparameter.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

128EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; removes persistent data with the specified name that has been attached to the sel

129EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersprofileNewName An optional parameter that specifies the new name for the profile. The new

130EXTENDING FLASH CS4 PROFESSIONALDocument objectParameterssceneToMove An integer that specifies which scene to move, with 0 (zero) being the first

131EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.resetRectangleObject()AvailabilityFlash CS3 Professional.Usage document.resetRectangleObjec

132EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().resetTransformation();document.revert()AvailabilityFlash MX 2004.Usage document

133EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; if the file can be reverted, displays a dialog box to let the user confirm that t

134EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.rotateSelection(angle [, rotationPoint])Parametersangle A floating-point value that

135EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example saves the current document in its default location: fl.getDocumentDOM()

136EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersNone.ReturnsA Boolean value of true if a version of the document is successfully saved to

137EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example expands the width of the current selection to double the original width

xviChapter 36: Screen objectscreen.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

138EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersNone. ReturnsNothing. DescriptionMethod; selects all items on the Stage. This method is eq

139EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().getTimeline().currentFrame = 10; fl.getDocumentDOM().selection = fl.getDocume

140EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.selectNone()AvailabilityFlash MX 2004.Usage document.selectNone()ParametersNone. ReturnsNot

141EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().setAlignToDocument(true);See alsodocument.getAlignToDocument()document.setBlend

142EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; sets the fill settings for the Tools panel, Property inspector, and any selected

143EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.setElementProperty()AvailabilityFlash MX 2004.Usage document.setElementProperty(property, v

144EXTENDING FLASH CS4 PROFESSIONALDocument objectReturnsA Boolean value: true if at least one text attribute property is changed; false otherwise.Des

145EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().setFillColor("#cc00cc"); fl.getDocumentDOM().setFillColor(0xcc00cc)

146EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.setFilters(filterArray)ParametersfilterArray The array of filters currently specifie

147EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().setInstanceAlpha(50);document.setInstanceBrightness()AvailabilityFlash MX 2004.

xviiChapter 39: SoundItem objectsoundItem.bitRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

148EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example sets the tint for the selected instance to red with an opacity value of

149EXTENDING FLASH CS4 PROFESSIONALDocument object <rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'> <rdf:Descrip

150EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; sets the value of an XML settings string in a mobile FLA file. (Most mobile FLA f

151EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.setPlayerVersion()AvailabilityFlash CS3 Professional.Usage document.setPlayerVersion(versio

152EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; specifies a value for a specified property of primitive Rectangle objects.Example

153EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.setSelectionRect()AvailabilityFlash MX 2004; bContactSensitiveSelection parameter added in

154EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.setStageVanishingPoint()AvailabilityFlash CS4 Professional.Usage document.setStageVanishing

155EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.setStroke()AvailabilityFlash MX 2004.Usage document.setStroke(color, size, strokeType)Param

156EXTENDING FLASH CS4 PROFESSIONALDocument objectReturnsNothing. DescriptionMethod; changes the stroke color of the selection to the specified color.

157EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersstrokeType A string that specifies the stroke style for the current selection. Acceptable

xviiiChapter 42: SymbolInstance objectsymbolInstance.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

158EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().setTextRectangle({left:0, top:0, right:50, bottom:200}) document.setTextSelecti

159EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; inserts a string of text. If the optional parameters are not passed, the existing

160EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; sets the position of the current selection’s transformation point. ExampleThe fol

161EXTENDING FLASH CS4 PROFESSIONALDocument objectwhichEdge A string that specifies the edge where the transformation occurs; if omitted, skew occurs

162EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.sourcePathDescriptionProperty; a string that contains a list of items in the document

163EXTENDING FLASH CS4 PROFESSIONALDocument objectThe following example spaces the objects horizontally, relative to each other, with bUseDcoumentBoun

164EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; swaps the current selection with the specified one. The selection must contain a

165EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod; synchronizes the specified document with the most current version on the Version

166EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.testScene()ParametersNone. ReturnsNothing. DescriptionMethod; executes a Test Scene o

167EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.traceBitmap()AvailabilityFlash MX 2004.Usage document.traceBitmap(threshold, minimumArea, c

xixtext.getTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

168EXTENDING FLASH CS4 PROFESSIONALDocument objectDescriptionMethod: sets the XYZ position around which the selection is translated or rotated. This m

169EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.transformSelection(a, b, c, d)Parametersa A floating-point number that specifies the

170EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.union()AvailabilityFlash 8.Usage document.union()ParametersNone.ReturnsA Boolean value: tru

171EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().unlockAllElements();See alsoelement.lockeddocument.viewMatrixAvailabilityFlash

172EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.xmlPanel()AvailabilityFlash MX 2004.Usage document.xmlPanel(fileURI)ParametersfileURI A st

173Chapter 12: drawingLayer objectAvailabilityFlash MX 2004.DescriptionThe drawingLayer object is accessible from JavaScript as a child of the flash o

174EXTENDING FLASH CS4 PROFESSIONALdrawingLayer objectParameterspersistentDraw A Boolean value (optional). If set to true, it indicates that the dra

175EXTENDING FLASH CS4 PROFESSIONALdrawingLayer objectUsage drawingLayer.cubicCurveTo(x1Ctrl, y1Ctrl, x2Ctl, y2Ctl, xEnd, yEnd)Parametersx1Ctl A floa

176EXTENDING FLASH CS4 PROFESSIONALdrawingLayer objectExampleThe following example draws a quadratic curve using the specified control points: fl.draw

177EXTENDING FLASH CS4 PROFESSIONALdrawingLayer objectExampleThe following example exits drawing mode: fl.drawingLayer.endDraw(); drawingLayer.endFram

Copyright© 2008 Adobe Systems Incorporated. All rights reserved.Extending Flash® for Windows® and Mac OSIf this guide is distributed with software tha

xxChapter 47: Timeline objecttimeline.addMotionGuide() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

178EXTENDING FLASH CS4 PROFESSIONALdrawingLayer objectExampleThe following example draws a line from the current drawing position to the point (20,30)

179EXTENDING FLASH CS4 PROFESSIONALdrawingLayer objectExampleThe following example returns a new Path object: fl.drawingLayer.newPath(); drawingLayer.

180EXTENDING FLASH CS4 PROFESSIONALdrawingLayer objectParametersfill A Fill object.DescriptionMethod; applies the specified fill to the drawing layer

181Chapter 13: Edge objectAvailabilityFlash MX 2004.DescriptionThe Edge object represents an edge of a shape on the Stage.Method summaryThe following

182EXTENDING FLASH CS4 PROFESSIONALEdge objectvar theShape = fl.getDocumentDOM().selection[0]; var edgesArray = theShape.edges; for(var i=0;i<edg

183EXTENDING FLASH CS4 PROFESSIONALEdge objectDescriptionMethod; returns a HalfEdge object. ExampleThe following example stores the half edges of the

184EXTENDING FLASH CS4 PROFESSIONALEdge objectedge.setControl()AvailabilityFlash MX 2004.Usage edge.setControl(index, x, y)Parametersindex An intege

185EXTENDING FLASH CS4 PROFESSIONALEdge objectReturnsNothing. DescriptionMethod; splits the edge into two pieces. You must call shape.beginEdit() befo

186Chapter 14: Element objectAvailabilityFlash MX 2004.DescriptionEverything that appears on the Stage is of the type Element. The following code exam

187EXTENDING FLASH CS4 PROFESSIONALElement objectelement.depthAvailabilityFlash MX 2004.Usage element.depthDescriptionRead-only property; an integer t

xxitoolObj.setIcon() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

188EXTENDING FLASH CS4 PROFESSIONALElement objectDescriptionRead-only property; a string that represents the type of the specified element. The value

189EXTENDING FLASH CS4 PROFESSIONALElement object // At least one symbol or bitmap is selected in the first layer, first frame. var elt = fl.getDocu

190EXTENDING FLASH CS4 PROFESSIONALElement objectUsage element.hasPersistentData(name)Parametersname A string that specifies the name of the data ite

191EXTENDING FLASH CS4 PROFESSIONALElement objectExampleThe following example stores the Layer object that contains the element in the theLayer variab

192EXTENDING FLASH CS4 PROFESSIONALElement objectelement.matrixAvailabilityFlash MX 2004.Usage element.matrixDescriptionProperty; a Matrix object. A m

193EXTENDING FLASH CS4 PROFESSIONALElement objectParametersname A string that specifies the name of the data to remove. ReturnsNothing. DescriptionMe

194EXTENDING FLASH CS4 PROFESSIONALElement objectExampleThe following example sets the x scale value of the current selection to 2 (doubles its value)

195EXTENDING FLASH CS4 PROFESSIONALElement objectelement.setPersistentData()AvailabilityFlash MX 2004.Usage element.setPersistentData(name, type, valu

196EXTENDING FLASH CS4 PROFESSIONALElement object• Drawing objects, primitive objects, and groups: transformationPoint is set relative to the center o

197EXTENDING FLASH CS4 PROFESSIONALElement objectelement.skewYAvailabilityFlash CS3 Professional.Usage element.skewYDescriptionProperty; a float value

xxiixmlui.setEnabled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

198EXTENDING FLASH CS4 PROFESSIONALElement objectelement.transformXAvailabilityFlash CS3 Professional.Usage element.transformXDescriptionProperty; a f

199EXTENDING FLASH CS4 PROFESSIONALElement objectDo not use this property to resize a text field. Instead, select the text field and use document.setT

200Chapter 15: Fill objectAvailabilityFlash MX 2004.DescriptionThis object contains all the properties of the Fill color setting of the Tools panel or

201EXTENDING FLASH CS4 PROFESSIONALFill objectvar fill = fl.getDocumentDOM().getCustomFill(); if (fill.style == "bitmap") fl.trace("F

202EXTENDING FLASH CS4 PROFESSIONALFill objectExampleThe following example sets the fill color of the current selection: var fill = fl.getDocumentDOM(

203EXTENDING FLASH CS4 PROFESSIONALFill objectExampleThe following example sets the focal point of a radial gradient for the current selection to 100

204EXTENDING FLASH CS4 PROFESSIONALFill objectExampleThe following example uses the fill.matrix property to specify a gradient fill for the current se

205EXTENDING FLASH CS4 PROFESSIONALFill objectDescriptionProperty; an array of integers, each in the range of zero to 255, indicating the position of

206Chapter 16: Filter objectAvailabilityFlash 8.DescriptionThis object contains all the properties for all filters. The filter.name property specifies

207EXTENDING FLASH CS4 PROFESSIONALFilter objectfilter.angleAvailabilityFlash 8.Usage filter.angleDescriptionProperty; a float value that specifies th

1Chapter 1: IntroductionAs a user of Adobe® Flash® CS4 Professional, you may be familiar with Adobe® ActionScript®, which lets you create scripts tha

208EXTENDING FLASH CS4 PROFESSIONALFilter object var myFilters = fl.getDocumentDOM().getFilters(); for(i=0; i < myFilters.length; i++){ if(myF

209EXTENDING FLASH CS4 PROFESSIONALFilter objectExampleThe following example sets the brightness to 30.5 for the Adjust Color filters on the selected

210EXTENDING FLASH CS4 PROFESSIONALFilter objectUsage filter.contrastDescriptionProperty; a float value that specifies the contrast value of the filte

211EXTENDING FLASH CS4 PROFESSIONALFilter objectfilter.enabledAvailabilityFlash CS3 Professional.Usage filter.enabledDescriptionProperty; a Boolean va

212EXTENDING FLASH CS4 PROFESSIONALFilter objectfilter.highlightColorAvailabilityFlash 8.Usage filter.highlightColorDescriptionProperty; the color of

213EXTENDING FLASH CS4 PROFESSIONALFilter object var myFilters = fl.getDocumentDOM().getFilters(); for(i=0; i < myFilters.length; i++){ if(myF

214EXTENDING FLASH CS4 PROFESSIONALFilter objectExampleThe following example sets the knockout property to true for the Glow filters on the selected o

215EXTENDING FLASH CS4 PROFESSIONALFilter objectUsage filter.qualityDescriptionProperty; a string that specifies the blur quality. Acceptable values a

216EXTENDING FLASH CS4 PROFESSIONALFilter objectfilter.shadowColorAvailabilityFlash 8.Usage filter.shadowColorDescriptionProperty; the color of the sh

217EXTENDING FLASH CS4 PROFESSIONALFilter object var myFilters = fl.getDocumentDOM().getFilters(); for(i=0; i < myFilters.length; i++){ if(myF

2EXTENDING FLASH CS4 PROFESSIONALIntroductionYou can also create a JSFL file by selecting commands in the History panel. Then click the Save button in

218Chapter 17: flash object (fl)AvailabilityFlash MX 2004.DescriptionThe flash object represents the Flash application. You can use flash or fl to ref

219EXTENDING FLASH CS4 PROFESSIONALflash object (fl)Property summary The following properties can be used with the flash object.fl.quit() Quits Flash,

220EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.actionsPanelAvailabilityFlash CS3 Professional.fl.createNewDocList Read-only; an array of strin

221EXTENDING FLASH CS4 PROFESSIONALflash object (fl)Usage fl.actionsPanelDescriptionRead-only property; an actionsPanel object, which represents the c

222EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.as3PackagePathsAvailabilityFlash CS3 Professional.Usage fl.as3PackagePathsDescriptionProperty;

223EXTENDING FLASH CS4 PROFESSIONALflash object (fl)DescriptionMethod; opens a File Open or File Save system dialog box and lets the user specify a fi

224EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.clipCopyString()AvailabilityFlash CS3 Professional.Usage fl.clipCopyString(string)Parametersstr

225EXTENDING FLASH CS4 PROFESSIONALflash object (fl) fl.closeAll();See alsofl.closeAllPlayerDocuments(), fl.closeDocument()fl.closeAllPlayerDocuments(

226EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ReturnsNothing.DescriptionMethod; closes the specified document.ExampleThe following example illus

227EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.configDirectoryAvailabilityFlash MX 2004.Usage fl.configDirectoryDescriptionRead-only property;

3EXTENDING FLASH CS4 PROFESSIONALIntroductionThere are two locations where you can store command and tool files so they can be accessed in the authori

228EXTENDING FLASH CS4 PROFESSIONALflash object (fl)DescriptionA Boolean value that specifies whether Contact Sensitive selection mode is enabled (tru

229EXTENDING FLASH CS4 PROFESSIONALflash object (fl)Usage fl.createNewDocListDescriptionRead-only property; an array of strings that represent the var

230EXTENDING FLASH CS4 PROFESSIONALflash object (fl) fl.trace("Number of template types: " + fl.createNewTemplateList.length); for (i = 0; i

231EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ExampleThe following example downloads the file named myFile.fla from the Version Cue server: fl.d

232EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.fileExists()AvailabilityFlash MX 2004.Usage fl.fileExists(fileURI)ParametersfileURI A string,

233EXTENDING FLASH CS4 PROFESSIONALflash object (fl) var originalDocID = fl.getDocumentDOM().id; // other code here, maybe working in different file

234EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ParametersinstanceName A string that specifies the instance name of an item in the specified docu

235EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ReturnsAn array of generic objects. Use the .obj property of each item in the array to get the ele

236EXTENDING FLASH CS4 PROFESSIONALflash object (fl) var doc = fl.getDocumentDOM(); var typeToSearchFor = "text"; var resultsArray = fl.

237EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ParametersmemType An integer that specifies the memory utilization area to be queried. For a list

4EXTENDING FLASH CS4 PROFESSIONALIntroductionTo add a tool implemented in a JSFL file to the Tools panel:1 Copy the JSFL file for the tool and any oth

238EXTENDING FLASH CS4 PROFESSIONALflash object (fl)DescriptionMethod; retrieves the DOM (Document object) of the currently active document (FLA file)

239EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ExampleThe following example adds the /SWC folder to the global ActionScript 3.0 Library path:fl.t

240EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ExampleThe following example shows the transformation matrix of the selected object and its invers

241EXTENDING FLASH CS4 PROFESSIONALflash object (fl) fl.trace("Number of recently opened files: " + fl.mruRecentFileListType.length); for

242EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ExampleThe following example opens a file named Document.fla that is stored in the root directory

243EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.packagePathsAvailabilityFlash CS3 Professional.Usage fl.packagePathsDescriptionProperty; a stri

244EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ParametersbPromptIfNeeded A Boolean value that is true (default) if you want the user to be promp

245EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.reloadTools()AvailabilityFlash MX 2004.Usage fl.reloadTools()ParametersNone. ReturnsNothing. De

246EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ExampleThe following example removes the event listener associated with the documentClosed event:

247EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ExampleThe following example resets the ActionScript 2.0 Classpath setting to its default value. f

5EXTENDING FLASH CS4 PROFESSIONALIntroductionpresetItem objectswfPanel objectNew methods and propertiesThe following methods and properties for existi

248EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ReturnsA Boolean value of true if the document is successfully reverted; false otherwise.Descripti

249EXTENDING FLASH CS4 PROFESSIONALflash object (fl) function testFunct(num, minNum) { fl.trace("in testFunct: 1st arg: " + num + "

250EXTENDING FLASH CS4 PROFESSIONALflash object (fl) fl.saveAll();See alsodocument.save(), document.saveAndCompact(), fl.saveDocument(), fl.saveDocume

251EXTENDING FLASH CS4 PROFESSIONALflash object (fl)ReturnsA Boolean value: true if the save operation completes successfully; false otherwise.If the

252EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.scriptURIAvailabilityFlash CS3 Professional.Usage fl.scriptURIDescriptionRead-only property; a

253EXTENDING FLASH CS4 PROFESSIONALflash object (fl) var nameToSearchFor = "second text field"; var doc = fl.getDocumentDOM(); // Sta

254EXTENDING FLASH CS4 PROFESSIONALflash object (fl)• Mac OS X: Macintosh HD/Users/username/Library/Application Support/Adobe/Flash CS3/language/Conf

255EXTENDING FLASH CS4 PROFESSIONALflash object (fl)Usage fl.showIdleMessage(show)Parametersshow A Boolean value specifying whether to enable or disa

256EXTENDING FLASH CS4 PROFESSIONALflash object (fl)fl.swfPanelsAvailabilityFlash CS4 Professional.Usage fl.swfPanelsDescriptionRead-only property; an

257EXTENDING FLASH CS4 PROFESSIONALflash object (fl)See alsofl.downloadLatestVersion(), fl.revertDocumentToLastVersion(), fl.saveAVersionOfDocument()f

6EXTENDING FLASH CS4 PROFESSIONALIntroduction• fl.flexSDKPath• fl.isFontInstalled()• fl.libraryPath• fl.presetPanel• fl.sourcePath• fl.swfPanels• FLfi

258EXTENDING FLASH CS4 PROFESSIONALflash object (fl) fl.outputPanel.clear(); fl.trace("Hello World!!!"); var myPet = "cat";

259Chapter 18: FLfile objectAvailabilityFlash MX 2004 7.2. DescriptionThe FLfile object lets you write Flash extensions that can access, modify, and r

260EXTENDING FLASH CS4 PROFESSIONALFLfile objectFLfile.copy()AvailabilityFlash MX 2004 7.2.Usage FLfile.copy(fileURI, copyURI)ParametersfileURI A str

261EXTENDING FLASH CS4 PROFESSIONALFLfile objectExampleThe following example makes a backup copy of a configuration file named config.ini and places i

262EXTENDING FLASH CS4 PROFESSIONALFLfile objectSee alsoFLfile.remove(), FLfile.write()FLfile.exists()AvailabilityFlash MX 2004 7.2.Usage FLfile.exist

263EXTENDING FLASH CS4 PROFESSIONALFLfile objectFLfile.getAttributes()AvailabilityFlash MX 2004 7.2.Usage FLfile.getAttributes(fileOrFolderURI)Paramet

264EXTENDING FLASH CS4 PROFESSIONALFLfile objectFLfile.getCreationDate()AvailabilityFlash MX 2004 7.2.Usage FLfile.getCreationDate(fileOrFolderURI)Par

265EXTENDING FLASH CS4 PROFESSIONALFLfile objectParametersfileOrFolderURI A string, expressed as a file:/// URI, specifying the file or folder whose

266EXTENDING FLASH CS4 PROFESSIONALFLfile object // Make sure the specified files exist. file1 = "file:///C|/MyApplication/MyApp.fla"; f

267EXTENDING FLASH CS4 PROFESSIONALFLfile objectFLfile.getSize()AvailabilityFlash MX 2004 7.2.Usage FLfile.getSize(fileURI)ParametersfileURI A string

7EXTENDING FLASH CS4 PROFESSIONALIntroductionOther changesThe following property has a new supported value in Flash CS4:• fill.styleThe following obje

268EXTENDING FLASH CS4 PROFESSIONALFLfile objectDescriptionMethod; returns an array of strings representing the contents of the folder.ExamplesThe fol

269EXTENDING FLASH CS4 PROFESSIONALFLfile objectExampleThe following example converts a filename from a platform-specific format to a file:/// URI, wh

270EXTENDING FLASH CS4 PROFESSIONALFLfile objectUsage FLfile.remove(fileOrFolderURI)ParametersfileOrFolderURI A string, expressed as a file:/// URI,

271EXTENDING FLASH CS4 PROFESSIONALFLfile objectParametersfileURI A string, expressed as a file:/// URI, specifying the file whose attributes you wan

272EXTENDING FLASH CS4 PROFESSIONALFLfile objectFLfile.uriToPlatformPath()AvailabilityFlash CS4 Professional.Usage FLfile.uriToPlatformPath(fileURI)Pa

273EXTENDING FLASH CS4 PROFESSIONALFLfile objectDescriptionMethod; writes the specified string to the specified file (as UTF-8). If the specified file

274Chapter 19: folderItem objectInheritance Item object > folderItem objectAvailabilityFlash MX 2004.DescriptionThe folderItem object is a subcl

275Chapter 20: fontItem objectInheritance Item object > fontItem objectAvailabilityFlash MX 2004.DescriptionThe fontItem object is a subclass of

276EXTENDING FLASH CS4 PROFESSIONALfontItem objectfontItem.boldAvailabilityFlash CS4 Professional.Usage fontItem.boldDescriptionProperty; a Boolean va

277EXTENDING FLASH CS4 PROFESSIONALfontItem objectfontItem.italicAvailabilityFlash CS4 Professional.Usage fontItem.italicDescriptionProperty; a Boolea

iiiContentsChapter 1: IntroductionWorking with the JavaScript API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8EXTENDING FLASH CS4 PROFESSIONALIntroductionContour object A Contour object represents a closed path of half edges on the boundary of a shape.Documen

278Chapter 21: Frame objectAvailabilityFlash MX 2004.DescriptionThe Frame object represents frames in the layer. Method summary The following methods

279EXTENDING FLASH CS4 PROFESSIONALFrame objectframe.actionScriptAvailabilityFlash MX 2004.Usage frame.actionScriptDescriptionProperty; a string that

280EXTENDING FLASH CS4 PROFESSIONALFrame objectDescriptionRead-only property; an integer that represents the number of frames in a frame sequence.Exam

281EXTENDING FLASH CS4 PROFESSIONALFrame objectDescriptionMethod; returns an array of objects that represent the control points for the cubic Bézier c

282EXTENDING FLASH CS4 PROFESSIONALFrame objectExampleThe following example sets the name of the first frame in the top layer to "First Frame&quo

283EXTENDING FLASH CS4 PROFESSIONALFrame objectUsage frame.motionTweenRotateTimesDescriptionProperty; an integer that specifies the number of times th

284EXTENDING FLASH CS4 PROFESSIONALFrame objectframe.motionTweenSyncAvailabilityFlash MX 2004.Usage frame.motionTweenSyncDescriptionProperty; a Boolea

285EXTENDING FLASH CS4 PROFESSIONALFrame objecteaseCurve An array of objects that defines the ease curve. Each array element must be a JavaScript obj

286EXTENDING FLASH CS4 PROFESSIONALFrame objectDescriptionProperty; a string that specifies effects for a sound that is attached directly to a frame (

287EXTENDING FLASH CS4 PROFESSIONALFrame objectframe.soundLoopModeAvailabilityFlash MX 2004.Usage frame.soundLoopModeDescriptionProperty; a string tha

9EXTENDING FLASH CS4 PROFESSIONALIntroductionThe Flash Document Object ModelThe Flash Document Object Model (DOM) for the Flash JavaScript API consist

288EXTENDING FLASH CS4 PROFESSIONALFrame objectDescriptionProperty; a string that specifies the sync behavior of a sound that is attached directly to

289EXTENDING FLASH CS4 PROFESSIONALFrame objectExampleThe following example specifies that the motion of the tweened object should begin fairly rapidl

290EXTENDING FLASH CS4 PROFESSIONALFrame objectExampleThe following example specifies that a single custom ease curve should be used for all propertie

291Chapter 22: HalfEdge objectAvailabilityFlash MX 2004.DescriptionThe HalfEdge object is the directed side of the edge of a Shape object. An edge has

292EXTENDING FLASH CS4 PROFESSIONALHalfEdge objectReturnsAn Edge object. DescriptionMethod; gets the Edge object for the HalfEdge object. See Edge obj

293EXTENDING FLASH CS4 PROFESSIONALHalfEdge objectParametersNone. ReturnsA HalfEdge object. DescriptionMethod; gets the HalfEdge object on the other s

294EXTENDING FLASH CS4 PROFESSIONALHalfEdge objectUsage halfEdge.getVertex()ParametersNone. ReturnsA Vertex objectDescriptionMethod; gets the Vertex o

295EXTENDING FLASH CS4 PROFESSIONALHalfEdge objectDescriptionRead-only property; an integer with a value of 0 or 1 that specifies the index for this H

296Chapter 23: Instance objectInheritance Element object > Instance objectAvailabilityFlash MX 2004.DescriptionInstance is a subclass of the Ele

297EXTENDING FLASH CS4 PROFESSIONALInstance objectinstance.libraryItemAvailabilityFlash MX 2004.Usage instance.libraryItemDescriptionProperty; a libra

10EXTENDING FLASH CS4 PROFESSIONALIntroduction flash.closeAll(); fl.closeAll();The flash object contains the following child objects: The Document o

298Chapter 24: Item objectAvailabilityFlash MX 2004.DescriptionThe Item object is an abstract base class. Anything in the library derives from Item. S

299EXTENDING FLASH CS4 PROFESSIONALItem objectitem.addData()AvailabilityFlash MX 2004.Usage item.addData(name, type, data)Parametersname A string tha

300EXTENDING FLASH CS4 PROFESSIONALItem objectExampleThe following example gets the value of the data named myData from the first item in the library

301EXTENDING FLASH CS4 PROFESSIONALItem objectitem.linkageBaseClassAvailabilityFlash CS3 Professional.Usage item.linkageBaseClassDescriptionProperty;

302EXTENDING FLASH CS4 PROFESSIONALItem objectFor this property to be defined, the item.linkageExportForAS and/or item.linkageExportForRS properties m

303EXTENDING FLASH CS4 PROFESSIONALItem objectitem.linkageExportInFirstFrameAvailabilityFlash MX 2004.Usage item.linkageExportInFirstFrameDescriptionP

304EXTENDING FLASH CS4 PROFESSIONALItem objectitem.linkageImportForRSAvailabilityFlash MX 2004.Usage item.linkageImportForRSDescriptionProperty; a Boo

305EXTENDING FLASH CS4 PROFESSIONALItem objectUsage item.nameDescriptionMethod; a string that specifies the name of the library item, which includes t

306Chapter 25: Layer objectAvailabilityFlash MX 2004.DescriptionThe Layer object represents a layer in the timeline. The timeline.layers property cont

307EXTENDING FLASH CS4 PROFESSIONALLayer objectExampleThe following example stores the value of the first layer in the colorValue variable: var color

11EXTENDING FLASH CS4 PROFESSIONALIntroductionAll the objects in the DOM that aren’t listed in the previous table (see “The Flash Document Object Mode

308EXTENDING FLASH CS4 PROFESSIONALLayer object var frameArray = fl.getDocumentDOM().getTimeline().layers[0].frames; var n = frameArray.length; fo

309EXTENDING FLASH CS4 PROFESSIONALLayer objectlayer.lockedAvailabilityFlash MX 2004.Usage layer.lockedDescriptionProperty; a Boolean value that speci

310EXTENDING FLASH CS4 PROFESSIONALLayer objectDescriptionProperty; a Boolean value that specifies the status of outlines for all objects in the layer

311EXTENDING FLASH CS4 PROFESSIONALLayer objectExampleThe following example makes all objects in the first layer invisible: fl.getDocumentDOM().getTi

312Chapter 26: library objectAvailabilityFlash MX 2004.DescriptionThe library object represents the Library panel. It is a property of the Document ob

313EXTENDING FLASH CS4 PROFESSIONALlibrary objectProperty summary for the library objectThe following property is available for the library object:lib

314EXTENDING FLASH CS4 PROFESSIONALlibrary objectwith this method). Specifying a folder path is the same as using library.newFolder()library.newFolder

315EXTENDING FLASH CS4 PROFESSIONALlibrary objectlibrary.duplicateItem()AvailabilityFlash MX 2004.Usage library.duplicateItem( [ namePath ] )Parameter

316EXTENDING FLASH CS4 PROFESSIONALlibrary objectExampleThe following example opens the item circle in the test folder of the library for editing: fl

317EXTENDING FLASH CS4 PROFESSIONALlibrary objectReturnsAn integer value representing the item’s zero-based index value. DescriptionMethod; returns th

12EXTENDING FLASH CS4 PROFESSIONALIntroductionIn some cases, an object is available by specifying a property of its parent object. For example, the do

318EXTENDING FLASH CS4 PROFESSIONALlibrary objectParametersnamePath A string that specifies the name of the item. If the item is in a folder, specify

319EXTENDING FLASH CS4 PROFESSIONALlibrary objectParameterslinkageName A string that provides the name of the SWF linkage of the root movie clip. swf

320EXTENDING FLASH CS4 PROFESSIONALlibrary objectlibrary.itemsAvailabilityFlash MX 2004.Usage library.itemsDescriptionProperty; an array of item objec

321EXTENDING FLASH CS4 PROFESSIONALlibrary objectlibrary.newFolder()AvailabilityFlash MX 2004.Usage library.newFolder([folderPath])ParametersfolderPat

322EXTENDING FLASH CS4 PROFESSIONALlibrary objectlibrary.selectAll()AvailabilityFlash MX 2004.Usage library.selectAll([bSelectAll])ParametersbSelectAl

323EXTENDING FLASH CS4 PROFESSIONALlibrary objectReturnsA Boolean value: true if the specified item exists; false otherwise.DescriptionMethod; selects

324EXTENDING FLASH CS4 PROFESSIONALlibrary objectUsage library.setItemProperty(property, value)Parametersproperty A string that is the name of the pr

325Chapter 27: Math objectAvailabilityFlash MX 2004.DescriptionThe Math object is available as a read-only property of the flash object; see fl.Math.

326EXTENDING FLASH CS4 PROFESSIONALMath objectMath.invertMatrix()AvailabilityFlash MX 2004.Usage Math.invertMatrix(mat)Parametersmat Indicates the Ma

327EXTENDING FLASH CS4 PROFESSIONALMath objectExampleThe following example stores the value for the distance between pt1 and pt2 in the dist variable:

13EXTENDING FLASH CS4 PROFESSIONALIntroduction 09 Vertex object 09 Edge object 07 Vertex object(shape.ver

328Chapter 28: Matrix objectAvailabilityFlash MX 2004.DescriptionThe Matrix object represents a transformation matrix. Property summary The following

329EXTENDING FLASH CS4 PROFESSIONALMatrix object var mat = fl.getDocumentDOM().selection[0].matrix; mat.a = 0.5; mat.b = 0.8; mat.c = 0.8*(-1);

330EXTENDING FLASH CS4 PROFESSIONALMatrix objectExampleSee the matrix.b example.matrix.dAvailabilityFlash MX 2004.Usage matrix.dDescriptionProperty; a

331EXTENDING FLASH CS4 PROFESSIONALMatrix objectUsage matrix.tyDescriptionProperty; a floating-point value that specifies the y-axis location of a sym

332Chapter 29: outputPanel objectAvailabilityFlash MX 2004.DescriptionThis object represents the Output panel, which displays troubleshooting informat

333EXTENDING FLASH CS4 PROFESSIONALoutputPanel objectoutputPanel.save()AvailabilityFlash MX 2004; bUseSystemEncoding parameter added in Flash 8. Usage

334EXTENDING FLASH CS4 PROFESSIONALoutputPanel objectReturns Nothing. DescriptionMethod; sends a text string to the Output panel, terminated by a new

335Chapter 30: Oval objectInheritance Element object > Shape object > Oval objectAvailabilityFlash CS3 Professional.DescriptionThe Oval objec

336EXTENDING FLASH CS4 PROFESSIONALOval objectOvalObject.endAngleAvailabilityFlash CS3 Professional.Usage OvalObject.endAngleDescriptionRead-only prop

337EXTENDING FLASH CS4 PROFESSIONALOval objectOvalObject.startAngleAvailabilityFlash CS3 Professional.Usage OvalObject.startAngleDescriptionRead-only

14EXTENDING FLASH CS4 PROFESSIONALIntroductionSample PolyStar toolA sample JavaScript API script named PolyStar.jsfl is located in the ExtendingFlash/

338Chapter 31: Parameter objectAvailabilityFlash MX 2004.DescriptionThe Parameter object type is accessed from the screen.parameters array (which corr

339EXTENDING FLASH CS4 PROFESSIONALParameter objectparameter.insertItem()AvailabilityFlash MX 2004.Usage parameter.insertItem(index, name, value, type

340EXTENDING FLASH CS4 PROFESSIONALParameter objectExampleThe following example sets the first parameter for a Slide, which is the autoKeyNav paramete

341EXTENDING FLASH CS4 PROFESSIONALParameter objectExampleThe following example removes the element at index 1 from the labelPlacement parameter of a

342EXTENDING FLASH CS4 PROFESSIONALParameter objectparameter.valueTypeAvailabilityFlash MX 2004.Usage parameter.valueTypeDescriptionRead-only property

343Chapter 32: Path objectAvailabilityFlash MX 2004.DescriptionThe Path object defines a sequence of line segments (straight, curved, or both), which

344EXTENDING FLASH CS4 PROFESSIONALPath objectyAnchor A floating-point number that specifies the y position of the first control point. x2 A floatin

345EXTENDING FLASH CS4 PROFESSIONALPath objectExampleThe following example creates a new path, stores it in the myPath variable, and assigns the curve

346EXTENDING FLASH CS4 PROFESSIONALPath objectDescriptionMethod; removes all points from the path. ExampleThe following example removes all points fro

347EXTENDING FLASH CS4 PROFESSIONALPath objectbSupressStroke A Boolean value that, if set to true, suppresses the stroke that would be applied to the

15Chapter 2: Top-Level Functions and MethodsAbout this sectionThis section describes the top-level functions and methods that are available when you u

348EXTENDING FLASH CS4 PROFESSIONALPath object var myPath = fl.drawingLayer.newPath(); myPath.addPoint(0, 0); myPath.addPoint(0, 30); myPath.add

349Chapter 33: presetItem objectAvailabilityFlash CS4 Professional.DescriptionThe presetItem object represents an item (preset or folder) in the Motio

350EXTENDING FLASH CS4 PROFESSIONALpresetItem objectfl.outputPanel.clear(); var presetItemArray=fl.presetPanel.items; for (i=0;i<presetItemArray.

351EXTENDING FLASH CS4 PROFESSIONALpresetItem objectpresetItem.nameAvailabilityFlash CS4 Professional.Usage presetItem.nameDescriptionRead-only proper

352EXTENDING FLASH CS4 PROFESSIONALpresetItem objectUsage presetItem.pathDescriptionRead-only property: a string that represents the path to the item

353Chapter 34: presetPanel objectAvailabilityFlash CS4 Professional.DescriptionThe presetPanel object represents the Motion Presets panel (Window >

354EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectpresetPanel.addNewItem()AvailabilityFlash CS4 Professional. Usagefl. presetPanel.addNewItem( [na

355EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectDescriptionMethod; applies the specified or currently selected preset to the currently selected i

356EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectpresetPanel.deleteItem()AvailabilityFlash CS4 Professional.Usage presetPanel.deleteItem( [namePat

357EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectDescriptionMethod; expands or collapses the currently selected folder or folders in the Motion Pr

16EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and MethodsDescriptionFunction; called when the extensible tool becomes active (that is, when th

358EXTENDING FLASH CS4 PROFESSIONALpresetPanel object//Exports fly-in-left to C:\My Presets\fly-in-left.xml fl.presetPanel.exportItem("file:///C

359EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectpresetPanel.getSelectedItems()AvailabilityFlash CS4 Professional.UsagepresetPanel.getSelectedItem

360EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectDescriptionMethod; adds a preset to the Motion Presets panel from a specified XML file. The path

361EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectUsagepresetPanel.moveToFolder(folderPath [, namePath] )ParametersfolderPath A string that specif

362EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectNote: You can’t add folders to the Default Presets folder.ExampleThe following example adds a fol

363EXTENDING FLASH CS4 PROFESSIONALpresetPanel objectUsagepresetPanel.selectItem(namePath [, bReplaceCurrentSelection [, bSelect] ])ParametersnamePath

364Chapter 35: Rectangle objectInheritance Element object > Shape object > Rectangle objectAvailabilityFlash CS3 Professional.DescriptionThe

365EXTENDING FLASH CS4 PROFESSIONALRectangle objectRectangleObject.bottomRightRadius AvailabilityFlash CS3 Professional.Usage RectangleObject.bottomRi

366EXTENDING FLASH CS4 PROFESSIONALRectangle objectDescriptionRead-only property; a float value that sets the radius of all corners of the rectangle (

367Chapter 36: Screen objectAvailabilityFlash MX 2004.DescriptionThe Screen object represents a single screen in a slide or form document. This object

17EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and MethodsUsage function configureTool() { // statements }ParametersNone. ReturnsNothing.

368EXTENDING FLASH CS4 PROFESSIONALScreen objectUsage screen.accNameDescriptionProperty; a string that is equivalent to the Name field in the Accessib

369EXTENDING FLASH CS4 PROFESSIONALScreen objectDescriptionProperty; a string that is equivalent to the Description field in the Accessibility panel.

370EXTENDING FLASH CS4 PROFESSIONALScreen objectExampleThe following example checks to see if the first screen in the outline is hidden and changes th

371EXTENDING FLASH CS4 PROFESSIONALScreen objectExampleThe following example checks to see if the current document allows screens (because it is a sli

372EXTENDING FLASH CS4 PROFESSIONALScreen objectExampleThe following example stores the parameters for the second screen in the outline to the parms v

373EXTENDING FLASH CS4 PROFESSIONALScreen objectExampleThe following example checks to see if the current document is a slide or form, and if it is, r

374EXTENDING FLASH CS4 PROFESSIONALScreen object var theTabIndex = fl.getDocumentDOM().screenOutline.screens[1].tabIndex;The following example sets th

375Chapter 37: ScreenOutline objectAvailabilityFlash MX 2004.DescriptionThe ScreenOutline object represents the group of screens in a slide or form do

376EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectscreenOutline.copyScreenFromFile()AvailabilityFlash MX 2004.Usage screenOutline.copyScreenFromF

377EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectDescriptionProperty; a Screen object, the currently selected screen (see Screen object).Example

ivbitmapItem.originalCompressionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and MethodsDescriptionMethod; displays a string in a modal Alert dialog box, along with OK and C

378EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectReturnsA Boolean value: true if the screen is successfully duplicated; false otherwise.Descript

379EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectUsage screenOutline.insertNestedScreen([name [, referenceScreen [, screenTypeName]]])Parameters

380EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectDescriptionMethod; inserts a new blank screen of a specified type into the document at a specif

381EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectParametersnewScreenName A string that specifies the new name of the screen.oldScreenName A st

382EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectDescriptionRead-only property; the array of top-level Screen objects contained in the document

383EXTENDING FLASH CS4 PROFESSIONALScreenOutline objectParametersproperty A string that specifies the property to set.value The new value for the pr

384Chapter 38: Shape objectInheritance Element object > Shape objectAvailabilityFlash MX 2004.DescriptionThe Shape object is a subclass of the E

385EXTENDING FLASH CS4 PROFESSIONALShape objectshape.beginEdit()AvailabilityFlash MX 2004.Usage shape.beginEdit()ParametersNone. ReturnsNothing. Descr

386EXTENDING FLASH CS4 PROFESSIONALShape objectshape.deleteEdge()AvailabilityFlash MX 2004.Usage shape.deleteEdge(index)Parametersindex A zero-based

387EXTENDING FLASH CS4 PROFESSIONALShape objectParametersNone. Returns Nothing. DescriptionMethod; defines the end of an edit session for the shape. A

19EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and MethodsUsage function keyDown() { // statements }ParametersNone. ReturnsNothing. Descri

388EXTENDING FLASH CS4 PROFESSIONALShape objectshape.isDrawingObjectAvailabilityFlash 8.Usage shape.isDrawingObjectDescriptionRead-only property; if t

389EXTENDING FLASH CS4 PROFESSIONALShape objectshape.isOvalObjectAvailabilityFlash CS3 Professional.Usage shape.isOvalObjectDescriptionRead-only prope

390EXTENDING FLASH CS4 PROFESSIONALShape objectUsage shape.membersDescriptionRead-only property; an array of objects in the currently selected group.

391EXTENDING FLASH CS4 PROFESSIONALShape objectDescriptionRead-only property; an array of Vertex objects (see Vertex object).ExampleThe following exam

392Chapter 39: SoundItem objectInheritance Item object > SoundItem objectAvailabilityFlash MX 2004.DescriptionThe SoundItem object is a subclass

393EXTENDING FLASH CS4 PROFESSIONALSoundItem objectsoundItem.bitRateAvailabilityFlash MX 2004.Usage soundItem.bitRateDescriptionProperty; a string tha

394EXTENDING FLASH CS4 PROFESSIONALSoundItem objectIf you want to specify a value for this property, set soundItem.useImportedMP3Quality to false.Exam

395EXTENDING FLASH CS4 PROFESSIONALSoundItem objectDescriptionProperty; a Boolean value available only for MP3 and Raw compression types. Setting this

396EXTENDING FLASH CS4 PROFESSIONALSoundItem objectUsage soundItem.fileLastModifiedDateDescriptionRead-only property: a string containing a hexadecima

397EXTENDING FLASH CS4 PROFESSIONALSoundItem objectUsage soundItem.qualityDescriptionProperty; a string that specifies the playback quality of a sound

20EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and Methods function keyUp() { fl.trace("Key is released"); }See alsokeyDown()mou

398EXTENDING FLASH CS4 PROFESSIONALSoundItem objectDescriptionRead-only property: a Boolean value of true if the file that was imported to the Library

399EXTENDING FLASH CS4 PROFESSIONALSoundItem objectDescriptionRead-only property: a string, expressed as a file:/// URI, that represents the path and

400Chapter 40: Stroke objectAvailabilityFlash MX 2004.DescriptionThe Stroke object contains all the settings for a stroke, including the custom settin

401EXTENDING FLASH CS4 PROFESSIONALStroke objectstroke.breakAtCornersAvailabilityFlash MX 2004. Deprecated in Flash CS3 in favor of stroke.joinType.Us

402EXTENDING FLASH CS4 PROFESSIONALStroke objectstroke.colorAvailabilityFlash MX 2004. In Flash 8 and later, this property is deprecated in favor of s

403EXTENDING FLASH CS4 PROFESSIONALStroke object var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "hatched"; myS

404EXTENDING FLASH CS4 PROFESSIONALStroke objectstroke.densityAvailabilityFlash MX 2004.Usage stroke.densityDescriptionProperty; a string that specifi

405EXTENDING FLASH CS4 PROFESSIONALStroke objectstroke.dotSpaceAvailabilityFlash MX 2004.Usage stroke.dotSpaceDescriptionProperty; an integer that spe

406EXTENDING FLASH CS4 PROFESSIONALStroke objectstroke.jiggleAvailabilityFlash MX 2004.Usage stroke.jiggleDescriptionProperty; a string that specifies

407EXTENDING FLASH CS4 PROFESSIONALStroke objectUsage stroke.lengthDescriptionProperty; a string that specifies the length of a hatch line. This prope

21EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and MethodsParameterspt A point that specifies the location of the mouse when the button is pre

408EXTENDING FLASH CS4 PROFESSIONALStroke objectUsage stroke.patternDescriptionProperty; a string that specifies the pattern of a ragged line. This pr

409EXTENDING FLASH CS4 PROFESSIONALStroke objectDescriptionProperty; a string that specifies the type of scale to be applied to the stroke. Acceptable

410EXTENDING FLASH CS4 PROFESSIONALStroke object var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "hatched"; myS

411EXTENDING FLASH CS4 PROFESSIONALStroke object• If value is "hatched", there are six additional properties: hatchThickness, space, jiggle,

412EXTENDING FLASH CS4 PROFESSIONALStroke object var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "stipple"; myS

413EXTENDING FLASH CS4 PROFESSIONALStroke object var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "ragged"; mySt

414Chapter 41: swfPanel objectAvailabilityFlash CS4 Professional.DescriptionThe swfPanel object represents a Window SWF panel. Window SWF panels are S

415EXTENDING FLASH CS4 PROFESSIONALswfPanel objectDescriptionMethod; works in conjunction with the ActionScript ExternalInterface.addCallback() and MM

416EXTENDING FLASH CS4 PROFESSIONALswfPanel objectfunction callMyPanel(panelName, arg) { if(fl.swfPanels.length > 0){ for(x = 0; x < fl.swfPa

417EXTENDING FLASH CS4 PROFESSIONALswfPanel objectSee alsoswfPanel.path, fl.swfPanelsswfPanel.pathAvailabilityFlash CS4 Professional.Usage swfPanel.pa

22EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and Methods function mouseMove() { fl.trace("moving"); } function mouseMove

418Chapter 42: SymbolInstance objectInheritance Element object > Instance object > SymbolInstance objectAvailabilityFlash MX 2004.Description

419EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectsymbolInstance.accNameAvailabilityFlash MX 2004.Usage symbolInstance.accNameDescriptionPropert

420EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectsymbolInstance.actionScriptAvailabilityFlash MX 2004.Usage symbolInstance.actionScriptDescript

421EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectUsage symbolInstance.buttonTrackingDescriptionProperty; a string that, for button symbols only

422EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectExampleThe following example subtracts 100 from the alpha setting of the selected symbol insta

423EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectDescriptionProperty; an integer that is part of the color transformation for the instance. Thi

424EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectUsage symbolInstance.colorModeDescriptionProperty; a string that specifies the color mode as i

425EXTENDING FLASH CS4 PROFESSIONALSymbolInstance object fl.getDocumentDOM().selection[0].colorRedPercent = 10; symbolInstance.descriptionAvailability

426EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectsymbolInstance.firstFrameAvailabilityFlash MX 2004.Usage symbolInstance.firstFrameDescriptionP

427EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectsymbolInstance.loopAvailabilityFlash MX 2004.Usage symbolInstance.loopDescriptionProperty; a s

23EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and MethodsParametersNone. ReturnsNothing. DescriptionFunction; called when the extensible tool

428EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectUsage symbolInstance.silentDescriptionProperty; a Boolean value that enables or disables the a

429EXTENDING FLASH CS4 PROFESSIONALSymbolInstance objectDescriptionProperty; an integer that is equivalent to the Tab index field in the Accessibility

430Chapter 43: SymbolItem objectInheritance Item object > SymbolItem objectAvailabilityFlash MX 2004.DescriptionThe SymbolItem object is a subcl

431EXTENDING FLASH CS4 PROFESSIONALSymbolItem objectReturns Nothing. DescriptionMethod; converts a symbol item in the library to a compiled movie clip

432EXTENDING FLASH CS4 PROFESSIONALSymbolItem objectParametersoutputURI A string, expressed as a file:/// URI, that specifies the SWF file to which t

433EXTENDING FLASH CS4 PROFESSIONALSymbolItem objectExampleThe following example specifies the locations of the 9-slice guides: fl.getDocumentDOM().li

434EXTENDING FLASH CS4 PROFESSIONALSymbolItem objectsymbolItem.sourceLibraryNameAvailabilityFlash MX 2004.Usage symbolItem.sourceLibraryNameDescriptio

435EXTENDING FLASH CS4 PROFESSIONALSymbolItem objectDescriptionRead-only property; a Timeline object. ExampleThe following example obtains and shows t

436Chapter 44: Text objectInheritance Element object > Text objectAvailabilityFlash MX 2004.DescriptionThe Text object represents a single text

437EXTENDING FLASH CS4 PROFESSIONALText objecttext.accNameAvailabilityFlash MX 2004.Usage text.accNameDescriptionProperty; a string that is equivalent

24EXTENDING FLASH CS4 PROFESSIONALTop-Level Functions and MethodssetCursor()AvailabilityFlash MX 2004.Usage function setCursor() { // statements

438EXTENDING FLASH CS4 PROFESSIONALText object var doc = fl.getDocumentDOM(); var theName = doc.selection[0].accName; The following example sets the

439EXTENDING FLASH CS4 PROFESSIONALText objecttext.autoExpandAvailabilityFlash MX 2004.Usage text.autoExpandDescriptionProperty; a Boolean value. For

440EXTENDING FLASH CS4 PROFESSIONALText objectExampleThe following example retrieves the description of the object: var doc = fl.getDocumentDOM(); v

441EXTENDING FLASH CS4 PROFESSIONALText objectThe following example resets the property: var doc = fl.getDocumentDOM(); doc.selection[0].embedRanges

442EXTENDING FLASH CS4 PROFESSIONALText objectParametersattrName A string that specifies the name of the TextAttrs object property to be returned. Fo

443EXTENDING FLASH CS4 PROFESSIONALText objectReturnsA string of the text in the specified range.DescriptionMethod; retrieves the specified range of t

444EXTENDING FLASH CS4 PROFESSIONALText objectThis property works only with dynamic or input text and generates a warning if used with static text. Th

445EXTENDING FLASH CS4 PROFESSIONALText objecttext.renderAsHTMLAvailabilityFlash MX 2004.Usage text.renderAsHTMLDescriptionProperty; a Boolean value.

446EXTENDING FLASH CS4 PROFESSIONALText objectInput text is always selectable. Flash generates a warning when this property is set to false and used w

447EXTENDING FLASH CS4 PROFESSIONALText object fl.getDocumentDOM().selection[0].selectionStart = 11; fl.getDocumentDOM().selection[0].selectionEnd =

25Chapter 3: actionsPanel objectAvailabilityFlash CS3 Professional.DescriptionThe actionsPanel object, which represents the currently displayed Action

448EXTENDING FLASH CS4 PROFESSIONALText objecttext.setTextString()AvailabilityFlash MX 2004.Usage text.setTextString(text [, startIndex [, endIndex]])

449EXTENDING FLASH CS4 PROFESSIONALText objectUsage text.shortcutDescriptionProperty; a string that is equivalent to the Shortcut field in the Accessi

450EXTENDING FLASH CS4 PROFESSIONALText objectDescriptionProperty; an integer that is equivalent to the Tab Index field in the Accessibility panel. Th

451EXTENDING FLASH CS4 PROFESSIONALText objecttext.useDeviceFontsAvailabilityFlash MX 2004.Usage text.useDeviceFontsDescriptionProperty; a Boolean val

452Chapter 45: TextAttrs objectAvailabilityFlash MX 2004.DescriptionThe TextAttrs object contains all the properties of text that can be applied to a

453EXTENDING FLASH CS4 PROFESSIONALTextAttrs objecttextAttrs.aliasTextAvailabilityFlash MX 2004.Usage textAttrs.aliasTextDescriptionProperty; a Boolea

454EXTENDING FLASH CS4 PROFESSIONALTextAttrs objectDescriptionProperty; a Boolean value that determines whether Flash uses (true) or ignores (false) p

455EXTENDING FLASH CS4 PROFESSIONALTextAttrs objecttextAttrs.characterSpacingAvailabilityFlash MX 2004. Deprecated in Flash 8 in favor of textAttrs.le

456EXTENDING FLASH CS4 PROFESSIONALTextAttrs objectDescriptionProperty; the color of the fill, in one of the following formats:• A string in the forma

457EXTENDING FLASH CS4 PROFESSIONALTextAttrs objecttextAttrs.leftMarginAvailabilityFlash MX 2004.Usage textAttrs.leftMarginDescriptionProperty; an int

26EXTENDING FLASH CS4 PROFESSIONALactionsPanel objectExampleThe following example displays the class assigned to the variable myVar, if the cursor is

458EXTENDING FLASH CS4 PROFESSIONALTextAttrs objectDescriptionProperty; an integer that specifies the line spacing (leading) of the paragraph. Accepta

459EXTENDING FLASH CS4 PROFESSIONALTextAttrs objecttextAttrs.sizeAvailabilityFlash MX 2004.Usage textAttrs.sizeDescriptionProperty; an integer that sp

460EXTENDING FLASH CS4 PROFESSIONALTextAttrs objectDescriptionProperty; a string that represents the URL property of the text field. This property wor

461Chapter 46: TextRun objectAvailabilityFlash MX 2004.DescriptionThe TextRun object represents a run of characters that have attributes that match al

462EXTENDING FLASH CS4 PROFESSIONALTextRun objectDescriptionProperty; the text contained in the TextRun object.ExampleThe following example displays t

463Chapter 47: Timeline objectAvailabilityFlash MX 2004.DescriptionThe Timeline object represents the Flash timeline, which can be accessed for the cu

464EXTENDING FLASH CS4 PROFESSIONALTimeline objectProperty summary The following properties are available for the Timeline object:timeline.getFramePro

465EXTENDING FLASH CS4 PROFESSIONALTimeline objecttimeline.addMotionGuide()AvailabilityFlash MX 2004.Usage timeline.addMotionGuide()ParametersNone. Re

466EXTENDING FLASH CS4 PROFESSIONALTimeline objectDescriptionMethod; adds a new layer to the document and makes it the current layer. ExampleThe follo

467EXTENDING FLASH CS4 PROFESSIONALTimeline objectUsage timeline.clearKeyframes([startFrameIndex [, endFrameIndex]])ParametersstartFrameIndex A zero-

27EXTENDING FLASH CS4 PROFESSIONALactionsPanel objectParametersNone.ReturnsA string that contains the text that is currently selected in the Actions p

468EXTENDING FLASH CS4 PROFESSIONALTimeline objectExampleThe following example converts Frame 2 up to, but not including, Frame 10 to blank keyframes

469EXTENDING FLASH CS4 PROFESSIONALTimeline objecttimeline.copyFrames()AvailabilityFlash MX 2004.Usage timeline.copyFrames([startFrameIndex [, endFram

470EXTENDING FLASH CS4 PROFESSIONALTimeline objectDescriptionMethod; copies motion on selected frames, either from a motion tween or from frame-by-fra

471EXTENDING FLASH CS4 PROFESSIONALTimeline objectUsage timeline.createMotionTween([startFrameIndex [, endFrameIndex]])ParametersstartFrameIndex A ze

472EXTENDING FLASH CS4 PROFESSIONALTimeline objecttimeline.currentLayerAvailabilityFlash MX 2004.Usage timeline.currentLayerDescriptionProperty; the z

473EXTENDING FLASH CS4 PROFESSIONALTimeline objectThe following example cuts Frame 2 up to, but not including, Frame 10 from the timeline and saves th

474EXTENDING FLASH CS4 PROFESSIONALTimeline objectbRecurseNestedParents A Boolean value that, if set to true, causes all the layers within the specif

475EXTENDING FLASH CS4 PROFESSIONALTimeline objectDescriptionMethod; finds an array of indexes for the layers with the given name. The layer index is

476EXTENDING FLASH CS4 PROFESSIONALTimeline objectendFrameIndex A zero-based index that specifies the end of the range of frames to select. The range

477EXTENDING FLASH CS4 PROFESSIONALTimeline objecttimeline.getLayerProperty()AvailabilityFlash MX 2004.Usage timeline.getLayerProperty(property)Parame

vdocument.align() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28EXTENDING FLASH CS4 PROFESSIONALactionsPanel objectactionsPanel.hasSelection()AvailabilityFlash CS3 Professional.Usage actionsPanel.hasSelection()Pa

478EXTENDING FLASH CS4 PROFESSIONALTimeline object var timeline = fl.getDocumentDOM().getTimeline(); timeline.setSelectedFrames(5,10); timeline.se

479EXTENDING FLASH CS4 PROFESSIONALTimeline objectIf the specified or selected frame is a regular frame, the keyframe is inserted at the frame. For ex

480EXTENDING FLASH CS4 PROFESSIONALTimeline objectIf no parameters are specified, this method works as follows:• If one or more frames are selected, t

481EXTENDING FLASH CS4 PROFESSIONALTimeline objectParametersframeNumIndex A zero-based index that specifies the frame index at which to insert the ke

482EXTENDING FLASH CS4 PROFESSIONALTimeline objectUsage timeline.layersDescriptionRead-only property; an array of layer objects. ExampleThe following

483EXTENDING FLASH CS4 PROFESSIONALTimeline objectReturns Nothing. DescriptionMethod; pastes the range of frames from the clipboard into the specified

484EXTENDING FLASH CS4 PROFESSIONALTimeline objecttimeline.removeFrames()AvailabilityFlash MX 2004.Usage timeline.removeFrames([startFrameIndex [, end

485EXTENDING FLASH CS4 PROFESSIONALTimeline objectbAddBefore Specifies whether to move the layer before or after layerToPutItBy. If you specify false

486EXTENDING FLASH CS4 PROFESSIONALTimeline objecttimeline.selectAllFrames()AvailabilityFlash MX 2004.Usage timeline.selectAllFrames()ParametersNone.

487EXTENDING FLASH CS4 PROFESSIONALTimeline objectDescriptionMethod; sets the property of the Frame object for the selected frames. ExampleThe followi

29EXTENDING FLASH CS4 PROFESSIONALactionsPanel objectDescriptionMethod; replaces the currently selected text with the text specified in replacementTex

488EXTENDING FLASH CS4 PROFESSIONALTimeline objecttimeline.setLayerProperty()AvailabilityFlash MX 2004.Usage timeline.setLayerProperty(property, value

489EXTENDING FLASH CS4 PROFESSIONALTimeline objectReturns Nothing. DescriptionMethod; selects a range of frames in the current layer or sets the selec

490EXTENDING FLASH CS4 PROFESSIONALTimeline objectExampleThe following example selects the top layer: fl.getDocumentDOM().getTimeline().setSelectedLa

491Chapter 48: ToolObj objectAvailabilityFlash MX 2004.DescriptionA ToolObj object represents an individual tool in the Tools panel. To access a ToolO

492EXTENDING FLASH CS4 PROFESSIONALToolObj objectUsage toolObj.depthDescriptionRead-only property; an integer that specifies the depth of the tool in

493EXTENDING FLASH CS4 PROFESSIONALToolObj objectbEnable A Boolean value that determines whether to enable (true) or disable (false) the control. Ret

494EXTENDING FLASH CS4 PROFESSIONALToolObj objectExampleThe following commands in the mouseDown() method of a tool’s JavaScript file will show that to

495EXTENDING FLASH CS4 PROFESSIONALToolObj objectDescriptionMethod; sets the string that appears in the pop-up menu as the name for the tool. This met

496EXTENDING FLASH CS4 PROFESSIONALToolObj object <properties> <property name="Style" variable="style" list=&quo

497EXTENDING FLASH CS4 PROFESSIONALToolObj objectExampleThe following example specifies that the shape Property inspector should be used when the tool

30EXTENDING FLASH CS4 PROFESSIONALactionsPanel objectactionsPanel.setSelection()AvailabilityFlash CS3 Professional.Usage actionsPanel.setSelection(sta

498EXTENDING FLASH CS4 PROFESSIONALToolObj objectDescriptionMethod; sets the tooltip that appears when the mouse is held over the tool icon. This meth

499EXTENDING FLASH CS4 PROFESSIONALToolObj objectbShow A Boolean value that determines whether to show or hide the specified control (true shows the

500Chapter 49: Tools objectAvailabilityFlash MX 2004.DescriptionThe Tools object is accessible from the flash object (fl.tools). The tools.toolObjs pr

501EXTENDING FLASH CS4 PROFESSIONALTools objectUsage tools.activeToolDescriptionRead-only property; returns the ToolObj object for the currently activ

502EXTENDING FLASH CS4 PROFESSIONALTools objectDescriptionMethod; takes two points and returns a new adjusted or constrained point. If the Shift key i

503EXTENDING FLASH CS4 PROFESSIONALTools objectExampleThe following example displays the integer value of the most recently pressed key: var theKey =

504EXTENDING FLASH CS4 PROFESSIONALTools objecttools.penLocAvailabilityFlash MX 2004.Usage tools.penLocDescriptionRead-only property; a point that rep

505EXTENDING FLASH CS4 PROFESSIONALTools objectDescriptionMethod; sets the pointer to a specified appearance. ExampleThe following example sets the po

506EXTENDING FLASH CS4 PROFESSIONALTools objecttools.toolObjsAvailabilityFlash MX 2004.Usage tools.toolObjsDescriptionRead-only property; an array of

507Chapter 50: Vertex objectAvailabilityFlash MX 2004.DescriptionThe Vertex object is the part of the shape data structure that holds the coordinate d

31EXTENDING FLASH CS4 PROFESSIONALactionsPanel objectDescriptionMethod; clears any text in the Actions panel and then adds the text specified in repla

508EXTENDING FLASH CS4 PROFESSIONALVertex object var shape = fl.getDocumentDOM().selection[0]; var hEdge = shape.edges[0].getHalfEdge(0); var the

509EXTENDING FLASH CS4 PROFESSIONALVertex objectDescriptionRead-only property; the x location of the vertex, in pixels. ExampleThe following example d

510Chapter 51: VideoItem objectInheritance Item object > VideoItem objectAvailabilityFlash MX 2004.DescriptionThe VideoItem object is a subclass

511EXTENDING FLASH CS4 PROFESSIONALVideoItem objectReturnsA Boolean value of true if the file is exported successfully; false otherwise.DescriptionMet

512EXTENDING FLASH CS4 PROFESSIONALVideoItem objectDescriptionRead-only property: a Boolean value of true if the file that was imported to the Library

513EXTENDING FLASH CS4 PROFESSIONALVideoItem objectExampleThe following example displays the name and source file path of any items in the library tha

514Chapter 52: XMLUI objectAvailabilityFlash MX 2004.DescriptionFlash 8 supports custom dialog boxes written in a subset of the XML User Interface Lan

515EXTENDING FLASH CS4 PROFESSIONALXMLUI objectParametersNone. Returns Nothing. DescriptionMethod; closes the current XMLUI dialog box with an accept

516EXTENDING FLASH CS4 PROFESSIONALXMLUI objectReturnsA string that represents the value of the specified property. In cases where you might expect a

517EXTENDING FLASH CS4 PROFESSIONALXMLUI objectxmlui.getEnabled()AvailabilityFlash 8.Usage xmlui.getEnabled(controlID)ParameterscontrolID A string th

32Chapter 4: BitmapInstance objectInheritance Element object > Instance object > BitmapInstance objectAvailabilityFlash MX 2004.DescriptionTh

518EXTENDING FLASH CS4 PROFESSIONALXMLUI object var isVisible = fl.xmlui.getVisible("myListBox"); fl.trace(isVisible);See alsoxmlui.setVis

519EXTENDING FLASH CS4 PROFESSIONALXMLUI objectelementItem A JavaScript object with a string property named label and an optional string property nam

520EXTENDING FLASH CS4 PROFESSIONALXMLUI object var nameArray = new Array("January", "February", "March"); var monthA

521EXTENDING FLASH CS4 PROFESSIONALXMLUI objectParameterscontrolID A string that specifies the ID attribute of the control you want to show or hide.v

522Chapter 53: C-Level ExtensibilityThis chapter describes the C-level extensibility mechanism, which lets you implement Adobe Flash CS4 Professional

523EXTENDING FLASH CS4 PROFESSIONALC-Level ExtensibilityMacintosh HD/Users/username/Library/Application Support/Adobe/Flash CS3/language/Configuration

524EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibility (mmEnv.defineFunction ? (*(mmEnv.defineFunction))(mmEnv.libObj, n, c, a) \ : JS_FALSE)

525EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibility #define JS_GetArrayLength(c, o) \ (mmEnv.getArrayLength ? (*(mmEnv.getArrayLength))(c, o) :

526EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibility // Windows __declspec( dllexport ) void MM_InitWrapper( MM_Environment *env, unsigned int e

527EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibility // Source code in C // Save the DLL or shared library with the name "Sample". #

33EXTENDING FLASH CS4 PROFESSIONALBitmapInstance objectThe byte array is meaningful only when referenced by a DLL or shared library. You typically use

528EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibilitytypedef struct JSObject JSObjectA pointer to this opaque data type passes to the C-level funct

529EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibilitytypedef JSBool (*JSNative)(JSContext *cx, JSObject *obj, unsigned int argc, jsval *argv, jsval

530EXTENDING FLASH CS4 PROFESSIONALC-Level ExtensibilityDescriptionMethod; extracts a function argument from a jsval structure, converts it to a strin

531EXTENDING FLASH CS4 PROFESSIONALC-Level ExtensibilityArgumentsJSContext *cx, jsval v, double *dp • The cx argument is the opaque JSContext pointer

532EXTENDING FLASH CS4 PROFESSIONALC-Level ExtensibilityReturnsA Boolean value: JS_TRUE indicates success; JS_FALSE indicates failure.JSBool JS_String

533EXTENDING FLASH CS4 PROFESSIONALC-Level ExtensibilityJSVal JS_BooleanToValue()Usage jsval JS_BooleanToValue(JSBool bv);DescriptionMethod; stores a

534EXTENDING FLASH CS4 PROFESSIONALC-Level ExtensibilityReturnsA JSVal structure that contains the integer that passed to the function as an argument.

535EXTENDING FLASH CS4 PROFESSIONALC-Level ExtensibilityArgumentsJSContext *cx, unsigned int length, jsval *v• The cx argument is the opaque JSContext

536EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibility• The vp argument is a pointer to a jsval where the contents of the jsval structure in the arr

537EXTENDING FLASH CS4 PROFESSIONALC-Level Extensibility• The sz argument is the size of the string, in bytes. If sz is 0, the length of the null-term

34EXTENDING FLASH CS4 PROFESSIONALBitmapInstance objectbitmapInstance.setBits()AvailabilityFlash MX 2004.Usage bitmapInstance.setBits(bitmap)Parameter

538

35EXTENDING FLASH CS4 PROFESSIONALBitmapInstance objectExampleThe following code gets the height of the bitmap in pixels: // Get the number of pixels

36Chapter 5: BitmapItem objectInheritance Item object > BitmapItem object AvailabilityFlash MX 2004.DescriptionA BitmapItem object refers to a b

37EXTENDING FLASH CS4 PROFESSIONALBitmapItem objectbitmapItem.allowSmoothingAvailabilityFlash MX 2004. Usage bitmapItem.allowSmoothingDescriptionPrope

vidocument.exitEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

38EXTENDING FLASH CS4 PROFESSIONALBitmapItem objectParametersfileURI A string, expressed as a file:/// URI, that specifies the path and name of the e

39EXTENDING FLASH CS4 PROFESSIONALBitmapItem objectDescriptionRead-only property; a string that specifies whether the specified item was imported as a

40EXTENDING FLASH CS4 PROFESSIONALBitmapItem objectExampleAssuming the first item in the Library is a bitmap item, the following code displays "t

41EXTENDING FLASH CS4 PROFESSIONALBitmapItem objectDescriptionRead-only property; a string, expressed as a file:/// URI, that represents the path and

42EXTENDING FLASH CS4 PROFESSIONALBitmapItem objectDescriptionProperty; a Boolean value that specifies whether to use the default imported JPEG qualit

43Chapter 6: CompiledClipInstance objectInheritance Element object > Instance object > CompiledClipInstance objectAvailabilityFlash MX 2004.D

44EXTENDING FLASH CS4 PROFESSIONALCompiledClipInstance object // Get the name of the object. var theName = fl.getDocumentDOM().selection[0].accName;

45EXTENDING FLASH CS4 PROFESSIONALCompiledClipInstance objectcompiledClipInstance.forceSimpleAvailabilityFlash MX 2004.Usage compiledClipInstance.forc

46EXTENDING FLASH CS4 PROFESSIONALCompiledClipInstance objectUsage compiledClipInstance.silentDescriptionProperty; a Boolean value that enables or dis

47Chapter 7: compilerErrors objectAvailabilityFlash CS3 Professional.DescriptionThe compilerErrors object, which represents the Compiler Errors panel,

viidocument.removeAllFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48EXTENDING FLASH CS4 PROFESSIONALcompilerErrors objectcompilerErrors.save()AvailabilityFlash CS3 Professional.Usage compilerErrors.save(fileURI [, bA

49Chapter 8: ComponentInstance objectInheritance Element object > Instance object > SymbolInstance object > ComponentInstance objectAvaila

50Chapter 9: componentsPanel objectAvailabilityFlash MX 2004.DescriptionThe componentsPanel object, which represents the Components panel, is a proper

51EXTENDING FLASH CS4 PROFESSIONALcomponentsPanel object fl.componentsPanel.addItemToDocument({x:0, y:0}, "User Interface", "CheckBox&q

52Chapter 10: Contour objectAvailabilityFlash MX 2004.DescriptionA Contour object represents a closed path of half edges on the boundary of a shape. M

53EXTENDING FLASH CS4 PROFESSIONALContour objectcontour.getHalfEdge()AvailabilityFlash MX 2004.Usagecontour.getHalfEdge()ParametersNone.ReturnsA HalfE

54EXTENDING FLASH CS4 PROFESSIONALContour objectcontour.interiorAvailabilityFlash MX 2004.Usagecontour.interiorDescriptionRead-only property; the valu

55EXTENDING FLASH CS4 PROFESSIONALContour object var elt = fl.getDocumentDOM().selection[0]; elt.beginEdit(); var contourArray = elt.contours;

56Chapter 11: Document objectAvailabilityFlash MX 2004.DescriptionThe Document object represents the Stage. That is, only FLA files are considered doc

57EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.canTestMovie() Determines whether you can use the document.testMovie() method successfully.d

viiidocument.setStrokeStyle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.enterEditMode() Switches the authoring tool into the editing mode specified by the parameter

59EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.intersect() Creates an intersection drawing object from all selected drawing objects.documen

60EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.saveAndCompact() Saves and compacts the file; equivalent to selecting File > Save and Com

61EXTENDING FLASH CS4 PROFESSIONALDocument objectProperty summary You can use the following properties with the Document object. document.setStageVani

62EXTENDING FLASH CS4 PROFESSIONALDocument objectProperty Descriptiondocument.accName A string that is equivalent to the Name field in the Accessibili

63EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.accNameAvailabilityFlash MX 2004.Usage document.accNameDescriptionProperty; a string that is

64EXTENDING FLASH CS4 PROFESSIONALDocument objecttype A string that defines the type of data to add. Acceptable values are "integer", "

65EXTENDING FLASH CS4 PROFESSIONALDocument object fl.getDocumentDOM().addDataToSelection("myData", "integer", 12); See alsodocumen

66EXTENDING FLASH CS4 PROFESSIONALDocument objectitem An Item object that specifies the item to add and the library from which to add it (see Item ob

67EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example adds a line between the specified starting point and ending point: fl.ge

ixedge.getHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.addNewPrimitiveOval()AvailabilityFlash CS4 Professional.Usagedocument.addNewPrimitiveOval( b

69EXTENDING FLASH CS4 PROFESSIONALDocument objectParametersrect A rectangle that specifies the bounds within which the new rectangle primitive is add

70EXTENDING FLASH CS4 PROFESSIONALDocument objectReturnsAn integer that is the index of the new profile in the profiles list. Returns -1 if a new prof

71EXTENDING FLASH CS4 PROFESSIONALDocument objectbSuppressStroke A Boolean value that, if set to true, causes the method to create the rectangle with

72EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example adds a new scene named myScene after the current scene in the current do

73EXTENDING FLASH CS4 PROFESSIONALDocument objectUsage document.align(alignmode [, bUseDocumentBounds])Parametersalignmode A string that specifies ho

74EXTENDING FLASH CS4 PROFESSIONALDocument object if(fl.getDocumentDOM().allowScreens()) { fl.trace("screen outline is available."); }

75EXTENDING FLASH CS4 PROFESSIONALDocument objectExampleThe following example specifies that instances placed on the Stage in the current document mus

76EXTENDING FLASH CS4 PROFESSIONALDocument objectdocument.as3StrictModeAvailabilityFlash CS3 Professional.Usage document.as3StrictModeDescriptionPrope

77EXTENDING FLASH CS4 PROFESSIONALDocument objectSee alsodocument.as3StrictModedocument.asVersionAvailabilityFlash CS3 Professional.Usage document.asV