Welcome!

Adobe Flex Authors: Matthew Lobas, PR.com Newswire, Shelly Palmer, Kevin Benedict

Related Topics: Adobe Flex

Adobe Flex: Article

Flex: The Value-Aware ComboBox

Extending a standard Flex ComboBox by adding a missing property to it

From Farata Systems blog

Adobe Flex framework contains a pretty impressive library of the off-the-shelf controls, which can fit the bill for many of the Rich Internet Applications needs. And yet, it is just the tip of the iceberg, because Flex enables you to create, combine and/or extend existing components with a simplicity and elegance hardly ever offered by other GUI development systems.  In this article I’ll show you how to start extending a standard ComboBox component, which is  a combination of edit field, button and a dropdown list. We will be customizing the API and adding some new functionality, making our ComboBox  a bit handier than a standard one.

A typical task, while working with a standard ComboBox, is to programmatically select a specific value. Suppose our ComboBox is populated with array of states:

private var usStates:Array=[
{label:"New York", data:"NY"},
{label:"Colorado", data:"CO"},
{label:"Texas", data:"TX"}                
];
.   .   .   .   .   .   .   .
<mx:ComboBox id="cbx_states" dataProvider="{usStates}"/>

To programmatically select Texas (to the visible portion of the ComboBox), you can write the following index-fetching loop, comparing val against the label of each element of dataProvider:

var val:String;

val = ’Texas’ ;
for (var i: int = 0; i < cbx.dataProdider.length; i++) {
if ( val == cbx_states.dataProvider[i].label) {
cbx_states.selectedIndex = i;
break;
}    
}

Alternatively, you could look up the data of dataProvider’s elements :

var val:String;

val = 'TX'  ;
for (var i: int = 0; i < cbx.dataProdider.length; i++) {
if ( val == cbx.dataProvider[i].data) {
cbx_states.selectedIndex = i;
break;
}    
}

Either way these index-fetching loops will clutter the application code instead of simple cbx_states.value=‘Texas’. On top of that, index-fetching via data is often unapplicable. Consider real-life ComboBox records coming from databases, messages etc. We can’t “mandate” to these data sources to contain  data field in the relevant record sets. And while the  standard ComboBox provides the labelField property, allowing to draw a label value from an arbitrary property, there is not a dataField property, which would allow a similar flexibility for data.

So far we’ve identified areas for improvement in selecting or setting value. Now let’s look at the opposite opperations. Standard ComboBox offers the properties  selectedIndex and selectedItem. When a ComboBox is populated with strings, selectedItem  returns selected string (or null if nothing is selected). If it’s populated with objects, selectedItem references selected  object ( or contains null):

<mx:Application xmlns:mx=http://www.adobe.com/2006/mxml creationComplete="onCreationComplete()">

private function onCreationComplete():void {
mx.control.Alert.show(cbx_states.selectedItem.label); // displays 'New York'
cbx_states.selectedIndex=-1;             //Removes initial selection
mx.control.Alert.show(cbx_states.selectedItem); // “displays” null
}
.  .  .  .  .  .  .  .  .
</mx:Application>

Listing 1 Using selectedItem and selectedIndex properties

But wait, there is also a read-only value property:  if a selected object has something in the data property, value refers to  data, otherwise value refers to  the label:

mx.control.Alert.show(cbx_states.value); // displays 'NY'

As you can see value does a half of the job: it shields us from selectedItem/ selectedIndex. What we miss is another half and in the following sections we will turn value into a read-write property. That will forever absolve us from index-fetching loops to modify the ComboBox selection.

We will also introduce the dataField property which will support any arbitrary property in place of  data, depending on a  specific ComboBox instance

Making the  value Property Writeable

Let’s start with upgrading  the value to the first class writeable property. The simplest way to do this is by extending the original ComboBox so that derived class provides a special setter for the value property. The setter attempts to match the value with either data or label properties of the dataProvider. Once a match is found, it modifies the selectedIndex which should cause the ComboBox to select the matching object:

<?xml version="1.0" encoding="utf-8"?>
<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml"  >
<mx:Script>
<![CDATA[
public function set value(val:Object)  : void {
if ( val != null ) {
for (var i : int = 0; i < dataProvider.length; i++) {
if ( val == dataProvider[i].data || val == dataProvider[i].label) {
selectedIndex = i;
return;
}    }    }
selectedIndex = -1;
}
]]>
</mx:Script>
</mx:ComboBox>

Listing 2. ComboBox.mxml - Making the value property writeable

If the ComboBox.mxml is located under the com/theriabook/controls, its test application can look as in  Listing 3 below.

