Adobe Extending Flash Professional CS4 User Manual

Extending

ADOBE® FLASH® CS4 PROFESSIONAL

Copyright

© 2008 Adobe Systems Incorporated. All rights reserved.
Extending Flash® for Windows® and Mac OS

If this guide is distributed with software that includes an end-user agreement, this guide, as well as the software described in it, is furnished under license and
may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored
in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe
Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end­user license agreement.

The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe
Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational
content contained in this guide.

Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law. The unauthorized
incorporation of such material into your new work could be a violation of the rights of the copyright owner. Please be sure to obtain any permission required
from the copyright owner.

Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual organization.

Adobe, the Adobe logo, ActionScript, Dreamweaver, Fireworks, Flash, Flash Lite, and Version Cue are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States and/or other countries.

Windows and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. Macintosh and
Mac OS are trademarks of Apple Inc., registered in the United States and other countries. All other trademarks are the property of their respective owners.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

MPEG Layer-3 audio compression technology licensed by Fraunhofer IIS and Thomson Multimedia (http://www.mp3licensing.com).

Speech compression and decompression technology licensed from Nellymoser, Inc. (www.nellymoser.com).

Video compression and decompression is powered by On2 TrueMotion video technology. © 1992-2005 On2 Technologies, Inc. All Rights Reserved.
http://www.on2.com.

This product includes software developed by the OpenSymphony Group (http://www.opensymphony.com/).

This product contains either BSAFE and/or TIPEM software by RSA Security, Inc.

Sorenson Spark™ video compression and decompression technology licensed from Sorenson Media, Inc.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA

Notice to U.S. government end users. The software and documentation are “Commercial Items,” as that term is defined at 48 C.F.R. §2.101, consisting of
“Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202,
as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and
Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial items and (b) with only those rights
as are granted to all other end users pursuant to the terms and conditions herein. Unpublished-rights reserved under the copyright laws of the United States.
Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable
equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment
Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60,
60-250 ,and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.

Contents

Chapter 1: Introduction

Working with the JavaScript API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

What’s new in the JavaScript API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

JavaScript API objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Sample implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 2: Top-Level Functions and Methods

activate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

alert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

configureTool() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

confirm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

deactivate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

keyDown() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

keyUp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

mouseDoubleClick() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

mouseDown() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

mouseMove() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

mouseUp() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

notifySettingsChanged() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

prompt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

setCursor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

iii

Chapter 3: actionsPanel object

actionsPanel.getClassForObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

actionsPanel.getScriptAssistMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

actionsPanel.getSelectedText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

actionsPanel.getText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

actionsPanel.hasSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

actionsPanel.replaceSelectedText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

actionsPanel.setScriptAssistMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

actionsPanel.setSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

actionsPanel.setText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Chapter 4: BitmapInstance object

bitmapInstance.getBits() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

bitmapInstance.hPixels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

bitmapInstance.setBits() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

bitmapInstance.vPixels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Chapter 5: BitmapItem object

bitmapItem.allowSmoothing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

bitmapItem.compressionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

bitmapItem.exportToFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

bitmapItem.fileLastModifiedDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

bitmapItem.originalCompressionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

bitmapItem.quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

bitmapItem.sourceFileExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

bitmapItem.sourceFileIsCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

bitmapItem.sourceFilePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

bitmapItem.useDeblocking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

bitmapItem.useImportedJPEGQuality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Chapter 6: CompiledClipInstance object

compiledClipInstance.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

compiledClipInstance.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

compiledClipInstance.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

compiledClipInstance.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

compiledClipInstance.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

compiledClipInstance.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

compiledClipInstance.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Chapter 7: compilerErrors object

compilerErrors.clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

compilerErrors.save() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

iv

Chapter 8: ComponentInstance object

componentInstance.parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Chapter 9: componentsPanel object

componentsPanel.addItemToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

componentsPanel.reload() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Chapter 10: Contour object

contour.fill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

contour.getHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

contour.interior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

contour.orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Chapter 11: Document object

document.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

document.addDataToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

document.addDataToSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

document.addFilter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

document.addItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

document.addNewLine() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

document.addNewOval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

document.addNewPrimitiveOval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

document.addNewPrimitiveRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

document.addNewPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

document.addNewRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

document.addNewScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

document.addNewText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

document.align() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

document.allowScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

document.arrange() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

document.as3AutoDeclare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

document.as3Dialect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

document.as3ExportFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

document.as3StrictMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

document.as3WarningsMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

document.asVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

document.autoLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

document.backgroundColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

document.breakApart() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

document.canEditSymbol() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

document.canRevert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

document.canSaveAVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

document.canTestMovie() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

document.canTestScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

document.changeFilterOrder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

document.clipCopy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

document.clipCut() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

document.clipPaste() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

document.close() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

document.convertLinesToFills() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

document.convertToSymbol() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

document.crop() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

document.currentPublishProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

document.currentTimeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

document.deleteEnvelope() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

document.deletePublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

document.deleteScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

document.deleteSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

document.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

document.disableAllFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

document.disableFilter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

document.disableOtherFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

document.distribute() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

document.distributeToLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

document.docClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

document.documentHasData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

document.duplicatePublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

document.duplicateScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

document.duplicateSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

document.editScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

document.enableAllFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

document.enableFilter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

document.enterEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

v

document.exitEditMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

document.exportPNG() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

document.exportPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

document.exportPublishProfileString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

document.exportSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

document.externalLibraryPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

document.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

document.frameRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

document.getAlignToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

document.getBlendMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

document.getCustomFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

document.getCustomStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

document.getDataFromDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

document.getElementProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

document.getElementTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

document.getFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

document.getMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

document.getMobileSettings() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

document.getPlayerVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

document.getSelectionRect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

document.getTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

document.getTimeline() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

document.getTransformationPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

document.group() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

document.height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

document.id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

document.importFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

document.importPublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

document.importPublishProfileString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

document.importSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

document.intersect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

document.library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

document.libraryPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

document.livePreview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

document.match() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

document.mouseClick() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

document.mouseDblClk() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

document.moveSelectedBezierPointsBy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

document.moveSelectionBy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

document.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

document.optimizeCurves() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

document.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

document.pathURI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

document.publish() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

document.publishProfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

document.punch() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

vi

document.removeAllFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

document.removeDataFromDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

document.removeDataFromSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

document.removeFilter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

document.renamePublishProfile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

document.renameScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

document.reorderScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

document.resetOvalObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

document.resetRectangleObject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

document.resetTransformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

document.revert() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

document.revertToLastVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

document.rotate3DSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

document.rotateSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

document.save() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

document.saveAndCompact() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

document.saveAVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

document.scaleSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

document.screenOutline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

document.selectAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

document.selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

document.selectNone() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

document.setAlignToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

document.setBlendMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

document.setCustomFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

document.setCustomStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

document.setElementProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

document.setElementTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

document.setFillColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

document.setFilterProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

document.setFilters() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

document.setInstanceAlpha() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

document.setInstanceBrightness() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

document.setInstanceTint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

document.setMetadata() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

document.setMobileSettings() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

document.setOvalObjectProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

document.setPlayerVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

document.setRectangleObjectProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

document.setSelectionBounds() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

document.setSelectionRect() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

document.setStageVanishingPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

document.setStageViewAngle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

document.setStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

document.setStrokeColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

document.setStrokeSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

vii

document.setStrokeStyle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

document.setTextRectangle() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

document.setTextSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

document.setTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

document.setTransformationPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

document.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

document.skewSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

document.smoothSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

document.sourcePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

document.space() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

document.straightenSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

document.swapElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

document.swapStrokeAndFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

document.synchronizeWithHeadVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

document.testMovie() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

document.testScene() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

document.timelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

document.traceBitmap() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

document.translate3DCenter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

document.translate3DSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

document.transformSelection() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

document.unGroup() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

document.union() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

document.unlockAllElements() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

document.viewMatrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

document.width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

document.xmlPanel() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

document.zoomFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

viii

Chapter 12: drawingLayer object

drawingLayer.beginDraw() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

drawingLayer.beginFrame() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

drawingLayer.cubicCurveTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

drawingLayer.curveTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

drawingLayer.drawPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

drawingLayer.endDraw() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

drawingLayer.endFrame() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

drawingLayer.lineTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

drawingLayer.moveTo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

drawingLayer.newPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

drawingLayer.setColor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

drawingLayer.setFill() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

drawingLayer.setStroke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Chapter 13: Edge object

edge.cubicSegmentIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

edge.getControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

edge.getHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

edge.id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

edge.isLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

edge.setControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

edge.splitEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

edge.stroke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Chapter 14: Element object

element.depth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

element.elementType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

element.getPersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

element.getTransformationPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

element.hasPersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

element.height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

element.layer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

element.left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

element.locked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

element.matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

element.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

element.removePersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

element.rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

element.scaleX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

element.scaleY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

element.selected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

element.setPersistentData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

element.setTransformationPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

element.skewX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

element.skewY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

element.top . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

element.transformX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

element.transformY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

element.width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

element.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

element.y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

ix

Chapter 15: Fill object

fill.bitmapIsClipped . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

fill.bitmapPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

fill.color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

fill.colorArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

fill.focalPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

fill.linearRGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

fill.matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

fill.overflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

fill.posArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

fill.style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Chapter 16: Filter object

filter.angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

filter.blurX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

filter.blurY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

filter.brightness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

filter.color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

filter.contrast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

filter.distance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

filter.enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

filter.hideObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

filter.highlightColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

filter.hue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

filter.inner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

filter.knockout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

filter.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

filter.quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

filter.saturation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

filter.shadowColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

filter.strength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

filter.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

x

Chapter 17: flash object (fl)

fl.actionsPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

fl.addEventListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

fl.as3PackagePaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

fl.browseForFileURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

fl.browseForFolderURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

fl.clipCopyString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

fl.closeAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

fl.closeAllPlayerDocuments() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

fl.closeDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

fl.compilerErrors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

fl.componentsPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

fl.configDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

fl.configURI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

fl.contactSensitiveSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

fl.createDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

fl.createNewDocList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

fl.createNewDocListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

fl.createNewTemplateList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

fl.documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

fl.downloadLatestVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

fl.drawingLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

fl.externalLibraryPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

fl.fileExists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

fl.findDocumentDOM() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

fl.findDocumentIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

fl.findObjectInDocByName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

fl.findObjectInDocByType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

fl.flexSDKPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

fl.getAppMemoryInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

fl.getDocumentDOM() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

fl.isFontInstalled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

fl.libraryPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

fl.mapPlayerURL() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

fl.Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

fl.mruRecentFileList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

fl.mruRecentFileListType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

fl.objectDrawingMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

fl.openDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

fl.openScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

fl.outputPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

fl.packagePaths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

fl.presetPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

fl.quit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

fl.reloadEffects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

fl.reloadTools() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

fl.removeEventListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

fl.resetAS3PackagePaths() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

fl.resetPackagePaths() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

fl.revertDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

fl.revertDocumentToLastVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

fl.runScript() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

fl.saveAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

fl.saveAVersionOfDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

fl.saveDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

fl.saveDocumentAs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

fl.scriptURI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

fl.selectElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

fl.selectTool() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

fl.setActiveWindow() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

fl.showIdleMessage() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

fl.sourcePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

fl.swfPanels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

fl.synchronizeDocumentWithHeadVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

fl.tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

fl.trace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

fl.version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

fl.xmlui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

xi

Chapter 18: FLfile object

FLfile.copy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

FLfile.createFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

FLfile.exists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

FLfile.getAttributes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

FLfile.getCreationDate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

FLfile.getCreationDateObj() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

FLfile.getModificationDate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

FLfile.getModificationDateObj() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

FLfile.getSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

FLfile.listFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

FLfile.platformPathToURI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

FLfile.read() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

FLfile.remove() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

FLfile.setAttributes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

FLfile.uriToPlatformPath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

FLfile.write() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Chapter 19: folderItem object

Chapter 20: fontItem object

fontItem.bitmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

fontItem.bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

fontItem.font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

fontItem.italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

fontItem.size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

xii

Chapter 21: Frame object

frame.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

frame.duration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

frame.elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

frame.getCustomEase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

frame.hasCustomEase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

frame.labelType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

frame.motionTweenOrientToPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

frame.motionTweenRotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

frame.motionTweenRotateTimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

frame.motionTweenScale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

frame.motionTweenSnap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

frame.motionTweenSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

frame.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

frame.setCustomEase() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

frame.shapeTweenBlend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

frame.soundEffect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

frame.soundLibraryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

frame.soundLoop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

frame.soundLoopMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

frame.soundName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

frame.soundSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

frame.startFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

frame.tweenEasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288

frame.tweenType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

frame.useSingleEaseCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

Chapter 22: HalfEdge object

halfEdge.getEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

halfEdge.getNext() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

halfEdge.getOppositeHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

halfEdge.getPrev() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

halfEdge.getVertex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

halfEdge.id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

halfEdge.index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

Chapter 23: Instance object

instance.instanceType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

instance.libraryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Chapter 24: Item object

item.addData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

item.getData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

item.hasData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

item.itemType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

item.linkageBaseClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

item.linkageClassName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

item.linkageExportForAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

item.linkageExportForRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

item.linkageExportInFirstFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

item.linkageIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

item.linkageImportForRS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

item.linkageURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

item.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

item.removeData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

xiii

Chapter 25: Layer object

layer.color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

layer.frameCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

layer.frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

layer.height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

layer.layerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

layer.locked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

layer.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

layer.outline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

layer.parentLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

layer.visible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Chapter 26: library object

library.addItemToDocument() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

library.addNewItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

library.deleteItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

library.duplicateItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

library.editItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

library.expandFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

library.findItemIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

library.getItemProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

library.getItemType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

library.getSelectedItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

library.importEmbeddedSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

library.itemExists() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

library.items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

library.moveToFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

library.newFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

library.renameItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321

library.selectAll() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

library.selectItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

library.selectNone() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

library.setItemProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

library.updateItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

xiv

Chapter 27: Math object

Math.concatMatrix() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Math.invertMatrix() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

Math.pointDistance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

Chapter 28: Matrix object

matrix.a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

matrix.b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

matrix.c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329

matrix.d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

matrix.tx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

matrix.ty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

Chapter 29: outputPanel object

outputPanel.clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

outputPanel.save() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

outputPanel.trace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333

Chapter 30: Oval object

OvalObject.closePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

OvalObject.endAngle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

OvalObject.innerRadius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

OvalObject.startAngle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337

Chapter 31: Parameter object

parameter.category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338

parameter.insertItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

parameter.listIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339

parameter.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

parameter.removeItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340

parameter.value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341

parameter.valueType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

parameter.verbose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

Chapter 32: Path object

path.addCubicCurve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343

path.addCurve() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344

path.addPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

path.clear() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

path.close() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

path.makeShape() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

path.newContour() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

path.nPts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Chapter 33: presetItem object

presetItem.isDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349

presetItem.isFolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

presetItem.level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350

presetItem.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

presetItem.open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

presetItem.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

xv

Chapter 34: presetPanel object

presetPanel.addNewItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

presetPanel.applyPreset() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354

presetPanel.deleteFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

presetPanel.deleteItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

presetPanel.expandFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

presetPanel.exportItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

presetPanel.findItemIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

presetPanel.getSelectedItems() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

presetPanel.importItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

presetPanel.items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

presetPanel.moveToFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

presetPanel.newFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

presetPanel.renameItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

presetPanel.selectItem() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

Chapter 35: Rectangle object

RectangleObject.bottomLeftRadius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

RectangleObject.bottomRightRadius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

RectangleObject.lockFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

RectangleObject.topLeftRadius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

RectangleObject.topRightRadius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366

Chapter 36: Screen object

screen.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

screen.childScreens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

screen.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

screen.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

screen.hidden . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369

screen.instanceName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

screen.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370

screen.nextScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

screen.parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371

screen.parentScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

screen.prevScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

screen.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

screen.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373

screen.timeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Chapter 37: ScreenOutline object

screenOutline.copyScreenFromFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

screenOutline.currentScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

screenOutline.deleteScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

screenOutline.duplicateScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

screenOutline.getSelectedScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

screenOutline.insertNestedScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

screenOutline.insertScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

screenOutline.moveScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

screenOutline.renameScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

screenOutline.rootScreen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

screenOutline.screens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

screenOutline.setCurrentScreen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

screenOutline.setScreenProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

screenOutline.setSelectedScreens() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383

xvi

Chapter 38: Shape object

shape.beginEdit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

shape.contours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

shape.deleteEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

shape.edges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

shape.endEdit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386

shape.getCubicSegmentPoints() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

shape.isDrawingObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

shape.isGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388

shape.isOvalObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

shape.isRectangleObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

shape.members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

shape.numCubicSegments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

shape.vertices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

Chapter 39: SoundItem object

soundItem.bitRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

soundItem.bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393

soundItem.compressionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

soundItem.convertStereoToMono . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394

soundItem.exportToFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

soundItem.fileLastModifiedDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395

soundItem.originalCompressionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

soundItem.quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396

soundItem.sampleRate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

soundItem.sourceFileExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397

soundItem.sourceFileIsCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

soundItem.sourceFilePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

soundItem.useImportedMP3Quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

Chapter 40: Stroke object

stroke.breakAtCorners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

stroke.capType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401

stroke.color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

stroke.curve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402

stroke.dash1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

stroke.dash2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

stroke.density . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

stroke.dotSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404

stroke.dotSpace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

stroke.hatchThickness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

stroke.jiggle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

stroke.joinType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

stroke.length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406

stroke.miterLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

stroke.pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407

stroke.rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

stroke.scaleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

stroke.shapeFill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

stroke.space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409

stroke.strokeHinting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

stroke.style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

stroke.thickness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

stroke.variation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411

stroke.waveHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

stroke.waveLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

xvii

Chapter 41: swfPanel object

swfPanel.call() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414

swfPanel.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

swfPanel.path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

Chapter 42: SymbolInstance object

symbolInstance.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

symbolInstance.actionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

symbolInstance.blendMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

symbolInstance.buttonTracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420

symbolInstance.cacheAsBitmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

symbolInstance.colorAlphaAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

symbolInstance.colorAlphaPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

symbolInstance.colorBlueAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

symbolInstance.colorBluePercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

symbolInstance.colorGreenAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

symbolInstance.colorGreenPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

symbolInstance.colorMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

symbolInstance.colorRedAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

symbolInstance.colorRedPercent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

symbolInstance.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

symbolInstance.filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

symbolInstance.firstFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

symbolInstance.forceSimple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

symbolInstance.loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

symbolInstance.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

symbolInstance.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

symbolInstance.symbolType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

symbolInstance.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

xviii

Chapter 43: SymbolItem object

symbolItem.convertToCompiledClip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

symbolItem.exportSWC() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

symbolItem.exportSWF() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

symbolItem.scalingGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

symbolItem.scalingGridRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

symbolItem.sourceAutoUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

symbolItem.sourceFilePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

symbolItem.sourceLibraryName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

symbolItem.symbolType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

symbolItem.timeline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434

Chapter 44: Text object

text.accName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437

text.antiAliasSharpness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

text.antiAliasThickness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

text.autoExpand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

text.border . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

text.description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

text.embeddedCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

text.embedRanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440

text.fontRenderingMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

text.getTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441

text.getTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

text.length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

text.lineType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

text.maxCharacters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

text.orientation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444

text.renderAsHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

text.scrollable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

text.selectable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

text.selectionEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

text.selectionStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

text.setTextAttr() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

text.setTextString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

text.shortcut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

text.silent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

text.tabIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

text.textRuns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

text.textType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

text.useDeviceFonts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

text.variableName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

xix

Chapter 45: TextAttrs object

textAttrs.aliasText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

textAttrs.alignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

textAttrs.autoKern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

textAttrs.bold . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

textAttrs.characterPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454

textAttrs.characterSpacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

textAttrs.face . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

textAttrs.fillColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

textAttrs.indent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

textAttrs.italic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

textAttrs.leftMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

textAttrs.letterSpacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

textAttrs.lineSpacing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

textAttrs.rightMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

textAttrs.rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

textAttrs.size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

textAttrs.target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

textAttrs.url . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Chapter 46: TextRun object

textRun.textAttrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

textRun.characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461

Chapter 47: Timeline object

timeline.addMotionGuide() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

timeline.addNewLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

timeline.clearFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

timeline.clearKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

timeline.convertToBlankKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

timeline.convertToKeyframes() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

timeline.copyFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

timeline.copyMotion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

timeline.copyMotionAsAS3() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

timeline.createMotionTween() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470

timeline.currentFrame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471

timeline.currentLayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

timeline.cutFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

timeline.deleteLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

timeline.expandFolder() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473

timeline.findLayerIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

timeline.frameCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

timeline.getFrameProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

timeline.getGuidelines() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476

timeline.getLayerProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

timeline.getSelectedFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

timeline.getSelectedLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

timeline.insertBlankKeyframe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

timeline.insertFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

timeline.insertKeyframe() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

timeline.layerCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

timeline.layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481

timeline.name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

timeline.pasteFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

timeline.pasteMotion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

timeline.removeFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

timeline.reorderLayer() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484

timeline.reverseFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485

timeline.selectAllFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

timeline.setFrameProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486

timeline.setGuidelines() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

timeline.setLayerProperty() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488

timeline.setSelectedFrames() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488

timeline.setSelectedLayers() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489

timeline.showLayerMasking() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490

xx

Chapter 48: ToolObj object

toolObj.depth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

toolObj.enablePIControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492

toolObj.iconID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

toolObj.position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

toolObj.setIcon() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

toolObj.setMenuString() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494

toolObj.setOptionsFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

toolObj.setPI() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

toolObj.setToolName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497

toolObj.setToolTip() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497

toolObj.showPIControl() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498

toolObj.showTransformHandles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499

Chapter 49: Tools object

tools.activeTool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

tools.altIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

tools.constrainPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

tools.ctlIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

tools.getKeyDown() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502

tools.mouseIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

tools.penDownLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503

tools.penLoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

tools.setCursor() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504

tools.shiftIsDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

tools.snapPoint() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

tools.toolObjs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

xxi

Chapter 50: Vertex object

vertex.getHalfEdge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

vertex.setLocation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508

vertex.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508

vertex.y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509

Chapter 51: VideoItem object

videoItem.exportToFLV() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

videoItem.fileLastModifiedDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

videoItem.sourceFileExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

videoItem.sourceFileIsCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

videoItem.sourceFilePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512

videoItem.videoType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513

Chapter 52: XMLUI object

xmlui.accept() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514

xmlui.cancel() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

xmlui.get() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515

xmlui.getControlItemElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

xmlui.getEnabled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

xmlui.getVisible() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

xmlui.set() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

xmlui.setControlItemElement() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518

xmlui.setControlItemElements() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519

xmlui.setEnabled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

xmlui.setVisible() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520

Chapter 53: C-Level Extensibility

About extensibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522

Integrating C functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522

Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

The C-level API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528

xxii

Chapter 1: Introduction

As a user of Adobe® Flash® CS4 Professional, you may be familiar with Adobe® ActionScript®, which lets you create
scripts that execute at run time in Adobe® Flash® Player. The Flash JavaScript application programming interface
(JavaScript API) described in this document is a complementary programming tool that lets you create scripts that run
in the authoring environment.

This document describes the objects, methods, and properties available in the JavaScript API. It assumes that you
know how to use the documented commands when working in the authoring environment. If you have a question
about what a particular command does, use other documents in Flash Help, such as Using Flash, to find that
information.

This document also assumes that you are familiar with JavaScript or ActionScript syntax and with basic programming
concepts such as functions, parameters, and data types.

Working with the JavaScript API

1

The Flash JavaScript API lets you write scripts to perform several actions in the Flash authoring environment (that is,
while a user has the Flash program open). This functionality is different from the ActionScript language, which lets
you write scripts to perform actions in the Flash Player environment (that is, while a SWF file is playing). This
functionality is also different from JavaScript commands that you might use in pages displayed in a web browser.

Using the JavaScript API, you can write Flash application scripts to help streamline the authoring process. For
example, you can write scripts to automate repetitive tasks or add custom tools to the Tools panel.

The Flash JavaScript API is designed to resemble the Adobe® Dreamweaver® and Adobe® Fireworks® JavaScript API
(which were designed based on the Netscape JavaScript API). The Flash JavaScript API is based on a Document Object
Model (DOM), which allows Flash documents to be accessed using JavaScript objects. The Flash JavaScript API
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 have an effect.

The JavaScript API also contains methods that let you implement extensibility using a combination of JavaScript and
custom C code. For more information, see

The JavaScript interpreter in Flash is the Mozilla SpiderMonkey engine, version 1.5, which is available on the web at

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 core JavaScript language as defined in the ECMAScript (ECMA-262) edition 3
language specification and it is fully compliant with the specification. Only the browser-specific host objects, which
are not part of the ECMA-262 specification, are not supported. Similarly, many JavaScript reference guides distinguish
between core JavaScript and client-side (browser-related) JavaScript. Only core JavaScript applies to the Flash
JavaScript interpreter.

“C-Level Extensibility” on page 522.

Creating JSFL files

You can use Adobe Flash CS4 Professional or your preferred text editor to write and edit Flash JavaScript (JSFL) files.
If you use Flash, these files have a .jsfl extension by default. To write a script, select File

> New > Flash JavaScript File.

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

You can also create a JSFL file by selecting commands in the History panel. Then click the Save button in the History
panel or select Save As Command from the panel menu. The command (JSFL) file is saved in the Commands folder

“Saving JSFL files” on page 2). You can then open the file and edit it the same as any other script file.

(see

The History panel provides some other useful options as well. You can copy selected commands to the Clipboard, and
you can view JavaScript commands that are generated while you are working in Flash.

To copy commands from the History panel to the clipboard:

1 Select one or more commands in the History panel.

2 Do one of the following:

• Click the Copy button.

• Select Copy Steps from the panel menu.

To view JavaScript commands in the History panel:

• Select View > JavaScript in Panel from the panel menu.

Saving JSFL files

You can have JSFL scripts available within the Flash authoring environment by storing them in one of several folders
within the Configuration folder. By default, the Configuration folder is in the following location:

2

• Windows® Vista™:

boot drive\Users\username\Local Settings\Application Data\Adobe\Flash CS4\language\Configuration\

• Windows XP:

boot drive\Documents and Settings\username\Local Settings\Application Data\Adobe\Flash
CS4\language\Configuration\

• Mac OS® X:

Macintosh HD/Users/username/Library/Application Support/Adobe/Flash CS4/language/Configuration/

To determine the location of the Configuration folder, use fl.configDirectory or fl.configURI, as shown in the
following example:

// store directory to a variable
var configDir = fl.configDirectory;
// display directory in the Output panel
fl.trace(fl.configDirectory);

Within the Configuration folder, the following folders can contain scripts that you can access in the authoring
environment: Behaviors (to support the user interface for behaviors); Commands (for scripts that appear on the
Commands menu); JavaScript (for scripts used by Script Assist to populate the user interface controls); Tools (for
extensible tools in the Tools panel); and WindowSWF (for panels that appear in the Windows menu). This document
focuses on scripts used for commands and tools.

If you edit a script in the Commands folder, the new script is immediately available in Flash. If you edit a script for an
extensible tool, close and restart Flash, or else use the

fl.reloadTools() command. However, if you used a script to

add an extensible tool to the Tools panel and you then edit the script, either remove and then add the tool to the Tools
panel again, or else close and restart Flash for the revised tool to be available.

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

There are two locations where you can store command and tool files so they can be accessed in the authoring
environment.

• For scripts that appear as items in the Commands menu, save the JSFL file in the Commands folder in the following

location:

Operating system Location

3

Windows Vista boot drive\Users\username\Local Settings\Application Data\Adobe\Flash

Windows XP boot drive\Documents and Settings\user\Local Settings\Application Data\Adobe\Flash

Mac OS X Macintosh HD/Users/userName/Library/Application Support/Adobe/Flash

CS4\language\Configuration\Commands

CS4\language\Configuration\Commands

CS4/language/Configuration/Commands

• For scripts that appear as extensible tools in the Tools panel, save the JSFL file in the Tools folder in the following

location:

Operating system Location

Windows Vista boot drive\Users\username\Local Settings\Application Data\Adobe\Flash

Windows XP boot drive\Documents and Settings\user\Local Settings\Application Data\Adobe\Flash

Mac OS X Macintosh HD/Users/userName/Library/Application Support/Adobe/Flash

CS4\language\Configuration\Tools

CS4\language\Configuration\Tools

CS4/language/Configuration/Tools

If a JSFL file has other files that go with it, such as XML files, store them in the same directory as the JSFL file.

Running scripts

There are several ways to run scripts. The most common ways are explained in this section.

To run a script that you are currently viewing or editing:

• Right-click (Command-click on the Macintosh) and choose Run Script.

• Click the Run Script icon on the Script window toolbar.

This option lets you run a script before you have saved it. This option also lets you run a script even if no FLA files are open.

To run a script that is in the Commands folder, do one of the following:

• From the authoring environment, select Commands > Script Name.

• Use a keyboard shortcut that you have assigned to the script. To assign a keyboard shortcut, use Edit > Keyboard

Shortcuts and select Drawing Menu Commands from the Commands pop-up menu. Expand the Commands node
in the menu tree to view a list of available scripts.

To run a command script that is not in the Commands folder, do one of the following:

• From the authoring environment, select Commands > Run Command, and then select the script to run.

• From within a script, use the fl.runScript() command.

• From the file system, double-click the script file.

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

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

1 Copy the JSFL file for the tool and any other associated files to the Tools folder (see “Saving JSFL files” on page 2).

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.

You can add individual JavaScript API commands to ActionScript files by using the MMExecute() function, which is
documented in the ActionScript 3.0 Language and Components Reference. However, the

MMExecute() function 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, JavaScript API commands have
no effect in Flash Player or outside the authoring environment.

To issue a command from an ActionScript script:

• Use the following syntax (you can concatenate several commands into one string):

MMExecute(Javascript command string);

You can also run a script from the command line.

To run a script from the command line on Windows:

• Use the following syntax (add path information as required):

"flash.exe" myTestFile.jsfl

4

To run a script from the “Terminal” application on the Macintosh:

• Use the following syntax (add path information as required):

osascript -e 'tell application "flash" to open alias "Mac OS X:Users:user:myTestFile.jsfl" '

The osascript command can also run AppleScript in a file. For example, you could include the following text in
a file named myScript:

tell application "flash"
open alias "Mac OS X:Users:user:myTestFile.jsfl"
end tell

Then, to run the script, you would use this command:

osascript myScript

What’s new in the JavaScript API

In Flash CS4, some objects, methods, and properties have been added while others have been removed. These changes
are summarized below.

If you have not used the JavaScript API before, you might want to skip this section and go directly to “JavaScript API

objects” on page 7).

New objects

The following objects are new in Flash CS4:

presetPanel object

presetItem object

swfPanel object

New methods and properties

The following methods and properties for existing objects are new in Flash CS4:

• BitmapItem object

• bitmapItem.exportToFile()

• bitmapItem.fileLastModifiedDate

• bitmapItem.originalCompressionType

• bitmapItem.sourceFileExists

• bitmapItem.sourceFileIsCurrent

• bitmapItem.sourceFilePath

• bitmapItem.useDeblocking

• Contour object

• contour.fill

• Document object

• document.addNewPrimitiveOval()

• document.addNewPrimitiveRectangle()

• document.exportPublishProfileString()

• document.externalLibraryPath

• document.importPublishProfileString()

• document.libraryPath

• document.pathURI

• document.rotate3DSelection

• document.setStageVanishingPoint()

• document.setStageViewAngle()

• document.sourcePath

• document.translate3DCenter()

• document.translate3DSelection()

• Edge object

• edge.cubicSegmentIndex

• edge.stroke

• Fill object

• fill.bitmapIsClipped

• fill.bitmapPath

• flash object (fl)

• fl.externalLibraryPath

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

5

• fl.flexSDKPath

• fl.isFontInstalled()

• fl.libraryPath

• fl.presetPanel

• fl.sourcePath

• fl.swfPanels

• FLfile object

• FLfile.platformPathToURI()

• FLfile.uriToPlatformPath()

• fontItem object

• fontItem.bitmap

• fontItem.bold

• fontItem.font

• fontItem.italic

• fontItem.size

• Shape object

• shape.getCubicSegmentPoints()

• shape.members

• shape.numCubicSegments

• SoundItem object

• soundItem.exportToFile()

• soundItem.fileLastModifiedDate

• soundItem.originalCompressionType

• soundItem.sourceFileExists

• soundItem.sourceFileIsCurrent

• soundItem.sourceFilePath

• Timeline object

• timeline.getGuidelines()

• timeline.setGuidelines()

• VideoItem object

• videoItem.exportToFLV()

• videoItem.fileLastModifiedDate

• videoItem.sourceFileExists

• videoItem.sourceFileIsCurrent

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

6

Other changes

The following property has a new supported value in Flash CS4:

• fill.style

The following objects, methods, and properties are no longer available in Flash CS4:

• Project object

• ProjectItem object

• fl.openProject()

• fl.closeProject()

• fl.createProject()

• fl.getProject()

• Effect object

• configureEffect()

• executeEffect()

• removeEffect()

• fl.activeEffect

• fl.effects

• fl.enableImmediateUpdates()

• fl.reloadEffects()

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

7

JavaScript API objects

This section provides a summary of the objects available in the Flash JavaScript API and how to begin working with
them. All standard JavaScript commands are also available when working with the JavaScript API.

The following table briefly describes each of the objects in the JavaScript API. The objects are listed in alphabetical
order.

Object Description

actionsPanel object The actionsPanel object represents the currently displayed Actions panel.

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

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

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

compilerErrors object The compilerErrors object represents the Compiler Errors panel. It is a

ComponentInstance object The ComponentInstance object is a subclass of the SymbolInstance object

componentsPanel object The componentsPanel object, which represents the Components panel, is a

a bitmap in a frame.

BitmapItem object is a subclass of the Item object.

property of the flash object (fl.compilerErrors).

and represents a component in a frame.

property of the flash object (

fl.componentsPanel).

Object Description

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

8

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

a shape.

Document object The Document object represents the Stage.

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

object.

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

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

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

panel or of a selected shape.

Filter object The Filter object contains all the properties for all filters.

flash object (fl) The flash object represents the Flash application.

FLfile object The FLfile object lets you write Flash extensions that can access, modify, and

remove files and folders on the local file system.

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

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.

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

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. It is a property of the flash

fl.outputPanel).

