Home > Articles > Programming > Java

Swing Solutions: Integrating Menus in JWord

📄 Contents

  1. Swing Solutions: Integrating Menus in JWord
  2. What's Next?
  3. Books by Steve Haines:
Welcome to the third article in the Swing Solutions' JWord series. The last two articles introduced you to and provided you with an implementation of the Java Swing support for creating menus. This article discusses the Swing classes that used for creating toolbars.
Like this article? We recommend

Like this article? We recommend

Swing Solutions: Integrating Menus in JWord

By Steve Haines - September 20, 2000

Welcome to the third article in the Swing Solutions' JWord series. The last two articles introduced you to and provided you with an implementation of the Java Swing support for creating menus. This article discusses the Swing classes that used for creating toolbars.

Swing Toolbars

If you have ever used a computer, you have certainly been exposed to the toolbar. A toolbar is a collection of buttons that invoke programmatic actions which are typically available through a menu selection. An example of some toolbar buttons with which you should be familiar include the “Back”, “Forward”, “Stop”, and “Refresh” buttons; you should see these buttons in the web browser that you are using to view this page. The toolbar consists of the region that encompasses the toolbar buttons, as well as the buttons themselves.

Figure 1 is an example of the toolbar that we are going to develop in the next two articles.

Figure 1 JWord with its Toolbar

A toolbar is not limited to the top of your window; it can also be docked to any of the four sides of your window (see figures 2, 3, and 4), or it may float (see figure 5).

Figure 2 JWord with its Toolbar docked on the left side

Figure 3 JWord with its Toolbar docked on the bottom

Figure 4 JWord with its Toolbar docked on the right side

Figure 5 JWord with its Toolbar floating

JButton

Each individual button within the toolbar is an instance of the JButton class. A JButton instance can have a text field and/or an icon, and can display floating tooltips; JButton instances that are typically used in the context of a toolbar do not make use of the text element. Its constructors are shown in Table 1.

Table 1. JButton Constructors

Constructor

Description

JButton()

Creates a button without set text or icon

JButton(Action a)

Creates a button where properties are taken from the Action supplied

JButton(Icon icon)

Creates a button with an icon

JButton(String text)

Creates a button with text

JButton(String text, Icon icon)

Creates a button with initial text and an icon

Most of these constructors are fairly self-explanatory; they accept either text or an icon, both text and an icon, or neither. The one that accepts an Action argument requires some explanation. The Action interface is a new addition to the Java 2 Standard Edition version 1.3; it offers great functionality to Java developers by providing a central repository for (1) object text, (2) object icons, (3) enabled/disabled states, and (as its name implies) (4) actions. This article addresses the traditional approach to handling action events, but an upcoming article will address the new 1.3 way to handle action events . If you are curious in the meantime, take a look at the Java SDK documentation under Action and AbstractAction.

When building toolbar buttons, our goal is to construct buttons without text. Following are a couple of sample JButton instances:

// Create a JButton from an image file as an ImageIcon
JButton fileOpen = new JButton( new ImageIcon( “images/fileopen.gif” ) );

// Create a JButton from a Java Look and Feel Graphics Repository icon
JButton fileNew = new JButton( getImage( "general/New24.gif" ) );

