Detailed instructions for use are in the User's Guide.
Flash JavaScript Dictionary
Trademarks Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware, Authorware Star, Backstage, Bright Tiger, Clustercats, ColdFusion, Contribute, Design In Motion, Director, Dream Templates, Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, Flash Lite, Flex, Fontographer, FreeHand, Generator, HomeSite, JFusion, JRun, Kawa, Know Your Site, Knowledge Objects, Knowledge Stream, Knowledge Track, LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Action!, Macromedia Breeze, Macromedia Flash, Macromedia M Logo and Design, Macromedia Spectra, Macromedia xRes Logo and Design, MacroModel, Made with Macromedia, Made with Macromedia Logo and Design, MAGIC Logo and Design, Mediamaker, Movie Critic, Open Sesame!, Roundtrip, Roundtrip HTML, Shockwave, Sitespring, SoundEdit, Titlemaker, UltraDev, Web Design 101, what the web can be, and Xtra are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. Third-Party Information This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third-party sites. Speech compression and decompression technology licensed from Nellymoser, Inc. (www.nellymoser.com). SorensonTM SparkTM video compression and decompression technology licensed from Sorenson Media, Inc.
Opera ® browser Copyright © 1995-2002 Opera Software ASA and its suppliers. All rights reserved. Apple Disclaimer APPLE COMPUTER, INC. MAKES NO WARRANTIES, EITHER EXPRESS OR IMPLIED, REGARDING THE ENCLOSED COMPUTER SOFTWARE PACKAGE, ITS MERCHANTABILITY OR ITS FITNESS FOR ANY PARTICULAR PURPOSE. THE EXCLUSION OF IMPLIED WARRANTIES IS NOT PERMITTED BY SOME STATES. THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. THIS WARRANTY PROVIDES YOU WITH SPECIFIC LEGAL RIGHTS. THERE MAY BE OTHER RIGHTS THAT YOU MAY HAVE WHICH VARY FROM STATE TO STATE. Copyright © 2004 Macromedia, Inc. All rights reserved. This manual may not be copied, photocopied, reproduced, translated, or converted to any electronic or machine-readable form in whole or in part without prior written approval of Macromedia, Inc. Acknowledgments Director: Erick Vera Project Management: Julee Burdekin, Erick Vera Writing: Jay Armstrong, Jody Bleyle, Mary Burger, Francis Cheng, Jen deHaan, Stephanie Gowin, Phillip Heinz, Shimul Rahim, Samuel R. Neff Managing Editor: Rosana Francescato Editing: Mary Ferguson, Mary Kraemer, Noreen Maher, Antonio Padial, Lisa Stanziano, Anne Szabla Production Management: Patrice O'Neill Media Design and Production: Adam Barnett, Christopher Basmajian, Aaron Begley, John Francis Second Edition: June 2004 Macromedia, Inc. 600 Townsend St. San Francisco, CA 94103
CONTENTS
CHAPTER 1: Introduction.
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Overview of the Macromedia Flash JavaScript API . . . . . . . . . . . . . . . . . . . . . . . . 17 The Flash Document Object Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 The Document object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Specifying the target of an action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Summary of the DOM structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 The PolyStar example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
CHAPTER 2: Top-level functions CHAPTER 3: Objects
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
BitmapInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 bitmapInstance.getBits(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 bitmapInstance.hPixels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 bitmapInstance.setBits() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 bitmapInstance.vPixels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 BitmapItem object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 bitmapItem.allowSmoothing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 bitmapItem.compressionType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 bitmapItem.quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 bitmapItem.useImportedJPEGQuality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 CompiledClipInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 compiledClipInstance.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 compiledClipInstance.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 compiledClipInstance.description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 compiledClipInstance.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 compiledClipInstance.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 compiledClipInstance.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 compiledClipInstance.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 ComponentInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 componentInstance.parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 componentsPanel object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 componentsPanel.addItemToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
3
Contour object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 contour.getHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 contour.interior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 contour.orientation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Document object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 document.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 document.addDataToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 document.addDataToSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 document.addItem(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 document.addNewLine() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 document.addNewOval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 document.addNewPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 document.addNewRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 document.addNewScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 document.addNewText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 document.align() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 document.allowScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 document.arrange() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 document.autoLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 document.backgroundColor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 document.breakApart(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 document.canEditSymbol() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 document.canRevert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 document.canTestMovie() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 document.canTestScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 document.clipCopy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 document.clipCut() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 document.clipPaste() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 document.close() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 document.convertLinesToFills() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 document.convertToSymbol() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 document.currentPublishProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 document.currentTimeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 document.deletePublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 document.deleteScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 document.deleteSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 document.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 document.distribute(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 document.distributeToLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 document.documentHasData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 document.duplicatePublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 document.duplicateScene(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 document.duplicateSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 document.editScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 document.enterEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 document.exitEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 document.exportPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 document.exportSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 document.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 document.frameRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
4
Contents
document.getAlignToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 document.getCustomFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 document.getCustomStroke(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 document.getDataFromDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 document.getElementProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 document.getElementTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 document.getSelectionRect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ...
