Welcome!

Java IoT Authors: Liz McMillan, Elizabeth White, Pat Romanski, Yeshim Deniz, Frank Lupo

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
    SYS-CON Events announced today that Yuasa System will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Yuasa System is introducing a multi-purpose endurance testing system for flexible displays, OLED devices, flexible substrates, flat cables, and films in smartphones, wearables, automobiles, and healthcare.
    SYS-CON Events announced today that Dasher Technologies will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Dasher Technologies, Inc. ® is a premier IT solution provider that delivers expert technical resources along with trusted account executives to architect and deliver complete IT solutions and services to help our clients execute their goals, plans and objectives. Since 1999, we'v...
    Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities – ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups. As a result, many firms employ new business models that place enormous impor...
    SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
    SYS-CON Events announced today that Taica will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Taica manufacturers Alpha-GEL brand silicone components and materials, which maintain outstanding performance over a wide temperature range -40C to +200C. For more information, visit http://www.taica.co.jp/english/.
    SYS-CON Events announced today that TidalScale, a leading provider of systems and services, will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. TidalScale has been involved in shaping the computing landscape. They've designed, developed and deployed some of the most important and successful systems and services in the history of the computing industry - internet, Ethernet, operating s...
    SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
    SYS-CON Events announced today that IBM has been named “Diamond Sponsor” of SYS-CON's 21st Cloud Expo, which will take place on October 31 through November 2nd 2017 at the Santa Clara Convention Center in Santa Clara, California.
    SYS-CON Events announced today that TidalScale will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. TidalScale is the leading provider of Software-Defined Servers that bring flexibility to modern data centers by right-sizing servers on the fly to fit any data set or workload. TidalScale’s award-winning inverse hypervisor technology combines multiple commodity servers (including their ass...
    Join IBM November 1 at 21st Cloud Expo at the Santa Clara Convention Center in Santa Clara, CA, and learn how IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Cognitive analysis impacts today’s systems with unparalleled ability that were previously available only to manned, back-end operations. Thanks to cloud processing, IBM Watson can bring cognitive services and AI to intelligent, unmanned systems. Imagine a robot vacuum that becomes your personal assistant tha...
    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.
    Infoblox delivers Actionable Network Intelligence to enterprise, government, and service provider customers around the world. They are the industry leader in DNS, DHCP, and IP address management, the category known as DDI. We empower thousands of organizations to control and secure their networks from the core-enabling them to increase efficiency and visibility, improve customer service, and meet compliance requirements.
    As popularity of the smart home is growing and continues to go mainstream, technological factors play a greater role. The IoT protocol houses the interoperability battery consumption, security, and configuration of a smart home device, and it can be difficult for companies to choose the right kind for their product. For both DIY and professionally installed smart homes, developers need to consider each of these elements for their product to be successful in the market and current smart homes.
    With major technology companies and startups seriously embracing Cloud strategies, now is the perfect time to attend 21st Cloud Expo October 31 - November 2, 2017, at the Santa Clara Convention Center, CA, and June 12-14, 2018, at the Javits Center in New York City, NY, and learn what is going on, contribute to the discussions, and ensure that your enterprise is on the right path to Digital Transformation.
    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 ...
    SYS-CON Events announced today that mruby Forum will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. mruby is the lightweight implementation of the Ruby language. We introduce mruby and the mruby IoT framework that enhances development productivity. For more information, visit http://forum.mruby.org/.
    Digital transformation is changing the face of business. The IDC predicts that enterprises will commit to a massive new scale of digital transformation, to stake out leadership positions in the "digital transformation economy." Accordingly, attendees at the upcoming Cloud Expo | @ThingsExpo at the Santa Clara Convention Center in Santa Clara, CA, Oct 31-Nov 2, will find fresh new content in a new track called Enterprise Cloud & Digital Transformation.
    Most technology leaders, contemporary and from the hardware era, are reshaping their businesses to do software. They hope to capture value from emerging technologies such as IoT, SDN, and AI. Ultimately, irrespective of the vertical, it is about deriving value from independent software applications participating in an ecosystem as one comprehensive solution. In his session at @ThingsExpo, Kausik Sridhar, founder and CTO of Pulzze Systems, will discuss how given the magnitude of today's applicati...
    SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp emp...
    In a recent survey, Sumo Logic surveyed 1,500 customers who employ cloud services such as Amazon Web Services (AWS), Microsoft Azure, and Google Cloud Platform (GCP). According to the survey, a quarter of the respondents have already deployed Docker containers and nearly as many (23 percent) are employing the AWS Lambda serverless computing framework. It’s clear: serverless is here to stay. The adoption does come with some needed changes, within both application development and operations. Tha...