object (

Oval object The Oval object is a shape that is drawn using the Oval tool. To determine if

an item is an Oval object, use

shape.isOvalObject.

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.

presetItem object The presetItem object represents an item (preset or folder) in the Motion

Presets panel.

presetPanel object The presetPanel object represents the Motion Presets panel (Window >

Motion Presets). It is a property of the flash object (

fl.presetPanel).

Object Description

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

9

Rectangle object The Rectangle object is a shape that is drawn using the Rectangle tool. To

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

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

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

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

swfPanel object The swfPanel object represents a Windows SWF panel. Windows SWF panels

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

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

determine if an item is a Rectangle object, use

shape.isRectangleObject.

document.

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

item used to create a sound.

settings.

are SWF files that implement applications you can run from the Flash
authoring environment. The array of swfPanel objects is a property of the
flash object (

a symbol in a frame.

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

fl.swfPanels).

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

Timeline object The Timeline object represents the Flash timeline, which can be accessed for

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

Tools object The Tools object is accessible from the Flash object (fl.tools).

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

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 XMLUI

match all of the properties in the TextAttrs object.

the current document by

coordinate data.

dialog box, and accept or cancel out of one.

fl.getDocumentDOM().getTimeline().

The Flash Document Object Model

The Flash Document Object Model (DOM) for the Flash JavaScript API consists of a set of top-level functions (see
“Top-Level Functions and Methods” on page 15) and two top-level objects—the FLfile object and the flash object (fl).
Each object is guaranteed to be available to a script because it always exists when the Flash authoring environment is
open. For more information, see

When referring to the flash object, you can use flash or fl. For example, to close all open FLA files, you can use either
of the following statements:

FLfile object and flash object (fl).

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

The flash object contains the following child objects:

Object How to access

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

10

actionsPanel object Use fl.actionsPanel to access the actionsPanel object. This object corresponds

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

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

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

drawingLayer object Use fl.drawingLayer to access the drawingLayer object.

Math object Use fl.Math to access the Math object.

outputPanel object Use fl.outputPanel to access the outputPanel object. This object corresponds to

presetPanel object Use fl.presetPanel to access the presetPanel object. This object corresponds to

swfPanel object Use fl.swfPanels to access an array of swfPanel objects. These objects

Tools object Use fl.tools to access an array of Tools objects.

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

to the Actions panel in the Flash authoring environment.

corresponds to the Compiler Errors panel in the Flash authoring environment.

corresponds to the Components panel in the Flash authoring environment.

fl.documents[index] to access a particular document; use
fl.getDocumentDOM() to access the current document (the one with focus).

the Output panel in the Flash authoring environment.

the Motion Presets panel (Window

correspond to Window SWF panels.

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

> Motion Presets).

The Document object

An important property of the top-level flash object is the fl.documents property. This property contains an array of
Document objects, each of which represents 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 Document object. For more information, see

Document object.

To refer to the first open document, for example, use the statement flash.documents[0] or fl.documents[0]. The
first document is the first Flash document that was opened during the 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 flash.findDocumentIndex(nameOfDocument) or

fl.findDocumentIndex(nameOfDocument). See fl.findDocumentIndex().

To access the document that is currently focused, use the statement flash.getDocumentDOM() or

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

document.

To find a particular document in the fl.documents array, iterate through the array and test each document for its

document.name property. See fl.documents and document.name.

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

All the objects in the DOM that aren’t listed in the previous table (see “The Flash Document Object Model” on page 9)
are accessed from the Document object. For example, to access the library of a document, you use the

document.library property, which retrieves a library object:

fl.getDocumentDOM().library

To access the array of items in the library, you use the library.items property; 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 library.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.
For more information, see

document.library, library object, library.itemslibrary.items, and Item 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);

