100% found this document useful (81 votes)

31K views

Creating and Extending Flex Components

source: http://labs.adobe.com/wiki/index.php/AIR:Documentation

Uploaded by

cortfr

Available Formats

Download as PDF or read online on Scribd

100% found this document useful (81 votes)

31K views

Creating and Extending Flex Components

source: http://labs.adobe.com/wiki/index.php/AIR:Documentation

Uploaded by

cortfr

Available Formats

Download as PDF or read online on Scribd

You are on page 1/ 256

Flex 3 Beta 1

® ™
Adobe Flex 3
Creating and Extending Flex Components
Flex 3 Beta 1
© 2007 Adobe Systems Incorporated. All rights reserved.

Creating and Extending Flex™ 2 Components

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, Flex, Flex Builder and Flash Player are either registered trademarks or trademarks of Adobe Systems
Incorporated in the United States and/or other countries. Windows is either a registered trademark or trademark of Microsoft
Corporation in the United States and/or other countries. Macintosh is a trademark of Apple Computer, 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/). Macromedia Flash 8
video 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/).
Portions licensed from Nellymoser (www.nellymoser.com). Portions utilize Microsoft Windows Media Technologies. Copyright
(c) 1999-2002 Microsoft Corporation. All Rights Reserved. Includes DVD creation technology used under license from Sonic
Solutions. Copyright 1996-2005 Sonic Solutions. All Rights Reserved. This Product includes code licensed from RSA Data
Security. Portions copyright Right Hemisphere, Inc. This product includes software developed by the OpenSymphony Group
(http://www.opensymphony.com/).

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.

Part Number: 90069416 (12/06)

Flex 3 Beta 1

Contents

Chapter 1: About Flex Documentation . . . . . . . . . . . . . . . . . . . . . . . 7

PART 1: CREATING CUSTOM FLEX COMPONENTS

Chapter 2: Creating Flex Components . . . . . . . . . . . . . . . . . . . . . . 13

About creating components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Creating custom components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Where to go from here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Chapter 3: Using ActionScript to Create Components . . . . . . . 25

Using ActionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Chapter 4: Creating Custom Events . . . . . . . . . . . . . . . . . . . . . . . 35

About events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Dispatching custom events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Chapter 5: Using Metadata Tags in Custom Components. . . . . 45

About metadata tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Metadata tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Chapter 6: Compiling Components. . . . . . . . . . . . . . . . . . . . . . . . .63

About compiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Compiling components with Flex SDK . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Compiling components with LiveCycle Data Services ES . . . . . . . . . .72

PART 2: CREATING MXML COMPONENTS

Chapter 7: Creating Simple MXML Components . . . . . . . . . . . . . 77

About MXML components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Scoping in custom components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Applying styles to your custom component . . . . . . . . . . . . . . . . . . . . . . 84

3
Flex 3 Beta 1

Chapter 8: Creating Advanced MXML Components . . . . . . . . . . 91

About reusable MXML components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Adding custom properties and methods to a component . . . . . . . . . . 92
Working with events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
About interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

PART 3: CREATING ACTIONSCRIPT COMPONENTS

Chapter 9: Creating Simple Visual Components in ActionScript . .

121
About ActionScript components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Adding properties and methods to a component . . . . . . . . . . . . . . . . . 125
Defining events in ActionScript components . . . . . . . . . . . . . . . . . . . . .141
Applying styles to custom components . . . . . . . . . . . . . . . . . . . . . . . . . 145

Chapter 10: Creating Advanced Visual Components in

ActionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
About creating advanced components. . . . . . . . . . . . . . . . . . . . . . . . . . 149
Implementing the component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Making components accessible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Adding version numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Best practices when designing a component . . . . . . . . . . . . . . . . . . . . 174
Example: Creating a composite component . . . . . . . . . . . . . . . . . . . . . 174
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Chapter 11: Creating Custom Style Properties . . . . . . . . . . . . . . 185

About styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Example: Creating style properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Chapter 12: Creating Template Components . . . . . . . . . . . . . . . 197

About template components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Implementing a template component . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

PART 4: CREATING NONVISUAL FLEX COMPONENTS

Chapter 13: Creating Custom Formatters . . . . . . . . . . . . . . . . . 209

Creating a custom formatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Using the SwitchSymbolFormatter class. . . . . . . . . . . . . . . . . . . . . . . . 213
Extending a Formatter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

4
Flex 3 Beta 1

Chapter 14: Creating Custom Validators . . . . . . . . . . . . . . . . . . . 219

Validating data by using custom validators. . . . . . . . . . . . . . . . . . . . . . .219
Example: Creating a simple validator . . . . . . . . . . . . . . . . . . . . . . . . . . . .221
Example: Validating multiple fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Chapter 15: Creating Effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

About creating a custom effect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
About tween effects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Writing an effect for a transition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Defining a custom effect trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

5
Flex 3 Beta 1

6
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 1

About Flex Documentation 1

Creating and Extending Flex Components describes how to create components in MXML and
ActionScript. This manual is intended for component developers who are developing new
components for use in their Adobe® Flex™ application.

Contents
Using this manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Accessing the Flex documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Using this manual

This manual can help anyone who is developing Flex applications. However, this manual is
most useful if you have basic experience using Flex, or have read Getting Started with Flex.
Getting Started with Flex provides an introduction to Flex and helps you develop the basic
knowledge that makes using this manual easier.
Creating and Extending Flex Components is divided into the following parts:

Part Description
Part 1, “Creating Custom Flex Components” Describes how to create
custom Flex components.

Part 2, “Creating MXML Components” Describes how to create

custom Flex components in MXML.
Part 3, “Creating ActionScript Components” Describes how to create
custom Flex components in ActionScript.

Part 4, “Creating Nonvisual Flex Components” Describes how to create formatter, validator,
and effect components for Flex.

7
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Accessing the Flex documentation
The Flex documentation is designed to provide support for the complete spectrum of
participants.

Documentation set
The Flex documentation set includes the following titles:

Book Description
Getting Started with Flex Contains an overview of Flex features and
application development procedures.
Flex Developer’s Guide Describes how to develop your dynamic web
applications.

Creating and Extending Flex Components Describes how to create and extend
Flex components.

Building and Deploying Flex Applications Describes how to build and deploy
Flex applications.

Migrating Applications to Flex 2 Provides an overview of the migration process,

and detailed descriptions of changes in Flex and
ActionScript.

Using Flex Builder Contains comprehensive information about all

Adobe® Flex™ Builder™ 2 features, for every level
of Flex Builder users.

Adobe Flex Language Reference Provides descriptions, syntax, usage, and code
examples for the Flex API.

Viewing online documentation

All Flex documentation is available online in HTML and Adobe® Portable Document Format
(PDF) files from the Adobe website. It is also available from the Adobe® Flex™ Builder™ Help
menu.

8 About Flex Documentation

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Typographical conventions
The following typographical conventions are used in this book:
■ Italic font indicates a value that should be replaced (for example, in a folder path).
■ Code font indicates code.
■ Code font italic indicates a parameter.
■ Boldface font indicates a verbatim entry.

Typographical conventions 9
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

10 About Flex Documentation

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

PART 1

Creating Custom Flex

Components 1
This part contains an introduction to creating custom Adobe Flex
components.
The following topics are included:
Chapter 2: Creating Flex Components . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 3: Using ActionScript to Create Components . . . . . . . . .25
Chapter 4: Creating Custom Events. . . . . . . . . . . . . . . . . . . . . . . . . .35
Chapter 5: Using Metadata Tags in Custom Components . . . . . .45
Chapter 6: Compiling Components . . . . . . . . . . . . . . . . . . . . . . . . . .63

11
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 2

Creating Flex Components 2

Adobe Flex supports a component-based development model. You use the predefined
components included with Flex to build your applications, and create components for your
specific application requirements. You can create components using MXML or ActionScript.
Defining your own custom components has several benefits. One advantage is that
components let you divide your applications into modules that you can develop and maintain
separately. By implementing commonly used logic within custom components, you can also
build a suite of reusable components that you can share among multiple Flex applications.
In addition, you can extend the Flex class hierarchy to base your custom components on the
set of predefined Flex components. You can create custom versions of Flex visual controls, as
well as custom versions of nonvisual components, such as validators, formatters, and effects.
This topic contains an introduction to the process that you use to create Flex components.
Subsequent topics describe this process in more detail.

Contents
About creating components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Creating custom components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Where to go from here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

About creating components

You can build an entire Flex application in a single MXML file that contains both your
MXML code and any supporting ActionScript code. As your application gets larger, your
single file also grows in size and complexity. This type of application would soon become
difficult to understand and debug, and very difficult for multiple developers to work on
simultaneously.

13
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
A common coding practice is to divide an application into functional units, or modules,
where each module performs a discrete task. Dividing your application into modules provides
you with many benefits, including the following:
Ease of development Different developers or development groups can develop and debug
modules independently of each other.
Reusability You can reuse modules in different applications so that you do not have to
duplicate your work.
Maintainability By developing your application in discrete modules, you can isolate and
debug errors faster than you could if you developed your application in a single file.
In Flex, a module corresponds to a custom component, implemented either in MXML or in
ActionScript. The following image shows an example of a Flex application divided into
components:

main.mxml Custom Compiler/Linker Web server Client

components

<mx:Application> ActionScript
classes

<..>
*.AS
*.MXML *.SWF

*.AS RSL files

*.AS
Use <mx:Script>
to write, import,
or include
ActionScript *.AS

<..>

*.MXML

*.AS
SWC and RSL files

14 Creating Flex Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
This example shows the following relationships among the components:
■ You define a main MXML file that contains the <mx:Application> tag.
■ In your main MXML file, you define an ActionScript block that uses the <mx:Script>
tag. Inside the ActionScript block, you write ActionScript code, or include external logic
defined by an ActionScript file. Typically, you use this area to write small amounts of
ActionScript code. If you must write large amounts of ActionScript code, you should
include an external file.
■ The main MXML file uses MXML and ActionScript to reference components supplied
with Flex, and to reference your custom components.
■ Custom components can reference other custom components.

The Flex class hierarchy

Flex is implemented as an ActionScript class hierarchy. That class hierarchy contains
component classes, manager classes, data-service classes, and classes for all other Flex features.
The following example shows a portion of the class hierarchy for the Flex visual components,
such as controls and containers:

UIComponent

Container Button NumericStepper ComboBase

Box Form ComboBox

VBox
N OTE

For a complete description of the class hierarchy, see the Adobe Flex Language
Reference.

All visual components are derived from the UIComponent ActionScript class. Flex nonvisual
components are also implemented as a class hierarchy in ActionScript. The most commonly
used nonvisual classes are the Validator, Formatter, and Effect base classes.
You create custom components by extending the Flex class hierarchy using the MXML and
ActionScript languages. Components inherit the properties, methods, events, styles, and
effects of their superclasses.

About creating components 15

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Customizing existing Flex components
One reason for you to create a component is to customize an existing Flex component for
your application requirements. This customization could be as simple as setting the label
property of a Button control to Submit to create a custom button for all of your forms.
You might also want to modify the behavior of a Flex component. For example, a VBox
container lays out its children from the top of the container to the bottom in the order in
which you define the children within the container. Instead, you might want to customize the
VBox container to lay out its children from bottom to top.
Another reason to customize a Flex component is to add logic or behavior to it. For example,
you might want to modify the TextInput control so that it supports a key combination to
delete all the text entered into the control. Or, you might want to modify a component so that
it dispatches a new event type when a user action.
To create your own components, you create subclasses from the UIComponent class, or any
other class in the Flex component hierarchy. For example, if you want to create a component
that behaves almost the same as a Button component does, you can extend the Button class
instead of recreating all the functionality of the Button class from the base classes.
Depending on the modifications that you want to make, you can create a subclass of a Flex
component in MXML or ActionScript.

The relationship between MXML components and

ActionScript components
To create a custom component in ActionScript, you create a subclass from a class in the Flex
class hierarchy. The name of your class (for example, MyASButton), must correspond to the
name of the ActionScript file; for example, MyASButton.as. The subclass inherits all of the
properties and methods of the superclass. In this example, you use the <MyASButton> tag to
reference it in MXML.
When you create a custom component in MXML, the Flex compiler automatically creates an
ActionScript class. The name of the MXML file (for example, MyMXMLButton.mxml)
corresponds to the ActionScript class name. In this example, the ActionScript class is named
MyMXMLButton, and you use the <MyMXMLButton> tag to reference it in MXML.

16 Creating Flex Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example shows two components based on the Flex Button component, one
defined in ActionScript and the other in MXML:

Button.as

MyASButton.as MyMXMLButton.mxml

package <mx:Button>
{
public class MyASButton extends Button <mx:Script>
{
// Override inherited methods
// Override inherited methods // and properties.
// and properties.
// Define new methods
// Define new methods // and properties.
// and properties.
// Define custom logic
// Define custom logic // in ActionScript.
// in ActionScript.
} </mx:Script>
}

</mx:Button>

Both implementations create a component as a subclass of the Button class and, therefore,
inherit all of the public and protected properties, methods, and other elements of the Button
class. Within each implementation, you can override inherited items, define new items, and
add your custom logic.
N OTE

You cannot override an inherited property defined by a variable, but you can override a
property defined by setter and getter methods. You can reset the value of an inherited
property defined by a variable. You typically reset it in the constructor of the subclass for
an ActionScript component, or in an event handler for an MXML component because
MXML components cannot define a constructor.

However, when you use MXML, the Flex compiler performs most of the overhead required to
create a subclass of a component for you. This makes it much easier to create components in
MXML than in ActionScript.

Deciding to create components in MXML or ActionScript

One of the first decisions that you must make when creating custom components is deciding
whether to write them in MXML or in ActionScript. Ultimately, it is the requirements of your
application that determine how you develop your custom component.

About creating components 17

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Some basic guidelines include the following:
■ MXML components and ActionScript components both define new ActionScript classes.
■ Almost anything that you can do in a custom ActionScript custom component, you can
also do in a custom MXML component. However, for simple components, such as
components that modify the behavior of an existing component or add a basic feature to
an existing component, it is simpler and faster to create them in MXML.
■ When your new component is a composite component that contains other components,
and you can express the positions and sizes of those other components using one of the
Flex layout containers, you should use MXML to define your component.
■ To modify the behavior of the component, such as the way a container lays out its
children, use ActionScript.
■ To create a visual component by creating a subclass from UIComponent, use
ActionScript.
■ To create a nonvisual component, such as a formatter, validator, or effect, use
ActionScript.
■ To add logging support to your control, use ActionScript. For more information, see
Chapter 12, “Logging,” in Building and Deploying Flex Applications.
N OTE

The Flash Professional 8 authoring environment does not support ActionScript 3.0.
Therefore, you should not use it to create ActionScript components for Flex 2. Instead,
you should use the Flex Builder IDE.

For more information on custom MXML components, see Chapter 7, “Creating Simple
MXML Components,” on page 77. For more information on ActionScript components, see
Chapter 9, “Creating Simple Visual Components in ActionScript,” on page 121.

Creating new components

Your application might require you to create components, rather than modifying existing
ones. To create components, you typically create them in ActionScript by creating a subclass
from the UIComponent class. This class contains the generic functionality of all Flex
components. You then add the required functionality to your new component to meet your
application requirements.
For more information, see Chapter 10, “Creating Advanced Visual Components in
ActionScript,” on page 149.

18 Creating Flex Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Creating custom components
You create custom components as either MXML or ActionScript files. This section contains
an overview of both methods.

Creating MXML components

Flex supplies a ComboBox control that you can use as part of a form that collects address
information from a customer. In the form, you can include a ComboBox control to let the
user select the state portion of the address from a list of the 50 states in the U.S. In an
application that has multiple forms where a user can enter an address, it would be tedious to
create and initialize multiple ComboBox controls with the same information about all 50
states.
Instead, you create an MXML component that contains a ComboBox control with all the 50
states defined within in it. Then, wherever you need to add a state selector to your
application, you use your custom MXML component. The following example shows a
possible definition for a custom ComboBox control:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:dataProvider>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>

</mx:dataProvider>
</mx:ComboBox>
This example shows the following:
1. The first line of the custom MXML component definition specifies the declaration of the
XML version.
2. The first MXML tag of the component, called its root tag, specifies a Flex component or a
custom component. MXML components correspond to ActionScript classes, therefore, the
root tag specifies the superclass of the MXML component. In this example, the MXML
component specifies the Flex ComboBox control as its superclass.
3. The xmlns property in the root tag specifies the Flex XML namespace. In this example, the
xmlns property indicates that tags in the MXML namespace use the prefix mx:.

4. The remaining lines of the component specify its definition.

Creating custom components 19

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" xmlns:MyComp="*">

<MyComp:StateComboBox/>

</mx:Application>
The MXML tag name for a custom component is composed of two parts: the namespace
prefix, in this case MyComp, and the tag name. The namespace prefix tells Flex where to look
for the file that implements the custom component. The tag name corresponds to the
filename of the component, in this case StateComboBox.mxml. Therefore, a file named
StateComboBox.mxml defines a component with the tag name of
<namespace:StateComboBox>.

As part of the <mx:Application> tag, the main application file includes the following
namespace definition: xmlns:MyComp="*". This definition specifies that the component is in
the same directory as the main application file, or in a directory included in the ActionScript
classpath. For more information on deploying MXML components, see Chapter 7, “Creating
Simple MXML Components,” on page 77.
A best practice is to put your custom components in a subdirectory of your application. That
practice helps to ensure that you do not have duplicate component names because they have a
different namespace. If you stored your component in the myComponents subdirectory of
your application, you would specify the namespace definition as
xmlns:MyComp="myComponents.*".

20 Creating Flex Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The StateComboBox.mxml file specifies the ComboBox control as its root tag, so you can
reference all of the properties of the ComboBox control in the MXML tag of your custom
component, or in the ActionScript specified in an <mx:Script> tag. For example, the
following example specifies the ComboBox.rowCount property and a listener for the
ComboBox.close event for your custom control:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Script>
<![CDATA[
import flash.events.Event;

private function handleCloseEvent(eventObj:Event):void {

// ...
}
]]>
</mx:Script>

<MyComp:StateComboBox rowCount="5" close="handleCloseEvent(event);"/>

</mx:Application>
For more information on MXML components, see “Creating Simple MXML Components”
on page 77.

Creating ActionScript components

You create ActionScript components by defining ActionScript classes. You can create the
following types of components in ActionScript:
User-interface, or visual, components User-interface components contain both
processing logic and visual elements. You create custom user-interface components to modify
existing behavior or add new functionality to the component. These components usually
extend the Flex component hierarchy. You can extend from the UIComponent class, or any of
the Flex components, such as Button, ComboBox, or DataGrid. Your custom ActionScript
component inherits all of the methods, properties, events, styles, and effects of its superclass.
Nonvisual components Nonvisual components define nonvisual elements. Flex includes
several types of nonvisual components that you can create, including formatters, validators,
and effects. You create nonvisual components by creating a subclass from the Flex component
hierarchy. For validators, you create subclasses of the Validator class; for formatters you create
subclasses of the Formatter class; and for effects, you create subclasses of the Effect class.

Creating custom components 21

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
For example, you can define a custom button component based on the Flex Button class, as
the following example shows:
package myComponents
{
// intro/myComponents/MyButton.as
import mx.controls.Button;

public class MyButton extends Button {

// Define the constructor.

public function MyButton() {
// Call the constructor in the superclass.
super();
// Set the label property to "Submit".
label="Submit";
}
}
}
In this example, you write your MyButton class to the MyButton.as file.
You must define your custom components within an ActionScript package. The package
reflects the directory location of your component in the directory structure of your
application. Typically, you put custom ActionScript components in directories that are in the
ActionScript classpath, subdirectories of your application, or for LiveCycle Data Services ES,
in the WEB-INF/flex/user_classes directory. In this example, the package statement specifies
that the MyButton.as file is in the myComponents subdirectory of your Flex application.
In the MXML file that references the custom component, you define the namespace and
reference it in an MXML file as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:MyButton/>

</mx:Application>
In this example, you first define the MyComp namespace that specifies the location of your
custom component in the application’s directory structure. You then reference the component
as an MXML tag using the namespace prefix.
For more information, see Chapter 9, “Creating Simple Visual Components in ActionScript,”
on page 121.

22 Creating Flex Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Deploying components
When you deploy your custom components as MXML or ActionScript files, you typically
deploy them in the same directory structure as your application files, in a directory specified
in the ActionScript classpath, or for LiveCycle Data Services ES, in the WEB-INF/flex/
user_classes directory.
For security reasons, you might not deploy your custom components as source code files.
Alternatively, you can deploy your components as SWC files or as part of a Runtime Shared
Library (RSL).
A SWC file is an archive file for Flex components. SWC files make it easy to exchange
components among Flex developers. You need only exchange a single file, rather than the
MXML or ActionScript files and images and other resource files. In addition, the SWF file
inside a SWC file is compiled, which means that the code is obfuscated from casual view.
SWC files can contain one or more components and are packaged and expanded with the
PKZip archive format. You can open and examine a SWC file using WinZip, JAR, or other
archiving tool. However, you should not manually change the contents of a SWC file, and
you should not try to run the SWF file that is in a SWC file outside of a SWC file.
To create a SWC file, use the compc utility in the flex_install_dir/bin directory. The compc
utility generates a SWC file from MXML component source files and/or ActionScript
component source files. For more information on compc, see Chapter 9, “Using the Flex
Compilers,” in Building and Deploying Flex Applications.
One way to reduce the size of your application’s SWF file is by externalizing shared assets into
stand-alone files that can be separately downloaded and cached on the client. These shared
assets are loaded by any number of applications at run time, but only need to be transferred to
the client once. These shared files are known as Runtime Shared Libraries or RSLs.
For more information, including information on how to create an RSL file, see Chapter 11,
“Using Runtime Shared Libraries,” in Building and Deploying Flex Applications.

Where to go from here

The remaining topics in this manual are divided into sections that correspond to the different
types of components that you can create. For more information on creating components, see
the following parts of this manual:
■ Part 2, “Creating MXML Components,” on page 75
■ Part 3, “Creating ActionScript Components,” on page 119
■ Part 4, “Creating Nonvisual Flex Components,” on page 207

Where to go from here 23

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

24 Creating Flex Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 3

Using ActionScript to Create

Components
3
You use ActionScript code to create ActionScript components for Adobe Flex, or to add logic
to MXML components. ActionScript provides flow control and object manipulation features
that are not available in MXML.
This topic contains a summary of the general rules for using ActionScript code in custom
components. This topic does not replace the information contained in the ActionScript
reference documentation. For additional information on ActionScript, see the following
resources:
■ Adobe Flex Language Reference: Contains the API reference for ActionScript 3.0.
■ Programming ActionScript 3.0: Contains information on using ActionScript 3.0.

Contents
Using ActionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Using ActionScript
Before you start developing custom components, you should be familiar with basic
ActionScript coding practices.

Using the package statement

You must define your ActionScript custom components within a package. The package
reflects the directory location of your component within the directory structure of your
application. To define the package structure, you include the package statement in your class
definition, as the following example shows:
package myComponents
{
// Class definition goes here.
}

25
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Your package statement must wrap the entire class definition. If you write your ActionScript
class file to the same directory as your other application files, you can leave the package name
blank. However, as a best practice, you should store your components in a subdirectory, where
the package name reflects the directory location. In this example, your write your
ActionScript class file to the directory myComponents, a subdirectory of your main
application directory.
Formatters are a particular type of component. You might also create a subdirectory of your
application’s root directory called myFormatters for all of your custom formatter classes. Each
formatter class would then define its package statement, as the following example shows:
package myFormatters
{
// Formatter class definition goes here.
}

If you create a component that is shared among multiple applications, or a component that
might be used with third-party components, assign a unique package name to avoid naming
conflicts. For example, you might prefix your package name with your company name, as in:
package Acme.myFormatters
{
// Formatter class definition goes here.
}

When you reference a custom component from an MXML file, you specify a namespace
definition for the component that corresponds to its directory location and package name, as
the following example shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myFormatters.*">

<MyComp:SimpleFormatter id="upperFormat" formatString="upper"/>

...

</mx:Application>

If a formatter class is in a subdirectory of myFormatters, such as myFormatters/

dataFormatters, the package statement is as follows:
package myFormatters.dataFormatters
{
// Formatter class definition goes here.
}

26 Using ActionScript to Create Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You then specify the namespace definition for the component, as the following example
shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myFormatters.dataFormatters.*">

<MyComp:SimpleFormatter id="upperFormat" formatString="upper"/>

...

</mx:Application>

Using the import statement

You use the import statement to import any classes that your class requires. Importing adds a
reference to the class so that you can access classes defined by the import. Classes that you
import must be located in the ActionScript classpath for your application.
You import the classes referenced by your custom component as part of its implementation, as
the following example shows:
package myComponents
{
// Import necessary classes.
import mx.core.Container;
import mx.controls.Button;
// Import all classes in the mx.events package
import mx.events.*;

// Class definition goes here.

// You can now create an instance of a Container using this syntax:

private var myContainer:Container = new Container();

There is a distinct difference between including and importing in ActionScript. Including is

copying lines of code from one ActionScript file into another. Files that you include must be
located relative to the file performing the include, or use an absolute path. Importing is adding
a reference to a class file or package so that you can access objects and properties defined by
external classes.
For more information on including and importing, see Chapter 4, “Using ActionScript,” in
Flex Developer’s Guide.

Using ActionScript 27
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using the class statement
You use the class statement to define your class name, and to specify its superclass, as the
following example shows:
package myComponents
{
// Import necessary classes
import mx.core.Container;
import mx.controls.Button;
// Import all classes in the mx.events package
import mx.events.*;

// Class definition goes here.

public class MyButton extends Button {

// Define properties, constructor, and methods.

}
}

The class definition of your component must be prefixed by the public keyword, or it cannot
be used as an MXML tag. A file that contains a class definition can have one, and only one,
public class definition, although it can have additional internal class definitions. Place any
internal class definitions at the bottom of your source file below the closing curly brace of the
package definition.
In a single ActionScript file, you can define only one class in the package. To define more than
one class in a file, define the additional classes outside of the package body.
N OTE

The class definition is one of the few ActionScript constructs that you cannot use in an
<mx:Script> block in an MXML file.

Defining the constructor

An ActionScript class must define a public constructor method, which initializes an instance
of the class. The constructor has the following characteristics:
■ No return type.
■ Should be declared public.
■ Might have optional arguments.
■ Cannot have any required arguments if you use it as an MXML tag.
■ Calls the super() method to invoke the superclass’s constructor.

28 Using ActionScript to Create Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You call the super() method within your constructor to invoke the superclass’s constructor to
initialize the inherited items from the superclass. The super() method should be the first
statement in your constructor; otherwise, the inherited parts of the superclass might not be
properly constructed. In some cases, you might want to initialize your class first, and then call
super().
N OTE

If you do not define a constructor, the compiler inserts one for you and adds a call to
super(). However, it is considered a best practice to write a constructor and to explicitly
call super(), unless the class contains nothing but static members. If you define the
constructor, but omit the call to super(), Flex automatically calls super() at the beginning
of your constructor.

In the following example, you define a constructor that uses super() to call the superclass’s
constructor:
package myComponents
{
// Import necessary classes
import mx.core.Container;
import mx.controls.Button;
// Import all classes in the mx.events package
import mx.events.*;

// Class definition goes here.

public class MyButton extends Button {

// Public constructor.
public function MyButton()
{
// Call the constructor in the superclass.
super();
}
// Define properties and methods.

}
}
N OTE

You cannot define a constructor for an MXML component. For more information, see
“About implementing IMXMLObject” on page 116

Using ActionScript 29
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Defining properties as variables
Properties let you define data storage within your class. You can define your properties as
public, which means that they can be accessed by users of the class. You can also define
properties as private, which means that they are used internally by the class, as the following
example shows:
public class MyButton extends Button {

// Define private vars.

private var currentFontSize:Number;

// Define public vars.

public var maxFontSize:Number = 15;
public var minFontSize:Number = 5;
}

Users of the class can access the public variables but not the private variables, as the following
example shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myControls.*">

<MyComp:MyButton label="Submit" maxFontSize="30"/>

</mx:Application>

Although you can define your classes to use public properties, you may find it advantageous to
define properties by using setter and getter methods. For more information, see “Defining
methods” on page 32.
N OTE

Defining properties as getters and setters

You can define properties for your components by using setter and getter methods. The
advantage of getters and setters is that they isolate the variable from direct public access so that
you can perform the following actions:
■ Inspect and validate any data written to the property on a write
■ Trigger events that are associated with the property when the property changes
■ Calculate a return value on a read
■ Allow a child class to override

30 Using ActionScript to Create Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
To define getter and setter methods, precede the method name with the keyword get or set,
followed by a space and the property name. The following example shows the declaration of a
public property named initialCount, and the getter and setter methods that get and set the
value of this property:
// Define internal private variable.
private var _initialCount:uint = 42;

// Define public getter.

public function get initialCount():uint {
return _initialCount;
}

// Define public setter.

public function set initialCount(value:uint):void {
_initialCount = value;
}

By convention, setters use the identifier value for the name of the argument.
The variable that stores the property’s value cannot have the same name as the getter or setter.
By convention, precede the name of the variables with one (_) or two underscores (__). In
addition, Adobe recommends that you declare the variable as private or protected.
Users of the class can access the public property as the following example shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myControls.*" >

<MyComp:MyButton label="Submit" initialCount="24"/>

</mx:Application>

If the getter or setter overrides a getter or setter in a superclass, ensure that you include the
override keyword, as the following example shows:
override public function get label():String {}
override public function set label(value:String):void {}

Using ActionScript 31
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Defining methods
Methods define the operations that your class can perform. You define methods in the body of
the class. Your methods can override a method of a superclass, or define new functionality for
your components.
If the method adds new functionality, you define it using the function keyword, as the
following example shows:
public function myMethod():void {
// Method definition
}

If you define this method as a public method, users of the class can call it.
You can also define private methods, as the following example shows:
N OTE

If a function takes no arguments, ensure that you specify its argument list as empty
parentheses (), not as (void). The latter specifies a single argument of type Object named
void.
If a function, other than a constructor, returns no value, you must specify a return value of
void. If you omit the return type, the compiler issues a warning.

private function internalMethod():void {

// Method definition
}

Private methods are for internal use by the class, and cannot be called by users of the class.
If the method overrides a method in a superclass, you must include the override keyword
and the signature of the method must exactly match that of the superclass method, as the
following example shows:
override protected function createChildren():void {
// Method definition
}

Your methods may take required or optional arguments. To make any of the arguments
optional, assign default values to them, as the following example shows:
override public validate(value:Object = null,
supressEvents:Boolean = false):ValidationResultEvent {
// Method definition
}

If the method takes a variable number of arguments, use the “...” syntax, as the following
example shows:
function foo(n:Number, ... rest):void {
// Method definition
}

32 Using ActionScript to Create Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex creates an Array called rest for the optional arguments. Therefore, you can determine
the number of arguments passed to the method by using rest.length, and access the
arguments by using rest[i].

Using the super keyword in a method override

You use the super keyword in a method override to invoke the corresponding method of the
superclass. The super keyword has the following syntax:
super.methodName([arg1, ..., argN])

This technique is useful when you create a subclass method that adds behavior to a superclass
method but also invokes the superclass method to perform its original behavior.
NOT E

Although Flex automatically calls the super() method in a constructor to execute the
superclass’s constructor, you must call super.methodName() in a method override.
Otherwise, the superclass’s version of the method does not execute.

Whether you call super.myMethod() within a method override depends on your application
requirement, as follows:
■ Typically, you extend the existing functionality of the superclass method, so the most
common pattern is to call super.myMethod() first in your method override, and then add
your logic.
■ You might need to change something before the superclass method does its work. In this
case, you might call super.myMethod() in the override after your logic.
■ In some method overrides, you might not want to invoke the superclass method at all.
Only call super.myMethod() if and when you want the superclass to do its work.
■ Sometimes the superclass has an empty method that does nothing, which requires you to
implement the functionality in the method. In this case, you should still call
super.myMethod() because in a future version of Flex, that method might implement
some functionality. For more information, see the documentation on each Flex class.

Using ActionScript 33
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
About scope
Scoping is mostly a description of what the this keyword refers to at any given point in your
application. In the main MXML application file, the file that contains the
<mx:Application> tag, the current scope is the Application object and, therefore, the this
keyword refers to the Application object.
In an ActionScript component, the scope is the component itself and not the application or
other file that references the component. As a result, the this keyword inside the component
refers to the component instance and not the Flex Application object.
Nonvisual ActionScript components do not have access to their parent application with the
parentDocument property. However, you can access the top-level Application object by using
the mx.core.Application.application property.
For more information on scope, see Chapter 4, “Using ActionScript,” in Flex Developer’s
Guide.

34 Using ActionScript to Create Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 4

Creating Custom Events 4

You can create custom events as part of defining MXML and ActionScript components.
Custom events let you add functionality to your custom components to respond to user
interactions, to trigger actions by your custom component, and to take advantage of data
binding. This topic presents an overview of how to dispatch custom events from your MXML
and ActionScript components, and how to create Event classes by creating a subclass of the
Event class.
The basic concepts of creating custom events are described here, however, subsequent topics
describe this process in more detail for MXML and ActionScript components. For more
information on creating custom events for MXML components, see Chapter 8, “Creating
Advanced MXML Components,” on page 91. For information on creating them for
ActionScript components, see Chapter 9, “Creating Simple Visual Components in
ActionScript,” on page 121.

Contents
About events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Dispatching custom events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

About events
Adobe Flex applications are event-driven. Events let an application know when the user
interacts with the interface, and also when important changes happen in the appearance or life
cycle of a component, such as the creation of a component or its resizing. Events can be
generated by user input devices, such as the mouse and keyboard, or by the asynchronous
operations, such as the return of a web service call or the firing of a timer.
The core class of the Flex component architecture, mx.core.UIComponent, defines core
events, such as updateComplete, resize, move, creationComplete, and others that are
fundamental to all components. Subclasses of UIComponent inherit these events.

35
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Custom components that extend existing Flex classes inherit all the events of the base class.
Therefore, if you extend the Button class to create the MyButton class, you can use the click
event, and the events that all controls inherit, such as mouseOver or initialize, as the
following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Script>
<![CDATA[
import flash.events.Event;

// Event listener for the click event.

private function handleClick(eventObj:Event):void {
// Define event listener.
}

// Event listener for the initialize event.

private function handleInit(eventObj:Event):void {
// Define event listener.
}
]]>
</mx:Script>

<MyComp:MyButton
click="handleClick(event);"
initialize="handleInit(event);"/>

</mx:Application>
In addition to using the events inherited from its superclasses, your custom components can
define custom events. You use custom events to support data binding, to respond to user
interactions, or to trigger actions by your component.
For more information on the Flex event mechanism, see Chapter 5, “Using Events,” in Flex
Developer’s Guide.

36 Creating Custom Events

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using an event object
When a Flex component dispatches an event, it creates an event object, where the properties
of the event object contain information describing the event. An event listener takes this event
object as an argument and accesses the properties of the object to determine information
about the event.
The base class for all event objects is the flash.events.Event class. All event objects are instances
of the Event class, or instances of a subclass of the Event class.
The following table describes the public properties of the Event class. The Event class
implements these properties using getter methods:

Property Type Description

type String The name of the event; for example, “click”. The event
constructor sets this property.
target EventDispatcher A reference to the component instance that dispatches the
event. This property is set by the dispatchEvent() method;
you cannot change this to a different object.
currentTarget EventDispatcher A reference to the component instance that is actively
processing the Event object. The value of this property is
different from the value of the target property during the
event capture and bubbling phase. For more information,
see Chapter 5, “Using Events,” in Flex Developer’s Guide.
eventPhase uint The current phase in the event flow. The property might
contain the following values:
• EventPhase.CAPTURING_PHASE: The capture phase
• EventPhase.AT_TARGET: The target phase
• EventPhase.BUBBLING_PHASE: The bubbling phase
bubbles Boolean Whether an event is a bubbling event. If the event can
bubble, the value for this property is true, otherwise, it is
false. You can optionally pass this property as a
constructor argument to the Event class. By default, most
event classes set this property to false. For more
information, see Chapter 5, “Using Events,” in Flex
Developer’s Guide.
cancelable Boolean Whether the event can be canceled. If the event can be
canceled, the value for this value is true, otherwise, it is
false. You can optionally pass this property as a
constructor argument to the Event class. By default, most
event classes set this property to false. For more
information, see Chapter 5, “Using Events,” in Flex
Developer’s Guide.

About events 37
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Dispatching custom events
Flex defines many of the most common events, such as the click event for the Button
control, however, your application may require that you create events. In your custom Flex
components, you can dispatch any of the predefined events inherited by the component from
its superclass, and dispatch new events that you define within the component.
To dispatch a new event from your custom component, you must do the following:
1. (Optional) Create a subclass from the flash.events.Event class to create an event class that
describes the event object. For more information, see “Creating a subclass from the Event
class” on page 38.
2. (Optional) Use the [Event] metadata tag to make the event public so that the MXML
compiler recognizes it. For more information, see “Using the Event metadata tag”
on page 40.
3. Dispatch the event using the dispatchEvent() method. For more information, see
“Dispatching an event” on page 41.

Creating a subclass from the Event class

All events use an event object to transmit information about the event to the event listener,
where the base class for all event objects is the flash.events.Event class. When you define a
custom event, you can dispatch an event object of type Event, or you can create a subclass of
the Event class to dispatch an event object of a different type. You typically create a subclass of
the Event class when your event requires you to add information to the event object, such as a
new property to hold information that the event listener requires.
For example, the event objects associated with the Flex Tree control include a property named
node, which identifies the node of the Tree control associated with the event. To support the
node property, the Tree control dispatches event objects of type TreeEvent, a subclass of the
Event class.
Within your subclass of the Event class, you can add properties, add methods, set the value of
an inherited property, or override methods inherited from the Event class. For example, you
might want to set the bubbles property to true to override the default setting of false,
which is inherited from the Event class.
You are required to override the Event.clone() method in your subclass. The clone()
method returns a cloned copy of the event object by setting the type property and any new
properties in the clone. Typically, you define the clone() method to return an event instance
created with the new operator.

38 Creating Custom Events

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Suppose that you want to pass information about the state of your component to the event
listener as part of the event object. To do so, you create a subclass of the Event class to create
an event, EnableChangeEvent, as the following example shows:
package myEvents
{
//events/myEvents/EnableChangeEvent.as
import flash.events.Event;

public class EnableChangeEvent extends Event

{

// Public constructor.
public function EnableChangeEvent(type:String,
isEnabled:Boolean=false) {
// Call the constructor of the superclass.
super(type);

// Set the new property.

this.isEnabled = isEnabled;
}

// Define static constant.

public static const ENABLE_CHANGED:String = "enableChanged";

// Define a public variable to hold the state of the enable property.

public var isEnabled:Boolean;

// Override the inherited clone() method.

override public function clone():Event {
return new EnableChangeEvent(type, isEnabled);
}
}
}
In this example, your custom class defines a public constructor that takes two arguments:
■ A String value that contains the value of the type property of the Event object.
■ An optional Boolean value that contains the state of the component’s isEnabled
property. By convention, all constructor arguments for class properties are optional, other
than the type argument.
From within the body of your constructor, you call the super() method to initialize the base
class properties.

Dispatching custom events 39

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using the Event metadata tag
You use the [Event] metadata tag to define events dispatched by a component so that the
Flex compiler can recognize them as MXML tag attributes in an MXML file. You add the
[Event] metadata tag in one of the following locations:

ActionScript components Above the class definition, but within the package definition, so
that the events are bound to the class and not a particular member of the class.
MXML components In the <mx:Metadata> tag of an MXML file.
The Event metadata keyword has the following syntax:
[Event(name=”eventName”, type=”package.eventType”)]

The eventName argument specifies the name, including the package, of the event. The
eventType argument specifies the class that defines the event.

The following example identifies the enableChange event as an event that an ActionScript
component can dispatch:
[Event(name="enableChange", type="myEvents.EnableChangeEvent")]
public class MyComponent extends TextArea
{
...
}

The following example shows the [Event] metadata tag within the <mx:Metadata> tag of an
MXML file:
<?xml version="1.0"?>

<mx:Button xmlns:mx="http://www.adobe.com/2006/mxml"
click="dispatchEvent(new EnableChangeEvent('enableChanged'));">

<mx:Script>
<![CDATA[
import myEvents.EnableChangeEvent;
]]>
</mx:Script>

<mx:Metadata>
[Event(name="enableChanged", type="myEvents.EnableChangeEvent")]
</mx:Metadata>

</mx:Button>

40 Creating Custom Events

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Once defined using the [Event] metadata tag, you can refer to the event in an MXML file, as
the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<mx:Script>
<![CDATA[
import myEvents.EnableChangeEvent;

public function
enableChangedListener(eventObj:EnableChangeEvent):void {
// Handle event.
}
]]>
</mx:Script>

<MyComp:MyButton enableChanged="myTA.text='got event';" />

<mx:TextArea id="myTA" />

</mx:Application>
If you do not identify an event with the [Event] metadata tag, the compiler generates an
error if you try to use the event name in MXML. The metadata for events is inherited from
the superclass, however, so you do not need to tag events that are already defined with the
[Event] metadata tag in the superclass.

Dispatching an event
You use the dispatchEvent() method to dispatch an event. The dispatchEvent() method
has the following signature:
public dispatchEvent(event:Event):Boolean

This method requires an argument of type Event, which is the event object. The
dispatchEvent() method initializes the target property of the event object with a reference
to the component dispatching the event.
You can create an event object and dispatch the event in a single statement, as the following
example shows:
dispatchEvent(new Event("click"));

You can also create an event object, initialize it, and then dispatch it, as the following example
shows:
var eventObj:EnableChangeEvent = new EnableChangeEvent("enableChange");

Dispatching custom events 41

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
eventObj.isEnabled=true;
dispatchEvent(eventObj);

For complete examples that create and dispatch custom events, see Chapter 8, “Creating
Advanced MXML Components,” on page 91 and Chapter 9, “Creating Simple Visual
Components in ActionScript,” on page 121.

Creating static constants for the Event.type property

The constructor of an event class typically takes a single required argument that specifies the
value of the event object’s type property. In the previous section, you passed the string
enableChange to the constructor, as the following example shows:
// Define event object, initialize it, then dispatch it.
var eventObj:EnableChangeEvent = new EnableChangeEvent("enableChange");
dispatchEvent(eventObj);

The Flex compiler does not examine the string passed to the constructor to determine if it is
valid. Therefore, the following code compiles, even though enableChangeAgain might not
be a valid value for the type property:
var eventObj:EnableChangeEvent =
new EnableChangeEvent("enableChangeAgain");

Because the compiler does not check the value of the type property, the only time that your
application can determine if enableChangeAgain is valid is at run time.
However, to ensure that the value of the type property is valid at compile time, Flex event
classes define static constants for the possible values for the type property. For example, the
Flex EffectEvent class defines the following static constant:
// Define static constant for event type.
public static const EFFECT_END:String = "effectEnd";

To create an instance of an EffectEvent class, you use the following constructor:

var eventObj:EffectEvent = new EffectEvent(EffectEvent.EFFECT_END);

If you incorrectly reference the constant in the constructor, the compiler generates a syntax
error because it cannot locate the associated constant. For example, the following constructor
generates a syntax error at compile time because MY_EFFECT_END is not a predefined constant
of the EffectEvent class:
var eventObj:EffectEvent = new EffectEvent(EffectEvent.MY_EFFECT_END);

42 Creating Custom Events

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can use this technique when you define your event classes. The following example
modifies the definition of the EnableChangeEventConst class to include a static constant for
the type property:
package myEvents
{
//events/myEvents/EnableChangeEventConst.as
import flash.events.Event;

public class EnableChangeEventConst extends Event

{
// Public constructor.
public function EnableChangeEventConst(type:String,
isEnabled:Boolean=false) {
// Call the constructor of the superclass.
super(type);

// Set the new property.

this.isEnabled = isEnabled;
}

// Define static constant.

public static const ENABLE_CHANGED:String = "myEnable";

// Define a public variable to hold the state of the enable property.

public var isEnabled:Boolean;

// Override the inherited clone() method.

override public function clone():Event {
return new EnableChangeEvent(type, isEnabled);
}
}
}

Dispatching custom events 43

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Now you create an instance of the class by using the static constant, as the following example
shows for the MyButtonConst custom component:
<?xml version="1.0"?>

<mx:Button xmlns:mx="http://www.adobe.com/2006/mxml"
click="dispatchEvent(new
EnableChangeEventConst(EnableChangeEventConst.ENABLE_CHANGED));">

<mx:Script>
<![CDATA[
import myEvents.EnableChangeEventConst;
]]>
</mx:Script>

<mx:Metadata>
[Event(name="myEnable", type="myEvents.EnableChangeEventConst")]
</mx:Metadata>

</mx:Button>
This technique does not preclude you from passing a string to the constructor.

44 Creating Custom Events

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 5

Using Metadata Tags in

Custom Components
5
You insert metadata tags into your MXML and ActionScript files to provide information to
the Flex compiler. Metadata tags do not get compiled into executable code, but provide
information to control how portions of your code get compiled.
This topic describes the metadata tags that you use when creating components in MXML and
ActionScript. Flex Developer’s Guide contains information about additional metadata tags that
you use when creating an application, such as the [Embed] metadata tag. For more
information on the [Embed] metadata tag, see Chapter 32, “Embedding Assets,” in Flex
Developer’s Guide.

Contents
About metadata tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Metadata tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

45
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
About metadata tags
Metadata tags provide information to the Flex compiler that describe how your components
are used in a Flex application. For example, you might create a component that defines a new
event. To make that event known to the Flex compiler so that you can reference it in MXML,
you insert the [Event] metadata tag into your component, as the following ActionScript class
definition shows:
[Event(name="enableChanged", type="flash.events.Event")]
class ModalText extends TextArea {
...
}

In this example, the [Event] metadata tag specifies the event name, and the class that defines
the type of the event object dispatched by the event. After you identify the event to the Flex
compiler, you can reference it in MXML, as the following example shows:
<?xml version="1.0"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" xmlns:MyComp="*">

<mx:Script>
<![CDATA[
function handleEnableChangeEvent(eventObj:Event):void {
...
}
]]>
</mx:Script>

<MyComp:ModalText enableChanged="handleEnableChangeEvent(event);"/>

</mx:Application>

If you omit the [Event] metadata tag from your class definition, Flex issues a syntax error
when it compiles your MXML file. The error message indicates that Flex does not recognize
the enableChanged property.

46 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using metadata tags
The Flex compiler recognizes component metadata statements in your ActionScript class files
and MXML files. The metadata tags define component attributes, data binding properties,
events, and other properties of the component. Flex interprets these statements during
compilation; they are never interpreted during run time.
Metadata statements are associated with a class declaration, an individual data field, or a
method. They are bound to the next line in the file. When you define a component property
or method, add the metadata tag on the line before the property or method declaration.
In an ActionScript file, when you define component events or other aspects of a component
that affect more than a single property, you add the metadata tag outside the class definition
so that the metadata is bound to the entire class, as the following example shows:
// Add the [Event] metadata tag outside of the class file.
[Event(name="enableChange", type=flash.events.Event)]
public class ModalText extends TextArea {

...

// Define class properties/methods

private var _enableTA:Boolean;

// Add the [Inspectable] metadata tag before the individual property.

[Inspectable(defaultValue="false")]
public function set enableTA(val:Boolean):void {
_enableTA = val;
this.enabled = val;

// Define event object, initialize it, then dispatch it.

var eventObj:Event = new Event("enableChange");
dispatchEvent(eventObj);
}
}

About metadata tags 47

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In this example, you add the [Event] metadata tag before the class definition to indicate that
the class dispatches an event named enableChanged. You also include the [Inspectable]
metadata tag to indicate the default value of the property for Flex Builder. For more
information on using this tag, see “Inspectable metadata tag” on page 56.
In an MXML file, you insert the metadata tags either in an <mx:Script> block along with
your ActionScript code, or in an <mx:Metadata> block, as the following example shows:
<?xml version="1.0"?>

<mx:TextArea xmlns:mx="http://www.adobe.com/2006/mxml">

<mx:Metadata>
[Event(name="enableChange", type="flash.events.Event")]
</mx:Metadata>

<mx:Script>
<![CDATA[

// Import Event class.

import flash.events.Event;

// Define class properties and methods.

private var _enableTA:Boolean;

// Add the [Inspectable] metadata tag before the individual property.

[Inspectable(defaultValue="false")]
public function set enableTA(val:Boolean):void {
_enableTA = val;
this.enabled = val;

// Define event object, initialize it, then dispatch it.

var eventObj:Event = new Event("enableChange");
dispatchEvent(eventObj);
}
]]>
</mx:Script>
</mx:TextArea>

A key difference between the <mx:Metadata> and <mx:Script> tags is that text within the
<mx:Metadata> tag is inserted before the generated class declaration, but text within
<mx:Script> tag is inserted in the body of the generated class declaration. Therefore,
metadata tags like [Event] and [Effect] must go in an <mx:Metadata> tag, but the
[Bindable] and [Embed] metadata tags must go in an <mx:Script> tag.

48 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Metadata tags
The following table describes the metadata tags that you can use in ActionScript class files:

Tag Description
[ArrayElementType] Defines the allowed data type of each element of an Array. For
more information, see “ArrayElementType metadata tag”
on page 50.
[Bindable] Identifies a property that you can use as the source of a data
binding expression. For more information, see “Bindable
metadata tag” on page 51.
[DefaultProperty] Defines the name of the default property of the component
when you use the component in an MXML file. For more
information, see “DefaultProperty metadata tag” on page 53.
[Effect] Defines the MXML property name for the effect. For more
information, see “Effect metadata tag” on page 54.
[Embed] Imports JPEG, GIF, PNG, SVG, and SWF files at compile time.
Also imports image assets from SWC files.
This is functionally equivalent to the MXML @Embed syntax, as
described in Chapter 32, “Embedding Assets,” in Flex
Developer’s Guide.
[Event] Defines the MXML property for an event and the data type of
the event object that a component emits. For more information,
see “Event metadata tag” on page 55.
[Exclude] Omits the class element from the FlexBuilder tag inspector.
The syntax is as follows:
[Exclude(name="label", kind="property")]

[ExcludeClass] Omits the class from the FlexBuilder tag inspector. This is
equivalent to the @private tag in ASDoc when applied to a
class.
[IconFile] Identifies the filename for the icon that represents the
component in the Insert bar of Adobe® Flex™ Builder™. For
more information, see “IconFile metadata tag” on page 56.
[Inspectable] Defines an attribute exposed to component users in the
attribute hints and Tag inspector of Flex Builder. Also limits
allowable values of the property. For more information, see
“Inspectable metadata tag” on page 56.
[InstanceType] Specifies the allowed data type of a property of type
IDeferredInstance. For more information, see “InstanceType
metadata tag” on page 58.

Metadata tags 49
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Tag Description
[NonCommittingChangeEvent] Identifies an event as an interim trigger. For more information,
see “NonCommittingChangeEvent metadata tag” on page 59.
[RemoteClass] Maps the ActionScript object to a Java object. For more
information, see the LiveCycle Data Services ES Developer’s
Guide.
[Style] Defines the MXML property for a style property for the
component. For more information on using the [Style]
metadata tag, see “Style metadata tag” on page 59.
[Transient] Identifies a property that should be omitted from data that is
sent to the server when an ActionScript object is mapped to a
Java object using [RemoteClass].

The following sections describe the component metadata tags in more detail.

ArrayElementType metadata tag

When you define an Array variable in ActionScript, you specify Array as the data type of the
variable. However, you cannot specify the data type of the elements of the Array.
To allow the Flex MXML compiler to perform type checking on Array elements, you can use
the [ArrayElementType] metadata tag to specify the allowed data type of the Array
elements, as the following example shows:
public class MyTypedArrayComponent extends VBox {

[ArrayElementType("String")]
public var newStringProperty:Array;

[ArrayElementType("Number")]
public var newNumberProperty:Array;
...
}

In this example, you specify String as the allowed data type of the Array elements. If a user
attempts to assign elements of a data type other than String to the Array in an MXML file, the
compiler issues a syntax error, as the following example shows:
<MyComp:MyTypedArrayComponent>
<MyComp:newStringProperty>
<mx:Number>94062</mx:Number>
<mx:Number>14850</mx:Number>
<mx:Number>53402</mx:Number>
</MyComp:newStringProperty>
</MyComp:MyTypedArrayComponent>

50 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In this example, you try to use Number objects to initialize the Array, so the compiler issues
an error.
You can also specify Array properties as tag attributes, rather than using child tags, as the
following example shows.
<MyComp:MyTypedArrayComponent newNumberProperty="[abc,def]"/>

This MXML code generates an error because Flex cannot convert the Strings {abc} and {def }
to a Number.
You insert the [ArrayElementType] metadata tag before the variable definition. The tag has
the following syntax:
[ArrayElementType("elementType")]

The following table describes the property of the [ArrayElementType] metadata tag:

Property Type Description

elementType String Specifies the data type of the Array elements, and can be one of
the ActionScript data type, such as String, Number, class, or
interface.
You must specify the type as a fully qualified class name, including
the package.

Bindable metadata tag

If you omit the event name, Flex automatically creates an event named propertyChange.
For more infomration on data binding and on this metadata tag, see Chapter 42, “Binding
Data,” in Flex Developer’s Guide.

Metadata tags 51
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Working with bindable property chains
When you specify a property as the source of a data binding, Flex monitors not only that
property for changes, but also the chain of properties leading up to it. The entire chain of
properties, including the destination property, is called a bindable property chain. In the
following example, firstName.text is a bindable property chain that includes both a
firstName object and its text property:
<first>{firstName.text}</first>

You should raise an event when any named property in a bindable property chain changes. If
the property is marked with the [Bindable] metadata tag, the Flex compiler generates the
event for you. For more examples using the [Bindable] metadata tag, see “Bindable
metadata tag” in Creating and Extending Flex Components.
The following example shows an example that uses the [Bindable] metadata tag for a
variable and a getter property and how to call the dispatchEvent() function:
[Bindable]
public var minFontSize:Number = 5;

[Bindable("textChanged")]
public function get text():String {
return myText;
}

public function set text(t : String):void {

myText = t;
dispatchEvent( new Event( "textChanged" ) );}

If you omit the event name in the [Bindable] metadata tag, the Flex compiler automatically
generates and dispatches an event named propertyChange so that the property can be used as
the source of a data binding expression.
You should also provide the compiler with better information about an object by casting the
object to a known type. In the following example, the myList List control contains Customer
objects, so the selectedItem property is cast to a Customer object:
<mx:Model id="selectedCustomer">
<customer>
<name>{Customer(myList.selectedItem).name}</name>
<address>{Customer(myList.selectedItem).address}</address>
...
</customer>
</mx:Model>

There are some situations in which binding does not execute automatically as expected.
Binding does not execute automatically when you change an entire item of a dataProvider
property.

52 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Binding also does not execute automatically for subproperties of properties that have
[Bindable] metadata, as the following example shows:
...
[Bindable]
var temp;
// Binding is triggered:
temp = new Object();
// Binding is not triggered, because label not a bindable property
// of Object:
temp.label = foo;
...

In this code example, the problem with {temp.label} is that temp is an Object. You can
solve in one of the following ways:
■ Preinitialize the Object.
■ Assign an ObjectProxy to temp; all of an ObjectProxy’s properties are bindable.
■ Make temp a strongly typed object with a label property that is bindable.
Binding also does not execute automatically when you are binding data to a property that
Flash Player updates automatically, such as the mouseX property.
The executeBindings() method of the UIComponent class executes all the bindings for
which a UIComponent object is the destination. All containers and controls, as well as the
Repeater component, extend the UIComponent class. The executeChildBindings()
method of the Container and Repeater classes executes all of the bindings for which the child
UIComponent components of a Container or Repeater class are destinations. All containers
extend the Container class.
These methods give you a way to execute bindings that do not occur as expected. By adding
one line of code, such as a call to executeChildBindings() method, you can update the user
interface after making a change that does not cause bindings to execute. However, you should
only use the executeBindings() method when you are sure that bindings do not execute
automatically.

DefaultProperty metadata tag

The [DefaultProperty] metadata tag defines the name of the default property of the
component when you use the component in an MXML file.
The [DefaultProperty] metadata tag has the following syntax:
[DefaultProperty("propertyName")]

The propertyName property specifies the name of the default property.

Metadata tags 53
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can use the [DefaultProperty] metadata tag in your ActionScript component to define
a single default property. For more information, and an example, see “Creating a default
property” on page 130.

Effect metadata tag

The [Effect] metadata tag defines the name of the MXML property that you use to assign
an effect to a component and the event that triggers the effect. If you define a custom effect,
you can use the [Effect] metadata tag to specify that property to the Flex compiler.
For more information on defining custom effects, see Chapter 15, “Creating Effects,” on
page 229.
An effect is paired with a trigger that invokes the effect. A trigger is an event, such as a mouse
click on a component, a component getting focus, or a component becoming visible. An effect
is a visible or audible change to the component that occurs over a period of time.
You insert the [Effect] metadata tag before the class definition in an ActionScript file, or in
the <mx:Metadata> block in an MXML file. The [Effect] metadata tag has the following
syntax:
[Effect(name="eventNameEffect", event="eventName")]

The following table describes the properties of the [Effect] metadata tag:

Property Type Description

eventNameEffect String Specifies the name of the effect.
eventName String Specifies the name of the event that triggers the effect.

The [Effect] metadata tag is often paired with an [Event] metadata tag, where the
[Event] metadata tag defines the event corresponding to the effect’s trigger. By convention,
the name of the effect is the event name with the suffix Effect, as the following example of
an ActionScript file shows:
// Define event corresponding to the effect trigger.
[Event(name="darken", type="flash.events.Event")]
// Define the effect.
[Effect(name="darkenEffect", event="darken")]
class ModalText extends TextArea {
...
}

In an MXML file, you can define the event and effect in an <mx:Metadata> block, as the
following example shows:
<mx:Metadata>
[Event(name="darken", type="flash.events.Event")]

54 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
[Effect(name="darkenEffect", event="darken")]
</mx:Metadata>

Event metadata tag

Use the [Event] metadata tag to define the MXML property for an event and the data type of
the event object that a component emits. You insert the [Event] metadata tag before the class
definition in an ActionScript file, or in the <mx:Metadata> block in an MXML file.
For more information on defining custom events, see Chapter 4, “Creating Custom Events,”
on page 35.
The [Event] metadata tag has the following syntax:
[Event(name="eventName", type="package.eventType")]

The following table describes the properties of the [Event] metadata tag:

Property Type Description

eventName String Specifies the name of the event, including its package name.
eventType String Specifies the class that defines the data type of the event object. The
class name is either the base event class, Event, or a subclass of the
Event class. You must include the package in the class name.

The following example identifies the myClickEvent event as an event that the component
can dispatch:
[Event(name="myClickEvent", type="flash.events.Event")]

If you do not identify an event in the class file with the [Event] metadata tag, the MXML
compiler generates an error if you try to use the event name in MXML. Any component can
register an event listener for the event in ActionScript by using the addEventListener()
method, even if you omit the [Event] metadata tag.
The following example identifies the myClickEvent event as an event that an ActionScript
component can dispatch:
[Event(name="myEnableEvent", type="flash.events.Event")]
public class MyComponent extends UIComponent
{
...
}

The following example shows the [Event] metadata tag in the <mx:Metadata> tag in an
MXML file:
<?xml version="1.0"?>

<mx:TextArea xmlns:mx="http://www.adobe.com/2006/mxml">

Metadata tags 55
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

<mx:Metadata>
[Event(name="myEnableEvent", type="flash.events.Event")]
</mx:Metadata>

....

</mx:TextArea>

IconFile metadata tag

Use the [IconFile] metadata tag to identify the filename for the icon that represents the
component in the Insert bar of Flex Builder.
The [IconFile] metadata tag has the following syntax:
[IconFile("fileName")]

The fileName property specifies a PNG, GIF, or JPEG file that contains the icon, as the
following example shows:
[IconFile("MyButton.png")]
public class MyButton extends Button
{
...
}

Inspectable metadata tag

The [Inspectable] metadata tag defines information about an attribute of your component
that you expose in code hints and in the Property Inspector area of Flex Builder. The
[Inspectable] metadata tag is not required for either code hints or the Property Inspector.
The following rules determine how Flex Builder displays this information:
■ All public properties in components appear in code hints and in the Flex Builder Property
Inspector. If you have extra information about the property that you want to add, such as
enumeration values or that a String property represents a file path, then add the
[Inspectable] metadata tag with that information.
■ Code hints for components and the information in the Property Inspector come from the
same data. Therefore, if the attribute appears in one, it should appear in the other.
■ Code hints for ActionScript components do not require metadata to work correctly so you
always see the appropriate code hints, depending the current scope. Flex Builder uses the
public, protected, private, and static keywords plus the current scope to determine
which ActionScript code hints to show.

56 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The [Inspectable] metadata tag must immediately precede the property’s variable
declaration or the setter and getter methods to be bound to that property.
The [Inspectable] metadata tag has the following syntaxes:
[Inspectable(attribute=value[,attribute=value,...])]
property_declaration name:type;
[Inspectable(attribute=value[,attribute=value,...])]
setter_getter_declarations;

The following table describes the properties of the [Inspectable] metadata tag:

Property Type Description

category String Groups the property into a specific subcategory in the Property
inspector of the Flex Builder user interface. The default category is
"Other".

defaultValue String or Sets the initial value in the editor that appears in the Property
Number Inspector when you modify the attribute. The default value is
determined from the property definition.
enumeration String Specifies a comma-delimited list of legal values for the property.
Only these values are allowed; for example, item1, item2, item3.
This information appear as code hints and in the Property Inspector.
If you define a Boolean variable, Flex Builder automatically shows
true and false without you having to specifying them using
enumeration.

environment String Specifies which inspectable properties should not be allowed (none),
which are used only for Flex Builder (Flash), and which are used only
by Flex and not Flex Builder (MXML).
format String Determines the type of editor that appears in the Property Inspector
when you modify the attribute. You can use this property when the
data type of the attribute is not specific to its function. For example,
for a property of type Number, you can specify format="Color" to
cause Flex Builder to open a color editor when you modify the
attribute. Common values for the format property include "Length",
"Color", "Time", "EmbeddedFile", and "File".

listOffset Number Specifies the default index into a List value.

name String Specifies the display name for the property; for example, Font Width.
If not specified, use the property’s name, such as _fontWidth.

Metadata tags 57
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Property Type Description
type String Specifies the type specifier. If omitted, use the property’s type. The
following values are valid:
• Array
• Boolean
• Color
• Font Name
• List
• Number
• Object
• String
If the property is an Array, you must list the valid values for the Array.
variable String Specifies the variable to which this parameter is bound.
verbose Number Indicates that this inspectable property should be displayed in the
Flex Builder user interface only when the user indicates that verbose
properties should be included. If this property is not specified, Flex
Builder assumes that the property should be displayed.

The following example defines the myProp parameter as inspectable:

[Inspectable(defaultValue=true, verbose=1, category="Other")]
public var myProp:Boolean;

InstanceType metadata tag

The [InstanceType] metadata tag specifies the allowed data type of a property of type
IDeferredInstance, as the following example shows:
// Define a deferred property for the top component.
[InstanceType("mx.controls.Label")]
public var topRow:IDeferredInstance;

The Flex compiler validates that users only assign values of the specified type to the property.
In this example, if the component user sets the topRow property to a value of a type other
than mx.controls.Label, the compiler issues an error message.
You use the [InstanceType] metadata tag when creating template components. For more
information, see Chapter 12, “Creating Template Components,” on page 197.
The [InstanceType] metadata tag has the following syntax:
[InstanceType("package.className")]

You must specify a fully qualified package and class name.

58 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
NonCommittingChangeEvent metadata tag
The [NonCommittingChangeEvent] metadata tag identifies an event as an interim trigger,
which means that the event should not invoke Flex data validators on the property. You use
this tag for properties that might change often, but which you do not want to validate on
every change.
An example of this is if you tied a validator to the text property of a TextInput control. The
text property changes on every keystroke, but you do not want to validate the property until
the user presses the Enter key or changes focus away from the field. The
NonCommittingChangeEvent tag lets you dispatch a change event, but that does not trigger
validation.
You insert the [NonCommittingChangeEvent] metadata tag before an ActionScript property
definition or before a setter or getter method. The [NonCommittingChangeEvent] metadata
tag has the following syntax:
[NonCommittingChangeEvent("event_name")]

In the following example, the component dispatches the change event every time the user
enters a keystroke, but the change event does not trigger data binding or data validators.
When the user completes data entry, by pressing the Enter key, the component broadcasts the
valueCommit event to trigger any data bindings and data validators:
[Event(name="change", type="flash.events.Event")]
class MyText extends UIComponent {
...

[Bindable(event="valueCommit")]
[NonCommittingChangeEvent("change")]
function get text():String {
return getText();
}
function set text(t):void {
setText(t);
// Dispatch events.
}
}

Style metadata tag

Use the [Style] metadata tag to define the MXML tag attribute for a style property for the
component. You insert the [Style] metadata tag before the class definition in an
ActionScript file, or in the <mx:Metadata> block in an MXML file.
The [Style] metadata tag has the following syntax:
[Style(name="style_name"[,property="value",...])]

Metadata tags 59
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following table describes the properties for the [Style] metadata tag:

Option Type Description

name String (Required) Specifies the name of the style.
type String Specifies the data type of the value that you write to the style
property. If the type is not an ActionScript type such as Number or
Date, use a qualified class name in the form
packageName.className.
arrayType String If type is Array, arrayType specifies the data type of the Array
elements. If the data type is not an ActionScript type such as
Number or Date, use a qualified class name in the form
packageName.className.
format String Specifies the units of the property. For example, if you specify type
as “Number”, you might specify format="Length" if the style defines a
length measured in pixels. Or, if you specify type="uint", you might
set format="Color" if the style defines an RGB color.
enumeration String Specifies an enumerated list of possible values for the style property.
inherit String Specifies whether the property is inheriting. Valid values are yes and
no. This property refers to CSS inheritance, not object-oriented
inheritance. All subclasses automatically use object-oriented
inheritance to inherit the style property definitions of their
superclasses.
Some style properties are inherited using CSS inheritance. If you set
an inheritable style property on a parent container, its children inherit
that style property. For example, if you define fontFamily as Times
for a Panel container, all children of that container will also use Times
for fontFamily, unless they override that property.
If you set a noninheritable style, such as textDecoration, on a parent
container, only the parent container and not its children use that
style. For more information on inheritable style properties, see
“About style inheritance” in Flex Developer’s Guide.
states String For skin properties, specifies that you can use the style to specify a
stateful skin for multiple states of the component. For example, the
definition of the Slider.thumbSkin style uses the following [Style]
metadata tag:
[Style(name="thumbSkin", type="Class", inherit="no",
states="disabled, down, over, up")]
This line specifies that you can use the Slider.thumbSkin style to
specify a stateful skin for the disabled, down, over, and up states of
the Slider control. For more information, see Chapter 22, “Creating
Skins,” in Flex Developer’s Guide.

60 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example shows the definition of the textSelectedColor style property:
[Style(name="textSelectedColor",type="Number",format="Color",inherit="yes")]

The next example shows the definition of the verticalAlign style property:
[Style(name="verticalAlign", type="String",
enumeration="bottom,middle,top", inherit="no")]

For more information on the [Style] metadata tag, see Chapter 11, “Creating Custom Style
Properties,” on page 185.

Transient metadata tag

Use the [Transient] metadata tag to identifies a property that should be omitted from data
that is sent to the server when an ActionScript object is mapped to a Java object using the
[RemoteClass] metedata tag.

The [Transient] metadata tag has the following syntax:

[Transient]
public var count:Number = 5;

Metadata tags 61
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

62 Using Metadata Tags in Custom Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 6

Compiling Components 6
When you compile an application, you create a SWF file that a user can download and play.
You can also compile any custom components that you create as part of the application.
When you create a component, you save it to a location that the Flex compiler can access. You
can save your components as MXML and ActionScript files, as SWC files, or as Runtime
Shared Libraries (RSLs). This topic describes the options you have when you compile
components.

Contents
About compiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Compiling components with Flex SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Compiling components with LiveCycle Data Services ES . . . . . . . . . . . . . . . . . . . . . 72

About compiling
You compile a custom component so that you can use it as part of your application. You can
compile the component when you compile the entire application, or you can compile it
separately so that you can link it into the application at a later time.

63
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex component file types
When you create a Flex component, you can distribute it in one of several different file
formats, as the following table shows:

File format Extension Description

MXML .mxml A component implemented as an MXML file.

ActionScript .as A component implemented as an ActionScript class.

SWC .swc A component implemented as an MXML or ActionScript

file, and then packaged as a SWC file. A SWC file contains
components that you package and reuse among multiple
applications. The SWC file is then compiled into your
application when you create the application’s SWF file.

RSL .swc A component implemented as an MXML or ActionScript

file, and then deployed as an RSL. An RSL is a stand-alone
file that is downloaded separately from your application’s
SWF file, and cached on the client computer for use with
multiple application SWF files.

You must take into consideration the file format and file location when you compile an
application that uses the component.

About compiling with Flex SDK

Adobe Flex includes two compilers, mxmlc and compc. You use the mxmlc compiler to
compile MXML, ActionScript, SWC, and RSL files into a single SWF file. After your
application is compiled and deployed on your web or application server, a user can make an
HTTP request to download and play the SWF file on their computer.
You use the compc compiler to compile components, classes, and other files into SWC files or
into RSLs.
You can use the compc and mxmlc compilers from Adobe Flex Builder, or from a command
line. For more information on using the compilers, see Chapter 9, “Using the Flex
Compilers,” in Building and Deploying Flex Applications, and Chapter 10, “Building Projects,”
in Using Flex Builder.
This section presents some examples of using the mxmlc compiler. The most basic example is
one in which the MXML file has no external dependencies (such as components in a SWC
file or ActionScript classes). In this case, you open mxmlc and point it to your MXML file:
$ mxmlc c:/myfiles/app.mxml

64 Compiling Components
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The default option is the target file to compile into a SWF file, and it is required to have a
value. If you use a space-separated list as part of the options, you can terminate the list with a
double hyphen before adding the target file; for example:
$ mxmlc -option arg1 arg2 arg3 -- target_file.mxml

About compiling with LiveCycle Data Services ES

If you have Adobe LiveCycle Data Services ES, you can use mxmlc to compile your
application when an HTTP request occurs. To do so, you deploy your application as MXML,
ActionScript, SWC, and RSL files under the web root directory of your application server.
When a user requests the main MXML file, the request triggers the compilation.
A request to an MXML file has the following form:
http://hostname/path/filename.mxml

When LiveCycle Data Services ES receives an HTTP request for an MXML file, LiveCycle
Data Services ES performs the following steps:
1. Compiles the MXML file to produce a SWF file.
2. Caches the compiled SWF file on the server.
3. Returns the SWF file to the client.

About case sensitivity during a compilation

The Flex compilers use a case-sensitive file lookup on all file systems. On case-insensitive file
systems, such as the Macintosh and Windows file systems, the Flex compiler generates a case-
mismatch error when you use a component with the incorrect case. On case-sensitive file
systems, such as the UNIX file system, the Flex compiler generates a component-not-found
error when you use a component with the incorrect case.

About the ActionScript classpath

Typically, you put component files in directories that are in the ActionScript classpath. These
include your application’s root directory, its subdirectories, and any directory that you specify
to the compiler. To specify a directory, you use the source-path option to the mxmlc
compiler, or the Project Properties dialog box in Flex Builder.
The following rules can help you organize your custom components:
■ An application can access MXML and ActionScript components in the same directory,
and in its subdirectories.

About compiling 65
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
■ An ActionScript component in a subdirectory of the main application directory must
define a fully qualified package name that is relative to the location of the application’s
root directory. For example, if you define a custom component in the
dir1/dir2/myControls/PieChart.as file, its fully qualified package name must be
dir1.dir2.myControls, assuming dir1 is an immediate subdirectory of the main
application directory.
■ An MXML component does not include a package name definition. However, you must
declare a namespace definition in the file that references the MXML component that
corresponds to the directory location of the MXML component, either in a subdirectory
of the application’s root directory, or in a subdirectory of the classpath. For more
information, see Chapter 7, “Creating Simple MXML Components,” on page 77.
■ An application can access MXML and ActionScript components in the directories
included in the ActionScript classpath. The component search order in the classpath is
based on the order of the directories listed in the classpath.
■ An ActionScript component in a subdirectory of a directory included in the classpath
must define a fully qualified package name that is relative to the location of the classpath
directory. For example, if you define a custom component in the file
dir1/dir2/myControls/PieChart.as, and dir1 is included in the ActionScript classpath, its
fully qualified package name must be dir1.dir2.myControls.
■ The <mx:Script> tag in the main MXML file, and in dependent MXML component
files, can reference components located in the ActionScript classpath.

Compiling components with Flex SDK

How you compile an application with Adobe® Flex™ SDK is based on how you distribute your
custom components. This section describes how to compile an application that uses custom
components distributed as MXML, ActionScript, SWC, and RSL files.

Distributing components as MXML and

ActionScript files
When you compile an application with Flex SDK, you define where the MXML and
ActionScript files for your custom components exist in the directory structure of your
application, or in the directory structure of components shared by multiple applications.

66 Compiling Components
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
For example, you can create a component for use by a single application. In that case, you
store it in the directory structure of the application, usually in a subdirectory under the
directory that contains the main file of the application. The component is then compiled with
the entire application into the resultant SWF file.
You can also create a component that is shared among multiple applications as an MXML or
ActionScript file. In that case, store the component in a location that is included in the
ActionScript classpath of the application. When Flex compiles the application, it also
compiles the components included in the application’s ActionScript classpath.
You specify the directory location of the shared components by using one of the following
methods:
Flex Builder Open the Project Properties dialog box, and then select Flex Build Path to set
the ActionScript classpath.
Command-line compiler Use the source-path option to the mxmlc compiler to specify
the directory location of your shared MXML and ActionScript files.

Distributing components as SWC files

A SWC file is an archive file of Flex components. SWC files make it easy to exchange
components among Flex developers. You need to exchange only a single file, rather than the
MXML or ActionScript files, images, and other resource files. In addition, the SWF file inside
a SWC file is compiled, which means that the code is hidden from casual view. Finally,
compiling a component as a SWC file can make namespace allocation an easier process.
SWC files can contain one or more components and are packaged and expanded with the
PKZIP archive format. You can open and examine a SWC file by using WinZip, JAR, or
another archiving tool. However, do not manually change the contents of a SWC file, and do
not try to run the SWF file that is in a SWC file outside of the SWC file.
When you compile your application, you specify the directory location of the SWC files by
using one of the following methods:
Flex Builder Open the Project Properties dialog box, and then select Flex Build Path to set
the library directories that contain the SWC files.
Command-line compiler Set the library-classpath option to the mxmlc compiler to
specify the directory location of your SWC files.
For more information about SWC files, see Chapter 9, “Using the Flex Compilers,” in
Building and Deploying Flex Applications, and Chapter 10, “Building Projects,” in Using Flex
Builder.

Compiling components with Flex SDK 67

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Distributing components as RSLs
One way to reduce the size of your application’s SWF file is by externalizing shared assets into
stand-alone files that can be separately downloaded and cached on the client. These shared
assets are loaded by any number of applications at run time, but must be transferred to the
client only once. These shared files are known as Runtime Shared Libraries (RSLs).
If you have multiple applications but those applications share a core set of components or
classes, your users download those assets only once as an RSL. The applications that share the
assets in the RSL use the same cached RSL as the source for the libraries as long as they are in
the same domain. By using an RSL, you can reduce the resulting file size for your
applications. The benefits increase as the number of applications that use the RSL increases. If
you only have one application, putting components into RSLs does not reduce the aggregate
download size, and may increase it.
When you compile your application, you specify the directory location of an RSL file by using
one of the following methods:
Flex Builder Open the Project Properties dialog box, and then select Flex Build Path to set
the library directories that contain the SWC files.
Command-line compiler Set the external-library-path option to the mxmlc compiler
to specify the location of the RSL file at compile time. Set the runtime-shared-libraries
option to the mxmlc compiler to specify the relative location of the RSL file when the
application is deployed.
For more information, including information on how to create an RSL file, see Chapter 11,
“Using Runtime Shared Libraries,” in Building and Deploying Flex Applications.

Example: Compiling a custom formatter component

This section contains an example that uses a custom formatter component that is defined as
an ActionScript file. The name of the formatter is MySimpleFormatter, and it is defined in the
file MySimpleFormatter.as. For more information on creating customer formatter
components, see Chapter 13, “Creating Custom Formatters,” on page 209.
The process for compiling an MXML file is the same as for an ActionScript file. For an
example of deploying an MXML file, see Chapter 7, “Creating Simple MXML Components,”
on page 77.

68 Compiling Components
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Distributing a component as an ActionScript file
When you distribute a component defined as an ActionScript file, you can store it within the
same directory structure as your application files, or in a directory specified in the
ActionScript classpath.
The MXML tag name for a custom component consists of two parts: the namespace prefix
and the tag name. The namespace prefix tells Flex where to look for the file that implements
the custom component. The tag name corresponds to the filename of the component, in this
case MySimpleFormatter.as. Therefore, a file MySimpleFormatter.as defines a component
with the tag name of <namespace:MySimpleFormatter>.
The main application MXML file defines the namespace prefix used to reference the
component in the <mx:Application> tag. When you deploy your formatter as an
ActionScript file, you refer to it in one of the following ways:
■ If you store the formatter component in the same directory as the application file, or in a
directory that the ActionScript classpath (not a subdirectory) specifies, you define the
formatter by using an empty package statement, as the following example shows:
package
{
//Import base Formatter class.
import mx.formatters.Formatter

public class MySimpleFormatter extends Formatter {

...
}
}

You can refer to it as the following example shows. In this example, the local namespace
(*) is mapped to the prefix MyComp.
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="*">

<MyComp:MySimpleFormatter/>

</mx:Application>

If the same file exists in the ActionScript classpath directory and the application directory,
Flex uses the file in the application directory.
■ If you store the formatter component in a subdirectory of the directory that contains the
application file, you specify that directory as part of the package statement, as the
following example shows:
package myComponents.formatters
{
//Import base Formatter class

Compiling components with Flex SDK 69

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
import mx.formatters.Formatter

public class MySimpleFormatter extends Formatter {

...
}
}

In this example, the MySimpleFormatter.as file is located in the

myComponents/formatter subdirectory of the main application directory. You map the
myComponents.formatters namespace to the MyComp prefix, as the following example
shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.formatters.*">

<MyComp:MySimpleFormatter/>

</mx:Application>

If multiple files with the same name exist under an ActionScript classpath subdirectory
and the application subdirectory, Flex uses the file under the application subdirectory.
■ If you store the formatter component in a subdirectory of the ActionScript classpath
directory, you specify that subdirectory as part of the package statement, as the following
example shows:
package flexSharedRoot.custom.components
{
//Import base Formatter class.
import mx.formatters.Formatter

public class MySimpleFormatter extends Formatter {

...
}
}

You then use a namespace that specifies the subdirectory. The following code declares a
component that is in the flexSharedRoot/custom/components directory:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="flexSharedRoot.custom.components.*"/>

<MyComp:MySimpleFormatter/>

</mx:Application>

If the same file exists in the ActionScript classpath directory and the application directory,
Flex uses the file in the application file directory.

70 Compiling Components
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Distributing a component as a SWC file
To create a SWC file, use the compc utility in the flex_install_dir/bin directory. The compc
utility generates a SWC file from MXML component source files and/or ActionScript
component source files.
In this example, you create a SWC file for a custom formatter component that you defined by
using the following package and class definition:
package myComponents.formatters
{
//Import base Formatter class.
import mx.formatters.Formatter

public class MySimpleFormatter extends Formatter {

...
}
}

In this example, the MySimpleFormatter.as file is in the directory

c:\flex\myComponentsForSWCs\myComponents\formatters.
You use the following compc command from the flex_install_dir/bin directory to create the
SWC file for this component:
.\compc -source-path c:\flex\myComponentsForSWCs\
-include-components myComponents.formatters.MySimpleFormatter
-o c:\flex\mainApp\MyFormatterSWC.swc

In this example, you use the following options of the compc compiler:

Option name Description

-source-path Specifies the base directory location of the MySimpleFormatter.as
file. It does not include the directories that the component’s
package statement defines.
-include-components Specifies the component to add to the SWC file, and includes the
information that the package statement specifies.
-o Specifies the name and directory location of the output SWC file. In
this example, the directory is c:\flex\mainApp, the directory that
contains your main application.

In your main application file, you specify the component’s namespace, as the following
example shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.formatters.*">

<MyComp:MyFormatter/>

Compiling components with Flex SDK 71

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

</mx:Application>

When you distribute SWC files, ensure that the corresponding ActionScript file is not in the
directory structure of the application or in the ActionScript classpath. Otherwise, Flex might
use the ActionScript file, rather than the SWC file.
When you use mxmlc to compile the main application, ensure that the c:\flex\mainApp
directory is included in the library path, otherwise mxmlc cannot locate the SWC file.
For more information about SWC files, see Chapter 9, “Using the Flex Compilers,” in
Building and Deploying Flex Applications, and Chapter 10, “Building Projects,” in Using Flex
Builder.

Distributing a component as an RSL file

You create an RSL by using the compc tool, and then pass the library’s location to the
compiler when you compile your application. For more information, including an example,
see Chapter 11, “Using Runtime Shared Libraries,” in Building and Deploying Flex
Applications.

Compiling components with LiveCycle

Data Services ES
If you have Adobe® Flex™ Data Services, you can compile your application, and any custom
components, in the same way that you can when using Flex SDK. For more information, see
“Compiling components with Flex SDK” on page 66. Alternatively, you can deploy your
application on your application server, and then compile the application upon an HTTP
request.
To deploy the application on your application server, copy the MXML and ActionScript files
to a web application directory. The first time a user requests the MXML file URL in a web
browser, the server compiles the MXML code into a SWF file. The server then sends the SWF
file to the web browser where it is rendered in Flash® Player. Unless the MXML or
ActionScript file changes, the SWF file is not recompiled on subsequent requests.
Typically, you copy these components to a subdirectory of the WEB-INF directory for the
web application that corresponds to your LiveCycle Data Services ES application. For
example, you can copy custom ActionScript classes and MXML components to the WEB-
INF/flex/user_classesdirectory.

72 Compiling Components
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Distributing components as MXML and
ActionScript files
You can deploy your components as MXML and ActionScript files by copying them to the
/WEB-INF/flex/user_classes directory, or to a directory included in the ActionScript
classpath. You set the ActionScript classpath by using the <source-path> tag in the flex-
config.xml file.
For more information, see Chapter 15, “Deploying Flex Applications,” in Building and
Deploying Flex Applications.

Distributing components as SWC files

To deploy an MXML or ActionScript component as a SWC file on your application server,
copy the SWC file to the WEB-INF/flex/user_classes directory, or to any directory specified
by the <library-path> tag in the flex-config.xml file. When you deploy the SWC file,
ensure that the corresponding MXML or ActionScript file is nowhere in the directory
structure of the application or in the ActionScript classpath. Otherwise, Flex might use the
MXML file, rather than the SWC file.
For more information, see Chapter 15, “Deploying Flex Applications,” in Building and
Deploying Flex Applications.

Distributing components as RSLs

To deploy an MXML or ActionScript component as an RSL file on your application server,
copy the RSL file to the directory specified by the <runtime-shared-libraries> tag in the
flex-config.xml file.
For more information, see Chapter 15, “Deploying Flex Applications,” in Building and
Deploying Flex Applications.

Compiling components with LiveCycle Data Services ES 73

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

74 Compiling Components
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

2
PART 2

Creating MXML Components

This part describes how to create custom Flex components in MXML.

The following topics are included:
Chapter 7: Creating Simple MXML Components . . . . . . . . . . . . . . 77
Chapter 8: Creating Advanced MXML Components . . . . . . . . . . . 91

75
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 7

Creating Simple MXML

Components
7
Adobe Flex applications typically consist of multiple MXML and ActionScript files, and each
MXML file is a separate MXML component. MXML components let you encapsulate
functionality in a reusable component, extend an existing Flex component by adding new
functionality to it, and reference the MXML component by using an MXML tag.
This topic describes how to create simple MXML components. For information on advanced
techniques for creating MXML components, see Chapter 8, “Creating Advanced MXML
Components,” on page 91.

Contents
About MXML components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Scoping in custom components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Applying styles to your custom component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

About MXML components

In typical Flex applications, you do not code the entire application within a single source code
file. Such an implementation makes it difficult for multiple developers to work on the project
simultaneously, makes it difficult to debug, and discourages code reuse.
Instead, you develop Flex applications using multiple MXML and ActionScript files. This
architecture promotes a modular design, code reuse, and lets multiple developers contribute
to the implementation.
MXML components are MXML files that you reference by using MXML tags from within
other MXML files. One of the main uses of MXML components is to extend the
functionality of an existing Flex component.

77
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
For example, Flex supplies a ComboBox control that you can use as part of a form that
collects address information from a customer. You can use a ComboBox to let the user select
the State portion of the address from a list of the 50 states in the U.S. In an application that
has multiple locations where a user can enter an address, it would be tedious to create and
initialize multiple ComboBox controls with the information about all 50 states.
Instead, you create an MXML component that contains a ComboBox control with all 50
states defined within it. Then, wherever you must add a state selector to your application, you
use your custom MXML component.

Creating MXML components

An application that uses MXML components includes a main MXML application file, which
contains the <mx:Application> root tag, and references one or more components that are
defined in separate MXML and ActionScript files. Each MXML component extends an
existing Flex component, or another MXML component.
You create an MXML component in an MXML file where the component’s filename becomes
its MXML tag name. For example, a file named StateComboBox.mxml defines a component
with the tag name of <StateComboBox>.
The root tag of an MXML component is a component tag, either a Flex component or
another MXML component. The root tag specifies the http://www.adobe.com/2006/mxml
namespace. For example, the following MXML component extends the standard Flex
ComboBox control.
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml">

<mx:dataProvider>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>

</mx:dataProvider>
</mx:ComboBox>
As part of its implementation, a custom MXML component can reference another custom
MXML component.

78 Creating Simple MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The main application, or any other MXML component file, references the StateComboBox
component, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="*">

<MyComp:StateComboBox/>

</mx:Application>
In this example, the main application file includes a new namespace definition of
xmlns:MyComp="*" as part of the <mx:Application> tag. This namespace definition
specifies the location of the MXML component. In this case, it specifies that the component
is in the same directory as the main application file or, if you are using LiveCycle Data
Services ES, in the WEB-INF/flex/user-classes directory.
As a best practice, store your components in a subdirectory. For example, you can write this
file to the myComponents directory, a subdirectory of your main application directory. For
more information on the namespace, see Chapter 2, “Developing Applications in MXML,” in
Flex Developer’s Guide.

About MXML components 79

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The StateComboBox.mxmlfile specifies the ComboBox control as its root tag, so you can
reference all of the properties of the ComboBox control within the MXML tag of your
custom component, or in the ActionScript specified within an <mx:Script> tag. For
example, the following example specifies the rowCount property and a listener for the close
event for your custom control:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:local="*">

<mx:Script>
<![CDATA[

import flash.events.Event;

private function handleCloseEvent(eventObj:Event):void {

myTA.text="foo";

}
]]>
</mx:Script>

<local:StateComboBox rowCount="5" close="handleCloseEvent(event);"/>

<mx:TextArea id="myTA" />

</mx:Application>

MXML components and ActionScript classes

When you create a custom MXML component, you define a new ActionScript class where the
class name corresponds to the filename of the MXML component. Your new class is a subclass
of the component’s root tag and, therefore, inherits all of the properties and methods of the
root tag. However, because you are defining the component in MXML, many of the
intricacies of creating an ActionScript class are hidden from you.
For example, in “Creating MXML components” on page 78, you defined the component
StateComboBox.mxml by using the <mx:ComboBox> tag as its root tag. Therefore,
StateComboBox.mxml defines a subclass of the ComboBox class.

80 Creating Simple MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Creating composite MXML components
A composite MXML component is a component that contains multiple component
definitions within it. To create a composite component, you specify a container as its root tag,
and then add Flex components as children of the container.
For example, the following component contains an address form created by specifying a Form
container as the root tag of the component, and then defining several children of the Form
container. One of the <mx:FormItem> tags contains a reference to the
<MyComp:StateComboBox> tag that you created in “Creating MXML components”
on page 78:
<?xml version="1.0"?>

<mx:Form xmlns:mx="http://www.adobe.com/2006/mxml" xmlns:MyComp="*">

<mx:FormItem label="NameField">
<mx:TextInput/>
</mx:FormItem>

<mx:FormItem label="Street">
<mx:TextInput/>
</mx:FormItem>

<mx:FormItem label="City" >

<mx:TextInput/>
</mx:FormItem>

<mx:FormItem label="State" >

<MyComp:StateComboBox/>
</mx:FormItem>

</mx:Form>
The following application file references the AddressForm component in the <AddressForm>
tag:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="*" >

<MyComp:AddressForm/>

</mx:Application>

About MXML components 81

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
If you include child tags of the root container tag in an MXML component file, you cannot
add child tags when you use the component as a custom tag in another MXML file. If you
define an empty container in an MXML file, you can add child tags when you use the
component as a custom tag.
NO TE

The restriction on child tags refers to the child tags that correspond to visual
components. Visual components are subclasses of the UIComponent component. You
can always insert tags for nonvisual components, such as ActionScript blocks, styles,
effects, formatters, validators, and other types of nonvisual components, regardless of
how you define your custom component.

The following example defines an empty Form container in an MXML component:

<?xml version="1.0"?>

<mx:Form xmlns:mx="http://www.adobe.com/2006/mxml"/>
This component defines no children of the Form container, therefore, you can add children
when you use it in another MXML file, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="*">

<MyComp:EmptyForm>
<mx:FormItem label="Name">
<mx:TextInput/>
</mx:FormItem>
</MyComp:EmptyForm>

</mx:Application>
The AddressForm.mxml file specifies the Form container as its root tag. Because you define a
container as the root tag of the MXML component, you are creating a subclass of that
container, and you can reference all of the properties and methods of the root tag when using
your MXML component. Therefore, in the main application, you can reference all of the
properties of the Form container in the MXML tag that corresponds to your custom
component, or in any ActionScript code in the main application. However, you cannot
reference properties of the children of the Form container.

82 Creating Simple MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
For example, the following example sets the horizontalPageScrollSize property and a
listener for the scroll event for your custom control, but you cannot specify properties for
the child CheckBox or TextInput controls of the Form container:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="*">

<mx:Script>
<![CDATA[
import mx.events.ScrollEvent;

private function handleScrollEvent(event:ScrollEvent):void {

// Handle scroll event.
}
]]>
</mx:Script>

<MyComp:AddressForm horizontalPageScrollSize="25"
scroll="handleScrollEvent(event);"/>

</mx:Application>
To configure the children of a custom MXML component, you define new properties in the
MXML component, and then use those new properties to pass configuration information to
the component children. For more information, see Chapter 8, “Creating Advanced MXML
Components,” on page 91.

Scoping in custom components

Scoping is mostly a description of what the this keyword refers to at any given point in your
application. In an <mx:Script> tag in an MXML file, the this keyword always refers to the
current scope. In the main application file, the file that contains the <mx:Application> tag,
the current scope is the Application object; therefore, the this keyword refers to the
Application object.
In an MXML component, Flex executes in the context of the custom component. The
current scope is defined by the root tag of the file. So, the this keyword refers not to the
Application object, but to the object defined by the root tag of the MXML file.
For more information on scoping, see Chapter 4, “Using ActionScript,” in Flex Developer’s
Guide.

Scoping in custom components 83

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The root tag of an MXML component cannot contain an id property. Therefore, if you refer
to the object defined by the root tag in the body of the component, you must use the this
keyword, as the following example shows:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
close="handleCloseEvent(event);">

<mx:Script>
<![CDATA[

import flash.events.Event;

// Define a property to hold the current index.

public var stateIndex:Number;

private function handleCloseEvent(eventObj:Event):void {

stateIndex = this.selectedIndex;
}
]]>
</mx:Script>

<mx:dataProvider>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:dataProvider>
</mx:ComboBox>
This example defines an event listener for the ComboBox control that updates the
stateIndex property when the ComboBox control closes.

Applying styles to your custom

component
Along with skins, styles define the look and feel (appearance) of your Flex applications. You
can use styles to change the appearance of a single component, or apply them across all
components.
When working with custom components, you have several options for how you use styles.
You can define your custom components so that they contain no style information at all. That
design allows the application developer who is using your component to apply styles to match
the rest of their application. For example, if you define a custom component to display text,
the application developer can style it to ensure that the font, font size, and font style of your
component match the rest of the application.

84 Creating Simple MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Alternatively, you might develop a component that you want to deploy with a built-in look so
that it is not necessary for application developers to apply any additional styles to it. This type
of component might be useful for applications that require a header or footer with a fixed
look, while the body of the application has more flexibility in its look.
Or, you might develop a custom component by using a combination of these approaches.
This type of design lets application developers set some styles, but not others.
This section describes several options for applying styles to your custom components. For
general information on Flex styles, see Chapter 20, “Using Styles and Themes,” in Flex
Developer’s Guide. For information on creating custom styles, see Chapter 11, “Creating
Custom Style Properties,” on page 185.

Applying styles from the custom component

You can choose to define styles within your MXML component so that the component has
the same appearance whenever it is used, and application developers do not have to worry
about applying styles to it.
In the definition of your custom component, you define styles by using one or both of the
following mechanisms:
■ Tag properties
■ Class selectors
The following custom component defines a style by using a tag property of the ComboBox
control:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
openDuration="1000"
fontSize="15">

<mx:dataProvider>
<mx:Array>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:Array>
</mx:dataProvider>
</mx:ComboBox>

Applying styles to your custom component 85

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Alternatively, you can define these styles by using a class selector style declaration, as the
following example shows:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
styleName="myCBStyle">

<mx:Style>
.myCBStyle {
openDuration : 1000;
fontSize : 15;
}
</mx:Style>

<mx:dataProvider>
<mx:Array>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:Array>
</mx:dataProvider>
</mx:ComboBox>
NO TE

You cannot define a type selector in an MXML component. If you define a type selector,
a compiler error occurs.

Application developers can apply additional styles to the component. For example, if your
component defines styles for the open duration and font size, application developers can still
specify font color or other styles. The following example uses
StateComboBoxWithStyleProps.mxml in an application and specifies the font color style for
the control:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:StateComboBoxWithStyleProps color="red"/>

</mx:Application>

Applying styles from the referencing file

When you reference an MXML component, the referencing file can specify style definitions
to the MXML component by using the following mechanisms:
■ Tag properties

86 Creating Simple MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
■ Class selectors
■ Type selectors
The styles that application developers can apply correspond to the styles supported by the root
tag of the MXML component. The following example uses a tag property to set a style for the
custom MXML component:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:StateComboBoxWithStyleProps openDuration="1000"/>

</mx:Application>
When you specify styles as tag attributes, those styles override any conflicting styles set in the
definition of the MXML component.
You can use a class selector to define styles. Often you use a class selector to apply styles to
specific instances of a control, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Style>
.myStateComboBox {
openDuration : 1000;
}
</mx:Style>

<MyComp:StateComboBoxWithStyleProps styleName="myStateComboBox"/>
<mx:ComboBox>
...
</mx:ComboBox>
</mx:Application>
In this example, you use the styleName property in the tag definition of an MXML
component to apply styles to a specific instance of the MXML component. However, those
styles are not applied to the ComboBox control defined in the main application file, nor
would they be applied to any other instances of StateComboBox.mxml unless you also specify
the styleName property as part of defining those instances of the MXML component.
When you specify any styles by using a class selector, those styles override all styles that you set
by using a class selector in the MXML file. Those styles do not override styles that you set by
using tag properties in the MXML file.

Applying styles to your custom component 87

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can also use a type selector to define styles. A type selector applies styles to all instances of
a component, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Style>
StateComboBoxWithStyleProps {
openDuration : 1000;
}
</mx:Style>

<MyComp:StateComboBoxWithStyleProps/>
</mx:Application>
In this example, the type selector specifies the openDuration style for all instances of the
StateComboBox control in the application. When you specify any styles by using a type
selector, those styles override all styles that you set by using a class selector in the MXML file.
Those styles do not override styles that you set by using tag properties in the MXML file.

88 Creating Simple MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Applying a type selector to the root tag of a custom
component
All custom components contain a root tag that specifies the superclass of the component. In
the case of StateComboBox.mxml, the root tag is <mx:ComboBox>. If you define a type
selector for the ComboBox control, or for a superclass of the ComboBox control, in your
main application file, that style definition is also applied to any custom component that uses a
ComboBox control as its root tag, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Style>
ComboBox {
openDuration: 1000;
fontSize: 15;
color: red;
}
</mx:Style>

<MyComp:StateComboBoxWithStyleProps/>
<mx:ComboBox/>

</mx:Application>
In this example, all ComboBox controls and all StateComboBox.mxml controls have an
openDuration of 1000 ms, fontSize of 15 points, and red text.

Applying styles to your custom component 89

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
If you define a type selector for a superclass of the custom control, and for the custom control
itself, Flex ignores any conflicting settings from the type selector for the superclass, as the
following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Style>
ComboBox {
color: red;
openDuration: 1000;
fontSize: 15;
}
StateComboBoxWithStyleProps {
color: green;
}
</mx:Style>

<MyComp:StateComboBoxWithStyleProps/>
<mx:ComboBox/>
</mx:Application>
In this example, the StateComboBox control uses green text, and the values for the fontSize
and openDuration styles specified in the type selector for the ComboBox control.

90 Creating Simple MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 8

Creating Advanced MXML

Components
8
One of the common goals when you create MXML components is to create configurable and
reusable components. For example, you might want to create MXML components that take
properties, dispatch events, define new style properties, have custom skins, or use other
customizations.
This topic describes advanced techniques for creating advanced MXML components. For
information about how to create and deploy simple MXML components, including how to
apply styles and skins to your MXML components, see the topic Chapter 7, “Creating Simple
MXML Components,” on page 77.

Contents
About reusable MXML components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Adding custom properties and methods to a component . . . . . . . . . . . . . . . . . . . . . . 92
Working with events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
About interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

About reusable MXML components

One design consideration when you create custom MXML components is reusability. That is,
do you want to create a component that is tightly coupled to your application, or create one
that is reusable in multiple applications?
A tightly coupled component is written for a specific application, often by making it
dependent on the application’s structure, variable names, or other details. If you change the
application, you might have to modify a tightly coupled component to reflect that change. A
tightly coupled component is often difficult to use in another application without rewriting it.
You design a loosely coupled component for reuse. A loosely coupled component has a well-
defined interface that specifies how to pass information to the component, and how the
component passes back results to the application.

91
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
With loosely coupled components, you typically define properties of the component to pass
information to it. These properties, defined by using variables or setter and getter methods,
specify the data type of the parameter value. For more information about defining component
properties, see “Adding custom properties and methods to a component” on page 92.
The best practice for defining components that return information back to the main
application is to design the component to dispatch an event that contains the return data. In
that way, the main application can define an event listener to handle the event and take the
appropriate action. For more information on dispatching events, see “Working with events”
on page 107.

Adding custom properties and methods

to a component
MXML components provide you with a simple way to create ActionScript classes. When
defining classes, you use class properties to store information and class methods to define class
functionality. When creating MXML components, you can also add properties and methods
to the components.
One of the reasons that you add properties and methods to your components is to make them
configurable. By allowing the user to pass information to the components, you can create a
reusable component that you can use in multiple locations throughout your application, or in
multiple applications.
This section describes how to define properties of MXML components in MXML tags or as
ActionScript variables, and how to define new methods of an MXML component by using
ActionScript functions.

Defining properties and methods in MXML

components
You can define methods for your MXML components in ActionScript, and properties in
ActionScript or MXML. The Flex compiler converts the MXML component into an
ActionScript class, so there is no performance difference between defining a property in
MXML and defining it in ActionScript.

92 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Defining properties and methods in ActionScript
With ActionScript, you define properties and methods by using the same syntax that you use
in an ActionScript class. For more information on using ActionScript to define properties and
methods, see Chapter 3, “Using ActionScript to Create Components,” on page 25.
When using ActionScript, you place a property or method definition within an <mx:Script>
block. The <mx:Script> tag must be an immediate child tag of the root tag of the MXML
file. A public variable declaration or a set function in an <mx:Script> tag becomes a property
of the component. A public ActionScript function in an <mx:Script> tag becomes a method
of the component.
In the following example, the component defines two data providers to populate the
ComboBox control, and a function to use as the event listener for the creationComplete
event. This function sets the data provider of the ComboBox based on the value of the
shortNames property. By default, the shortNames property is set to true, to display two-
letter names:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
creationComplete="setNameLength();">

<mx:Script>
<![CDATA[

// Define public variables.

public var shortNames:Boolean = true;

// Define private variables.

private var stateArrayShort:Array = ["AK", "AL"];
private var stateArrayLong:Array = ["Arkansas", "Alaska"];

// Define listener method.

public function setNameLength():void {
if (shortNames) {
dataProvider=stateArrayShort; }
else {
dataProvider=stateArrayLong; }
}
]]>
</mx:Script>
</mx:ComboBox>

Adding custom properties and methods to a component 93

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following MXML application file uses the <MyComp:StateComboBoxPropAS> tag to
configure the control to display long state names:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:StateComboBoxPropAS shortNames="true"/>

</mx:Application>
The following example modifies the component to add a method that lets you change the
display of the state name at run time. This public method takes a single argument that
specifies the value of the shortNames property:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
creationComplete="setNameLength();">

<mx:Script>
<![CDATA[

// Define public variables.

public var shortNames:Boolean = true;

// Define private variables.

private var stateArrayShort:Array = ["AK", "AL"];
private var stateArrayLong:Array = ["Arkansas", "Alaska"];

public function setNameLength():void {

if (shortNames) {
this.dataProvider=stateArrayShort; }
else {
this.dataProvider=stateArrayLong; }
}

public function setShortName(val:Boolean):void {

shortNames=val;
if (val) {
dataProvider=stateArrayShort; }
else {
dataProvider=stateArrayLong; }
}
]]>
</mx:Script>
</mx:ComboBox>

94 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You might use this new method with the click event of a Button control to change the
display from long names to short names, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:StateComboBoxPropMethod id="myCB" shortNames="false"/>

<mx:Button label="Use Short Names" click="myCB.setShortName(true);"/>

</mx:Application>

Defining properties in MXML

In MXML, you can use an MXML tag to define a property of any type, as long as the type
refers to an ActionScript class name. For example, you can use the <mx:String>,
<mx:Number>, and <mx:Boolean> tags to define properties in your MXML components that
take String, Number, or Boolean values, respectively. When using one of these tags, you must
specify an id, which becomes the property name.
Optionally, you can specify an initial value in the body of the tag, or you can use the source
property to specify the contents of an external URL or file as the initial property value. If you
use the source property, the body of the tag must be empty. The initial value can be static
data or a binding expression.
The following examples show initial properties set as static data and binding expressions;
values are set in the tag bodies and in the source properties:

<mx:Boolean id="myBooleanProperty">true</mx:Boolean>
<mx:Boolean id="passwordStatus">{passwordExpired}</mx:Boolean>

<mx:Number id="myNumberProperty">15</mx:Number>
<mx:Number id="minutes">{numHours * 60}</mx:Number>

<mx:String id="myStringProperty">Welcome, {CustomerName}.</mx:String>
<mx:String id="myStringProperty1" source="./file"/>

All properties defined by using the <mx:String>, <mx:Number>, and <mx:Boolean> tags are
public. This means that the component user can access these properties.

Adding custom properties and methods to a component 95

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example modifies the example in “Defining properties and methods in
ActionScript” on page 93 to define the shortNames property by using an MXML tag, rather
than an ActionScript variable definition:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
creationComplete="setNameLength();">

<mx:Boolean id="shortNames">true</mx:Boolean>

<mx:Script>
<![CDATA[

// Define private variables.

private var stateArrayShort:Array = ["AK", "AL"];
private var stateArrayLong:Array = ["Arkansas", "Alaska"];

// Define listener method.

public function setNameLength():void {
if (shortNames) {
dataProvider=stateArrayShort; }
else {
dataProvider=stateArrayLong; }
}
]]>
</mx:Script>
</mx:ComboBox>
In the preceding example, you implement the StateComboBox.mxml file by using the
<mx:Boolean> tag to add a new property, shortNames, with a default value of true. This
property controls whether the ComboBox control displays state names that use a two-letter
format, or the entire state name.

Defining properties by using setters and getters

You can define properties for your MXML components by using setter and getter methods.
The advantage of getters and setters is that they isolate the variable from direct public access
so that you can perform the following tasks:
■ Inspect and validate any data written to the property on a write
■ Trigger events that are associated with the property when the property changes
■ Calculate a return value on a read

96 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
For more information, see Chapter 3, “Using ActionScript to Create Components,” on
page 25.
In the following example, the StateComboBoxGetSet.mxml component contains several new
properties and methods:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml">

<mx:Script>
<![CDATA[

// Define private variables.

private var stateArrayShort:Array = ["AK", "AL"];
private var stateArrayLong:Array = ["Arkansas", "Alaska"];

// Variable holding the display setting.

private var __shortNames:Boolean = true;

// Set method.
public function set shortNames(val:Boolean):void {
// Call method to set the dataProvider
// based on the name length.
__shortNames = val;
if (__shortNames) {
this.dataProvider=stateArrayShort; }
else {
this.dataProvider=stateArrayLong; }
}

// Get method.
public function get shortNames():Boolean{
return __shortNames;
}
]]>
</mx:Script>
</mx:ComboBox>
In this example, you create a StateComboBoxGetSet.mxml control that takes a shortNames
property defined by using ActionScript setter and getter methods. One advantage to using
setter and getter methods to define a property is that the component can recognize changes to
the property at run time. For example, you can give your users the option of displaying short
state names or long state names from the application. The setter method modifies the
component at run time in response to the user’s selection.

Adding custom properties and methods to a component 97

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can also define events to be dispatched when a property changes. This enables you to
signal the change so that an event listener can recognize the change. For more information on
events, see “Working with events” on page 107.
You can call a component’s custom methods and access its properties in ActionScript just as
you would any instance method or component property, as the following application shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:StateComboBoxSetGet id="myStateCB" shortNames="true"/>

<mx:Button click="myStateCB.shortNames=!myStateCB.shortNames;"/>

</mx:Application>
In this example, selecting the button toggles the display format of the state name between the
short and long formats.

Defining inspectable properties

You should precede the variable or set function with the [Inspectable] metadata tag if you
plan to use the component in an authoring tool such as Adobe Flex Builder. The
[Inspectable] metadata tag must immediately precede the property’s variable declaration or
the setter and getter methods to be bound to that property, as the following example shows:
<mx:Script>
<![CDATA[

// Define public variables.

[Inspectable(defaultValue=true)]
public var shortNames:Boolean = true;

]]>
</mx:Script>

For more information on the [Inspectable] metadata tag, see Chapter 5, “Using Metadata
Tags in Custom Components,” on page 45.

98 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Supporting data binding in custom properties
The Flex data binding mechanism provides a syntax for automatically copying the value of a
property of one object to a property of another object at run time. The following example
shows a Text control that gets its data from Slider control’s value property. The property
name inside the curly braces ({ }) is a binding expression that copies the value of the source
property, mySlider.value, to the destination property, the Text control’s text property, as
the following example shows:
<mx:Slider id="mySlider"/>
<mx:Text text="{mySlider.value}"/>

Data binding is usually triggered whenever the value of the source property changes.
Properties that you define in your custom controls can also take advantage of data binding.
You can automatically use any property defined by using an MXML tag, such as
<mx:Boolean>, and any ActionScript property defined as a variable or defined by using setter
and getter methods as the destination of a binding expression.
For example, “Defining properties by using setters and getters” on page 96 defined the
shortNames property of StateComboBoxGetSet.mxml by using setter and getter methods.
With no modification to that component, you can use shortNames as the destination of a
binding expression, as the following example shows:
<MyComp:StateComboBoxSetGet shortNames="{some_prop}"/>

However, you can also write your component to use the shortNames property as the source of
a binding expression, as the following example shows for the nex component
StateComboBoxGetSetBinding.mxml:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:StateComboBoxSetGetBinding id="myStateCB" shortNames="false"/>

<mx:TextArea text="The value of shortNames is {myStateCB.shortNames}"/>

<mx:Button click="myStateCB.shortNames=!myStateCB.shortNames;"/>

</mx:Application>

Adding custom properties and methods to a component 99

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
When a property is the source of a data binding expression, any changes to the property must
signal an update to the destination property. The way to signal that change is to dispatch an
event, as the following example shows:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml">

<mx:Script>
<![CDATA[

import flash.events.Event;

private var stateArrayShort:Array = ["AK", "AL"];

private var stateArrayLong:Array = ["Arkansas", "Alaska"];

private var __shortNames:Boolean = true;

public function set shortNames(val:Boolean):void {

__shortNames = val;
if (__shortNames) {
dataProvider=stateArrayShort; }
else {
dataProvider=stateArrayLong; }
// Create and dispatch event.
dispatchEvent(new Event("changeShortNames"));
}

// Include the [Bindable] metadata tag.

[Bindable(event="changeShortNames")]
public function get shortNames():Boolean {
return __shortNames;
}
]]>
</mx:Script>
</mx:ComboBox>

To use a property as the source of a data binding expression:

1. Define the property as a variable, or by using setter and getter methods.
You must define a setter method and a getter method if you use the [Bindable] tag with
the property.
2. Insert the [Bindable] metadata tag before the property definition, or before either the
setter or getter method, and optionally specify the name of the event dispatched by the
property when it changes.

100 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
If you omit the event name specification from the [Bindable] metadata tag, Flex
automatically generates and dispatches an event named propertyChange. If the property
value remains the same on a write, Flex does not dispatch the event or update the
property.
Alternatively, you can place the [Bindable] metadata before a public class definition.
This makes all public properties that you defined as variables, and all public properties
that you defined by using both a setter and a getter method, usable as the source of a
binding expression.
NOT E

When you use the [Bindable] metadata tag before a public class definition, it only
applies to public properties; it does not apply to private or protected properties, or to
properties defined in any other namespace. You must insert the [Bindable] metadata
tag before a nonpublic property to make it usable as the source for a data binding
expression.

3. Add a call to the dispatchEvent() method to dispatch the event when you define the
event name in the [Bindable] metadata tag.
For more information on using the [Bindable] tag, see “Bindable metadata tag” on page 51.

Passing references to properties of MXML

components
One of the ways that you can make a component reusable is to design it so that users can pass
values to the component by using public properties of the component. “Supporting data
binding in custom properties” on page 99 describes how to define properties for MXML
components by using MXML and ActionScript, and shows how to pass values to those
properties.
Rather than passing a value to a component, you can pass a reference to it. The reference
could be to the calling component, to another component, or to a property of a component.
This section describes several different ways of passing references to your components.

Accessing the Application object

The Application object is the top-level object in a Flex application. Often, you must reference
properties or objects of the Application object from your custom component. Use the
mx.core.Application.application static property to reference the application object.

Adding custom properties and methods to a component 101

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can also use the parentDocument property to reference the next object up in the
document chain of a Flex application. The parentDocument property is inherited by all
components from the UIComponent class. For an MXML component, the parentDocument
property references the Object corresponding to the component that referenced the MXML
component.
For more information on the mx.core.Application.application static property and the
the parentDocument property, see Chapter 16, “Using the Application Container,” on
page 601, in Flex Developer’s Guide.
Even if the calling file does not pass a reference to the Application object, you can always
access it from your MXML component. For example, the following application contains a
custom component called StateComboBoxDirectRef. In this example,
StateComboBoxDirectRef is designed to write the index of the selected item in the
ComboBox to the TextArea control:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:TextArea id="myTAMain"/>
<MyComp:StateComboBoxDirectRef/>

</mx:Application>

102 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The simplest way to write StateComboBoxDirectRef.mxml is to use the
mx.core.Application.application static property to write the index directly to the
TextArea control, as the following example shows:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
close="handleCloseEvent(event);">

<mx:Script>
<![CDATA[

import flash.events.Event;
import mx.core.Application;

public function handleCloseEvent(eventObj:Event):void {

mx.core.Application.application.myTAMain.text=
String(this.selectedIndex);
}
]]>
</mx:Script>

<mx:dataProvider>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:dataProvider>
</mx:ComboBox>
In the previous example, you use the close event of the ComboBox control to write the
selectedIndex directly to the TextArea control in the main application. You must cast the
value of selectedIndex to a String because the text property of the TextArea control is of
type String.

Adding custom properties and methods to a component 103

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You could make the custom component slightly more reusable by using the parentDocument
property to reference the TextArea control, rather than the
mx.core.Application.application static property. By using the parentDocument
property, you can call the custom component from any other MXML component that
contains a TextArea control named myTAMain, as the following example shows:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
close="handleCloseEvent(event);">

<mx:Script>
<![CDATA[

import flash.events.Event;

public function handleCloseEvent(eventObj:Event):void {

parentDocument.myTAMain.text=String(selectedIndex);
}
]]>
</mx:Script>

<mx:dataProvider>
<mx:Array>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:Array>
</mx:dataProvider>
</mx:ComboBox>
Although these examples work, they require that the TextArea control has a predefined id
property, and that MXML component knows that id. In this case, custom component is an
example of a tightly coupled component. That is, the component is written for a specific
application and application structure, and it not easily reused in another application.

104 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Passing a reference to the component
A loosely coupled component is a highly reusable component that you can easily use in
different places in one application, or in different applications. To make the component from
“Supporting data binding in custom properties” on page 99 reusable, you can pass a reference
to the TextArea control to the custom component, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:TextArea id="myTAMain" />

<MyComp:StateComboBoxPassRefToTA outputTA="{myTAMain}" />

</mx:Application>
The custom component does not have to know anything about the main application, other
than that it writes its results back to a TextArea control, as the following example shows:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
close="handleCloseEvent(event);">

<mx:Script>
<![CDATA[
import flash.events.Event;
import mx.controls.TextArea;

// Define a variable of type mx.controls.TextArea.

public var outputTA:TextArea;

public function handleCloseEvent(eventObj:Event):void {

outputTA.text=String(this.selectedIndex);
}
]]>
</mx:Script>

<mx:dataProvider>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:dataProvider>
</mx:ComboBox>
In this example, you use the Flex data binding syntax to pass the reference to the TextArea
control to your custom component. Now, you can use StateComboBoxPassRefToTA.mxml
anywhere in an application. The only requirement is that the calling component must pass a
reference to a TextArea control to the component.

Adding custom properties and methods to a component 105

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Passing a reference to the calling component
In “Passing a reference to the component” on page 105, you passed a reference to a single
component to the custom MXML component. This allowed the MXML component to access
only a single component in the main application.
One type of reference that you can pass to your component is a reference to the calling
component. With a reference to the calling component, your custom MXML file can access
any properties or object in the calling component.
To pass a reference to the calling component to a custom MXML component, you create a
property in the custom MXML component to represent the calling component. Then, from
the calling component, you pass a reference to the calling component to the custom MXML
component, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
horizontalAlign="left"
xmlns:MyComp="myComponents.*">

<!-- Use the caller property to pass a reference to the

calling component to DestinationComp. -->

<mx:Label text="Enter text"/>

<mx:TextInput id="text1" text="Hello"/>

<mx:Label text="Input text automatically copied to MXML component."/>

<MyComp:DestinationComp caller="{this}"/>

</mx:Application>
In the definition of DestinationComp.mxml, you define the caller property, and specify as
its data type the name of the file of the calling MXML file, as the following example shows:
<?xml version="1.0"?>

<mx:VBox xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
// Define variable to reference calling file.
[Bindable]
public var caller:CallingComponent;
]]>
</mx:Script>

