Home > Articles > Programming > Java

Simple Tips for More Powerful Tables

Four simple tips can help you build more powerful, customized Swing table components. Jeff Friesen uncovers the secrets of using ToolTips, moving a column's cursor, coloring a table component's cells, and moving columns from the keyboard.
Like this article? We recommend

Like this article? We recommend

The previous article explored Swing's table component by walking you through Swing's JTable class and related classes. In addition to teaching you about JTable's inner structure, that article showed you how to accomplish some basic things with a JTable by calling various JTable methods. This article expands on that knowledge by introducing four simple tips that can help you build more powerful table components.

Assign ToolTips to Column Headers

Occasionally, you might find it helpful to assign ToolTips to your table component's column headers. ToolTips provide long descriptive names that, when assigned to column headers, offer additional feedback about the purpose of table component columns. That feedback benefits the table component's users by allowing them to more clearly understand a column's purpose and how to interact with that column's cells. Figure 1 illustrates a simple demonstration table component that displays a column-specific ToolTip when the mouse cursor's hotspot—that part of a mouse cursor icon used by Java to determine whether the mouse cursor is over a component—enters that column's header.

Figure 1 The third column header's ToolTip appears when the mouse cursor's hotspot enters that column's header.

Assigning ToolTips to column headers requires you to subclass the JTableHeader class (located in the javax.swing.table package) and to override its getToolTipText() method. Code within that method identifies the column that a mouse cursor's hotspot is positioned over and returns an appropriate String object that contains that column's ToolTip text. For a detailed look at how those tasks are accomplished, examine Listing 1's HeaderToolTips source code.

Listing 1: HeaderToolTips.java

// HeaderToolTips.java

import java.awt.*;
import java.awt.event.*;

import javax.swing.*;
import javax.swing.table.*;

class HeaderToolTips extends JFrame
{
  HeaderToolTips (String title)
  {
   // Pass the title to the JFrame superclass so that it appears in
   // the title bar.

   super (title);

   // Tell the program to exit when the user either selects Close
   // from the System menu or presses an appropriate X button on the
   // title bar.

   setDefaultCloseOperation (EXIT_ON_CLOSE);

   // Create a default table model consisting of headersText columns
   // and 10 rows.

   String [] headersText =
   {
     "Header #1",
     "Header #2",
     "Header #3",
     "Header #4",
     "Header #5",
     "Header #6"
   };

   DefaultTableModel dtm = new DefaultTableModel (headersText, 10);

   // Create a table using the previously created default table
   // model.

   JTable jt = new JTable (dtm);

   // Obtain the table's column model and pass it to the constructor
   // of a new TTHeader (ToolTip Header) object. The column model
   // contains all information on the table's columns.

   TTHeader tth = new TTHeader (jt.getColumnModel ());

   // Assign myToolTipsText to the TTHeader object.

   String [] myToolTipsText =
   {
     "",
     "Header #2 ToolTip Text",
     "Header #3 ToolTip Text",
     "",
     "Header #5 ToolTip Text",
     ""
   };

   tth.setToolTipsText (myToolTipsText);

   // Assign default ToolTip text for those headers that do not have
   // their own ToolTip text (as indicated by "" in myToolTipsText),
   // to the TTHeader object.

   tth.setToolTipText ("Default ToolTip text");

   // Assign the TTHeader to the JTable object as that table's 
   // header.

   jt.setTableHeader (tth);

   // Place the table in a JScrollPane object (to allow the table to
   // be vertically scrolled and display scrollbars, as necessary).

   JScrollPane jsp = new JScrollPane (jt);

   // Add the JScrollPane object to the frame window's content pane.
   // That allows the table to be displayed within a displayed 
   // scroll pane.

   getContentPane ().add (jsp);

   // Establish the overall size of the frame window to 400
   // horizontal pixels by 225 vertical pixels.

   setSize (400, 225);

   // Display the frame window and all contained
   // components/containers.

   setVisible (true);
  }

  public static void main (String [] args)
  {
   // Create a HeaderToolTips object, which creates the GUI.

   new HeaderToolTips ("Header ToolTips");
  }
}

class TTHeader extends JTableHeader
{
  // The following String array holds all ToolTip text, with one entry
  // for each table column. If a column is to display default ToolTip
  // text, the corresponding entry is "".

  private String [] allToolTipsText;

  TTHeader (TableColumnModel tcm)
  {
   // Pass the TableColumnModel object to the superclass, which 
   // takes care of that object.

   super (tcm);
  }

  // The following method is automatically called when the mouse 
  // cursor hotspot moves over any one of the header rectangles in a
  // table header.

