Home > Articles > Programming > Java

This chapter is from the book

This chapter is from the book

Customizing the Default Tree Cell Renderer

The default tree cell renderer is provided by the class DefaultTreeCell-Renderer, which resides in the Swing javax.swing.tree package. You can get a reference to the renderer that is installed in a tree by using the JTree getCellRenderer method and you should verify that this returns a DefaultTreeCellRenderer, then cast it and use the methods shown in Table 10-5 to change its behavior as required. The method works for all of the current look-and-feel implementations, because their tree cell renderers are all derived from DefaultTreeCellRenderer.

Table 10–5 Default Tree Cell Renderer Customization Methods

Method

Description

public void setBackgroundNonSelectionColor(Color)

Sets the background color used when the node is not selected.

public void setBackgroundSelectionColor(Color)

Sets the color in which to draw the background of a selected node.

public void setBorderSelectionColor(Color)

Sets the color in which to draw the border of a selected node. There is no method to set the color of the border of a nonselected node because nonselected nodes do not have borders.

public void setTextNonSelectionColor(Color)

Determines the color of the text when the node is not selected.

public void setTextSelectionColor(Color)

Determines the color of the text when the node is selected.

public void setFont(Font)

Sets the font used to render the node's text.

public void setClosedIcon(Icon)

Sets the icon displayed when the node's children are not shown.

public void setOpenIcon(Icon)

Sets the icon displayed when the node's children are shown.

public void setLeafIcon(Icon)

Changes the icon displayed when the node is a leaf.


Since each tree uses a single renderer to draw every node, changes you make using these methods are effective for the whole tree. Since a different instance of the renderer is used for each tree, changes made in this way apply only to the single tree whose renderer is modified.

For the purposes of illustration, the next example changes the background of the tree to black and uses green text for nonselected items and white text for those that are selected. The background color for selected items will also be changed to gray. The starting point for this tree is TreeExample1, which was created earlier. This tree shows the crews of the Skylab space station and the Apollo lunar landing missions. The code that we added to the main method of the program, which we renamed ModifyRenderer, is shown in Listing 10-4.

Listing 10–4 Customizing the default tree cell renderer

// Get the tree's cell renderer. If it is a default
// cell renderer, customize it.
TreeCellRenderer cr = t.getCellRenderer();
if (cr instanceof DefaultTreeCellRenderer) {
  DefaultTreeCellRenderer dtcr =
               (DefaultTreeCellRenderer)cr; 

  // Set the various colors
  dtcr.setBackgroundNonSelectionColor(Color.black);
  dtcr.setBackgroundSelectionColor(Color.gray);
  dtcr.setTextSelectionColor(Color.white); 
  dtcr.setTextNonSelectionColor(Color.green); 

  // Finally, set the tree's background color 
  t.setBackground(Color.black); 
} 

You can run this example for yourself using the command:

java JFCBook.Chapter10.ModifyRenderer 

The result. If you partly expand the tree, will look something like Figure 10–10.

Figure 10–10 Customizing the colors of the nodes.

If you look at the code, you'll see that it gets the tree's renderer and checks that it is the renderer from the basic package, or one derived from it. If it is, then the text and background colors are changed. Once these changes are made, all of the nodes in the tree will be drawn with the new settings. This is a simple way to make basic changes to the tree's appearance. To make more radical changes, you need to customize the renderer that draws each node's representation.

Implementing a Customized Renderer

Like the combo box and list controls, each cell of a tree is drawn by a renderer. Tree renderers implement the TreeCellRenderer interface, which has only has one method:

public abstract Component getTreeCellRendererComponent(
    JTree tree, Object value, boolean selected,
    boolean expanded, boolean leaf, int row,
    boolean hasFocus) 

In most cases, the most important argument passed by this method is the value, which is the object to be formatted. The renderer is responsible for configuring a Component that represents this value in the tree. In terms of the Metal look-and-feel, this component will take the place of the folder or leaf icon and the descriptive text that appears to the right of it. The remaining arguments may be used to affect the way in which the component is rendered. For example, if the node is expanded, the Metal look-and-feel shows an open folder; if it is a leaf, it displays a sheet of paper. Selected rows usually have a background of a different color, while a row with the focus might be drawn with a colored line around the border.

You've just seen that you can use public methods supplied by Default-TreeCellRenderer to customize it to some extent. Another way to change the way a node is rendered is to subclass the default renderer. The default renderer is actually a subclass of JLabel that also implements the Tree-CellRenderer interface. The DefaultTreeCellRenderer just places the text and icon it is given on the label and, aside from some work that takes place in the paint method to paint the background and border of the cell, most of the rendering code is inherited from JLabel. If you subclass DefaultTreeCellRenderer, you can do such things as changing the color in which the text is rendered by setting the label's attributes directly. The advantage of this is that you can vary these attributes for each individual node if necessary, rather than setting constant values that apply to the whole tree.

The following example illustrates how to make the renderer node-specific by using a different text color and icon for leaf nodes. This example is actually an extension of Listing 10-4, which works by creating and installing a subclass of the default renderer. The code that is changed is highlighted in bold in Listing 10-5.

Listing 10–5 Installing a customized version of the default tree cell renderer