11

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 (see document.selection). 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;
}

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.

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

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.

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 parent object
(the superclass). Subclasses share the same level in the hierarchy as their superclass. For example, the Item object is a
superclass of the BitmapItem object. These relationships are illustrated in the following outline:

01 Top-Level Functions and Methods
01 FLfile object
01 flash object (fl)
02 compilerErrors object
02 componentsPanel object
02 Document object (fl.documents array)
03 Filter object
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 array)
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 Oval object
07 Rectangle 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

12

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 Math object
02 outputPanel object
02 presetPanel object
03 presetItem object(presetPanel.items array)
02 swfPanel object
02 Tools object (fl.tools array)
03 ToolObj object (tools.toolObjs array)
02 XMLUI object

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

13

Sample implementations

Several sample JSFL implementations are available for Adobe Flash CS4 Professional. You can review and install these
files to familiarize yourself with the JavaScript API. The samples are in a folder named Samples/ExtendingFlash within
the Samples.zip file located at

Sample Shape command

A sample JavaScript API script named Shape.jsfl is located in the ExtendingFlash/Shape folder (see “Sample
implementations” above). This script displays information about the contours of the shape in the Output panel.

To install and run the Shape script:

1 Copy the Shape.jsfl file to the Configuration/Commands folder (see “Saving JSFL files” on page 2).