  public String getToolTipText (MouseEvent e)
  {
   // Return the pixel position of the mouse cursor hotspot.

   Point p = e.getPoint ();

   // Convert the pixel position to the zero-based column index of
   // the table header column over which the mouse cursor hotspot is
   // located. The result is a view-based column index.

   int viewColumnIndex = columnAtPoint (p);

   // Retrieve a reference to the JTable object associated with the
   // table header.

   JTable jt = getTable ();

   // Convert the view-based column index to a model-based column
   // index.

   int modelColumnIndex = 
     jt.convertColumnIndexToModel (viewColumnIndex);

   // If model's ToolTip text is not present in allToolTipsText, 
   // that means the default ToolTip text should be returned. 
   // Otherwise, return the actual ToolTip text.

   if (allToolTipsText [modelColumnIndex].length () == 0)
     return super.getToolTipText (e);
   else
     return allToolTipsText [modelColumnIndex];
  }

  void setToolTipsText (String [] myToolTipsText)
  {
   // Save the ToolTips text array for use by getToolTipText().

   allToolTipsText = myToolTipsText;
  }
}

HeaderToolTips associates a column header's name with appropriate ToolTip text by way of its headersText and myToolTipsText String arrays. Each entry at a given index in headersText maps to an entry at the same index in myToolTipsText. For example, Header #2 at index 1 in headersText maps to Header #2 ToolTip Text at index 1 in myToolTipsText.

The myToolTipsText array is accessed from the getToolTipsText() method via the allToolTipsText reference variable in the TTHeader class. Because a TTHeader object registers with a JTable object via a call to JTable's setTableHeader() method in HeaderToolTips's constructor (so that the TTHeader object can serve as the table component's header), Swing calls TTHeader's getToolTipText() method—with a MouseEvent argument that identifies the current mouse position—when the mouse cursor's hotspot moves over a table component column header. In response, getToolTipText() returns a String identifying the column header's ToolTip text. Swing will render that text in a window (behind the scenes), and a ToolTip will appear.

The first task that getToolTipText() performs is to convert the pixel coordinates in its MouseEvent object argument (as referenced by e) to a column index by calling JTableHeader's columnAtPoint() method. The integer returned from columnAtPoint() represents the zero-based index of the column over which the mouse cursor's hotspot appears. Furthermore, the returned index is view-specific. What does that mean? It means that index 0 always refers to the leftmost column, index 1 always refers to the next-to-leftmost column, and so forth. That has ramifications for mapping ToolTip text to column headers. For example, if you associate ToolTip text with view-specific column index 1, that text associates with whatever column appears in the next-to-leftmost column position. Therefore, if you drag the column at view-specific column index 1 (by holding down the left mouse button while the mouse cursor's hotspot appears over that column's header and by moving the mouse) to a different column position, some other column would occupy the position at view-specific column index 1 and use the same ToolTip text as the column just dragged. Furthermore, the column just dragged would acquire its new position's ToolTip text.

CAUTION

Don't use view-specific column indexes to index into the ToolTip text array. If you do, the resulting text associates with a view-specific column, not the actual column. When you drag that column to another portion of the table component, the ToolTip text does not follow that column. Moving the mouse cursor's hotspot over the column header in its new position reveals that position's ToolTip, not the column's ToolTip.

JTable's convertColumnIndexToModel() method is called to convert the view-specific column index to a model-specific column index. The resulting index associates with a specific column based on the table component's model, not on a view of that table component. Once obtained, the model-specific column index is used to obtain the associated ToolTip text String from allToolTipsText. If the String's length is 0, a call is made to super.getToolTipText (e); to retrieve the default ToolTip text, which returns to the caller of the overridden getToolTipText() method. (What sets the default ToolTip text? The answer is tth.setToolTipText ("Default ToolTip text");, which simply calls JTableHeader's setToolTipText() method to assign default text. That text returns from super.getToolTipText(e);.) If the String's length is not 0, the appropriate entry in the allToolTipsText array returns. And that is how you assign ToolTips to column headers.

TIP

If you are unclear on why it is not good to associate ToolTip text with a view-specific index, comment out int modelColumnIndex = jt.convertColumnIndexToModel (viewColumnIndex); in Listing 1's getToolTipText() method and insert int modelColumnIndex = viewColumIndex;. Recompile and run the application. View the ToolTip text for each column and try dragging one of those columns with nondefault ToolTip text. It shouldn't take long for you to see why it is not a good idea to associate ToolTip text with a view-specific column index.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020