User manual MACROMEDIA FIREWORKS 8 - EXTENDING FIREWORKS

Extending Fireworks Trademarks 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flash Video Encoder, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and WebHelp are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. Third-Party Information This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third-party sites. Copyright © 2005 Macromedia, Inc. All rights reserved. This manual may not be copied, photocopied, reproduced, translated, or converted to any electronic or machine-readable form in whole or in part without written approval from Macromedia, Inc. Notwithstanding the foregoing, the owner or authorized user of a valid copy of the software with which this manual was provided may print out one copy of this manual from an electronic version of this manual for the sole purpose of such owner or authorized user learning to use such software, provided that no part of this manual may be printed out, reproduced, distributed, resold, or transmitted for any other purposes, including, without limitation, commercial purposes, such as selling copies of this documentation or providing paid-for support services. Acknowledgments Project Management: Debi Robson, Charles Nadeau Writing: David Sullivan Editing Management: Rosana Francescato Editors: Melba Lancaster, Mary Kraemer Production Management: Patrice O'Neill Production: John Francis, Adam Barnett, Mario Reynoso, Geeta Karmarkar Special thanks to Peter Moody, Mike Thrall, David Spells, Alan Musselman, Sheila McGinn, Andrew Wilson, and Maureen Keating. First Edition: September 2005 Macromedia, Inc. 600 Townsend St. San Francisco, CA 94103 Contents Chapter 1: Extending Fireworks Overview . . . . . . . . . . . . . . . . . . . . 5 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Installing an extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 What's new in Extending Fireworks 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Conventions used in this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Additional resources for extension writers . . . . . . . . . . . . . . . . . . . . . . . . . 8 Chapter 2: The Fireworks Object Model . . . . . . . . . . . . . . . . . . . . . 9 Using the Fireworks Object Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Global methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Core objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 The Fireworks object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Objects within Fireworks documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 HTML export objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 Working with selected objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Chapter 3: Cross-Product Extensions . . . . . . . . . . . . . . . . . . . . . 99 Cross-product architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Flash panels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Chapter 4: Auto Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 How Auto Shapes work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123 Creating an Auto Shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124 Chapter 5: Fireworks JavaScript API. . . . . . . . . . . . . . . . . . . . . . 131 Using Fireworks API functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Document functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132 Fireworks functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305 Property inspector functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347 History panel functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350 Static Document Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 Using the common API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359 3 4 Contents CHAPTER 1 Extending Fireworks Overview To extend Macromedia Fireworks 8, you must write JavaScript code. You can use JavaScript to write your own objects and commands that affect Fireworks documents and the elements within them. To accomplish these tasks, you must be proficient in JavaScript and in Fireworks. This guide introduces the Fireworks Object Model, explains how to write cross-product extensions (extensions written in, or for, other Macromedia applications), and discusses the JavaScript Auto Shape construction. The final chapter is a reference to the Fireworks JavaScript application programming interface (API)--the custom JavaScript functions that are built into Fireworks. 1 Prerequisites Because Fireworks extensions must be written in JavaScript, this guide assumes that readers are familiar with JavaScript syntax and with basic programming concepts such as functions, arguments, and data types. It also assumes that readers understand the concept of working with objects and properties. This guide does not attempt to teach programming in general or JavaScript in particular. Anyone who wants to extend Fireworks should have a good JavaScript reference to help with syntax questions (for example, is it substring() or subString()?). Useful JavaScript references include JavaScript Bible by Danny Goodman (IDG), JavaScript: The Definitive Guide by David Flanagan (O'Reilly), and Pure JavaScript by R. Allen Wyke, Jason D. Gilliam, and Charlton Ting (Sams). 5 Installing an extension As you start learning the process of writing extensions, you might want to explore the extensions and resources already available through the Macromedia Exchange website (www.macromedia.com/exchange). By installing an existing extension, you will become familiar with some of the tools that you need to work with your own extensions. To install an extension: 1. 2. 3. 4. 5. 6. Download and install the Extension Manager, which is available on the Macromedia Downloads website (www.macromedia.com/software/downloads). Log on to the Macromedia Exchange website (www.macromedia.com/exchange). Click the Fireworks Exchange link. From the available extensions, choose one that you want to use. Click the Download link to download the extension package. Save the extension package in a directory on your machine. In Fireworks, choose Commands > Manage Extensions to start the Extension Manager (or you can start Extension Manager, located in the Macromedia program group, independently from Fireworks). In the Extension Manager, choose File > Install Extension, and choose the extension package you just saved. The Extension Manager automatically installs the extension into Fireworks. 7. You cannot begin using some extensions until you restart Fireworks. If you are running Fireworks when you install the extension, you might be prompted to quit and restart the application. To view basic information on the extension after its installation, go to the Extension Manager (Commands > Manage Extensions) in Fireworks. What's new in Extending Fireworks 8 Fireworks 8 includes the following new features and interfaces that you can use to develop extensions for the product: Marquee-to-path and path-to-marquee conversions In Fireworks 8 you can convert marquees drawn with any of the marquee tools to a vector path. You can also convert any vector path to a marquee and set its edge to hard, anti-aliased, or feathered. 6 Extending Fireworks Overview Vector path compatibility with Macromedia FreeHand Although Fireworks 8 imports winding fills from FreeHand MX, it does not provide a user interface that lets you create a winding fill. However, Fireworks 8 has APIs that let third-party developers create an interface where a user can specify if a path uses an even/odd or winding fill. Instead of having to create a new layer specifically for an object you want to lock, Fireworks 8 lets you lock specific objects on a layer without locking the other objects on the same layer. Three new APIs let you specify which object to lock. Lock individual objects within a layer New panels and commands Fireworks 8 introduces three new panels and a new command. Several new APIs let you set selections within these panels and access the new command. Access dialog boxes Fireworks 8 introduces a new Dialogs class as a property of the Fireworks object. The APIs in this class let you run standard application dialog boxes that are usually accessible only through the menu. Get system information The new System class in Fireworks 8 provides APIs that let you query for information about the operating system. Conventions used in this guide The following typographical conventions are used in this guide: Code font indicates code fragments and API literals, including class names, method names, function names, type names, scripts, SQL statements, and HTML and XML tag and attribute names. font indicates replaceable items in code. Italic code The continuation symbol (¬) indicates that a long line of code has been broken across two or more lines to fit on the page. When copying the lines of code, eliminate the continuation symbol and type the code as one line. Curly braces ({ }) around a function argument indicate that the argument is optional. You refers to the developer who is responsible for writing extensions. The user refers to the person using Fireworks. The visitor refers to the person who views the graphic that the user created. The following naming conventions are used in this guide: Conventions used in this guide 7 Additional resources for extension writers To communicate with other developers who are writing extensions, you can visit the Fireworks online forums at www.macromedia.com/go/13012. 8 Extending Fireworks Overview CHAPTER 2 The Fireworks Object Model If you want to extend the functionality of Macromedia Fireworks 8 by writing or modifying a JavaScript extensibility file, you must become familiar with the objects that Fireworks makes available through JavaScript. The hierarchy of these objects comprises the Fireworks Object Model, which contains the following major components: 2 Six global methods that are available from any part of the application and need not be declared as methods of a particular object. For more information, see "Global methods" on page 12. Six core objects: Dialogs, Document, Errors, Files, Find, and System. For more information, see "Core objects" on page 13. (The App object that was used in Fireworks 3 is supported for backward compatibility, but its use is deprecated in favor of the Fireworks object.) The Fireworks object (for more information, see "The Fireworks object" on page 26). Numerous objects associated with Fireworks documents, such as ExportOptions, Guides, Path, Image, and Text. For more information, see "Objects within Fireworks documents" on page 32. A set of objects that you can use to specify the format of HTML code when exporting from Fireworks. For more information, see "HTML export objects" on page 80. Using the Fireworks Object Model When scripting extensions for Fireworks, you write JavaScript commands that send calls to the Fireworks Object Model to determine or change the current settings for a Fireworks document. For example, the following command calls the Fireworks object (fw) to obtain the path to the Export Settings directory (appExportSettingsDir), which is expressed as a file:/ /URL. In other words, fw references the Fireworks global object, of which appExportSettingsDir is a property (for more information, see "The Fireworks object" on page 26), so a JavaScript command can assign the resulting value to a variable, as follows: var expSetDir = fw.appExportSettingsDir; 9 Accessing a Fireworks document All the functions listed in "Document functions" on page 132 are methods of the Document object, which represents a Fireworks document. To perform a function on a Document object, you must first get the Document Object Model (DOM) of the document. You then call the functions as methods of that DOM. You can use methods that operate on a document's DOM only on open documents. N OT E To use a DOM function with a document other than the active document, use the following syntax; note that documentIndex is a zero-based index that specifies which document the command will affect. fw.documents[documentIndex].functionName(); To use a DOM function with the active document, use fw.getDocumentDOM().functionName() (for more information, see fw.getDocumentDOM()). Passing values For all properties that are not read-only, you can pass values to change elements of a document. For example, the following command sets the fifth brush in the third open document to a square shape: fw.documents[2].brushes[4].shape = "square"; The preceding example includes the following properties: documents is a property of the Fireworks object and contains an array of Document objects. is a property of the Document object and contains an array of Brush objects. is a property of the Brush object. brushes shape Throughout this manual, optional arguments are enclosed in {braces}. Fireworks Object Model calls and API calls In some cases, you can use Fireworks Object Model calls or API calls to perform the same operations. In other cases, a certain function might be available in either the Fireworks Object Model or the API, but not in both. 10 N OT E The Fireworks Object Model For example, if the first open document is the current document, the first code fragment has the same effect as the second and third code fragments. The fw.getDocumentDOM() function references the current document (for more information, see "Accessing a Fireworks document" on page 10). fw.getDocumentDOM().setDocumentResolution({pixelsPerUnit:72, units:"inch"}) ; fw.documents[0].resolution =72; fw.documents[0].resolutionUnits ="inch"; Formatting nonstandard data types In addition to the standard data types that can be passed to functions as arguments, or used as properties, such as integer, string, and so on, Fireworks accepts other data types. Some functions accept values that are Fireworks objects. For more information, see "The Fireworks Object Model" on page 9. Some functions accept a string in a specific format. Others accept value types that are not Fireworks objects but are JavaScript object types that are specific to Fireworks. These types of arguments are described next, in alphabetical order. Color string data type Functions that accept colors as arguments use the HTML syntax "#rrggbb". You can specify a color with an alpha (transparency) component by passing a longer string of the form "#rrggbbaa". Mask data type The format for a mask is {maskBounds: rectangle, maskKind: string, maskEdgeMode: string, featherAmount: int, maskData: hex-string}. maskBounds specifies the bounding rectangle of the mask area. Acceptable values for maskKind are "rectangle", "oval", "zlib compressed", "rle compressed", or "uncompressed". If the value of maskKind is "rectangle" or "oval", the maskData string is ignored, and a mask of the right shape is constructed that fills maskBounds and that has the edge specified by maskEdgeMode and featherAmount. If the value of maskKind is "zlib compressed", "rle compressed", or "uncompressed", the maskData string is presumed to contain 8-bit mask data in hexadecimal format that precisely matches the maskBounds to define the mask. Using the Fireworks Object Model 11 Matrix data type The format for a matrix is {matrix: [float, float, float, float, float, float, float, float, float]}. This guide assumes that you know how to use these nine values to construct a three-by-three transformation matrix; discussion of the construction of transformation matrices is beyond the scope of this manual. Point data type The format for a point is {x: float, y: float}. For instance, dom.addNewLine(startPoint, endPoint) could look like the following example: fw.getDocumentDOM().addNewLine({x:64.5, y:279.5}, {x:393.5, y:421.5}); Rectangle data type The format for a rectangle is {left: float, top: float, right: float, bottom: float}. For instance, dom.addNewOval(boundingRectangle) could look like the following example: fw.getDocumentDOM().addNewOval({left:72, top:79, right:236, bottom:228}); Resolution data type The format for resolution is {pixelsPerUnit: float, units: string}. Acceptable values for units are "inch" or "cm". For instance, dom.setDocumentResolution(resolution) could look like the following example: fw.getDocumentDOM().setDocumentResolution({pixelsPerUnit:72, units:"inch"}) ; Global methods The following table lists the global Fireworks methods, along with their argument data types and, where appropriate, acceptable values and notes. Method alert(message) Data type string string Notes Displays a string in a modal alert box, along with an OK button. Returns nothing. Displays a string in a modal alert box, along with OK and Cancel buttons. Returns true if OK is clicked, false if Cancel is clicked. confirm(message) 12 The Fireworks Object Model Method prompt(caption, text) Data type string, string Notes Prompts the user (with the string that is specified by text) to enter a string in a modal dialog box; the dialog box is titled with the string that is specified by caption. Returns the string entered if OK is clicked, null if Cancel is clicked. Same as WRITE_HTML; WRITE_HTML was created to let you differentiate HTML output calls from other JavaScript calls in your code. Available only when exporting. Writes the CSS as an external file. Available only when exporting. Converts each argument to a string and writes it to the HTML output file. To enter an end-ofline character, use "\n"; this is converted to the correct line ending for your platform. For more information, see "HTML export objects" on page 80. write(arg1, arg2, ..., argN) string WRITE_CSS string string WRITE_HTML(arg1, arg2, ..., argN) Core objects This section describes the six core objects that are always available: Dialogs, Document, Errors, Files, Find, and System. For information on how to format nonstandard data types, such as rectangle or point, see "Formatting nonstandard data types" on page 11. NO T E Dialogs object The following table lists the methods of the Dialogs object, along with their data types and, where appropriate, acceptable values and notes. Method runEditGrids() runEditGuides() runNumericTransform() Data type none none none Notes Opens the Edit Grids dialog box. Opens the Edit Guides dialog box. Opens the Numeric Transform dialog box. Core objects 13 Document object The following table lists the properties of the Document object, along with their data types, acceptable values and notes. Read-only properties are marked with a bullet (·). You can also use many API calls to work with documents. For more information, see "Document functions" on page 132. Property backgroundColor Data type string Notes A color string that specifies the document canvas color (for more information, see "Color string data type" on page 11). Sets a general URL for a document that uses a Hotspot. Everything that is not covered by the Hotspot has the background URL. Array of Brush objects that are available for use in the document (for more information, see "Brush object" on page 33). The index of the current frame. The index of the current layer. Default Alt text for the output images. It works for single and sliced images. Sliced images get the default, unless specific text is specified for a slice. Corresponds to the text that is specified in File > HTML Properties > ImageMap > AltImageDescription. The title of the document file, without any file extension. If the document has not been saved, this string is empty. Identical to exportOptions. Included for backward compatibility with Fireworks 2. ExportOptions object (for more information, see "ExportOptions object" on page 58). ExportSettings object (for more information, see "ExportSettings object" on page 61). backgroundURL string brushes · array currentFrameNum zero-based index zero-based index string currentLayerNum defaultAltText docTitleWithoutExtension string exportFormatOptions object object exportOptions exportSettings object 14 The Fireworks Object Model Property filePathForRevert Data type string Notes The path to the file from which this document was opened, which is expressed as file://URL, or null if created from scratch. The location to which this document was saved, which is expressed as file://URL, or null if never saved. Array of Fill objects that are available for use in the document (for more information, see "Fill object" on page 64). The number of frames in the current document. ­1 -- don't repeat 0 -- repeat forever > 0 -- repeat this number of times Array of Frame objects in the document (for more information, see "Frame object" on page 65). If set to true, the document should be previewed in opposite-platform gamma. If set to false, the document colors are unadjusted. Array of Gradient objects that are available for use in the document (for more information, see "Gradient object" on page 66). A color string that specifies the color of the grid display (for more information, see "Color string data type" on page 11). Used to set the origin of the grid. Corresponds to the point set when dragging the ruler origin from the upper-left of the document when rulers are visible. gridSize.x is the horizontal grid size; gridSize.y is the vertical grid size. filePathForSave string fills · array frameCount integer integer frameLoopingCount frames · array gammaPreview Boolean gradients · array gridColor string gridOrigin point gridSize point object guides · Guides object (for more information, see "Guides object" on page 67). Core objects 15 Property height Data type integer Notes Total height of the document, in pixels. To find the bottom edge of the document, use document. top + document.height. isDirty Boolean Boolean Boolean Set to true if the document was modified since the last ti me it was saved. Set to true if the document is currently in paint-mode editing, false otherwise. Set to true if the document is a Symbol or Button document, false if it is an ordinary document. You might see this when looking through the list of open documents and one is a symbol-editing window. Set to true if the document is open in Fireworks; false otherwise. (Occasionally the JavaScript object that is associated with a document lingers after the document closes; this property lets you check for that eventuality.) The path to the last directory to which the file was exported, which is expressed as file://URL, or null if the file was never exported. For instance, if the document was last exported to "file:///files/ current/logo.gif", it returns "file:/// files/current". isPaintMode · isSymbolDocument · isValid Boolean lastExportDirectory string lastExportFile string The name that was used the last time the file was exported, or null if the file was never exported. For instance, if the document was last exported to "file:/// files/current/logo.gif", it returns "logo.gif". layers · array An array of Layer objects in the document (for more information, see "Layer object" on page 67). Coordinate of the left edge of the document, in pixels. To find the right edge of the document, use document.left + document.width. left integer 16 The Fireworks Object Model Property mapType Data type string Notes Acceptable values are "client", "server", and "both". Corresponds to the image-map type selected in File > HTML Properties > ImageMap. A color string that corresponds to the matte color specified in the Optimize panel (for more information, see "Color string data type" on page 11). This string is used by the useMatteColor property. Number of frames after the current frame to show through onion skinning. Corresponds to the onion-skin controls in the left edge of the Frames panel. A value of 0 indicates no onion skinning; a very large value (such as 99,999) indicates onion skinning of all frames after the current frame. Similar to the onionSkinAfter property, but refers to the number of frames to show through onion skinning before the current frame. List of internal pattern names. PathAttrs object (for more information, see "PathAttrs object" on page 68). This object specifies default attributes that will be applied to all newly created objects. A structure that can be used to store various chunks of text in a well-known format. For more information, see "The pngText object" on page 18. Document resolution, in pixels per unit (for more information, see resolutionUnits). The range is 1 to 5000. The units to be used with the resolution property. Acceptable values are "inch" and "cm". Array of the saved bitmap selections in the active document. matteColor string onionSkinAfter integer onionSkinBefore integer patterns · pathAttributes object object pngText object resolution float resolutionUnits string savedSelections object Core objects 17 Property textures Data type array Notes Array of Texture objects that are available for use in the document (for more information, see "Texture object" on page 56). Coordinate of the top edge of the document, in pixels. To find the bottom edge of the document, use document.top + document.height. top integer useMatteColor Boolean If set to true, the matteColor property is used when exporting documents with transparent backgrounds. If set to false, the matteColor property is ignored in this situation, and the exported file is matted against the document's canvas color. The width of the document, in pixels. To find the right edge of the document, use document.left + document.width. width integer The pngText object Fireworks maintains the following fields for use with the pngText object: Field name CreationTime Software Value The date and time the document was created. The software used to create the document. The current version of Fireworks always sets this value to "Macromedia Fireworks 8." You can edit these or add your own fields, and they will be preserved across file saves. The pngText object corresponds directly to the 'tEXt' chunk of the document's PNG structure. Errors object All Errors object properties are read-only strings that are used to simplify the localizing of scripts. They return localized error messages appropriate to the specific error. For example, the English version of Fireworks returns "Memory is full." for the EOutOfMem property. 18 The Fireworks Object Model The following list contains the properties of the Errors object alphabetically: EAppAlreadyRunning, EAppNotSerialized, EArrayIndexOutOfBounds, EBadFileContents, EBadJsVersion, EBadNesting, EBadParam, EBadParamType, EBadSelection, EBufferTooSmall, ECharConversionFailed, EDatabaseError, EDeletingLastMasterChild, EDiskFull, EDuplicateFileName, EFileIsReadOnly, EFileNotFound, EGenericErrorOccurred, EGroupDepth, EIllegalThreadAccess, EInternalError, ELowOnMem, ENoActiveDocument, ENoActiveSelection, ENoFilesSelected, ENoNestedMastersOrAliases, ENoNestedPasting, ENoSliceableElems, ENoSuchElement, ENotImplemented, ENotMyType, EOutOfMem, EResourceNotFound, ESharingViolation, EUnknownReaderFormat, EUserCanceled, EUserInterrupted, EWrongType Files object The following table lists the methods of the Files object, along with their data types and, where appropriate, acceptable values and notes. Method copy(docname1, docname2) Data type string, string Notes Copies the file specified in the first argument to the file specified in the second argument. Each argument must be the name of a file, which is expressed as file://URL. Only files (not directories) can be copied. The files do not need to reside on the same drive, and the method does not overwrite a file if it already exists. Returns a value of true if the copy is successful; false otherwise. Creates the specified directory. Returns true if successful; false otherwise. createDirectory(dirname) string string, string, string createFile(fileURL, fileType, fileCreator) Creates the specified file. The file must not already exist. The first argument is the name of the file, which is expressed as file://URL. The last two arguments let you specify the file type and file creator strings. The fileType and fileCreator strings should each be strings of exactly four characters in length, for example: Files.createFile(newFile,".txt","FWM X"); Core objects 19 Method deleteFile(docOrDir) Data type string Notes Deletes the specified file or directory. Returns true if successful; false if the file or directory does not exist or cannot be deleted. Compare with deleteFileIfExisting(). deleteFileIfExisting (docOrDir) string Deletes the specified file or directory. Returns true if successful; false if the file or directory cannot be deleted. Unlike deleteFile(), this method returns true if the file or directory does not exist. Returns an array of file URLs. If docOrDir is a directory, the array enumFiles(docOrDir) string contains an entry for every file or directory that is contained in the specified directory. If docOrDir is a file, the array contains a single entry (the file passed in). exists(docOrDir) string Returns true if docOrDir refers to a directory or file that exists; false otherwise. Returns only the directory name from docname, which is expressed as file:// URL. For example, Files.getDirectory("file://work/ logo.png") returns "file:///work". getDirectory(docname) string getExtension(docname) string Returns the filename extension, if any, of docname. For example, Files.getExtension("birthday.png") returns ".png". If the filename has no extension, an empty string is returned. A filename that is expressed as file://URL is acceptable. getFilename(docname) string Returns just the filename from docname, which is expressed as file://URL. For example, Files.getFilename("file:/// work/logo.png") returns "logo.png". Returns the URL of the language directory associated with the currently running language. getLanguageDirectory() string 20 The Fireworks Object Model