2 In a Flash document (FLA file), select a shape object.

3 Select Commands > Shape to run the script.

Sample get and set filters command

A sample JavaScript API script named filtersGetSet.jsfl is located in the ExtendingFlash/filtersGetSet folder (see
“Sample implementations” above). This script adds filters to a selected object and displays information about the filters
being added in the Output panel.

To install and run the filtersGetSet script:

1 Copy the filtersGetSet.jsfl file to the Configuration/Commands folder (see “Saving JSFL files” on page 2).

2 In a Flash document (FLA file), select a text, movie clip, or button object.

3 Select Commands > filtersGetSet to run the script.

www.adobe.com/go/learn_fl_samples.

EXTENDING FLASH CS4 PROFESSIONAL

Introduction

Sample PolyStar tool

A sample JavaScript API script named PolyStar.jsfl is located in the ExtendingFlash/PolyStar folder (see “Sample
implementations” above).

The PolyStar.jsfl replicates the PolyStar tool that can be found in the Flash Tools panel. The script demonstrates how
to build the PolyStar tool using the JavaScript API and includes detailed comments describing what the code is doing.
Read this file to gain a better understanding of how the JavaScript API can be used. You should also read the
PolyStar.xml file in the Tools directory to learn more about how to build your own tool.

Sample Trace Bitmap panel

A set of files named TraceBitmap.fla and TraceBitmap.swf are located in the ExtendingFlash/TraceBitmapPanel folder
(see “Sample implementations” above). These files illustrate how to design and build a panel to control the functions
of Flash. They also show the use of the
script.

To run the TraceBitmap sample:

1 If Flash is running, exit from Flash.

2 Copy the TraceBitmap.swf file to the WindowSWF folder, which is a subdirectory of the Configuration folder (see

“Saving JSFL files” on page 2). For example, on Windows XP, the folder is in boot drive\Documents and
Settings\user\Local Settings\Application Data\Adobe\Flash CS4\language\Configuration\WindowSWF.

3 Start Flash.

4 Create or open a Flash document (FLA file), and import a bitmap or JPEG image into the file.

You can use the flower.jpg file provided in the TraceBitmapPanel folder or another image of your choice.

MMExecute() function to call JavaScript commands from an ActionScript

14

5 With the imported image selected, select Window > Other Panels > TraceBitmap.

6 Click Submit.

The image is converted into a group of shapes.

Sample DLL

A sample DLL implementation is located in the ExtendingFlash/dllSampleComputeSum folder (see “Sample
implementations” above). For more information about building DLLs, see

“C-Level Extensibility” on page 522.

Chapter 2: Top-Level Functions and Methods

About this section

This section describes the top-level functions and methods that are available when you use the Adobe Flash JavaScript
application programming interface (JavaScript API). For information about where to store JavaScript API files, see
“Saving JSFL files” on page 2.

Global methods

The following methods can be called from any JavaScript API script:

alert()
confirm()
prompt()

Extensible tools

The following functions are available in scripts that create extensible tools:

15

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

activate()

Availability

Flash MX 2004.

Usage

function activate() {
// statements
}

Parameters

None.

Returns

Nothing.

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

Description

Function; called when the extensible tool becomes active (that is, when the tool is selected in the Tools panel). Use this
function to perform any initialization tasks the tool requires.

Example

The following example sets the value of tools.activeTool when the extensible tool is selected in the Tools panel:

function activate() {
var theTool = fl.tools.activeTool
}

See also

tools.activeTool

alert()

Availability

Flash MX 2004.

16

Usage

alert ( alertText )

Parameters

alertText A string that specifies the message you want to display in the Alert dialog box.

Returns

Nothing.

Description

Method; displays a string in a modal Alert dialog box, along with an OK button.

Example

The following example displays the message “Process Complete” in an Alert dialog box:

alert("Process Complete");

See also

confirm(), prompt()

configureTool()

Availability

Flash MX 2004.

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

Usage

function configureTool() {
// statements
}

Parameters

None.

Returns

Nothing.

Description

Function; called when Flash opens and the extensible tool is loaded into the Tools panel. 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 );
}

17

confirm()

Availability

Flash 8.

Usage

confirm ( strAlert )

Parameters

strAlert A string that specifies the message you want to display in the Alert dialog box.

Returns

A Boolean value: true if the user clicks OK; false if the user clicks Cancel.

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

Description

Method; displays a string in a modal Alert dialog box, along with OK and Cancel buttons.

Note: If there are no documents (FLA files) open, this method fails with an error condition.

Example

The following example displays the message “Sort data?” in an Alert dialog box:

confirm("Sort data?");

See also

alert(), prompt()

deactivate()

Availability

Flash MX 2004.

18

Usage

function deactivate() {
// statements
}

Parameters

None.

Returns

Nothing.

Description

Function; called when the extensible 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

The following example displays a message in the Output panel when the tool becomes inactive:

function deactivate() {
fl.trace( "Tool is no longer active" );
}

keyDown()

Availability

Flash MX 2004.

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

Usage

function keyDown() {
// statements
}

Parameters

None.

Returns

Nothing.

Description

Function; called when the extensible tool is active and the user presses a key. The script should call

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

Example

The following example displays information about which key was pressed when the extensible tool is active and the
user presses a key.

function keyDown() {
fl.trace("key " + fl.tools.getKeyDown() + " was pressed");
}

19

See also

keyUp(), tools.getKeyDown()

keyUp()

Availability

Flash MX 2004.

Usage

function keyUp() {
// statements
}

Parameters

None.

Returns

Nothing.

Description

Function; called when the extensible tool is active and a key is released.

Example

The following example displays a message in the Output panel when the extensible tool is active and a key is released.

function keyUp() {
fl.trace("Key is released");
}

See also

keyDown()

mouseDoubleClick()

Availability

Flash MX 2004.

Usage

function mouseDoubleClick() {
// statements
}

Parameters

None.

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

20

Returns

Nothing.

Description

Function; called when the extensible tool is active and the mouse button is double-clicked on the Stage.

Example

The following example displays a message in the Output panel when the extensible tool is active and the mouse button
is double-clicked.

function mouseDoubleClick() {
fl.trace("Mouse was double-clicked");
}

mouseDown()

Availability

Flash MX 2004.

Usage

function mouseDown( [ pt ] ) {
// statements
}

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

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

Function; called when the extensible tool is active and the mouse button is pressed while the pointer is over the Stage.

Example

The following examples show how this function can be used when the extensible tool is active. The first example
displays a message in the Output panel that the mouse button was pressed. The second example displays the x and y
coordinates of the mouse’s location when the button was pressed.

function mouseDown() {
fl.trace("Mouse button has been pressed");
}
function mouseDown(pt) {
fl.trace("x = "+ pt.x+" :: y = "+pt.y);
}

21

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

Function; called whenever the extensible tool is active and the mouse moves over a specified point on the Stage. The
mouse button can be down or up.

Example

The following examples show how this function can be used. The first example displays a message in the Output panel
that the mouse is being moved. The second example displays the x and y coordinates of the mouse’s location as it
moves.

function mouseMove() {
fl.trace("moving");
}

function mouseMove(pt) {
fl.trace("x = "+ pt.x + " :: y = " + pt.y);
}

mouseUp()

Availability

Flash MX 2004.

Usage

function mouseUp() {
// statements
}

Parameters

None.

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

22

Returns

Nothing.

Description

Function; called whenever the extensible tool is active and the mouse button is released after being pressed on the
Stage.

Example

The following example displays a message in the Output panel when the extensible tool is active and the mouse button
is released.

function mouseUp() {
fl.trace("mouse is up");
}

notifySettingsChanged()

Availability

Flash MX 2004.

Usage

function notifySettingsChanged() {
// statements
}

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

Parameters

None.

Returns

Nothing.

Description

Function; called when the extensible tool is active and the user changes its options in the Property inspector. You can

tools.activeTool property to query the current values of the options (see tools.activeTool).

use the

Example

The following example displays a message in the Output panel when the extensible tool is active and the user changes
its options in the Property inspector.

function notifySettingsChanged() {
var theTool = fl.tools.activeTool;
var newValue = theTool.myProp;
}