TreeCellRenderer cr = t.getCellRenderer(); 
CustomDefaultRenderer dtcr = new CustomDefaultRenderer(); t.setCellRenderer(dtcr); 
// Set the various colors 
dtcr.setBackgroundNonSelectionColor(Color.black); 
dtcr.setBackgroundSelectionColor(Color.gray); 
dtcr.setTextSelectionColor(Color.white); 
dtcr.setTextNonSelectionColor(Color.green); 
// Set the extra attributes for this renderer 
dtcr.setLeafForeground(Color.yellow); 
dtcr.setLeafIcon(new ImageIcon( 
SubClassRenderer.class.getResource(
      "images/earth.gif"))); 

// Change the row height
t.setRowHeight(0); 

// Finally, set the tree's background color 
t.setBackground(Color.black); 

In this example, an instance of the new renderer is instantiated and installed using the JTree setCellRenderer method. The customizations that were used in the previous example can still be applied to it because it is derived from the default renderer, but these changes affect every node in the tree. One extra attribute of the custom renderer allows the color used for leaf nodes to be different from that of branch nodes. This attribute is set in the code shown above using the setLeafForeground method which is implemented by the custom renderer. Note also that the setLeafIcon method, inherited from DefaultTreeCellRenderer, is used to install a different icon that will be used only for leaf nodes. The only other change shown here is to set the cell row height using the JTree setRowHeight method, which requires an integer argument. If you supply a positive value, the rows will all be of that height, whereas a zero or negative value causes the tree look-and-feel class to query the renderer for the height of each row as it draws it, which allows variable height rows. This is necessary in this case because the icon used for leafs nodes is not necessarily the same size as that for branch nodes, so the height of each row needs to depend on the requirements of the node that will occupy it.

Core Note

The default row height is determined by the selected look-and-feel. The Metal look-and-feel does not supply a default height, so each row is as high as its renderer makes it. The Motif look-and-feel sets the default row height to 18 pixels and Windows uses 16 pixels as the default.

The custom renderer itself is actually very simple—its only job is to change the way that the JLabel displays its content by manipulating its properties if the node being rendered is a leaf node. The renderer is implemented here as an inner class, but you could make it equally well a freestand-ing object that can be reused. The code is shown in Listing 10-6.

Listing 10–6 A customized tree cell renderer

// This class is a custom renderer based
// on DefaultTreeCellRenderer
protected static class CustomDefaultRenderer
                   extends DefaultTreeCellRenderer {
  public Component getTreeCellRendererComponent(
              JTree tree,
              Object value,
              boolean selected,
              boolean expanded,
              boolean leaf,
              int row,
              boolean hasFocus) {
  // Allow the original renderer to set up the label
   Component c = super.getTreeCellRendererComponent(
                  tree, value, selected,
                  expanded, leaf, row,
                  hasFocus); 

   if (leaf) { 
     // Use a different foreground
     // color for leaf nodes.
     if (leafForeground != null) {
      c.setForeground(leafForeground);
     } 
   } 

   return c; 
  }
   public void setLeafForeground(Color color) {
     this.leafForeground = color;
   } 

   private Color leafForeground; 
} 

Since the intention is just to change the way in which the label created by the default renderer is configured, the first step in the getTreeCellRendererComponent method is to invoke the corresponding method of the default renderer superclass and let it set up the label as it would normally appear. This arranges for the appropriate text and icon to be installed, based on whether the node is a leaf or not, whether the node is selected, whether it has the focus, and whether it is expanded. Then, if the node being rendered is a leaf, the foreground text color is set to that configured by the application. If this attribute is null, no change is made to the value set by the default renderer. Note that the getTreeCellRendererComponent method determines whether the node is a leaf by using the leaf argument that is supplied to it. If specific behavior were required for expanded nodes or nodes that had the focus, this would also be handled by checking the method argumentnts.

To try this version of the example for yourself, use the command:

java JFCBook.Chapter10.SubClassRenderer 

Figure 10–11 shows a typical snapshot of this example after some of the leaf nodes have been exposed. You'll notice that the branch nodes are rendered as they were in Figure 10–10, but the leaf nodes have an icon that shows the earth as viewed from the moon and the text is yellow.

Figure 10–11 Changing text and icon positions using a custom tree renderer.

One problem with creating a new renderer by subclassing DefaultTree-CellRenderer is that it may only work properly if the Metal or Windows look-and-feel is installed. Because of the fact that this example uses the original renderer functionality by invoking the getTreeCellRendererComponent method of its superclass, there might be a problem if it were replacing the Motif look-and-feel, which has its own cell renderer that is derived from DefaultTreeCellRenderer, because we wouldn't be using its specific getTreeCellRendererComponent method. Whether or not this matters depends entirely on what your customization is. You could, of course, implement a subclass for each of the look-and-feels and install the correct one at run time. There is, however, another technique that avoids having to generate more classes that you'll see in "Rendering and Editing Custom Objects." If you can't achieve the effects you need by subclassing the default renderer, you can provide your own by implementing the TreeCellRenderer interface yourself. The technique for doing this is identical to the one used when creating renderers for the JList and JComboBox control, so it isn't repeated here.

  • + Share This
  • 🔖 Save To Your Account

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