Adobe Extending Flash Professional CS5 Manuel d'utilisateur

ExtendingADOBE® FLASH® PROFESSIONAL CS5 & CS5.5

xEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011Chapter 16: Filter objectfilter.angle . . . . . . . . . . . . . . . . . . . . . . . . . .

78EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.canEditSymbol()AvailabilityFlash MX 2004.Usage document.canEditSymbol()Para

79EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 if(fl.getDocumentDOM().canRevert()){ fl.getDocumentDOM().revert(); }document

80EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; determines whether you can use the document.testScene() method su

81EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().changeFilterOrder(1,0); See alsodocument.addFilter(), document.

82EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsNothing. DescriptionMethod; cuts the current selection from the document and

83EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.close()AvailabilityFlash MX 2004.Usage document.close([bPromptToSaveChanges

84EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().convertLinesToFills();document.convertToSymbol()AvailabilityFla

85EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsA Boolean value: true if successful; false otherwise. DescriptionMethod; uses

86EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionProperty; an integer that specifies the index of the active timeline. You

87EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.deleteEnvelope()AvailabilityFlash 8.Usage document.deleteEnvelope()Paramete

xiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011fl.findDocumentIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

88EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 alert(fl.getDocumentDOM().deletePublishProfile());See alsodocument.addNewPublishPro

89EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; deletes the current selection on the Stage. Displays an error mes

90EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example disables all filters on the selected objects: fl.getDoc

91EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ParametersenabledFilterIndex An integer representing the zero-based index of the fi

92EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().distribute("top edge", false);The following example d

93EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example specifies that the ActionScript 3.0 class associated wi

94EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ParametersprofileName A string that specifies the unique name of the duplicated pro

95EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.duplicateSelection()ParametersNone. ReturnsNothing. DescriptionMethod

96EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.enableAllFilters()ParametersNone.ReturnsNothing.DescriptionMethod; en

97EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.enterEditMode()AvailabilityFlash MX 2004.Usage document.enterEditMode([edit

xiiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011fl.trace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

98EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; exits from symbol-editing mode and returns focus to the next leve

99EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.exportPublishProfile()AvailabilityFlash MX 2004.Usage document.exportPublis

100EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example stores an XML string that represents the current profi

101EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.externalLibraryPathAvailabilityFlash CS4 Professional.Usage document.exter

102EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.frameRateAvailabilityFlash MX 2004.Usage document.frameRateDescriptionProp

103EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.getBlendMode()AvailabilityFlash 8.Usage document.getBlendMode()ParametersN

104EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; retrieves the fill object of the selected shape or, if specified

105EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 var stroke = fl.getDocumentDOM().getCustomStroke("selection"); stroke

106EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.getElementProperty(propertyName)ParameterspropertyName A string th

107EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsIf one text field is selected, the property is returned if there is only one

xiiiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011frame.motionTweenOrientToPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

108EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011See alsodocument.addFilter(), document.changeFilterOrder(), document.setFilters(),

109EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example displays the XML settings string for the current docum

110EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.getSelectionRect()AvailabilityFlash MX 2004.Usage document.getSelectionRec

111EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; gets the currently selected text. If the optional parameters are

112EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().enterEditMode("inPlace"); fl.getDocumentDOM().getT

113EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.group()ParametersNone. ReturnsNothing. DescriptionMethod; converts t

114EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.idDescriptionRead-only property; a unique integer (assigned automati

115EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.importPublishProfile()AvailabilityFlash MX 2004.Usage document.importPubli

116EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011var profileXML=fl.getDocumentDOM().exportPublishProfileString('Default');

117EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsA Boolean value: true if successful; false otherwise.DescriptionMethod; crea

xivEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011item.linkageIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

118EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionProperty; a string that contains a list of items in the document’s Actio

119EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; loads a cue point XML file. The format and DTD of the XML file i

120EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.mouseClick()AvailabilityFlash MX 2004.Usage document.mouseClick(position,

121EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsNothing. DescriptionMethod; performs a double mouse click from the Selection

122EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.moveSelectionBy(distanceToMove)ParametersdistanceToMove A pair of f

123EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.optimizeCurves()AvailabilityFlash MX 2004.Usage document.optimizeCurves(sm

124EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011See alsodocument.pathURIdocument.pathURIAvailabilityFlash CS4 Professional.Usage do

125EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example publishes the current document: fl.getDocumentDOM().pu

126EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011See alsodocument.crop(), document.deleteEnvelope(), document.intersect(), document.

127EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; removes persistent data with the specified name that has been at

xvEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011Chapter 28: Matrix objectmatrix.a . . . . . . . . . . . . . . . . . . . . . . . . . . . .

128EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ParametersfilterIndex An integer specifying the zero-based index of the filter to

129EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.renameScene(name)Parametersname A string that specifies the new nam

130EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.resetOvalObject()AvailabilityFlash CS3 Professional.Usage document.resetOv

131EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().resetRectangleObject();See alsodocument.resetOvalObject()docum

132EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example reverts the current document to the previously saved v

133EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011rotationPoint A string that specifies which side of the bounding box to rotate. Ac

134EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011See alsodocument.saveAndCompact(), fl.saveAll(), fl.saveDocument(), fl.saveDocument

135EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011whichCorner A string value that specifies the edge about which the transformation

136EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.selectAll()AvailabilityFlash MX 2004.Usage document.selectAll()ParametersN

137EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011• Specify all the elements in a particular frame (see Element object). See the firs

xviEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011Chapter 34: presetPanel objectpresetPanel.addNewItem() . . . . . . . . . . . . . . . . .

138EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 // Assigns the layers array to the variable "theLayers". var theLayers

139EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().selectNone();See alsodocument.selectAll(), document.selectiond

140EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsNothing.DescriptionMethod; sets the blending mode for the selected objects.

141EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.setCustomStroke()AvailabilityFlash MX 2004.Usage document.setCustomStroke(

142EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsNothing. DescriptionMethod; sets the specified Element property on selected

143EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.setFillColor()AvailabilityFlash MX 2004.Usage document.setFillColor(color)

144EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011value A number or string specifying the value to be set for the specified filter p

145EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 var myFilters = fl.getDocumentDOM().getFilters(); for (i=0; i < myFilters.le

146EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsNothing. DescriptionMethod; sets the brightness for the instance. ExampleThe

147EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ParametersstrMetadata A string containing the XML metadata to be associated with t

xviiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011soundItem.sampleRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

148EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 <rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'>

149EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().setMobileSettings("<? xml version="1.0" enco

150EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Parametersversion A string that represents the version of Flash Player targeted by

151EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.setSelectionBounds()AvailabilityFlash MX 2004; bContactSensitiveSelection

152EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011bContactSensitiveSelection A Boolean value that specifies whether the Contact Sens

153EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionSpecifies the vanishing point for viewing 3D objects.ExampleThe followin

154EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011strokeType A string that specifies the new type of stroke for the selection. Accep

155EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.setStrokeSize()AvailabilityFlash MX 2004.Usage document.setStrokeSize(size

156EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.setTextRectangle()AvailabilityFlash MX 2004.Usage document.setTextRectangl

157EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011endIndex An integer that specifies the end position of the selection up to, but no

xviiiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011symbolInstance.colorAlphaAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . .

158EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011The following example inserts “Howdy” starting at position 2 and up to, but not inc

159EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.silentAvailabilityFlash MX 2004.Usage document.silentDescriptionProperty;

160EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following examples skew the selected object by 2.0 vertically and 1.5 ho

161EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011var myDoc = fl.getDocumentDOM(); fl.trace(myDoc.sourcePath); myDoc.sourcePath =

162EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.straightenSelection()AvailabilityFlash MX 2004.Usage document.straightenSe

163EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.swapStrokeAndFill()AvailabilityFlash 8.Usage document.swapStrokeAndFill()P

164EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011See alsodocument.canTestMovie(), document.testScene()document.testScene()Availabili

165EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 var i = 0; var curTimelines = fl.getDocumentDOM().timelines; while(i < fl.g

166EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Usage document.translate3DCenter(xyzCoordinate)ParametersxyzCoordinate An XYZ coor

167EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.transformSelection()AvailabilityFlash MX 2004.Usage document.transformSele

xixEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011text.lineType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

168EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 fl.getDocumentDOM().unGroup();See alsodocument.group()document.union()Availability

169EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; unlocks all locked elements on the currently selected frame. Exa

170EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example sets the width of the Stage to 400 pixels. fl.getDocum

171EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionProperty; specifies the zoom percent of the Stage at authoring time. A v

172Last updated 5/2/2011Chapter 12: drawingLayer objectAvailabilityFlash MX 2004.DescriptionThe drawingLayer object is accessible from JavaScript as a

173EXTENDING FLASH PROFESSIONALdrawingLayer objectLast updated 5/2/2011ParameterspersistentDraw A Boolean value (optional). If set to true, it indic

174EXTENDING FLASH PROFESSIONALdrawingLayer objectLast updated 5/2/2011Usage drawingLayer.cubicCurveTo(x1Ctrl, y1Ctrl, x2Ctl, y2Ctl, xEnd, yEnd)Parame

175EXTENDING FLASH PROFESSIONALdrawingLayer objectLast updated 5/2/2011ExampleThe following example draws a quadratic curve using the specified contro

176EXTENDING FLASH PROFESSIONALdrawingLayer objectLast updated 5/2/2011ExampleThe following example exits drawing mode: fl.drawingLayer.endDraw(); dra

177EXTENDING FLASH PROFESSIONALdrawingLayer objectLast updated 5/2/2011ExampleThe following example draws a line from the current drawing position to

Last updated 5/2/2011Legal noticesLegal noticesFor legal notices, see http://help.adobe.com/en_US/legalnotices/index.html.

xxEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011timeline.convertToBlankKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . .

178EXTENDING FLASH PROFESSIONALdrawingLayer objectLast updated 5/2/2011DescriptionMethod; returns a new Path object. You typically use this method onl

179EXTENDING FLASH PROFESSIONALdrawingLayer objectLast updated 5/2/2011drawingLayer.setFill()This method is not available.drawingLayer.setStroke()This

180Last updated 5/2/2011Chapter 13: Edge objectAvailabilityFlash MX 2004.DescriptionThe Edge object represents an edge of a shape on the Stage.Method

181EXTENDING FLASH PROFESSIONALEdge objectLast updated 5/2/2011var theShape = fl.getDocumentDOM().selection[0]; var edgesArray = theShape.edges; for

182EXTENDING FLASH PROFESSIONALEdge objectLast updated 5/2/2011DescriptionMethod; returns a HalfEdge object. ExampleThe following example stores the h

183EXTENDING FLASH PROFESSIONALEdge objectLast updated 5/2/2011edge.setControl()AvailabilityFlash MX 2004.Usage edge.setControl(index, x, y)Parameters

184EXTENDING FLASH PROFESSIONALEdge objectLast updated 5/2/2011ReturnsNothing. DescriptionMethod; splits the edge into two pieces. You must call shape

185Last updated 5/2/2011Chapter 14: Element objectAvailabilityFlash MX 2004.DescriptionEverything that appears on the Stage is of the type Element. Th

186EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011element.depthAvailabilityFlash MX 2004.Usage element.depthDescriptionRead-only prope

187EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011DescriptionRead-only property; a string that represents the type of the specified el

xxiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011Chapter 46: ToolObj objecttoolObj.depth . . . . . . . . . . . . . . . . . . . . . . . . .

188EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011 // At least one symbol or bitmap is selected in the first layer, first frame. var

189EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011Usage element.hasPersistentData(name)Parametersname A string that specifies the nam

190EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011ExampleThe following example stores the Layer object that contains the element in th

191EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011element.matrixAvailabilityFlash MX 2004.Usage element.matrixDescriptionProperty; a M

192EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011Parametersname A string that specifies the name of the data to remove. ReturnsNothi

193EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011ExampleThe following example sets the x scale value of the current selection to 2 (d

194EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011element.setPersistentData()AvailabilityFlash MX 2004.Usage element.setPersistentData

195EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011• Drawing objects, primitive objects, and groups: transformationPoint is set relativ

196EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011element.skewYAvailabilityFlash CS3 Professional.Usage element.skewYDescriptionProper

197EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011element.transformXAvailabilityFlash CS3 Professional.Usage element.transformXDescrip

xxiiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011xmlui.getEnabled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

198EXTENDING FLASH PROFESSIONALElement objectLast updated 5/2/2011Do not use this property to resize a text field. Instead, select the text field and

199Last updated 5/2/2011Chapter 15: Fill objectAvailabilityFlash MX 2004.DescriptionThis object contains all the properties of the Fill color setting

200EXTENDING FLASH PROFESSIONALFill objectLast updated 5/2/2011var fill = fl.getDocumentDOM().getCustomFill(); if (fill.style == "bitmap")

201EXTENDING FLASH PROFESSIONALFill objectLast updated 5/2/2011ExampleThe following example sets the fill color of the current selection: var fill = f

202EXTENDING FLASH PROFESSIONALFill objectLast updated 5/2/2011ExampleThe following example sets the focal point of a radial gradient for the current

203EXTENDING FLASH PROFESSIONALFill objectLast updated 5/2/2011ExampleThe following example uses the fill.matrix property to specify a gradient fill f

204EXTENDING FLASH PROFESSIONALFill objectLast updated 5/2/2011DescriptionProperty; an array of integers, each in the range of zero to 255, indicating

205Last updated 5/2/2011Chapter 16: Filter objectAvailabilityFlash 8.DescriptionThis object contains all the properties for all filters. The filter.na

206EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011filter.angleAvailabilityFlash 8.Usage filter.angleDescriptionProperty; a float value

207EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011 var myFilters = fl.getDocumentDOM().getFilters(); for(i=0; i < myFilters.length

1Last updated 5/2/2011Chapter 1: IntroductionAs a user of Adobe® Flash® Professional CS5 or CS5.5, you may be familiar with Adobe® ActionScript®, whi

208EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011ExampleThe following example sets the brightness to 30.5 for the Adjust Color filters

209EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011Usage filter.contrastDescriptionProperty; a float value that specifies the contrast v

210EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011filter.enabledAvailabilityFlash CS3 Professional.Usage filter.enabledDescriptionPrope

211EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011filter.highlightColorAvailabilityFlash 8.Usage filter.highlightColorDescriptionProper

212EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011 var myFilters = fl.getDocumentDOM().getFilters(); for(i=0; i < myFilters.length

213EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011ExampleThe following example sets the knockout property to true for the Glow filters

214EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011Usage filter.qualityDescriptionProperty; a string that specifies the blur quality. Ac

215EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011filter.shadowColorAvailabilityFlash 8.Usage filter.shadowColorDescriptionProperty; th

216EXTENDING FLASH PROFESSIONALFilter objectLast updated 5/2/2011 var myFilters = fl.getDocumentDOM().getFilters(); for(i=0; i < myFilters.length

217Last updated 5/2/2011Chapter 17: flash object (fl)AvailabilityFlash MX 2004.DescriptionThe flash object represents the Flash application. You can u

2EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011You can also create a JSFL file by selecting commands in the History panel. Then click t

218EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011Property summary The following properties can be used with the flash object.fl.op

219EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.createNewDocList Read-only; an array of strings that represent the various typ

220EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.actionsPanelAvailabilityFlash CS3 Professional.Usage fl.actionsPanelDescriptio

221EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ExampleThe following example displays a message in the Output panel when a docume

222EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersbrowseType A string that specifies the type of file browse operation.

223EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ExampleThe following example lets the user select a folder and then displays a li

224EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ReturnsNothing.DescriptionMethod; copies the specified string to the Clipboard.To

225EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011Usage fl.closeAllPlayerDocuments()ParametersNone.ReturnsA Boolean value: true if

226EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 // Closes the specified document and prompts to save changes. fl.closeDocument

227EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011DescriptionRead-only property; a string that specifies the full path for the loca

3EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011There are two locations where you can store command and tool files so they can be access

228EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 var contact = fl.contactSensitiveSelection; fl.contactSensitiveSelection = fa

229EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ExampleThe following example displays the types of documents that can be created,

230EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.documentsAvailabilityFlash MX 2004.Usage fl.documentsDescriptionRead-only prop

231EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersucfURI A string that specifies the file Uniform Resource Identifier (U

232EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.fileExists()AvailabilityFlash MX 2004.Usage fl.fileExists(fileURI)Parametersfi

233EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 var originalDocID = fl.getDocumentDOM().id; // other code here, maybe working

234EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersinstanceName A string that specifies the instance name of an item in t

235EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ReturnsAn array of generic objects. Use the .obj property of each item in the arr

236EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 var doc = fl.getDocumentDOM(); var typeToSearchFor = "text"; var r

237EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersmemType An integer that specifies the memory utilization area to be qu

4EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011• From within a script, use the fl.runScript() command.• From the file system, double-cl

238EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011DescriptionMethod; retrieves the DOM (Document object) of the currently active do

239EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersNone. ReturnsAn array of generic objects corresponding to the list of i

240EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ExampleThe following code displays “true” in the Output panel if the Times font i

241EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.mapPlayerURL()AvailabilityFlash MX 2004.Usage fl.mapPlayerURL(URI [, returnMBC

242EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 // Select an element on the Stage and then run this script. var mat =fl.getDoc

243EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.objectDrawingModeAvailabilityFlash 8. Usage fl.objectDrawingModeDescriptionPro

244EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 var doc = fl.openDocument("file:///c|/Document.fla");fl.openScript()Av

245EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011DescriptionRead-only property; reference to the outputPanel object.ExampleSee out

246EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.publishCacheDiskSizeMaxAvailabilityFlash CS5.5 Professional.Usage fl.publishCa

247EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011Usage fl.publishCacheMemoryEntrySizeLimitDescriptionProperty: an integer that set

5EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011New methods and propertiesThe following methods and properties for existing objects are

248EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersflaURI A string, expressed as a file:/// URI, that specifies the path

249EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 // Quit with prompt to save any modified documents. fl.quit(); fl.quit(true)

250EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011DescriptionMethod; rebuilds the Tools panel from the toolconfig.xml file. This me

251EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersNone.DescriptionMethod; resets the global Classpath setting in the Acti

252EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ParametersdocumentObject A Document object. If documentObject refers to the acti

253EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 function testFunct(num, minNum) { fl.trace("in testFunct: 1st arg: "

254EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011 fl.saveAll();See alsodocument.save(), document.saveAndCompact(), fl.saveDocument

255EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011Usage fl.saveDocumentAs(document)Parametersdocument A Document object that speci

256EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.selectElement()AvailabilityFlash CS3 Professional.Usage fl.selectElement(eleme

257EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011Usage fl.selectTool(toolName)ParameterstoolName A string that specifies the name

6EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011• flash object (fl)• fl.getSwfPanel()• fl.installedPlayers()• fl.publishCacheEnabled• fl

258EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ReturnsNothing. DescriptionMethod; sets the active window to be the specified doc

259EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.sourcePathAvailabilityFlash CS4 Professional.Usage fl.sourcePathDescriptionPro

260EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011fl.toggleBreakpoint()AvailabilityFlash Professional CS5.Usage fl.toggleBreakPoint

261EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011ReturnsNothing. DescriptionMethod; sends a text string to the Output panel, termi

262EXTENDING FLASH PROFESSIONALflash object (fl)Last updated 5/2/2011DescriptionRead-only property; an XMLUI object. This property lets you get and se

263Last updated 5/2/2011Chapter 18: FLfile objectAvailabilityFlash MX 2004 7.2. DescriptionThe FLfile object lets you write Flash extensions that can

264EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011FLfile.copy()AvailabilityFlash MX 2004 7.2.Usage FLfile.copy(fileURI, copyURI)Paramet

265EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011ExampleThe following example makes a backup copy of a configuration file named config

266EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011See alsoFLfile.remove(), FLfile.write()FLfile.exists()AvailabilityFlash MX 2004 7.2.U

267EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011FLfile.getAttributes()AvailabilityFlash MX 2004 7.2.Usage FLfile.getAttributes(fileOr

7EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011Object DescriptionactionsPanel object The actionsPanel object represents the currently d

268EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011FLfile.getCreationDate()AvailabilityFlash MX 2004 7.2.Usage FLfile.getCreationDate(fi

269EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011ParametersfileOrFolderURI A string, expressed as a file:/// URI, specifying the file

270EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011 // Make sure the specified files exist. file1 = "file:///C|/MyApplication/MyA

271EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011FLfile.getSize()AvailabilityFlash MX 2004 7.2.Usage FLfile.getSize(fileURI)Parameters

272EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011DescriptionMethod; returns an array of strings representing the contents of the folde

273EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011ExampleThe following example converts a filename from a platform-specific format to a

274EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011Usage FLfile.remove(fileOrFolderURI)ParametersfileOrFolderURI A string, expressed as

275EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011ParametersfileURI A string, expressed as a file:/// URI, specifying the file whose a

276EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011FLfile.uriToPlatformPath()AvailabilityFlash CS4 Professional.Usage FLfile.uriToPlatfo

277EXTENDING FLASH PROFESSIONALFLfile objectLast updated 5/2/2011DescriptionMethod; writes the specified string to the specified file (as UTF-8). If t

iiiLast updated 5/2/2011ContentsChapter 1: IntroductionWorking with the JavaScript API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

8EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011Parameter object The Parameter object type is accessed from the screen.parameters array

278Last updated 5/2/2011Chapter 19: folderItem objectInheritance Item object > folderItem objectAvailabilityFlash MX 2004.DescriptionThe folderI

279Last updated 5/2/2011Chapter 20: fontItem objectInheritance Item object > fontItem objectAvailabilityFlash MX 2004.DescriptionThe fontItem ob

280EXTENDING FLASH PROFESSIONALfontItem objectLast updated 5/2/2011fontItem.boldAvailabilityFlash CS4 Professional.Usage fontItem.boldDescriptionPrope

281EXTENDING FLASH PROFESSIONALfontItem objectLast updated 5/2/2011Usage fontItem.embedRangesDescriptionProperty; a string value that specifies a seri

282EXTENDING FLASH PROFESSIONALfontItem objectLast updated 5/2/2011function embedFontSymbol(symbolName, fontName, includeVariants) { var doc = fl

283EXTENDING FLASH PROFESSIONALfontItem objectLast updated 5/2/2011fontItem.fontAvailabilityFlash CS4 Professional.Usage fontItem.fontDescriptionPrope

284EXTENDING FLASH PROFESSIONALfontItem objectLast updated 5/2/2011fontItem.italicAvailabilityFlash CS4 Professional.Usage fontItem.italicDescriptionP

285Last updated 5/2/2011Chapter 21: Frame objectAvailabilityFlash MX 2004.DescriptionThe Frame object represents frames in the layer. Method summary T

286EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011frame.convertMotionObjectTo2D()AvailabilityFlash Professional CS5.Usage frame.convertM

287EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011ExampleThe following example converts the selected motion object to a 2D motion object

9EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011The Flash Document Object ModelThe Flash Document Object Model (DOM) for the Flash JavaS

288EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011Usage frame.actionScriptDescriptionProperty; a string that represents ActionScript cod

289EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011 var myElements = fl.getDocumentDOM().getTimeline().layers[0].frames[0].elements; fram

290EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011 var doc = fl.getDocumentDOM(); var my_tl = doc.getTimeline(); this.getCurrentFrame

291EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011ExampleThe following example returns a trace statement informing you if the current se

292EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011frame.isMotionObject()AvailabilityFlash Professional CS5.Usage Frame.isMotionObject()D

293EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011frame.motionTweenOrientToPathAvailabilityFlash MX 2004.Usage frame.motionTweenOrientTo

294EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011ExampleThe following example rotates the element in this frame counter-clockwise three

295EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011Usage frame.motionTweenSyncDescriptionProperty; a Boolean value that if set to true, s

296EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011var doc = fl.getDocumentDOM(); var my_tl = doc.getTimeline(); t his.getCurrentFram

297EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011See alsoframe.getCustomEase(), frame.hasCustomEase, frame.useSingleEaseCurveframe.setM

10EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011To access the document that is currently focused, use the statement flash.getDocumentDO

298EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011endAtCurrentLocation A boolean value that determines whether the tween starts or ends

299EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011frame.soundLibraryItemAvailabilityFlash MX 2004.Usage frame.soundLibraryItemDescriptio

300EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011DescriptionProperty; a string that specifies whether a sound that is attached directly

301EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011frame.startFrameAvailabilityFlash MX 2004.Usage frame.startFrameDescriptionRead-only p

302EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011Usage Frame.tweenInstanceName()DescriptionProperty; a string that assigns an instance

303EXTENDING FLASH PROFESSIONALFrame objectLast updated 5/2/2011This property is ignored if the frame doesn’t have custom easing applied.ExampleThe fo

304Last updated 5/2/2011Chapter 22: HalfEdge objectAvailabilityFlash MX 2004.DescriptionThe HalfEdge object is the directed side of the edge of a Shap

305EXTENDING FLASH PROFESSIONALHalfEdge objectLast updated 5/2/2011ReturnsAn Edge object. DescriptionMethod; gets the Edge object for the HalfEdge obj

306EXTENDING FLASH PROFESSIONALHalfEdge objectLast updated 5/2/2011ParametersNone. ReturnsA HalfEdge object. DescriptionMethod; gets the HalfEdge obje

307EXTENDING FLASH PROFESSIONALHalfEdge objectLast updated 5/2/2011Usage halfEdge.getVertex()ParametersNone. ReturnsA Vertex objectDescriptionMethod;

11EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011Summary of the DOM structureThe following list displays the DOM structure in outline fo

308EXTENDING FLASH PROFESSIONALHalfEdge objectLast updated 5/2/2011DescriptionRead-only property; an integer with a value of 0 or 1 that specifies the

309Last updated 5/2/2011Chapter 23: Instance objectInheritance Element object > Instance objectAvailabilityFlash MX 2004.DescriptionInstance is

310EXTENDING FLASH PROFESSIONALInstance objectLast updated 5/2/2011instance.libraryItemAvailabilityFlash MX 2004.Usage instance.libraryItemDescription

311Last updated 5/2/2011Chapter 24: Item objectAvailabilityFlash MX 2004.DescriptionThe Item object is an abstract base class. Anything in the library

312EXTENDING FLASH PROFESSIONALItem objectLast updated 5/2/2011item.addData()AvailabilityFlash MX 2004.Usage item.addData(name, type, data)Parametersn

313EXTENDING FLASH PROFESSIONALItem objectLast updated 5/2/2011ExampleThe following example gets the value of the data named myData from the first ite

314EXTENDING FLASH PROFESSIONALItem objectLast updated 5/2/2011item.linkageBaseClassAvailabilityFlash CS3 Professional.Usage item.linkageBaseClassDesc

315EXTENDING FLASH PROFESSIONALItem objectLast updated 5/2/2011For this property to be defined, the item.linkageExportForAS and/or item.linkageExportF

316EXTENDING FLASH PROFESSIONALItem objectLast updated 5/2/2011item.linkageExportInFirstFrameAvailabilityFlash MX 2004.Usage item.linkageExportInFirst

317EXTENDING FLASH PROFESSIONALItem objectLast updated 5/2/2011item.linkageImportForRSAvailabilityFlash MX 2004.Usage item.linkageImportForRSDescripti

12EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011 07 Edge object (shape.edges array) 08 HalfEdge object

318EXTENDING FLASH PROFESSIONALItem objectLast updated 5/2/2011Usage item.nameDescriptionMethod; a string that specifies the name of the library item,

319Last updated 5/2/2011Chapter 25: Layer objectAvailabilityFlash MX 2004.DescriptionThe Layer object represents a layer in the timeline. The timeline

320EXTENDING FLASH PROFESSIONALLayer objectLast updated 5/2/2011ExampleThe following example stores the value of the first layer in the colorValue var

321EXTENDING FLASH PROFESSIONALLayer objectLast updated 5/2/2011 var frameArray = fl.getDocumentDOM().getTimeline().layers[0].frames; var n = frameA

322EXTENDING FLASH PROFESSIONALLayer objectLast updated 5/2/2011layer.lockedAvailabilityFlash MX 2004.Usage layer.lockedDescriptionProperty; a Boolean

323EXTENDING FLASH PROFESSIONALLayer objectLast updated 5/2/2011DescriptionProperty; a Boolean value that specifies the status of outlines for all obj

324EXTENDING FLASH PROFESSIONALLayer objectLast updated 5/2/2011ExampleThe following example makes all objects in the first layer invisible: fl.getDo

325Last updated 5/2/2011Chapter 26: library objectAvailabilityFlash MX 2004.DescriptionThe library object represents the Library panel. It is a proper

326EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011Property summary for the library objectThe following property is available for the l

327EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011namePath A string that specifies the name of the item to be added. If the item is i

13EXTENDING FLASH PROFESSIONALIntroductionLast updated 5/2/2011Sample PolyStar toolA sample JavaScript API script named PolyStar.jsfl is located in th

328EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011library.duplicateItem()AvailabilityFlash MX 2004.Usage library.duplicateItem( [ name

329EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011ExampleThe following example opens the item circle in the test folder of the library

330EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011ReturnsAn integer value representing the item’s zero-based index value. DescriptionM

331EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011ParametersnamePath A string that specifies the name of the item. If the item is in

332EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011ParameterslinkageName A string that provides the name of the SWF linkage of the roo

333EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011library.itemsAvailabilityFlash MX 2004.Usage library.itemsDescriptionProperty; an ar

334EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011library.newFolder()AvailabilityFlash MX 2004.Usage library.newFolder([folderPath])Pa

335EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011library.selectAll()AvailabilityFlash MX 2004.Usage library.selectAll([bSelectAll])Pa

336EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011ReturnsA Boolean value: true if the specified item exists; false otherwise.Descripti

337EXTENDING FLASH PROFESSIONALlibrary objectLast updated 5/2/2011Usage library.setItemProperty(property, value)Parametersproperty A string that is t

14Last updated 5/2/2011Chapter 2: Top-Level Functions and MethodsAbout this sectionThis section describes the top-level functions and methods that are

338Last updated 5/2/2011Chapter 27: Math objectAvailabilityFlash MX 2004.DescriptionThe Math object is available as a read-only property of the flash

339EXTENDING FLASH PROFESSIONALMath objectLast updated 5/2/2011Math.invertMatrix()AvailabilityFlash MX 2004.Usage Math.invertMatrix(mat)Parametersmat

340EXTENDING FLASH PROFESSIONALMath objectLast updated 5/2/2011ExampleThe following example stores the value for the distance between pt1 and pt2 in t

341Last updated 5/2/2011Chapter 28: Matrix objectAvailabilityFlash MX 2004.DescriptionThe Matrix object represents a transformation matrix. Property s

342EXTENDING FLASH PROFESSIONALMatrix objectLast updated 5/2/2011 var mat = fl.getDocumentDOM().selection[0].matrix; mat.a = 0.5; mat.b = 0.8; m

343EXTENDING FLASH PROFESSIONALMatrix objectLast updated 5/2/2011ExampleSee the matrix.b example.matrix.dAvailabilityFlash MX 2004.Usage matrix.dDescr

344EXTENDING FLASH PROFESSIONALMatrix objectLast updated 5/2/2011Usage matrix.tyDescriptionProperty; a floating-point value that specifies the y-axis

345Last updated 5/2/2011Chapter 29: outputPanel objectAvailabilityFlash MX 2004.DescriptionThis object represents the Output panel, which displays tro

346EXTENDING FLASH PROFESSIONALoutputPanel objectLast updated 5/2/2011outputPanel.save()AvailabilityFlash MX 2004; bUseSystemEncoding parameter added

347EXTENDING FLASH PROFESSIONALoutputPanel objectLast updated 5/2/2011Returns Nothing. DescriptionMethod; sends a text string to the Output panel, ter

15EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011DescriptionFunction; called when the extensible tool becomes active

348Last updated 5/2/2011Chapter 30: Oval objectInheritance Element object > Shape object > Oval objectAvailabilityFlash CS3 Professional.Desc

349EXTENDING FLASH PROFESSIONALOval objectLast updated 5/2/2011OvalObject.endAngleAvailabilityFlash CS3 Professional.Usage OvalObject.endAngleDescript

350EXTENDING FLASH PROFESSIONALOval objectLast updated 5/2/2011OvalObject.startAngleAvailabilityFlash CS3 Professional.Usage OvalObject.startAngleDesc

351Last updated 5/2/2011Chapter 31: Parameter objectAvailabilityFlash MX 2004.DescriptionThe Parameter object type is accessed from the componentInsta

352EXTENDING FLASH PROFESSIONALParameter objectLast updated 5/2/2011parameter.insertItem()AvailabilityFlash MX 2004.Usage parameter.insertItem(index,

353EXTENDING FLASH PROFESSIONALParameter objectLast updated 5/2/2011ExampleThe following example sets the first parameter for a Slide, which is the au

354EXTENDING FLASH PROFESSIONALParameter objectLast updated 5/2/2011ExampleThe following example removes the element at index 1 from the labelPlacemen

355EXTENDING FLASH PROFESSIONALParameter objectLast updated 5/2/2011parameter.valueTypeAvailabilityFlash MX 2004.Usage parameter.valueTypeDescriptionR

356Last updated 5/2/2011Chapter 32: Path objectAvailabilityFlash MX 2004.DescriptionThe Path object defines a sequence of line segments (straight, cur

357EXTENDING FLASH PROFESSIONALPath objectLast updated 5/2/2011yAnchor A floating-point number that specifies the y position of the first control poi

16EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011Usage function configureTool() { // statements }ParametersNone.

358EXTENDING FLASH PROFESSIONALPath objectLast updated 5/2/2011ExampleThe following example creates a new path, stores it in the myPath variable, and

359EXTENDING FLASH PROFESSIONALPath objectLast updated 5/2/2011DescriptionMethod; removes all points from the path. ExampleThe following example remov

360EXTENDING FLASH PROFESSIONALPath objectLast updated 5/2/2011bSupressStroke A Boolean value that, if set to true, suppresses the stroke that would

361EXTENDING FLASH PROFESSIONALPath objectLast updated 5/2/2011 var myPath = fl.drawingLayer.newPath(); myPath.addPoint(0, 0); myPath.addPoint(0,

362Last updated 5/2/2011Chapter 33: presetItem objectAvailabilityFlash CS4 Professional.DescriptionThe presetItem object represents an item (preset or

363EXTENDING FLASH PROFESSIONALpresetItem objectLast updated 5/2/2011fl.outputPanel.clear(); var presetItemArray=fl.presetPanel.items; for (i=0;i<

364EXTENDING FLASH PROFESSIONALpresetItem objectLast updated 5/2/2011presetItem.nameAvailabilityFlash CS4 Professional.Usage presetItem.nameDescriptio

365EXTENDING FLASH PROFESSIONALpresetItem objectLast updated 5/2/2011Usage presetItem.pathDescriptionRead-only property: a string that represents the

366Last updated 5/2/2011Chapter 34: presetPanel objectAvailabilityFlash CS4 Professional.DescriptionThe presetPanel object represents the Motion Prese

367EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011presetPanel.addNewItem()AvailabilityFlash CS4 Professional. Usagefl. presetPane

17EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011DescriptionMethod; displays a string in a modal Alert dialog box, al

368EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011DescriptionMethod; applies the specified or currently selected preset to the cur

369EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011presetPanel.deleteItem()AvailabilityFlash CS4 Professional.Usage presetPanel.del

370EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011DescriptionMethod; expands or collapses the currently selected folder or folders

371EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011//Exports fly-in-left to C:\My Presets\fly-in-left.xml fl.presetPanel.exportIte

372EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011presetPanel.getSelectedItems()AvailabilityFlash CS4 Professional.UsagepresetPane

373EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011DescriptionMethod; adds a preset to the Motion Presets panel from a specified XM

374EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011UsagepresetPanel.moveToFolder(folderPath [, namePath] )ParametersfolderPath A s

375EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011Note: You can’t add folders to the Default Presets folder.ExampleThe following e

376EXTENDING FLASH PROFESSIONALpresetPanel objectLast updated 5/2/2011UsagepresetPanel.selectItem(namePath [, bReplaceCurrentSelection [, bSelect] ])P

377Last updated 5/2/2011Chapter 35: Rectangle objectInheritance Element object > Shape object > Rectangle objectAvailabilityFlash CS3 Profess

ivEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011bitmapItem.originalCompressionType . . . . . . . . . . . . . . . . . . . . . . . . . . .

18EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011Usage function keyDown() { // statements }ParametersNone. Retur

378EXTENDING FLASH PROFESSIONALRectangle objectLast updated 5/2/2011RectangleObject.bottomRightRadius AvailabilityFlash CS3 Professional.Usage Rectang

379EXTENDING FLASH PROFESSIONALRectangle objectLast updated 5/2/2011DescriptionRead-only property; a float value that sets the radius of all corners o

380Last updated 5/2/2011Chapter 36: Shape objectInheritance Element object > Shape objectAvailabilityFlash MX 2004.DescriptionThe Shape object i

381EXTENDING FLASH PROFESSIONALShape objectLast updated 5/2/2011shape.beginEdit()AvailabilityFlash MX 2004.Usage shape.beginEdit()ParametersNone. Retu

382EXTENDING FLASH PROFESSIONALShape objectLast updated 5/2/2011shape.deleteEdge()AvailabilityFlash MX 2004.Usage shape.deleteEdge(index)Parametersind

383EXTENDING FLASH PROFESSIONALShape objectLast updated 5/2/2011ParametersNone. Returns Nothing. DescriptionMethod; defines the end of an edit session

384EXTENDING FLASH PROFESSIONALShape objectLast updated 5/2/2011shape.isDrawingObjectAvailabilityFlash 8.Usage shape.isDrawingObjectDescriptionRead-on

385EXTENDING FLASH PROFESSIONALShape objectLast updated 5/2/2011shape.isOvalObjectAvailabilityFlash CS3 Professional.Usage shape.isOvalObjectDescripti

386EXTENDING FLASH PROFESSIONALShape objectLast updated 5/2/2011Usage shape.membersDescriptionRead-only property; an array of objects in the currently

387EXTENDING FLASH PROFESSIONALShape objectLast updated 5/2/2011DescriptionRead-only property; an array of Vertex objects (see Vertex object).ExampleT

19EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011 function keyUp() { fl.trace("Key is released"); }See

388Last updated 5/2/2011Chapter 37: SoundItem objectInheritance Item object > SoundItem objectAvailabilityFlash MX 2004.DescriptionThe SoundItem

389EXTENDING FLASH PROFESSIONALSoundItem objectLast updated 5/2/2011soundItem.bitRateAvailabilityFlash MX 2004.Usage soundItem.bitRateDescriptionPrope

390EXTENDING FLASH PROFESSIONALSoundItem objectLast updated 5/2/2011If you want to specify a value for this property, set soundItem.useImportedMP3Qual

391EXTENDING FLASH PROFESSIONALSoundItem objectLast updated 5/2/2011DescriptionProperty; a Boolean value available only for MP3 and Raw compression ty

392EXTENDING FLASH PROFESSIONALSoundItem objectLast updated 5/2/2011Usage soundItem.fileLastModifiedDateDescriptionRead-only property: a string contai

393EXTENDING FLASH PROFESSIONALSoundItem objectLast updated 5/2/2011Usage soundItem.qualityDescriptionProperty; a string that specifies the playback q

394EXTENDING FLASH PROFESSIONALSoundItem objectLast updated 5/2/2011DescriptionRead-only property: a Boolean value of true if the file that was import

395EXTENDING FLASH PROFESSIONALSoundItem objectLast updated 5/2/2011DescriptionRead-only property: a string, expressed as a file:/// URI, that represe

396Last updated 5/2/2011Chapter 38: Stroke objectAvailabilityFlash MX 2004.DescriptionThe Stroke object contains all the settings for a stroke, includ

397EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011stroke.breakAtCornersAvailabilityFlash MX 2004. Deprecated in Flash CS3 in favor of s

20EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011Parameterspt A point that specifies the location of the mouse when

398EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011stroke.colorAvailabilityFlash MX 2004. In Flash 8 and later, this property is depreca

399EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011 var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "hatc

400EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011stroke.densityAvailabilityFlash MX 2004.Usage stroke.densityDescriptionProperty; a st

401EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011stroke.dotSpaceAvailabilityFlash MX 2004.Usage stroke.dotSpaceDescriptionProperty; an

402EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011stroke.jiggleAvailabilityFlash MX 2004.Usage stroke.jiggleDescriptionProperty; a stri

403EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011Usage stroke.lengthDescriptionProperty; a string that specifies the length of a hatch

404EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011Usage stroke.patternDescriptionProperty; a string that specifies the pattern of a rag

405EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011DescriptionProperty; a string that specifies the type of scale to be applied to the s

406EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011 var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "hatc

407EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011• If value is "hatched", there are six additional properties: hatchThicknes

21EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011 function mouseMove() { fl.trace("moving"); } f

408EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011 var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "stip

409EXTENDING FLASH PROFESSIONALStroke objectLast updated 5/2/2011 var myStroke = fl.getDocumentDOM().getCustomStroke(); myStroke.style = "ragg

410Last updated 5/2/2011Chapter 39: swfPanel objectAvailabilityFlash CS4 Professional.DescriptionThe swfPanel object represents a Window SWF panel. Wi

411EXTENDING FLASH PROFESSIONALswfPanel objectLast updated 5/2/2011ReturnsEither null or a string that is returned by the function call. The function

412EXTENDING FLASH PROFESSIONALswfPanel objectLast updated 5/2/2011function callMyPanel(panelName, arg) { if(fl.swfPanels.length > 0){ for(x = 0

413EXTENDING FLASH PROFESSIONALswfPanel objectLast updated 5/2/2011fl.trace(fl.swfPanels[0].name);See alsoswfPanel.path, fl.swfPanelsswfPanel.pathAvai

414EXTENDING FLASH PROFESSIONALswfPanel objectLast updated 5/2/20114 Run the script below from the Commands menu (put a JSFL file containing the code

415Last updated 5/2/2011Chapter 40: SymbolInstance objectInheritance Element object > Instance object > SymbolInstance objectAvailabilityFlas

416EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011symbolInstance.accNameAvailabilityFlash MX 2004.Usage symbolInstance.accNameD

417EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011 fl.getDocumentDOM().selection[0].accName = "Home Button";symbolIns

22EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011ParametersNone. ReturnsNothing. DescriptionFunction; called when the

418EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011Usage symbolInstance.bitmapRenderModeDescriptionProperty; a string that sets

419EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011symbolInstance.buttonTrackingAvailabilityFlash MX 2004.Usage symbolInstance.b

420EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011DescriptionProperty; an integer that is part of the color transformation for

421EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011symbolInstance.colorBluePercentAvailabilityFlash MX 2004.Usage symbolInstance

422EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011ExampleThe following example sets the colorGreenPercent of the selected symbo

423EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011Usage symbolInstance.colorRedPercentDescriptionProperty; part of the color tr

424EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011ExampleThe following example traces the name of the filter at index 0. If it

425EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011ExampleThe following example checks to see if the children of the object are

426EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011 fl.getDocumentDOM().selection[0].shortcut = "Ctrl+i";symbolInstanc

427EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011symbolInstance.tabIndexAvailabilityFlash MX 2004.Usage symbolInstance.tabInde

23EXTENDING FLASH PROFESSIONALTop-Level Functions and MethodsLast updated 5/2/2011setCursor()AvailabilityFlash MX 2004.Usage function setCursor() {

428EXTENDING FLASH PROFESSIONALSymbolInstance objectLast updated 5/2/2011DescriptionProperty; a boolean value that sets the Visible property of an obj

429Last updated 5/2/2011Chapter 41: SymbolItem objectInheritance Item object > SymbolItem objectAvailabilityFlash MX 2004.DescriptionThe SymbolI

430EXTENDING FLASH PROFESSIONALSymbolItem objectLast updated 5/2/2011Returns Nothing. DescriptionMethod; converts a symbol item in the library to a co

431EXTENDING FLASH PROFESSIONALSymbolItem objectLast updated 5/2/2011ParametersoutputURI A string, expressed as a file:/// URI, that specifies the SW

432EXTENDING FLASH PROFESSIONALSymbolItem objectLast updated 5/2/2011ExampleThe following example specifies the locations of the 9-slice guides: fl.ge

433EXTENDING FLASH PROFESSIONALSymbolItem objectLast updated 5/2/2011symbolItem.sourceLibraryNameAvailabilityFlash MX 2004.Usage symbolItem.sourceLibr

434EXTENDING FLASH PROFESSIONALSymbolItem objectLast updated 5/2/2011DescriptionRead-only property; a Timeline object. ExampleThe following example ob

435Last updated 5/2/2011Chapter 42: Text objectInheritance Element object > Text objectAvailabilityFlash MX 2004.DescriptionThe Text object repr

436EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011text.accNameAvailabilityFlash MX 2004.Usage text.accNameDescriptionProperty; a string t

437EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011 var doc = fl.getDocumentDOM(); var theName = doc.selection[0].accName; The following

24Last updated 5/2/2011Chapter 3: actionsPanel objectAvailabilityFlash CS3 Professional.DescriptionThe actionsPanel object, which represents the curre

438EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011text.autoExpandAvailabilityFlash MX 2004.Usage text.autoExpandDescriptionProperty; a Bo

439EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011ExampleThe following example retrieves the description of the object: var doc = fl.getD

440EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011ExampleThe following example assumes that the first or only item in the current selecti

441EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011ExampleThe following example shows how you can use the customThicknessSharpness value t

442EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011ExampleThe following example gets the font size of the currently selected text field an

443EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011text.lengthAvailabilityFlash MX 2004.Usage text.lengthDescriptionRead-only property; an

444EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011This property works only with input text; if used with other text types, the property g

445EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011text.scrollableAvailabilityFlash MX 2004.Usage text.scrollableDescriptionProperty; a Bo

446EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011DescriptionProperty; a zero-based integer that specifies the end of a text subselection

447EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011For a list of possible values for attrName and attrValue, see the Property summary for

25EXTENDING FLASH PROFESSIONALactionsPanel objectLast updated 5/2/2011ExampleThe following example displays the class assigned to the variable myVar,

448EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011DescriptionProperty; changes the text string within this Text object. If you omit the o

449EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011text.silentAvailabilityFlash MX 2004.Usage text.silentDescriptionProperty; a Boolean va

450EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011Usage text.textRunsDescriptionRead-only property; an array of TextRun objects (see Text

451EXTENDING FLASH PROFESSIONALText objectLast updated 5/2/2011text.variableNameAvailabilityFlash MX 2004.Usage text.variableNameDescriptionProperty;

452Last updated 5/2/2011Chapter 43: TextAttrs objectAvailabilityFlash MX 2004.DescriptionThe TextAttrs object contains all the properties of text that

453EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011textAttrs.aliasTextAvailabilityFlash MX 2004.Usage textAttrs.aliasTextDescriptionP

454EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011DescriptionProperty; a Boolean value that determines whether Flash uses (true) or

455EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011textAttrs.characterSpacingAvailabilityFlash MX 2004. Deprecated in Flash 8 in favo

456EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011DescriptionProperty; the color of the fill, in one of the following formats:• A st

457EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011textAttrs.leftMarginAvailabilityFlash MX 2004.Usage textAttrs.leftMarginDescriptio

26EXTENDING FLASH PROFESSIONALactionsPanel objectLast updated 5/2/2011ParametersNone.ReturnsA string that contains the text that is currently selected

458EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011DescriptionProperty; an integer that specifies the line spacing (leading) of the p

459EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011textAttrs.sizeAvailabilityFlash MX 2004.Usage textAttrs.sizeDescriptionProperty; a

460EXTENDING FLASH PROFESSIONALTextAttrs objectLast updated 5/2/2011DescriptionProperty; a string that represents the URL property of the text field.

461Last updated 5/2/2011Chapter 44: TextRun objectAvailabilityFlash MX 2004.DescriptionThe TextRun object represents a run of characters that have att

462EXTENDING FLASH PROFESSIONALTextRun objectLast updated 5/2/2011DescriptionProperty; the text contained in the TextRun object.ExampleThe following e

463Last updated 5/2/2011Chapter 45: Timeline objectAvailabilityFlash MX 2004.DescriptionThe Timeline object represents the Flash timeline, which can b

464EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011timeline.deleteLayer() Deletes a layer.timeline.duplicateLayers() Duplicates the se

465EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011Property summary The following properties are available for the Timeline object:tim

466EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011Usage timeline.addNewLayer([name] [, layerType [, bAddAbove]]) Parametersname A st

467EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011ExampleThe following example clears the frames from Frame 6 up to, but not includin

27EXTENDING FLASH PROFESSIONALactionsPanel objectLast updated 5/2/2011actionsPanel.hasSelection()AvailabilityFlash CS3 Professional.Usage actionsPanel

468EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011ParametersstartFrameIndex A zero-based index that specifies the starting frame to

469EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011 fl.getDocumentDOM().getTimeline().convertToKeyframes();The following example conve

470EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011Usage timeline.copyLayers([startLayerIndex [, endLayerIndex]])ParametersstartLayerI

471EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011 fl.getDocumentDOM().getTimeline().copyMotion(); See alsotimeline.copyMotionAsAS3()

472EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011endFrame Specifies the frame at which to stop creating motion objects; the range o

473EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011ExampleThe following example converts the shape in the first frame up to, but not i

474EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011timeline.cutFrames()AvailabilityFlash MX 2004.Usage timeline.cutFrames([startFrameI

475EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011endLayerIndex Optional. A zero-based index that specifies the layer at which to st

476EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011timeline.duplicateLayers()AvailabilityFlash CS5.5 Professional.Usage timeline.dupli

477EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011bRecurseNestedParents A Boolean value that, if set to true, causes all the layers

vEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011document.align() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28EXTENDING FLASH PROFESSIONALactionsPanel objectLast updated 5/2/2011DescriptionMethod; replaces the currently selected text with the text specified

478EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011DescriptionMethod; finds an array of indexes for the layers with the given name. Th

479EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011endFrameIndex A zero-based index that specifies the end of the range of frames to

480EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011timeline.getLayerProperty()AvailabilityFlash MX 2004.Usage timeline.getLayerPropert

481EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011 var timeline = fl.getDocumentDOM().getTimeline(); timeline.setSelectedFrames(5,1

482EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011If the specified or selected frame is a regular frame, the keyframe is inserted at

483EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011If no parameters are specified, this method works as follows:• If one or more frame

484EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011ParametersframeNumIndex A zero-based index that specifies the frame index at which

485EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011Usage timeline.layersDescriptionRead-only property; an array of layer objects. Exam

486EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011ExampleThe following example retrieves the first scene name: var sceneName = fl.get

487EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011Usage timeline.pasteLayers([layerIndex])ParameterslayerIndex Optional. A zero-base

29EXTENDING FLASH PROFESSIONALactionsPanel objectLast updated 5/2/2011actionsPanel.setSelection()AvailabilityFlash CS3 Professional.Usage actionsPanel

488EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011 fl.getDocumentDOM().getTimeline().pasteMotion();See alsotimeline.copyMotion()timel

489EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011ParametersstartFrame Specifies the first frame at which to start removing motion o

490EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011Returns Nothing. DescriptionMethod; moves the first specified layer before or after

491EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011timeline.selectAllFrames()AvailabilityFlash MX 2004.Usage timeline.selectAllFrames(

492EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011DescriptionMethod; sets the property of the Frame object for the selected frames. E

493EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011timeline.setLayerProperty()AvailabilityFlash MX 2004.Usage timeline.setLayerPropert

494EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011Returns Nothing. DescriptionMethod; selects a range of frames in the current layer

495EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011ExampleThe following example selects the top layer: fl.getDocumentDOM().getTimelin

496EXTENDING FLASH PROFESSIONALTimeline objectLast updated 5/2/2011DescriptionMethod; starts automatic playback of the timeline if it is currently pla

497Last updated 5/2/2011Chapter 46: ToolObj objectAvailabilityFlash MX 2004.DescriptionA ToolObj object represents an individual tool in the Tools pan

30EXTENDING FLASH PROFESSIONALactionsPanel objectLast updated 5/2/2011DescriptionMethod; clears any text in the Actions panel and then adds the text s

498EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011Usage toolObj.depthDescriptionRead-only property; an integer that specifies the dept

499EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011bEnable A Boolean value that determines whether to enable (true) or disable (false)

500EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011ExampleThe following commands in the mouseDown() method of a tool’s JavaScript file

501EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011DescriptionMethod; sets the string that appears in the pop-up menu as the name for t

502EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011 <properties> <property name="Style" variable="style&q

503EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011ExampleThe following example specifies that the shape Property inspector should be u

504EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011DescriptionMethod; sets the tooltip that appears when the mouse is held over the too

505EXTENDING FLASH PROFESSIONALToolObj objectLast updated 5/2/2011bShow A Boolean value that determines whether to show or hide the specified control

506Last updated 5/2/2011Chapter 47: Tools objectAvailabilityFlash MX 2004.DescriptionThe Tools object is accessible from the flash object (fl.tools).

507EXTENDING FLASH PROFESSIONALTools objectLast updated 5/2/2011Usage tools.activeToolDescriptionRead-only property; returns the ToolObj object for th

31Last updated 5/2/2011Chapter 4: BitmapInstance objectInheritance Element object > Instance object > BitmapInstance objectAvailabilityFlash

508EXTENDING FLASH PROFESSIONALTools objectLast updated 5/2/2011DescriptionMethod; takes two points and returns a new adjusted or constrained point. I

509EXTENDING FLASH PROFESSIONALTools objectLast updated 5/2/2011ExampleThe following example displays the integer value of the most recently pressed k

510EXTENDING FLASH PROFESSIONALTools objectLast updated 5/2/2011tools.penLocAvailabilityFlash MX 2004.Usage tools.penLocDescriptionRead-only property;

511EXTENDING FLASH PROFESSIONALTools objectLast updated 5/2/2011tools.setCursor()AvailabilityFlash MX 2004.Usage tools.setCursor(cursor)Parameterscurs

512EXTENDING FLASH PROFESSIONALTools objectLast updated 5/2/2011 var isShiftDown = fl.tools.shiftIsDown;tools.snapPoint()AvailabilityFlash MX 2004.Usa

513Last updated 5/2/2011Chapter 48: Vertex objectAvailabilityFlash MX 2004.DescriptionThe Vertex object is the part of the shape data structure that h

514EXTENDING FLASH PROFESSIONALVertex objectLast updated 5/2/2011 var shape = fl.getDocumentDOM().selection[0]; var hEdge = shape.edges[0].getHalfEd

515EXTENDING FLASH PROFESSIONALVertex objectLast updated 5/2/2011DescriptionRead-only property; the x location of the vertex, in pixels. ExampleThe fo

516Last updated 5/2/2011Chapter 49: VideoItem objectInheritance Item object > VideoItem objectAvailabilityFlash MX 2004.DescriptionThe VideoItem

517EXTENDING FLASH PROFESSIONALVideoItem objectLast updated 5/2/2011ReturnsA Boolean value of true if the file is exported successfully; false otherwi

32EXTENDING FLASH PROFESSIONALBitmapInstance objectLast updated 5/2/2011The byte array is meaningful only when referenced by a DLL or shared library.

518EXTENDING FLASH PROFESSIONALVideoItem objectLast updated 5/2/2011DescriptionRead-only property: a Boolean value of true if the file that was import

519EXTENDING FLASH PROFESSIONALVideoItem objectLast updated 5/2/2011ExampleThe following example displays the name and source file path of any items i

520Last updated 5/2/2011Chapter 50: XMLUI objectAvailabilityFlash MX 2004.DescriptionFlash 8 supports custom dialog boxes written in a subset of the X

521EXTENDING FLASH PROFESSIONALXMLUI objectLast updated 5/2/2011ParametersNone. Returns Nothing. DescriptionMethod; closes the current XMLUI dialog bo

522EXTENDING FLASH PROFESSIONALXMLUI objectLast updated 5/2/2011ReturnsA string that represents the value of the specified property. In cases where yo

523EXTENDING FLASH PROFESSIONALXMLUI objectLast updated 5/2/2011xmlui.getEnabled()AvailabilityFlash 8.Usage xmlui.getEnabled(controlID)Parameterscontr

524EXTENDING FLASH PROFESSIONALXMLUI objectLast updated 5/2/2011 var isVisible = fl.xmlui.getVisible("myListBox"); fl.trace(isVisible);See

525EXTENDING FLASH PROFESSIONALXMLUI objectLast updated 5/2/2011elementItem A JavaScript object with a string property named label and an optional st

526EXTENDING FLASH PROFESSIONALXMLUI objectLast updated 5/2/2011 var nameArray = new Array("January", "February", "March"

527EXTENDING FLASH PROFESSIONALXMLUI objectLast updated 5/2/2011ParameterscontrolID A string that specifies the ID attribute of the control you want

33EXTENDING FLASH PROFESSIONALBitmapInstance objectLast updated 5/2/2011bitmapInstance.setBits()AvailabilityFlash MX 2004.Usage bitmapInstance.setBits

528Last updated 5/2/2011Chapter 51: C-Level ExtensibilityThis chapter describes the C-level extensibility mechanism, which lets you implement Adobe Fl

529EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011• Mac OS X:Macintosh HD/Users/username/Library/Application Support/Adobe/Fla

530EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011 /* JSBool JS_DefineFunction(unsigned short *name, JSNative call, unsigned in

531EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011 /* long JS_GetArrayLength(JSContext *cx, JSObject *obj) */ #define JS_G

532EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011 #ifdef _WIN32 # ifndef _MAC // Windows __declspec( dllexport ) void MM

533EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011 // Source code in C // Save the DLL or shared library with the name "

534EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011typedef struct JSObject JSObjectA pointer to this opaque data type passes to

535EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011typedef JSBool (*JSNative)(JSContext *cx, JSObject *obj, unsigned int argc, j

536EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011DescriptionMethod; extracts a function argument from a jsval structure, conve

537EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011ArgumentsJSContext *cx, jsval v, double *dp • The cx argument is the opaque J

34EXTENDING FLASH PROFESSIONALBitmapInstance objectLast updated 5/2/2011ExampleThe following code gets the height of the bitmap in pixels: // Get the

538EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011ReturnsA Boolean value: JS_TRUE indicates success; JS_FALSE indicates failure

539EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011JSVal JS_BooleanToValue()Usage jsval JS_BooleanToValue(JSBool bv);Description

540EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011ReturnsA JSVal structure that contains the integer that passed to the functio

541EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011ArgumentsJSContext *cx, unsigned int length, jsval *v• The cx argument is the

542EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011• The vp argument is a pointer to a jsval where the contents of the jsval str

543EXTENDING FLASH PROFESSIONALC-Level ExtensibilityLast updated 5/2/2011• The sz argument is the size of the string, in bytes. If sz is 0, the length

35Last updated 5/2/2011Chapter 5: BitmapItem objectInheritance Item object > BitmapItem object AvailabilityFlash MX 2004.DescriptionA BitmapItem

36EXTENDING FLASH PROFESSIONALBitmapItem objectLast updated 5/2/2011bitmapItem.allowSmoothingAvailabilityFlash MX 2004. Usage bitmapItem.allowSmoothin

37EXTENDING FLASH PROFESSIONALBitmapItem objectLast updated 5/2/2011ParametersfileURI A string, expressed as a file:/// URI, that specifies the path

viEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011document.exitEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

38EXTENDING FLASH PROFESSIONALBitmapItem objectLast updated 5/2/2011DescriptionRead-only property; a string that specifies whether the specified item

39EXTENDING FLASH PROFESSIONALBitmapItem objectLast updated 5/2/2011ExampleAssuming the first item in the Library is a bitmap item, the following code

40EXTENDING FLASH PROFESSIONALBitmapItem objectLast updated 5/2/2011DescriptionRead-only property; a string, expressed as a file:/// URI, that represe

41EXTENDING FLASH PROFESSIONALBitmapItem objectLast updated 5/2/2011DescriptionProperty; a Boolean value that specifies whether to use the default imp

42Last updated 5/2/2011Chapter 6: CompiledClipInstance objectInheritance Element object > Instance object > CompiledClipInstance objectAvaila

43EXTENDING FLASH PROFESSIONALCompiledClipInstance objectLast updated 5/2/2011 // Get the name of the object. var theName = fl.getDocumentDOM().sele

44EXTENDING FLASH PROFESSIONALCompiledClipInstance objectLast updated 5/2/2011compiledClipInstance.forceSimpleAvailabilityFlash MX 2004.Usage compiled

45EXTENDING FLASH PROFESSIONALCompiledClipInstance objectLast updated 5/2/2011Usage compiledClipInstance.silentDescriptionProperty; a Boolean value th

46Last updated 5/2/2011Chapter 7: compilerErrors objectAvailabilityFlash CS3 Professional.DescriptionThe compilerErrors object, which represents the C

47EXTENDING FLASH PROFESSIONALcompilerErrors objectLast updated 5/2/2011compilerErrors.save()AvailabilityFlash CS3 Professional.Usage compilerErrors.s

viiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011document.punch() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

48Last updated 5/2/2011Chapter 8: ComponentInstance objectInheritance Element object > Instance object > SymbolInstance object > Component

49Last updated 5/2/2011Chapter 9: componentsPanel objectAvailabilityFlash MX 2004.DescriptionThe componentsPanel object, which represents the Componen

50EXTENDING FLASH PROFESSIONALcomponentsPanel objectLast updated 5/2/2011 fl.componentsPanel.addItemToDocument({x:0, y:0}, "User Interface",

51Last updated 5/2/2011Chapter 10: Contour objectAvailabilityFlash MX 2004.DescriptionA Contour object represents a closed path of half edges on the b

52EXTENDING FLASH PROFESSIONALContour objectLast updated 5/2/2011contour.getHalfEdge()AvailabilityFlash MX 2004.Usagecontour.getHalfEdge()ParametersNo

53EXTENDING FLASH PROFESSIONALContour objectLast updated 5/2/2011contour.interiorAvailabilityFlash MX 2004.Usagecontour.interiorDescriptionRead-only p

54EXTENDING FLASH PROFESSIONALContour objectLast updated 5/2/2011 var elt = fl.getDocumentDOM().selection[0]; elt.beginEdit(); var contourArray

55Last updated 5/2/2011Chapter 11: Document objectAvailabilityFlash MX 2004.DescriptionThe Document object represents the Stage. That is, only FLA fil

56EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.canTestScene() Determines whether you can use the document.testScene() meth

57EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.exitEditMode() Exits from symbol-editing mode and returns focus to the next

viiiEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011document.setTextRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.match() Makes the size of the selected objects the same. document.mouseClic

59EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.selectAll() Selects all items on the Stage; equivalent to pressing Control+

60EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Property summary You can use the following properties with the Document object. docu

61EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.as3StrictMode A Boolean value that specifies whether the ActionScript 3.0 c

62EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.accNameAvailabilityFlash MX 2004.Usage document.accNameDescriptionProperty;

63EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ReturnsNothing.DescriptionMethod; stores specified data with a document. Data is wri

64EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.addFilter()AvailabilityFlash 8.Usage document.addFilter(filterName)Paramete

65EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; adds an item from any open document or library to the specified D

66EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.addNewOval()AvailabilityFlash MX 2004.Usage document.addNewOval(boundingRec

67EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ParametersboundingRectangle A rectangle that specifies the bounds within which the

ixEXTENDING FLASH PROFESSIONALContentsLast updated 5/2/2011edge.isLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011bSuppressStroke A Boolean value that, if set to true, causes the method to create t

69EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example adds a new publish profile with a default name and then

70EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011DescriptionMethod; adds a new rectangle or rounded rectangle, fitting it into the sp

71EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011The following example adds a new scene using the default naming convention. If only

72EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011Parametersalignmode A string that specifies how to align the selection. Acceptable

73EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011 if(fl.getDocumentDOM().allowScreens()) { fl.trace("screen outline is availa

74EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011ExampleThe following example specifies that instances placed on the Stage in the cur

75EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011document.as3StrictModeAvailabilityFlash CS3 Professional.Usage document.as3StrictMod

76EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011See alsodocument.as3StrictModedocument.asVersionAvailabilityFlash CS3 Professional.U

77EXTENDING FLASH PROFESSIONALDocument objectLast updated 5/2/2011The following example sets the autoLabel property to true, telling Flash to automati