23

prompt()

Availability

Flash MX 2004.

Usage

prompt(promptMsg [,text])

Parameters

promptMsg A string to display in the Prompt dialog box (limited to 256 characters in Mac OS X).

text An optional string to display as a default value for the text field.

Returns

The string the user typed if the user clicks OK; null if the user clicks Cancel.

Description

Method; displays a prompt and optional text in a modal Alert dialog box, along with OK and Cancel buttons.

Example

The following example prompts the user to enter a user name. If the user types a name and clicks OK, the name appears
in the Output panel.

var userName = prompt("Enter user name", "Type user name here");
fl.trace(userName);

See also

alert(), confirm()

EXTENDING FLASH CS4 PROFESSIONAL

Top-Level Functions and Methods

setCursor()

Availability

Flash MX 2004.

Usage

function setCursor() {
// statements
}

Parameters

None.

Returns

Nothing.

Description

Function; called when the extensible tool is active and the mouse moves, to allow the script to set custom pointers. The
script should call
to which integer values, see

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

tools.setCursor().

24

Example

function setCursor() {
fl.tools.setCursor( 1 );
}

Chapter 3: actionsPanel object

Availability

Flash CS3 Professional.

Description

The actionsPanel object, which represents the currently displayed Actions panel, is a property of the flash object (see

fl.actionsPanel).

Method summary

The following methods can be used with the actionsPanel object:

Method Description

actionsPanel.getClassForObject() Returns the class of a specified variable.

actionsPanel.getScriptAssistMode() Specifies whether Script Assist mode is enabled.

actionsPanel.getSelectedText() Returns the text that is currently selected in the Actions panel.

25

actionsPanel.getText() Returns the text in the Actions panel.

actionsPanel.hasSelection() Specifies whether any text is currently selected in the Actions panel.

actionsPanel.replaceSelectedText() Replaces the currently selected text with specified text.

actionsPanel.setScriptAssistMode() Enables or disables Script Assist mode.

actionsPanel.setSelection() Selects a specified set of characters in the Actions panel.

actionsPanel.setText() Clears any text in the Actions panel and then adds specified text.

actionsPanel.getClassForObject()

Availability

Flash CS3 Professional.

Usage

actionsPanel.getClassForObject(ASvariableName)

Parameters

ASvariableName A string that represents the name of an ActionScript variable.

Returns

A string that represents the class of which ASvariableName is a member.

Description

Method; returns the class of the specified variable, which must be defined in the currently displayed Actions panel. In
addition, the cursor or selected text in the Actions panel must be positioned after the variable definition.

EXTENDING FLASH CS4 PROFESSIONAL

actionsPanel object

Example

The following example displays the class assigned to the variable myVar, if the cursor is positioned after the statement
var myVar:ActivityEvent; in the Actions panel.

// Place the following code in the Actions panel,
// and position the cursor somewhere after the end of the line
var myVar:ActivityEvent;
// Place the following code in the JSFL file
var theClass = fl.actionsPanel.getClassForObject("myVar");
fl.trace(theClass); // traces: "ActivityEvent"

actionsPanel.getScriptAssistMode()

Availability

Flash CS3 Professional.

Usage

actionsPanel.getScriptAssistMode()

26

Parameters

None.

Returns

A Boolean value that specifies whether Script Assist mode is enabled (true) or not (false).

Description

Method; specifies whether Script Assist mode is enabled.

Example

The following example displays a message if Script Assist mode is not enabled.

mAssist = fl.actionsPanel.getScriptAssistMode();
if (!mAssist) {
alert("For more guidance when writing ActionScript code, try Script Assist mode");
}

See also

actionsPanel.setScriptAssistMode()

actionsPanel.getSelectedText()

Availability

Flash CS3 Professional.

Usage

actionsPanel.getSelectedText()

EXTENDING FLASH CS4 PROFESSIONAL

actionsPanel object

Parameters

None.

Returns

A string that contains the text that is currently selected in the Actions panel.

Description

Method; returns the text that is currently selected in the Actions panel.

Example

The following example displays the text that is currently selected in the Actions panel.

var apText = fl.actionsPanel.getSelectedText();
fl.trace(apText);

See also

actionsPanel.getText(), actionsPanel.hasSelection(), actionsPanel.replaceSelectedText(),

actionsPanel.setSelection()

27

actionsPanel.getText()

Availability

Flash CS3 Professional.

Usage

actionsPanel.getText()

Parameters

None.

Returns

A string that contains all the text in the Actions panel.

Description

Method; returns the text in the Actions panel.

Example

The following example displays the text that is in the Actions panel.

var apText = fl.actionsPanel.getText();
fl.trace(apText);

See also

actionsPanel.getSelectedText(), actionsPanel.setText()

EXTENDING FLASH CS4 PROFESSIONAL

actionsPanel object

actionsPanel.hasSelection()

Availability

Flash CS3 Professional.

Usage

actionsPanel.hasSelection()

Parameters

None.

Returns

A Boolean value that specifies whether any text is selected in the Actions panel (true) or not (false).

Description

Method; specifies whether any text is currently selected in the Actions panel.

Example

The following example displays text that is currently selected in the Actions panel. If no text is selected, it displays all
the text in the Actions panel.

28

if (fl.actionsPanel.hasSelection()) {
var apText = fl.actionsPanel.getSelectedText();
}
else {
var apText = fl.actionsPanel.getText();
}
fl.trace(apText);

See also

actionsPanel.getSelectedText(), actionsPanel.getText(), actionsPanel.replaceSelectedText(),

actionsPanel.setSelection()

actionsPanel.replaceSelectedText()

Availability

Flash CS3 Professional.

Usage

actionsPanel.replaceSelectedText(replacementText)

Parameters

replacementText A string that represents text to replace selected text in the Actions panel.

Returns

A Boolean value of true if the Actions panel is found; false otherwise.

EXTENDING FLASH CS4 PROFESSIONAL

actionsPanel object

Description

Method; replaces the currently selected text with the text specified in replacementText. If replacementText contains
more characters than the selected text, any characters following the selected text now follow replacementText; that is,
they are not overwritten.

Example

The following example replaces currently selected text in the Actions panel.

if (fl.actionsPanel.hasSelection()) {
fl.actionsPanel.replaceSelectedText("// © 2006 Adobe Inc.");
}

See also

actionsPanel.getSelectedText(), actionsPanel.hasSelection(), actionsPanel.setSelection(),

actionsPanel.setText()

actionsPanel.setScriptAssistMode()

29

Availability

Flash CS3 Professional.

Usage

actionsPanel.setScriptAssistMode(bScriptAssist)

Parameters

bScriptAssist A Boolean value that specifies whether to enable or disable Script Assist mode.

Returns

A Boolean value that specifies whether Script Assist mode was enabled or disabled successfully.

Description

Method; enables or disables Script Assist mode.

Example

The following example toggles the state of Script Assist mode.

fl.trace(fl.actionsPanel.getScriptAssistMode());
if (fl.actionsPanel.getScriptAssistMode()){
fl.actionsPanel.setScriptAssistMode(false);
}
else {
fl.actionsPanel.setScriptAssistMode(true);
}
fl.trace(fl.actionsPanel.getScriptAssistMode());

See also

actionsPanel.getScriptAssistMode()

EXTENDING FLASH CS4 PROFESSIONAL

actionsPanel object

actionsPanel.setSelection()

Availability

Flash CS3 Professional.

Usage

actionsPanel.setSelection(startIndex, numberOfChars)

Parameters

startIndex A zero-based integer that specifies the first character to be selected.

numberOfChars An integer that specifies how many characters to select.

Returns

A Boolean value that specifies whether the requested characters can be selected (true) or not (false).

Description

Method; selects a specified set of characters in the Actions panel.

30

Example

The following example replaces the characters “2006” in the Actions panel with the specified text.

// Type the following as the first line in the Actions panel
// 2006 - Addresses user request 40196
// Type the following in the JSFL file
fl.actionsPanel.setSelection(3,4);
fl.actionsPanel.replaceSelectedText("// Last updated: 2007");

See also

actionsPanel.getSelectedText(), actionsPanel.hasSelection(),

actionsPanel.replaceSelectedText()

actionsPanel.setText()

Availability

Flash CS3 Professional.

Usage

actionsPanel.setText(replacementText)

Parameters

replacementText A string that represents text to place in the Actions panel.

Returns

A Boolean value of true if the specified text was placed in the Actions panel; false otherwise.

EXTENDING FLASH CS4 PROFESSIONAL

Description

Method; clears any text in the Actions panel and then adds the text specified in replacementText.

Example

The following example replaces any text currently in the Actions panel with the specified text.

fl.actionsPanel.setText("// Deleted this code - no longer needed");

See also

actionsPanel.getText(), actionsPanel.replaceSelectedText()

31

actionsPanel object

Chapter 4: 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 (see Instance object).

Method summary

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

Method Description

32

bitmapInstance.getBits() Lets you create bitmap effects by getting the bits out of the bitmap,

bitmapInstance.setBits() Sets the bits of an existing bitmap element.

Property summary

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

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

manipulating them, and then returning them to Flash.

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 bits
element is an array of bytes. The
array is the length of the color table.

cTab element is an array of color values of the form "#RRGGBB". The length of the

EXTENDING FLASH CS4 PROFESSIONAL

BitmapInstance object

The byte array is meaningful only when referenced by a DLL or shared library. You typically use it only when creating
an extensible tool or effect. For information on creating DLLs for use with Flash JavaScript, see

“C-Level Extensibility”

on page 522

Description

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

Example

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);
}

See also

bitmapInstance.setBits()

33

bitmapInstance.hPixels

Availability

Flash MX 2004.

Usage

bitmapInstance.hPixels

Description

Read-only property; an integer that represents the width of the bitmap—that is, the number of pixels in the horizontal
dimension.

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];
var isBitmap = bmObj.instanceType;
if(isBitmap == "bitmap"){
var numHorizontalPixels = bmObj.hPixels;
}

See also

bitmapInstance.vPixels

EXTENDING FLASH CS4 PROFESSIONAL

BitmapInstance object

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

propertiesare integers. The
depth of 8 or less and is a string that represents a color value in the form "#RRGGBB".

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

Nothing.

bits property is a byte array. The cTab property is required only for bitmaps with a bit

34

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 sets the height of the bitmap to 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);
}

See also

bitmapInstance.getBits()

bitmapInstance.vPixels

Availability

Flash MX 2004.

Usage

bitmapInstance.vPixels

Description

Read-only property; an integer that represents the height of the bitmap—that is, the number of pixels in the vertical
dimension.

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;
}

See also

bitmapInstance.hPixels

EXTENDING FLASH CS4 PROFESSIONAL

BitmapInstance object

35

Chapter 5: 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 (see Item object).

Property summary

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

Property Description

36

bitmapItem.allowSmoothing A Boolean value that specifies whether to allow smoothing

bitmapItem.compressionType A string that determines the type of image compression

bitmapItem.fileLastModifiedDate The number of seconds that have elapsed between

bitmapItem.originalCompressionType Specifies whether the item was imported as an jpeg file.

bitmapItem.sourceFileExists Specifies whether the file that was imported to the Library

bitmapItem.sourceFileIsCurrent Specifies whether the file modification date of the Library

bitmapItem.sourceFilePath The path and name of the file that was imported into the

bitmapItem.useDeblocking Specifies whether deblocking is enabled.

bitmapItem.useImportedJPEGQuality A Boolean value that specifies whether to use the default

of a bitmap.

applied to the bitmap.

January 1, 1970 and the modification date of the original
file.

still exists in the location from where it was imported.

item is the same as the modification date on disk of the file
that was imported.

Library.

imported JPEG quality.

Method summary

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

Method Description

bitmapItem.exportToFile() Exports the specified item to a PNG or JPG file.

EXTENDING FLASH CS4 PROFESSIONAL

BitmapItem object

bitmapItem.allowSmoothing

Availability

Flash MX 2004.

Usage

bitmapItem.allowSmoothing

Description

