Java IoT Authors: Yeshim Deniz, Pat Romanski, Elizabeth White, Liz McMillan, Carmen Gonzalez

Related Topics: Java IoT

Java IoT: Article

GUI Design Patterns

Choosing data from long lists

Long lists of data present a problem for GUI development. This occurs when choosing records from large database tables or recipients from a long list of e-mail addresses, or any time a subset of data must be chosen from a long list or table.

Two issues arise when choosing from long lists of data. First, what is the best GUI for long lists so that the users understand how to navigate and manipulate their data? Second, if the list holds more than a few hundred items, performance become an issue.

In this article, simple examples show how to optimize usability for this common GUI design pattern. In a later article, more complex examples will show how to optimize performance for long lists.

GUI Design Patterns
In the late 1990s, a GUI design pattern emerged for choosing multiple objects from long lists. The book GUI Design Essentials by Susan Weinschenk, et al, called this the Selection Summary pattern. In "A Dual Listbox Selection Manager" by Steve Aube, it's also known as the Dual Listbox Selection interface. In "The Java Look and Feel Guidelines, Advanced Topics" by Sun Microsystems, it's called the Add-and-Remove idiom. Figure 1 shows an example of this GUI design pattern.

The Add-and-Remove design pattern has many variations. One common enhancement is to provide "Move Up" and "Move Down" buttons to reorder the chosen list. Sometimes the chosen list is displayed as a table (as in Figure 2) to show additional information.

This GUI design pattern has several advantages. By presenting the original and chosen lists in a symmetric layout, learning is simplified: once users learn one part of the GUI, the corresponding part works consistently. Also, because objects are moved from one location to another, directional icons and disabling can be used to guide the user.

The most important advantage of a standard GUI design like this is that because it is widely known, users will most likely have seen it before and therefore understand it quickly. A standard GUI design pattern is the simplest way to achieve usability.

Lay Out the Components
Listing 1 shows how this GUI design pattern can be implemented using the Swing components JList, JScrollPane, ImageIcon, and GridBagLayout. The GridBagLayout enables the alignment of unequal-sized components and provides good behavior on resizing. For a basic implementation, we need a grid with three columns and five rows. Lists, labels, and buttons are placed using GridBagConstraints so that when the component is resized, the lists grow or shrink while other components retain their original size (see Figure 3).

To support the Add-and-Remove pattern, the list contents must be mutable; i.e., the lists must dynamically change in response to the button presses. The DefaultListModel provides mutable storage that performs satisfactorily for lists of moderate size.

In Listing 1, the ActionListener interface connects the buttons to the lists. The actionPerformed method uses the button text to determine which of the four buttons was pressed.

The code in Listing 1 produces the GUI shown in Figure 4.

The DefaultListModel is not the default ListModel. By default, JLists use an internal ListModel that is immutable: you can't change its contents. This internal ListModel is efficient when applications only need to view a list because it doesn't carry the overhead of changing list contents.

To change list contents, as in the Add-and-Remove pattern, requires a mutable ListModel. Swing provides one in javax.swing.DefaultListModel, and it gives good performance for most applications. For long lists DefaultListModel is not particularly fast, and a later article will show how to improve on its performance.

Follow the Guidelines
"The Java Look and Feel Guidelines" specify precise spacings in multiples of six pixels between components. To follow these guidelines, EmptyBorders are added around the buttons and labels.

  BorderFactory.createEmptyBorder( 0, 0, 6, 0 ));
  BorderFactory.createEmptyBorder( 0, 0, 6, 0 ));
  BorderFactory.createEmptyBorder( 0, 11, 5, 11 ),
  BorderFactory.createEmptyBorder( 0, 11, 11, 11 ),
  BorderFactory.createEmptyBorder( 0, 11, 5, 11 ),
  BorderFactory.createEmptyBorder( 0, 11, 0, 11 ),

The Guidelines also recommend mnemonics to support keyboard equivalents of mouse actions, as shown in the code below.

_add.setMnemonic( 'A' );
_addAll.setMnemonic( 'l' );
_remove.setMnemonic( 'R' );
_removeAll.setMnemonic( 'v' );

Note the difference between Figures 4 and 5. By following the guidelines, the GUI appearance is improved.

This example uses the guidelines for the Java ("Metal") Look and Feel. If you target a different platform the guidelines will be different. For example, Windows Guidelines specify different spacings between the components.