<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" xmlns="*" xmlns:lib="com.theriabook.controls.*">
<mx:ArrayCollection id="comboData" >
<mx:Array>
<mx:Object label="New York" data="NY"/>
<mx:Object label="Connecticut" data="CT"/>
<mx:Object label="Illinois" data="IL"/>
</mx:Array>
</mx:ArrayCollection>
<mx:Label text="Current bound value is '{cbx_1.value}' " />
<lib:ComboBox id="cbx_1" value="IL" width="150" dataProvider="{comboData}"/>
</mx:Application>


Listing 3. Using our new ComboBox

Run this  application,  and you’ll see the ComboBox displaying the value New York… while we  would expect Illinois. We forgot about the order in which objects’ properties (cbx_1) get initialized. In particular, the  value property is initialized before the dataProvider. And, since during dataProvider initialization ComboBox, by default, selects the first item, the work performed by our value setter is wasted. You can prove the point by just trading places of value and dataProvider in the above application code.

Should we rely on the order of attributes in MXML components? Apparently not. Especially when Flex offers an excellent mechanism to coordinate the updates to multiple properties of the control – the commitProperties() method.

Here is how it works: whenever you need to modify a property raise some indicator, store the value in the temporary variable and call invalidateProperties(), like in the following snippet:

private var candidateValue:Object;
private var valueDirty:Boolean = false;

public function set value(val:Object)  : void {
candidateValue = val;
valueDirty = true;        
invalidateProperties();
}

In response to invalidateProperties() Flex will schedule a call of commitProperties() for a later execution,  so that all property changes deferred in the above manner can be consolidated in a single place and in the pre-determined order:

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

if (dataProviderDirty)    {
super.dataProvider = candidateDataProvider;
dataProviderDirty = false;
}

if (valueDirty) {
applyValue(candidateValue);
valueDirty = false;
}            
}

Aside of co-ordinating updates to different properties, this coding pattern helps to avoid multiple updates to the same property and, in general, allows setter methods to return faster, improving the overall performance of the control. The entire code of our “value-aware” ComboBox is presented in Listing 4:

<?xml version="1.0" encoding="utf-8"?>
<mx:ComboBox xmlns:mx="http://www.adobe.com/2006/mxml" >
<mx:Script>
<![CDATA[

private var candidateValue:Object;
private var valueDirty:Boolean = false;
private var candidateDataProvider:Object;
private var dataProviderDirty:Boolean = false;

private function applyValue(val:Object):void {
if ((val != null) && (dataProvider != null)) {

for (var i : int = 0; i < dataProvider.length; i++) {
if ( val == dataProvider[i].data || val == dataProvider[i].label) {
selectedIndex = i;
return;
}    }    }
selectedIndex = -1;
}    

public function set value(val:Object)  : void {
candidateValue = val;
valueDirty = true;        
invalidateProperties();
}
override public function set dataProvider(value:Object):void {
candidateDataProvider = value;
dataProviderDirty = true;
invalidateProperties();
}

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

if (dataProviderDirty)    {
super.dataProvider = candidateDataProvider;
dataProviderDirty = false;
}

if (valueDirty) {
applyValue(candidateValue);
valueDirty = false;
}            
}        
]]>
</mx:Script>
</mx:ComboBox>


Listing 4. The value-aware ComboBox

Now everything works as expected. The screenshot of the running application is presented below:



Figure 1. The “value-aware" ComboBox in action

If you change the ComboBox selection, the top label, which initially contains Current bound value is “IL” will change accordingly. No miracles here, a regular Flex data binding one would say. Indeed, good things are easy to take for granted. Still, we have not provided any binding declarations or binding code in our ComboBox. So why does it work? It works because the original Flex definition of value getter ComboBox has already been marked with metadata tag [“Bindable”], which makes the property bindable (you do not have to have a setter to be bindable):

[Bindable("change")]
[Bindable("valueCommitted")]

But wait, you may say, these binding definitions indicate  that data modifications bound to value property get triggered in response to events change or valueCommitted. Yet our value setter does not contain a single  dispatchEvent call. Where is the catch? Events are dispatched inside the code that assigns  selectedIndex. This assignment results in invocation of selectedIndex setter, which ultimately dispatches events.

More Stories By Victor Rasputnis

Dr. Victor Rasputnis is a Managing Principal of Farata Systems. He's responsible for providing architectural design, implementation management and mentoring to companies migrating to XML Internet technologies. He holds a PhD in computer science from the Moscow Institute of Robotics. You can reach him at [email protected]

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...