Home > Articles > Programming > Java

This chapter is from the book

This chapter is from the book

Tree Model Events

All of the methods in the previous sections operate by generating TreeMod-elEvents that can be caught by registering a TreeModelListener on the tree's DefaultTreeModel object. Usually, Swing and AWT events are not highly specific about exactly what has changed—the listener is expected to query the source of the event to find out what happened. This is acceptable for simple controls like lists, combo boxes, text fields, and buttons where only one thing can have happened. But in the case of a tree, many modifications of different types can be made. If a single event that said "something has changed" were posted, it would be necessary to scan the whole tree to try and detect what happened. This would, of course, be time-consuming and would require the listener to remember a large amount of state in order to be able to perform a comparison at all.

Because of this, the TreeModelListener must implement four methods, each of which receives a TreeModelEvent:

public void treeNodesChanged(TreeModelEvent)
public void treeStructureChanged(TreeModelEvent)
public void treeNodesInserted(TreeModelEvent)
public void treeNodesRemoved(TreeModelEvent) 

These listener methods are entered as a result of following Default-TreeModel methods being called:


nodeChangedor nodesChangedwas called


reload(either variant) or nodeStructureChanged was called


nodesWereInserted was called


nodesWereRemovedwas called

Splitting at this level is not sufficient, however, because it doesn't tell the listener what was added, removed, or changed. This information is contained in the TreeModelEvent, which has five methods that can be used to extract details of the change to the model:

public Object getSource() 
public TreePath getTreePath()
public Object[] getPath() 
public Object[] getChildren() 
public int[] getChildIndices() 

Which of these methods returns meaningful values and what they mean depends on the type of event. All of the events return a valid value to get-Source, which is a reference to the affected tree model (i.e., the Default-TreeModel instance for the affected JTree). The getTreePath and getPath method both return the node in the tree that is affected by the change, either in terms of its TreePath or as the array of Objects that makes up the TreePath. In the case of an event delivered to treeStructureChanged, only get-Path and getTreePath return any useful information. These methods return the node and below which the change occurred. This TreePath corresponds to the node that was originally passed to reload or nodeStructure-Changed. The getChildren and getChildIndices methods both return null.

For treeNodesChanged, the values returned by getPath and getTree-Path again correspond to the node that is the parent of the node or nodes that were affected. The getChildIndices and getChildren methods return arrays that contain one entry for each affected child of that node. The indices in the array returned by getChildIndices are in ascending numerical order and the array returned by getChildren is sorted so that corresponding entries in these two arrays match—that is, the index in entry n of the index array corresponds to the child in entry n of the child array.

Similarly, getPath and getTreePath return the parent of the affected nodes in both treeNodesRemoved and treeNodesInserted and the get-ChildIndices and getChildren methods retrieve sorted and matching arrays of the affected children. Note, however, that in the case of treeNodes-Removed, these children have already been removed from the parent node and the indices indicate where they used to reside in the parent's list of children, whereas for treeNodesInserted, these indices describe where the children have been inserted—that is, they describe the final state of the model.

Most applications won't need to handle these events because the JTree look-and-feel class registers itself as a listener of the tree's model and updates the tree's appearance based on the events that it receives. You can, however, register a listener of your own if you want the tree control to cause your application to react in some special way to changes in its structure. You'll see examples of this in the rest of this chapter.

A File System Tree Control

The most obvious thing to use a tree control for is to show the content of a machine's file system, in the same way as the Windows Explorer does in the left of its two display panes. Since the file system and JTree are both inherently hierarchical, you might expect it to be a simple matter to create a tree control that maps a file system but, as you'll see in this section, there are a few interesting issues to tackle along the way. As the description of the implementation of this component progresses, you'll see some of the real-world problems that come up when creating new components, including the need to sometimes work around problems in the classes that the new control is based on.

Before looking at how to implement a file system control, let's look at what the finished product looks like. Figure 10–1 shows the control mounted in a frame and running on a Windows platform. If you want to try this out for yourself, use a command like the following:

java JFCBook.Chapter10.FileTreeTest C:\ 

You can replace the string "C:\" with the name of any directory on your system—this is the directory that becomes the root of the file tree.

When you run this example, you should see the directory whose name was supplied on the command line at the top of the display, followed by all of its subdirectories. Like Windows Explorer, this control only shows directories, not files. Windows Explorer shows files in its right-hand pane, which is almost identical to the Swing JFileChooser. Indeed, once you have this control, you can use it, together with the JFileChooser and the JSplit-Pane component that you saw in the last chapter to create an application that looks very much like Windows Explorer itself except, of course, that it also runs on many versions of UNIX (and other platforms).

If you move the mouse over any directory with an expansion icon to the left of it and click on the icon or double-click on the directory icon or name, it opens to reveal its subdirectories. If those subdirectories have other subdirectories, they will also have expansion icons next to them. A directory that doesn't have any subdirectories (i.e., a directory that is empty or contains only files) cannot be expanded. Again, to see the contents, you would need to connect this control to a JFileChooser and have it display the directory's contents.

Core Note

The Swing JTree component doesn't work ideally with respect to displaying the icon for a node that has no children. If you're using a look-and-feel with this problem, you'll find that all of the subdirectories seem to have contents but, when you click on one that actually only has files in it, the icon sign disappears. All of the standard look-and-feels currently behave this way.

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.


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.


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.


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.


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


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


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.


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.


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