Whatever the target platform, the reason for following guidelines is to make life easier for the user. When your application looks and works the way the users expect, they have less to learn.

Help the Users Learn
"The Java Look and Feel Guidelines, Advanced Topics" by Sun recommends the use of icons in the buttons. If icons are stored with the ListChooser class, they can be assigned with the following code.

_add.setIcon( new ImageIcon(
  ListSelector.class.getResource( "images/add.gif" )));
_add.setHorizontalTextPosition( SwingConstants.LEFT );
_addAll.setIcon( new ImageIcon(
  ListSelector.class.getResource( "images/addAll.gif" )));
_addAll.setHorizontalTextPosition( SwingConstants.LEFT );
_remove.setIcon( new ImageIcon(
  ListSelector.class.getResource( "images/remove.gif" )));
_remove.setHorizontalTextPosition( SwingConstants.RIGHT );
_removeAll.setIcon( new ImageIcon(
  ListSelector.class.getResource( "images/removeAll.gif")));
_removeAll.setHorizontalTextPosition( SwingConstants.RIGHT );

These simple icons transform the buttons into a diagram of information flow through the GUI. The icons make the users' possible actions clear before they read the buttons' text, enabling new users to understand the buttons' functions at a glance.

The icons in Figure 6 are chosen because they're familiar to most users; similar icons appear on most tape and disk players. "The Java Look and Feel Guidelines, Advanced Topics" illustrate other icons specific to the Java look and feel. Whatever icons are chosen, the program should provide equal margins on the left and right to ensure consistent spacing between the icons and the button text. A slight margin below the icon, as shown in Figure 7, can improve vertical alignment.

Prevent User Errors
One of the best ways to improve usability is to prevent the user from making a mistake. The authors of GUI Design Essentials recommend disabling unavailable actions. This technique guides users through the GUI, preventing them from taking actions that make no sense.

This effective GUI design pattern is trivially easy to code. The ActionListener interface enables the "Add All" and "Remove All" buttons when the lists contain objects, and disables them when the lists are empty.

public void actionPerformed(
  ActionEvent e )
{    .
   originalModel.getSize() > 0 );
   chosenModel.getSize() > 0 );

The ListSelectionListener interface enables the "Add" and "Remove" buttons when objects are selected, and disables them when no objects are selected.

public void valueChanged(
   ListSelectionEvent e )
{ _add.setEnabled( _originalList.
   getSelectedValues().length > 0 );
  _remove.setEnabled( _chosenList.
   getSelectedValues().length > 0 );

As shown in Listing 1, the ListChooser registers itself as an ActionListener to receive events when buttons are pressed. To receive events when list contents are selected, the ListChooser registers itself as a ListSelectionListener. Also, at the end of the constructor, two dummy events are initiated to set the default enabled states.

public ListChooser(
  Object[] original, Object[] chosen )
{     .
   addListSelectionListener( this );
   addListSelectionListener( this );
   new ActionEvent( this, 0, "" ));
   new ListSelectionEvent(
   this, 0, 0, false ));

The effect of this code is shown in Figure 8. Rather than trying to deal with the user pressing the wrong button, the program uses disabling to prevent the mistake from occurring. Disabling unavailable actions is one of the simplest and most effective GUI design patterns.

GUI Variations
All of the GUI design patterns described above apply to tables as well as lists. Listing 2 shows an implementation using JTable and TableModel instead of JList and ListModel. "The Java Look and Feel Guidelines" recommend only one table column in the original list and multiple columns in the chosen list. As shown in Listing 2, this can be done by disabling the header and grid lines in the original table, and by assigning the preferred viewport size based on TableColumn widths.

The GridBagLayout code is omitted from Listing 2 as it is similar to the simpler variation of Listing 1. If "Move Up" and "Move Down" buttons are provided, the GridBagLayout contains seven rows instead of five. Following "The Java Look and Feel Guidelines," the spacing between these optional buttons is six pixels greater than between the "Add" and "Remove" buttons.

The ActionListener implementation is slightly different in Listing 2 because of the use of TableModels instead of ListModels. The code in Listing 2 produces the GUI shown in Figure 2.

Details of the JTable and TableModel can be found in The JFC Swing Tutorial (by Kathy Walrath and Mary Campione), along with descriptions of the JList and ListModel. The JTable is more complex than the JList, but when displaying long lists they share many of the same performance issues. A future article will discuss these issues and how to optimize performance for this common GUI design pattern.

