Welcome!

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

Related Topics: Adobe Flex

Adobe Flex: Article

Macromedia Flash - How To Use the Singleton Design Pattern

A standardized solution to a common programming problem

Design patterns are standardized solutions to common programming problems. It's good to use design patterns for two simple reasons. First, it's faster (and many times better) to implement a time-tested design pattern as opposed to developing a custom solution. Second, collaboration with other developers increases when common practices are used.

The Singleton Pattern
The Singleton design pattern is one of the most widely known design patterns; and it's also one of the simplest. It's used to insure that a class is only instantiated once. The pattern also provides a global point of access to the sole instance of that class. Many classes have to be able to limit their instantiation to a single instance. For example, you may write a focus manager for you application. If you had two instances of the focus manager, they might conflict with each other and create race conditions. So it's essential that you have only one instance per application.

There are two goals for the Singleton pattern: one instance and global access. The global access point insures that all of your classes have access to that single instance. But the main task of the Singleton pattern is to ensure that there is only one instance of the class. That's why the Singleton pattern lets the class manage its own instantiation. Instead of creating an instance of the class by using a new keyword, outside access will be given via a static method that returns the lone instance of the class. If the instance doesn't exist then it creates the instance before returning the reference.

There are two things you must do to make the Singleton pattern work. The first is to use a static method to retrieve the instance of the class and a static property to store the instance. The static keyword indicates that the following method or property is created only once per class rather than being created in every instance of the class.

The second thing you must do is make the constructor private. A private constructor is rare in ActionScript. Since the constructor is private, instantiation can only happen in the class. By making the constructor private, you can insure that no one can instantiate your class outside of the static method.

The Singleton pattern may seem complex, but the code is actually simple. The following example contains all the code you would need to make your class follow the Singleton pattern:

class Singleton {
static private instance:Singleton;
private function Singleton() {}
static public function getInstance():Singleton {
if(instance == undefined) {
instance = new Singleton();
}
return instance;
}

The instantiation of a Singleton class is a little different from a normal class. Normally we'd call the constructor directly like this:

var foo:Singleton = new Singleton();

However, in the Singleton pattern our constructor is private so that code would fail. We must get the single instance of this class by calling the static getInstance method like this:

var foo:Singleton = Singleton.getInstance();

Singleton in Action
In the following example, we'll build a class for tracking the navigation history of a given application. We'll use the Singleton pattern so all of an application's navigational classes track this history information in a central location. An example of some navigational classes might be a menu bar, a link, or even a button. All of these objects will have to be able to track the application's history. But ultimately there can be only one navigation history for an application so we use the Singleton pattern. This class is simple. It will simply store a string to describe a history destination. Any variety of information your application may need to determine the history destination could substitute. Our class will contain one private array that will hold all of the items in our application's history. We will also have an addItem method for adding destination items to the history. Then we'll have previousItem and nextItem methods for going forward and backward in our history.

// History.as
class History {
private var historyItems:Array;
private var currentPosition:Number;
static private var instance:History;
private function History() {
historyItems = new Array();
}
static public function getInstance():History {
if(instance == undefined) {
instance = new History();
}
return instance;
}
public function addItem(item:String):Boolean {
if(item != historyItems[currentPosition]) {
if(currentPosition < (historyItems.length - 1)) {
historyItems = historyItems.slice(0,
(currentPosition + 1));
}
historyItems.push(item);
currentPosition = historyItems.length - 1;
return true;
}
return false;
}
public function get nextItem():String {
if(currentPosition != undefined && currentPosition <
(historyItems.length - 1)) {
return historyItems[++currentPosition];
}else {
return null;
}
public function get previousItem():String {
if(currentPosition != undefined && currentPosition > 0) {
return historyItems[--currentPosition];
}else {
return null;
}





More Stories By Danny Patterson

Danny Patterson is a Consultant
specializing in Flash and Web technologies. Danny is a Partner and
Author at Community MX (communitymx.com) and a member of Team Macromedia
Flash. He is a Certified Advanced ColdFusion MX, Flash MX and Flash MX
2004 Developer. You can check out his weblog at DannyPatterson.com.

Comments (1) View Comments

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.


Most Recent Comments
SYS-CON Belgium News Desk 08/03/05 01:41:16 PM EDT

Macromedia Flash - How To Use the Singleton Design Pattern. Design patterns are standardized solutions to common programming problems. It's good to use design patterns for two simple reasons. First, it's faster (and many times better) to implement a time-tested design pattern as opposed to developing a custom solution. Second, collaboration with other developers increases when common practices are used.

IoT & Smart Cities Stories
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...
DXWorldEXPO LLC announced today that Big Data Federation to Exhibit at the 22nd International CloudEXPO, colocated with DevOpsSUMMIT and DXWorldEXPO, November 12-13, 2018 in New York City. Big Data Federation, Inc. develops and applies artificial intelligence to predict financial and economic events that matter. The company uncovers patterns and precise drivers of performance and outcomes with the aid of machine-learning algorithms, big data, and fundamental analysis. Their products are deployed...
All in Mobile is a place where we continually maximize their impact by fostering understanding, empathy, insights, creativity and joy. They believe that a truly useful and desirable mobile app doesn't need the brightest idea or the most advanced technology. A great product begins with understanding people. It's easy to think that customers will love your app, but can you justify it? They make sure your final app is something that users truly want and need. The only way to do this is by ...
The challenges of aggregating data from consumer-oriented devices, such as wearable technologies and smart thermostats, are fairly well-understood. However, there are a new set of challenges for IoT devices that generate megabytes or gigabytes of data per second. Certainly, the infrastructure will have to change, as those volumes of data will likely overwhelm the available bandwidth for aggregating the data into a central repository. Ochandarena discusses a whole new way to think about your next...
CloudEXPO | DevOpsSUMMIT | DXWorldEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
Cell networks have the advantage of long-range communications, reaching an estimated 90% of the world. But cell networks such as 2G, 3G and LTE consume lots of power and were designed for connecting people. They are not optimized for low- or battery-powered devices or for IoT applications with infrequently transmitted data. Cell IoT modules that support narrow-band IoT and 4G cell networks will enable cell connectivity, device management, and app enablement for low-power wide-area network IoT. B...
The hierarchical architecture that distributes "compute" within the network specially at the edge can enable new services by harnessing emerging technologies. But Edge-Compute comes at increased cost that needs to be managed and potentially augmented by creative architecture solutions as there will always a catching-up with the capacity demands. Processing power in smartphones has enhanced YoY and there is increasingly spare compute capacity that can be potentially pooled. Uber has successfully ...
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...