Property; a Boolean value that specifies whether to allow smoothing of a bitmap (true) or not (false).

Example

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

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

bitmapItem.compressionType

37

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 "photo"

"lossless". If the value of bitmapItem.useImportedJPEGQuality is false, "photo" corresponds to JPEG with

or
a quality from 0 to 100; if
default document quality value. The value

bitmapItem.useImportedJPEGQuality).

Example

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

"photo":

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

bitmapItem.useImportedJPEGQuality is true, "photo" corresponds to JPEG using the

"lossless" corresponds to GIF or PNG format (see

bitmapItem.exportToFile()

Availability

Flash CS4 Professional.

Usage

bitmapItem.exportToFile(fileURI)

EXTENDING FLASH CS4 PROFESSIONAL

Parameters

fileURI A string, expressed as a file:/// URI, that specifies the path and name of the exported file.

Returns

A Boolean value of true if the file was exported successfully; false otherwise.

Description

Method; exports the specified item to a PNG or JPG file.

Example

Assuming the first item in the Library is a bitmap item, the following code exports it as a JPG file:

var imageFileURL = "file:///C|/exportTest/out.jpg";
var libItem = fl.getDocumentDOM().library.items[0];
libItem.exportToFile(imageFileURL);

bitmapItem.fileLastModifiedDate

38

BitmapItem object

Availability

Flash CS4 Professional.

Usage

bitmapItem.fileLastModifiedDate

Description

Read-only property; a string containing a hexadecimal number that represents the number of seconds that have
elapsed between January 1, 1970 and the modification date of the original file at the time the file was imported to the
library. If the file no longer exists, this value is "00000000".

Example

Assuming the first item in the Library is a bitmap item, the following code displays a hex number as described above.

var libItem = fl.getDocumentDOM().library.items[0];
fl.trace("Mod date when imported = " + libItem.fileLastModifiedDate);

See also

bitmapItem.sourceFileExists, bitmapItem.sourceFileIsCurrent, bitmapItem.sourceFilePath,

FLfile.getModificationDate()

bitmapItem.originalCompressionType

Availability

Flash CS4 Professional.

Usage

bitmapItem.originalCompressionType

EXTENDING FLASH CS4 PROFESSIONAL

BitmapItem object

Description

Read-only property; a string that specifies whether the specified item was imported as an jpeg file. Possible values for
this property are “photo” (for jpeg files) and “lossless” (for uncompressed file types such as GIF and PNG).

Example

Assuming that the first item in the Library is a bitmap item, the following code displays "photo" if the file was imported
into the Library as a jpeg file, or "lossless" if is was not:

var libItem = fl.getDocumentDOM().library.items[0];
fl.trace("Imported compression type = "+ libItem.originalCompressionType);

See also

bitmapItem.compressionType

bitmapItem.quality

Availability

Flash MX 2004.

39

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

Availability

Flash CS4 Professional.

Usage

bitmapItem.sourceFileExists

Description

Read-only property; a Boolean value of true if the file that was imported to the Library still exists in the location from
where it was imported;

false otherwise.

EXTENDING FLASH CS4 PROFESSIONAL

BitmapItem object

Example

Assuming the first item in the Library is a bitmap item, the following code displays "true" if the file that was imported
into the Library still exists.

var libItem = fl.getDocumentDOM().library.items[0];
fl.trace("sourceFileExists = "+ libItem.sourceFileExists);

See also

bitmapItem.sourceFileIsCurrent,

bitmapItem.sourceFilePath

bitmapItem.sourceFileIsCurrent

Availability

Flash CS4 Professional.

Usage

bitmapItem.sourceFileIsCurrent

40

Description

Read-only property; a Boolean value of true if the file modification date of the Library item is the same as the
modification date on disk of the file that was imported ;

false otherwise.

Example

Assuming the first item in the Library is a bitmap item, the following code displays "true" if the file that was imported
has not been modified on disk since it was imported:

var libItem = fl.getDocumentDOM().library.items[0];
fl.trace("fileIsCurrent = "+ libItem.sourceFileIsCurrent);

See also

bitmapItem.fileLastModifiedDate, bitmapItem.sourceFilePath

bitmapItem.sourceFilePath

Availability

Flash CS4 Professional.

Usage

bitmapItem.sourceFilePath

EXTENDING FLASH CS4 PROFESSIONAL

BitmapItem object

Description

Read-only property; a string, expressed as a file:/// URI, that represents the path and name of the file that was imported
into the Library.

Example

The following example displays the name and source file path of any items in the library that are of type "bitmap":

for (idx in fl.getDocumentDOM().library.items) {
if (fl.getDocumentDOM().library.items[idx].itemType == "bitmap") {
var myItem = fl.getDocumentDOM().library.items[idx];
fl.trace(myItem.name + " source is " + myItem.sourceFilePath);
}
}

See also

bitmapItem.sourceFileExists

bitmapItem.useDeblocking

41

Availability

Flash CS4 Professional.

Usage

bitmapItem.useDeblocking

Description

Property; a Boolean value that specifies whether deblocking is enabled (true) or not (false).

Example

Assuming the first item in the Library is a bitmap item, the following code enables deblocking for the item:

var libItem = fl.getDocumentDOM().library.items[0];
libItem.useDeblocking = true;

bitmapItem.useImportedJPEGQuality

Availability

Flash MX 2004.

Usage

bitmapItem.useImportedJPEGQuality

EXTENDING FLASH CS4 PROFESSIONAL

BitmapItem object

Description

Property; a Boolean value that specifies whether to use the default imported JPEG quality (true) or not (false).
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:

42

Chapter 6: 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 (see Instance object).

Property summary

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

Property Description

compiledClipInstance.accName A string that is equivalent to the Name field in the Accessibility panel.

43

compiledClipInstance.actionScript A string that represents the ActionScript for this instance; equivalent to

compiledClipInstance.description A string that is equivalent to the Description field in the Accessibility panel.

compiledClipInstance.forceSimple A Boolean value that enables and disables the children of the object to be

compiledClipInstance.shortcut A string that is equivalent to the Shortcut field in the Accessibility panel.

compiledClipInstance.silent A Boolean value that enables or disables the accessibility of the object;

compiledClipInstance.tabIndex An integer that is equivalent to the Tab Index field in the Accessibility panel.

symbolInstance.actionScript.

accessible.

equivalent to the inverse logic of the Make Object Accessible setting in the
Accessibility panel.

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.

Example

The following example gets and sets the accessibility name of the first selected object:

EXTENDING FLASH CS4 PROFESSIONAL

CompiledClipInstance object

// 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:

44

// 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";

EXTENDING FLASH CS4 PROFESSIONAL

CompiledClipInstance object

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
same as the Make Child Objects Accessible option being unchecked. If
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;

forceSimple is false, it is the same as the

forceSimple is true, it is the

45

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

EXTENDING FLASH CS4 PROFESSIONAL

CompiledClipInstance object

Usage

compiledClipInstance.silent

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
unchecked. If

silent is false, then Make Object Accessible is checked.

silent is true, then Make Object Accessible is

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.

46

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().selection[0].tabIndex = 1;

Chapter 7: compilerErrors object

Availability

Flash CS3 Professional.

Description

The compilerErrors object, which represents the Compiler Errors panel, is a property of the flash object (fl) and can
be accessed by

Method summary

The following methods can be used with the compilerErrors object:

Method Description

compilerErrors.clear() Clears the contents of the Compiler Errors panel.

compilerErrors.save() Saves the contents of the Compiler Errors panel to a local text file.

fl.compilerErrors (see flash object (fl)).

47

compilerErrors.clear()

Availability

Flash CS3 Professional.

Usage

compilerErrors.clear()

Parameters

None.

Returns

Nothing.

Description

Method; clears the contents of the Compiler Errors panel.

Example

The following example clears the contents of the Compiler Errors panel:

fl.compilerErrors.clear();

See also

compilerErrors.save()

EXTENDING FLASH CS4 PROFESSIONAL

compilerErrors object

compilerErrors.save()

Availability

Flash CS3 Professional.

Usage

compilerErrors.save(fileURI [, bAppendToFile [, bUseSystemEncoding]])

Parameters

fileURI A string, expressed as a file:/// URI, that specifies the filename for the saved file. If fileURI already exists, and

you haven’t specified a value of

bAppendToFile An optional Boolean value that specifies whether the contents of the Compiler Errors panel should

be appended to fileURI (

bUseSystemEncoding An optional Boolean value that specifies whether to save the Compiler Errors panel text using

the system encoding. If this value is
with Byte Order Mark characters at the beginning of the text. The default value is

Returns

Nothing.

true for bAppendToFile, fileURI is overwritten without warning.

true) or not (false). The default value is false.

false (the default), the Compiler Errors panel text is saved using UTF-8 encoding,

false.

48

Description

Method; saves the contents of the Compiler Errors panel to a local text file.

Example

The following example saves the contents of the Compiler Errors panel to a file named errors.log in the C:\tests folder:

fl.compilerErrors.save("file:///c|/tests/errors.log");

See also

compilerErrors.clear()

Chapter 8: ComponentInstance object

Inheritance Element object > Instance object > SymbolInstance object > ComponentInstance object

Availability

Flash MX 2004.

Description

TheComponentInstance object is a subclass of the SymbolInstance object and represents a component in a frame (see

SymbolInstance object).

Property summary

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

Property Description

49

componentInstance.parameters Read-only; an array of ActionScript 2.0 properties that are accessible from the

component Property inspector.

componentInstance.parameters

Availability

Flash MX 2004.

Usage

componentInstance.parameters

Description

Read-only property; an array of ActionScript 2.0 properties that are accessible from the component Property
inspector. See

Example

The following example illustrates getting and setting the parameters property:

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

See also

Parameter object

Parameter object.

Chapter 9: componentsPanel object

Availability

Flash MX 2004.

Description

The componentsPanel object, which represents the Components panel, is a property of the flash object (fl) and can be
accessed by

Method summary

You can use the following methods with the componentsPanel object:

Method Description

fl.componentsPanel (see flash object (fl)).

50

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

componentsPanel.reload() Refreshes the Components panel's list of components.

position.

componentsPanel.addItemToDocument()

Availability

Flash MX 2004.

Usage

componentsPanel.addItemToDocument(position, categoryName, componentName)

Parameters

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

position relative to the center point of the component—not the component’s registration point (also origin point or
zero point).

categoryName A string that specifies the name of the component category (for example, "Data"). The valid category

names are listed in the Components panel.

componentName A string that specifies the name of the component in the specified category (for example,

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.

Example

The following examples illustrate some ways to use this method:

EXTENDING FLASH CS4 PROFESSIONAL

componentsPanel object

fl.componentsPanel.addItemToDocument({x:0, y:0}, "User Interface", "CheckBox");
fl.componentsPanel.addItemToDocument({x:0, y:100}, "Data", "WebServiceConnector");
fl.componentsPanel.addItemToDocument({x:0, y:200}, "User Interface", "Button");

componentsPanel.reload()

Availability

Flash 8.

Usage

componentsPanel.reload()

Parameters

None.

Returns

A Boolean value of true if the Component panel list is refreshed, false otherwise.

51

Description

Method; refreshes the Components panel’s list of components.

Example

The following example refreshes the Components panel:

fl.componentsPanel.reload();

Chapter 10: 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

You can use the following method with the Contour object:

Method Description

contour.getHalfEdge() Returns a HalfEdge object on the contour of the selection.

Property summary

You can use the following properties with the Contour object:

52

Property Description

contour.fill A Fill object.

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.

contour.fill

Availability

Flash CS4 Professional.

Usage

contour.fill

Description

Property; a Fill object.

Example

Assuming that you have a contour with a fill selected, the following example displays the contour’s fill color in the
Output panel:

var insideContour = fl.getDocumentDOM().selection[0].contours[1];
var insideFill = insideContour.fill;
fl.trace(insideFill.color);

EXTENDING FLASH CS4 PROFESSIONAL

Contour object

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 the selected shape and shows the coordinates of the vertices in the Output
panel:

53

// with a shape selected

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];
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();

EXTENDING FLASH CS4 PROFESSIONAL

Contour object

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 of 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++;
}
elt.endEdit();