<mx:TextInput id="mytext" text="{caller.text1.text}"/>

</mx:VBox>

106 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Remember, an MXML component corresponds to an ActionScript class, where the
ActionScript class name is the filename of the MXML component. Therefore, the MXML
component defines a new data type. You can then create a variable named whose data type is
that of the calling file.
With the reference to the calling file, your MXML component can access any property of the
calling file, and you can bind the value of the TextInput control in CallingComp.mxml to the
TextInput control in StateComboBox.mxml. Creating a property of type CallingComp
provides strong typing benefits and ensures that binding works correctly.

Working with events

Flex applications are event-driven. Events let a programmer know when the user interacts
with the interface, and also when important changes happen in the appearance or life cycle of
a component, such as the creation or destruction of a component or its resizing. This section
describes how to handle events that your custom components generate, and also how to add
your own event types to your custom components.

Handling events from simple MXML components

Simple MXML components are those that contain a single root tag that is not a container. In
this topic, the StateComboBox.mxml component is a simple component because it contains a
definition only for the ComboBox control.
You have two choices for handling events that a simple component dispatches: handle the
events within the definition of your MXML component, or allow the file that references the
component to handle them.

Working with events 107

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example uses the StateComboBox.mxml component, and defines the event
listener for the component’s close event in the main application:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" xmlns:MyComp="*">

