Macromedia FLASH MX FLASH JAVASCRIPT DICTIONARY User Manual

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

Sorenson™ Spark™ 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

CHAPTER 3: Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

document.getTextString(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

document.getTimeline(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

document.getTransformationPoint(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

document.group() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

document.height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

document.importPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

document.importSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

document.library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

document.livePreview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

document.match() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

document.mouseClick() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

document.mouseDblClk() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

document.moveSelectedBezierPointsBy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

document.moveSelectionBy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

document.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

document.optimizeCurves() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

document.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

document.publish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

document.publishProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

document.removeDataFromDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

document.removeDataFromSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

document.renamePublishProfile(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

document.renameScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

document.reorderScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

document.resetTransformation(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

document.revert(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

document.rotateSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

document.save() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

document.saveAndCompact() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

document.scaleSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

document.screenOutline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

document.selectAll(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

document.selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

document.selectNone(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

document.setAlignToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

document.setCustomFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

document.setCustomStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

document.setElementProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

document.setElementTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

document.setFillColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

document.setInstanceAlpha() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

document.setInstanceBrightness(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

document.setInstanceTint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Contents 5

document.setSelectionBounds() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

document.setSelectionRect(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

document.setStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

document.setStrokeColor(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

document.setStrokeSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

document.setStrokeStyle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

document.setTextRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

document.setTextSelection(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

document.setTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

document.setTransformationPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

document.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

document.skewSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

document.smoothSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

document.space() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

document.straightenSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

document.swapElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

document.testMovie(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

document.testScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

document.timelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

document.traceBitmap(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

document.transformSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

document.unGroup(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

document.unlockAllElements() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

document.viewMatrix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

document.width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

document.xmlPanel() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

drawingLayer object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

drawingLayer.beginDraw() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

drawingLayer.beginFrame() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

drawingLayer.cubicCurveTo(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

drawingLayer.curveTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

drawingLayer.drawPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

drawingLayer.endDraw() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

drawingLayer.endFrame() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

drawingLayer.lineTo(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

drawingLayer.moveTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

drawingLayer.newPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

drawingLayer.setColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Edge object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

edge.getControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

edge.getHalfEdge(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

edge.id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

edge.isLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

edge.setControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

edge.splitEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

6 Contents

Effect object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

effect.effectName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

effect.groupName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

effect.sourceFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

effect.symbolType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

effect.useXMLToUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Element object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

element.depth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

element.elementType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

element.getPersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

element.hasPersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

element.height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

element.left. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

element.locked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

element.matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

element.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

element.removePersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

element.setPersistentData(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

element.top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

element.width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

EmbeddedVideoInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Fill object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

fill.color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

fill.colorArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

fill.matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

fill.posArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

fill.style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

flash object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

fl.activeEffect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

fl.browseForFileURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

fl.closeAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

fl.closeDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

fl.componentsPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

fl.configDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

fl.configURI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

fl.createDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

fl.createNewDocList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

fl.createNewDocListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

fl.createNewTemplateList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

fl.documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

fl.drawingLayer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

fl.effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

fl.enableImmediateUpdates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

fl.fileExists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

fl.findDocumentIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

fl.getDocumentDOM() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

fl.mapPlayerURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

fl.Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

fl.mruRecentFileList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

fl.mruRecentFileListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Contents 7

fl.openDocument(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

fl.openProject(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

fl.openScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

fl.outputPanel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

fl.quit(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

fl.reloadEffects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

fl.reloadTools() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

fl.revertDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

fl.runScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

fl.saveAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

fl.saveDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

fl.saveDocumentAs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

fl.setActiveWindow() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

fl.tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

fl.trace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

fl.version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

fl.xmlui. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

folderItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

fontItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Frame object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

frame.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

frame.duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

frame.elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

frame.labelType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

frame.motionTweenOrientToPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

frame.motionTweenRotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

frame.motionTweenRotateTimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

frame.motionTweenScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

frame.motionTweenSnap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

frame.motionTweenSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

frame.name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

frame.shapeTweenBlend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

frame.soundEffect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

frame.soundLibraryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

frame.soundLoop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

frame.soundLoopMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

frame.soundName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

frame.soundSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

frame.startFrame. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

frame.tweenEasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

frame.tweenType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

HalfEdge object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

halfEdge.getEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

halfEdge.getNext() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

halfEdge.getOppositeHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

halfEdge.getPrev() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

halfEdge.getVertex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

halfEdge.id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

8 Contents

Instance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

instance.instanceType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

instance.libraryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Item object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

item.addData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

item.getData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

item.hasData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

item.itemType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

item.linkageClassName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

item.linkageExportForAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

item.linkageExportForRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

item.linkageExportInFirstFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

item.linkageIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

item.linkageImportForRS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

item.linkageURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

item.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

item.removeData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Layer object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

layer.color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

layer.frameCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

layer.frames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

layer.height. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

layer.layerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

layer.locked. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

layer.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

layer.outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

layer.parentLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

layer.visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

library object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

library.addItemToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

library.addNewItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

library.deleteItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

library.duplicateItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

library.editItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

library.expandFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

library.findItemIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

library.getItemProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

library.getItemType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

library.getSelectedItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

library.importEmbeddedSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

library.itemExists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

library.items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

library.moveToFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

library.newFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

library.renameItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

library.selectAll(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

library.selectItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

library.selectNone(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

library.setItemProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

library.updateItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Contents 9

LinkedVideoInstance object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Math object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Math.concatMatrix() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Math.invertMatrix() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Math.pointDistance(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Matrix object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

matrix.a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

matrix.b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

matrix.c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

matrix.d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

matrix.tx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

matrix.ty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

outputPanel object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

outputPanel.clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

outputPanel.save() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

outputPanel.trace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Parameter object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

parameter.category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

parameter.insertItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

parameter.listIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

parameter.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

parameter.removeItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

parameter.value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

parameter.valueType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

parameter.verbose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Path object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

path.addCubicCurve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

path.addCurve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

path.addPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

path.clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

path.close() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

path.makeShape(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

path.newContour(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

path.nPts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Screen object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

screen.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

screen.childScreens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

screen.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

screen.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

screen.hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

screen.instanceName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

screen.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

screen.nextScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

screen.parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

screen.parentScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

screen.prevScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

screen.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

screen.tabIndex. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

screen.timeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

10 Contents

ScreenOutline object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

screenOutline.copyScreenFromFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

screenOutline.currentScreen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

screenOutline.deleteScreen(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

screenOutline.duplicateScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

screenOutline.getSelectedScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

screenOutline.insertNestedScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

screenOutline.insertScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

screenOutline.moveScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

screenOutline.renameScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

screenOutline.rootScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

screenOutline.screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

screenOutline.setCurrentScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

screenOutline.setScreenProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

screenOutline.setSelectedScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

Shape object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

shape.beginEdit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

shape.contours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

shape.deleteEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

shape.edges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

shape.endEdit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

shape.isGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

shape.vertices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

SoundItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

soundItem.bitRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

soundItem.bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

soundItem.compressionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

soundItem.convertStereoToMono. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

soundItem.quality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

soundItem.sampleRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

soundItem.useImportedMP3Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

Stroke object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

stroke.breakAtCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

stroke.color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

stroke.curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

stroke.dash1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

stroke.dash2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

stroke.density . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

stroke.dotSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

stroke.dotSpace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

stroke.hatchThickness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

stroke.jiggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

stroke.length. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

stroke.pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

stroke.rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

stroke.space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

stroke.style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

stroke.thickness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

Contents 11

stroke.variation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

stroke.waveHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

stroke.waveLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

SymbolInstance object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

symbolInstance.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

symbolInstance.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

symbolInstance.buttonTracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

symbolInstance.colorAlphaAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

symbolInstance.colorAlphaPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

symbolInstance.colorBlueAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

symbolInstance.colorBluePercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

symbolInstance.colorGreenAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

symbolInstance.colorGreenPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

symbolInstance.colorMode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

symbolInstance.colorRedAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

symbolInstance.colorRedPercent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

symbolInstance.description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

symbolInstance.firstFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

symbolInstance.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

symbolInstance.loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

symbolInstance.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

symbolInstance.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

symbolInstance.symbolType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

symbolInstance.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

SymbolItem object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

symbolItem.convertToCompiledClip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

symbolItem.exportSWC(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

symbolItem.exportSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

symbolItem.sourceAutoUpdate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

symbolItem.sourceFilePath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

symbolItem.sourceLibraryName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

symbolItem.symbolType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

symbolItem.timeline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

TextAttrs object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

textAttrs.aliasText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

textAttrs.alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

textAttrs.autoKern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

textAttrs.bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

textAttrs.characterPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

textAttrs.characterSpacing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

textAttrs.face. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

textAttrs.fillColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

textAttrs.indent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

textAttrs.italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

textAttrs.leftMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

textAttrs.lineSpacing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

textAttrs.rightMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

textAttrs.rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

12 Contents

textAttrs.size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

textAttrs.target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

textAttrs.url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Text object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

text.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

text.autoExpand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

text.border . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

text.description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

text.embeddedCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

text.embedRanges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

text.getTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

text.getTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

text.length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

text.lineType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

text.maxCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

text.orientation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

text.renderAsHTML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

text.scrollable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

text.selectable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

text.selectionEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

text.selectionStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

text.setTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

text.setTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

text.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

text.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

text.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

text.textRuns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

text.textType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

text.useDeviceFonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

text.variableName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

TextRun object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

textRun.characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

textRun.textAttrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

Timeline object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

timeline.addMotionGuide() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

timeline.addNewLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

timeline.clearFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

timeline.clearKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

timeline.convertToBlankKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

timeline.convertToKeyframes(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

timeline.copyFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

timeline.createMotionTween() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

timeline.currentFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

timeline.currentLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

timeline.cutFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

timeline.deleteLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

timeline.expandFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

timeline.findLayerIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

timeline.frameCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

timeline.getFrameProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Contents 13

timeline.getLayerProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

timeline.getSelectedFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

timeline.getSelectedLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

timeline.insertBlankKeyframe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

timeline.insertFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

timeline.insertKeyframe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

timeline.layerCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

timeline.layers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

timeline.name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

timeline.pasteFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

timeline.removeFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

timeline.reorderLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

timeline.reverseFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

timeline.selectAllFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

timeline.setFrameProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

timeline.setLayerProperty(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

timeline.setSelectedFrames(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

timeline.setSelectedLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

timeline.showLayerMasking(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

ToolObj object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

toolObj.enablePIControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

toolObj.position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

toolObj.setIcon() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

toolObj.setMenuString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

toolObj.setOptionsFile(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

toolObj.setPI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

toolObj.setToolName(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

toolObj.setToolTip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

toolObj.showPIControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

toolObj.showTransformHandles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

Tools object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

tools.activeTool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

tools.altIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

tools.constrainPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

tools.ctlIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.getKeyDown() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.mouseIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.penDownLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

tools.penLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

tools.setCursor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

tools.shiftIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

tools.snapPoint(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

tools.toolObjs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Vertex object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

vertex.getHalfEdge(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

vertex.setLocation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

vertex.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

vertex.y. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

VideoItem object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

14 Contents

XMLUI object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

xmlui.accept(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

xmlui.cancel(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

xmlui.get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

xmlui.set() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

CHAPTER 4: C-Level Extensibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

How integrating C functions works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

C-level extensibility and the JavaScript interpreter . . . . . . . . . . . . . . . . . . . . . 370

Sample implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375

The C-level API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

JSBool JS_DefineFunction(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

unsigned short *JS_ValueToString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

JSBool JS_ValueToInteger() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

JSBool JS_ValueToDouble(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

JSBool JS_ValueToBoolean() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

JSBool JS_ValueToObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

JSBool JS_StringToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

JSBool JS_DoubleToValue(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

JSVal JS_BooleanToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

JSVal JS_BytesToValue(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

JSVal JS_IntegerToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

JSVal JS_ObjectToValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

unsigned short *JS_ObjectType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

JSObject *JS_NewArrayObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

long JS_GetArrayLength() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

JSBool JS_GetElement(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

JSBool JS_SetElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384

JSBool JS_ExecuteScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

Contents 15

16 Contents

CHAPTER 1

Introduction

The documents on this site assume you are familiar with JavaScript or ActionScript syntax and
with basic programming concepts such as functions, parameters, and data types. They also
assume that you understand the concept of working with objects and properties. For a reference
on JavaScript, see the Netscape JavaScript documentation.

Netscape DevEdge Online has a JavaScript Developer Central site (http://

developer.netscape.com/tech/javascript/index.html) that contains documentation and articles

useful for understanding JavaScript. The most valuable resource is the Core JavaScript Guide.

This chapter contains the following sections:

Overview of the Macromedia Flash JavaScript API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

The Flash Document Object Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

The PolyStar example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Overview of the Macromedia Flash JavaScript API

The ActionScript language lets you write scripts to perform actions in the Macromedia Flash
Player environment (that is, while a SWF file is playing). The Flash JavaScript API (JSAPI) lets
you write scripts to perform several actions in the Flash authoring environment (that is, while a
user has the Flash program open). You can write scripts that act like commands and scripts that
add tools to the Tools panel. These scripts can be used to help automate the authoring process.

The Flash JSAPI is designed to resemble the Macromedia Dreamweaver and Macromedia
Fireworks JavaScript API (which were designed based on the Netscape JavaScript API). The Flash
JSAPI is based on a Document Object Model (DOM), which allows Flash documents to be
accessed using JavaScript objects. The Flash JSAPI includes all elements of the Netscape
JavaScript API, plus the Flash DOM. These added objects and their methods and properties are
described in this document. You can use any of the elements of the native JavaScript language in a
Flash script, but only elements that make sense in the context of a Flash document will have
an effect.

17

You can use Macromedia Flash MX 2004 Professional or your preferred text editor to write or
edit Flash JavaScript (JSFL) files. If you use Flash Professional, these files have a .jsfl extension by
default. To make a script appear in the Commands menu, save its JSFL file in the following
folder:

• Windows 2000 or Windows XP:

C:\Documents and Settings\user\Local Settings\ Application Data\Macromedia\
Flash MX2004\language\Configuration\Commands

• Windows 98:

C:\Windows\Application Data\Macromedia\Flash MX 2004\language\
Configuration\Commands

• Mac OS X:

Hard Drive/Users/userName/Library/Application Support/Macromedia/Flash MX 2004/
language/Configuration/Commands

JSFL files that create tools need to be stored in the Tools folder, which can be found in the
following location:

• Windows 2000 or Windows XP:

C:\Documents and Settings\user\Local Settings\ Application Data\Macromedia\
Flash MX2004\language\Configuration\Tools

• Windows 98:

C:\Windows\Application Data\Macromedia\Flash MX 2004\language\Configuration\Tools

• Mac OS X:

Hard Drive/Users/userName/Library/Application Support/Macromedia/Flash MX 2004/
language/Configuration/Tools

If a JSFL file has other files that go with it, such as XML files, they should be stored in the same
directory as the JSFL file.

You can also create a JSFL file by selecting one or more commands in the History panel and then
clicking the Save As Command button in the History panel or selecting the Save As Command
from the Options pop-up menu. The command (JSFL) file is saved in the Commands folder. You
can then open the file and edit it the same as any other script file.

To run a script, do one of the following:

• Select Commands > Command Name.

• Select Commands > Run Command and then select the script to run.

To add a tool implemented in a JSFL file to the Flash Tools panel:

1.

Copy the JSFL file for the tool and any other associated files to the Tools folder.

2.

Select Edit > Customize Tools Panel (Windows) or Flash > Customize Tools Panel
(Macintosh).

3.

Add the tool to the list of available tools.

4.

Click OK.

18 Chapter 1: Introduction

You can embed individual JSAPI commands in ActionScript files by using the MMExecute()
command, which is documented in the Flash MX 2004 ActionScript Language Reference. However,
the

MMExecute() command has an effect only when it is used in the context of a custom user-

interface element, such as a component Property inspector, or a SWF panel within the authoring
environment. Even if called from ActionScript, JSAPI commands have no effect in Flash Player or
outside the authoring environment.

The JSAPI also contains a number of methods that let you implement extensibility using a
combination of JavaScript and custom C code. For more information, see Chapter 4, “C-Level

Extensibility,” on page 369.

Flash JavaScript objects contain properties and methods. Properties, each defined as a primitive
type such as Boolean, integer, array, float, or reference data types such as color, object, point, rect,
and String, are used to describe the object. Methods are used to perform a function on the object.
To access the properties or methods of an object, dot notation is used. Also, most objects have

getProperty() and setProperty() methods, which get the value for a specified property or set

the value for a specified property. Most methods take parameters that are used to specify different
options for the method.

The JavaScript interpreter in Flash is the Mozilla SpiderMonkey engine, version 1.5, which is
available on the web at http://www.mozilla.org/js/spidermonkey/. SpiderMonkey is one of the
two reference implementations of the JavaScript language developed by Mozilla.org. It is the same
engine that is embedded in the Mozilla browser.

SpiderMonkey implements the entire core JavaScript language as defined in the ECMA-262
specification. It is fully compliant with ECMA-262 Edition 3. Only the browser-specific host
objects, which are not part of the ECMA-262 specification, are not supported.

All “Core JavaScript” sections of Netscape’s JavaScript documentation at http://

devedge.netscape.com/central/javascript/ apply to the Flash JavaScript interpreter. All “Client-

Side JavaScript” sections do not apply because they only apply to browser environments.

SpiderMonkey is also used in Fireworks MX 2004, Dreamweaver MX 2004, Director MX 2004
and Flash Communication Server MX.

The Flash Document Object Model

The DOM for the Flash JavaScript API consists of a set of top-level functions (see “Top-level

functions” on page 25) and the top-level flash object. The

available to a script because it always exists when the Flash authoring environment is open. When
referring to this object, you can use

flash or fl. For example, to close all open files, you can use

either of the following statements:

flash.closeAll();
fl.closeAll();

flash object is guaranteed to be

The Flash Document Object Model 19

The flash object contains the following child objects:

Object How to access

componentsPanel object Use fl.componentsPanel to access the componentsPanel object. This

object corresponds to the Components panel in the Flash authoring
environment.

Document object Use

drawingLayer object Use

Effect object Use

Math object Use

outputPanel object Use

Tools object

ToolObj object Use fl.

XMLUI object Use

fl.documents to retrieve an array of all the open documents; use

fl.documents[index] to access a particular document; use

fl.getDocumentDOM() to access the current document (the one with

focus).

fl.drawingLayer to access the drawingLayer object.

fl.effects to retrieve an array of effect descriptors that

corresponds to the effects registered when Flash starts; use

fl.effects[index] to access a particular effect; use fl.activeEffect to

access the effect descriptor for the current effect being applied.

fl.Math to access the Math object.

fl.outputPanel to access the outputPanel object. This object

corresponds to the Output panel in the Flash authoring environment.

fl.tools is an object that has a toolObjs property. The toolObjs

property is an array of
a tool in the Flash Tools panel.

tools.toolObjs to retrieve an array of all tool objects (see

tools.toolObjs); use fl.tools.activeTool to access the currently

active tool object (see

fl.xmlui to access an XML User Interface (XMLUI) object. The

XMLUI object provides the ability to get and set properties of an XMLUI
dialog box.

toolObj objects. Each toolObj object represents

tools.activeTool).

The Document object

An important property of the top-level

flash object is the documents property. The documents

property contains an array of Document objects that each represent one of the FLA files currently
open in the authoring environment. The properties of each Document object represent most of
the elements that a FLA file can contain. Therefore, a large portion of the DOM is composed of
child objects and properties of the

To refer to the first open document, for example, use the statement

fl.documents[0]. The first document is the first Flash document that was opened during the

Document object.

flash.documents[0]. or

current session in the authoring environment. When the first opened document is closed, the
indexes of the other open documents are decremented.

To find a particular document's index use

To access the document that is currently focused, use the statement

fl.getDocumentDOM(). The latter is the syntax used in most of the examples in this document.

To find a particular document in the
document for its

20 Chapter 1: Introduction

name property.

fl.findDocumentIndex(nameOfDocument).

flash.getDocumentDOM() or

documents array, iterate through the array and test each

All the objects in the DOM that aren’t listed in the previous table (see “The Flash Document

Object Model” on page 19) are accessed from the

library of a document, you use the

library property of the Document object, which retrieves a

Document object. For example, to access the

library object:

fl.getDocumentDOM().library

To access the array of items in the library, you use the items property of the Library object; each
element in the array is an Item object:

fl.getDocumentDOM().library.items

To access a particular item in the library, you specify a member of the items array:

fl.getDocumentDOM().library.items[0]

In other words, the Library object is a child of the Document object, and the Item object is a
child of the

Library object.

Specifying the target of an action

Unless otherwise specified, methods affect the current focus or selection. For example, the
following script doubles the size of the current selection because no particular object is specified:

fl.getDocumentDOM().scaleSelection(2, 2);

In some cases, you might want an action to specifically target the currently selected item in the
Flash document. To do this, use the array that the

Document.selection property contains. The

first element in the array represents the currently selected item, as shown in the following
example:

var accDescription = fl.getDocumentDOM().selection[0].description;

The following script doubles the size of the first element on the Stage that is stored in the element
array, instead of the current selection:

var element =

fl.getDocumentDOM().getTimeline().layers[0].frames[0].elements[0];

if (element) {

element.width = element.width*2;
element.height = element.height*2;

}

You can also do something such as loop through all the elements on the Stage and increase the
width and height by a specified amount, as shown in the following example:

var elementArray =

fl.getDocumentDOM().getTimeline().layers[0].frames[0].elements;
for (var i=0; i < elementArray.length; i++) {

var offset = 10;
elementArray[i].width += offset;
elementArray[i].height += offset;

}

The Flash Document Object Model 21

Summary of the DOM structure

The following list displays the DOM structure in outline format. Numbers at the beginning of
each line represent the level of an object. For example, an object preceded by “03” is a child of
next highest “02” object, which, in turn, is a child of the next highest “01” object.

In some cases, an object is available by specifying a property of its parent object. For example, the

document.timelines property contains an array of Timeline objects. These properties are

noted in the following outline.

Finally, some objects are subclasses of other objects, rather than being children of other objects.
An object that is a subclass of another object has methods and/or properties of its own in addition
to the methods and properties of the other object (the superclass). Subclasses share the same level
in the hierarchy as their superclass. For example, Item is a superclass of BitmapItem. These
relationships are illustrated in the following outline:

01 Top-level functions
01 flash object

02 componentsPanel object
02 Document object (fl.documents array)

03 Matrix object
03 Fill object
03 Stroke object
03 library object

04 Item object (library.items array)
04 BitmapItem object (subclass of Item object)
04 folderItem object (subclass of Item object)
04 fontItem object (subclass of Item object)
04 SoundItem object (subclass of Item object)
04 SymbolItem object (subclass of Item object)
04 VideoItem object (subclass of Item object)

03 Timeline object (document.timelines array)

04 Layer object (timeline.layers array)

05 Frame object (layer.frames array)

06 Element object (frame.elements array)

07 Matrix object (Element.matrix)
06 Instance object (abstract class, subclass of Element object)
06 BitmapInstance object (subclass of Instance object)
06 CompiledClipInstance object (subclass of Instance object)
06 ComponentInstance object (subclass of SymbolInstance object)

07 Parameter object (ComponentInstance.parameters)
06 EmbeddedVideoInstance object (subclass of Instance object)
06 LinkedVideoInstance object (subclass of Instance object)
06 SymbolInstance object (subclass of Instance object)
06 Text object (subclass of Element object)

07 TextRun object (text.textRuns array)

08 TextAttrs object (textRun.textAttrs array)

06 Shape object (subclass of Element object)

07 Contour object (shape.contours array)

08 HalfEdge object

09 Vertex object
09 Edge object

07 Edge object (shape.edges array)

08 HalfEdge object

22 Chapter 1: Introduction

09 Vertex object
09 Edge object

07 Vertex object (shape.vertices array)

08 HalfEdge object

09 Vertex object
09 Edge object

03 ScreenOutline object

04 Screen object (screenOutline.screens array)

05 Parameter object (screen.parameters array)

02 drawingLayer object

03 Path object

04 Contour object
02 Effect object (fl.effects array)
02 Math object
02 outputPanel object
02 Tools object (fl.tools array)

03 ToolObj object (tools.toolObjs array)

02 XMLUI object

The PolyStar example

Included with this documentation is a sample Flash JSAPI script named PolyStar.jsfl. (You can
download the file at www.macromedia.com/go/jsapi_info_en.) This script replicates the PolyStar
tool that can be found in the Flash Tools panel. The PolyStar.jsfl file demonstrates how to build
the PolyStar tool using the JSAPI. It includes detailed comments that describe what the lines of
code are doing. Read this file to gain a better understanding of how the JSAPI can be used.

Flash MX 2004 includes an earlier version of the PolyStar.jsfl script that must be removed in order
to use the updated PolyStar.jsfl file.

To remove the earlier version of the PolyStar.jsfl that was installed with Flash MX 2004:

1.

Select Edit > Customize Tools Panel (Windows) or Flash > Customize Tools Panel
(Macintosh).

2.

In the Customize Tools Panel dialog box, click the Rectangle tool on the left side of the dialog
box.

The Rectangle tool and the PolyStar tool should now be listed in the Current Selection list on
the right side of the dialog box.

3.

Select the PolyStar tool in the Current Selection list.

4.

Click Remove.

5.

Click OK.

6.

Quit Flash.

7.

Remove only the PolyStar.jsfl file from the appropriate Tools folder listed in “Overview of the

Macromedia Flash JavaScript API” on page 17. The PolyStar.xml and PolyStar.png files are

needed by the new PolyStar.jsfl file that you will install later. When you restart Flash, the
PolyStar tool no longer appears in the Customize Tools Panel dialog box.

The PolyStar example 23

To install the updated PolyStar example files:

1.

Copy the new PolyStar.jsfl file to the Tools folder. The PolyStar.xml and PolyStar.png files that
you see in this folder are needed by the new PolyStar.jsfl file.

2.

Restart Flash.

3.

Select Edit > Customize Tools Panel (Windows) or Flash > Customize Tools Panel
(Macintosh). You should see PolyStar tool in the available tools list.

4.

Click the Rectangle tool at the left side of the Customize Tools Panel dialog box. The Rectangle
Tool should appear in the Current Selection list at the right side of the dialog box.

5.

Select the PolyStar tool from the Available Tools list.

6.

Click Add.

7.

Click OK.

The PolyStar tool now appears in the Rectangle tool pop-up menu.

24 Chapter 1: Introduction

CHAPTER 2

Top-level functions

This chapter describes the top-level functions that are available when creating extensible tools.
The following list shows the functions in alphabetical order:

activate()
configureEffect()
configureTool()
deactivate()
executeEffect()
keyDown()
keyUp()
mouseDoubleClick()
mouseDown()
mouseMove()
mouseUp()
notifySettingsChanged()
removeEffect()
setCursor()

25

activate()

Availability

Flash MX 2004.

Usage

function activate() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the extensible tool becomes active (that is, when the tool is selected
in the Tools panel). Any setup the tool needs to do should be performed in this function.

Example

function activate() {

fl.trace( "Tool is active" );

}

26 Chapter 2: Top-level functions

configureEffect()

Availability

Flash MX 2004.

Usage

function configureEffect() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called once at load time of Flash and is a good place for global initialization of
your effect. The per instance parameter data for an effect cannot be accessed here.

See also

executeEffect()

, removeEffect()

configureEffect() 27

configureTool()

Availability

Flash MX 2004.

Usage

function configureTool() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when Macromedia Flash opens and the tool is loaded. Use this function to
set any information Flash needs to know about the tool.

Example

The following examples show two possible implementations of this function:

function configureTool() {

theTool = fl.tools.activeTool;
theTool.setToolName("myTool");
theTool.setIcon("myTool.png");
theTool.setMenuString("My Tool's menu string");
theTool.setToolTip("my tool's tool tip");
theTool.setOptionsFile( "mtTool.xml" );

}

function configureTool() {

theTool = fl.tools.activeTool;
theTool.setToolName("ellipse");
theTool.setIcon("Ellipse.png");
theTool.setMenuString("Ellipse");
theTool.setToolTip("Ellipse");
theTool.showTransformHandles( true );

}

28 Chapter 2: Top-level functions

deactivate()

Availability

Flash MX 2004.

Usage

function deactivate() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the tool becomes inactive (that is, when the active tool changes from
this tool to another one). Use this function to perform any cleanup the tool needs.

Example

function deactivate() {

fl.trace( "Tool is no longer active" );

}

deactivate() 29

executeEffect()

Availability

Flash MX 2004.

Usage

function executeEffect() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the user first applies an effect or changes an effect's properties. The
code contained in this function is responsible for modifying the original object(s) to accomplish
the desired effect. It is also responsible for copying the original to another hidden layer if
necessary for the

See also

configureEffect()

removeEffect function

, removeEffect()

30 Chapter 2: Top-level functions

keyDown()

Availability

Flash MX 2004.

Usage

function keyDown() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the tool is active and the user presses a key. The script should call

tools.getKeyDown() to determine which key was pressed.

Example

function keyDown() {

fl.trace("key " + fl.tools.getKeyDown() + " was pressed");

}

keyDown() 31

keyUp()

Availability

Flash MX 2004.

Usage

function keyUp() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the tool is active and a key is released.

Example

function keyUp() {

fl.trace("Key is released");

}

32 Chapter 2: Top-level functions

mouseDoubleClick()

Availability

Flash MX 2004.

Usage

function mouseDoubleClick() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the mouse button is double-clicked on the Stage.

Example

function mouseDblClk() {

fl.trace("Mouse was double-clicked");

}

mouseDoubleClick() 33

mouseDown()

Availability

Flash MX 2004.

Usage

function mouseDown( [ pt ] ) {

// statements

}

Parameters

pt

A point that specifies the location of the mouse when the button is pressed. It is passed to the

function when the mouse button is pressed. This parameter is optional.

Returns

Nothing.

Description

This function is called whenever the tool is active and the mouse button is pressed while the
pointer is over the Stage.

Example

function mouseDown() {

fl.trace("Mouse button has been pressed");

}

34 Chapter 2: Top-level functions

mouseMove()

Availability

Flash MX 2004.

Usage

function mouseMove( [ pt ] ) {

// statements

}

Parameters

pt

A point that specifies the current location of the mouse. It is passed to the function whenever
the mouse moves, which tracks the mouse location. If the Stage is in edit or edit-in-place mode,
the point coordinates are relative to the object being edited. Otherwise, the point coordinates are
relative to the Stage. This parameter is optional.

Returns

Nothing.

Description

This function is called whenever the mouse moves over a specified point on the Stage. The mouse
button can be down or up.

Example

function mouseMove() {

fl.trace("moving");

}

mouseMove() 35

mouseUp()

Availability

Flash MX 2004.

Usage

function mouseUp() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called whenever the mouse button is released after being pressed on the Stage.

Example

function mouseUp() {

fl.trace("mouse is up");

}

36 Chapter 2: Top-level functions

notifySettingsChanged()

Availability

Flash MX 2004.

Usage

function notifySettingsChanged() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called whenever a tool is active and the user changes its options in the Property
inspector. You can use the
options.

Example

function notifySettingsChanged() {

var theTool = fl.tools.activeTool;
var newValue = theTool.myProp;

}

tools.activeTool property to query the current values of the

notifySettingsChanged() 37

removeEffect()

Availability

Flash MX 2004.

Usage

function removeEffect() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called when the user changes an effect's properties or uses the "remove effect"
menu item. The code contained in this function is responsible for returning the object(s) to their
original state. For example, if the effect broke a text string apart, the responsibility of the

removeEffect() method would be to remove the text string that was broken apart and replace it

with the original string.

See also

configureEffect()

, executeEffect()

38 Chapter 2: Top-level functions

setCursor()

Availability

Flash MX 2004.

Usage

function setCursor() {

// statements

}

Parameters

None.

Returns

Nothing.

Description

This function is called whenever the mouse moves, to allow the script to set custom pointers. The
script should call
pointers correspond to which integer values, see

Example

function setCursor() {

fl.tools.setCursor( 1 );

}

tools.setCursor() to specify the pointer to use. For a list that shows which

tools.setCursor().

setCursor() 39

40 Chapter 2: Top-level functions

CHAPTER 3

Objects

This chapter describes the Flash JSAPI objects, listed in alphabetical order. The objects are listed
in the following table:

Object Description

BitmapInstance object The BitmapInstance object is a subclass of the Instance object and

BitmapItem object A BitmapItem object refers to a bitmap in the library of a document.

CompiledClipInstance object The CompiledClipInstance object is a subclass of the Instance

ComponentInstance object The ComponentInstance object is a subclass of the SymbolInstance

componentsPanel object The componentsPanel object, which represents the Components

Contour object A Contour object represents a closed path of half edges on the

Document object The Document object represents the Stage.

drawingLayer object The drawingLayer object is accessible from JavaScript as a child of

Edge object The Edge object represents an edge of a shape on the Stage.

Effect object The Effect object represents an instance of a Timeline effect.

Element object Everything that appears on the Stage is of the type Element.

EmbeddedVideoInstance
object

Fill object The Fill object contains all the properties of the Fill color setting of

flash object The flash object represents the Flash application.

folderItem object The folderItem object is a subclass of the Item object.

represents a bitmap in a frame.

The BitmapItem object is a subclass of the Item object.

object.

object and represents a component in a frame.

panel, is a property of the flash object and can be accessed by

fl.componentsPanel.

boundary of a shape.

the flash object.

The EmbeddedVideoInstance object is a subclass of the Instance

object.

the Tools panel or of a selected shape.

41

Object Description

fontItem object The fontItem object is a subclass of the Item object.

Frame object The Frame object represents frames in the layer.

HalfEdge object Directed side of the edge of a Shape object.

Instance object The Instance object is a subclass of the Element object.

Item object The Item object is an abstract base class.

Layer object The Layer object represents a layer in the Timeline.

library object The library object represents the Library panel.

LinkedVideoInstance object The LinkedVideoInstance object is a subclass of the Instance object.

Math object The Math object is available as a read-only property of the flash

object; see

fl.Math.

Matrix object The Matrix object represents a transformation matrix.

outputPanel object The outputPanel object represents the Output panel, which displays

troubleshooting information such as syntax errors.

Parameter object The Parameter object type is accessed from the

screen.parameters

array (which corresponds to the screen Property inspector in the
Flash authoring tool) or by the

componentInstance.parameters array

(which corresponds to the component Property inspector in the
authoring tool).

Path object The Path object defines a sequence of line segments (straight,

curved, or both), which you typically use when creating extensible
tools.

Screen object The Screen object represents a single screen in a slide or form

document.

ScreenOutline object The ScreenOutline object represents the group of screens in a slide

or form document.

Shape object The Shape object is a subclass of the Element object. The Shape

object provides more precise control than the drawing APIs for
manipulating or creating geometry on the Stage.

SoundItem object The SoundItem object is a subclass of the Item object. It represents

a library item used to create a sound.

Stroke object The Stroke object contains all the settings for a stroke, including the

custom settings.

SymbolInstance object The SymbolInstance object is a subclass of the Instance object and

represents a symbol in a frame.

SymbolItem object The SymbolItem object is a subclass of the Item object.

Text object The Text object represents a single text item in a document.

TextAttrs object The TextAttrs object contains all the properties of text that can be

applied to a subselection. This object is a subclass of the Text

object.

42 Chapter 3: Objects

Object Description

TextRun object The TextRun object represents a run of characters that have

Timeline object The Timeline object represents the Flash Timeline, which can be

ToolObj object A ToolObj object represents an individual tool in the Tools panel.

Tools object The Tools object is accessible from the Flash object (

Vertex object The Vertex object is the part of the shape data structure that holds

VideoItem object The VideoItem object is a subclass of the Item object.

XMLUI object The XMLUI object provides the ability to get and set properties of an

attributes that match all of the properties in the TextAttrs object.

accessed for the current document by

fl.getDocumentDOM().getTimeline().

fl.tools).

the coordinate data.

XMLUI dialog box, and accept or cancel out of one.

BitmapInstance object

Inheritance Element object > Instance object > BitmapInstance object

Availability

Flash MX 2004.

Description

The BitmapInstance object is a subclass of the Instance object and represents a bitmap in a frame.

Method summary for the BitmapInstance object

In addition to the Instance object methods, you can use the following methods with the
BitmapInstance object:

Method Description

bitmapInstance.getBits() Method; lets you create bitmap effects by getting the bits out of the

bitmap, manipulating them, and then returning them to Flash.

bitmapInstance.setBits() Method; sets the bits of an existing bitmap element.

Property summary for the BitmapInstance object

In addition to the Instance object properties, you can use the following properties with the
BitmapInstance object.

Property Description

bitmapInstance.hPixels Read-only; an integer that represents the width of the bitmap, in

bitmapInstance.vPixels Read-only; an integer that represents the height of the bitmap, in

pixels.

pixels.

BitmapInstance object 43

bitmapInstance.getBits()

Availability

Flash MX 2004.

Usage

bitmapInstance.getBits()

Parameters

None.

Returns

An object that contains width, height, depth, bits, and, if the bitmap has a color table, cTab
properties. The
the form

Note: The byte array is meaningful only when referenced by an external library. You typically use it
only when creating an extensible tool or effect.

Description

bits element is an array of bytes. The cTab element is an array of color values of

"#rrggbb". The length of the array is the length of the color table.

Method; lets you create bitmap effects by getting the bits out of the bitmap, manipulating them,
and then returning them to Flash. See also

Example

bitmapInstance.setBits().

The following code creates a reference to the currently selected object; tests whether the object is a
bitmap; and traces the height, width, and bit depth of the bitmap:

var isBitmap = fl.getDocumentDOM().selection[0].instanceType;
if(isBitmap == "bitmap"){

var bits = fl.getDocumentDOM().selection[0].getBits();
fl.trace("height = " + bits.height);
fl.trace("width = " + bits.width);
fl.trace("depth = " + bits.depth);

}

bitmapInstance.hPixels

Availability

Flash MX 2004.

Usage

bitmapInstance.hPixels

Description

Read-only property; an integer that represents the width of the bitmap, in pixels.

Example

The following code retrieves the width of the bitmap in pixels:

// Get the number of pixels in the horizontal dimension.
var bmObj = fl.getDocumentDOM().selection[0];

44 Chapter 3: Objects

var isBitmap = bmObj.instanceType;
if(isBitmap == "bitmap"){

var numHorizontalPixels = bmObj.hPixels;

}

bitmapInstance.setBits()

Availability

Flash MX 2004.

Usage

bitmapInstance.setBits(bitmap)

Parameters

bitmap

An object that contains height, width, depth, bits, and cTab properties. The

height, width, and depth properties are integers. The bits property is a byte array. The cTab

property is required only for bitmaps with a bit depth of 8 or less and is a string that represents a
color value in the form

Note: The byte array is meaningful only when referenced by an external library. You typically use it
only when creating an extensible tool or effect.

Returns

"#rrggbb".

Nothing.

Description

Method; sets the bits of an existing bitmap element. This lets you create bitmap effects by getting
the bits out of the bitmap, manipulating them, and then returning the bitmap to Flash.

Example

The following code tests whether the current selection is a bitmap, and then reduces the height of
the bitmap by 150 pixels:

var isBitmap = fl.getDocumentDOM().selection[0].instanceType;
if(isBitmap == "bitmap"){

var bits = fl.getDocumentDOM().selection[0].getBits();
bits.height = -150;
fl.getDocumentDOM().selection[0].setBits(bits);

}

bitmapInstance.vPixels

Availability

Flash MX 2004.

Usage

bitmapInstance.vPixels

Description

Read-only property; an integer that represents the height of the bitmap, in pixels.

BitmapInstance object 45

Example

The following code gets the height of the bitmap in pixels:

// get the number of pixels in the vertical dimension
var bmObj = fl.getDocumentDOM().selection[0];
var isBitmap = bmObj.instanceType;
if(isBitmap == "bitmap"){

var numVerticalPixels = bmObj.vPixels;

}

46 Chapter 3: Objects

CHAPTER 3

BitmapItem object

Inheritance Item object > BitmapItem object

Availability

Flash MX 2004.

Description

A BitmapItem object refers to a bitmap in the library of a document. The BitmapItem object is a
subclass of the Item object.

Property summary for the BitmapItem object

In addition to the Item object properties, the BitmapItem object has following properties:

Property Description

bitmapItem.allowSmoothing Property; a Boolean value. Set to true to allow smoothing of

a bitmap;

bitmapItem.compressionType Property; a string that determines the type of image

compression applied to the bitmap.

bitmapItem.quality Property; an iinteger that specifies the quality of the bitmap

bitmapItem.useImportedJPEGQuality Property; a Boolean value. To use the default imported JPEG

quality, specify

false otherwise.

true; false otherwise.

Objects

bitmapItem.allowSmoothing

Availability

Flash MX 2004.

Usage

bitmapItem.allowSmoothing

Description

Property; a Boolean value. Set to true to allow smoothing of a bitmap; false otherwise.

Example

The following code sets the allowSmoothing property of the first item in the library of the
current document to

fl.getDocumentDOM().library.items[0].allowSmoothing = true;
alert(fl.getDocumentDOM().library.items[0].allowSmoothing);

true:

BitmapItem object 47

bitmapItem.compressionType

Availability

Flash MX 2004.

Usage

bitmapItem.compressionType

Description

Property; a string that determines the type of image compression applied to the bitmap.
Acceptable values are

false, "photo" corresponds to JPEG using a quality from 0 to 100; if
bitmapItem.useImportedJPEGQuality is true, "photo" corresponds to JPEG using the

default document quality value. The value

Example

"photo" or "lossless". If bitmapItem.useImportedJPEGQuality is

"lossless" corresponds to GIF or PNG formats.

The following code sets the compressionType property of the first item in the library of the
current document to

fl.getDocumentDOM().library.items[0].compressionType = "photo";
alert(fl.getDocumentDOM().library.items[0].compressionType);

"photo":

bitmapItem.quality

Availability

Flash MX 2004.

Usage

bitmapItem.quality

Description

Property; an integer that specifies the quality of the bitmap. To use the default document quality,
specify -1; otherwise, specify an integer from 0 to 100. Available only for JPEG compression.

Example

The following code sets the quality property of the first item in the library of the current
document to 65:

fl.getDocumentDOM().library.items[0].quality = 65;
alert(fl.getDocumentDOM().library.items[0].quality);

bitmapItem.useImportedJPEGQuality

Availability

Flash MX 2004.

Usage

bitmapItem.useImportedJPEGQuality

48 Chapter 3: Objects

Description

Property; a Boolean value. To use the default imported JPEG quality, specify true; false
otherwise. Available only for JPEG compression.

Example

The following code sets the useImportedJPEGQuality property of the first item in the library of
the current document to

fl.getDocumentDOM().library.items[0].useImportedJPEGQuality = true;
alert(fl.getDocumentDOM().library.items[0].useImportedJPEGQuality);

true:

BitmapItem object 49

CHAPTER 3

CompiledClipInstance object

Inheritance Element object > Instance object > CompiledClipInstance object

Availability

Flash MX 2004.

Description

The CompiledClipInstance object is a subclass of the Instance object. It is essentially an instance
of a movie clip that has been converted to a compiled clip library item.

Property summary for the CompiledClipInstance object

In addition to the properties of the Instance object, the CompiledClipInstance object has the
following properties:

Property Description

compiledClipInstance.accName

compiledClipInstance.actionScript

compiledClipInstance.description

compiledClipInstance.forceSimple

compiledClipInstance.shortcut

compiledClipInstance.silent

compiledClipInstance.tabIndex

Property; a string that is equivalent to the Name field in the
Accessibility panel.

Property; a string that represents the ActionScript for this
instance; equivalent to

Property; a string that is equivalent to the Description field in
the Accessibility panel.

Property; a Boolean value that enables and disables the
children of the object to be accessible.

Property; a string that is equivalent to the Shortcut field in the
Accessibility panel.

Property; a Boolean value that enables or disables the
accessibility of the object; equivalent to the inverse logic of
Make Object Accessible setting in the Accessibility panel.

Property; an integer that is equivalent to the Tab Index field in
the Accessibility panel.

symbolInstance.actionScript.

Objects

compiledClipInstance.accName

Availability

Flash MX 2004.

Usage

compiledClipInstance.accName

Description

Property; a string that is equivalent to the Name field in the Accessibility panel. Screen readers
identify objects by reading the name aloud.

50 Chapter 3: Objects

Example

// get the name of the object.
var theName = fl.getDocumentDOM().selection[0].accName;
// set the name of the object.
fl.getDocumentDOM().selection[0].accName = 'Home Button';

compiledClipInstance.actionScript

Availability

Flash MX 2004.

Usage

compiledClipInstance.actionScript

Description

Property; a string that represents the ActionScript for this instance; equivalent to

symbolInstance.actionScript.

Example

The following code assigns ActionScript to specified elements:

//assign some ActionScript to a specified Button compiled clip instance.
fl.getDocumentDOM().getTimeline().layers[0].frames[0].elements[0]

.actionScript = "on(click) {trace('button is clicked');}";

//assign some ActionScript to the currently selected Button compiled clip

instance.

fl.getDocumentDOM().selection[0].actionScript =

"on(click) {trace('button is clicked');}";

compiledClipInstance.description

Availability

Flash MX 2004.

Usage

compiledClipInstance.description

Description

Property; a string that is equivalent to the Description field in the Accessibility panel. The
description is read by the screen reader.

Example

The following example illustrates getting and setting the description property:

// get the description of the current selection
var theDescription = fl.getDocumentDOM().selection[0].description;
// set the description of the current selection
fl.getDocumentDOM().selection[0].description =

"This is compiled clip number 1";

CompiledClipInstance object 51

compiledClipInstance.forceSimple

Availability

Flash MX 2004.

Usage

compiledClipInstance.forceSimple

Description

Property; a Boolean value that enables and disables the children of the object to be accessible.
This is equivalent to the inverse logic of the Make Child Objects Accessible setting in the
Accessibility panel. If
option being unchecked. If

forceSimple is true, it is the same as the Make Child Objects Accessible

forceSimple is false, it is the same as the Make Child Object

Accessible option being checked.

Example

The following example illustrates getting and setting the forceSimple property:

// query if the children of the object are accessible
var areChildrenAccessible = fl.getDocumentDOM().selection[0].forceSimple;
// allow the children of the object to be accessible
fl.getDocumentDOM().selection[0].forceSimple = false;

compiledClipInstance.shortcut

Availability

Flash MX 2004.

Usage

compiledClipInstance.shortcut

Description

Property; a string that is equivalent to the Shortcut field in the Accessibility panel. The shortcut is
read by the screen readers. This property is not available for dynamic text fields.

Example

The following example illustrates getting and setting the shortcut property:

// get the shortcut key of the object
var theShortcut = fl.getDocumentDOM().selection[0].shortcut;
// set the shortcut key of the object
fl.getDocumentDOM().selection[0].shortcut = "Ctrl+I";

compiledClipInstance.silent

Availability

Flash MX 2004.

Usage

compiledClipInstance.silent

52 Chapter 3: Objects

Description

Property; a Boolean value that enables or disables the accessibility of the object; equivalent to the
inverse logic of Make Object Accessible setting in the Accessibility panel. That is, if

true, then Make Object Accessible is unchecked. If silent is false, then Make Object

silent is

Accessible is checked.

Example

The following example illustrates getting and setting the silent property:

// query if the object is accessible
var isSilent =fl.getDocumentDOM().selection[0].silent;
// set the object to be accessible
fl.getDocumentDOM().selection[0].silent = false;

compiledClipInstance.tabIndex

Availability

Flash MX 2004.

Usage

compiledClipInstance.tabIndex

Description

Property; an integer that is equivalent to the Tab Index field in the Accessibility panel. Creates a
tab order in which objects are accessed when the user presses the Tab key.

Example

The following example illustrates getting and setting the tabIndex property:

// get the tabIndex of the object.
var theTabIndex = fl.getDocumentDOM().selection[0].tabIndex;
// set the tabIndex of the object.
fl.getDocumentDOM().sele ction[0].tabIndex = 1;

CompiledClipInstance object 53

CHAPTER 3

ComponentInstance object

Inheritance Element object > Instance object > SymbolInstance object > ComponentInstance

object

Availability

Flash MX 2004.

Description

The ComponentInstance object is a subclass of the SymbolInstance object and represents a
component in a frame.

Property summary for the ComponentInstance object

In addition to all the properties of the SymbolInstance object, the ComponentInstance object has
the following property:

Property Description

componentInstance.parameters Read-only; an array containing the ActionScript 2.0 properties that

are accessible from the component Property inspector.

componentInstance.parameters

Availability

Flash MX 2004.

Objects

Usage

componentInstance.parameters

Description

Read-only property; an array containing the ActionScript 2.0 properties that are accessible from
the component Property inspector. See “Parameter object” on page 237.

Example

The following example illustrates getting and setting the parameters property:

var parms = fl.getDocumentDOM().selection[0].parameters;
parms[0].value = "some value";

54 Chapter 3: Objects

CHAPTER 3

componentsPanel object

Availability

Flash MX 2004.

Description

The componentsPanel object, which represents the Components panel, is a property of the flash

object and can be accessed by

Method summary for the ComponentsPanel object

You can use the following method with the componentsPanel object:

Property Description

componentsPanel.addItemToDocument() Adds the specified component to the document at the

componentsPanel.addItemToDocument()

Availability

Flash MX 2004.

Usage

componentsPanel.addItemToDocument( position, categoryName, componentName )

fl.componentsPanel.

specified position.

Objects

Parameters

position

component. Specify

A point (for example, {x:0, y:100}) that specifies the location at which to add the

position relative to the center point of the component—not the

component’s registration point.

categoryName A string that specifies the name of the component category (for example, "Data
Components

componentName A string that specifies the name of the component in the specified category

(for example, "

"). The valid category names are listed in the Components panel.

WebServiceConnector"). The valid component names are listed in the

Components panel.

Returns

Nothing.

Description

Adds the specified component to the document at the specified position.

Examples

The following examples illustrate some ways to use this method:

fl.componentsPanel.addItemToDocument({x:0, y:0}, "UI Components", "CheckBox");
fl.componentsPanel.addItemToDocument({x:0, y:100}, "Data Components",

"WebServiceConnector");

fl.componentsPanel.addItemToDocument({x:0, y:200}, "UI Components", "Button");

componentsPanel object 55

Contour object

Availability

Flash MX 2004.

Description

A Contour object represents a closed path of half edges on the boundary of a shape.

Method summary for the Contour object

You can use the following method with the Contour object:

Property Description

contour.getHalfEdge() Method; returns a HalfEdge object on the contour of the selection.

Property summary for the Contour object

You can use the following properties with the Contour object:

Property Description

contour.interior Read-only: the value is true if the contour encloses an area; false

otherwise.

contour.orientation Read-only; an integer indicating the orientation of the contour.

CHAPTER 3

Objects

contour.getHalfEdge()

Availability

Flash MX 2004.

Usage

contour.getHalfEdge()

Parameters

None.

Returns

A HalfEdge object.

Description

Method; returns a HalfEdge object on the contour of the selection.

Example

This example traverses all the contours of a selected shape and shows the coordinates of the
vertices in the Output panel:

// with a shape selected

var elt = fl.getDocumentDOM().selection[0];

56 Chapter 3: Objects

elt.beginEdit();

var contourArray = elt.contours;
var contourCount = 0;
for (i=0; i<contourArray.length; i++)
{

var contour = contourArray[i];
contourCount++;
var he = contour.getHalfEdge();

var iStart = he.id;
var id = 0;
while (id != iStart)
{

// get the next vertex
var vrt = he.getVertex();

var x = vrt.x;
var y = vrt.y;
fl.trace("vrt: " + x + ", " + y);

he = he.getNext();
id = he.id;

}
}
elt.endEdit();

contour.interior

Availability

Flash MX 2004.

Usage

contour.interior

Description

Read-only property: the value is true if the contour encloses an area; false otherwise.

Example

This example traverses all the contours in the selected shape and shows the value of the interior
property for each contour in the Output panel:

var elt = fl.getDocumentDOM().selection[0];
elt.beginEdit();

var contourArray = elt.contours;

var contourCount = 0;
for (i=0; i<contourArray.length; i++) {

var contour = contourArray[i];

fl.trace("Next Contour, interior:" + contour.interior );

contourCount++;

Contour object 57

}
elt.endEdit();

contour.orientation

Availability

Flash MX 2004.

Usage

contour.orientation

Description

Read-only property: an integer indicating the orientation of the contour. The value of the integer
is -1 if the orientation is counterclockwise, 1 if it is clockwise, and 0 if it is a contour with no area.

Example

The following example traverses all the contours of the selected shape and shows the value of the

orientation property of each contour in the Output panel:

var elt = fl.getDocumentDOM().selection[0];
elt.beginEdit();

var contourArray = elt.contours;

var contourCount = 0;
for (i=0; i<contourArray.length; i++) {

var contour = contourArray[i];

fl.trace("Next Contour, orientation:" + contour.orientation);

contourCount++;
}
elt.endEdit();

58 Chapter 3: Objects

CHAPTER 3

Document object

Availability

Flash MX 2004.

Description

The Document object represents the Stage. That is, only FLA files are considered documents.

Method summary for the Document object

You can use the following methods with the Document object.

Method Description

document.addDataToDocument() Stores specified data with a document.

document.addDataToSelection() Stores specified data with the selected object(s).

document.addItem() Adds an item from any open document or library to the

specified Document object.

document.addNewLine() Adds a new path between two points.

document.addNewOval() Adds a new oval in the specified bounding rectangle.

document.addNewPublishProfile() Adds a new publish profile and makes it the current one.

document.addNewRectangle() Adds a new rectangle or rounded rectangle, fitting it into

document.addNewScene() Adds a new scene (Timeline object) as the next scene

document.addNewText() Inserts a new empty text field.

document.align() Aligns the selection.

document.allowScreens() Use this method before using the

document.arrange() Arranges the selection on the Stage.

document.breakApart() Performs a break-apart operation on the current

document.canEditSymbol() Indicates whether Edit Symbols menu and functionality

document.canRevert() Determines whether you can use the document.revert()

document.canTestMovie() Determines whether you can use the

document.canTestScene() Determines whether you can use the

document.clipCopy() Copies the current selection from the document to the

the specified bounds.

after the currently selected scene and makes the new
scene the currently selected scene.

document.screenOutline property.

selection.

is enabled.

or

fl.revertDocument() method successfully.

document.testMovie() method successfully.

document.testScene() method successfully.

Clipboard.

Objects

Document object 59

Method Description

document.clipCut() Cuts the current selection from the document and writes

it to the Clipboard.

document.clipPaste() Pastes the contents of the Clipboard into the document.

document.close() Closes the specified document.

document.convertLinesToFills() Converts lines to fills on the selected objects.

document.convertToSymbol() Converts the selected Stage item(s) to a new symbol.

document.deletePublishProfile() Deletes the currently active profile, if there is more than

one.

document.deleteScene() Deletes the current scene (Timeline object) and, if the

deleted scene was not the last one, sets the next scene
as the current Timeline object.

document.deleteSelection() Deletes the current selection on the Stage.

document.distribute() Distributes the selection.

document.distributeToLayers() Performs a distribute-to-layers operation on the current

selection; equivalent to selecting Distribute to Layers.

document.documentHasData() Checks the document for persistent data with the

specified name.

document.duplicatePublishProfile() Duplicates the currently active profile and gives the

duplicate version focus.

document.duplicateScene() Makes a copy of the currently selected scene, giving the

new scene a unique name and making it the current
scene.

document.duplicateSelection() Duplicates the selection on the Stage.

document.editScene() Makes the specified scene the currently selected scene

for editing.

document.enterEditMode() Switches the authoring tool into the editing mode

specified by the parameter.

document.exitEditMode() Exits from symbol-editing mode and returns focus to the

next level up from the editing mode.

document.exportPublishProfile() Exports the currently active profile to a file.

document.exportSWF() Exports the document to the specified file in the Flash

SWF format.

document.getAlignToDocument() Identical to retrieving the value of the To Stage button in

the Align panel.

document.getCustomFill() Retrieves the fill object of the selected shape or, if

specified, the toolbar and Property inspector.

document.getCustomStroke() Returns the stroke object of the selected shape or, if

specified, the toolbar and Property inspector.

document.getDataFromDocument() Retrieves the value of the specified data.

60 Chapter 3: Objects

Method Description

document.getElementProperty() Gets the specified Element property for the current

selection.

document.getElementTextAttr() Gets a specified TextAttrs property of the selected text

objects.

document.getSelectionRect() Gets the bounding rectangle of the current selection.

document.getTextString() Gets the currently selected text.

document.getTimeline() Retrieves the current Timeline object in the document.

document.getTransformationPoint() Gets the location of the transformation point of the

current selection.

document.group() Converts the current selection to a group.

document.importPublishProfile() Imports a profile from a file.

document.importSWF() Imports a SWF file into the document.

document.match() Makes the size of the selected objects the same.

document.mouseClick() Performs a mouse click from the arrow tool.

document.mouseDblClk() Performs a double mouse click from the arrow tool.

document.moveSelectedBezierPointsBy() If the selection contains at least one path with at least

one Bézier point selected, this method moves all
selected Bézier points on all selected paths by the
specified amount.

document.moveSelectionBy() Moves selected objects by a specified distance.

document.optimizeCurves() Optimizes smoothing for the current selection, allowing

multiple passes, if specified, for optimal smoothing;
equivalent to selecting Modify > Shape > Optimize.

document.publish() Publishes the document according to the active Publish

Settings (see File > Publish Settings); equivalent to
selecting File > Publish.

document.removeDataFromDocument() Removes persistent data with the specified name that

has been attached to the document.

document.removeDataFromSelection() Removes persistent data with the specified name that

has been attached to the selection.

document.renamePublishProfile() Renames the current profile.

document.renameScene() Renames the currently selected scene in the Scenes

panel.

document.reorderScene() Moves the specified scene before another specified

scene.

document.resetTransformation() Resets the transformation matrix; equivalent to selecting

Modify > Transform > Remove transform.

document.revert() Reverts the specified document to its previously saved

version; equivalent to selecting File > Revert.

Document object 61

Method Description

document.rotateSelection() Rotates the selection by a specified amount.

document.save() Saves the document in its default location; equivalent to

selecting File > Save.

document.saveAndCompact() Saves and compacts the file; equivalent to selecting

File > Save and Compact.

document.scaleSelection() Scales the selection by a specified amount; equivalent to

using the Free Transform tool to scale the object.

document.selectAll() Selects all items on the Stage; equivalent to pressing

Control+A (Windows) or Command+A (Macintosh) or
selecting Edit > Select All.

document.selectNone() Deselects any selected items.

document.setAlignToDocument() Sets the preferences for document.align(),

document.distribute(),document.match(), and
document.space() to act on the document; equivalent to

enabling the To Stage button in the Align panel.

document.setCustomFill() Sets the fill settings for the toolbar, Property inspector,

and any selected shapes.

document.setCustomStroke() Sets the stroke settings for the toolbar, Property

inspector, and any selected shapes.

document.setElementProperty() Sets the specified Element property on selected

object(s) in the document.

document.setElementTextAttr() Sets the specified TextAttrs property of the selected

text items to the specified value.

document.setFillColor() Changes the fill color of the selection to the specified

color.

document.setInstanceAlpha() Sets the opacity of the instance.

document.setInstanceBrightness() Sets the brightness for the instance.

document.setInstanceTint() Sets the tint for the instance.

document.setSelectionBounds() Moves and resizes the selection in a single operation.

document.setSelectionRect() Draws a rectangular selection marquee relative to the

Stage, using the specified coordinates.

document.setStroke() Sets the color, width, and style of the selected strokes.

document.setStrokeColor() Changes the stroke color of the selection to the specified

color.

document.setStrokeSize() Changes the stroke size of the selection to the specified

size.

document.setStrokeStyle() Changes the stroke style of the selection to the specified

style.

document.setTextRectangle() Changes the bounding rectangle for the selected text

item to the specified size.

62 Chapter 3: Objects

Method Description

document.setTextSelection() Sets the text selection of the currently selected text field

to the values specified by the

startIndex and endIndex

values.

document.setTextString() Inserts a string of text.

document.setTransformationPoint() Moves the transformation point of the current selection.

document.skewSelection() Skews the selection by a specified amount.

document.smoothSelection() Smooths the curve of each selected fill outline or curved

line.

document.space() Spaces the objects in the selection evenly.

document.straightenSelection() Straightens the currently selected strokes; equivalent to

using the Straighten button in the Tools panel.

document.swapElement() Swaps the current selection with the specified one.

document.testMovie() Executes a Test Movie operation on the document.

document.testScene() Executes a Test Scene operation on the current scene of

the document.

document.traceBitmap() Performs a trace bitmap on the current selection;

equivalent to selecting Modify > Bitmap > Trace Bitmap.

document.transformSelection() Performs a general transformation on the current

selection by applying the matrix specified in the
arguments.

document.unGroup() Ungroups the current selection.

document.unlockAllElements() Unlocks all locked elements on the currently selected

frame.

document.xmlPanel() Posts a XMLUI dialog box.

Property summary for the Document object

You can use the following properties with the Document object.

Property Description

document.accName A string that is equivalent to the Name field in the

document.autoLabel A Boolean value that is equivalent to the Auto Label

document.backgroundColor A color in hexidecimal format that represents the

document.currentPublishProfile A string that specifies the name of the active publish

document.currentTimeline An integer that specifies the index of the active Timeline.

Accessibility panel.

check box in the Accessibility panel.

background color.

profile for the specified document.

Document object 63

Property Description

document.description A string that is equivalent to the Description field in the

Accessibility panel.

document.forceSimple A Boolean value that specifies whether the children of

the specified object are accessible.

document.frameRate A float value that specifies the number of frames

displayed per second when the SWF file plays; the
default is 12.

document.height An integer that specifies the height of the document

(Stage) in pixels.

document.library Read-only; the library object for a document.

document.livePreview A Boolean value that specifies if Live Preview is enabled.

document.name Read-only; a string that represents the name of a

document (FLA file).

document.path Read-only; a string that represents the path of the

document.

document.publishProfiles Read-only; an array of the publish profile names for the

document.

document.screenOutline Read-only; the current ScreenOutline object for the

document.

document.selection An array of the selected objects in the document.

document.silent A Boolean value that specifies whether the object is

accessible.

document.timelines Read-only; an array of Timeline objects (see Timeline

object).

document.viewMatrix Read-only; a Matrix object.

document.width An integer that specifies the width of the document

(Stage) in pixels.

document.accName

Availability

Flash MX 2004.

Usage

document.accName

Description

Property; a string that is equivalent to the Name field in the Accessibility panel. Screen readers
identify objects by reading the name aloud.

64 Chapter 3: Objects

Example

The following example sets the accessibility name of the document to "Main Movie":

fl.getDocumentDOM().accName = "Main Movie";

The following example gets the accessibility name of the document:

fl.trace(fl.getDocumentDOM().accName);

document.addDataToDocument()

Availability

Flash MX 2004.

Usage

document.addDataToDocument( name, type, data )

Parameters

name

A string that specifies the name of the data to add.

type A string that defines the type of data to add. The valid values for type are "integer",

"integerArray", "double", "doubleArray", "string", and "byteArray".

data the value to add. Valid types depend on the type parameter.

Returns

Nothing.

Description

Method; stores specified data with a document. Data is written to the FLA file and is available to
JavaScript when the file reopens. See

document.removeDataFromDocument().

document.getDataFromDocument() and

Example

The following example adds an integer value of 12 to the current document:

fl.getDocumentDOM().addDataToDocument("myData", "integer", 12);

The following example returns the value of the data named "myData" and displays the result in
the Output panel:

fl.trace(fl.getDocumentDOM().getDataFromDocument("myData"));

document.addDataToSelection()

Availability

Flash MX 2004.

Usage

document.addDataToSelection( name, type, data )

Document object 65

Parameters

name

A string that specifies the name of the persistent data.

type Defines the type of data. The valid values for type are: "integer", "integerArray",
"double", "doubleArray", "string", and "byteArray".

data the value to add. Valid types depend on the type parameter.

Returns

Nothing.

Description

Method; stores specified data with the selected object(s). Data is written to the FLA file and is
available to JavaScript when the file reopens. Only symbols and bitmaps support persistent data.
See

document.removeDataFromSelection().

Example

The following example adds an integer value of 12 to the selected object:

fl.getDocumentDOM().addDataToSelection("myData", "integer", 12);

document.addItem()

Availability

Flash MX 2004.

Usage

document.addItem( position

, item )

Parameters

position

A point that specifies the x and y coordinates of the location at which to add the

item. It uses the center of a symbol or the upper left corner of a bitmap or video.

item An Item object that specifies the item to add and the library from which to add it.

Returns

A Boolean value: true if successful; false otherwise.

Description

Method; adds an item from any open document or library to the specified Document object.

Example

The following example adds the first item from the library to the first document at the specified
location for the selected symbol, bitmap, or video:

var item = fl.documents[0].library.items[0];
fl.documents[0].addItem({x:0,y:0}, item);

66 Chapter 3: Objects

The following example adds the symbol myMovieClip from the current document’s library to the
current document:

var itemIndex = fl.getDocumentDOM().library.findItemIndex("myMovieClip");
var theItem = fl.getDocumentDOM().library.items[itemIndex];
fl.getDocumentDOM().addItem({x:0,y:0}, theItem);

The following example adds the symbol myMovieClip from the second document in the
documents array to the third document in the documents array:

var itemIndex = fl.documents[1].library.findItemIndex("myMovieClip");
var theItem = fl.documents[1].library.items[itemIndex];
fl.documents[2].addItem({x:0,y:0}, theItem);

document.addNewLine()

Availability

Flash MX 2004.

Usage

document.addNewLine( startPoint

Parameters

startpoint

A pair of floating point numbers that specify the x and y coordinates where the line

, endpoint )

starts.

endpoint A pair of floating point numbers that specify the x and y coordinates where the line

ends.

Returns

Nothing.

Description

Method; adds a new path between two points. The method uses the document’s current stroke
attributes and adds the path on the current frame and current layer. This method works in the
same way as clicking on the line tool and drawing a line.

Example

The following example adds a line between the specified starting point and ending point:

fl.getDocumentDOM().addNewLine({x:216.7, y:122.3}, {x:366.8, y:165.8});

document.addNewOval()

Availability

Flash MX 2004.

Usage

document.addNewOval( boundingRectangle

[, bSuppressFill [, bSuppressStroke ]] )

Document object 67

Parameters

boundingRectangle

bSuppressFill A Boolean value that, if set to true, causes the method to create the shape

without a fill. The default value is

bSuppressStroke A Boolean value that, if set to true, causes the method to create the shape

without a stroke. The default value is

Returns

A rectangle that specifies the bounds of the oval to be added.

false. This parameter is optional.

false. This parameter is optional.

Nothing.

Description

Method; adds a new oval in the specified bounding rectangle. This method performs the same
operation as the oval tool. The method uses the document’s current default stroke and fill
attributes and adds the oval on the current frame and layer. If
oval is drawn without a fill. If
stroke. If both

Example

bSuppressFill or bSuppressStroke are set to true, the method will do nothing.

bSurpressStroke is set to true, the oval is drawn without a

bSurpressFill is set to true, the

The following example adds a new oval within the specified coordinates:

flash.getDocumentDOM().addNewOval({left:72,top:50,right:236,bottom:228});

The following example draws an oval without fill:

flash.getDocumentDOM().addNewOval({left:72,top:50,right:236,bottom:228},

true);

The following example draws an oval without stroke:

flash.getDocumentDOM().addNewOval({left:72,top:50,right:236,bottom:228},

false, true);

document.addNewPublishProfile()

Availability

Flash MX 2004.

Usage

document.addNewPublishProfile( [profileName ] )

Parameters

profileName

the unique name of the new profile. If you do not specify a name, a default name

is provided. This parameter is optional.

Returns

An integer that is the index of the new profile in the profiles list. Returns -1 if a new profile
cannot be created.

68 Chapter 3: Objects

Description

Method; adds a new publish profile and makes it the current one. See

document.deletePublishProfile().

Example

The following example adds a new publish profile with a default name and then displays the
name of the profile in the Output panel:

fl.getDocumentDOM().addNewPublishProfile();
fl.outputPanel.trace(fl.getDocumentDOM().currentPublishProfile);

The following example adds a new publish profile with the name "my profile":

fl.getDocumentDOM().addNewPublishProfile("my profile");

document.addNewRectangle()

Availability

Flash MX 2004.

Usage

document.addNewRectangle( boundingRectangle, roundness

[, bSuppressFill [, bSuppressStroke ] ] )

Parameters

boundingRectangle

added. This parameter specifies a pixel location for

roundness An integer value between 0 and 999 that specifies the roundness to use for the

A rectangle that specifies the bounds within which the new rectangle is

left, top, right, and bottom.

corners. The value is specified as number of points. The greater the value, the greater the
roundness.

bSuppressFill A Boolean value that, if set to true, causes the method to create the shape

without a fill. The default value is

false. This parameter is optional.

bSuppressStroke A Boolean value that, if set to true, causes the method to create the

rectangle without a stroke. The default value is

Returns

false. This parameter is optional.

Nothing.

Description

Method; adds a new rectangle or rounded rectangle, fitting it into the specified bounds. This
method performs the same operation as the rectangle tool. The method uses the document’s
current default stroke and fill attributes and adds the rectangle on the current frame and layer. If
the

bSuppressFill parameter is set to true, the rectangle is drawn without a fill. If the
bSuppressStroke parameter is set to true, the rectangle is drawn without a stroke. Either
bSuppressFill or bSuppressStroke must be set to false or the method does nothing.

Document object 69

Example

The following example adds a new rectangle with no round corners within the specified
coordinates.

flash.getDocumentDOM().addNewRectangle({left:0,top:0,right:100,bottom:100},0);

The following example adds a new rectangle with no round corners and without a fill.

flash.getDocumentDOM().addNewRectangle({left:0,top:0,right:100,bottom:100},0,

true);

The following example add a new rectangle no round corners and without a stroke.

flash.getDocumentDOM().addNewRectangle({left:0,top:0,right:100,bottom:100},0,

false, true);

document.addNewScene()

Availability

Flash MX 2004.

Usage

document.addNewScene( [name] )

Parameters

name

Specifies the name of the scene. If you do not specify a name, a new scene name is

generated.

Returns

A Boolean value: true if the scene is added successfully; false otherwise.

Description

Method; adds a new scene (Timeline object) as the next scene after the currently selected scene
and makes the new scene the currently selected scene. If the specified scene name already exists,
the scene is not added and the method returns an error.

Example

The following example adds a new scene named myScene after the current scene in the current
document. The variable

var success = flash.getDocumentDOM().addNewScene("myScene");

success will be true when the new scene is created; false otherwise

The following example adds a new scene using the default naming convention. If only one scene
exists, the newly created scene is named

fl.getDocumentDOM().addNewScene();

70 Chapter 3: Objects

"Scene 2".

document.addNewText()

Availability

Flash MX 2004.

Usage

document.addNewText( boundingRectangle )

Parameters

boundingRectangle

pixels for

left, top, right, and bottom. The method applies the current text attributes. It

should be followed by calling

Returns

Specifies the size and location of the text field by providing locations in

setTextString() to populate the new text box.

Nothing.

Description

Method; inserts a new empty text field. See document.setTextString().

Example

The following example creates a new text field in the upper left corner of the Stage and then sets
the text string to

fl.getDocumentDOM().addNewText({left:0, top:0, right:100, bottom:100});
fl.getDocumentDOM().setTextString('Hello World!');

"Hello World":

document.align()

Availability

Flash MX 2004.

Usage

document.align( alignmode [, bUseDocumentBounds ] )

Parameters

alignmode

"left", "right", "top", "bottom", "vertical center", and "horizontal center".

bUseDocumentBounds A Boolean value that, if set to true, causes the method to align to the

A string that specifies how to align the selection. Valid values for alignmode are

bounds of the document. Otherwise, the method uses the bounds of the selected objects. The
default is

Returns

false. This parameter is optional.

Nothing.

Description

Method; aligns the selection. See document.distribute(),

document.setAlignToDocument(), and document.getAlignToDocument().

Document object 71

Example

The following example aligns objects to left and to the Stage. This is equivalent to turning on the
To Stage setting in the Align panel and clicking the Align to Left button:

fl.getDocumentDOM().align("left", true);

document.allowScreens()

Availability

Flash MX 2004.

Usage

document.allowScreens()

Parameters

None.

Returns

Returns a Boolean value: true if dom.screenOutline can be used safely; false otherwise.

Description

Method; Used before using the document.screenOutline property. If this method returns the
value

true, you can safely access the screenOutline property. Flash displays an error if you

access the

Example

screenOutline property in a document without screens.

The following example determines whether screens methods can be used in the current
document:

if(fl.getDocumentDOM().allowScreens()) {

fl.trace("screen outline is available.");
}
else {

fl.trace("whoops, no screens.");
}

document.arrange()

Availability

Flash MX 2004.

Usage

document.arrange( arrangeMode )

Parameters

arrangeMode
arrangemode are "back", "backward", "forward", and "front". It provides the same

Specifies the direction in which to move the selection. The valid values for

capabilities as these options provide on the Modify >Arrange menu.

72 Chapter 3: Objects

Returns

Nothing.

Description

Method; arranges the selection on the Stage. This method applies only to non-shape objects.

Example

The following example moves the current selection to the front:

fl.getDocumentDOM().arrange("front");

document.autoLabel

Availability

Flash MX 2004.

Usage

document.autoLabel

Description

Property; A Boolean value that is equivalent to the Auto Label check box in the Accessibility
panel. You can use this property to tell Flash to automatically label objects on the Stage with the
text associated with them.

Example

The following example gets the value of the autoLabel property and displays the result in the
Output panel:

var isAutoLabel = fl.getDocumentDOM().autoLabel;
fl.trace(isAutoLabel);

The following example sets the autoLabel property to true, telling Flash to automatically label
objects on the Stage:

fl.getDocumentDOM().autoLabel = true;

document.backgroundColor

Availability

Flash MX 2004.

Usage

document.backgroundColor

Description

Property; a color in hexidecimal format that represents the background color.

Example

The following example sets the background color to black:

fl.getDocumentDOM().backgroundColor = '#000000';

Document object 73

document.breakApart()

Availability

Flash MX 2004.

Usage

document.breakApart()

Parameters

None.

Returns

Nothing.

Description

Method; performs a break-apart operation on the current selection.

Example

The following example breaks apart the current selection:

fl.getDocumentDOM().breakApart();

document.canEditSymbol()

Availability

Flash MX 2004.

Usage

document.canEditSymbol()

Parameters

None.

Returns

A Boolean value: true if the Edit Symbols menu and functionality are available for use; false
otherwise.

Description

Method; indicates whether the Edit Symbols menu and functionality are enabled. This is not
related to whether the selection can be edited. This method should not be used to test whether

fl.getDocumentDOM().enterEditMode() is allowed.

Example

The following example displays in the Output panel the state of the Edit Symbols menu and
functionality:

fl.trace("fl.getDocumentDOM().canEditSymbol() returns: " +

fl.getDocumentDOM().canEditSymbol());

74 Chapter 3: Objects

document.canRevert()

Availability

Flash MX 2004.

Usage

document.canRevert()

Parameters

None.

Returns

A Boolean value: true if you can use the document.revert() or fl.revertDocument()
methods successfully;

Description

false otherwise.

Method; determines whether you can use the document.revert() or fl.revertDocument()
method successfully.

Example

The following example checks whether the current document can revert to the previously saved
version. If so,

if(fl.getDocumentDOM().canRevert()){

fl.getDocumentDOM().revert();
}

fl.getDocumentDOM().revert() restores the previously saved version.

document.canTestMovie()

Availability

Flash MX 2004.

Usage

document.canTestMovie()

Parameters

None.

Returns

A Boolean value: true if you can use the document.testMovie() method successfully: false
otherwise.

Description

Method; determines whether you can use the document.testMovie() method successfully. See

document.canTestScene() and document.testScene().

Document object 75

Example

The following example tests whether fl.getDocumentDOM().testMovie() can be used. If so, it
calls the method.

if(fl.getDocumentDOM().canTestMovie()){

fl.getDocumentDOM().testMovie();
}

document.canTestScene()

Availability

Flash MX 2004.

Usage

document.canTestScene()

Parameters

None.

Returns

A Boolean value: true if you can use the document.testScene() method successfully; false
otherwise.

Description

Method; determines whether you can use the document.testScene() method successfully. See

document.canTestMovie() and document.testMovie().

Example

The following example first tests whether fl.getDocumentDOM().testScene() can be used
successfully. If so, it calls the method.

if(fl.getDocumentDOM().canTestScene()){

fl.getDocumentDOM().testScene();
}

document.clipCopy()

Availability

Flash MX 2004.

Usage

document.clipCopy()

Parameters

None.

Returns

Nothing.

76 Chapter 3: Objects

Description

Method; copies the current selection from the document to the Clipboard.

Example

The following example copies the current selection from the document to the Clipboard:

fl.getDocumentDOM().clipCopy();

document.clipCut()

Availability

Flash MX 2004.

Usage

document.clipCut()

Parameters

None.

Returns

Nothing.

Description

Method; cuts the current selection from the document and writes it to the Clipboard.

Example

The following example cuts the current selection from the document and writes it to the
Clipboard:

fl.getDocumentDOM().clipCut();

document.clipPaste()

Availability

Flash MX 2004.

Usage

document.clipPaste( [bInPlace] )

Parameters

bInPlace

place operation. The default value is

A Boolean value that, when set to true, causes the method to perform a paste-in-

false, which causes the method to perform a paste

operation to the center of the document. This parameter is optional.

Returns

Nothing.

Description

Method; pastes the contents of the Clipboard into the document.

Document object 77

Example

The following examples pastes the Clipboard contents to the center of the document:

fl.getDocumentDOM().clipPaste();

The following example pastes the Clipboard contents in place in the current document:

fl.getDocumentDOM().clipPaste(true);

document.close()

Availability

Flash MX 2004.

Usage

document.close( [bPromptToSaveChanges] )

Parameters

bPromptToSaveChanges

A Boolean value that, when set to true, causes the method to prompt

the user with a dialog box if there are unsaved changes in the document. If

bPromptToSaveChanges is set to false, the user is not prompted to save any changed

documents. The default value is

Returns

true. This parameter is optional.

Nothing.

Description

Method; closes the specified document.

Example

The following example closes the current document and prompts the user with a dialog box to
save changes:

fl.getDocumentDOM().close();

The following example closes the current document without saving changes:

fl.getDocumentDOM().close(false);

document.convertLinesToFills()

Availability

Flash MX 2004.

Usage

document.convertLinesToFills()

Parameters

None.

78 Chapter 3: Objects

Returns

Nothing.

Description

Method; converts lines to fills on the selected objects.

Example

The following example converts the current selected lines to fills:

fl.getDocumentDOM().convertLinesToFills();

document.convertToSymbol()

Availability

Flash MX 2004.

Usage

document.convertToSymbol( type

Parameters

type

A string that specifies the type of symbol to create. Valid values for type are "movie

, "button", and "graphic".

clip"

name A string that specifies the name for the new symbol, which must be unique. You can

, name, registrationPoint )

submit an empty string to have this method create a unique symbol name for you.

registration point Specifies the point that represents the 0,0 location for the symbol.

Acceptable values are:

"center right", "bottom left", "bottom center", and "bottom right".

"top left", "top center", "top right", "center left", "center",

Returns

An object for the newly created symbol, or null if it cannot create the symbol.

Description

Method; converts the selected Stage item(s) to a new symbol. For information on defining linkage
and shared asset properties for a symbol, see Item object.

Example

The following examples create a movie clip symbol with a specified name, a button symbol with a
specified name, and a movie clip symbol with a default name:

newMc = fl.getDocumentDOM().convertToSymbol("movie clip", "mcSymbolName", "top

left");
newButton = fl.getDocumentDOM().convertToSymbol("button", "btnSymbolName",

"bottom right");
newClipWithDefaultName = fl.getDocumentDOM().convertToSymbol("movie clip", "",

"top left");

Document object 79

document.currentPublishProfile

Availability

Flash MX 2004.

Usage

document.currentPublishProfile

Description

Property; a string that specifies the name of the active publish profile for the specified document.

Example

The following example adds a new publish profile with the default name and then displays the
name of the profile in the Output panel:

fl.getDocumentDOM().addNewPublishProfile();
fl.outputPanel.trace(fl.getDocumentDOM().currentPublishProfile);

The following example changes the selected publish profile to "Default":

fl.getDocumentDOM().currentPublishProfile = "Default";

document.currentTimeline

Availability

Flash MX 2004.

Usage

document.currentTimeline

Description

Property; an integer that specifies the index of the active Timeline. You can set the active Timeline
by changing the value of this property; the effect is almost equivalent to calling

document.editScene(). The only difference is that you don’t get an error message if the index of

the Timeline is not valid (the property is simply not set, which causes silent failure).

See

document.getTimeline().

Example

The following example displays the index of the current Timeline.

var myCurrentTL = fl.getDocumentDOM().currentTimeline;
fl.trace("The index of the current timeline is: "+ myCurrentTL);

The following example changes the active Timeline from the main Timeline to a scene named

"myScene".

var i = 0;
var curTimelines = fl.getDocumentDOM().timelines;
while(i < fl.getDocumentDOM().timelines.length){

if(curTimelines[i].name == "myScene"){

fl.getDocumentDOM().currentTimeline = i;

}

80 Chapter 3: Objects

++i;
}

document.deletePublishProfile()

Availability

Flash MX 2004.

Usage

document.deletePublishProfile()

Parameters

None.

Returns

An integer that is the index of the new current profile. If a new profile is not available, the method
leaves the current profile unchanged and returns its index.

Description

Method; deletes the currently active profile, if there is more than one. There must be at least one
profile left. See

Example

document.addNewPublishProfile().

The following example deletes the currently active profile, if there is more than one, and displays
the index of the new currently active profile:

alert(fl.getDocumentDOM().deletePublishProfile());

document.deleteScene()

Availability

Flash MX 2004.

Usage

document.deleteScene()

Parameters

None.

Returns

A Boolean value: true if the scene is successfully deleted; false otherwise.

Description

Method; deletes the current scene (Timeline object) and, if the deleted scene was not the last one,
sets the next scene as the current Timeline object. If the deleted scene was the last one, it sets the
first object as the current Timeline object. If only one
the value

false.

Timeline object (scene) exists, it returns

Document object 81

Example

Assuming there are three scenes (Scene0, Scene1, and Scene2) in the current document, the
following example makes

fl.getDocumentDOM().editScene(2);
var success = fl.getDocumentDOM().deleteScene();

Scene2 the current scene and then deletes it:

document.deleteSelection()

Availability

Flash MX 2004.

Usage

document.deleteSelection()

Parameters

None.

Returns

Nothing.

Description

Method; deletes the current selection on the Stage. Displays an error message if there is no
selection.

Example

The following example deletes the current selection in the document:

fl.getDocumentDOM().deleteSelection();

document.description

Availability

Flash MX 2004.

Usage

document.description

Description

Property; a string that is equivalent to the Description field in the Accessibility panel. The
description is read by the screen reader.

Example

The following example sets the description of the document:

fl.getDocumentDOM().description= "This is the main movie";

The following example gets the description of the document and displays it in the Output panel:

fl.trace(fl.getDocumentDOM().description);

82 Chapter 3: Objects

document.distribute()

Availability

Flash MX 2004.

Usage

document.distribute( distributemode [, bUseDocumentBounds ] )

Parameters

distributemode
distributeMode are "left edge", "horizontal center", "right edge", "top edge",

"vertical center", and "bottom edge".

bUseDocumentBounds A Boolean value that, when set to true, distributes the selected objects

A string that specifies where to distribute the selected object. Valid values for

using the bounds of the document. Otherwise, the method uses the bounds of the selected object.
The default is

Returns

false.

Nothing.

Description

Method; distributes the selection. See document.setAlignToDocument() and

document.getAlignToDocument().

Example

The following example distributes the selected objects by the top edge:

fl.getDocumentDOM().distribute("top edge");

The following example distributes the selected objects by top edge and expressly sets the

bUseDcoumentBounds parameter:

fl.getDocumentDOM().distribute("top edge", false);

The following example distributes the selected objects by their top edges, using the bounds of the
document:

fl.getDocumentDOM().distribute("top edge", true);

document.distributeToLayers()

Availability

Flash MX 2004.

Usage

document.distributeToLayers()

Parameters

None.

Document object 83

Returns

Nothing.

Description

Method; performs a distribute-to-layers operation on the current selection—equivalent to
selecting Distribute to Layers. This method displays an error if there is no selection.

Example

The following example distributes the current selection to layers:

fl.getDocumentDOM().distributeToLayers();

document.documentHasData()

Availability

Flash MX 2004.

Usage

document.documentHasData( name )

Parameters

name

A string that specifies the name of the data to check.

Returns

A Boolean value: true if the document has persistent data; false otherwise.

Description

Method; checks the document for persistent data with the specified name. See

document.addDataToDocument(), document.getDataFromDocument(), and
document.removeDataFromDocument().

Example

The following example checks the document for persistent data with the name "myData":

var hasData = fl.getDocumentDOM().documentHasData("myData");

document.duplicatePublishProfile()

Availability

Flash MX 2004.

Usage

document.duplicatePublishProfile( [profileName ] )

Parameters

profileName

A string that specifies the unique name of the duplicated profile. If you do not

specify a name, the method uses the default name. This parameter is optional.

84 Chapter 3: Objects

Returns

An integer that is the index of the new profile in the profile list. Returns -1 if the profile cannot
be duplicated.

Description

Method; duplicates the currently active profile and gives the duplicate version focus.

Example

The following example duplicates the currently active profile and displays the index of the new
profile in the Output panel:

fl.trace(fl.getDocumentDOM().duplicatePublishProfile("dup profile"));

document.duplicateScene()

Availability

Flash MX 2004.

Usage

document.duplicateScene()

Parameters

None.

Returns

A Boolean value: true if the scene is duplicated successfully; false otherwise.

Description

Method; makes a copy of the currently selected scene, giving the new scene a unique name and
making it the current scene.

Example

The following example duplicates the second scene in the current document:

fl.getDocumentDOM().editScene(1); //set the middle scene to current scene
var success = fl.getDocumentDOM().duplicateScene();

document.duplicateSelection()

Availability

Flash MX 2004.

Usage

document.duplicateSelection()

Parameters

None.

Document object 85

Returns

Nothing.

Description

Method; duplicates the selection on the Stage.

Example

The following example duplicates the current selection, which is similar to Alt-clicking and then
dragging an item:

fl.getDocumentDOM().duplicateSelection();

document.editScene()

Availability

Flash MX 2004.

Usage

document.editScene( index )

Parameters

index

A zero-based integer that specifies which scene to edit.

Returns

Nothing.

Description

Method; makes the specified scene the currently selected scene for editing.

Example

Assuming that there are three scenes (Scene0, Scene1, and Scene2) in the current document, the
following example makes

fl.getDocumentDOM().editScene(2);
fl.getDocumentDOM().deleteScene();

Scene2 the current scene and then deletes it:

document.enterEditMode()

Availability

Flash MX 2004.

Usage

document.enterEditMode( [editMode] )

Parameters

editMode

"newWindow". If no parameter is specified, the default is symbol-editing mode. This parameter is

A string that specifies the editing mode. Valid values are "inPlace" or

optional.

86 Chapter 3: Objects

Returns

Nothing.

Description

Method; switches the authoring tool into the editing mode specified by the parameter. If no
parameter is specified, the method defaults to symbol-editing mode, which has the same result as
right-clicking the symbol to invoke the context menu and selecting Edit. See

document.exitEditMode().

Example

The following example puts Flash in edit-in-place mode for the currently selected symbol:

fl.getDocumentDOM().enterEditMode('inPlace');

The following example puts Flash in edit-in-new-window mode for the currently selected symbol:

fl.getDocumentDOM().enterEditMode('newWindow');

document.exitEditMode()

Availability

Flash MX 2004.

Usage

document.exitEditMode()

Parameters

None.

Returns

Nothing.

Description

Method; exits from symbol-editing mode and returns focus to the next level up from the editing
mode. For example, if you are editing a symbol inside another symbol, this method takes you up
a level from the symbol you are editing, into the parent symbol. See

document.enterEditMode().

Example

The following example exits symbol-editing mode:

fl.getDocumentDOM().exitEditMode();

document.exportPublishProfile()

Availability

Flash MX 2004.

Usage

document.exportPublishProfile( fileURI )

Document object 87

Parameters

fileURI

A string, expressed as a file://URL, that specifies the path of the XML file to which the

profile is exported.

Returns

Nothing.

Description

Method; exports the currently active profile to a file.

Example

The following example exports the currently active profile to the file named profile.xml in the
folder /Documents and Settings/username/Desktop on the C drive:

fl.getDocumentDOM().exportPublishProfile('file:///C|/Documents and Settings/

username/Desktop/profile.xml');

document.exportSWF()

Availability

Flash MX 2004.

Usage

document.exportSWF( [fileURI]

Parameters

fileURI
fileURI is empty or not specified, Flash displays the Export Movie dialog box. This parameter is

A string, expressed as a file://URL, that specifies the name of the exported file. If

{, bCurrentSettings] )

optional.

bCurrentSettings A Boolean value that, when set to true, causes Flash to use current SWF

publish settings. Otherwise, Flash displays the Export Flash Player dialog box. The default is

false. This parameter is optional.

Returns

Nothing.

Description

Method; exports the document to the specified file in the Flash SWF format.

Example

The following example exports the document to the specified file location with the current
publish settings:

fl.getDocumentDOM().exportSWF("file:///C|/Documents and Settings/gdrieu/

Desktop/qwerty.swf");

88 Chapter 3: Objects

The following example displays the Export Movie dialog box and the Export Flash Player dialog
box and then exports the document based on the specified settings:

fl.getDocumentDOM().exportSWF("", true);

The following example displays the Export Movie dialog box and then exports the document with
specified settings:

fl.getDocumentDOM().exportSWF();

document.forceSimple

Availability

Flash MX 2004.

Usage

document.forceSimple

Description

Property; a Boolean value that specifies whether the children of the specified object are accessible.
This is equivalent to the inverse logic of the Make Child Objects Accessible setting in the
Accessibility panel. That is, if
Accessible option being unchecked. If

forceSimple is true, it is the same as the Make Child Object

forceSimple is false, it is the same as the Make Child

Object Accessible option being checked.

Example

The following example sets the areChildrenAccessible variable to the value of the

forceSimple property; a value of false means the children are accessible:

var areChildrenAccessible = fl.getDocumentDOM().forceSimple;

The following example sets the forceSimple property to allow the children of the document to
be accessible:

fl.getDocumentDOM().forceSimple = false;

document.frameRate

Availability

Flash MX 2004.

Usage

document.frameRate

Description

Property; a float value that specifies the number of frames displayed per second when the SWF
file plays; the default is 12. This is the same functionality as setting the frame rate in the
Document properties dialog box (Modify > Document).

Document object 89

Example

The following example sets the frame rate to 25.5 frames per second:

fl.getDocumentDOM().frameRate = 25.5;

document.getAlignToDocument()

Availability

Flash MX 2004.

Usage

document.getAlignToDocument()

Parameters

None.

Returns

A Boolean value: true if the preference is set to align the objects to the Stage; false otherwise.

Description

Method; identical to retrieving the value of the To Stage button in the Align panel. Gets the
preference that can be used for

document.match(), and document.space() methods on the document. See
document.setAlignToDocument().

Example

document.align(), document.distribute(),

The following example retrieves the value of the To Stage button in the Align panel. If the return
value is

var isAlignToDoc = fl.getDocumentDOM().getAlignToDocument();
fl.getDocumentDOM().align("left", isAlignToDoc);

true, the To Stage button is active; otherwise, it is not.

document.getCustomFill()

Availability

Flash MX 2004.

Usage

document.getCustomFill( [ objectToFill ] )

Parameters

objectToFill

A string that specifies the location of the fill object. The following values are

valid:

• "toolbar", which returns the fill object of the toolbar and Property inspector

• "selection", which returns the fill object of the selection

If you omit this parameter, the default value is
returns

undefined. This parameter is optional.

90 Chapter 3: Objects

"selection". If there is no selection, the method

Returns

The Fill object specified by the objectToFill parameter, if successful; otherwise, it returns

undefined.

Description

Method; retrieves the fill object of the selected shape or, if specified, of the toolbar and Property
inspector. See

Example

document.setCustomFill().

The following example gets the fill object of the selection and then changes the selection’s color to
white:

var fill = fl.getDocumentDOM().getCustomFill();
fill.color = '#FFFFFF';
fill.style = "solid";
fl.getDocumentDOM().setCustomFill(fill);

The following example returns the fill object of the toolbar and Property inspector and then
changes the color swatch to a linear gradient:

var fill = fl.getDocumentDOM().getCustomFill("toolbar");
fill.style = "linearGradient";
fill.colorArray = [ 0x00ff00, 0xff0000, 0x0000ff ];
fill.posArray = [0, 100, 200];
fl.getDocumentDOM().setCustomFill( fill );

document.getCustomStroke()

Availability

Flash MX 2004.

Usage

document.getCustomStroke( [locationOfStroke] )

Parameters

locationOfStroke

A string that specifies the location of the stroke object. The following values

are valid:

• "toolbar", which, if set, returns the stroke object of the toolbar and Property inspector.

• "selection", which, if set, returns the stroke object of the selection.

If you omit this parameter, it defaults to

undefined. This parameter is optional.

Returns

The Stroke object specified by the locationOfStroke parameter, if successful; otherwise, it
returns

undefined.

"selection". If there is no selection, it returns

Document object 91

Description

Returns the stroke object of the selected shape or, if specified, of the toolbar and Property
inspector. See

Example

document.setCustomStroke().

The following example returns the current stroke settings of the selection and changes the stroke
thickness to 2:

var stroke = fl.getDocumentDOM().getCustomStroke("selection");
stroke.thickness = 2;
fl.getDocumentDOM().setCustomStroke(stroke);

The following example returns the current stroke settings of the toolbar and Property inspector
and sets the stroke color to red:

var stroke = fl.getDocumentDOM().getCustomStroke("toolbar");
stroke.color = "#FF0000";
fl.getDocumentDOM().setCustomStroke(stroke);

document.getDataFromDocument()

Availability

Flash MX 2004.

Usage

document.getDataFromDocument( name )

Parameters

name

A string that specifies the name of the data to return.

Returns

The specified data.

Description

Method; retrieves the value of the specified data. The type returned depends on the type of data
that was stored. See

document.removeDataFromDocument().

Example

document.addDataToDocument(), document.documentHasData(), and

The following example adds an integer value of 12 to the current document and uses this method
to display the value in the Output panel:

fl.getDocumentDOM().addDataToDocument("myData", "integer", 12);
fl.trace(fl.getDocumentDOM().getDataFromDocument("myData"));

92 Chapter 3: Objects

document.getElementProperty()

Availability

Flash MX 2004.

Usage

document.getElementProperty( propertyName )

Parameters

The name of the Element property for which to retrieve the value.

Returns

The value of the specified property. Returns null if the property is an indeterminate state, as
when multiple elements are selected with different property values. Returns

undefined if the

property is not a valid property of the selected element.

Description

Method; gets the specified Element property for the current selection. See “Property summary for

the Element object” on page 149 for a list of valid values. See

document.setElementProperty().

Example

The following example gets the name of the Element property for the current selection:

//elementName = the instance name of the selected object
var elementName = fl.getDocumentDOM().getElementProperty("name");

document.getElementTextAttr()

Availability

Flash MX 2004.

Usage

document.getElementTextAttr( attrName

Parameters

attrName

A string that specifies the name of the TextAttrs property to be returned. For a list

[, startIndex [, endIndex]] )

of property names and expected values, see “Property summary for the TextAttrs object”

on page 299.

startIndex An integer that specifies the index of first character, with 0 (zero) specifying the

first position. This parameter is optional.

endIndex An integer that specifies the index of last character. This parameter is optional.

Document object 93

Returns

If one text field is selected, the property is returned if there is only one value used within the text.
Returns

undefined if there are several values used inside the text field. If several text fields are

selected, and all the text alignment values are equal, the method returns this value. If several text
fields are selected, but all the text alignment values are not equal, the method returns

undefined.

If the optional arguments are not passed, these rules apply to the range of text currently selected
or the whole text field if the text is not currently being edited. If only

startIndex is passed, the

property of the character to the right of the index is returned, if all the selected text objects match
values. If
characters from

Description

startIndex and endIndex are passed, the value returned reflects the entire range of

startIndex up to, but not including, endIndex.

Method; gets a specific TextAttrs property of the selected text objects. Selected objects that are
not text fields are ignored. For a list of property names and expected values, see “Property

summary for the TextAttrs object” on page 299. See

Example

document.setElementTextAttr().

The following example gets the size of the selected text fields:

fl.getDocumentDOM().getElementTextAttr("size");

The following example gets the color of the character at index 3 in the selected text fields:

fl.getDocumentDOM().getElementTextAttr("fillColor", 3);

The following example gets the font name of the text from index 2 up to, but not including,
index 10 of the selected text fields:

fl.getDocumentDOM().getElementTextAttr("face", 2, 10);

document.getSelectionRect()

Availability

Flash MX 2004.

Usage

document.getSelectionRect()

Parameters

None.

Returns

The bounding rectangle of the current selection, or 0 if nothing is selected.

Description

Method; gets the bounding rectangle of the current selection. If a selection is non-rectangular, the
smallest rectangle encompassing the entire selection is returned. The rectangle is based on the
document space or, when in an edit mode, the registration point of the symbol being edited. See

document.setSelectionRect().

94 Chapter 3: Objects

Example

The following example gets the bounding rectangle for the current selection and then displays its
properties:

var newRect = fl.getDocumentDOM().getSelectionRect();
var outputStr = "left: " + newRect.left + " top: " + newRect.top + " right: " +

newRect.right + " bottom: " + newRect.bottom;
alert(outputStr);

document.getTextString()

Availability

Flash MX 2004.

Usage

document.getTextString( [startIndex [, endIndex]] )

Parameters

startIndex

endIndex An integer that is an index of last character to get. This parameter is optional.

Returns

An integer that is an index of first character to get. This parameter is optional.

A string that contains the selected text.

Description

Method; gets the currently selected text. If the optional parameters are not passed, the current text
selection is used. If text is not currently opened for editing, the whole text string is returned. If
only

startIndex is passed, the string starting at that index and ending at the end of the field is

returned. If
but not including,

startIndex and endIndex are passed, the string starting from startIndex up to,

endIndex is returned. See document.setTextString().

If there are several text fields selected, the concatenation of all the strings is returned.

Example

The following example gets the string in the selected text fields:

fl.getDocumentDOM().getTextString();

The following example gets the string at character index 5 in the selected text fields:

fl.getDocumentDOM().getTextString(5);

The following example gets the string from character index 2 up to, but not including, character
index 10:

fl.getDocumentDOM().getTextString(2, 10);

Document object 95

document.getTimeline()

Availability

Flash MX 2004.

Usage

document.getTimeline()

Parameters

None.

Returns

The current Timeline object.

Description

Method; retrieves the current Timeline object in the document. The current Timeline can be the
current scene, the current symbol being edited, or the current screen. See

document.currentTimeline, document.timelines, and symbolItem.timeline.

Example

The following example gets the Timeline object and returns the number of frames in the longest
layer:

var longestLayer = fl.getDocumentDOM().getTimeline().frameCount;
fl.trace("The longest layer has" + longestLayer + "frames");

The following example enters edit-in-place mode for the selected symbol on the Stage and inserts
a frame on the symbol’s Timeline.

fl.getDocumentDOM().enterEditMode("inPlace");
fl.getDocumentDOM().getTimeline().insertFrames();

The following example gets the Timeline object and displays its name:

var timeline = fl.getDocumentDOM().getTimeline();
alert(timeline.name);

document.getTransformationPoint()

Availability

Flash MX 2004.

Usage

document.getTransformationPoint()

Parameters

None.

Returns

The location of the transformation point.

96 Chapter 3: Objects

Description

Method; gets the location of the transformation point of the current selection. You can use the
transformation point for commutations such as rotate and skew. See

document.setTransformationPoint().

Example

The following example gets the transformation point for the current selection. The

transPoint.x property gives the x coordinate of the transformation point. The transPoint.y

property gives the y coordinate of the transformation point:

var transPoint = fl.getDocumentDOM().getTransformationPoint();

document.group()

Availability

Flash MX 2004.

Usage

document.group()

Parameters

None.

Returns

Nothing.

Description

Method; converts the current selection to a group. See document.unGroup().

Example

The following example converts the objects in the current selection to a group:

fl.getDocumentDOM().group();

document.height

Availability

Flash MX 2004.

Usage

document.height

Description

Property; an integer that specifies the height of the document (Stage) in pixels. See

document.width.

Document object 97

Example

The following example sets the height of the Stage to 400 pixels:

fl.getDocumentDOM().height = 400;

document.importPublishProfile()

Availability

Flash MX 2004.

Usage

document.importPublishProfile( fileURI )

Parameters

fileURI

A string that specifies the path, expressed as a file://URL, of the XML file defining the

profile to import.

Returns

An integer that is the index of the imported profile in the profiles list. Returns -1 if the profile
cannot be imported.

Description

Method; imports a profile from a file.

Example

The following example imports the profile contained in the profile.xml file and displays its index
in the profiles list:

alert(fl.getDocumentDOM().importPublishProfile('file:///C|/Documents and

Settings/username/Desktop/profile.xml'));

document.importSWF()

Availability

Flash MX 2004.

Usage

document.importSWF( fileURI )

Parameters

fileURI

Returns

A string that specifies the URI, expressed as a file://URI, for the SWF file to import.

Nothing.

Description

Method; imports a SWF file into the document. Performs the same operation as using the Import
menu option to specify a SWF file.

98 Chapter 3: Objects

Example

The following example imports the "mySwf.swf" file from the Flash Configuration folder:

fl.getDocumentDOM().importSWF(fl.configURI+"mySwf.swf");

document.library

Availability

Flash MX 2004.

Usage

document.library

Description

Read-only property; the library object for a document.

Example

The following example gets the library for the currently focused document:

var myCurrentLib = fl.getDocumentDOM().library;

Assuming the currently focused document is not fl.documents[1], the following example gets
the library for a non-focused library or for a library you opened using File > Open as external
library:

var externalLib = fl.documents[1].library;

document.livePreview

Availability

Flash MX 2004.

Usage

document.livePreview

Description

Property; a Boolean value that specifies if Live Preview is enabled. If set to true, components
appear on the Stage as they will appear in the published Flash content, including their
approximate size. If set to

Example

false, components appear only as outlines. The default value is true.

The following example sets Live Preview to false:

fl.getDocumentDOM().livePreview = false;

Document object 99

document.match()

Availability

Flash MX 2004.

Usage

document.match( bWidth, bHeight [, bUseDocumentBounds] )

Parameters

bWidth

A Boolean value that, when set to true, causes the method to make the widths of the

selected items the same.

bHeight A Boolean value that, when set to true, causes the method to make the heights of the

selected items the same.

bUseDocumentBounds A Boolean value that, when set to true, causes the method to match the

size of the objects to the bounds of the document. Otherwise, the method uses the bounds of the
largest object. The default is false. This parameter is optional.

Returns

Nothing.

Description

Method; makes the size of the selected objects the same. See document.setAlignToDocument()
and

document.getAlignToDocument().

Example

The following example matches the width of the selected objects only:

fl.getDocumentDOM().match(true,false);

The following example matches the height only:

fl.getDocumentDOM().match(false,true);

The following example matches the width only to the bounds of the document:

fl.getDocumentDOM().match(true,false,true);

document.mouseClick()

Availability

Flash MX 2004.

Usage

document.mouseClick( position

Parameters

position

A pair of floating point values that specify the x and y coordinates of the click in

pixels.

100 Chapter 3: Objects

, bToggleSel, bShiftSel )