Recall that in the last article,we defined a method getImage(), which loads an image from a set of common images that are released by Sun and are known as the Java Look And Feel Graphics Repository (see http://developer.java.sun.com/developer/techDocs/hi/repository/ for more information.) To save you from referencing that article, below is the code for the getImage() method:

public ImageIcon getImage( String strFilename )
{
      // Get an instance of our class
      Class thisClass = getClass();

      // Locate the desired image file and create a URL to it
      java.net.URL url = thisClass.getResource( "toolbarButtonGraphics/" +
                                                strFilename );

      // See if we successfully found the image
      if( url == null )
      {
         System.out.println( "Unable to load the following image: " +
                             strFilename );
         return null;
      }

      // Get a Toolkit object
      Toolkit toolkit = Toolkit.getDefaultToolkit();      
      
      // Create a new image from the image URL
      Image image = toolkit.getImage( url );

      // Build a new ImageIcon from this and return it to the caller
      return new ImageIcon( image );
}

For a complete explanation of this code, please refer back to the article: “Swing Solutions: Integrating Menus in JWord”.

JToolBar

Once we have defined a set of JButton objects, we need a container that will hold them. The JToolBar class provides such a container; as previously mentioned , the JToolBar class can be docked to one of the four sides of your JFrame, or it can float. Table 2 shows the constructors for the JToolBar class.

Table 2. JToolBar Constructors

Constructor

Description

JToolBar()

Creates a new toolbar; orientation defaults to HORIZONTAL

JToolBar(int orientation)

Creates a new toolbar with the specified orientation

JToolBar(String name)

Creates a new toolbar with the specified name

JToolBar(String name, int orientation)

Creates a new toolbar with a specified name and orientation

When creating a JToolBar, you can specify the toolbar’s orientation (either HORIZONTAL or VERTICAL) and the name of the toolbar, which is displayed when the toolbar is floating (see figure 5). The following code constructs three toolbars using the aforementioned constructors:

JToolBar toolbar = new JToolBar( “My Toolbar” );
JToolBar toolbar2 = new JToolBar( JToolBar.VERTICAL );
JToolBar toolbar3 = new JToolBar( “My Toolbar”, JToolBar.VERTICAL );

If you look closely at the JToolBar documentation—and even if you look at its source code—you may be puzzled that the orientation constants HORIZONTAL and VERTICAL are not defined. The JToolBar class implements an interface named SwingConstants, which defines a set of constants that are used by the various Swing components. By implementing this interface, the JToolBar class inherits the definitions of both VERTICAL and HORIZONTAL.

Table 3 shows some of the more commonly used JToolBar methods.

Table 3. JToolBar Methods

Method

Description

JButton add(Action a)

Adds a new JButton that dispatches the action

Component add(Component comp)

Adds the specified component to the end of this container (inherited from Container)

void addSeparator()

Appends a toolbar separator of default size to the end of the toolbar

void addSeparator(Dimension size)

Appends a toolbar separator of a specified size to the end of the toolbar

boolean isFloatable()

Returns true if the JToolBar can be dragged out by the user

void setFloatable(boolean b)

Sets whether the toolbar can be made to float

int getOrientation()

Returns the current orientation of the toolbar

void setOrientation(int o)

Sets the orientation of the toolbar

Insets getMargin()

Returns the margin between the toolbar's border and its buttons

void setMargin(Insets m)

Sets the margin between the toolbar's border and its buttons

The add() methods (table 3) show both the tradional way to add buttons (Component instances), as well as the new Java 2 SDK version 1.3 method of adding buttons (Action instances). There are two methods you may use in order to add separators between button groups named addSeparator() (see figure 1, 2, 3, 4, or 5, and look at the space between the print icon and the cut icon).

JToolBar objects can be made floatable by calling the setFloatable() method, and their floatable state can be verified by calling the isFloatable() method (by default, the JToolBar class is floatable.) The JToolBar object’s orientation can be verified and updated through the getOrientation() and setOrientation() methods. Finally, the getInsets() and setInsets() methods allow you to retrieve and specify the margins between the toolbar’s border and its buttons.

The following code demonstrates how to create a few JButton objects, a JToolBar object, and how to build the a complete toolbar:

// Create some JButton objects
JButton fileOpen = new JButton( getImage( “general/New24.gif” ) );
JButton fileSave = new JButton( getImage( “general/Save24.gif” ) );
JButton editCut = new JButton( getImage( “general/Cut24.gif” ) );
JButton editCopy = new JButton( getImage( “general/Copy24.gif” ) );

// Create the JToolBar
JToolBar toolbar = new JToolBar( “My Toolbar” );

// Add the buttons to the JToolBar
toolbar.add( fileOpen );
toolbar.add( fileSave );
toolbar.addSeparator();
toolbar.add( editCut );
toolbar.add( editCopy );

Events

A toolbar, like a menu, handles events through its elements: JButton objects. The JButton class method addActionListener() accepts a class that implements the ActionListener interface. It is prototyped as follows:

public void addActionListener(ActionListener l)

When a JButton is clicked, the ActionListener implementing class’s actionPerformed( ActionEvent e ) method will be called with an ActionEvent that refers to the JButton which generated the event. The following code segment shows a sample event handler for a JToolBar’s JButton:

public class MyClass implements ActionListener
{
   JButton button1 = new JButton( “images/myimage1.gif” );
   JButton button2 = new JButton( “images/myimage2.gif” );
   JToolBar toolbar = new JToolBar( “My Toolbar” );

   public MyClass()
   {
      // Add MyClass as an ActionListener to the JButtons
      button1.addActionListener( this );
      button2.addActionListener( this );

      // Add the buttons to the toolbar
      toolbar.add( button1 );
      toolbar.add( button2 );
   }

   /**
    * Handle the toolbar button events
    */
   public void actionPerformed(ActionEvent e)
   {
      if( e.getSource() == button1 )
      {
         System.out.println( “Button 1 Pressed” );
      }
      else if( e.getSource() == button2 )
      {
         System.out.println( “Button 2 Pressed” );
      }
   }
}

Where does the toolbar go?

We’re almost done for this installment, but one more very important thing is left for our discussion: now that you have this beautiful toolbar, what do you do with it!?

The best way to handle toolbars—actually, the only way to handle toolbars—if you want the docking functionality discussed earlier, is to create a container (usually JFrame in applications) whose layout manager is a BorderLayout and does not have any children on its four sides. The JToolBar can then be added to the container at any of the four sides by the standard content pane add() method:

public class MyClass extends JFrame implements ActionListener
{
   ...
   public MyClass()
   {
      ...
      // Set the layout manager for the JFrame’s content pane to a new BorderLayout
      getContentPane().setLayoutManager( new BorderLayout() );

      // Add the toolbar to the top (NORTH) of content pane
      getContentPane().add( toolbar, BorderLayout.NORTH );
   }
   ...
}

 

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