<mx:Script>
<![CDATA[
import flash.events.Event;

public function handleCloseEvent(eventObj:Event):void {

...
}
]]>
</mx:Script>

<MyComp:StateComboBox rowCount="5" close="handleCloseEvent(event);"/>

</mx:Application>

In this example, if the MXML component dispatches a close event, the event listener in the
calling MXML file handles it.
Alternatively, you could define the event listener within the StateComboBox.mxml
component, as the following example shows:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
close="handleCloseEvent(event);">

<mx:Script>
<![CDATA[

import flash.events.Event;

public function handleCloseEvent(eventObj:Event):void {

...
}
]]>
</mx:Script>

<mx:dataProvider>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:dataProvider>
</mx:ComboBox>

108 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
With simple MXML components, you can define event listeners in both places, and both
event listeners process the event. However, the event listeners defined within the component
execute before any listeners defined in the application.

Creating custom events

All MXML components can dispatch events, either those inherited by the components from
their superclasses, or new events that you define within your components. When you are
developing MXML components, you can add your own event types.
In this example, you define a new component called TextAreaEnabled.mxml that uses a
<mx:TextArea> tag as its root tag. This component also defines a new property called
enableTA that users set to true to enable text input or to false to disable input.

The setter method dispatches a new event type, called enableChanged, when the value of the
enableTA variable changes. The [Event] metadata tag identifies the event to the MXML
compiler so that the file referencing the component can use the new property. For more
information on using the [Event] metadata keyword, see Chapter 5, “Using Metadata Tags
in Custom Components,” on page 45.
The syntax for the [Event] metadata tag is as follows:
<mx:Metadata>
[Event(name="eventName", type="eventType")]
</mx:Metadata>