54

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();

EXTENDING FLASH CS4 PROFESSIONAL

Contour object

55

Chapter 11: Document object

Availability

Flash MX 2004.

Description

The Document object represents the Stage. That is, only FLA files are considered documents. To return the Document
object for the current document, use

Method summary

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.addFilter() Applies a filter to the selected objects.

fl.getDocumentDOM().

56

document.addItem() Adds an item from any open document or library to the

document.addNewLine() Adds a new path between two points.

document.addNewOval() Adds a new Oval object in the specified bounding rectangle.

document.addNewPrimitiveOval() Adds a new oval primitive fitting into the specified bounds.

document.addNewPrimitiveRectangle() Adds a new rectangle primitive fitting into the specified

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 the

document.addNewScene() Adds a new scene (Timeline object) as the next scene after the

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

document.canEditSymbol() Indicates whether the Edit Symbols menu and functionality are

specified Document object.

bounds.

specified bounds.

currently selected scene and makes the new scene the
currently selected scene.

document.screenOutline property.

enabled.

document.canRevert() Determines whether you can use the document.revert() or

document.canSaveAVersion() Determines whether a version of the specified document can

fl.revertDocument() method successfully.

be saved to the Version Cue server.

Method Description

EXTENDING FLASH CS4 PROFESSIONAL

Document object

57

document.canTestMovie() Determines whether you can use the

document.canTestScene() Determines whether you can use the

document.changeFilterOrder() Changes the index of the filter in the Filters list.

document.clipCopy() Copies the current selection from the document to the

document.testMovie() method successfully.

document.testScene() method successfully.

Clipboard.

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.crop() Uses the top selected drawing object to crop all selected

drawing objects underneath it.

document.deleteEnvelope() Deletes the envelope (bounding box that contains one or

more objects) from the selected object.

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.disableAllFilters() Disables all filters on the selected objects.

document.disableFilter() Disables the specified filter in the Filters list.

document.disableOtherFilters() Disables all filters except the one at the specified position in

the Filters list.

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.enableAllFilters() Enables all the filters on the Filters list for the selected object(s).

document.enableFilter() Enables the specified filter for the selected object(s).

Method Description

EXTENDING FLASH CS4 PROFESSIONAL

Document object

58

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.exportPNG() Exports the document as one or more PNG files.

document.exportPublishProfile() Exports the currently active profile to an XML file.

document.exportPublishProfileString() Returns a string that specifies, in XML format, the specified

profile.

document.exportSWF() Exports the document in the Flash SWF format.

document.getAlignToDocument() Identical to retrieving the value of the To Stage button in the

Align panel.

document.getBlendMode() Returns a string that specifies the blending mode for the

selected object(s).

document.getCustomFill() Retrieves the fill object of the selected shape, or the Tools

panel and Property inspector if specified.

document.getCustomStroke() Returns the stroke object of the selected shape, or the Tools

panel and Property inspector if specified.

document.getDataFromDocument() Retrieves the value of the specified data.

document.getElementProperty() Gets the specified Element property for the current selection.

document.getElementTextAttr() Gets a specified TextAttrs property of the selected Text

objects.

document.getFilters() Returns an array that contains the list of filters applied to the

currently selected object(s).

document.getMetadata() Returns a string containing the XML metadata associated with

the document.

document.getMobileSettings() Returns the string passed to

document.getPlayerVersion() Returns a string that represents the targeted player version for

document.setMobileSettings().

the specified document.

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.importFile() Imports a file into the document.

document.importPublishProfile() Imports a profile from a file.

document.importPublishProfileString() Imports an XML string that represents a publish profile and sets

it as the current profile.

document.importSWF() Imports a SWF file into the document.

Method Description

EXTENDING FLASH CS4 PROFESSIONAL

Document object

59

document.intersect() Creates an intersection drawing object from all selected

drawing objects.

document.match() Makes the size of the selected objects the same.

document.mouseClick() Performs a mouse click from the Selection tool.

document.mouseDblClk() Performs a double mouse click from the Selection 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 (File > Publish Settings); equivalent to selecting File >
Publish.

document.punch() Uses the top selected drawing object to punch through all

selected drawing objects underneath it.

document.removeAllFilters() Removes all filters from the selected object(s).

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.removeFilter() Removes the specified filter from the Filters list of the selected

object(s).

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.resetOvalObject() Sets all values in the Property inspector to default Oval object

settings.

document.resetRectangleObject() Sets all values in the Property inspector to default Rectangle

object settings.

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.revertToLastVersion() Reverts the specified document to the version stored on the

Version Cue server and logs any errors to the Output panel.

document.rotate3DSelection() Applies a 3D rotation to the selection.

document.rotateSelection() Rotates the selection by a specified number of degrees.

document.save() Saves the document in its default location; equivalent to

selecting File > Save.

Method Description

EXTENDING FLASH CS4 PROFESSIONAL

Document object

60

document.saveAndCompact() Saves and compacts the file; equivalent to selecting File > Save

and Compact.

document.saveAVersion() Saves a version of the specified document to the Version Cue

server.

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.setBlendMode() Sets the blending mode for the selected objects.

document.setCustomFill() Sets the fill settings for the Tools panel, Property inspector, and

any selected shapes.

document.setCustomStroke() Sets the stroke settings for the Tools panel, 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.setFilterProperty() Sets a specified filter property for the currently selected

object(s).

document.setFilters() Applies filters to the selected objects.

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.setMetadata() Sets the XML metadata for the specified document,

overwriting any existing metadata.

document.setMobileSettings() Sets the value of an XML settings string in a mobile FLA file.

document.setOvalObjectProperty() Specifies a value for a specified property of primitive Oval

objects.

document.setPlayerVersion() Sets the version of the Flash Player targeted by the specified

document.

document.setRectangleObjectProperty() Specifies a value for a specified property of primitive Rectangle

objects.

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.

EXTENDING FLASH CS4 PROFESSIONAL

Method Description

document.setStageVanishingPoint() Specifies the vanishing point for viewing 3D objects.

document.setStageViewAngle() Specifies the perspective angle for viewing 3D objects.

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.

61

Document object

document.setTextRectangle() Changes the bounding rectangle for the selected text item to

the specified size.

document.setTextSelection() Sets the text selection of the currently selected text field to the

values specified by the

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

startIndex and endIndex values.

the Straighten button in the Tools panel.

document.swapElement() Swaps the current selection with the specified one.

document.swapStrokeAndFill() Swaps the Stroke and Fill colors.

document.synchronizeWithHeadVersion() Synchronizes the specified document with the most current

version on the Version Cue server and logs any errors to the
Output panel.

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.translate3DCenter() Sets the XYZ position around which the selection is translated

or rotated.

document.translate3DSelection() Applies a 3D translation to the selection.

document.unGroup() Ungroups the current selection.

document.union() Combines all selected shapes into a drawing object.

document.unlockAllElements() Unlocks all locked elements on the currently selected frame.

document.xmlPanel() Posts a XMLUI dialog box.

Property summary

You can use the following properties with the Document object.

EXTENDING FLASH CS4 PROFESSIONAL

Property Description

document.accName A string that is equivalent to the Name field in the Accessibility panel.

62

Document object

document.as3AutoDeclare A Boolean value that describes whether the instances placed on the Stage

are automatically added to user-defined timeline classes.

document.as3Dialect A string that describes the ActionScript 3.0 “dialect” being used in the

specified document.

document.as3ExportFrame An integer that specifies in which frame to export ActionScript 3.0 classes.

document.as3StrictMode A Boolean value that specifies whether the ActionScript 3.0 compiler

should compile with the Strict Mode option turned on or off.

document.as3WarningsMode A Boolean value that specifies whether the ActionScript 3.0 compiler

should compile with the Warnings Mode option turned on or off.

document.asVersion An integer that specifies which version of ActionScript is being used in the

specified file.

document.autoLabel A Boolean value that is equivalent to the Auto Label check box in the

Accessibility panel.

document.backgroundColor A string, hexadecimal value, or integer that represents the background

color.

document.currentPublishProfile A string that specifies the name of the active publish profile for the

specified document.

document.currentTimeline An integer that specifies the index of the active timeline.

document.description A string that is equivalent to the Description field in the Accessibility

panel.

document.docClass Specifies the top-level ActionScript 3.0 class associated with the

document.

document.externalLibraryPath A string that contains a list of items in the document’s ActionScript 3.0

External library path, which specifies the location of SWC files used as
runtime shared libraries.

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.id A unique integer (assigned automatically) that identifies a document

during a Flash session.

document.library Read-only; the library object for a document.

document.libraryPath A string that contains a list of items in the document’s ActionScript 3.0

Library path, which specifies the location of SWC files or folders containing
SWC files.

document.livePreview A Boolean value that specifies whether 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, in a

platform-specific format.

document.pathURI Read-only; a string that represents the path of the document, expressed as

a file:/// URI.

EXTENDING FLASH CS4 PROFESSIONAL

Property Description

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.

63

Document object

document.sourcePath A string that contains a list of items in the document’s ActionScript 3.0

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.zoomFactor Specifies the zoom percent of the Stage at authoring time.

Source path, which specifies the location of ActionScript class files.

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.

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.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

type A string that defines the type of data to add. Acceptable values 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.

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"));

See also

document.getDataFromDocument(), document.removeDataFromDocument()

64

document.addDataToSelection()

Availability

Flash MX 2004.

Usage

document.addDataToSelection(name, type, data)

Parameters

name A string that specifies the name of the persistent data.

type Defines the type of data. Acceptable values 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.

Example

The following example adds an integer value of 12 to the selected object:

EXTENDING FLASH CS4 PROFESSIONAL

fl.getDocumentDOM().addDataToSelection("myData", "integer", 12);

Document object

See also

document.removeDataFromSelection()

document.addFilter()

Availability

Flash 8.

Usage

document.addFilter(filterName)

Parameters

filterName A string specifying the filter to be added to the Filters list and enabled for the selected object(s).

Acceptable values are

"glowFilter", "gradientBevelFilter", and "gradientGlowFilter".

"adjustColorFilter", "bevelFilter", "blurFilter", "dropShadowFilter",

65

Returns

Nothing.

Description

Method; applies a filter to the selected objects and places the filter at the end of the Filters list.

Example

The following example applies a glow filter to the selected object(s):

fl.getDocumentDOM().addFilter("glowFilter");

See also

document.changeFilterOrder(), document.disableFilter(), document.enableFilter(),
document.getFilters(), document.removeFilter(), document.setBlendMode(),

document.setFilterProperty()

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.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

item An Item object that specifies the item to add and the library from which to add it (see Item object).

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

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:

66

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, endpoint)

Parameters

startpoint A pair of floating-point numbers that specify the x and y coordinates where the line 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.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

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

Parameters

boundingRectangle A rectangle that specifies the bounds of the oval to be added. For information on the format of

boundingRectangle, see

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.

document.addNewRectangle().

67

bSuppressStroke A Boolean value that, if set to true, causes the method to create the shape without a stroke. The

default value is

false. This parameter is optional.

Returns

Nothing.

Description

Method; adds a new Oval object 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 both bSuppressFill and bSuppressStroke are set to

true, the method has no effect.

Example

The following example adds a new oval within the specified coordinates; it is 164 pixels in width and 178 pixels in
height:

fl.getDocumentDOM().addNewOval({left:72,top:50,right:236,bottom:228});

The following example draws the oval without a fill:

fl.getDocumentDOM().addNewOval({left:72,top:50,right:236,bottom:228}, true);

The following example draws the oval without a stroke:

fl.getDocumentDOM().addNewOval({left:72,top:50,right:236,bottom:228}, false, true);

See also

document.addNewPrimitiveOval()

EXTENDING FLASH CS4 PROFESSIONAL

Document object

document.addNewPrimitiveOval()

Availability

Flash CS4 Professional.

Usage

document.addNewPrimitiveOval( boundingRectangle [, bSpupressFill [, bSuppressStroke ]] ))

