User manual MACROMEDIA FLASH MX 2004-USING COMPONENTS

[. . . ] Using Components Trademarks Add Life to the Web, Afterburner, Aftershock, Andromedia, Allaire, Animation PowerPack, Aria, Attain, Authorware, Authorware Star, Backstage, Bright Tiger, Clustercats, ColdFusion, Contribute, Design In Motion, Director, Dream Templates, Dreamweaver, Drumbeat 2000, EDJE, EJIPT, Extreme 3D, Fireworks, Flash, Flash Lite, Flex, Fontographer, FreeHand, Generator, HomeSite, JFusion, JRun, Kawa, Know Your Site, Knowledge Objects, Knowledge Stream, Knowledge Track, LikeMinds, Lingo, Live Effects, MacRecorder Logo and Design, Macromedia, Macromedia Action!, Macromedia Breeze, Macromedia Flash, Macromedia M Logo and Design, Macromedia Spectra, Macromedia xRes Logo and Design, MacroModel, Made with Macromedia, Made with Macromedia Logo and Design, MAGIC Logo and Design, Mediamaker, Movie Critic, Open Sesame!, Roundtrip, Roundtrip HTML, Shockwave, Sitespring, SoundEdit, Titlemaker, UltraDev, Web Design 101, what the web can be, and Xtra are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally. [. . . ] For example, the following code, attached to the List instance myList, sends "_level0. myList" to the Output panel: on(itemRollOut){ trace(this); } The second usage example uses a dispatcher/listener event model. A component instance (listInstance) dispatches an event (in this case, itemRollOut) and the event is handled by a function, also called a handler, on a listener object (listenerObject) that you create. You define a method with the same name as the event on the listener object; the method is called when the event is triggered. When the event is triggered, it automatically passes an event object (eventObject) to the listener object method. Each event object has properties that contain information about the event. Finally, you call the EventDispatcher. addEventListener() method on the component instance that broadcasts the event to register the listener with the instance. For more information, see "EventDispatcher class (API)" on page 415. 468 Chapter 6: Components Dictionary Example The following example sends a message to the Output panel that indicates which item index number has been rolled over: form. itemRollOut = function (eventObj) { trace("Item #" + eventObj. index + " has been rolled out. "); } myList. addEventListener("itemRollOut", form); See also List. itemRollOver List. itemRollOver Availability Flash Player 6 (6. 0 79. 0). Edition Flash MX 2004. Usage Usage 1: on(itemRollOver){ // your code here } Usage 2: listenerObject = new Object(); listenerObject. itemRollOver = function(eventObject){ // your code here } listInstance. addEventListener("itemRollOver", listenerObject) Event object In addition to the standard properties of the event object, the itemRollOver event has an index property that specifies the number of the item that was rolled over. Description Event; broadcast to all registered listeners when the list items are rolled over. The first usage example uses an on() handler and must be attached directly to a List instance. The keyword this, used inside an on() handler attached to a component, refers to the component instance. For example, the following code, attached to the List instance myList, sends "_level0. myList" to the Output panel: on(itemRollOver){ trace(this); } List component 469 The second usage example uses a dispatcher/listener event model. A component instance (listInstance) dispatches an event (in this case, itemRollOver) and the event is handled by a function, also called a handler, on a listener object (listenerObject) that you create. You define a method with the same name as the event on the listener object; the method is called when the event is triggered. When the event is triggered, it automatically passes an event object (eventObject) to the listener object method. Each event object has properties that contain information about the event. Finally, you call the EventDispatcher. addEventListener() method on the component instance that broadcasts the event to register the listener with the instance. For more information, see "EventDispatcher class (API)" on page 415. Example The following example sends a message to the Output panel that indicates which item index number has been rolled over: form. itemRollOver = function (eventObj) { trace("Item #" + eventObj. index + " has been rolled over. "); } myList. addEventListener("itemRollOver", form); See also List. itemRollOut List. labelField Availability Flash Player 6 (6. 0 79. 0). Edition Flash MX 2004. Usage listInstance. labelField Description Property; specifies a field in each item to be used as display text. The default value is "label". Example The following example sets the labelField property to be the "name" field of each item. "Nina" would display as the label for the item added in the second line of code: list. labelField = "name"; list. addItem({name: "Nina", age: 25}); See also List. labelFunction 470 Chapter 6: Components Dictionary List. labelFunction Availability Flash Player 6 (6. 0 79. 0). Edition Flash MX 2004. Usage listInstance. labelFunction Description Property; specifies a function that determines which field (or field combination) of each item to display. This function receives one parameter, item, which is the item being rendered, and must return a string representing the text to display. Example The following example makes the label display some formatted details of the items: list. labelFunction = function(item){ return "The price of product " + item. productID + ", " + item. productName + " is $" + item. price; } See also List. labelField List. length Availability Flash Player 6 (6. 0 79. 0). Edition Flash MX 2004. Usage listInstance. length Description Property (read-only); the number of items in the list. Example The following example places the value of length in a variable: var len = myList. length; List component 471 List. maxHPosition Availability Flash Player 6 (6. 0 79. 0). Edition Flash MX 2004. Usage listInstance. maxHPosition Description Property; specifies the number of pixels the list can scroll when List. hScrollPolicy is set to "on". The list doesn't precisely measure the width of text that it contains. You must set maxHPosition to indicate the amount of scrolling that the list requires. The list does not scroll horizontally if this property is not set. Example The following example creates a list with 400 pixels of horizontal scrolling: myList. hScrollPolicy = "on"; myList. maxHPosition = 400; See also List. hScrollPolicy List. multipleSelection Availability Flash Player 6 (6. 0 79. 0). Edition Flash MX 2004. Usage listInstance. multipleSelection Description Property; indicates whether multiple selections are allowed (true) or only single selections are allowed (false). [. . . ] This example builds on the MyShelf component and CompactDisc collection. 2. Open the Library panel, drag the component onto the Stage, and give it an instance name. This example uses the instance name myShelf. 3. Select the component, open the Component inspector, and display the Parameters tab. Click the line that contains the collection property, and click the magnifying glass to the right of the line. [. . . ]