Working with events 109

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You dispatch new event types by using the dispatchEvent() method, as the following
example shows:
<?xml version="1.0"?>

<mx:TextArea xmlns:mx="http://www.adobe.com/2006/mxml" >

<mx:Metadata>
[Event(name="enableChanged", type="flash.events.Event")]
</mx:Metadata>

<mx:Script>
<![CDATA[

import flash.events.Event;

// Define private variable to hold the enabled state.

private var __enableTA:Boolean;

// Define a setter method for the private variable.

public function set enableTA(val:Boolean):void {
__enableTA = val;
enabled = val;

// Define event object, initialize it, then dispatch it.

dispatchEvent(new Event("enableChanged"));
}

// Define a getter method for the private variable.

public function get enableTA():Boolean {
return __enableTA;
}
]]>
</mx:Script>
</mx:TextArea>

110 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following main application includes TextAreaEnabled.mxml and defines an event listener
for the enableChanged event:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Script>
<![CDATA[

import flash.events.Event;
import myComponents.TextAreaEnabled;

public function handleEnableChangeEvent(eventObj:Event):void {

var tempTA:TextAreaEnabled =
eventObj.currentTarget as TextAreaEnabled;
if (tempTA.enableTA) {
myButton.label="Click to disable";
}
else {
myButton.label="Click to enable";
}
}
]]>
</mx:Script>

<MyComp:TextAreaEnabled id="myTA" enableTA="false"

enableChanged="handleEnableChangeEvent(event);" />

<mx:Button id="myButton" label="Click to enable"

click="myTA.enableTA=!myTA.enableTA;" />

</mx:Application>
If you do not use the [Event] metadata tag in the custom component file to define the
enableChanged event, the MXML compiler generates an error message when you reference
the event name in an MXML file. Any component can register an event listener for the event
in ActionScript using the addEventListener() method, even if you omit the [Event]
metadata tag.
You can also create and dispatch events that use an event object of a type other than that
defined by the Event class. For example, you might want to create an event object that
contains new properties so that you can pass those properties back to the referencing file. To
do so, you create a subclass of the Event class to define your new event object. For information
on creating custom event classes, see Chapter 4, “Creating Custom Events,” on page 35.

Working with events 111

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Handling events from composite components
Composite components are components that use a container for the root tag, and define child
components in that container. You handle events generated by the root container in the same
way as you handle events generated by simple MXML components. That is, you can handle
the event within the MXML component, within the referencing file, or both. For more
information, see “Handling events from simple MXML components” on page 107.
To handle an event that a child of the root container dispatches, you can handle it in the
MXML component in the same way as you handle an event from the root container.
However, if a child component of the root container dispatches an event, and you want that
event to be dispatched to the referencing file, you must add logic to your custom component
to propagate the event.
For example, you can define a component that uses an <mx:Form> tag as the root tag, and
include within it a ComboBox control. Any event that the Form container dispatches, such a
scroll event, is dispatched to the referencing file of the custom component. However, the
close event of the ComboBox control is dispatched only within the custom MXML
component.

112 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
To propagate the close event outside of the custom component, you define an event listener
for it in the MXML component that redispatches it, as the following example shows:
<?xml version="1.0"?>

<mx:Form xmlns:mx="http://www.adobe.com/2006/mxml" xmlns:local="*">

<mx:Metadata>
[Event(name="close", type="flash.events.Event")]
</mx:Metadata>

<mx:Script>
<![CDATA[

import flash.events.Event;

// Redispatch event.
private function handleCloseEventInternal(eventObj:Event):void {
dispatchEvent(eventObj);
}
]]>
</mx:Script>

<mx:FormItem label="Name">
<mx:TextInput id="name1" />
</mx:FormItem>

<mx:FormItem label="Street">
<mx:TextInput id="street" />
</mx:FormItem>

<mx:FormItem label="City" >

<mx:TextInput id="city" />
</mx:FormItem>

<mx:FormItem label="State" >

<mx:ComboBox close="handleCloseEventInternal(event);">
<mx:dataProvider>
<mx:Array>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:Array>
</mx:dataProvider>
</mx:ComboBox>
</mx:FormItem>
</mx:Form>

Working with events 113

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In this example, you propagate the event to the calling file. You could, alternatively, create an
event type and new event object as part the propagation. For more information on the
[Event] metadata tag, see Chapter 5, “Using Metadata Tags in Custom Components,” on
page 45.
You can handle the close event in your main application, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Script>
<![CDATA[

import flash.events.Event;

private function handleCloseEvent(eventObj:Event):void {

myTAClose.text=eventObj.type;
}

private function handleMouseDown(eventObj:Event):void {

myTA.text=eventObj.type;
}
]]>
</mx:Script>

<mx:TextArea id="myTA" />

<mx:TextArea id="myTAClose" />

<MyComp:AddressForm mouseDown="handleMouseDown(event);"
close="handleCloseEvent(event);"/>
</mx:Application>

About interfaces
Interfaces are a type of class that you design to act as an outline for your components. When
you write an interface, you provide only the names of public methods rather than any
implementation. For example, if you define two methods in an interface and then implement
that interface, the implementing class must provide implementations of those two methods.
Interfaces in ActionScript can only declare methods and properties by using setter and getter
methods; they cannot specify constants. The benefit of interfaces is that you can define a
contract that all classes that implement that interface must follow. Also, if your class
implements an interface, instances of that class can also be cast to that interface.

114 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Custom MXML components can implement interfaces just as other ActionScript classes can.
To do this, you use the implements attribute. All MXML tags support this attribute.
The following code is an example of a simple interface that declares several methods:
// The following is in a file named SuperBox.as.
interface SuperBox {
function selectSuperItem():String;
function removeSuperItem():Boolean;
function addSuperItem():Boolean;
}

A class that implements the SuperBox interface uses the implements attribute to point to its
interface and must provide an implementation of the methods. The following example of a
custom ComboBox component implements the SuperBox interface:
<?xml version="1.0"?>

<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
implements="SuperBox">
<mx:Script>
<![CDATA[
public function selectSuperItem():String {
return "Super Item was selected";
}
public function removeSuperItem():Boolean {
return true;
}
public function addSuperItem():Boolean {
return true;
}
]]>
</mx:Script>
<mx:dataProvider>
<mx:String>AK</mx:String>
<mx:String>AL</mx:String>
</mx:dataProvider>
</mx:ComboBox>

You can implement multiple interfaces by separating them with commas, as the following
example shows:
<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"
implements="SuperBox, SuperBorder, SuperData">

All methods that you declare in an interface are considered public. If you define an interface
and then implement that interface, but do not implement all of its methods, the MXML
compiler throws an error.

About interfaces 115

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Methods that are implemented in the custom component must have the same return type as
their corresponding methods in the interface. If no return type is specified in the interface, the
implementing methods can declare any return type.

About implementing IMXMLObject

You cannot define a constructor for an MXML component. If you do, the Flex compiler
issues an error message that specifies that you defined a duplicate function.
For many types of Flex components, you can use an event listener instead of a constructor. For
example, depending on what you want to do, you can write an event listener for the
preinitialize, initialize, or creationComplete event to replace the constructor.

These events are all defined by the UIComponent class, and inherited by all of its subclasses.
If you create an MXML component that is not a subclass of UIComponent, you cannot take
advantage of these events. You can instead implement the IMXMLObject interface in your
MXML component, and then implement the IMXMLObject.initialized() method, as the
following example shows:
<?xml version="1.0"?>

<mx:Object xmlns:mx="http://www.adobe.com/2006/mxml"
implements="mx.core.IMXMLObject">

<mx:Script>
<![CDATA[

// Implement the IMXMLObject.initialized() method.

public function initialized(document:Object, id:String):void {
trace("initialized, x = " + x);
}
]]>
</mx:Script>

<mx:Number id="y"/>
<mx:Number id="z"/>
<mx:Number id="x"/>
</mx:Object>

116 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex calls the IMXMLObject.initialized() method after it initializes the properties of the
component. The following example uses this component:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*"
creationComplete="initApp();">

<mx:Script>
<![CDATA[

public function initApp():void {

myTA.text="myFC.x = " + String(myFC.x);
}
]]>
</mx:Script>

<MyComp:ObjectComp id="myFC" x="1" y="2" z="3"/>

<mx:TextArea id="myTA"/>

</mx:Application>
Because Flex calls the IMXMLObject.initialized() method after it initializes the properties
of the component, the trace() function in the implementation of the
IMXMLObject.initialized() method outputs the following:
initialized, x = 1

About interfaces 117

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

118 Creating Advanced MXML Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

PART 3

Creating ActionScript
Components 3
This part describes how to create custom Adobe Flex components in
ActionScript.
The following topics are included:
Chapter 9: Creating Simple Visual Components in ActionScript 121
Chapter 10: Creating Advanced Visual Components in
ActionScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Chapter 11: Creating Custom Style Properties . . . . . . . . . . . . . . . . 185
Chapter 12: Creating Template Components . . . . . . . . . . . . . . . . . 197

119
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 9

Creating Simple Visual

Components in ActionScript
9
You define custom ActionScript components to extend the Adobe Flex component library.
For example, you can create a customized Button, Tree, or DataGrid component as an
ActionScript component.
This topic describes how to create simple visual components in ActionScript, and includes
examples of creating components that extend the Flex component hierarchy. For information
on creating advanced components in ActionScript, see Chapter 10, “Creating Advanced
Visual Components in ActionScript,” on page 149.

Contents
About ActionScript components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Adding properties and methods to a component . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Defining events in ActionScript components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
Applying styles to custom components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

About ActionScript components

You create reusable components by using ActionScript, and reference these components in
your Flex applications as MXML tags. Components created in ActionScript can contain
graphical elements, define custom business logic, or extend existing Flex components.

121
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex components are implemented as a class hierarchy in ActionScript. Each component in
your application is an instance of an ActionScript class. The following example shows just a
portion of this hierarchy:

UIComponent

Container Button NumericStepper ComboBase

Box Form ComboBox

VBox
NO TE

This example shows a portion of the class hierarchy. For a complete description of the
class hierarchy, see the Adobe Flex Language Reference.

All Flex visual components are derived from the ActionScript UIComponent class. To create
your own components, you can create a subclass from the UIComponent class, or from any of
its subclasses.
The class you choose to use as the superclass of your custom component depends on what you
are trying to accomplish. For example, you might require a custom button control. You could
create a subclass of the UIComponent class, then recreate all of the functionality built into the
Flex Button class. A better and faster way to create your custom button component is to create
a subclass of the Flex Button class, and then modify it in your custom class.
This topic describes how to create simple ActionScript components. Simple components are
subclasses of existing Flex components that modify the behavior of the component, or add
new functionality to it. For example, you might add a new event type to a Button control, or
modify the default styles or skins of a DataGrid control.
You can also create advanced ActionScript components. Advanced ActionScript components
might have one of the following requirements:
■ Modify the appearance of a control or the layout functionality of a container
■ Encapsulate one or more components into a composite component
■ Subclass UIComponent to create components
For information on creating advanced ActionScript components, see Chapter 10, “Creating
Advanced Visual Components in ActionScript,” on page 149.

122 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Example: Creating a simple component
When you define a simple component, you do not create a component yourself, but you
modify the behavior of an existing component. In this section, you create a customized
TextArea control by extending the mx.controls.TextArea component. This component adds
an event listener for the keyDown event to the TextArea control. The KeyDown event deletes all
the text in the control when a user presses the Control+Z key combination:
package myComponents
{
// as/myComponents/DeleteTextArea.as
import mx.controls.TextArea;
import flash.events.KeyboardEvent;

public class DeleteTextArea extends TextArea {

// Constructor
public function DeleteTextArea() {
// Call super().
super();

// Add event listener for keyDown event.

addEventListener("keyDown", myKeyDown);
}

// Define private keyDown event handler.

private function myKeyDown(eventObj:KeyboardEvent):void {
// Check to see if Ctrl-Z pressed. Keycode for Z is 90.
if (eventObj.ctrlKey && eventObj.keyCode == 90)
text = "";
}
}
}
The filename for this component is DeleteTextArea.as, and its location is in the
myComponents subdirectory of the application, as specified by the package statement. For
more information on using the package statement, and specifying the directory location of
your components, see Chapter 3, “Using ActionScript to Create Components,” on page 25.
You can now use your new TextArea control in an application, as the following example
shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:DeleteTextArea/>

</mx:Application>

About ActionScript components 123

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
NOT E

Your class must be specified as public for you to be able to access it by using an MXML
tag.

In this example, you first define the MyComp namespace to specify the location of your custom
component. You then reference the component as an MXML tag by using the namespace
prefix.
You can specify any inherited properties of the superclass in MXML, as the following example
shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:DeleteTextArea wordWrap="true" text="My Message"/>

</mx:Application>
You do not have to change the name of your custom component when you create a subclass of
a Flex class. In the previous example, you could have named your custom component
TextArea, and written it to the TextArea.as file in the myComponents directory, as the
following example shows:
package myComponents
{
import mx.controls.TextArea;
import flash.events.KeyboardEvent;

public class TextArea extends mx.controls.TextArea {

...
}
}

You can now use your custom TextArea control, and the standard TextArea control, in an
application. To differentiate between the two controls, you use the namespace prefix, as the
following example shows:
<?xml version="1.0"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<MyComp:TextArea/>

<mx:TextArea/>

</mx:Application>

124 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Adding properties and methods to a
component
To make your custom components reusable, you design them so that users can pass
information to them. This section describes how to add public properties and methods to
your components. It also describes how the component user can call the methods and access
the properties, and how to make them accessible in MXML.

Defining public properties in ActionScript

You can use one of the following methods to add public properties to your ActionScript
components:
■ Define public variables
■ Define public getter and setter methods

Accessing public properties in MXML

All public properties defined in your component are accessible in MXML by using MXML
tag properties. For example, you might allow the user to pass a value to your component, as
the following example shows:
<MyComp:MyCustomComponent prop1="3"/>

To create a component that takes tag attributes in MXML, you define a public variable with
the same name as the tag attribute in your class definition:
public class MyCustomComponent extends TextArea {

// Define an uninitialized variable.

public var prop1:Number;

// Define and initialize a variable.

public var prop2:Number=5;
...
}

You can also use public getter and setter methods to define a property, as the following
example shows:
public class MyCustomComponent extends TextArea {

private var _prop1:Number;

public function get prop1():Number {

// Method body.
// Typically the last line returns the value of the private variable.

Adding properties and methods to a component 125

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
return _prop1;
}

public function set prop1(value:Number):void {

// Typically sets the private variable to the argument.
_prop1=value;
// Define any other logic, such as dispatching an event.
}
}

You can define and initialize a private variable, as the following example shows:
private var _prop2:Number=5;

When you specify a value to the property in MXML, Flex automatically calls the setter
method. If you do not set the property in MXML, Flex sets it to its initial value, if you
specified one, or to the type’s default value, which is NaN for a variable of type Number.

126 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Defining public properties as variables
In the following example, you use the Control+I key combination to extend the TextArea
control to let the user increase the font size by one point, or use the Control+M key
combination to decrease the font size by one point:
package myComponents
{

// as/myComponents/TextAreaFontControl.as
import mx.controls.TextArea;
import flash.events.KeyboardEvent;
import flash.events.Event;

public class TextAreaFontControl extends TextArea

{
// Constructor
public function TextAreaFontControl() {
super();

// Add event listeners.

addEventListener("keyDown", myKeyDown);
addEventListener("creationComplete", myCreationComplete);
}

// Define private var for current font size.

private var currentFontSize:Number;

// Define a public property for the minimum font size.

public var minFontSize:Number = 5;
// Define a public property for the maximum font size.
public var maxFontSize:Number = 15;

// Initialization event handler for getting default font size.

private function myCreationComplete(eventObj:Event):void {
// Get current font size
currentFontSize = getStyle('fontSize');
}

// keyDown event handler.

private function myKeyDown(eventObj:KeyboardEvent):void {
// Was Ctrl key pressed?
if (eventObj.ctrlKey)
{
switch (eventObj.keyCode) {
// Was Ctrl-I pressed?
case 73 :
if (currentFontSize < maxFontSize) {
currentFontSize = currentFontSize + 1;
setStyle('fontSize', currentFontSize);

Adding properties and methods to a component 127

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
}
break;
// Was Ctrl-M pressed?
case 77 :
if (currentFontSize > minFontSize) {
currentFontSize = currentFontSize - 1;
setStyle('fontSize', currentFontSize);
}
break;
default :
break;
}
}
}
}
}
Notice that the call to the getStyle() method is in the event listener for the
creationComplete event. You must wait until component creation is complete before calling
getStyle() to ensure that Flex has set all inherited styles. However, you can call setStyle()
in the component constructor to set styles.
This example uses variables to define public properties to control the maximum font size,
maxFontSize, and minimum font size, minFontSize, of the control. Users can set these
properties in MXML, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:TextAreaFontControl id="myTAFS"
minFontSize="8"
maxFontSize="50"/>

<mx:Button
label="Get Font Size"
click="myTA.text=String(myTAFS.getStyle('fontSize'));"/>
<mx:TextArea id="myTA"/>
</mx:Application>

Defining public properties by using getter and setter methods

There are no restrictions on using public variables to define public properties, However,
Adobe recommends that you use getter and setter methods so that you can control user
interaction with your component, as described in “Defining properties as getters and setters”
on page 30.

128 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example code defines a component named TextAreaFontControlGetSet that
replaces the public property definition for the maxFontSize property shown in “Defining
public properties as variables” on page 127:
package myComponents
{
// as/myComponents/TextAreaFontControlGetSet.as
import mx.controls.TextArea;
import flash.events.KeyboardEvent;
import flash.events.Event;

public class TextAreaFontControlGetSet extends TextArea

{
public function TextAreaFontControlGetSet()
{
super();
addEventListener("keyDown", myKeyDown);
addEventListener("creationComplete", myCreationComplete);
}

private var currentFontSize:Number;

public var minFontSize:Number = 5;

// Define private variable for maxFontSize.

private var _maxFontSize:Number = 15;

// Define public getter method.

public function get maxFontSize():Number {
return _maxFontSize;
}

// Define public setter method.

public function set maxFontSize(value:Number):void {
if (value <= 30) {
_maxFontSize = value;
} else _maxFontSize = 30;
}

private function myCreationComplete(eventObj:Event):void {

// Get current font size
currentFontSize = getStyle('fontSize');
}

// keyDown event handler.

private function myKeyDown(eventObj:KeyboardEvent):void {
// Was Ctrl key pressed?
if (eventObj.ctrlKey)
{
switch (eventObj.keyCode) {
// Was Ctrl-I pressed?

Adding properties and methods to a component 129

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
case 73 :
if (currentFontSize < maxFontSize) {
currentFontSize = currentFontSize + 1;
setStyle('fontSize', currentFontSize);
}
break;
// Was Ctrl-M pressed?
case 77 :
if (currentFontSize > minFontSize) {
currentFontSize = currentFontSize - 1;
setStyle('fontSize', currentFontSize);
}
break;
default :
break;
}
}
}
}
}
In this example, the setter method checks that the specified font size is less than the
predefined limit of 30 pixels. If the font size is greater than the limit, it sets it to the limit.

Creating a default property

You can define a default property for your ActionScript components by using the
[DefaultProperty] metadata tag. You can then use the default property in MXML as the
child tag of the component tag without specifying the property name. For more information
on using the default property, including an example, see “Setting the default property” in Flex
Developer’s Guide.

130 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can use the [DefaultProperty] metadata tag in your ActionScript component to define
a single default property, as the following example shows:
package myComponents
{
// as/myComponents/TextAreaDefaultProp.as
import mx.controls.TextArea;

// Define the default property.

[DefaultProperty("defaultText")]

public class TextAreaDefaultProp extends TextArea {

public function TextAreaDefaultProp()

{
super();
}

// Define a setter method to set the text property

// to the value of the default property.
public function set defaultText(value:String):void {
if (value!=null)
text=value;
}

public function get defaultText():String {

return text;
}
}
}
In this example, you add a new property to the TextArea control, called defaultProperty,
and specify it as the default property of the control. The setter method for defaultProperty
just sets the value of the text property of the control. You can then use the default property in
MXML, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:TextAreaDefaultProp>Hello</MyComp:TextAreaDefaultProp>

</mx:Application>

Adding properties and methods to a component 131

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The one place where Flex prohibits the use of a default property is when you use the
ActionScript class as the root tag of an MXML component. In this situation, you must use
child tags to define the property, as the following example shows:
<?xml version="1.0"?>

<MyComp:TextAreaDefaultProp xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:defaultText>Hello</MyComp:defaultText>

</MyComp:TextAreaDefaultProp>

Making properties accessible in Flex Builder

You can make your property definitions accessible in Flex Builder by adding the
[Inspectable] metadata tag to the property definition. For example, if you are using Adobe
Flex Builder, you can insert the [Inspectable] metadata tag to define the property as user-
editable (or inspectable), as the following example shows:
[Inspectable]
var prop1:Number;

You can also use the [Inspectable] metadata tag with setter and getter methods. For more
information, see Chapter 5, “Using Metadata Tags in Custom Components,” on page 45.

Using data binding with custom properties

Data binding defines a syntax for automatically copying the value of a property of one object,
the source property, to a property of another object, the destination property, at run time. Data
binding is usually triggered when the value of the source property changes.
The following example shows a Text control that gets its data from a HSlider control’s value
property. The property name inside the curly braces ({ }) specifies a binding expression that
copies the value of the source property, mySlider.value, into the destination property, the
Text control’s text property.
<mx:HSlider id="mySlider"/>
<mx:Text text="{mySlider.value}"/>

The current value of the HSlider control appears in the Text control when you stop moving
the slider. To get continuous updates as you move the slider, set the HSlider.liveDragging
property to true.

132 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using properties as the destination of a binding expression
Properties in your custom components can take advantage of data binding. Any property
defined as a variable or defined by using a setter and getter method can automatically be used
as the destination of a binding expression.
For example, in the section “Defining public properties in ActionScript” on page 125, you
created a class with the public property maxFontSize. You can use the maxFontSize property
as the destination of a binding expression, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<MyComp:TextAreaFontControl id="myTA"
maxFontSize="{Number(myTI.text)}"/>

<mx:Label text="Enter max font size."/>

<mx:TextInput id="myTI" text="25"/>

</mx:Application>
In this example, any value that the user enters into the TextInput control is automatically
copied to the maxFontSize property.

Using properties as the source of a data binding expression

When a property is the source of a data binding expression, Flex automatically copies the
value of the source property to any destination property when the source property changes.
However, in order to signal to Flex to perform the copy, you must register the property with
Flex and the source property must dispatch an event.
To register a property as a source for data bindings, you use the [Bindable] metadata tag.
You can use this tag in three places:
■ Before a class definition to make all public properties defined as variables or by using setter
and getter methods usable as the source of a binding expression
■ Before a property that a variable defines to make that specific property support binding
■ Before a getter method for a property implemented by using setter and getter methods
NOTE

Adding properties and methods to a component 133

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
For more information on the [Bindable] metadata tag, see Chapter 5, “Using Metadata Tags
in Custom Components,” on page 45.

134 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example modifies the component in the section “Defining public properties in
ActionScript” on page 125 to make the maxFontSize and minFontSize properties usable as
the source for data bindings:
// Define public properties for tracking font size.
[Bindable]
public var maxFontSize:Number = 15;
[Bindable]
public var minFontSize:Number = 5;

If you omit the event name from the [Bindable] metadata tag, Flex automatically dispatches
an event named propertyChange when the property changes to trigger the data binding. If
the property value remains the same on a write, Flex does not dispatch the event or update the
property.