Parameters

boundingRectangle A rectangle that specifies the bounds within which the new oval primitive is added. For

information on the format of boundingRectangle, see

bSuppressFill A Boolean value that, if set to true, causes the method to create the oval without a fill. The default

value is

bSuppressStroke A Boolean value that, if set to true, causes the method to create the oval without a stroke. The

default value is

false. This parameter is optional.

false. This parameter is optional.

Returns

Nothing.

document.addNewRectangle().

68

Description

Method; adds a new oval primitive fitting into the specified bounds. This method performs the same operation as the
Oval Primitive tool. The oval primitive uses the document's current default stroke and fill attributes and is added on
the current frame and layer. If both bSuppressFill and bSuppressStroke are set to

true, the method has no effect.

Example

The following example adds oval primitives within the specified coordinates, with and without fill and stroke:

// Add an oval primitive with fill and stroke
fl.getDocumentDOM().addNewPrimitiveOval({left:0,top:0,right:100,bottom:100});
// Add an oval primitive without a fill
fl.getDocumentDOM().addNewPrimitiveOval({left:100,top:100,right:200,bottom:200}, true);
// Add an oval primitive without a stroke
fl.getDocumentDOM().addNewPrimitiveOval({left:200,top:200,right:300,bottom:300},false,true);

See also

document.addNewOval()

document.addNewPrimitiveRectangle()

Availability

Flash CS4 Professional.

Usage

document.addNewPrimitiveRectangle( boundingRectangle, roundness, [, bSuppressFill [,
bSuppressStroke ]] ))

EXTENDING FLASH CS4 PROFESSIONAL

Document object

Parameters

rect A rectangle that specifies the bounds within which the new rectangle primitive is added. For information on the

format of boundingRectangle, see

roundness An integer between 0 and 999 that represents the number of points used to specify how much the corners

document.addNewRectangle().

should be rounded.

bSuppressFill A Boolean value that, if set to true, causes the method to create the rectangle without a fill. The

default value is

bSuppressStroke A Boolean value that, if set to true, causes the method to create the rectangle without a stroke.

false. This parameter is optional.

The default value is false. This parameter is optional.

Returns

Nothing.

Description

Method; adds a new rectangle primitive fitting into the specified bounds. This method performs the same operation
as the Rectangle Primitive tool. The rectangle primitive uses the document's current default stroke and fill attributes
and is added on the current frame and layer. If both bSuppressFill and bSuppressStroke are set to

true, the method has

no effect.

69

Example

The following example adds rectangle primitives within the specified coordinates, with and without fill and stroke, and
with different amounts of roundness:

// Add a rectangle primitive with fill and stroke
fl.getDocumentDOM().addNewPrimitiveRectangle({left:0,top:0,right:100,bottom:100}, 0);
// Add a rectangle primitive without a fill
fl.getDocumentDOM().addNewPrimitiveRectangle({left:100,top:100,right:200,bottom:200}, 20,
true);
// Add a rectangle primitive without a stroke
fl.getDocumentDOM().addNewPrimitiveRectangle({left:200,top:200,right:300,bottom:300},
50,false,true);

See also

document.addNewRectangle()

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.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

Returns

An integer that is the index of the new profile in the profiles list. Returns -1 if a new profile cannot be created.

Description

Method; adds a new publish profile and makes it the current one.

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");

See also

document.deletePublishProfile()

70

document.addNewRectangle()

Availability

Flash MX 2004.

Usage

document.addNewRectangle(boundingRectangle, roundness
[, bSuppressFill [, bSuppressStroke]])

Parameters

boundingRectangle A rectangle that specifies the bounds within which the new rectangle is added, in the format

{left:value1,top:value2,right:value3,bottom:value4}. The left and top values specify the location of the

upper left corner (e.g.,
specify the location of the lower-right corner. Therefore, the width of the rectangle is the difference in value between

left and right, and the height of the rectangle is the difference in value between top and bottom.

In other words, the rectangle bounds do not all correspond to the values shown in the Property inspector. The left

top values correspond to the X and Y values in the Property inspector, respectively. However, the right and

and

bottom values don’t correspond to the W and H values in the Property inspector. For example, consider a rectangle

with the following bounds:

{left:10,top:10,right:50,bottom:100}

This rectangle would display the following values in the Property inspector:

X = 10, Y = 10, W = 40, H = 90

left:0,top:0 represents the upper left corner of the Stage) and the right and bottom values

roundness An integer value from 0 to 999 that specifies the roundness to use for the 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.

EXTENDING FLASH CS4 PROFESSIONAL

bSuppressStroke A Boolean value that, if set to true, causes the method to create the rectangle without a stroke.

The default value is

false. This parameter is optional.

Document object

Returns

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 both bSuppressFill and bSuppressStroke are set to

true, the method

has no effect.

Example

The following example adds a new rectangle with no rounding on the corners within the specified coordinates; it is 100
pixels in width and in height:

fl.getDocumentDOM().addNewRectangle({left:0,top:0,right:100,bottom:100},0);

The following example adds a new rectangle with no rounding on the corners and without a fill; it is 100 pixels in width
and 200 in height:

71

fl.getDocumentDOM().addNewRectangle({left:10,top:10,right:110,bottom:210},0, true);

The following example adds a new rectangle with no rounding on the corners and without a stroke; it is 200 pixels in
width and 100 in height:

fl.getDocumentDOM().addNewRectangle({left:20,top:20,right:220,bottom:120},0, false, true);

See also

document.addNewPrimitiveRectangle()

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.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

Example

The following example adds a new scene named myScene after the current scene in the current document. The variable

success will be true when the new scene is created; false otherwise.

var success = fl.getDocumentDOM().addNewScene("myScene");

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();

"Scene 2".

document.addNewText()

Availability

Flash MX 2004; optional text parameter added in Flash CS3 Professional.

Usage

document.addNewText(boundingRectangle [, text ])

72

Parameters

boundingRectangle Specifies the size and location of the text field. For information on the format of

boundingRectangle, see

text An optional string that specifies the text to place in the field. If you omit this parameter, the selection in the Tools

document.addNewRectangle().

panel switches to the Text tool. Therefore, if you don’t want the selected tool to change, pass a value for text.

Returns

Nothing.

Description

Method; inserts a new text field and optionally places text into the field. If you omit the text parameter, you can call

document.setTextString() to populate the text field.

Example

The following example creates a new text field in the upper left corner of the Stage and sets the text string to "Hello

World":

fl.getDocumentDOM().addNewText({left:0, top:0, right:100, bottom:100} , "Hello World!" );
fl.getDocumentDOM().setTextString('Hello World!');

See also

document.setTextString()

document.align()

Availability

Flash MX 2004.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

Usage

document.align(alignmode [, bUseDocumentBounds])

Parameters

alignmode A string that specifies how to align the selection. Acceptable values are "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 bounds of the document.

Otherwise, the method uses the bounds of the selected objects. The default is

false. This parameter is optional.

Returns

Nothing.

Description

Method; aligns the selection.

Example

The following example aligns objects to the 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:

73

fl.getDocumentDOM().align("left", true);

See also

document.distribute(), document.getAlignToDocument(), document.setAlignToDocument()

document.allowScreens()

Availability

Flash MX 2004.

Usage

document.allowScreens()

Parameters

None.

Returns

A Boolean value: true if document.screenOutline can be used safely; false otherwise.

Description

Method; use before using the document.screenOutline property. If this method returns the value true, you can
safely access
document without screens.

document.screenOutline; Flash displays an error if you access document.screenOutline in a

Example

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.");
}

See also

document.screenOutline

document.arrange()

Availability

Flash MX 2004.

Usage

document.arrange(arrangeMode)

EXTENDING FLASH CS4 PROFESSIONAL

Document object

74

Parameters

arrangeMode Specifies the direction in which to move the selection. Acceptable values are "back", "backward",
"forward", and "front". It provides the same capabilities as these options provide on the Modify > Arrange menu.

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

Availability

Flash CS3 Professional.

Usage

document.as3AutoDeclare

Description

Property; a Boolean value that describes whether the instances placed on the Stage are automatically added to user­defined timeline classes. The default value is

true.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

Example

The following example specifies that instances placed on the Stage in the current document must be manually added
to user-defined timeline classes.

fl.getDocumentDOM().as3AutoDeclare=false;

document.as3Dialect

Availability

Flash CS3 Professional.

Usage

document.as3Dialect

Description

Property; a string that describes the ActionScript 3.0 “dialect” being used in the specified document. The default value

"AS3"

is

. If you wish to allow prototype classes, as permitted in earlier ECMAScript specifications, set this value to

"ES"

75

.

Example

The following example specifies that the dialect being used in the current document is ECMAScript:

fl.getDocumentDOM().as3Dialect="ES";

See also

document.asVersion

document.as3ExportFrame

Availability

Flash CS3 Professional.

Usage

document.as3ExportFrame

Description

Property; an integer that specifies in which frame to export ActionScript 3.0 classes. By default, classes are exported in
Frame 1.

Example

The following example changes the frame in which classes are exported from 1 (the default) to 5.

var myDocument = fl.getDocumentDOM();
fl.outputPanel.trace("'Export classes in frame:' value before modification is " +
myDocument.as3ExportFrame);
myDocument.as3ExportFrame = 5;
fl.outputPanel.trace("'Export classes in frame:' value after modification is " +
myDocument.as3ExportFrame);

EXTENDING FLASH CS4 PROFESSIONAL

Document object

document.as3StrictMode

Availability

Flash CS3 Professional.

Usage

document.as3StrictMode

Description

Property; a Boolean value that specifies whether the ActionScript 3.0 compiler should compile with the Strict Mode
option turned on (
compilation will not succeed if those errors exist. The default value is

Example

The following example turns off the Strict Mode compiler option.

var myDocument = fl.getDocumentDOM();
fl.outputPanel.trace("Strict Mode value before modification is " + myDocument.as3StrictMode);
myDocument.as3StrictMode = false;
fl.outputPanel.trace("Strict Mode value after modification is " + myDocument.as3StrictMode);

true) or off (false). Strict Mode causes warnings to be reported as errors, which means that

true.

76

See also

document.as3WarningsMode

document.as3WarningsMode

Availability

Flash CS3 Professional.

Usage

document.as3WarningsMode

Description

Property; a Boolean value that specifies whether the ActionScript 3.0 compiler should compile with the Warnings
Mode option turned on (
discovering incompatibilities when updating ActionScript 2.0 code to ActionScript 3.0. The default value is

Example

The following example turns off the Warnings Mode compiler option.

var myDocument = fl.getDocumentDOM();
fl.outputPanel.trace("Warnings Mode value before modification is " +
myDocument.as3WarningsMode);
myDocument.as3WarningsMode = false;
fl.outputPanel.trace("Warnings Mode value after modification is " +
myDocument.as3WarningsMode);

true) or off (false). Warnings Mode causes extra warnings to be reported that are useful for

true.

EXTENDING FLASH CS4 PROFESSIONAL

Document object

See also

document.as3StrictMode

document.asVersion

Availability

Flash CS3 Professional.

Usage

document.asVersion

Description

Property; an integer that specifies which version of ActionScript is being used in the specified document. Acceptable
values are 1, 2, and 3.

To determine the targeted player version for the specified document, use document.getPlayerVersion(); this
method returns a string, so it can be used by Flash® Lite™ players.

77

Example

The following example sets the version of ActionScript in the current document to ActionScript 2.0 if it is currently
set as ActionScript 1.0.

if(fl.getDocumentDOM().asVersion == 1){
fl.getDocumentDOM().asVersion = 2;
}

See also

document.as3Dialect, document.getPlayerVersion()

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

EXTENDING FLASH CS4 PROFESSIONAL

Document object

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; the color of the background, in one of the following formats:

• A string in the format "#RRGGBB" or "#RRGGBBAA"

• A hexadecimal number in the format 0xRRGGBB

• An integer that represents the decimal equivalent of a hexadecimal number

78

Example

The following example sets the background color to black:

fl.getDocumentDOM().backgroundColor = '#000000';

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();