Welcome!

Java IoT Authors: Liz McMillan, Elizabeth White, Jnan Dash, Greg O'Connor, Pat Romanski

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.

_originalLabel.setBorder(
  BorderFactory.createEmptyBorder( 0, 0, 6, 0 ));
_chosenLabel.setBorder(
  BorderFactory.createEmptyBorder( 0, 0, 6, 0 ));
_add.setBorder(
  BorderFactory.createCompoundBorder(
  BorderFactory.createEmptyBorder( 0, 11, 5, 11 ),
  _add.getBorder()));
_addAll.setBorder(
  BorderFactory.createCompoundBorder(
  BorderFactory.createEmptyBorder( 0, 11, 11, 11 ),
  _addAll.getBorder()));
_remove.setBorder(
  BorderFactory.createCompoundBorder(
  BorderFactory.createEmptyBorder( 0, 11, 5, 11 ),
  _remove.getBorder()));
_removeAll.setBorder(
  BorderFactory.createCompoundBorder(
  BorderFactory.createEmptyBorder( 0, 11, 0, 11 ),
  _removeAll.getBorder()));

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 )
{    .
    .
    .
  _addAll.setEnabled(
   originalModel.getSize() > 0 );
  _removeAll.setEnabled(
   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 )
{     .
     .
     .
  _originalList.
   addListSelectionListener( this );
  _chosenList.
   addListSelectionListener( this );
  actionPerformed(
   new ActionEvent( this, 0, "" ));
  valueChanged(
   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.

Conclusion
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.

Resources

  • 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
    Cloud computing is being adopted in one form or another by 94% of enterprises today. Tens of billions of new devices are being connected to The Internet of Things. And Big Data is driving this bus. An exponential increase is expected in the amount of information being processed, managed, analyzed, and acted upon by enterprise IT. This amazing is not part of some distant future - it is happening today. One report shows a 650% increase in enterprise data by 2020. Other estimates are even higher....
    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, wh...
    Video experiences should be unique and exciting! But that doesn’t mean you need to patch all the pieces yourself. Users demand rich and engaging experiences and new ways to connect with you. But creating robust video applications at scale can be complicated, time-consuming and expensive. In his session at @ThingsExpo, Zohar Babin, Vice President of Platform, Ecosystem and Community at Kaltura, will discuss how VPaaS enables you to move fast, creating scalable video experiences that reach your...
    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 sett...
    SYS-CON Events announced today that SoftLayer, an IBM Company, has been named “Gold Sponsor” of SYS-CON's 18th Cloud Expo, which will take place on June 7-9, 2016, at the Javits Center in New York, New York. SoftLayer, an IBM Company, provides cloud infrastructure as a service from a growing number of data centers and network points of presence around the world. SoftLayer’s customers range from Web startups to global enterprises.
    19th Cloud Expo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy. Meanwhile, 94% of enterpri...
    Businesses are struggling to manage the information flow and interactions between all of these new devices and things jumping on their network, and the apps and IT systems they control. The data businesses gather is only helpful if they can do something with it. In his session at @ThingsExpo, Chris Witeck, Principal Technology Strategist at Citrix, will discuss how different the impact of IoT will be for large businesses, expanding how IoT will allow large organizations to make their legacy ap...
    In his general session at 18th Cloud Expo, Lee Atchison, Principal Cloud Architect and Advocate at New Relic, discussed cloud as a ‘better data center’ and how it adds new capacity (faster) and improves application availability (redundancy). The cloud is a ‘Dynamic Tool for Dynamic Apps’ and resource allocation is an integral part of your application architecture, so use only the resources you need and allocate /de-allocate resources on the fly.
    SYS-CON Events announced today the Enterprise IoT Bootcamp, being held November 1-2, 2016, in conjunction with 19th Cloud Expo | @ThingsExpo at the Santa Clara Convention Center in Santa Clara, CA. Combined with real-world scenarios and use cases, the Enterprise IoT Bootcamp is not just based on presentations but with hands-on demos and detailed walkthroughs. We will introduce you to a variety of real world use cases prototyped using Arduino, Raspberry Pi, BeagleBone, Spark, and Intel Edison. Y...
    The vision of a connected smart home is becoming reality with the application of integrated wireless technologies in devices and appliances. The use of standardized and TCP/IP networked wireless technologies in line-powered and battery operated sensors and controls has led to the adoption of radios in the 2.4GHz band, including Wi-Fi, BT/BLE and 802.15.4 applied ZigBee and Thread. This is driving the need for robust wireless coexistence for multiple radios to ensure throughput performance and th...
    Internet of @ThingsExpo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devices - comp...
    The many IoT deployments around the world are busy integrating smart devices and sensors into their enterprise IT infrastructures. Yet all of this technology – and there are an amazing number of choices – is of no use without the software to gather, communicate, and analyze the new data flows. Without software, there is no IT. In this power panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists will look at the protocols that communicate data and the emerging data analy...
    “We're a global managed hosting provider. Our core customer set is a U.S.-based customer that is looking to go global,” explained Adam Rogers, Managing Director at ANEXIA, in this SYS-CON.tv interview at 18th Cloud Expo, held June 7-9, 2016, at the Javits Center in New York City, NY.
    According to Forrester Research, every business will become either a digital predator or digital prey by 2020. To avoid demise, organizations must rapidly create new sources of value in their end-to-end customer experiences. True digital predators also must break down information and process silos and extend digital transformation initiatives to empower employees with the digital resources needed to win, serve, and retain customers.
    Smart Cities are here to stay, but for their promise to be delivered, the data they produce must not be put in new siloes. In his session at @ThingsExpo, Mathias Herberts, Co-founder and CTO of Cityzen Data, will deep dive into best practices that will ensure a successful smart city journey.
    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.
    DevOps at Cloud Expo, taking place Nov 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait for long dev...
    The Jevons Paradox suggests that when technological advances increase efficiency of a resource, it results in an overall increase in consumption. Writing on the increased use of coal as a result of technological improvements, 19th-century economist William Stanley Jevons found that these improvements led to the development of new ways to utilize coal. In his session at 19th Cloud Expo, Mark Thiele, Chief Strategy Officer for Apcera, will compare the Jevons Paradox to modern-day enterprise IT, e...
    What happens when the different parts of a vehicle become smarter than the vehicle itself? As we move toward the era of smart everything, hundreds of entities in a vehicle that communicate with each other, the vehicle and external systems create a need for identity orchestration so that all entities work as a conglomerate. Much like an orchestra without a conductor, without the ability to secure, control, and connect the link between a vehicle’s head unit, devices, and systems and to manage the ...
    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 lea...