Adding properties and methods to a component 135

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
When you define a property by using getter and setter methods so that the property is usable
as the source for data binding, you include the [Bindable] metadata tag before the getter
method, and optionally include the name of the event dispatched by the setter method when
the property changes, as the following example shows:
package myComponents
{
// as/myComponents/TextAreaFontControlBinding.as
import mx.controls.TextArea;
import flash.events.KeyboardEvent;
import flash.events.Event;

public class TextAreaFontControlBinding extends TextArea

{
public function TextAreaFontControlBinding()
{
super();
addEventListener("keyDown", myKeyDown);
addEventListener("creationComplete", myCreationComplete);
}

private var currentFontSize:Number;

public var minFontSize:Number = 5;

// Define private variable for maxFontSize.

public var _maxFontSize:Number = 15;

// Define public getter method, mark the property

// as usable for the source of data binding,
// and specify the name of the binding event.
[Bindable("maxFontSizeChanged")]
public function get maxFontSize():Number {
return _maxFontSize;
}

// Define public setter method.

public function set maxFontSize(value:Number):void {
if (value <= 30) {
_maxFontSize = value;
} else _maxFontSize = 30;

// Dispatch the event to trigger data binding.

dispatchEvent(new Event("maxFontSizeChanged"));
}

private function myCreationComplete(eventObj:Event):void {

// Get current font size
currentFontSize = getStyle('fontSize');
}

136 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
// keyDown event handler.
private function myKeyDown(eventObj:KeyboardEvent):void {
// Was Ctrl key pressed?
if (eventObj.ctrlKey)
{
switch (eventObj.keyCode) {
// Was Ctrl-I pressed?
case 73 :
if (currentFontSize < maxFontSize) {
currentFontSize = currentFontSize + 1;
setStyle('fontSize', currentFontSize);
}
break;
// Was Ctrl-M pressed?
case 77 :
if (currentFontSize > minFontSize) {
currentFontSize = currentFontSize - 1;
setStyle('fontSize', currentFontSize);
}
break;
default :
break;
}
}
}

}
}
In this example, the setter updates the value of the property, and then dispatches an event to
trigger an update of any data binding destination. The name of the event is not restricted. You
can use this component in an application, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:TextAreaFontControlBinding id="myTA"
maxFontSize="{Number(myTI.text)}"/>

<mx:Label text="Enter max font size."/>

<mx:TextInput id="myTI" text="15"/>

<mx:Label text="Current max font size."/>

<mx:TextArea text="{String(myTA.maxFontSize)}"/>

</mx:Application>

Adding properties and methods to a component 137

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Defining a method override
You can override a method of a base class in your ActionScript component. To override the
method, you add a method with the same signature to your class, and prefix it with the
override keyword. The following example overrides the HBox.addChild() method to open
an Alert box when a new item is added to it:
package myComponents
{
import mx.controls.Alert;
import mx.containers.HBox;
import flash.display.DisplayObject;

public class HBoxWithAlert extends HBox

{
// Define the constructor.
public function HBoxWithAlert()
{
super();
}

// Define the override.

override public function addChild(child:DisplayObject):DisplayObject {

// Call super.addChild().
super.addChild(child);

// Open the Alert box.

Alert.show("Item added successfully");

return child;
}
}
}
Notice that the method implementation calls the super.addChild() method. The call to
super.addChild() causes Flex to invoke the superclass’s addChild() method to perform the
operation. Your new functionality to open the Alert box occurs after the super.addChild()
method.
You might have to use super() to call the base class method before your code, after your
code, or not at all. The location is determined by your requirements. To add functionality to
the method, you call super() before your code. To replace the base class method, you do not
call super() at all.

138 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example uses this component in an application:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Script>
<![CDATA[
import mx.controls.Button;

public function addButton():void {

var myButton:Button = new Button();
myButton.label = "New Button";
myHBox.addChild(myButton);
}
]]>
</mx:Script>

<MyComp:HBoxWithAlert id="myHBox">
</MyComp:HBoxWithAlert>

<mx:Button label="Add Button" click="addButton();"/>

</mx:Application>

Adding properties and methods to a component 139

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Initializing inherited properties with tag attributes in
MXML
In an MXML component, you can initialize the value of any inherited public, writable
property by defining a child tag of the MXML component with an id property that matches
the name of the inherited property. For example, you define a custom Panel component based
on the Flex Panel container, named MyPanel.as, as the following example shows:
package myComponents
{
import mx.containers.Panel;
import mx.controls.Text;
import mx.controls.TextInput;

public class MyPanel extends Panel {

// Define public variables for two child components.

public var myInput:TextInput;
public var myOutput:TextInput;

public function MyPanel() {

super();
}

// Copy the text from one child component to another.

public function xfer():void {
myOutput.text = myInput.text;
}
}
}
In this example, the MyPanel component defines two variables corresponding to TextInput
controls. You then create a custom MXML component, named MyPanelComponent.mxml,
based on MyPanel.as, as the following example shows:
<?xml version="1.0"?>

<MyComps:MyPanel xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComps="myComponents.*">

<mx:TextInput id="myInput"/>
<mx:TextInput id="myOutput"/>

</MyComps:MyPanel>
Notice that the value of the id property for the two TextInput controls matches the variable
names of the properties defined in the MyPanel component. Therefore, Flex initializes the
inherited properties with the TextInput controls that you defined in MXML. This technique
for initializing properties can be referred to as code behind.

140 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can use your custom component in the following Flex application:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComps="myComponents.*">

<MyComps:MyPanelComponent id="myP"/>

<mx:Button label="Copy" click="myP.xfer();"/>

</mx:Application>
If the value of the id property of a TextInput control does not match an inherited property
name, Flex creates a property of the component, where the id property defines the name of
the new property.
To support initialization from MXML, an inherited property must have the following
characteristics:
■ The inherited property must be public.
If you try to initialize a non-public inherited property, the Flex compiler issues an error.
■ The inherited property must be writable.
If you try to initialize a constant, or a property defined by a getter method without a
corresponding setter method, the Flex compiler issues an error.
■ The data type of the value that you specify to the inherited property must by compatible
with the data type of the property.
If you try to initialize a property with a value of an incompatible data type, the Flex
compiler issues an error.

Defining events in ActionScript

components
Flex components dispatch their own events and listen to other events. An object that wants to
know about another object’s events registers as a listener with that object. When an event
occurs, the object dispatches the event to all registered listeners.
The core class of the Flex architecture, mx.core.UIComponent, defines core events, such as
updateComplete, resize, move, creationComplete, and others that are fundamental to all
components. Subclasses of these classes inherit and dispatch these events.

Defining events in ActionScript components 141

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Custom components that extend existing Flex classes inherit all the events of the superclass. If
you extend the Button class to create the MyButton class, you can use the events inherited
from the Button class, such as mouseOver or creationComplete, as the following example
shows:
<?xml version="1.0"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Script>
<![CDATA[

import flash.events.Event;

private function handleClick(eventObj:Event):void {

// Define event listener.
}

private function handleCreationComplete(eventObj:Event):void {

// Define event listener.
}

]]>
</mx:Script>

<MyComp:MyButton
click="handleClick(event);"
creationComplete="handleCreationComplete(event);"/>

</mx:Application>

Your custom components can also define new events based on the requirements of your
components. For example, the section “Using data binding with custom properties”
on page 132 showed how to define a custom event so that properties of your component can
work with the Flex data binding mechanism.
This section describes how to handle events within a custom component and how to create
events for it.

Handling predefined events within the component

The previous section showed a custom component, MyButton, dispatching two events. In
that section, you defined the event listeners in the main application file.

142 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Your custom component can also define event listeners within the component itself to handle
the events internally. For example, “Defining public properties as variables” on page 127
defined event listeners for the keyDown and creationComplete events within the body of the
component. This allows the component to handle those events internally.
NO TE

Even though you define event listeners for the events in the component itself, your
application can also register listeners for those events. The event listeners defined within
the component execute before any listeners defined in the application.

The example used the creationComplete event to access the default fontSize property of
the component. You could not access this property in the constructor itself because Flex does
not define it until after the component is created. For more information on the initialization
order of a component, see Chapter 10, “Creating Advanced Visual Components in
ActionScript,” on page 149.

Dispatching custom events

Your ActionScript component can define custom events and use the predefined events. You
use custom events to support data binding, to respond to user interactions, or to trigger
actions by your component. For an example that uses events to support data binding, see
“Using data binding with custom properties” on page 132.
For each custom event dispatched by your component, you must do the following:
1. Create an Event object describing the event.
2. (Optional) use the [Event] metadata tag to make the event public so that other
components can listen for it.
3. Dispatch the event by using the dispatchEvent() method.
To add information to the event object, you define a subclass of the flash.events.Event class to
represent the event object. For more information on creating custom event classes, see
Chapter 4, “Creating Custom Events,” on page 35.

Defining events in ActionScript components 143

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You might define some custom events that are used internally by your component, and are
not intended to be recognized by the other components. For example, the following
component defines a custom event, dispatches it, and handles it all within the component:
package myComponents
{
import mx.controls.TextArea;
import flash.events.Event;

public class ModalText extends TextArea {

public function ModalText() {

super();

// Register event listener.

addEventListener("enableChanged", enableChangedListener);
}

public function enableInput(value:Boolean):void {

// Method body.

// Dispatch event.
dispatchEvent(new Event("enableChanged"));
}

private function enableChangedListener(eventObj:Event):void {

// Handle event.
}
}
}
In this example, the public method enableInput() lets the user enable or disable input to
the control. When you call the enableInput() method, the component uses the
dispatchEvent() method to dispatch the enableChanged event. The dispatchEvent()
method has the following signature:
dispatchEvent(eventObj)

The eventObj argument is the event object that describes the event.
If you want an MXML component to be able to register a listener for the event, you must
make the event known to the Flex compiler by using the [Event] metadata tag. For each
public event that your custom component dispatches, you add an [Event] metadata keyword
before the class definition that defines that event; for example:
[Event(name="enableChanged", type="flash.events.Event")]
public class ModalText extends TextArea {
...
}

144 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
If you do not identify an event in the class file with the [Event] metadata tag, the compiler
generates an error when an MXML component attempts to register a listener for that event.
Any component can register an event listener for the event in ActionScript using the
addEventListener() method, even if you omit the [Event] metadata tag.

You can then handle the event in MXML, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComps="myComponents.*">

<mx:Script>
<![CDATA[

import flash.events.Event;

private function handleEnableChanged(event:Event):void {

myTA.text="Got Event";
}
]]>
</mx:Script>

<MyComps:ModalTextEvent id="myMT"
enableChanged="handleEnableChanged(event);"/>

<mx:Button click="myMT.enableInput(true);"/>
<mx:TextArea id="myTA"/>
</mx:Application>

Applying styles to custom components

Style properties define the look of a component, from the size of the fonts used to the color of
the background. Your custom ActionScript components inherit all of the styles of the base
class, so you can set them in the same way as for that base class.
To change style properties in custom components, use the setStyle() method in the
component’s constructor. This applies the same style to all instances of the component, but
users of the component can override the settings of the setStyle() method in MXML tags.
Any style properties that are not set in the component’s class file are inherited from the
component’s superclass.

Applying styles to custom components 145

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following ActionScript class file sets the color and borderColor styles of the
BlueButton control:
package myComponents
{
// as/myComponents/BlueButton.as
import mx.controls.Button;

public class BlueButton extends Button

{

public function BlueButton() {

super();

// Set the label text to blue.

setStyle("color", 0x0000FF);

// Set the borderColor to blue.

setStyle("borderColor", 0x0000FF);
}
}
}
The following MXML file uses the BlueButton control with the default color and
borderColor styles set in your component’s class file:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComps="myComponents.*">

<MyComps:BlueButton label="Submit"/>

</mx:Application>
Setting the styles in constructor does not prevent users of the component from changing the
style. For example, the user could still set their own value for the color style, as the following
example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComps="myComponents.*">

<MyComps:BlueButton label="Submit" color="0xFF0000"/>

</mx:Application>

146 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In addition to setting the color property, you can set the font face, font size, and other style
properties. For more information on the available style properties, see Flex Developer’s Guide.
You can also define new style properties for your components. For more information, see
Chapter 10, “Creating Advanced Visual Components in ActionScript,” on page 149.

Applying styles to custom components 147

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

148 Creating Simple Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 10

Creating Advanced Visual

Components in ActionScript
10
This topic describes the details of creating advanced visual components for use in Adobe Flex
applications. This topic assumes that you are familiar with creating simple ActionScript
components as described in Chapter 9, “Creating Simple Visual Components in
ActionScript,” on page 121.

Contents
About creating advanced components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Implementing the component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Making components accessible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Adding version numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Best practices when designing a component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Example: Creating a composite component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

About creating advanced components

Simple visual components are subclasses of existing Flex components that modify the
appearance of the component by using skins or styles, or add new functionality to the
component. For example, you add a new event type to a Button control, or modify the default
styles or skins of a DataGrid control. For more information, see Chapter 9, “Creating Simple
Visual Components in ActionScript,” on page 121.
This topic describes how to create advanced visual components in ActionScript. In advanced
components, you typically perform the following actions:
■ Modify the visual appearance or visual characteristics of an existing component.
■ Create a composite component that encapsulates two or more components within it.
■ Create a component by creating a subclass of the UIComponent class.

149
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You usually create a component as a subclass of an existing class. For example, to create a
component that is based on the Button control, you create a subclass of the
mx.controls.Button class. To make your own component, you create a subclass of the
mx.core.UIComponent class.

About overriding protected UIComponent methods

All Flex visual components are subclasses of the UIComponent class. Therefore, visual
components inherit the methods, properties, events, styles, and effects defined by the
UIComponent class.
To create an advanced visual component, you must implement a class constructor. Also, you
optionally override one or more of the following protected methods of the UIComponent
class:

UIComponent Description
method
commitProperties() Commits any changes to component properties, either to make the
changes occur at the same time, or to ensure that properties are set in
a specific order.
For more information, see “Implementing the commitProperties()
method” on page 160.
createChildren() Creates any child components of the component. For example, the
ComboBox control contains a TextInput control and a Button control
as child components.
For more information, see “Implementing the createChildren() method”
on page 159.
layoutChrome() Defines the border area around the container for subclasses of the
Container class.
For more information, see “Implementing the layoutChrome() method”
on page 168.
measure() Sets the default size and default minimum size of the component.
For more information, see “Implementing the measure() method”
on page 164.
updateDisplayList() Sizes and positions the children of the component on the screen based
on all previous property and style settings, and draws any skins or
graphic elements used by the component. The parent container for the
component determines the size of the component itself.
For more information, see “Implementing the updateDisplayList()
method” on page 168.

150 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Component users do not call these methods directly; Flex calls them as part of the
initialization process of creating a component, or when other method calls occur. For more
information, see “About the component instantiation life cycle” on page 152.

About the invalidation methods

During the lifetime of a component, your application might modify the component by
changing its size or position, modifying a property that controls its display, or modifying a
style or skin property of the component. For example, you might change the font size of the
text displayed in a component. As part of changing the font size, the component’s size might
also change, which requires Flex to update the layout of the application. The layout operation
might require Flex to invoke the commitProperties(), measure(), layoutChrome(), and
the updateDisplayList() methods of your component.
Your application can programmatically change the font size of a component much faster than
Flex can update the layout of an application. Therefore, you only want to update the layout
after you are sure that you determined the final value of the font size.
In another scenario, when you set multiple properties of a component, such as the label and
icon properties of a Button control, you want the commitProperties(), measure(), and
updateDisplayList() methods to execute only once, after all properties are set. You do not
want these methods to execute when you set the label property, and then execute again when
you set the icon property.
Also, several components might change their font size at the same time. Rather than updating
the application layout after each component changes its font size, you want Flex to coordinate
the layout operation to eliminate any redundant processing.
Flex uses an invalidation mechanism to synchronize modifications to components. Flex
implements the invalidation mechanism as a set of methods that you call to signal that
something about the component has changed and requires Flex to call the component’s
commitProperties(), measure(), layoutChrome(), or updateDisplayList() methods.

About creating advanced components 151

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following table describes the invalidation methods:

Invalidation method Description

invalidateProperties() Marks a component so that its commitProperties() method gets
called during the next screen update.
invalidateSize() Marks a component so that its measure() method gets called
during the next screen update.
invalidateDisplayList() Marks a component so that its layoutChrome() and
updateDisplayList() methods get called during the next screen
update.

When a component calls an invalidation method, it signals to Flex that the component must
be updated. When multiple components call invalidation methods, Flex coordinates updates
so that they all occur together during the next screen update.
Typically, component users do not call the invalidation methods directly. Instead, they are
called by the component’s setter methods, or by any other methods of a component class as
necessary. For more information and examples, see “Implementing the commitProperties()
method” on page 160.

About the component instantiation life cycle

The component instantiation life cycle describes the sequence of steps that occur when you
create a component object from a component class. As part of that life cycle, Flex
automatically calls component methods, dispatches events, and makes the component visible.

152 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example creates a Button control in ActionScript and adds it to a container:
// Create a Box container.
var boxContainer:Box = new Box();
// Configure the Box container.

// Create a Button control.

var b:Button = new Button()
// Configure the button control.
b.label = "Submit";
...
// Add the Button control to the Box container.
boxContainer.addChild(b);

The following steps show what occurs when you execute the code to create the Button
control, and add the control to the Box container:
1. You call the component’s constructor, as the following code shows:
// Create a Button control.
var b:Button = new Button()

2. You configure the component by setting its properties, as the following code shows:
// Configure the button control.
b.label = "Submit";

Component setter methods might call the invalidateProperties(),

invalidateSize(), or invalidateDisplayList() methods.
3. You call the addChild() method to add the component to its parent, as the following code
shows:
// Add the Button control to the Box container.
boxContainer.addChild(b);

Flex performs the following actions:

a. Sets the parent property for the component to reference its parent container.
b. Computes the style settings for the component.
c. Dispatches the preinitialize event on the component.
d. Calls the component’s createChildren() method.
e. Calls the invalidateProperties(), invalidateSize(), and
invalidateDisplayList() methods to trigger later calls to the
commitProperties(), measure(), or updateDisplayList() methods during the
next render event.
The only exception to this rule is that Flex does not call the measure() method when
the user sets the height and width of the component.

About creating advanced components 153

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
f. Dispatches the initialize event on the component. At this time, all of the
component’s children are initialized, but the component was not sized or processed for
layout. You can use this event to perform additional processing of the component
before it is laid out.
g. Dispatches the childAdd event on the parent container.
h. Dispatches the initialize event on the parent container.
4. During the next render event, Flex performs the following actions:
a. Calls the component’s commitProperties() method.
b. Calls the component’s measure() method.
c. Calls the component’s layoutChrome() method.
d. Calls the component’s updateDisplayList() method.
e. Dispatches the updateComplete event on the component.
5. Flex dispatches additional render events if the commitProperties(), measure(), or
updateDisplayList() methods call the invalidateProperties(),
invalidateSize(), or invalidateDisplayList() methods.

6. After the last render event occurs, Flex performs the following actions:
a. Makes the component visible by setting the visible property to true.
b. Dispatches the creationComplete event on the component. The component is sized
and processed for layout. This event is only dispatched once when the component is
created.
c. Dispatches the updateComplete event on the component. Flex dispatches additional
updateComplete events whenever the layout, position, size, or other visual
characteristic of the component changes and the component is updated for display.
Most of the work for configuring a component occurs when you add the component to a
container by using the addChild() method. That is because until you add the component to
a container, Flex cannot determine its size, set inheriting style properties, or draw it on the
screen.
You can also define your application in MXML, as the following example shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Box>
<mx:Button label="Submit"/>
</mx:Box>
</mx:Application>

The sequence of steps that Flex executes when creating a component in MXML are equivalent
to the steps described for ActionScript.

154 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can remove a component from a container by using the removeChild() method. If there
are no references to the component, it is eventually deleted from memory by the garbage
collection mechanism of Adobe Flash Player 9.

About the steps for creating a component

When you implement a component, you override component methods, define new
properties, dispatch new events, or perform any other customizations required by your
application.
To implement your component, Follow these general steps:
1. If necessary, create any skins for the component.
2. Create an ActionScript class file.
a. Extend one of the base classes, such as UIComponent or another component class.
b. Specify properties that the user can set by using an MXML tag property. For more
information, see Chapter 9, “Creating Simple Visual Components in ActionScript,”
on page 121.
c. Embed any graphic and skin files. For more information, see Chapter 9, “Creating
Simple Visual Components in ActionScript,” on page 121.
d. Implement the constructor.
e. Implement the UIComponent.createChildren() method.
f. Implement the UIComponent.commitProperties() method.
g. Implement the UIComponent.measure() method.
h. Implement the UIComponent.layoutChrome() method.
i. Implement the UIComponent.updateDisplayList() method.
j. Add properties, methods, styles, events, and metadata.
3. Deploy the component as an ActionScript file or as a SWC file.
You do not have to override all component methods to define a new component. You only
override the methods required to implement the functionality of your component. If you
create a subclass of an existing component, such as Button control or VBox container, you
must implement the methods necessary for you to add any new functionality to the
component.

About creating advanced components 155

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
For example, you can implement a custom Button control that uses a new mechanism for
defining its default size. In that case, you only need to override the measure() method. For an
example, see “Implementing the measure() method” on page 164.
Or, you might implement a new subclass of the VBox container. Your new subclass uses all of
the existing sizing logic of the VBox class, but changes the layout logic of the class to lay out
the container children from the bottom of the container to the top, rather than from the top
down. In this case, you only need to override the updateDisplayList() method. For an
example, see “Implementing the updateDisplayList() method” on page 168.

About interfaces
Flex uses interfaces to divide the basic functionality of components into discrete elements so
that they can be implemented piece by piece. For example, to make your component
focusable, it must implement the IFocusable interface; to let it participate in the layout
process, it must implement ILayoutClient interface.
To simplify the use of interfaces, the UIComponent class implements all of the interfaces
defined in the following table, except for the IFocusManagerComponent and
IToolTipManagerClient interfaces. However, many subclasses of UIComponent implement
the IFocusManagerComponent and IToolTipManagerClient interfaces.
Therefore, if you create a subclass of the class or subclass of UIComponent, you do not have
to implement these interfaces. But, if you create a component that is not a subclass of
UIComponent, and you want to use that component in Flex, you might have to implement
one or more of these interfaces.
N OTE

For Flex 2, Adobe recommends that all of your components extend the UIComponent
class or a class that extends UIComponent.

156 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following table lists the main interfaces implemented by Flex components:

Interface Use
IChildList Indicates the number of children in a container.

IDeferredInstantiationUIComponent Indicates that a component or object can effect

deferred instantiation.

IFlexDisplayObject Specifies the interface for skin elements.

IFocusManagerComponent Indicates that a component or object is focusable,

which means that the components can receive focus
from the FocusManager.
The UIComponent class does not implement
IFocusable because some components are not
intended to receive focus.

IInvalidating Indicates that a component or object can use the

invalidation mechanism to perform delayed, rather than
immediate, property commitment, measurement, and
drawing or layout.

ILayoutManagerClient Indicates that a component or object can participate in

the LayoutManager's commit, measure, and update
sequence.

IPropertyChangeNotifier Indicates that a component supports a specialized form

of event propagation.

IRepeaterClient Indicates that a component or object can be used with

the Repeater class.

IStyleClient Indicates that the component can inherit styles from

another object, and supports the setStyle() and
getStyle() methods.

IToolTipManagerClient Indicates that a component has a toolTip property,

and, therefore, is monitored by the ToolTipManager.

IUIComponent Defines the basic set of APIs that you must implement
in order to be a child of layout containers and lists.

IValidatorListener Indicates that a component can listen for validation

events, and, therefore, show a validation state, such as
a red border and error tooltips.

Implementing the component

When you create a custom component in ActionScript, you have to override the methods of
the UIComponent class. This section describes how to implement the following methods:

Implementing the component 157

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
■ “Basic component structure” on page 158
■ “Implementing the constructor” on page 159
■ “Implementing the createChildren() method” on page 159
■ “Implementing the commitProperties() method” on page 160
■ “Implementing the measure() method” on page 164
■ “Implementing the layoutChrome() method” on page 168
■ “Implementing the updateDisplayList() method” on page 168

Basic component structure

The following example shows the basic structure of a Flex component:
package myComponents
{
public class MyComponent extends UIComponent
{
....
}
}

You must define your ActionScript custom components within a package. The package
reflects the directory location of your component within the directory structure of your
application.
The class definition of your component must be prefixed by the public keyword. A file that
contains a class definition can have one, and only one, public class definition, although it can
have additional internal class definitions. Place any internal class definitions at the bottom of
your source file below the closing curly brace of the package definition.

158 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Implementing the constructor
Your ActionScript class should define a public constructor method for a class that is a subclass
of the UIComponent class, or a subclass of any child of the UIComponent class. The
constructor has the following characteristics:
■ No return type
■ Should be declared public
■ No arguments
■ Calls the super() method to invoke the superclass’s constructor
Each class can contain only one constructor method; ActionScript does not support
overloaded constructor methods. For more information, see Chapter 3, “Defining the
constructor,” on page 28.
Use the constructor to set the initial values of class properties. For example, you can set
default values for properties and styles, or initialize data structures, such as Arrays.
Do not create child display objects in the constructor; you should use it only for setting initial
properties of the component. If your component creates child components, create them in the
createChildren() method.

Implementing the createChildren() method

A component that creates other components or visual objects within it is called a composite
component. For example, the Flex ComboBox control contains a TextInput control to define
the text area of the ComboBox, and a Button control to define the ComboBox arrow.
Components implement the createChildren() method to create child objects (such as
other components) in the component.
You do not call the createChildren() method directly; Flex calls it when the call to the
addChild() method occurs to add the component to its parent. Notice that the
createChildren() method has no invalidation method, which means that you do not have
to call it a second time after the component is added to its parent.
For example, you might define a new component that consists of a Button control and a
TextArea control, where the Button control enables and disables user input to the TextArea
control. The following example creates the TextArea and Button controls:
// Declare two variables for the component children.
private var text_mc:TextArea;
private var mode_mc:Button;

override protected function createChildren():void {

Implementing the component 159

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
// Call the createChildren() method of the superclass.
super.createChildren();

// Test for the existence of the children before creating them.

// This is optional, but do this so a subclass can create a different
// child.
if (!text_mc) {
text_mc = new TextArea();
text_mc.explicitWidth = 80;
text_mc.editable = false;
text_mc.addEventListener("change", handleChangeEvent);
// Add the child component to the custom component.
addChild(text_mc);
}

// Test for the existence of the children before creating them.

if (!mode_mc) {
mode_mc = new Button();
mode_mc.label = "Toggle Editing";
mode_mc.addEventListener("click", handleClickEvent);
// Add the child component to the custom component.
addChild(mode_mc);
}
}

Notice in this example that the createChildren() method calls the addChild() method to
add the child component. You must call the addChild() method for each child object.
After you create a child component, you can use properties of the child component to define
its characteristics. In this example, you create the Button and TextArea controls, initialize
them, and register event listeners for them. You could also apply skins to the child
components. For a complete example, see “Example: Creating a composite component”
on page 174.

Implementing the commitProperties() method

You use the commitProperties() method to coordinate modifications to component
properties. Most often, you use it with properties that affect how a component appears on the
screen.
Flex schedules a call to the commitProperties() method when a call to the
invalidateProperties() method occurs. The commitProperties() method executes
during the next render event after a call to the invalidateProperties() method. When
you use the addChild() method to add a component to a container, Flex automatically calls
the invalidateProperties() method.

160 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Calls to the commitProperties() method occur before calls to the measure() method. This
lets you set property values that the measure() method might use.
The typical pattern that you use for defining component properties is to define the properties
by using getter and setter methods, as the following example shows:
// Define a private variable for the alignText property.
private var _alignText:String = "right";

// Define a flag to indicate when the _alignText property changes.

private var bAlignTextChanged:Boolean = false;

// Define getter and setter methods for the property.

public function get alignText():String {
return _alignText;
}

public function set alignText(t:String):void {

_alignText = t;
bAlignTextChanged = true;

// Trigger the commitProperties(), measure(), and updateDisplayList()

// methods as necessary.
// In this case, you do not need to remeasure the component.
invalidateProperties();
invalidateDisplayList();
}

// Implement the commitProperties() method.

override protected function commitProperties():void {
super.commitProperties();

// Check whether the flag indicates a change to the alignText property.

if (bAlignTextChanged) {
// Reset flag.
bAlignTextChanged = false;

// Handle alignment change

}
}

As you can see in this example, the setter method modifies the property, calls the
invalidateProperties() and invalidateDisplayList() methods, then returns. The
setter itself does not perform any calculations based on the new property value. This design
lets the setter method return quickly, and leaves any processing of the new value to the
commitProperties() method.

Implementing the component 161

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Changing the alignment of text in a control does not necessarily change the control’s size.
However, if it does, include a call to the invalidateSize() method to trigger the measure()
method.
The main advantages of using the commitProperties() method are the following:
■ To coordinate the modifications of multiple properties so that the modifications occur
synchronously.
For example, you might define multiple properties that control the text displayed by the
component, such as the alignment of the text within the component. A change to either
the text or the alignment property requires Flex to update the appearance of the
component. However, if you modify both the text and the alignment, you want Flex to
perform any calculations for sizing or positioning the component once, when the screen
updates.
Therefore, you use the commitProperties() method to calculate any values based on the
relationship of multiple component properties. By coordinating the property changes in
the commitProperties() method, you can reduce unnecessary processing overhead.
■ To coordinate multiple modifications to the same property.
You do not necessarily want to perform a complex calculation every time a user updates a
component property. For example, users modify the icon property of the Button control
to change the image displayed in the button. Calculating the label position based on the
presence or size of an icon can be a computationally expensive operation that you want to
perform only when necessary.
To avoid this behavior, you use the commitProperties() method to perform the
calculations. Flex calls the commitProperties() method when it updates the display.
That means you perform the calculations once when Flex updates the screen, regardless of
the number of times the property changed between screen updates.
The following example shows how you can handle two related properties in the
commitProperties() method:
// Define a private variable for the text property.
private var _text:String = "ModalText";
private var bTextChanged:Boolean = false;

// Define the getter method.

public function get text():String {
return _text;
}

//Define the setter method to call invalidateProperties()

// when the property changes.
public function set text(t:String):void {
_text = t;

162 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
bTextChanged = true;
invalidateProperties();
// Changing the text causes the control to recalculate its default size.
invalidateSize();
invalidateDisplayList();
}

// Define a private variable for the alignText property.

private var _alignText:String = "right";
private var bAlignTextChanged:Boolean = false;

public function get alignText():String {

return _alignText;
}

public function set alignText(t:String):void {

_alignText = t;
bAlignTextChanged = true;
invalidateProperties();
invalidateDisplayList();
}

// Implement the commitProperties() method.

override protected function commitProperties():void {
super.commitProperties();

// Check whether the flags indicate a change to both properties.

if (bTextChanged && bAlignTextChanged) {
// Reset flags.
bTextChanged = false;
bAlignTextChanged = false;

// Handle case where both properties changed.

}

// Check whether the flag indicates a change to the text property.

if (bTextChanged) {
// Reset flag.
bTextChanged = false;

// Handle text change.

}

// Check whether the flag indicates a change to the alignText property.

if (bAlignTextChanged) {
// Reset flag.
bAlignTextChanged = false;

// Handle alignment change.

Implementing the component 163

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
}
}

Implementing the measure() method

The measure() method sets the default component size, in pixels, and optionally sets the
component’s default minimum size.
Flex schedules a call to the measure() method when a call to the invalidateSize() method
occurs. The measure() method executes during the next render event after a call to the
invalidateSize() method. When you use the addChild() method to add a component to
a container, Flex automatically calls the invalidateSize() method.
When you set a specific height and width of a component, Flex does not call the measure()
method, even if you explicitly call the invalidateSize() method. That is, Flex only calls the
measure() method if the explicitWidth property or the explicitHeight property of the
component is NaN.
In the following example, because you explicitly set the size of the Button control, Flex does
not call the Button.measure() method:
<mx:Button height="10" width="10"/>

In a subclass of an existing component, you might implement the measure() method only if
you are performing an action that requires modification to the default sizing rules defined in
the superclass. Therefore, to set a new default size, or perform calculations at run time to
determine component sizing rules, implement the measure() method.
You set the following properties in the measure() method to specify the default size:

Properties Characteristics Description

measuredHeight Default height Specifies the default height and width of the
measuredWidth and width component, in pixels.
These properties are set to 0 until the measure()
method executes. Although you can leave them set
to 0, it makes the component invisible by default.
measuredMinHeight Default minimum Specifies the default minimum height and minimum
measuredMinWidth height and width width of the component, in pixels. Flex cannot set
the size of a component smaller than its specified
minimum size.

The measure() method only sets the default size of the component. In the
updateDisplayList() method, the parent container of the component passes to it its actual
size, which may be different than the default size.

164 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Component users can also override the default size settings in an application by using the
component in the following ways:
■ Setting the explicitHeight and exlicitWidth properties
■ Setting the width and height properties
■ Setting the percentHeight and percentWidth properties
For example, you can define a Button control with a default size of 100 pixels wide and
50 pixels tall, and a default minimum size of 50 pixels by 25 pixels, as the following example
shows:
package myComponents
{
// asAdvanced/myComponents/DeleteTextArea.as
import mx.controls.Button;

public class BlueButton extends Button {

public function BlueButton() {

super();
}

override protected function measure():void {

super.measure();

measuredWidth=100;
measuredMinWidth=50;
measuredHeight=50;
measuredMinHeight=25;
}
}
}
The following application uses this button in an application:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<mx:VBox>
<MyComp:BlueButton/>
<mx:Button/>
</mx:VBox>
</mx:Application>
In the absence of any other sizing constraints on the button, the VBox container uses the
default size and default minimum size of the button to calculate its size at run time. For
information on the rules for sizing a component, see Chapter 15, “Introducing Containers,”
in Flex Developer’s Guide.

Implementing the component 165

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can override the default size settings in an application, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<mx:VBox>
<MyComp:BlueButton width="50%"/>
<mx:Button/>
</mx:VBox>
</mx:Application>
In this example, you specify that the width of the button is 50% of the width of the VBox
container. When 50% of the width if the container is smaller than the minimum width of the
button, the button uses its minimum width.

Calculating default sizes

The example in “Implementing the measure() method” on page 164 uses static values for the
default size and default minimum size of a component. Some Flex components use static sizes.
For example, the TextArea control has a default size of 100 pixels wide by 44 pixels high,
regardless of the text it contains. If the text is larger than the TextArea control, the control
displays scroll bars.
Often, you set the default size based on characteristics of the component or information
passed to the component. For example, the Button control’s measure() method examines its
label text, margin settings, and font characteristics to determine the control’s default size.

166 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In the following example, you override the measure() method of the TextArea control so that
it examines the text passed to the control, and calculates the default size of the TextArea
control to display the entire text string in a single line.
package myComponents
{
// asAdvanced/myComponents/MyTextArea.as
import mx.controls.TextArea;
import flash.text.TextLineMetrics;

public class MyTextArea extends TextArea

{

public function MyTextArea() {

super();
}

// The default size is the size of the text plus a 10 pixel margin.
override protected function measure():void {
super.measure();

// Calculate the default size of the control based on the

// contents of the TextArea.text property.
var lineMetrics:TextLineMetrics = measureText(text);
// Add a 10 pixel border area around the text.
measuredWidth = measuredMinWidth = lineMetrics.width + 10;
measuredHeight = measuredMinHeight = lineMetrics.height + 10;
}
}
}
For text strings that are longer than the display area of your application, you can add logic to
increase the height of the TextArea control to display the text on multiple lines. The following
application uses this component:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<MyComp:MyTextArea id="myTA" text="This is a long text strring that

would normally cause a TextArea control to display scroll bars. But, the
custom MyTextArea control calcualtes its default size based on the text
size."/>

<mx:TextArea id="flexTA" text="This is a long text strring that would

normally cause a TextArea control to display scroll bars. But, the custom
MyTextArea control calcualtes its default size based on the text size."/>

</mx:Application>

Implementing the component 167

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Implementing the layoutChrome() method
The Container class, and some subclasses of the Container class, use the layoutChrome()
method to define the border area around the container.
Flex schedules a call to the layoutChrome() method when a call to the
invalidateDisplayList() method occurs. The layoutChrome() method executes during
the next render event after a call to the invalidateDisplayList() method. When you use
the addChild() method to add a component to a container, Flex automatically calls the
invalidateDisplayList() method.