The Add-and-Remove pattern enables users to choose multiple objects from long lists. This standard GUI design pattern improves usability by easing the user's learning curve. Standard spacing, directional icons, and button disabling all reduce the users' efforts, enabling them to accomplish their tasks easily in a professional user interface.


  • Aube, S. (2000). "A Dual Listbox Selection Manager": www.codeguru.com/Cpp/controls/listbox/article.php/c4755
  • Walrath, K., and Campione, M. (2004). The JFC Swing Tutorial: A Guide to Constructing GUIs. Addison-Wesley Professional: java.sun.com/docs/books/tutorial/uiswing/components/
  • "Official Guidelines for User Interface Developers and Designers." Microsoft Inc. (2004): msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwue/html/welcome.asp
  • Sun Microsystems Inc. (2001). Java Look and Feel Design Guidelines, Second Edition. Addison-Wesley Professional: java.sun.com/products/jlf/ed2/book/HIG.Misc.html
  • Sun MicroSystems Inc. (2002). Java Look and Feel Design Guidelines: Advanced Topics. Addison-Wesley Professional: java.sun.com/products/jlf/at/book/Idioms6.html
  • Weinschenk, S., Jamar, P., and Yeo, S. (1997). GUI Design Essentials. John Wiley & Sons.
  • More Stories By Heman Robinson

    Heman Robinson is a senior developer with SAS Institute in Cary, N.C. He holds a BS in mathematics from the University of North Carolina and an MS in computer science from the University of Southern California. He has specialized in GUI design and development for 15 years and has been a Java developer since 1996.

    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
    steve 02/14/05 07:04:05 PM EST

    Does anyone have code that accomplishes this for VB.NET?

    @ThingsExpo Stories
    The IoT industry is now at a crossroads, between the fast-paced innovation of technologies and the pending mass adoption by global enterprises. The complexity of combining rapidly evolving technologies and the need to establish practices for market acceleration pose a strong challenge to global enterprises as well as IoT vendors. In his session at @ThingsExpo, Clark Smith, senior product manager for Numerex, will discuss how Numerex, as an experienced, established IoT provider, has embraced a ...
    DevOps is being widely accepted (if not fully adopted) as essential in enterprise IT. But as Enterprise DevOps gains maturity, expands scope, and increases velocity, the need for data-driven decisions across teams becomes more acute. DevOps teams in any modern business must wrangle the ‘digital exhaust’ from the delivery toolchain, "pervasive" and "cognitive" computing, APIs and services, mobile devices and applications, the Internet of Things, and now even blockchain. In this power panel at @...
    SYS-CON Events announced today that Super Micro Computer, Inc., a global leader in Embedded and IoT solutions, will exhibit at SYS-CON's 20th International Cloud Expo®, which will take place on June 7-9, 2017, at the Javits Center in New York City, NY. Supermicro (NASDAQ: SMCI), the leading innovator in high-performance, high-efficiency server technology, is a premier provider of advanced server Building Block Solutions® for Data Center, Cloud Computing, Enterprise IT, Hadoop/Big Data, HPC and ...
    SYS-CON Events announced today that SoftNet Solutions will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. SoftNet Solutions specializes in Enterprise Solutions for Hadoop and Big Data. It offers customers the most open, robust, and value-conscious portfolio of solutions, services, and tools for the shortest route to success with Big Data. The unique differentiator is the ability to architect and ...
    In the next forty months – just over three years – businesses will undergo extraordinary changes. The exponential growth of digitization and machine learning will see a step function change in how businesses create value, satisfy customers, and outperform their competition. In the next forty months companies will take the actions that will see them get to the next level of the game called Capitalism. Or they won’t – game over. The winners of today and tomorrow think differently, follow different...
    “Media Sponsor” of SYS-CON's 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. CloudBerry Backup is a leading cross-platform cloud backup and disaster recovery solution integrated with major public cloud services, such as Amazon Web Services, Microsoft Azure and Google Cloud Platform.
    In past @ThingsExpo presentations, Joseph di Paolantonio has explored how various Internet of Things (IoT) and data management and analytics (DMA) solution spaces will come together as sensor analytics ecosystems. This year, in his session at @ThingsExpo, Joseph di Paolantonio from DataArchon, will be adding the numerous Transportation areas, from autonomous vehicles to “Uber for containers.” While IoT data in any one area of Transportation will have a huge impact in that area, combining sensor...
    More and more brands have jumped on the IoT bandwagon. We have an excess of wearables – activity trackers, smartwatches, smart glasses and sneakers, and more that track seemingly endless datapoints. However, most consumers have no idea what “IoT” means. Creating more wearables that track data shouldn't be the aim of brands; delivering meaningful, tangible relevance to their users should be. We're in a period in which the IoT pendulum is still swinging. Initially, it swung toward "smart for smar...
    @ThingsExpo has been named the Top 5 Most Influential M2M Brand by Onalytica in the ‘Machine to Machine: Top 100 Influencers and Brands.' Onalytica analyzed the online debate on M2M by looking at over 85,000 tweets to provide the most influential individuals and brands that drive the discussion. According to Onalytica the "analysis showed a very engaged community with a lot of interactive tweets. The M2M discussion seems to be more fragmented and driven by some of the major brands present in the...
    Successful digital transformation requires new organizational competencies and capabilities. Research tells us that the biggest impediment to successful transformation is human; consequently, the biggest enabler is a properly skilled and empowered workforce. In the digital age, new individual and collective competencies are required. In his session at 19th Cloud Expo, Bob Newhouse, CEO and founder of Agilitiv, will draw together recent research and lessons learned from emerging and established ...
    The best way to leverage your Cloud Expo presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering Cloud Expo and @ThingsExpo will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at Cloud Expo. Product announcements during our show provide your company with the most reach through our targeted audiences.
    November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Penta Security is a leading vendor for data security solutions, including its encryption solution, D’Amo. By using FPE technology, D’Amo allows for the implementation of encryption technology to sensitive data fields without modification to schema in the database environment. With businesses having their data become increasingly more complicated in their mission-critical applications (such as ERP, CRM, HRM), continued ...
    Explosive growth in connected devices. Enormous amounts of data for collection and analysis. Critical use of data for split-second decision making and actionable information. All three are factors in making the Internet of Things a reality. Yet, any one factor would have an IT organization pondering its infrastructure strategy. How should your organization enhance its IT framework to enable an Internet of Things implementation? In his session at @ThingsExpo, James Kirkland, Red Hat's Chief Arch...
    SYS-CON Events announced today that Enzu will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Enzu’s mission is to be the leading provider of enterprise cloud solutions worldwide. Enzu enables online businesses to use its IT infrastructure to their competitive advantage. By offering a suite of proven hosting and management services, Enzu wants companies to focus on the core of their online busine...
    SYS-CON Events announced today that Cloudbric, a leading website security provider, will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Cloudbric is an elite full service website protection solution specifically designed for IT novices, entrepreneurs, and small and medium businesses. First launched in 2015, Cloudbric is based on the enterprise level Web Application Firewall by Penta Security Sys...
    Why do your mobile transformations need to happen today? Mobile is the strategy that enterprise transformation centers on to drive customer engagement. In his general session at @ThingsExpo, Roger Woods, Director, Mobile Product & Strategy – Adobe Marketing Cloud, covered key IoT and mobile trends that are forcing mobile transformation, key components of a solid mobile strategy and explored how brands are effectively driving mobile change throughout the enterprise.
    SYS-CON Events announced today that Roundee / LinearHub will exhibit at the WebRTC Summit at @ThingsExpo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. LinearHub provides Roundee Service, a smart platform for enterprise video conferencing with enhanced features such as automatic recording and transcription service. Slack users can integrate Roundee to their team via Slack’s App Directory, and '/roundee' command lets your video conference ...
    Established in 1998, Calsoft is a leading software product engineering Services Company specializing in Storage, Networking, Virtualization and Cloud business verticals. Calsoft provides End-to-End Product Development, Quality Assurance Sustenance, Solution Engineering and Professional Services expertise to assist customers in achieving their product development and business goals. The company's deep domain knowledge of Storage, Virtualization, Networking and Cloud verticals helps in delivering ...
    SYS-CON Events announced today that Embotics, the cloud automation company, will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Embotics is the cloud automation company for IT organizations and service providers that need to improve provisioning or enable self-service capabilities. With a relentless focus on delivering a premier user experience and unmatched customer support, Embotics is the fas...
    In the next five to ten years, millions, if not billions of things will become smarter. This smartness goes beyond connected things in our homes like the fridge, thermostat and fancy lighting, and into heavily regulated industries including aerospace, pharmaceutical/medical devices and energy. “Smartness” will embed itself within individual products that are part of our daily lives. We will engage with smart products - learning from them, informing them, and communicating with them. Smart produc...