Item object 201 Item object Availability Flash MX 2004. Description The Item object is an abstract base class. Anything in the library derives from Item. See also library object. Method summary for the Item object The following methods are available for the Item object. Property summary for the Item object The following properties are available for the Item object. Method Description item.addData() Method; adds specified data to a library item. item.getData() Method; retrieves the value of the specified data. item.hasData() Method; determines whether the library item has the named data. item.removeData() Method; removes persistent data from the library item. Property Description item.itemType Read-only; a string that specifies the type of element. item.linkageClassName Property; a string that specifies the ActionScript 2.0 class that will be associated with the symbol. item.linkageExportForAS Property; a Boolean value. If true, the item is exported for ActionScript. item.linkageExportForRS Property; a Boolean value. If true, the item is exported for runtime sharing. item.linkageExportInFirstFrame Property; a Boolean value. If true, the item is exported in the first frame. item.linkageIdentifier Property; a string that specifies the name Flash will use to identify the asset when linking to the destination SWF file. item.linkageImportForRS Property; a Boolean value. If true, the item is imported for runtime sharing. item.linkageURL Property; a string that specifies the URL where the SWF file containing the shared asset is located. item.name Property; a string that specifies the name of the library item, which includes the folder structure. CHAPTER 3 Objects 202 Chapter 3: Objects item.addData() Availability Flash MX 2004. Usage item.addData( name, type, data ) Parameters name A string that specifies the name of the data. type A string that specifies the type of data. Valid types are "integer", "integerArray", "double", "doubleArray", "string", and "byteArray". data The data to add to the specified library item. The type of data depends on the value of the type parameter. For example, if type is " integer", the value of data must be an integer, and so on. Returns Nothing. Description Method; adds specified data to a library item. Example The following example adds data named myData with an integer value of 12 to the first item in the library: fl.getDocumentDOM().library.items[0].addData("myData", "integer", 12); item.getData() Availability Flash MX 2004. Usage item.getData( name ) Parameters name A string that specifies the name of the data to retrieve. Returns The data specified by the name parameter. The type of data returned depends on the type of stored data. Description Method; retrieves the value of the specified data. Item object 203 Example The following example gets the value of the data named myData from the first item in the library and stores it in the variable libData. var libData = fl.getDocumentDOM().library.items[0].getData( "myData" ); item.hasData() Availability Flash MX 2004. Usage item.hasData( name ) Parameters name A string that specifies the name of the data to check for in the library item. Returns A Boolean value: true if the specified data exists; false otherwise. Description Method; determines whether the library item has the named data. Example The following example shows a message in the Output panel if the first item in the library contains data point named myData: if ( fl.getDocumentDOM().library.items[0].hasData( "myData" ) ){ fl.trace("Yep, it's there!"); } item.itemType Availability Flash MX 2004. Usage item.itemType Description Read-only property; a string that specifies the type of element. Potential values are "undefined", "component", "movie clip", "graphic", "button", "video", "folder", "font", "sound", "bitmap", "compiled clip", and "video". Example The following example shows the type of the specified library item in the Output panel: fl.trace(fl.getDocumentDOM().library.items[0].itemType); 204 Chapter 3: Objects item.linkageClassName Availability Flash MX 2004. Usage item.linkageClassName Description Property; a string that specifies the ActionScript 2.0 class that will be associated with the symbol. For this property to be defined, the item.linkageExportForAS and/or item.linkageExportForRS properties must be set to true, and the item.linkageImportForRS property must be set to false. Example The following example specifies that the ActionScript 2.0 class name associated with the first item in the Library is myClass: fl.getDocumentDOM().library.items[0].linkageClassName = "myClass"; item.linkageExportForAS Availability Flash MX 2004. Usage item.linkageExportForAS Description Property; a Boolean value. If true, the item is exported for ActionScript. You can also set the item.linkageExportForRS and item.linkageExportInFirstFrame properties to true. The item.linkageImportForRS property must be set to false if this property is set to true. Example The following example sets this property for the specified library item: fl.getDocumentDOM().library.items[0].linkageExportForAS = true; item.linkageExportForRS Availability Flash MX 2004. Usage item.linkageExportForRS Item object 205 Description Property; a Boolean value. If true, the item is exported for runtime sharing. This property can be set to true only if item.linkageImportForRS is set to false. Also, the properties item.linkageIdentifier and item.linkageURL must be defined. Example The following example sets this property for the specified library item: fl.getDocumentDOM().library.items[0].linkageExportForRS = true; item.linkageExportInFirstFrame Availability Flash MX 2004. Usage item.linkageExportInFirstFrame Description Property; a Boolean value. If true, the item is exported in the first frame; if false, the item is exported on the frame of the first instance. If the item does not appear on the Stage, it isn’t exported. This property can be set to true only when item.linkageExportForAS and/or item.linkageExportForRS are set to true. Example The following example specifies that the specified library item is exported in the first frame: fl.getDocumentDOM().library.items[0].linkageExportInFirstFrame = true; item.linkageIdentifier Availability Flash MX 2004. Usage item.linkageIdentifier Description Property; a string that specifies the name Flash will use to identify the asset when linking to the destination SWF file. It must be specified if item.linkageExportForAS and/or item.linkageExportForRS are set to true. Example The following example specifies that the string my_mc will be used to identify the library item when it is linked to the destination SWF file to which it is being exported: fl.getDocumentDOM().library.items[0].linkageIdentifier = "my_mc"; 206 Chapter 3: Objects item.linkageImportForRS Availability Flash MX 2004. Usage item.linkageImportForRS Description Property; a Boolean value: if true, the item is imported for runtime sharing. If this property is set to true, both item.linkageExportForAS and item.linkageExportForRS must be set to false. Also, you must specify an identif1ier (item.linkageIdentifier) and a URL ( item.linkageURL). Example The following example sets this property to true for the specified library item: fl.getDocumentDOM().library.items[0].linkageImportForRS = true; item.linkageURL Availability Flash MX 2004. Usage item.linkageURL Description Property; a string that specifies the URL where the SWF file containing the shared asset is located. Must be set when item.linkageExportForRS or item.linkageImportForRS is set to true. You can specify a web URL or a file name in platform-dependent format (that is, forward slashes (/) or backward slashes (\), depending on the platform). Example The following example specifies a linkage URL for the specified library item: fl.getDocumentDOM().library.items[0].linkageURL = "theShareSWF.swf"; item.name Availability Flash MX 2004. Usage item.name Item object 207 Description Method; a string that specifies the name of the library item, which includes the folder structure. For example, if Symbol_1 is inside a folder called Folder_1, the name property of Symbol_1 is "Folder_1/Symbol_1". Example The following example shows the name of the specified library item in the Output panel: fl.trace(fl.getDocumentDOM().library.items[0].name); item.removeData() Availability Flash MX 2004. Usage item.removeData( name ) Parameters name S pecifies the name of the data to remove from the library item. Returns Nothing. Description Property; removes persistent data from the library item. Example The following example removes the data named myData from the first item in the library: fl.getDocumentDOM().library.items[0].removeData( "myData" ); 208 Chapter 3: Objects Layer object Availability Flash MX 2004. Description The Layer object represents a layer in the Timeline. The timeline.layers property contains an array of Layer objects, which can be accessed by fl.getDocumentDOM().getTimeline().layers. Property summary for the Layer object The following properties are available for the Layer object: layer.color Availability Flash MX 2004. Usage layer.color Description Property; a string that specifies the color assigned to outline the layer; equivalent to the Outline color setting in the Layer Properties dialog box. Specified in hexadecimal #rrggbb format (where r is red, g is green, and b is blue), a hexidecimal color value (such as 0xFF0000), or an integer color value. Property Description layer.color Property; a string that specifies the color assigned to outline the layer. layer.frameCount Read-only; an integer that specifies the number of frames in the layer. layer.frames Read-only; an array of Frame objects. layer.height Property; an integer that specifies the percentage layer height; equivalent to the Layer height value in the Layer Properties dialog box. layer.layerType Property; a string that specifies the current use of the layer; equivalent to the Type setting in the Layer Properties dialog box. layer.locked Property; a Boolean value that specifies the locked status of the layer. layer.name Property; a string that specifies the name of the layer. layer.outline Property; a Boolean value that specifies the status of outlines for all objects on the layer. layer.parentLayer Property; a Layer object that represents the layer’s containing folder, guiding, or masking layer. layer.visible Property; a Boolean value that specifies whether the layer’s objects on the Stage are shown or hidden. CHAPTER 3 Objects Layer object 209 Example The following example stores the value of the first layer in the colorValue variable: var colorValue = fl.getDocumentDOM().getTimeline().layers[0].color; The following example shows three ways to set the color of the first layer to red: fl.getDocumentDOM().getTimeline().layers[0].color=16711680; fl.getDocumentDOM().getTimeline().layers[0].color="#ff0000"; fl.getDocumentDOM().getTimeline().layers[0].color=0xFF0000; layer.frameCount Availability Flash MX 2004. Usage layer.frameCount Description Read-only property; an integer that specifies the number of frames in the layer. Example The following example stores the number of frames in the first layer in the fcNum variable: var fcNum = fl.getDocumentDOM().getTimeline().layers[0].frameCount; layer.frames Availability Flash MX 2004. Usage layer.frames Description Read-only property; an array of Frame objects (see Frame object). Example The following example sets the variable frameArray to the array of Frame objects for the frames in the current document: var frameArray = fl.getDocumentDOM().getTimeline().layers[0].frames; To determine if a frame is a keyframe, check whether the frame.startFrame property matches the array index, as shown in the following example: var frameArray = fl.getDocumentDOM().getTimeline().layers[0].frames; var n = frameArray.length; for (i=0; i<n; i++) { if (i==frameArray[i].startFrame) { alert("Keyframe at: " + i); 210 Chapter 3: Objects } } layer.height Availability Flash MX 2004. Usage layer.height Description Property; an integer that specifies the percentage layer height; equivalent to the Layer height value in the Layer Properties dialog box. Acceptable values represent percentages of the default height: 100, 200, or 300. Example The following example stores the percentage value of the first layer’s height setting: var layerHeight = fl.getDocumentDOM().getTimeline().layers[0].height; The following example sets the height of the first layer to 300 percent: fl.getDocumentDOM().getTimeline().layers[0].height = 300; layer.layerType Availability Flash MX 2004. Usage layer.layerType Description Property; a string that specifies the current use of the layer; equivalent to the Type setting in the Layer Properties dialog box. Acceptable values are "normal", "guide", "guided", "mask", "masked", "folder". Example The following example sets the first layer in the Timeline to type “folder”: fl.getDocumentDOM().getTimeline().layers[0].layerType = "folder"; layer.locked Availability Flash MX 2004. Usage layer.locked [...]... example makes all objects in the first layer invisible: fl.getDocumentDOM().getTimeline().layers[0].visible = false; 212 Chapter 3: Objects CHAPTER 3 Objects library object Availability Flash MX 2004 Description The library object represents the Library panel It is a property of the Document object (see document.library) and can be accessed by fl.getDocumentDOM().library The library object contains an array... Example The following examples select all the items in the library: fl.getDocumentDOM().library.selectAll(); fl.getDocumentDOM().library.selectAll(true); The following examples deselect all the items in the library: fl.getDocumentDOM().library.selectAll(false); fl.getDocumentDOM().library.selectNone(); library.selectItem() Availability Flash MX 2004 Usage library.selectItem( namePath [, bReplaceCurrentSelection... folder: alert(fl.getDocumentDOM().library.itemExists('Folder_1/Symbol_1')); library.items Availability Flash MX 2004 Usage library.items Description Property; an array of item objects in the library Example The following example stores the array of all library items in the itemArray variable: var itemArray = fl.getDocumentDOM().library.items; library.moveToFolder() Availability Flash MX 2004 Usage... lockStatus = fl.getDocumentDOM().getTimeline().layers[0].locked; The following example sets the status of the first layer to unlocked: fl.getDocumentDOM().getTimeline().layers[0].locked = false; layer.name Availability Flash MX 2004 Usage layer.name Description Property; a string that specifies the name of the layer Example The following example sets the name of the first layer in the current document to... false); library.selectNone() Availability Flash MX 2004 Parameters None Returns Nothing Description Method; deselects all the library items 224 Chapter 3: Objects Example The following examples deselect all the items in the library: fl.getDocumentDOM().library.selectNone(); fl.getDocumentDOM().library.selectAll(false); library.setItemProperty() Availability Flash MX 2004 Usage library.setItemProperty(... angle: var mat = fl.getDocumentDOM().selection[0].matrix; mat.b = -1; mat.c = 0; fl.getDocumentDOM().selection[0].matrix = mat; To skew the object back to its original shape, you can set b and c to 0 See the matrix.a example matrix.c Availability Flash MX 2004 Usage matrix.c Description Property; a floating-point value that specifies the (1,0) element in the matrix This value causes Flash to skew the object... properties Example In the following example, setting tx and ty to 0 moves the registration point of the object to point 0,0 in the document: var mat = fl.getDocumentDOM().selection[0].matrix; mat.tx = 0; mat.ty = 0; fl.getDocumentDOM().selection[0].matrix = mat; matrix.ty Availability Flash MX 2004 Usage matrix.ty 232 Chapter 3: Objects Description Property; a floating-point value that specifies the y-axis... several are selected Example The following example deletes the currently selected item: fl.getDocumentDOM().library.deleteItem(); The following example deletes the item Symbol_1 from the library folder Folder_1: fl.getDocumentDOM().library.deleteItem("Folder_1/Symbol_1"); library.duplicateItem() Availability Flash MX 2004 Usage library.duplicateItem( [ namePath ] ) Parameters namePath A string that specifies... for runtime sharing: alert(fl.getDocumentDOM().library.getItemProperty("linkageIdentifier")); 218 Chapter 3: Objects library.getItemType() Availability Flash MX 2004 Usage library.getItemType( [ namePath ] ) Parameters A string that specifies the name of the item If the item is in a folder, specify its name and path using slash notation If namePath is not specified, Flash provides the type of the current... folder of the second layer (layers[1]) This action moves the second layer inside the first layer var parLayer = fl.getDocumentDOM().getTimeline().layers[0]; parLayer.layerType = "folder"; fl.getDocumentDOM().getTimeline().layers[1].parentLayer = parLayer; layer.visible Availability Flash MX 2004 Usage layer.visible Description Property; a Boolean value that specifies whether the layer’s objects on . current document to "foreground": fl.getDocumentDOM().getTimeline().layers[0].name = "foreground"; layer.outline Availability Flash. the Library panel. It is a property of the Document object (see document.library) and can be accessed by fl.getDocumentDOM().library. The library object