Typically, you use the RectangularBorder class to define the border area of a container. For
example, you can create the RectangularBorder object, and add it as a child of the component
in your override of the createChildren() method.
When you create a subclass of the Container class, you can use the createChildren()
method to create the content children of the container; the content children are the child
components that appear within the container. You then use updateDisplayList() to
position the content children.
You typically use the layoutChrome() method to define and position the border area of the
container, and any additional elements that you want to appear in the border area. For
example, the Panel container uses the layoutChrome() method to define the title area of the
panel container, including the title text and close button.
The primary reason for dividing the handling of the content area of a container from its
border area is to handle the situation when the Container.autoLayout property is set to
false. When the autoLayout property is set to true, measurement and layout of the
container and of its children are done whenever the position or size of a container child
changes. The default value is true.
When the autoLayout property is set to false, measurement and layout are done only once,
when children are added to or removed from the container. However, Flex executes the
layoutChrome() method in both cases. Therefore, the container can still update its border
area even when the autoLayout property is set to false.

Implementing the updateDisplayList() method

The updateDisplayList() method sizes and positions the children of your component
based on all previous property and style settings, and draws any skins or graphic elements that
the component uses. The parent container for the component determines the size of the
component itself.

168 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
A component does not appear on the screen until its updateDisplayList() method gets
called. Flex schedules a call to the updateDisplayList() method when a call to the
invalidateDisplayList() method occurs. The updateDisplayList() method executes
during the next render event after a call to the invalidateDisplayList() method. When
you use the addChild() method to add a component to a container, Flex automatically calls
the invalidateDisplayList() method.
The main uses of the updateDisplayList() method are the following:
■ Sets the size and position of the elements of the component for display.
Many components are made up of one or more child components, or have properties that
control the display of information in the component. For example, the Button control lets
you specify an optional icon, and use the labelPlacement property to specify where the
button text appears relative to the icon.
The Button.updateDisplayList() method uses the settings of the icon and
labelPlacement properties to control the display of the button.
For containers that have child controls, the updateDisplayList() method controls how
those child components are positioned. For example, the updateDisplayList() method
on the HBox container positions its children from left to right in a single row; the
updateDisplayList() method for a VBox container positions its children from top to
bottom in a single column.
To size components in the updateDisplayList() method, you use the
setActualSize() method, not the sizing properties, such as width and height. To
position a component, use the move() method, not the x and y properties.
■ Draws any visual elements necessary for the component.
Components support many types of visual elements such as skins, styles, and borders.
Within the updateDisplayList() method, you can add these visual elements, use the
Flash drawing APIs, and perform additional control over the visual display of your
component.
The updateDisplayList() method has the following signature:
protected function updateDisplayList(unscaledWidth:Number,
unscaledHeight:Number):void

Implementing the component 169

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The properties have the following values:
unscaledWidth Specifies the width of the component, in pixels, in the component’s
coordinates, regardless of the value of the scaleX property of the component. This is the
width of the component as determined by its parent container.
unscaledHeight Specifies the height of the component, in pixels, in the component’s
coordinates, regardless of the value of the scaleY property of the component. This is the
height of the component as determined by its parent container.
Scaling occurs in Flash Player, after updateDisplayList() executes. For example, a
component with an unscaledHeight value of 100, and with a scaleY property of 2.0,
appears 200 pixels high in Flash Player.

Overriding the layout mechanism of the VBox container

The VBox container lays out its children from the top of the container to the bottom of the
container in the order in which the children are added to the container. The following
example overrides the updateDisplayList() method, which causes the VBox container to
layout its children from the bottom of the container to the top:
package myComponents
{
// asAdvanced/myComponents/BottomUpVBox.as
import mx.containers.VBox;
import mx.core.EdgeMetrics;
import mx.core.UIComponent;

public class BottomUpVBox extends VBox

{

public function BottomUpVBox() {

super();
}

override protected function updateDisplayList(unscaledWidth:Number,

unscaledHeight:Number):void {

super.updateDisplayList(unscaledWidth, unscaledHeight);

// Get information about the container border area.

// The usable area of the container for its children is the
// container size, minus any border areas.
var vm:EdgeMetrics = viewMetricsAndPadding;

// Get the setting for the vertical gap between children.

var gap:Number = getStyle("verticalGap");

// Determine the y coordinate of the bottom of the usable area

170 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
// of the VBox.
var yOfComp:Number = unscaledHeight-vm.bottom;

// Temp variable for a container child.

var obj:UIComponent;

for (var i:int = 0; i < numChildren; i++)

{
// Get the first container child.
obj = UIComponent(getChildAt(i));

// Determine the y coordinate of the child.

yOfComp = yOfComp - obj.height;

// Set the x and y coordinate of the child.

// Note that you do not change the x coordinate.
obj.move(obj.x, yOfComp);

// Save the y coordinate of the child,

// plus the vertical gap between children.
// This is used to calculate the coordinate
// of the next child.
yOfComp = yOfComp - gap;
}
}
}
}
In this example, you use the UIComponent.move() method to set the position of each child in
the container. You can also use the UIComponent.x and UIComponent.y properties to set
these coordinates. The difference is that the move() method changes the location of the
component and then dispatches a move event when you call the method immediately; setting
the x and y properties changes the location of the component and dispatches the event on the
next screen update.

Implementing the component 171

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following application uses this component:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<MyComp:BottomUpVBox>
<mx:Label text="Label 1"/>
<mx:Button label="Button 1"/>

<mx:Label text="Label 2"/>

<mx:Button label="Button 2"/>

<mx:Label text="Label 3"/>

<mx:Button label="Button 3"/>

<mx:Label text="Label 4"/>

<mx:Button label="Button 4"/>

</MyComp:BottomUpVBox>
</mx:Application>

Drawing graphics in your component

Every Flex component is a subclass of the Flash Sprite class, and, therefore, inherits the
Sprite.graphics property. The Sprite.graphics property specifies a Graphics object that
you can use to add vector drawings to your component.
For example, in the updateDisplayList() method, you can use methods of the Graphics
class to draw borders, rules, and other graphical elements:
override protected function updateDisplayList(unscaledWidth:Number,
unscaledHeight:Number):void {

super.updateDisplayList(unscaledWidth, unscaledHeight);

// Draw a simple border around the child components.

graphics.lineStyle(1, 0x000000, 1.0);
graphics.drawRect(0, 0, unscaledWidth, unscaledHeight);
}

Making components accessible

A growing requirement for web content is that it should be accessible to people who have
disabilities. Visually impaired people can use the visual content in Flash applications by using
screen reader software, which provides an audio description of the material on the screen.

172 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
When you create a component, you can include ActionScript that enables the component and
a screen reader for audio communication. When developers use your component to build an
application in Flash, they use the Accessibility panel to configure each component instance.
Flash includes the following accessibility features:
■ Custom focus navigation
■ Custom keyboard shortcuts
■ Screen-based documents and the screen authoring environment
■ An Accessibility class
To enable accessibility in your component, add the following line to your component’s class
file:
mx.accessibility.ComponentName.enableAccessibility();

For example, the following line enables accessibility for the MyButton component:
mx.accessibility.MyButton.enableAccessibility();

For additional information about accessibility, see Chapter 39, “Creating Accessible
Applications,” in Flex Developer’s Guide.

Adding version numbers

When releasing components, you can define a version number. This lets developers know
whether they should upgrade, and helps with technical support issues. When you set a
component’s version number, use the static variable version, as the following example shows:
static var version:String = "1.0.0.42";
N OTE

Flex does not use or interpret the value of the version property.

If you create many components as part of a component package, you can include the version
number in an external file. That way, you update the version number in only one place. For
example, the following code imports the contents of an external file that stores the version
number in one place:
include "../myPackage/ComponentVersion.as"

The contents of the ComponentVersion.as file are identical to the previous variable
declaration, as the following example shows:
static var version:String = "1.0.0.42";

Adding version numbers 173

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Best practices when designing a
component
Use the following practices when you design a component:
■ Keep the file size as small as possible.
■ Make your component as reusable as possible by generalizing functionality.
■ Use the Border class rather than graphical elements to draw borders around objects.
■ Use tag-based skinning.
■ Assume an initial state. Because style properties are on the object, you can set initial
settings for styles and properties so your initialization code does not have to set them
when the object is constructed, unless the user overrides the default state.

Example: Creating a composite

component
Composite components are components that contain multiple components. They might be
graphical assets or a combination of graphical assets and component classes. For example, you
can create a component that includes a button and a text field, or a component that includes
a button, a text field, and a validator.
When you create composite components, you should instantiate the controls inside the
component’s class file. Assuming that some of these controls have graphical assets, you must
plan the layout of the controls that you are including, and set properties such as default values
in your class file. You must also ensure that you import all the necessary classes that the
composite component uses.
Because the class extends one of the base classes, such as UIComponent, and not a controls
class like Button, you must instantiate each of the controls as children of the custom
component and arrange them on the screen.
Properties of the individual controls are not accessible from the MXML author’s environment
unless you design your class to allow this. For example, if you create a component that extends
the UIComponent class and uses a Button and a TextArea component, you cannot set the
Button control’s label text in the MXML tag because you do not directly extend the Button
class.

174 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Example: Composite component
This section uses an example component, called ModalText and defined in the file
ModalText.as, that combines a Button control and a TextArea control. You use the Button
control to enable or disable text input in the TextArea control.

Defining event listeners for composite components

Custom components implement the createChildren() method to create children of the
component, as the following example shows:
override protected function createChildren():void {
super.createChildren();

// Create and initialize the TextArea control.

if (!text_mc) {
text_mc = new TextArea();
...
text_mc.addEventListener("change", handleChangeEvent);
addChild(text_mc);
}

// Create and initialize the Button control.

if (!mode_mc) {
mode_mc = new Button();
...
mode_mc.addEventListener("click", handleClickEvent);
addChild(mode_mc);
}
}

The createChildren() method also contains a call to the addEventListener() method to

register an event listener for the change event generated by the TextArea control, and for the
click event for the Button control. These event listeners are defined within the ModalText
class, as the following example shows:
// Handle events that are dispatched by the children.
private function handleChangeEvent(eventObj:Event):void {
dispatchEvent(new Event("change"));
}

// Handle events that are dispatched by the children.

private function handleClickEvent(eventObj:Event):void {
text_mc.editable = !text_mc.editable;
}

You can handle an event dispatched by a child of a composite component in the component.
In this example, the event listener for the Button control’s click event is defined in the class
definition to toggle the editable property of the TextArea control.

Example: Creating a composite component 175

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
However, if a child component dispatches an event, and you want that opportunity to handle
the event outside of the component, you must add logic to your custom component to
propagate the event. Notice that the event listener for the change event for the TextArea
control propagates the event. This lets you handle the event in your application, as the
following example shows:
<?xml version="1.0"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Script>
<![CDATA[

import flash.events.Event;

function handleText(eventObj:Event)
{
...
}
]]>
</mx:Script>

<MyComp:ModalText change="handleText(event);"/>
</mx:Application>

Creating the ModalText component

The following code example implements the class definition for the ModalText component.
The ModalText component is a composite component that contains a Button control and a
TextArea control. The following image shows this control:

This control has the following attributes:

■ You cannot edit the TextArea control by default.
■ You click the Button control to toggle editing of the TextArea control.
■ You use the textPlacement property of the control to make the TextArea appear on the
right side or the left side of the control.
■ Editing the textPlacement property of the control dispatches the placementChanged
event.
■ You use the text property to programmatically write content to the TextArea control.
■ Editing the text property of the control dispatches the textChanged event.
■ Editing the text in the TextArea control dispatches the change event.

176 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
■ You can use both the textPlacement property or the text property as the source for a
data binding expression.
■ You can optionally use skins for the up, down, and over states of the Button control.
The following is an example MXML file that uses the ModalText control and sets the
textPlacement property to left:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<MyComp:ModalText textPlacement="left"/>

</mx:Application>
You can handle the placementChanged event to determine when the
ModalText.textPlacement property is modified, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<mx:Script>
<![CDATA[
import flash.events.Event;

private function placementChangedListener(event:Event):void {

myEvent.text="placementChanged event occurred - textPlacement = "
+ myMT.textPlacement as String;
}
]]>
</mx:Script>

<MyComp:ModalText id="myMT" textPlacement="left"

placementChanged="placementChangedListener(event);"/>
<mx:TextArea id="myEvent" width="50%"/>

<mx:Label text="Change Placement" />

<mx:Button label="Set Text Placement Right"
click="myMT.textPlacement='right';" />
<mx:Button label="Set Text Placement Left"
click="myMT.textPlacement='left';" />

</mx:Application>

Example: Creating a composite component 177

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example shows the ModalText.as file that defines this control:
package myComponents
{
// Import all necessary classes.
import mx.core.UIComponent;
import mx.controls.Button;
import mx.controls.TextArea;
import flash.events.Event;
import flash.text.TextLineMetrics;

// ModalText dispatches a change event when the text of the child

// TextArea control changes, a textChanged event when you set the text
// property of ModalText, and a placementChanged event
// when you change the textPlacement property of ModalText.
[Event(name="change", type="flash.events.Event")]
[Event(name="textChanged", type="flash.events.Event")]
[Event(name="placementChanged", type="flash.events.Event")]

/* a) Extend UIComponent. */

public class ModalText extends UIComponent {

/* b) Implement the class constructor. */

public function ModalText() {
super();
}

/* c) Define variables for the two child components. */

// Declare two variables for the component children.
private var text_mc:TextArea;
private var mode_mc:Button;

/* d) Embed new skins used by the Button component. */

// You can create a SWF file that contains symbols with the names
// ModalUpSkin, ModalOverSkin, and ModalDownSkin.
// If you do not have skins, comment out these lines.
[Embed(source="Modal2.swf", symbol="blueCircle")]
public var modeUpSkinName:Class;

[Embed(source="Modal2.swf", symbol="blueCircle")]
public var modeOverSkinName:Class;

[Embed(source="Modal2.swf", symbol="greenSquare")]
public var modeDownSkinName:Class;

/* e) Implement the createChildren() method. */

// Test for the existence of the children before creating them.
// This is optional, but we do this so a subclass can create a

178 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
// different child instead.
override protected function createChildren():void {
super.createChildren();

// Create and initialize the TextArea control.

if (!text_mc)
{
text_mc = new TextArea();
text_mc.explicitWidth = 80;
text_mc.editable = false;
text_mc.text= _text;
text_mc.addEventListener("change", handleChangeEvent);
addChild(text_mc);
}

// Create and initialize the Button control.

if (!mode_mc)
{ mode_mc = new Button();
mode_mc.label = "Toggle Editing Mode";
// If you do not have skins available,
// comment out these lines.
mode_mc.setStyle('overSkin', modeOverSkinName);
mode_mc.setStyle('upSkin', modeUpSkinName);
mode_mc.setStyle('downSkin', modeDownSkinName);
mode_mc.addEventListener("click", handleClickEvent);
addChild(mode_mc);
}
}

/* f) Implement the commitProperties() method. */

override protected function commitProperties():void {
super.commitProperties();

if (bTextChanged) {
bTextChanged = false;
text_mc.text = _text;
invalidateDisplayList();
}
}

/* g) Implement the measure() method. */

// The default width is the size of the text plus the button.
// The height is dictated by the button.
override protected function measure():void {
super.measure();

// Since the Button control uses skins, get the

// measured size of the Button control.

Example: Creating a composite component 179

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
var buttonWidth:Number = mode_mc.getExplicitOrMeasuredWidth();
var buttonHeight:Number = mode_mc.getExplicitOrMeasuredHeight();

// The default and minimum width are the measuredWidth

// of the TextArea control plus the measuredWidth
// of the Button control.
measuredWidth = measuredMinWidth =
text_mc.measuredWidth + buttonWidth;

// The default and minimum height are the larger of the

// height of the TextArea control or the measuredHeight of the
// Button control, plus a 10 pixel border around the text.
measuredHeight = measuredMinHeight =
Math.max(mode_mc.measuredHeight,buttonHeight) + 10;
}

/* h) Implement the updateDisplayList() method. */

// Size the Button control to the size of its label text
// plus a 10 pixel border area.
// Size the TextArea to the remaining area of the component.
// Place the children depending on the setting of
// the textPlacement property.
override protected function updateDisplayList(unscaledWidth:Number,
unscaledHeight:Number):void {
super.updateDisplayList(unscaledWidth, unscaledHeight);

// Subtract 1 pixel for the left and right border,

// and use a 3 pixel margin on left and right.
var usableWidth:Number = unscaledWidth - 8;

// Subtract 1 pixel for the top and bottom border,

// and use a 3 pixel margin on top and bottom.
var usableHeight:Number = unscaledHeight - 8;

// Calculate the size of the Button control based on its text.

var lineMetrics:TextLineMetrics = measureText(mode_mc.label);
// Add a 10 pixel border area around the text.
var buttonWidth:Number = lineMetrics.width + 10;
var buttonHeight:Number = lineMetrics.height + 10;
mode_mc.setActualSize(buttonWidth, buttonHeight);

// Calculate the size of the text

// Allow for a 5 pixel gap between the Button
// and the TextArea controls.
var textWidth:Number = usableWidth - buttonWidth - 5;
var textHeight:Number = usableHeight;
text_mc.setActualSize(textWidth, textHeight);

// Position the controls based on the textPlacement property.

180 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
if (textPlacement == "left") {
text_mc.move(4, 4);
mode_mc.move(4 + textWidth + 5, 4);
}
else {
mode_mc.move(4, 4);
text_mc.move(4 + buttonWidth + 5, 4);
}

// Draw a simple border around the child components.

graphics.lineStyle(1, 0x000000, 1.0);
graphics.drawRect(0, 0, unscaledWidth, unscaledHeight);
}

/* i) Add methods, properties, and metadata. */

// The general pattern for properties is to specify a private
// holder variable.
private var _textPlacement:String = "left";

// Create a getter/setter pair for the textPlacement property.

public function set textPlacement(p:String):void {
_textPlacement = p;
invalidateDisplayList();
dispatchEvent(new Event("placementChanged"));
}

// The textPlacement property supports data binding.

[Bindable(event="placementChanged")]
public function get textPlacement():String {
return _textPlacement;
}

private var _text:String = "ModalText";

private var bTextChanged:Boolean = false;

// Create a getter/setter pair for the text property.

public function set text(t:String):void {
_text = t;
bTextChanged = true;
invalidateProperties();
dispatchEvent(new Event("textChanged"));
}

[Bindable(event="textChanged")]
public function get text():String {
return text_mc.text;
}

// Handle events that are dispatched by the children.

Example: Creating a composite component 181

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
private function handleChangeEvent(eventObj:Event):void {
dispatchEvent(new Event("change"));
}

// Handle events that are dispatched by the children.

private function handleClickEvent(eventObj:Event):void {
text_mc.editable = !text_mc.editable;
}
}
}

Troubleshooting
This section describes some common problems and their solutions when you create
components for Flex in Flash.
I get an error “don't know how to parse…” when I try to use the component from MXML.
This means that the compiler could not find the SWC file, or the contents of the SWC file
did not list the component. Ensure that the SWC file is in a directory that Flex searches, and
ensure that your xmlns property is pointing to the right place. Try moving the SWC file to
the same directory as the MXML file and setting the namespace to "*" as the following
example shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" xmlns="*">

For more information, see Chapter 9, “Using the Flex Compilers,” in Building and Deploying
Flex Applications.
I get an error “xxx is not a valid attribute…” when I try to use the component from MXML.
Ensure that the attribute is spelled correctly. Also ensure that it is not private.
I don't get any errors, but nothing appears.
Verify that the component was instantiated. One way to do this is to put a Button control and
a TextArea control in the MXML application and set the text property to the ID for the
component when the button is clicked; for example:

<zz:mycomponent id="foo"/>
<mx:TextArea id="output"/>
<mx:Button label="Print Output" click="output.text = foo.id;"/>

The component is instantiated properly but does not appear (1).

182 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In some cases, helper classes are not ready by the time your component requires them. Flex
adds classes to the application in the order that they must be initialized (base classes, and then
child classes). However, if you have a static method that gets called as part of the initialization
of a class, and that static method has class dependencies, Flex does not know to place that
dependent class before the other class, because it does not know when that method is going to
be called.
One possible remedy is to add a static variable dependency to the class definition. Flex knows
that all static variable dependencies must be ready before the class is initialized, so it orders the
class loading correctly.
The following example adds a static variable to tell the linker that class A must be initialized
before class B:
public class A {

static function foo():Number {

return 5;
}
}

public class B {
static function bar():Number {
return mx.example.A.foo();
}

static var z = B.bar();

// Dependency
static var ADependency:mx.example.A = mx.example.A;
}

The component is instantiated properly but does not appear (2).

Verify that the measuredWidth and measuredHeight properties are nonzero. If they are zero
or NaN, ensure that you implemented the measure() method correctly.
You can also verify that the visible property is set to true. If visible=false, ensure that
your component called the invalidateDisplayList() method.
The component is instantiated properly but does not appear (3).

It is possible that there is another class or SWC file that overrides your custom class or the
symbols used in your component. Ensure that there are no naming conflicts.

Troubleshooting 183
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

184 Creating Advanced Visual Components in ActionScript

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 11

Creating Custom Style

Properties
11
Styles are useful for defining the look and feel of your Adobe Flex applications, including
letting users set component skins. You can use them to change the appearance of a single
component, or apply them across all components. This topic describes how to create style
properties for your custom components.

Contents
About styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Example: Creating style properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

About styles
You modify the appearance of Flex components through style properties. These properties can
define the size of a font used in a Label control, or the background color used in the Tree
control. In Flex, some styles are inherited from parent containers to their children, and across
style types and classes. This means that you can define a style once, and then have that style
apply to all controls of a single type or to a set of controls. Also, you can override individual
properties for each control at a local, document, or global level, giving you great flexibility in
controlling the appearance of your applications.
For more information, see Chapter 20, “Using Styles and Themes,” in Flex Developer’s Guide.

185
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
About inheritance in Cascading Style Sheets
When you implement a style property in an ActionScript component, that property is
automatically inherited by any subclasses of your class, just as methods and properties are
inherited. This type of inheritance is called object-oriented inheritance.
Some style properties also support Cascading Style Sheet (CSS ) inheritance. CSS inheritance
means that if you set the value of a style property on a parent container, a child of that
container inherits the value of the property when your application runs. For example, if you
define the fontFamily style as Times for a Panel container, all children of that container use
Times for fontFamily, unless they override that property.
In general, color and text styles support CSS inheritance, regardless of whether they are set by
using CSS or style properties. All other styles do not support CSS inheritance, unless
otherwise noted.
If you set a style on a parent that does not support CSS inheritance, such as textDecoration,
only the parent container uses that value, and not its children. There is an exception to the
rules of CSS inheritance. If you use the global type selector in a CSS style definition, Flex
applies those style properties to all controls, regardless of whether the properties are
inheritable.
For more information about style inheritance, see Chapter 20, “Using Styles and Themes,” in
Flex Developer’s Guide.

About setting styles

Flex provide several ways of setting component styles: using MXML tag attributes, calling the
setStyle() method, and CSS. This section describes the different ways to set styles, and the
actions that Flex performs when you set styles.

186 Creating Custom Style Properties

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Setting styles using MXML tag attributes
Component users can use MXML tag attributes to set a style property on a component. For
example, the following code creates a TextArea control, then sets the backgroundColor style
of the component to blue (0x0000FF):
<mx:TextArea id="myTA" backgroundColor="0x0000FF"/>

Setting styles using the setStyle() method

Component users can use the setStyle() method to set a style property on a component.
For example, the following code creates a TextArea control, then sets the backgroundColor
style of the component to blue (0x0000FF):
var myTA:TextArea=new TextArea()
myTA.setStyle('backgroundColor', 0x0000FF);

Setting styles using CSS

Component users can use the <mx:Styles> tag to set CSS styles in an MXML application, as
the following example shows:
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<mx:Style>
TextArea {backgroundColor: "0x0000FF"}
</mx:Style>

<mx:TextArea/>

</mx:Application>

You can also import an external CSS file, as the following example shows:
<mx:Style source="myStyle.css"/>

About styles 187

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
About overriding the styleChanged() method
When a user sets a style on a component, Flex calls the component’s styleChanged()
method, passing to it the name of the style being set. When you create a custom component,
you can override the UIComponent.styleChanged() method to check the style name passed
to it, and handle the change accordingly, as the following example shows:
var bBackgroundColor:Boolean=false;

override public function styleChanged(styleProp:String):void {

super.styleChanged(styleProp);

// Check to see if style changed.

if (styleProp=="backgroundColor")
{
bBackgroundColor=true;
invalidateDisplayList();
return;
}
}

The styleChanged() method first calls superclass’s styleChanged() method to let the
superclass handle the style change.
After the superclass gets a call to handle the style change, your component can detect that the
user set the backgroundColor style, and handle it. By handling the style change after the
superclass makes the change, you can override the way the superclass handles the style.
Notice that the method calls the invalidateDisplayList() method, which causes Flex to
execute the component’s updateDisplayList() method at the next screen update. Although
you can detect style changes in the styleChanged() method, you still use the
updateDisplayList() method to draw the component on the screen. For more information,
see “Defining a style property” on page 191.

188 Creating Custom Style Properties

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Typically, you use a flag to indicate that a style changed. In the updateDisplayList()
method, you check the flag and update the component based on the new style setting, as the
following example shows:
override protected function updateDisplayList(unscaledWidth:Number,
unscaledHeight:Number):void {

super.updateDisplayList(unscaledWidth, unscaledHeight);

// Check to see if style changed.

if (bBackgroundColor==true)
{
// Redraw the component using the new style.
...
}
}

By using flags to signal style updates to the updateDisplayList() method, the

updateDisplayList() method has to perform only the updates based on the style changes; it
may not have to redraw or recalculate the appearance of the entire component. For example, if
you are changing only the border color of a component, it is more efficient to redraw only the
border, rather than redrawing the entire component every time someone changes a style.

Example: Creating style properties

When you create a component, you might want to create a style property so that component
users can configure it by using styles. For example, you create a component, named
StyledRectangle, that uses a gradient fill pattern to define its color, as the following example
shows:

Example: Creating style properties 189

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
This gradient is defined by two colors that you set by using a new style property called
fillColors. The fillColors style takes an array of two colors that component users can set.
The StyledRectangle.as class defines default colors for the fillColors style, but you can also
set them as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Style>
StyledRectangle {fillColors: #FF00FF, #00FFFF}
</mx:Style>

<MyComp:StyledRectangle id="mySR1"/>

<MyComp:StyledRectangle id="mySR2"/>

<mx:Button label="Set gradient"
click="mySR2.setStyle('fillColors', [0x000000, 0xFFFFFF]);"/>

<MyComp:StyledRectangle id="mySR3" fillColors="[0x00FF00, 0xFFFFFF]"/>

</mx:Application>
In this example, the CSS type selector for the StyledRectangle component sets the initial
values of the fillColors property to #FF00FF and #00FFFF. For the second StyledRectangle
components, you use the click event of a Button control to change the fillColor style by
using the setStyle() method. The third component sets the style property by using an
MXML tag attribute.

190 Creating Custom Style Properties

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Defining a style property
You define a style property for a component in the class definition.

To define a new style property:

1. Insert the [Style] metadata tag that defines the style before the class definition.
You insert the [Style] metadata tag before the class definition to define the MXML tag
attribute for a style property. If you omit the [Style] metadata tag, the MXML compiler
issues a syntax error when you try to set the property as an MXML tag attribute.
The [Style] metadata tag has the following syntax:
[Style(name="style_name"[,property="value",...])]

For more information, see Chapter 5, “Using Metadata Tags in Custom Components,” on
page 45.
2. Override the styleChanged() method to detect changes to the property.
3. Override updateDisplayList() method to incorporate the style into the component
display.
4. Define a static initializer to set the default value of the style property.
For more information, see “Setting default style values” on page 194.

Example: Creating style properties 191

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following code example defines the StyledRectangle component and the fillColors
style:
package myComponents
{
// skinstyle/myComponents/StyledRectangle.as
import mx.core.UIComponent;
import mx.styles.CSSStyleDeclaration;
import mx.styles.StyleManager;
import flash.display.GradientType;

// Insert the [Style] metadata tag to define the name, type

// and other infomration about the style property for the
// MXML compiler.
[Style(name="fillColors",type="Array",format="Color",inherit="no")]
public class StyledRectangle extends UIComponent
{

// Define a static variable.

private static var classConstructed:Boolean = classConstruct();

// Define a static method.

private static function classConstruct():Boolean {
if (!StyleManager.getStyleDeclaration("StyledRectangle"))
{
// If there is no CSS definition for StyledRectangle,
// then create one and set the default value.
var newStyleDeclaration:CSSStyleDeclaration =
new CSSStyleDeclaration();
newStyleDeclaration.setStyle("fillColors", [0xFF0000,
0x0000FF]);
StyleManager.setStyleDeclaration("StyledRectangle",
newStyleDeclaration, true);
}
return true;
}

// Constructor
public function StyledRectangle() {
super();
}

// Define a default size of 100 x 100 pixels.

override protected function measure():void {
super.measure();

measuredWidth = measuredMinWidth = 100;

measuredHeight = measuredMinHeight = 100;
}

192 Creating Custom Style Properties

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

// Define the variable to hold the current gradient fill colors.

private var fillColorsData:Array;
private var bFillColorsChanged:Boolean = true;

// Define variables for additional controls on the fill.

// You can create style properties for these as well.
private var alphas:Array = [1.0, 1.0];
private var ratios:Array = [0x00, 0xFF];

// Override styleChanged() to detect changes in your new style.

override public function styleChanged(styleProp:String):void {

super.styleChanged(styleProp);

// Check to see if style changed.

if (styleProp=="fillColors")
{
bFillColorsChanged=true;
invalidateDisplayList();
return;
}
}

// Override updateDisplayList() to update the component

// based on the style setting.
override protected function updateDisplayList(unscaledWidth:Number,
unscaledHeight:Number):void {
super.updateDisplayList(unscaledWidth, unscaledHeight);

// Check to see if style changed.

if (bFillColorsChanged==true)
{
// Redraw gradient fill only if style changed.
fillColorsData=getStyle("fillColors");
graphics.beginGradientFill(GradientType.LINEAR,
fillColorsData, alphas, ratios);
graphics.drawRect(0, 0, unscaledWidth, unscaledHeight);

}
}
}
}

Example: Creating style properties 193

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Setting default style values
One of the issues that you have to decide when you create a style property for your
component is how to set its default value. Setting a default value for a style property is not as
simple as calling the setStyle() method in the component’s constructor; you must take into
consideration how Flex processes styles, and the order of precedence of styles.
When Flex compiles your application, Flex first examines any style definitions in the
<mx:Style> tag, before it creates any components. Therefore, if you call setStyle() from
within the component’s constructor, which occurs after processing the <mx:Style> tag, you
set the style property on each instance of the component; this overrides any conflicting CSS
declarations in the <mx:Style> tag.
The easiest way to set a default value for a style property is to define a static initializer in your
component. A static initializer is executed once, the first time Flex creates an instance of a
component. In “Defining a style property” on page 191, you defined a static initializer, by
using the classConstructed variable and the classConstruct() method, as part of the
StyledRectangle.as class.
The classConstruct() method is invoked the first time Flex creates a StyledRectangle
component. This method determines a style definition for the StyledRectangle class already
exists, defined by using the <mx:Style> tag. If no style is defined, the classConstruct()
method creates one, and sets the default value for the style property.
Therefore, if you omit the <mx:Style> tag from your application, the style definition is
created by the classConstruct() method, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<MyComp:StyledRectangle/>

</mx:Application>

194 Creating Custom Style Properties

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
If you include the <mx:Style> tag, the <mx:Style> tag creates the default style definition, as
the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*">

<mx:Style>
StyledRectangle {fillColors: #FF00FF, #00FFFF}
</mx:Style>

<MyComp:StyledRectangle/>

</mx:Application>

Defining a style property for a skin

Flex lets you set component skins by using style properties. Your new component might also
support skins and, therefore, support setting skins by using style properties.
The mechanism for creating style properties to support skinning is the same as for creating
other style properties. Setting a style property for a skin that triggers a call to the
styleChanged() method. The styleChanged() method detects the change to the skin, and
performs any updates to the appearance of the component in the updateDisplayList()
method.
The one difference when defining a style property for a skin is how you specify the [Style]
metadata tag. When the style property corresponds to a skin, you specify Class as the value to
the type property of the metadata tag, as the following example shows:
[Style(name="downSkin", type="Class", inherit="no")]

For more information on creating skins, see Chapter 22, “Creating Skins,” in Flex Developer’s
Guide.

Example: Creating style properties 195

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

196 Creating Custom Style Properties

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 12

Creating Template
Components
12
One way to create reusable components is to define them as template components. A template
component defines properties with a general data type that lets the component user specify an
object of a concrete data type when using the component. By using a general data type to
define component properties, you create highly reusable components that can work with
many different types of objects.
This topic describes how to create template components.

Contents
About template components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Implementing a template component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

About template components

A standard component defines a property with a concrete data type, such as Number or
String. The component user must then pass a value that exactly matches the property’s data
type or else Flex issues a compiler error.
A template component is a component in which one or more of its properties is defined with a
general data type. This property serve as a slot for values that can be of the exact data type of
the property, or of a value of a subclass of the data type. For example, to accept any Flex visual
component as a property value, you define the data type of the property as UIComponent. To
accept only container components, you define the data type of the property as Container.
When you use the template component in an application, the component user sets the
property value to be an object with a concrete data type. You can think of the property as a
placeholder for information, where it is up to the component user to define the actual data
type of the property, rather than the component developer.

197
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example shows an application that uses a template component called
MyTemplateComponent:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*"
height="700" width="700">

<mx:Panel paddingTop="10" paddingBottom="10"

paddingRight="10" paddingLeft="10">

<MyComp:MyTemplateComponent id="myTComp1">
<MyComp:topRow>
<mx:Label text="top component"/>
</MyComp:topRow>
<MyComp:bottomRow>
<mx:Button label="Button 1"/>
<mx:Button label="Button 2"/>
<mx:Button label="Button 3"/>
</MyComp:bottomRow>
</MyComp:MyTemplateComponent>
</mx:Panel>
</mx:Application>
The MyTemplateComponent takes two properties:
■ The topRow property specifies the single Flex component that appears in the top row of
the VBox container.
■ The bottomRow property specifies one or more Flex components that appear along the
bottom row of the VBox container.
The implementation of the MyTemplateComponent consists of a VBox container that
displays its children in two rows. The following image shows the output of this application:

198 Creating Template Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The implementation of the topRow and bottomRow properties lets you specify any Flex
component as a value, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*"
height="700" width="700">

<mx:Panel paddingTop="10" paddingBottom="10"

paddingRight="10" paddingLeft="10">

<MyComp:MyTemplateComponent id="myTComp2">
<MyComp:topRow>
<mx:TextArea text="top component"/>
</MyComp:topRow>
<MyComp:bottomRow>
<mx:LinkButton label="Link 1"/>
<mx:LinkButton label="Link 2"/>
<mx:LinkButton label="Link 3"/>
</MyComp:bottomRow>
</MyComp:MyTemplateComponent>
</mx:Panel>
</mx:Application>
In this example, the top component is a TextArea control, and the bottom components are
two LinkButton controls.

Implementing a template component

The section “About template components” on page 197 shows an example of a template
component named MyTemplateComponet. Flex provides you with two primary ways to
create template components:
■ Create properties with general data types, such as UIComponent or Container
■ Create properties with the type IDeferredInstance.
The following sections describes these methods.

Using general data types in a template component

This section shows one implementation of the component MyTemplateComponent shown in
the section “About template components” on page 197 by defining the properties topRow
and bottomRow to be of type UIComponent. Users of the component can then specify any
object to these properties that is either an instance of the UIComponent class, or an instance
of a subclass of UIComponent.

Implementing a template component 199

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following code shows the implementation of MyTemplateComponent:
<?xml version="1.0"?>

<mx:VBox xmlns:mx="http://www.adobe.com/2006/mxml"
initialize="init();">

<mx:Script>
<![CDATA[

import mx.containers.HBox;
import mx.core.UIComponent;

// Define a property for the top component.

public var topRow:UIComponent;

// Define an Array of properties for a row of components.

// Restrict the type of the Array elements
// to mx.core.UIComponent.
[ArrayElementType("mx.core.UIComponent")]
public var bottomRow:Array;

private function init():void {

// Add the top component to the VBox container.
addChild(topRow);

// Create an HBox container. This container

// is the parent container of the bottom row of components.
var controlHBox:HBox = new HBox();

// Add the bottom row of components

// to the HBox container.
for (var i:int = 0; i < bottomRow.length; i++)
controlHBox.addChild(bottomRow[i]);

// Add the HBox container to the VBox container.

addChild(controlHBox);
}
]]>
</mx:Script>
</mx:VBox>
For the bottomRow property, you define it as an Array and include the [ArrayElementType]
metadata tag to specify to the compiler that the data type of the Array elements is also
UIComponent. For more information on the [ArrayElementType] metadata tag, see
Chapter 5, “Using Metadata Tags in Custom Components,” on page 45.

200 Creating Template Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using IDeferredInstance in a template component
Deferred creation is a feature of Flex where Flex containers create only the controls that
initially appear to the user. Flex then creates the container’s other descendants if the user
navigates to them. For more information, see Chapter 6, “Improving Startup Performance,”
in Building and Deploying Flex Applications.
You can create a template component that also takes advantage of deferred creation. Rather
than having Flex create your component and its properties when the application loads, you
can define a component that only creates its properties when a user navigates to the area of the
application that uses the component. This is especially useful for large components that may
have many child components. Flex view states makes use of this feature.

Implementing a template component 201

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following example shows an alternative implementation for the MyTemplateComponent
component shown in the section “About template components” on page 197, named
MyTemplateComponentDeferred.mxml, by defining the topRow and bottomRow properties
to be of type IDeferredInstance:
<?xml version="1.0"?>

<mx:VBox xmlns:mx="http://www.adobe.com/2006/mxml"
initialize="init();">

<mx:Script>
<![CDATA[

import mx.containers.HBox;
import mx.core.UIComponent;

// Define a deferred property for the top component.

public var topRow:IDeferredInstance;

// Define an Array of deferred properties

// for a row of components.
[ArrayElementType("mx.core.IDeferredInstance")]
public var bottomRow:Array;

private function init():void {

// Add the top component to the VBox container.
// Cast the IDeferredInstance object to UIComponent
// so that you can add it to the parent container.
addChild(UIComponent(topRow.getInstance()));

// Create an HBox container. This container

// is the parent container of the bottom row of components.
var controlHBox:HBox = new HBox();

// Add the bottom row of components

// to the HBox container.
for (var i:int = 0; i < bottomRow.length; i++)
controlHBox.addChild(UIComponent(bottomRow[i].getInstance()));

// Add the HBox container to the VBox container.

addChild(controlHBox);
}
]]>
</mx:Script>
</mx:VBox>
The IDeferredInstance interface defines a single method, getInstance(). Flex calls the
getInstance() method to initialize a property when it creates an instance of the component.
A subsequent call to the getInstance() method returns a reference to the property value.

202 Creating Template Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In MXML, when the compiler encounters a value declaration for a property of type
IDeferredInstance, instead of generating code to construct and assign the value to the
property, the compiler generates code to construct and assign an IDeferredInstance
implementation object, which then produces the value at run time.
You can pass any data type to a property of type IDeferredInstance. In the example in the
section “About template components” on page 197, you pass a Label control to the topRow
property, and three Button controls to the bottomRow property.
Notice in the example that the addChild() methods that take topRow and bottomRow as
arguments cast them to UIComponent. This cast is necessary because the addChild()
method can only add an object that implements the IUIComponent interface to a container;
and the DeferredInstance.getInstance() method returns a value of type Object.

Defining properties using the IDeferredInstance

interface
This section describes how to define component properties of type IDeferredInstance.

Defining a generic property

To define a generic property, one with no associated data type, you define its type as
IDeferredInstance, as the following example shows:
// Define a deferred property for the top component.
public var topRow:IDeferredInstance;

The user of the component can then specify an object of any type to the property. It is your
responsibility in the component implementation to verify that the value passed by the user is
of the correct data type.

Restricting the data type of a property

You use the [InstanceType] metadata tag to specify the allowed data type of a property of
type IDeferredInstance, as the following example shows:
// Define a deferred property for the top component.
[InstanceType("mx.controls.Label")]
public var topRow:IDeferredInstance;

Implementing a template component 203

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Defining an array of template properties
You can define an array of template properties, as the following example shows:
// Define an Array of deferred properties for a row of components.
// Do not restrict the type of the component.
[ArrayElementType("mx.core.IDeferredInstance")]
public var bottomRow:Array;

// Define an Array of deferred properties for a row of components.

// Restrict the type of the component to mx.controls.Button.
[InstanceType("mx.controls.Button")]
[ArrayElementType("mx.core.IDeferredInstance")]
public var bottomRow:Array;

In the first example, you can assign a value of any data type to the bottomRow property. Each
array element's getInstance() method is not called until the element is used.

204 Creating Template Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In the second example, you can only assign values of type mx.controls.Button to it. Each
Array element is created when the application loads. The following template component
shows an alternative implementatin of the MyTemplateComponent that restricts the type of
components to be of type mx.controls.Button:
<?xml version="1.0"?>

<mx:VBox xmlns:mx="http://www.adobe.com/2006/mxml"
initialize="init();">

<mx:Script>
<![CDATA[

import mx.containers.HBox;
import mx.core.UIComponent;

[InstanceType("mx.controls.Label")]
public var topRow:IDeferredInstance;

// Define an Array of deferred properties

// for a row of components.
// Restrict the type of the component
// to mx.controls.Button.
[InstanceType("mx.controls.Button")]
[ArrayElementType("mx.core.IDeferredInstance")]
public var bottomRow:Array;

private function init():void {

addChild(UIComponent(topRow.getInstance()));

var controlHBox:HBox = new HBox();

for (var i:int = 0; i < bottomRow.length; i++)
controlHBox.addChild(UIComponent(bottomRow[i].getInstance()));

addChild(controlHBox);
}
]]>
</mx:Script>
</mx:VBox>

Implementing a template component 205

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

206 Creating Template Components

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

PART 4

Creating Nonvisual Flex

Components 4
This part describes how to create formatter, validator, and effect
components for Adobe Flex.
The following topics are included:
Chapter 13: Creating Custom Formatters . . . . . . . . . . . . . . . . . . . 209
Chapter 14: Creating Custom Validators . . . . . . . . . . . . . . . . . . . . . 219
Chapter 15: Creating Effects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

207
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 13

Creating Custom Formatters 13

Adobe Flex includes several predefined formatters that you can use in your applications to
format data. You also might have to extend the functionality of these predefined formatters, or
create formatters for your specific application needs. This topic describes how to create a
custom data formatter. For more information on using formatters, see Chapter 45,
“Formatting Data,” in Flex Developer’s Guide.

Contents
Creating a custom formatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Using the SwitchSymbolFormatter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Extending a Formatter class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

209
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Creating a custom formatter
You create a custom formatter by creating a class that extends the mx.formatters.Formatter
base class, or by creating a class that extends one of the standard formatter classes, which all
extend mx.formatters.Formatter. The following example shows the class hierarchy for
formatters:

Formatter

all formatter classes

Like standard formatter classes, your custom formatter class must contain a public format()
method that takes a single argument and returns a String that contains the formatted data.
Most of the processing of your custom formatter occurs within the format() method.
Your custom formatter also might let the user specify which pattern formats the data. Where
applicable, the Flex formatters, such as the ZipCodeFormatter, use a formatString property
to pass a format pattern. Some Flex formatters, such as the NumberFormatter and
CurrencyFormatter classes, do not have formatString properties, because they use a set of
properties to configure formatting.

210 Creating Custom Formatters

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Creating a simple formatter
This example defines a simple formatter class that converts any string to all uppercase or all
lowercase letters depending on the value passed to the formatString property. By default, the
formatter converts a String to all uppercase.
package myFormatters
{
// formatters/myFormatter/SimpleFormatter.as
import mx.formatters.Formatter
import mx.formatters.SwitchSymbolFormatter

public class SimpleFormatter extends Formatter

{
// Declare the variable to hold the pattern string.
public var myFormatString:String = "upper";

// Constructor
public function SimpleFormatter() {
// Call base class constructor.
super();
}

// Override format().
override public function format(value:Object):String {
// 1. Validate value - must be a nonzero length string.
if( value.length == 0)
{ error="0 Length String";
return ""
}

// 2. If the value is valid, format the string.

switch (myFormatString) {
case "upper" :
var upperString:String = value.toUpperCase();
return upperString;
break;
case "lower" :
var lowerString:String = value.toLowerCase();
return lowerString;
break;
default :
error="Invalid Format String";
return ""
}
}
}
}

Creating a custom formatter 211

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can use this formatter in a Flex application, as the following example shows:
<?xml version="1.0" ?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myFormatters.*">

<MyComp:SimpleFormatter id="upperFormat" myFormatString="upper" />

<mx:TextInput id="myTI" />

<mx:TextArea text="Your uppercase string is

{upperFormat.format(myTI.text)}" />

</mx:Application>
The namespace declaration in the <mx:Application> tag specifies to use the MyComp prefix
when referencing the formatter, and the location of the formatter’s ActionScript file. That file
is in the myFormatters subdirectory of the application, or in the default classpath of the
application. For more information on deploying your formatters, see Chapter 6, “Compiling
Components,” on page 63.

Handling errors in formatters

For all formatter classes, except for the SwitchSymbolFormatter class, when an error occurs,
the formatter returns an empty string and writes a string that describes the error condition to
the formatter’s error property. The error property is inherited from the Formatter
superclass.
In your application, you can test for an empty string in the result returned by the formatter. If
detected, you can check the error property to determine the cause of the error. For an
example that handles a formatter error, see Chapter 45, “Formatting Data,” in Flex Developer’s
Guide. For more information on the SwitchSymbolFormatter class, see “Using the
SwitchSymbolFormatter class” on page 213.

212 Creating Custom Formatters

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using the SwitchSymbolFormatter class
You can use the SwitchSymbolFormatter utility class when you create custom formatters. You
use this class to replace placeholder characters in one string with numbers from a second
string.
For example, you specify the following information to the SwitchSymbolFormatter class:
Format string: “The Social Security number is: ###-##-####”
Input string: "123456789"
The SwitchSymbolFormatter class parses the format string and replaces each placeholder
character with a number from the input string in the order in which the numbers are specified
in the input string. The default placeholder character is the number sign (#). You can define a
different placeholder character by passing it to the constructor when you create a
SwitchSymbolFormatter object. For an example, see “Using a different placeholder character”
on page 213.
The SwitchSymbolFormatter class creates the following output string from the Format and
Input strings:
"The SocialSecurity number is: 123-45-6789"
You use the formatString property of the SwitchSymbolFormatter class to specify the format
string. You can mix alphanumeric characters and placeholder characters in this format string.
The format string can contain any characters that are constant for all values of the numeric
portion of the string. However, the input string for formatting must be numeric.
The number of digits supplied in the source value must match the number of digits defined in
the format string. The code that calls the SwitchSymbolFormatter object verifies that the
number of digits match.

Using a different placeholder character

By default, the SwitchSymbolFormatter class uses a number sign (#) as the placeholder
character to indicate a number substitution within its format string. However, sometimes you
might want to include a number sign in your actual format string. Then, you must use a
different symbol to indicate a number substitution slot within the format string. You can
select any character for this alternative symbol as long as it doesn’t appear in the format string.
For example, to use the ampersand character (&) as the placeholder, you create an instance of
the SwitchSymbolFormatter class as the following example shows:
var dataFormatter = new SwitchSymbolFormatter("&");

Using the SwitchSymbolFormatter class 213

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Handling errors with the SwitchSymbolFormatter
class
Unlike other formatters, the SwitchSymbolFormatter class does not write its error messages
into an error property. Instead, it is your responsibility to test for error conditions and return
an error message if appropriate.
The custom formatter component in the following example formats nine-digit Social Security
numbers by using the SwitchSymbolFormatter class:
package myFormatters
{
// formatters/myFormatter/CustomSSFormatter.as
import mx.formatters.Formatter
import mx.formatters.SwitchSymbolFormatter

public class CustomSSFormatter extends Formatter

{
// Declare the variable to hold the pattern string.
public var formatString : String = "###-##-####";

// Constructor
public function CustomSSFormatter() {
// Call base class constructor.
super();
}

// Override format().
override public function format( value:Object ):String {
// Validate input string value - must be a 9-digit number.
// You must explicitly check if the value is a number.
// The formatter does not do that for you.
if( !value || value.toString().length != 9)
{ error="Invalid String Length";
return ""
}

// Validate format string.

// It must contain 9 number placeholders.
var numCharCnt:int = 0;
for( var i:int = 0; i<formatString.length; i++ )
{
if( formatString.charAt(i) == "#" )
{ numCharCnt++;
}
}

if( numCharCnt != 9 )
{

214 Creating Custom Formatters

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
error="Invalid Format String";
return ""
}

// If the formatString and value are valid, format the number.

var dataFormatter:SwitchSymbolFormatter =
new SwitchSymbolFormatter();
return dataFormatter.formatValue( formatString, value );
}
}
}
The following example uses this custom formatter in an application:
<?xml version="1.0" encoding="UTF-8"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myFormatters.*">

<MyComp:CustomSSFormatter id="SSFormat"
formatString="SS: #-#-#-#-#-#-#-#-#"/>

<mx:TextInput text="Your SS number is {SSFormat.format('123456789')}"/>

</mx:Application>

Using the SwitchSymbolFormatter class 215

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Extending a Formatter class
You can extend the Formatter class to create a custom formatter, or any formatter class. This
section shows an example that extends the ZipCodeFormatter class by allowing an extra
format pattern: "#####*####".
In this example, if the user omits a format string, or specifies the default value of
"#####*####", the formatter returns the ZIP code using the format "#####*####". If the
user specifies any other format string, such as a five-digit string in the form "#####", the
custom formatter calls the format() method in the superclass ZipCodeFormatter class to
format the data.
package myFormatters
{
// formatters/myFormatter/ExtendedZipCodeFormatter.as
import mx.formatters.Formatter
import mx.formatters.ZipCodeFormatter
import mx.formatters.SwitchSymbolFormatter

public class ExtendedZipCodeFormatter extends ZipCodeFormatter {

// Constructor
public function ExtendedZipCodeFormatter() {
// Call base class constructor.
super();
// Initialize formatString.
formatString = "#####*####";
}

// Override format().
override public function format(value:Object):String {
// 1. If the formatString is our new pattern,
// then validate and format it.

if( formatString == "#####*####" ){

if( String( value ).length == 5 )

value = String( value ).concat("0000");

if( String( value ).length == 9 ){

var dataFormatter:SwitchSymbolFormatter =
new SwitchSymbolFormatter();
return dataFormatter.formatValue( formatString, value );
}
else {
error="Invalid String Length";
return ""
}
}

216 Creating Custom Formatters

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

// If the formatString is anything other than '#####*####,

// call super and validate and format as usual using
// the base ZipCodeFormatter.
return super.format(value);
}
}
}
Notice that the ExtendedZipCodeFormatter class did not have to define a formatString
property because it is already defined in its base class, ZipCodeFormatter.
The following example uses this custom formatter in an application:
<?xml version="1.0" encoding="UTF-8"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myFormatters.*">

<MyComp:ExtendedZipCodeFormatter id="ZipCodeFormat"/>

<mx:TextInput width="200"
text="Your zipcode number is {ZipCodeFormat.format('123456789')}"/>

</mx:Application>

Extending a Formatter class 217

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

218 Creating Custom Formatters

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 14

Creating Custom Validators 14

Data validators let you validate the data in an object. Adobe Flex supplies a number of
standard validators that you can use in your application, however, you can also define custom
validators for your specific application needs. This topic describes how to create custom
validators.
For information on the standard validators, see Chapter 44, “Validating Data,” in Flex
Developer’s Guide.

Contents
Validating data by using custom validators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Example: Validating multiple fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224

Validating data by using custom

validators
The data that a user enters in a user interface might or might not be appropriate for the
application. In Flex, you use a validator to ensure the values in the fields of an object meet
certain criteria. For example, you can use a validator to ensure that a user enters a valid phone
number value in a TextInput control.
Flex includes a set of validators for common types of user input data, such as ZIP codes,
phone numbers, and credit cards. Although Flex supplies a number of commonly used
validators, your application may require you to create custom validator classes. The
mx.validators.Validator class is an ActionScript class that you can extend to add your own
validation logic. Your classes could extend the functionality of an existing validator class, or
you could implement new functionality in your custom validator class.

219
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following image shows the class hierarchy for validators:

Validator

All validator classes

About overriding the doValidation() method

Your custom validator class must contain an override of the protected
Validator.doValidation() method that takes a single argument, value, of type Object,
and returns an Array of ValidationResult objects. You return one ValidationResult object for
each field that the validator examines and fails the validation. For fields that pass the
validation, you omit the ValidationResult object.
You do not have to create a ValidationResult object for fields that validate successfully. Flex
creates those ValidationResult objects for you.
The base Validator class implements the logic to handle required fields by using the required
property. When set to true, this property specifies that a missing or empty value in a user-
interface control causes a validation error. To disable this verification, set this property to
false.

In the doValidation() method of your validator class, you typically call the base class’s
doValidation() method to perform the verification for a required field. If the user did not
enter a value, the base class issues a validation error stating that the field is required.
The remainder of the doValidation() method contains your custom validation logic.

About the ValidationResult class

The doValidation() method returns an Array of ValidationResult objects, one for each field
that generates a validation error. The ValidationResult class defines several properties that let
you record information about any validation failures, including the following:
errorCode A String that contains an error code. You can define your own error codes for
your custom validators.
errorMessage A String that contains the error message. You can define your own error
messages for your custom validators.
isError A Boolean value that indicates whether or not the result is an error. Set this property
to true.

220 Creating Custom Validators

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
subField A String that specifies the name of the subfield associated with the
ValidationResult object.
In your override of the doValidation() method, you can define an empty Array and
populate it with ValidationResult objects as your validator encounters errors.

About the validate() method

You use the Validator.validate() method to programmatically invoke a validator from
within a Flex application. However, you should never override this method in your custom
validator classes. You need to override only the doValidation() method.

Example: Creating a simple validator

You can use the StringValidator class to validate that a string is longer than a minimum length
and shorter than a maximum length, but you cannot use it to validate the contents of a string.
This example creates a simple validator class that determines if a person is more than 18 years
old based on their year of birth.

Example: Creating a simple validator 221

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
This validator extends the Validator base class, as the following example shows:
package myValidators
{
import mx.validators.Validator;
import mx.validators.ValidationResult;

public class AgeValidator extends Validator {

// Define Array for the return value of doValidation().

private var results:Array;

// Constructor.
public function AgeValidator() {
// Call base class constructor.
super();
}

// Define the doValidation() method.

override protected function doValidation(value:Object):Array {

// Convert value to a Number.

var inputValue:Number = Number(value);

// Clear results Array.

results = [];

// Call base class doValidation().

results = super.doValidation(value);
// Return if there are errors.
if (results.length > 0)
return results;

// Create a variable and initialize it to the current date.

var currentYear:Date = new Date();

// If input value is not a number, or contains no value,

// issue a validation error.
if (isNaN(inputValue) || !value )
{
results.push(new ValidationResult(true, null, "NaN",
"You must enter a year."));
return results;
}

// If calculated age is less than 18, issue a validation error.

if ((currentYear.getFullYear() - inputValue) < 18) {
results.push(new ValidationResult(true, null, "tooYoung",
"You must be 18."));
return results;

222 Creating Custom Validators

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
}

return results;
}
}
}
This example first defines a public constructor that calls super() to invoke the constructor of
its base class. The base class can perform the check to ensure that data was entered into a
required field, if you set the required property of the validator to true.
Notice that the second argument of the constructor for the ValidationResult class is null. You
use this argument to specify a subfield, if any, of the object being validated that caused the
error. When you are validating a single field, you can omit this argument. For an example that
validates multiple fields, see “Example: Validating multiple fields” on page 224.
You can use this validator in your Flex application, as the following example shows:
<?xml version="1.0" ?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myValidators.*">

<MyComp:AgeValidator id="ageV"
required="true"
source="{birthYear}"
property="text" />

<mx:Form >
<mx:FormItem label="Enter birth year: ">
<mx:TextInput id="birthYear"/>
</mx:FormItem>
<mx:FormItem label="Enter birth year: ">
<mx:Button label="Submit"/>
</mx:FormItem>
</mx:Form>

</mx:Application>
The package statement for your custom validator specifies that you should deploy it in a
directory called myValidators. In the previous example, you place it in the subdirectory of
the directory that contains your Flex application. Therefore, the namespace definition in your
Flex application is xmlns:MyComp="myValidators.*". For more information on
deployment, see Chapter 6, “Compiling Components,” on page 63.

Example: Creating a simple validator 223

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Example: Validating multiple fields
A validator can validate more than one field at a time. For example, you could create a custom
validator called NameValidator to validate three input controls that represent a person’s first,
middle, and last names.
To create a validator that examines multiple fields, you can either define properties on the
validator that let you specify the multiple input fields, as does the Flex DateValidator class
class, or you can require that the single item passed to the validator includes all of the fields to
be validated.
In the following example, you use a NameValidator that validates an item that contains three
fields named first, middle, and last:
<?xml version="1.0" ?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myValidators.*">

<mx:Model id="person">
<name>
<custName>
<first>{firstInput.text}</first>
<middle>{middleInput.text}</middle>
<last>{lastInput.text}</last>
</custName>
</name>
</mx:Model>

<mx:TextInput id="firstInput"/>
<mx:TextInput id="middleInput"/>
<mx:TextInput id="lastInput"/>

<MyComp:NameValidator id="nameVal"
source="{person}" property="custName"
listener="{firstInput}"/>

<mx:Button label="Validate" click="nameVal.validate();"/>

</mx:Application>
This validator examines three input fields. You specify firstInput as the validation listener.
Therefore, when a validation error occurs, Flex shows a validation error message on the first
TextInput control.

224 Creating Custom Validators

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can implement the NameValidator class, as the following example shows:
package myValidators
{
import mx.validators.Validator;
import mx.validators.ValidationResult;

public class NameValidator extends Validator {

// Define Array for the return value of doValidation().

private var results:Array;

public function NameValidator () {

super();
}

override protected function doValidation(value:Object):Array {

var fName:String = value.first;

var mName:String = value.middle;
var lName:String = value.last;

// Clear results Array.

results = [];

// Call base class doValidation().

results = super.doValidation(value);
// Return if there are errors.
if (results.length > 0)
return results;

// Check first name field.

if (fName == "" || fName == null) {
results.push(new ValidationResult(true,
"first", "noFirstName", "No First Name."));
return results;
}

// Check middle name field.

if (mName == "" || mName == null) {
results.push(new ValidationResult(true,
"middle", "noMiddleName", "No Middle Name."));
return results;
}

// Check last name field.

if (lName == "" || lName == null) {
results.push(new ValidationResult(true,
"last", "noLastName", "No Last Name."));
return results;
}

Example: Validating multiple fields 225

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

return results;
}
}
}
In this example, because you are using a single validator to validate three subfields of the
Object passed to the validator, you include the optional second argument to the constructor
for the ValidationResult class to specify the subfield that caused the validation error. This
inclusion permits Flex to identify the input component that caused the error, and to highlight
that component in the application.

226 Creating Custom Validators

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The doValidation() method returns a validation error as soon as it detects the first
validation error. You can modify doValidation() so that it examines all of the input fields
before returning an error message, as the following example shows. This custom valiudator is
named NameValidatorAllFields.as:
package myValidators
{
import mx.validators.Validator;
import mx.validators.ValidationResult;

public class NameValidatorAllFields extends Validator {

// Define Array for the return value of doValidation().

private var results:Array;

public function NameValidatorAllFields() {

super();
}

override protected function doValidation(value:Object):Array {

var fName:String = value.first;

var mName:String = value.middle;
var lName:String = value.last;

// Clear results Array.

results = [];

// Call base class doValidation().

results = super.doValidation(value);
// Return if there are errors.
if (results.length > 0)
return results;

// Check first name field.

if (fName == "" || fName == null) {
results.push(new ValidationResult(true,
"first", "noFirstName", "No First Name."));
}

// Check middle name field.

if (mName == "" || mName == null) {
results.push(new ValidationResult(true,
"middle", "noMiddleName", "No Middle Name."));
}

// Check last name field.

if (lName == "" || lName == null) {
results.push(new ValidationResult(true,
"last", "noLastName", "No Last Name."));

Example: Validating multiple fields 227

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
}

return results;
}
}
}
Notice that you remove the return statement from the body of the if statements so that the
method contains only a single return statemen. This modification allows you to detect three
different validation errors at once.

228 Creating Custom Validators

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

CHAPTER 15

Creating Effects 15
Behaviors let you add animation and motion to your application when some user or
programmatic action occurs, where a behavior is a combination of a trigger paired with an
effect. A trigger is an action, such as a mouse click on a component, a component getting
focus, or a component becoming visible. An effect is a visible or audible change to the target
component that occurs over a period of time, measured in milliseconds. For example, you can
use behaviors to cause a dialog box to bounce slightly when it receives focus, or to slowly fade
in when it becomes visible.
Adobe Flex supplies a number of standard effects that you can use in your application.
However, you also can define custom effects for your specific application needs. This topic
describes how to create custom effects.
For information on the standard effects, see Chapter 19, “Using Behaviors,” in Flex Developer’s
Guide.

Contents
About creating a custom effect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
About tween effects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239
Writing an effect for a transition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .242
Defining a custom effect trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

229
Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
About creating a custom effect
Flex implements effects by using an architecture in which each effect is represented by two
classes: a factory class and an instance class. Therefore, to implement a custom effect, you
create two classes: the factory class and the instance class.
You create a factory class by creating a subclass of the mx.effects.Effect class, or by creating a
subclass of one of the subclasses of the mx.effects.Effect class. You create an instance class by
creating a subclass of the mx.effects.EffectInstance class, or a subclass of one of the subclasses
of the mx.effects.EffectInstance class.
The following image shows the class hierarchy for effects:

Effect

MaskEffect TweenEffect CompositeEffect

effect classes effect classes effect classes

Factory classes

EffectInstance

MaskEffectInstance TweenEffectInstance CompositeEffectInstance

effect instance classes effect instance classes effect instance classes

Instance classes

Defining factory and instance classes

To define a custom effect, you create two classes: the factory class and the instance class:
Factory class The factory class creates an object of the instance class to perform the effect
on the target. You create a factory class instance in your application, and configure it with the
necessary properties to control the effect, such as the zoom size or effect duration. You then
assign the factory class instance to an effect trigger of the target component, as the following
example shows:

230 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

<mx:WipeDown id="myWD" duration="1000"/>

<mx:Button id="myButton" mouseDownEffect="{myWD}"/>
<mx:Button id="myOtherButton" mouseDownEffect="{myWD}"/>

By convention, the name of a factory class is the name of the effect, such as Zoom or Fade.
Instance class The instance class implements the effect logic. When an effect trigger
occurs, or when you call the play() method to invoke an effect, the factory class creates an
object of the instance class to perform the effect on the target. When the effect ends, Flex
destroys the instance object. If the effect has multiple target components, the factory class
creates multiple instance objects, one per target.
By convention, the name of an instance class is the name of the effect with the suffix Instance,
such as ZoomInstance or FadeInstance.

About the effect base classes

You define effects by creating a subclass from the effects class hierarchy. Typically, you create a
subclass from one of the following classes:
■ mx.effects.Effect Create a subclass from this class for simple effects that do not require
an effect to play over a period of time. For example, the Pause effect inserts a delay
between two consecutive effects. You can also define a simple sound effect that plays an
MP3 file.
■ mx.effects.TweenEffect Create a subclass from this class to define an effect that plays
over a period of time, such as an animation. For example, the Resize effect is a subclass of
the TweenEffect class that modifies the size of its target over a specified duration.

About implementing your effects classes

You must override several methods and properties in your custom effect classes, and define
any new properties and methods that are required to implement the effect. You can optionally
override additional properties and methods based on the type of effect that you create.

About creating a custom effect 231

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following table lists the methods and properties that you define in a factory class:

Factory method/property Description

constructor (Required) The class constructor. You typically call
the super() method to invoke the superclass
constructor to initialize the inherited items from the
superclasses.
Your constructor must take at least one optional
argument, of type Object. This argument specifies the
target component of the effect.
Effect.initInstance() (Required) Copies properties of the factory class to
the instance class. Flex calls this protected method
from the Effect.createInstance() method; you do
not have to call it yourself.
In your override, you must call the
super.initInstance() method.

Effect.getAffectedProperties() (Required) Returns an Array of Strings, where each

String is the name of a property of the target object
that is changed by this effect. If the effect does not
modify any properties, it should return an empty
Array.
Effect.instanceClass (Required) Contains an object of type Class that
specifies the name of the instance class for this effect
class.
All subclasses of the Effect class must set this
property, typically in the constructor.
Effect.effectEndHandler() (Optional) Called when an effect instance finishes
playing. If you override this method, ensure that you
call the super() method.
Effect.effectStartHandler() (Optional) Called when the effect instance starts
playing. If you override this method, ensure that you
call the super() method.

Additional methods and properties (Optional) Define any additional methods and
properties that the user requires to configure the
effect.

232 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following table lists the methods and properties that you define in an instance class:

Instance method/property Description

EffectInstance.end() (Optional) Interrupts an effect that is currently

playing, and jumps immediately to the end of the
effect.
EffectInstance.initEffect() (Optional) Called if the effect was triggered by the
EffectManager. You rarely have to implement this
method. For more information, see “Overriding the
initEffect() method” on page 252.
TweenEffectInstance.onTweenUpdate() (Required) Use when you create a subclass from
TweenEffectInstance. A callback method called at
regular intervals to implement a tween effect. For
more information, see “Example: Creating a tween
effect” on page 240.
TweenEffectInstance.onTweenEnd() (Optional) Use when you create a subclass from
TweenEffectInstance. A callback method called
when the tween effect ends. You must call
super.onTweenEnd() from your override. For more
information, see “Example: Creating a tween effect”
on page 240.

Additional methods and properties (Optional) Define any additional methods and
properties. These typically correspond to the public
properties and methods from the factory class, and
any additional properties and methods that you
require to implement the effect.

About creating a custom effect 233

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Example: Defining a simple effect
To define a simple custom effect, you create a factory class from the Effect base class, and the
instance class from the mx.effects.EffectInstance class. The following example shows an effect
class that uses a Sound object to play an embedded MP3 file when a user action occurs. This
example is a simplified version of the SoundEffect class that ships with Flex.
package myEffects
{
// myEffects/MySound.as
import mx.effects.Effect;
import mx.effects.EffectInstance;
import mx.effects.IEffectInstance;

public class MySound extends Effect

{
// Define constructor with optional argument.
public function MySound(targetObj:Object = null) {
// Call base class constructor.
super(targetObj);

// Set instanceClass to the name of the effect instance class.

instanceClass= MySoundInstance;
}

// This effect modifies no properties, so your

// override of getAffectedProperties() method
// returns an empty array.
override public function getAffectedProperties():Array {
return [];
}

// Override initInstance() method.

override protected function initInstance(inst:IEffectInstance):void {
super.initInstance(inst);
}
}
}
The package statement in your class specifies that you should deploy it in a directory called
myEffects. In this example, you place it in the subdirectory of the directory that contains your
Flex application. Therefore, the namespace definition in your Flex application is
xmlns:MyComp="myEffects.*". For more information on deployment, see Chapter 6,
“Compiling Components,” on page 63.

234 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
To define your instance class, you create a subclass from the mx.effects.EffectInstance class. In
the class definition, you must define a constructor and play() methods, and you can
optionally define an end() method to stop the effect.
package myEffects
{
// myEffects/MySoundInstance.as
import mx.effects.EffectInstance;
import flash.media.SoundChannel;
import flash.media.Sound;

public class MySoundInstance extends EffectInstance

{

// Embed the MP3 file.

[Embed(source="sample.mp3")]
[Bindable]
private var sndCls:Class;

// Define local variables.

private var snd:Sound = new sndCls() as Sound;
private var sndChannel:SoundChannel;

// Define constructor.
public function MySoundInstance(targetObj:Object) {
super(targetObj);
}

// Override play() method.

// Notice that the MP3 file is embedded in the class.
override public function play():void {
super.play();
sndChannel=snd.play();
}

// Override end() method class to stop the MP3.

override public function end():void {
sndChannel.stop();
super.end();
}
}
}

About creating a custom effect 235

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
To use your custom effect class in an MXML file, you insert a tag with the same name as the
factory class in the MXML file. You reference the custom effect the same way that you
reference a standard effect.
The following example shows an application that uses the MySound effect:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myEffects.*">

<MyComp:MySound id="mySoundEffect" />

<mx:Label text="play MP3" rollOverEffect="{mySoundEffect}" />

</mx:Application>

236 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Example: Passing parameters to effects

To make your effects more robust, you often design them to let the user pass parameters to
them. The example in this section modifies the sound effect from the previous section to take
a parameter that specifies the MP3 file to play:
package myEffects
{
// MySoundParam.as
import mx.effects.Effect;
import mx.effects.EffectInstance;
import mx.effects.IEffectInstance;

public class MySoundParam extends Effect

{

// Define a variable for the MP3 URL

// and give it a default value.
public var soundMP3:String=
"http://localhost:8100/flex/assets/default.mp3";

// Define constructor with optional argument.

public function MySoundParam(targetObj:Object = null) {
// Call base class constructor.
super(targetObj);

// Set instanceClass to the name of the effect instance class.

instanceClass= MySoundParamInstance;
}

// Override getAffectedProperties() method to return an empty array.

override public function getAffectedProperties():Array {
return [];
}

// Override initInstance() method.

override protected function initInstance(inst:IEffectInstance):void {
super.initInstance(inst);
// initialize the corresponding parameter in the instance class.
MySoundParamInstance(inst).soundMP3 = soundMP3;
}
}
}
In the MySoundParam class, you define a variable named soundMP3 that enables the user of
the effect to specify the URL of the MP3 file to play. You also modify your override of the
initInstance() method to pass the value of the soundMP3 variable to the instance class.

About creating a custom effect 237

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Notice that the getAffectedProperties() method still returns an empty Array. That is
because getAffectedProperties() returns the list of properties of the effect target that are
modified by the effect, not the properties of the effect itself.
In your instance class, you define a property named soundMP3, corresponding to the
property with the same name in the factory class. Then, use it to create the URLRequest
object to play the sound, as the following example shows:
package myEffects
{
// MySoundParamInstance.as
import mx.effects.EffectInstance;
import flash.media.Sound;
import flash.media.SoundChannel;
import flash.net.URLRequest;

public class MySoundParamInstance extends EffectInstance

{

// Define local variables.

private var s:Sound;
private var sndChannel:SoundChannel;
private var u:URLRequest;

// Define a variable for the MP3 URL.

public var soundMP3:String;

// Define constructor.
public function MySoundParamInstance(targetObj:Object) {
super(targetObj);
}

// Override play() method.

override public function play():void {
// You must call super.play() from within your override.
super.play();
s = new Sound();
// Use the new parameter to specify the URL.
u = new URLRequest(soundMP3);
s.load(u);
sndChannel=s.play();
}

// Override end() method to stop the MP3.

override public function end():void {
sndChannel.stop();
super.end();
}
}
}

238 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
You can now pass the URL of an MP3 to the effect, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComps="myEffects.*">

<MyComps:MySoundParam id="mySoundEffect"
soundMP3="http://localhost:8100/flex/assets/sample.mp3"/>

<mx:Label text="play MP3" rollOverEffect="mySoundEffect"/>

</mx:Application>

About tween effects

Most Flex effects are implemented by using the tweening mechanism, where a tween defines a
transition performed on a target object over a period of time. That transition could be a
change in size, such as the Zoom or Resize effects perform; a change in visibility, as the Fade
or Dissolve effects perform; or other types of transition.
You use the following classes to implement a tween effect:
mx.effects.Tween A class used to implement tween effects. A Tween object accepts a start
value, an end value, and an optional easing function. When you define tween effect classes,
you create an instance of the Tween class in your override of the Effect.play() method.
The Tween object invokes the mx.effects.TweenEffect.onTweenUpdate() callback
method on a regular interval, passing the callback method an interpolated value between the
start and end values. Typically, the callback method updates some property of the target
component, causing that component’s property to animate over time. For example, the Move
effect modifies the x and y properties of the target component for the duration of the effect to
show an animated movement.
When the effect ends, the Tween object invokes the
mx.effects.TweenEffect.onTweenEnd() callback method. This method performs any final
processing before the effect terminates. You must call super.onTweenEnd() from your
override.
mx.effects.TweenEffect The base factory class for all tween effects. This class encapsulates
methods and properties that are common among all Tween-based effects.
mx.effects.effectClasses.TweenEffectInstance The instance class for all tween effects.

About tween effects 239

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
When you define effects based on the TweenEffect class, you must override the
TweenEffectInstance.onTweenUpdate () method, and optionally override the
TweenEffectInstance.onTweenEnd () method.

This section describes how to create a tween effect. However, Flex supplies the
AnimateProperty class that you can use to create a tween effect for a single property of the
target component. For more information, see Chapter 19, “Using Behaviors,” in Flex
Developer’s Guide.

Example: Creating a tween effect

In this example, you create a tween effect that rotates a component in a circle. This example
implements a simplified version of the Rotate effect. The rotation is controlled by two
parameters that are passed to the effect: angleFrom and angleTo:
package myEffects
{
// myEffects/Rotation.as
import mx.effects.TweenEffect;
import mx.effects.EffectInstance;
import mx.effects.IEffectInstance;

public class Rotation extends TweenEffect

{
// Define parameters for the effect.
public var angleFrom:Number = 0;
public var angleTo:Number = 360;

// Define constructor with optional argument.

public function Rotation(targetObj:* = null) {
super(targetObj);
instanceClass= RotationInstance;
}

// Override getAffectedProperties() method to return "rotation".

override public function getAffectedProperties():Array {
return ["rotation"];
}

// Override initInstance() method.

override protected function initInstance(inst:IEffectInstance):void {
super.initInstance(inst);
RotationInstance(inst).angleFrom = angleFrom;
RotationInstance(inst).angleTo = angleTo;
}
}
}

240 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In this example, the effect works by modifying the rotation property of the target
component. Therefore, your override of the getAffectedProperties() method returns an
array that containsa single element.
You derive your instance class from the TweenEffectInstance class, and override the play(),
onTweenUpdate(), and onTweenEnd() methods, as the following example shows:
package myEffects
{
// myEffects/RotationInstance.as
import mx.effects.effectClasses.TweenEffectInstance;
import mx.effects.Tween;

public class RotationInstance extends TweenEffectInstance

{
// Define parameters for the effect.
public var angleFrom:Number;
public var angleTo:Number;

public function RotationInstance(targetObj:*) {

super(targetObj);
}

// Override play() method class.

override public function play():void {
// All classes must call super.play().
super.play();
// Create a Tween object. The tween begins playing immediately.
var tween:Tween =
createTween(this, angleFrom, angleTo, duration);
}

// Override onTweenUpdate() method.

override public function onTweenUpdate(val:Object):void {
target.rotation = val;
}

// Override onTweenEnd() method.

override public function onTweenEnd(val:Object):void {
// All classes that implement onTweenEnd()
// must call super.onTweenEnd().
super.onTweenEnd(val);
}
}
}

About tween effects 241

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
In this example, Tween object invokes the onTweenUpdate() callback method on a regular
interval, passing it values between angleFrom and angleTo. At the end of the effect, the
Tween object calls the onTweenUpdate() callback method with a value of angleTo. By
invoking the onTweenUpdate() callback method at regular intervals throughout the duration
of the effect, the target component displays a smooth animation as it rotates.
You use your new effect in an MXML application, as the following example shows:
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myEffects.*">

<MyComp:Rotation id="Rotate90"
angleFrom="0" angleTo="360"
duration="1000"/>

<mx:Image source="@Embed(source='../assets/myImage.jpg')"
mouseDownEffect="{Rotate90}"/>

</mx:Application>
In this example, you use the effect to rotate an image when the user clicks it.

Writing an effect for a transition

Transitions define how a change of view state appears on the screen. You define a transition by
using a combination of the Flex effect classes. For more information on transitions, see
Chapter 30, “Using Transitions,” in Flex Developer’s Guide.
You can define your own custom effects for use in transitions. To do so, you have to account
for the effect being used in a transition when you override the EffectInstance.play()
method. The EffectInstance.play() method must be able to determine default values for
effect properties when the effect is used in a transition.

Defining the default values for a transition effect

Like any effect, an effect in a transition has properties that you use to configure it. For
example, most effects have properties that define starting and ending information for the
target component, such as the xFrom, yFrom, xTo, and yTo properties of the Move effect.

242 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Flex uses the following rules to determine the start and end values of effect properties when
you use the effect in a transition:
1. If the effect defines the values of any properties, it uses the properties in the transition, as
the following example shows:
<mx:Transition fromState="*" toState="*">
<mx:Sequence id="t1" targets="{[p1,p2,p3]}">
<mx:Blur duration="100"
blurXFrom="0.0" blurXTo="10.0" blurYFrom="0.0" blurYTo="10.0"/>
<mx:Parallel>
<mx:Move duration="400"/>
<mx:Resize duration="400"/>
</mx:Parallel>
<mx:Blur duration="100"
blurXFrom="10.0" blurXTo="0.0" blurYFrom="10.0" blurYTo="0.0"/>
</mx:Sequence>
</mx:Transition>

In this example, the two Blur filters define the properties of the effect.
2. If the effect does not define the start values of the effect, the effect determines the values
from the EffectInstance.propertyChanges property passed to the effect instance. Flex
sets the propertyChanges property by using information from the current settings of the
component, as defined by the current view state. For more information on the
propertyChanges property, see “How Flex initializes the propertyChanges property”
on page 244.
In the example in step 1, notice that the Move and Resize effects do not define start values.
Therefore, Flex determines the start values from the current size and position of the effect
targets in the current view state, and passes that information to each effect instance by
using the propertyChanges property.
3. If the effect does not define the end values of the effect, the effect determines the values
from the Effectinstance.propertyChanges property passed to the effect instance. Flex
sets the propertyChanges property by using information about the component, as defined
by the destination view state. For more information on the propertyChanges property,
see “How Flex initializes the propertyChanges property” on page 244.
In the example in rule 1, Flex determines the end values of the Move and Resize effects
from the size and position of the effect targets in the destination view state. In some cases,
the destination view state defines those values. If the destination view state does not define
the values, Flex determines them from the setting of the base view state, and passes that
information to each effect instance by using the propertyChanges property.
4. If there are no explicit values, and Flex cannot determine values from the current or
destination view states, the effect uses its default property values.

Writing an effect for a transition 243

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Using the propertyChanges property
The EffectInstance.propertyChanges property contains a PropertyChanges object. A
PropertyChanges object contains the properties described in the following table:

Property Description
target A target component of the effect. The end and start properties of the
PropertyChanges class define how the target component is modified by the
change to the view state.
start An object that contains the starting properties of the target component, as
defined by the current view state. For example, for a target component that is
moved and resized by a change to the view state, the start property contains
the starting position and size of the component, as the following example shows:
{x:00, y:00, width:100, height:100}

end An object that contains the ending properties of the target component, as
defined by the destination view state. For example, for a target component that
is moved and resized by a change to the view state, the end property contains
the ending position and size of the component, as the following example shows:
{x:100, y:100, width:200, height:200}

In the body of the Effectinstance.play() method, you can examine the information in
the propertyChanges property to configure the effect.

How Flex initializes the propertyChanges property

Before you can use the EffectInstance.propertyChanges property in your effect instance,
it has to be properly initialized. When you change the view state, Flex initializes
propertyChanges.start and propertyChanges.end separately.

The following steps describe the actions that occur when you change view states. Notice that,
Flex initializes propertyChanges.start as part of step 4, and initializes
propertyChanges.end as part of step 7:

1. You set the currentState property to the destination view state.

2. Flex dispatches the currentStateChanging event.
3. Flex examines the list of transitions to determine the one that matches the change of view
state.
4. Flex calls the Effect.captureStartValues() method to initialize
propertyChanges.start for all effect instances.

You can also call Effect.captureStartValues() to initialize an effect instance used

outside of a transition.

244 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
5. Flex applies the destination view state to the application.
6. Flex dispatches the currentStateChange event.
7. Flex plays the effects defined in the transition.
As part of playing the effect, Flex invokes the factory class play() method,
Effect.play(), to initialize propertyChanges.end for effect instances.

Example: Creating a transition effect

This section modifies the Rotation effect created in “Example: Creating a tween effect”
on page 240 to make the effect usable in a transition.
The following example shows the RotationTrans.as class that definesthe factory class for the
effect. The only modification you make to Rotation.as to create RotationTrans.as is to remove
the default value definitions for the angleFrom and angleTo property definitions. The
RotationTransInstance.play() method determines the default values.
package myEffects
{
// myEffects/RotationTrans.as
import mx.effects.TweenEffect;
import mx.effects.EffectInstance;
import mx.effects.IEffectInstance;

public class RotationTrans extends TweenEffect

{
// Define parameters for the effect.
// Do not specify any default values.
// The default value of these properties is NaN.
public var angleFrom:Number;
public var angleTo:Number;

// Define constructor with optional argument.

public function RotationTrans(targetObj:Object = null) {
super(targetObj);
instanceClass= RotationTransInstance;
}

// Override getAffectedProperties() method to return "rotation".

override public function getAffectedProperties():Array {
return ["rotation"];
}

// Override initInstance() method.

override protected function initInstance(inst:IEffectInstance):void {
super.initInstance(inst);
RotationTransInstance(inst).angleFrom = angleFrom;
RotationTransInstance(inst).angleTo = angleTo;

Writing an effect for a transition 245

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
}
}
}
In the RotationTransInstance.as class, you modify the play() method to calculate the default
values for the angleFrom and angleTo properties. This method performs the following
actions:
1. Determines whether the user set values for the angleFrom and angleTo properties.
2. If not, determines whether the Effectinstance.propertyChanges property was
initialized with start and end values. If so, the method uses those values to configure the
effect.
3. If not, sets the angleFrom and angleTo properties to the default values of 0 for the
angleFrom property, and 360 for the angleTo property.

The following example shows the RotationTransInstance.as class:

package myEffects
{
// myEffects/RotationTransInstance.as
import mx.effects.effectClasses.TweenEffectInstance;
import mx.effects.Tween;

public class RotationTransInstance extends TweenEffectInstance

{
// Define parameters for the effect.
public var angleFrom:Number;
public var angleTo:Number;

public function RotationTransInstance(targetObj:Object) {

super(targetObj);
}

// Override play() method class.

override public function play():void {
// All classes must call super.play().
super.play();

// Check whether angleFrom is set.

if (isNaN(angleFrom))
{
// If not, look in propertyChanges.start for a value.
// Otherwise, set it to 0.
angleFrom = (propertyChanges.start["rotation"] != undefined) ?
propertyChanges.start["rotation"] : 0;

// Check whether angleTo is set.

246 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
if (isNaN(angleTo))
{
// If not, look in propertyChanges.end for a value.
// Otherwise, set it to 360.
angleTo = (propertyChanges.end["rotation"] != undefined) ?
propertyChanges.end["rotation"] : 360;
}

// Create a Tween object. The tween begins playing immediately.

var tween:Tween =
createTween(this, angleFrom, angleTo, duration);
}

// Override onTweenUpdate() method.

override public function onTweenUpdate(val:Object):void {
target.rotation = val;
}

// Override onTweenEnd() method.

override public function onTweenEnd(val:Object):void {
// All classes that implement onTweenEnd()
// must call super.onTweenEnd().
super.onTweenEnd(val);
}
}
}

Writing an effect for a transition 247

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The following application uses the RotationTrans effect:
<?xml version="1.0" encoding="UTF-8"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myEffects.*">

<mx:states>
<mx:State name="One">
<mx:SetProperty target="{p1}" name="x" value="110"/>
<mx:SetProperty target="{p1}" name="y" value="0"/>
<mx:SetProperty target="{p1}" name="width" value="200"/>
<mx:SetProperty target="{p1}" name="height" value="210"/>
<mx:SetProperty target="{p2}" name="x" value="0"/>
<mx:SetProperty target="{p2}" name="y" value="0"/>
<mx:SetProperty target="{p2}" name="width" value="100"/>
<mx:SetProperty target="{p2}" name="height" value="100"/>
<mx:SetProperty target="{p3}" name="x" value="0"/>
<mx:SetProperty target="{p3}" name="y" value="110"/>
<mx:SetProperty target="{p3}" name="width" value="100"/>
<mx:SetProperty target="{p3}" name="height" value="100"/>
</mx:State>
<mx:State name="Two">
<mx:SetProperty target="{p2}" name="x" value="110"/>
<mx:SetProperty target="{p2}" name="y" value="0"/>
<mx:SetProperty target="{p2}" name="width" value="200"/>
<mx:SetProperty target="{p2}" name="height" value="210"/>
<mx:SetProperty target="{p3}" name="x" value="0"/>
<mx:SetProperty target="{p3}" name="y" value="110"/>
<mx:SetProperty target="{p3}" name="width" value="100"/>
<mx:SetProperty target="{p3}" name="height" value="100"/>
</mx:State>
</mx:states>

<mx:transitions>
<mx:Transition fromState="*" toState="*">
<mx:Sequence id="t1" targets="{[p1,p2,p3]}">
<mx:Parallel>
<mx:Move duration="400"/>
<mx:Resize duration="400"/>
</mx:Parallel>
<MyComp:RotationTrans filter="move"/>
</mx:Sequence>
</mx:Transition>
</mx:transitions>

<mx:Canvas id="pm" width="100%" height="100%" >
<mx:Panel id="p1" title="One"

248 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
x="0" y="0" width="100" height="100"
click="currentState='One'" >
<mx:Label fontSize="24" text="One"/>
</mx:Panel>
<mx:Panel id="p2" title="Two"
x="0" y="110" width="100" height="100"
click="currentState='Two'" >
<mx:Label fontSize="24" text="Two"/>
</mx:Panel>
<mx:Panel id="p3" title="Three"
x="110" y="0" width="200" height="210"
click="currentState=''" >
<mx:Label fontSize="24" text="Three"/>
</mx:Panel>
</mx:Canvas>
</mx:Application>

Defining a custom effect trigger

You can create a custom effect trigger to handle situations for which the standard Flex triggers
do not meet your needs. An effect trigger is paired with a corresponding event that invokes
the trigger. For example, a Button control has a mouseDown event and a mouseDownEffect
trigger. The event initiates the corresponding effect trigger when a user clicks a component.
You use the mouseDown event to specify the event listener that executes when the user selects
the component. You use the mouseDownEffect trigger to associate an effect with the trigger.
Suppose that you want to apply an effect that sets the brightness level of a component when a
user action occurs. The following example shows a custom Button control that uses a new
property, bright, and dispatches two new events, darken and brighten, based on changes to
the bright property. The control also defines two new effect triggers, darkenEffect and
brightenEffect, which are paired with the darken event and the brighten event.
<?xml version="1.0"?>

<mx:Button xmlns:mx="http://www.adobe.com/2006/mxml" >

<mx:Metadata>

[Event(name="darken", type="flash.events.Event")]
[Event(name="brighten", type="flash.events.Event")]
[Effect(name="darkenEffect", event="darken")]
[Effect(name="brightenEffect", event="brighten")]
</mx:Metadata>

<mx:Script>
<![CDATA[
import flash.events.Event;

Defining a custom effect trigger 249

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta

// Define the private variable for the bright setting.

private var _bright:Boolean = true;

// Define the setter to dispatch the events

// corresponding to the effect triggers.
public function set bright(value:Boolean):void {
_bright = value;

if (_bright)
dispatchEvent(new Event("brighten"));
else
dispatchEvent(new Event("darken"));
}

// Define the getter to return the current bright setting.

public function get bright():Boolean {
return _bright;
}
]]>
</mx:Script>

</mx:Button>
When you declare an event in the form [Event(name="eventName",
type="package.eventType")], you can also create a corresponding effect, in the form
[Effect(name="eventnameEffect", event="eventname")]. As in the previous example,
in the <mx:Metadata> tag, you insert the metadata statements that define the two new events,
darken and brighten, and the new effect triggers, darkenEffect and brightenEffect, to
the Flex compiler.
For more information on using metadata, see Chapter 5, “Using Metadata Tags in Custom
Components,” on page 45.

250 Creating Effects

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
The application in the following example uses the MyButton control. The darkenEffect and
brightenEffect properties are set to the FadeOut and FadeIn effects, respectively. The
click event of a second Button control toggles the MyButton control’s bright property and
executes the corresponding effect (FadeOut or FadeIn).
<?xml version="1.0"?>

<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:MyComp="myComponents.*" >

<mx:Fade id="FadeOut" duration="1000" alphaFrom="1.00" alphaTo=".20"/>
<mx:Fade id="FadeIn" duration="1000" alphaFrom=".20" alphaTo="1.00"/>

<!-- Define custom button that defines the

darkenEffect and brightenEffect. -->
<MyComp:MyButton
label="MyButton" id="btn"
darkenEffect="{FadeOut}"
brightenEffect="{FadeIn}"
darken="debugW.text='got darken event';"
brighten="debugW.text='got brighten event';"/>

<mx:Button
label="set bright to false"
click="btn.bright = false; myTA.text=String(btn.bright);"/>

<mx:Button
label="set bright to true"
click="btn.bright = true; myTA.text=String(btn.bright);"/>

<mx:TextArea id="myTA" />

<mx:TextArea id="debugW" />

<MyComp:MyButton id="btn2" label="test effects"
mouseDownEffect="{FadeOut}"
mouseUpEffect="{FadeIn}"/>

</mx:Application>

Defining a custom effect trigger 251

Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta 1 Flex 3 Beta
Overriding the initEffect() method
The EffectInstance class defines the initEffect() method that you can override in your
custom effect. This method has the following signature:
public initEffect(event:Event):void

where event is the Event object dispatched by the event that triggered the effect.
For example, a user might create an instance of an effect, but not provide all of the
configuration information that is required to play the effect. Although you might be able to
assign default values to all properties within the definition of the effect class, in some cases you
might have to determine the default values at run time.
In this method, you can examine the Event object and the effect target to calculate values at
run time. For more information on how to create a custom event and an effect trigger, see
“Defining a custom effect trigger” on page 249. As part of that example, you can add
properties to the Event object passed to the dispatchEvent() method. You can then access
that Event object, and its additional properties, from the initEffect() method.
By overriding the initEffect() method, you can also access the target property of the
Event object to reference the target component of the effect. For example, if you must
determine the current x and y coordinates of the component, or its current height and width,
you can access them from your override of the initEffect() method.

252 Creating Effects

Flex 3 Beta 1

Index

A composite MXML components 81

compound components 174
accessibility, custom components 172 constructor
ActionScript about 28
classpath 65 implementing 159
coding practices 25 createChildren() method 159
custom components 21 creating components
defining components 121 adding events 144
distributing components as 69 extending a class 16
Application object, accessing 101 using metadata statements 47
CSS
inheritance 186
B setting styles 187
behaviors custom components
in applications 229 best practices 174
defining custom effects 235 compound 174
Bindable metadata keyword 49 metadata 47
types 21
versioning 173
C custom effect trigger 249
class hierarchy 15 custom effects
class statement 28 creating 230
classes factory and instance classes 230
extending classes and subclasses 16 custom events, dispatching 38, 143
hierarchy for components 15, 122 custom properties, data binding 132
classpath, ActionScript 65 custom, formatting 210
commitProperties() method 160, 161
compiling
about 63 D
compc 64 data binding
mxmlc 64 custom properties 132
web-tier compiler 65 in custom properties 99
component instantiation life cycle 152 data validation 219
components data, custom formatters 210
class hierarchy 15, 122 default property 130
compound 174 DefaultProperty metadata keyword 53
getters and setters 30, 96 deferred creation 201

253
Flex 3 Beta 1
deploying components 23 IDeferredInstance interface 201
dispatchEvent() method 144 images, Embed metadata keyword 49
import statement 27
Inspectable metadata keyword 49
E instance class 230
Effect metadata keyword 49 InstanceType metadata keyword 58
effects instantiation, troubleshooting custom components
custom 230 183
custom effect trigger 249 interfaces
defining custom 235 about 114, 156
for transitions 242 IMXMLObject interface 116
tween effects 239
Embed metadata keyword 49
enableAccessibility() method 173 K
Event class, creating a subclass 38 keywords, metadata 49
Event metadata keyword 49, 55, 59
events
about 35 L
adding 144 layoutChrome() method 168
custom 109 life cycle, component instantiation 152
defining in ActionScript components 141
dispatching custom events 38
Event metadata keyword 49, 55, 59 M
Event metadata tag 40 measure() method 164
from composite components 112 metadata keywords
handling 107 available 49
NonCommittingChangeEvent metadata keyword Bindable 49
59 custom components 47
extending classes 16 Embed 49
extending graphical components 174 Event 55, 59
NonCommittingChangeEvent 59
Style 59, 61, 191
F syntax 47
faceless components, definition 21 tags 49
factory class 230 using 47
formatters metadata tags
error handling 212 about 46
extending 216 Event 40
formatting, data methods
custom 210 defining 32
ZIP codes 213 overrides 138
MXML
ActionScript classes and 15
G custom components 19
getters 30, 96 custom properties and methods 92
multiple files 77
MXML components
I about 77
IconFile metadata keyword 49 creating 78

254
Flex 3 Beta 1
reusable 91 for metadata 49
See also specific tag names
template components
N about 197
NonCommittingChangeEvent metadata keyword 50, data types 199
59 transitions 242
troubleshooting 182
tween effects 239
P type selector 89
package statement 25
performance, RSLs 23, 68
postal codes, formatting 213
U
properties UIComponent methods 150
as getters and setters 30 updateDisplayList() method 168
as variables 30
commitProperties() method 161
getter and setters 128 V
getters and setters 96 validation, multiple fields example 224
inspectable 98 validators 220
MXML 95 VBox layout, overriding 170
versioning 173
visual components 149
R
runtime shared libraries (RSLs), definition 23, 68

S
scope
about 34
custom components 83
screen readers, accessibility in custom components 173
setters, defining for custom components 30, 96
skins, style property 195
startup time, RSLs 23, 68
static constants 42
Style metadata keyword 50, 59, 61, 191
styles
about 185
custom components 84, 145
setting 186
setting defaults 194
Style metadata keyword 50, 59, 61, 191
super keyword 33
SWC files, distributing components as 67
syntax, for metadata statements 47

T
tags

255
Flex 3 Beta 1

256

The How of Happiness
92% (36)
The How of Happiness
193 pages
Becoming A Data Driven Organization Ebook
100% (1)
Becoming A Data Driven Organization Ebook
23 pages
Business and Data Analytics
No ratings yet
Business and Data Analytics
4 pages
Flex2 Createextendcomponents
No ratings yet
Flex2 Createextendcomponents
254 pages
Beta 2
No ratings yet
Beta 2
177 pages
Flash As2 Components Help
100% (1)
Flash As2 Components Help
192 pages
Adobe Flex 3 Developer Guide
100% (3)
Adobe Flex 3 Developer Guide
1,328 pages
Download Full Flex 4 Cookbook Real world recipes for developing Rich Internet Applications 1st Edition Joshua Noble PDF All Chapters
100% (2)
Download Full Flex 4 Cookbook Real world recipes for developing Rich Internet Applications 1st Edition Joshua Noble PDF All Chapters
51 pages
[Ebooks PDF] download Flex 4 Cookbook Real world recipes for developing Rich Internet Applications 1st Edition Joshua Noble full chapters
100% (5)
[Ebooks PDF] download Flex 4 Cookbook Real world recipes for developing Rich Internet Applications 1st Edition Joshua Noble full chapters
61 pages
Advanced Multiplayer Game Development with Ureal Engine 5: A Comprehensive Guide to C++ Scripting
From Everand
Advanced Multiplayer Game Development with Ureal Engine 5: A Comprehensive Guide to C++ Scripting
Vladimir Kiselev
No ratings yet
Aura Oss
No ratings yet
Aura Oss
383 pages
Flash As3 Components Help
No ratings yet
Flash As3 Components Help
258 pages
Flex 4 Cookbook Real world recipes for developing Rich Internet Applications 1st Edition Joshua Noble - The full ebook version is just one click away
No ratings yet
Flex 4 Cookbook Real world recipes for developing Rich Internet Applications 1st Edition Joshua Noble - The full ebook version is just one click away
56 pages
Getting Started Flex
No ratings yet
Getting Started Flex
86 pages
Gray Hat Hacking the Ethical Hacker's
From Everand
Gray Hat Hacking the Ethical Hacker's
Çağatay Şanlı
5/5 (1)
(Ebook) The Essential Guide to Flex 3 (Essential Guide) by Charles E Brown ISBN 9781590599501, 1590599500 download
100% (1)
(Ebook) The Essential Guide to Flex 3 (Essential Guide) by Charles E Brown ISBN 9781590599501, 1590599500 download
52 pages
CNC Machining Handbook: Building, Programming, and Implementation
From Everand
CNC Machining Handbook: Building, Programming, and Implementation
Alan Overby
No ratings yet
Inside AX 2012 R3
60% (5)
Inside AX 2012 R3
86 pages
Inside AX 2012 R3 Preview
No ratings yet
Inside AX 2012 R3 Preview
86 pages
Compiler Api User Guide
No ratings yet
Compiler Api User Guide
24 pages
(Ebook) Learning Flex 4: Getting Up to Speed with Rich Internet Application Design and Development (Adobe Dev Lib) by Alaric Cole, Elijah Robison ISBN 9780596805630, 0596805632 download
100% (3)
(Ebook) Learning Flex 4: Getting Up to Speed with Rich Internet Application Design and Development (Adobe Dev Lib) by Alaric Cole, Elijah Robison ISBN 9780596805630, 0596805632 download
50 pages
Aura Oss
No ratings yet
Aura Oss
354 pages
Using Adobe Flex Builder 3
100% (1)
Using Adobe Flex Builder 3
233 pages
Lightning
No ratings yet
Lightning
548 pages
Plain JavaScript: Learning the Front-End
From Everand
Plain JavaScript: Learning the Front-End
Roger Beans-Rivet
No ratings yet
Lightning Aura
No ratings yet
Lightning Aura
613 pages
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
From Everand
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
Matthew C. Smith
No ratings yet
WPF Programmer s Reference Windows Presentation Foundation with C 2010 and NET 4 1st Edition Rod Stephens - The complete ebook version is now available for download
100% (1)
WPF Programmer s Reference Windows Presentation Foundation with C 2010 and NET 4 1st Edition Rod Stephens - The complete ebook version is now available for download
55 pages
Flex 4.0 Compiler API
No ratings yet
Flex 4.0 Compiler API
27 pages
Satham
No ratings yet
Satham
56 pages
NUKE 101: Professional Compositing and Visual Effects
No ratings yet
NUKE 101: Professional Compositing and Visual Effects
56 pages
Lightning
No ratings yet
Lightning
155 pages
Cybersecurity for Executives: A Guide to Protecting Your Business
From Everand
Cybersecurity for Executives: A Guide to Protecting Your Business
Matthew C. Smith
No ratings yet
Learning ActionScript 3 0 A Beginner s Guide 1st Edition Rich Shupe - Download the ebook now for an unlimited reading experience
No ratings yet
Learning ActionScript 3 0 A Beginner s Guide 1st Edition Rich Shupe - Download the ebook now for an unlimited reading experience
57 pages
Autodesk Composite 2011 User Guide
No ratings yet
Autodesk Composite 2011 User Guide
916 pages
XML Developer Reference Free Sampler
No ratings yet
XML Developer Reference Free Sampler
26 pages
Lightning
100% (1)
Lightning
469 pages
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
No ratings yet
Instant Download (Ebook) Foundation XML and E4X for Flash and Flex by Sas Jacobs ISBN 9781430216346, 1430216344 PDF All Chapters
100% (1)
Instant Download (Ebook) Foundation XML and E4X for Flash and Flex by Sas Jacobs ISBN 9781430216346, 1430216344 PDF All Chapters
72 pages
[Ebooks PDF] download ActionScripting in Flash 1st Edition Phillip Kerman full chapters
100% (2)
[Ebooks PDF] download ActionScripting in Flash 1st Edition Phillip Kerman full chapters
77 pages
The Essential Guide to Flex 3 Essential Guide 1st Edition Charles E Brown - The ebook in PDF/DOCX format is available for instant download
No ratings yet
The Essential Guide to Flex 3 Essential Guide 1st Edition Charles E Brown - The ebook in PDF/DOCX format is available for instant download
82 pages
Sams Teach Yourself Macromedia Flash MX 2004 in 24 Hours Sams Teach Yourself Phillip Kerman - The latest ebook edition with all chapters is now available
100% (1)
Sams Teach Yourself Macromedia Flash MX 2004 in 24 Hours Sams Teach Yourself Phillip Kerman - The latest ebook edition with all chapters is now available
47 pages
Tips & Traps for Building Decks, Patios, and Porches
From Everand
Tips & Traps for Building Decks, Patios, and Porches
R. Dodge Woodson
No ratings yet
Computing Fundamentals: IC3 Edition
From Everand
Computing Fundamentals: IC3 Edition
Faithe Wempen
No ratings yet
WPF Programmer s Reference Windows Presentation Foundation with C 2010 and NET 4 1st Edition Rod Stephens - The ebook is now available, just one click to start reading
100% (2)
WPF Programmer s Reference Windows Presentation Foundation with C 2010 and NET 4 1st Edition Rod Stephens - The ebook is now available, just one click to start reading
54 pages
ActionScripting in Flash 1st Edition Phillip Kerman - Download the ebook now to never miss important content
100% (3)
ActionScripting in Flash 1st Edition Phillip Kerman - Download the ebook now to never miss important content
40 pages
Fireworks MX Tutorials: Macromedia
No ratings yet
Fireworks MX Tutorials: Macromedia
62 pages
Flex 4 Fun 1st Edition Chet Haase - Download the ebook now and own the full detailed content
100% (1)
Flex 4 Fun 1st Edition Chet Haase - Download the ebook now and own the full detailed content
45 pages
Developing Rich Client Applications
No ratings yet
Developing Rich Client Applications
279 pages
Flash Tutorials
100% (39)
Flash Tutorials
292 pages
Fl8 Tutorials
No ratings yet
Fl8 Tutorials
290 pages
Lightning
No ratings yet
Lightning
590 pages
Software Patterns Made Easy
From Everand
Software Patterns Made Easy
Justice Nanhou
No ratings yet
Programming Arduino Next Steps: Going Further with Sketches, Second Edition
From Everand
Programming Arduino Next Steps: Going Further with Sketches, Second Edition
Simon Monk
3/5 (3)
Content Creation Revolution with chatGPT
From Everand
Content Creation Revolution with chatGPT
Maria Cowen
No ratings yet
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
From Everand
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
Jay Nans
No ratings yet
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
From Everand
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
Michael Basler
No ratings yet
OCP Oracle Database 11g Administration II Exam Guide: Exam 1Z0-053
From Everand
OCP Oracle Database 11g Administration II Exam Guide: Exam 1Z0-053
Bob Bryla
No ratings yet
Adobe Acrobat 7.0 QuickSteps
From Everand
Adobe Acrobat 7.0 QuickSteps
Marty Matthews
No ratings yet
A To Z of Internet: Everything You Wanted to Know
From Everand
A To Z of Internet: Everything You Wanted to Know
Bittu Kumar
No ratings yet
Programming Arduino Next Steps: Going Further with Sketches
From Everand
Programming Arduino Next Steps: Going Further with Sketches
Simon Monk
3/5 (3)
Mastering Python Advanced Concepts and Practical Applications
From Everand
Mastering Python Advanced Concepts and Practical Applications
Aissa Younes
No ratings yet
The TAB Book of Arduino Projects: 36 Things to Make with Shields and Proto Shields
From Everand
The TAB Book of Arduino Projects: 36 Things to Make with Shields and Proto Shields
Simon Monk
5/5 (7)
S.NO. Location Address: MTNL Total SCB Drop Boxes List
No ratings yet
S.NO. Location Address: MTNL Total SCB Drop Boxes List
34 pages
Office Vocabulay Key
No ratings yet
Office Vocabulay Key
4 pages
Fishing Rods
No ratings yet
Fishing Rods
15 pages
Proceduri
No ratings yet
Proceduri
2 pages
Administering Cloud Pod Architecture in Horizon 7 - VMware Horizon 7 7.8
No ratings yet
Administering Cloud Pod Architecture in Horizon 7 - VMware Horizon 7 7.8
98 pages
Oracle On AIX - Configuration and Tuning
No ratings yet
Oracle On AIX - Configuration and Tuning
55 pages
Word KMS Client - PL
No ratings yet
Word KMS Client - PL
3 pages
Java Oca Se7 Dump Gold
No ratings yet
Java Oca Se7 Dump Gold
32 pages
Parallel Algorithm by Rc4
No ratings yet
Parallel Algorithm by Rc4
22 pages
Registration Data Sheet ALTERNATE PDF
0% (1)
Registration Data Sheet ALTERNATE PDF
1 page
Powershell Commandlets - BitLocker Module
No ratings yet
Powershell Commandlets - BitLocker Module
50 pages
Manual C2 4000 Series
No ratings yet
Manual C2 4000 Series
108 pages
CA7 Scheduling
No ratings yet
CA7 Scheduling
9 pages
Sandeep RDBMS Notes
No ratings yet
Sandeep RDBMS Notes
197 pages
IC Agile Resource Planning Template 9260
No ratings yet
IC Agile Resource Planning Template 9260
5 pages
Ecommerce Notes For Bcom
No ratings yet
Ecommerce Notes For Bcom
115 pages
Orthogonal Array Testing
100% (2)
Orthogonal Array Testing
9 pages
MM-FI Integration in PO For Handling Down Payments
No ratings yet
MM-FI Integration in PO For Handling Down Payments
8 pages
Release Notes
No ratings yet
Release Notes
119 pages
Fcomp 06 1359471 1
No ratings yet
Fcomp 06 1359471 1
15 pages
Interview Questions and Answer or Learning Pega - 39
100% (1)
Interview Questions and Answer or Learning Pega - 39
11 pages
INSITE™ QST30 G-Drive Install Bulletin: Software Before Reading This Document
No ratings yet
INSITE™ QST30 G-Drive Install Bulletin: Software Before Reading This Document
5 pages
Kindle Publishing Guidelines
No ratings yet
Kindle Publishing Guidelines
4 pages
The Design and Implementation of A Job-Matching Portal Using Clustering Algorithm
No ratings yet
The Design and Implementation of A Job-Matching Portal Using Clustering Algorithm
42 pages
Design With The JSF Architecture
No ratings yet
Design With The JSF Architecture
6 pages
Business Events: Product Overview/Fundamentals
100% (1)
Business Events: Product Overview/Fundamentals
18 pages
Sunday, September 18, 2016 Pitch Time:: IPE. Officer Maintenance Technician Prod - Officer
No ratings yet
Sunday, September 18, 2016 Pitch Time:: IPE. Officer Maintenance Technician Prod - Officer
14 pages