Home > Articles > Programming > Java

Like this article? We recommend

Like this article? We recommend

Date Picker and Month View

Some applications include calendars as part of their GUIs. These calendars reveal dates in an intuitive manner. They flag scheduled appointments, holidays, and any other kinds of dates important to the user. Calendars also let the user select a range of dates for appointments, and present an appointment book that lets the user enter new appointments or view existing appointments for these dates.

SwingX’s date picker and month view components support calendars:

  • The date picker, represented by the org.jdesktop.swingx.JXDatePicker class, consists of an editable text field, a button, a month view, and a link panel. The user enters a date in the text field, or clicks the button and selects a date from the month view (which then appears in the text field). The default link panel presents a date as a hyperlink. It can be replaced—your own appointment book panel?
  • The month view, represented by the org.jdesktop.swingx.calendar.JXMonthView class, presents one or more months in the traditional calendar format. It allows the user to select a range of dates. By default, the month view presents the current month and year, and recognizes java.util.Calendar.SUNDAY as the first day of the week.

To create date pickers, call the public JXDatePicker() and public JXDatePicker(long millis) constructors. The first constructor uses the current date and the second constructor uses the specified millis date as the initially selected date. Both constructors obtain the formats for entering dates in the editable text field via org.jdesktop.swingx.calendar.JXDatePickerFormatterFactory:

// Create date picker with current date initially selected.

JXDatePicker datePicker = new JXDatePicker ();

// Create date picker with specified date initially selected.

Calendar cal = Calendar.getInstance ();
cal.set (2006, 7, 1); // August 1, 2006
long millis = cal.getTimeInMillis ();
JXDatePicker datePicker = new JXDatePicker (millis);

After creating a date picker, you can call its public void addActionListener(ActionListener l) method to register an action listener that’s notified whenever the user enters or selects a date. You might set an appointment book link panel to the date’s appointments, for example. You can also call the public void removeActionListener(ActionListener l) method to remove the action listener.

You might find occasion to share the same listener among multiple date pickers. To identify these date pickers uniquely, call public void setActionCommand(String cmd) with some appropriate identification string for each date picker. Call the public String getActionCommand() method to return this identification string.

I’ve created a DPMVDemo1 application that demonstrates the date picker component. In addition to calling JXDatePicker() to create the date picker, this application registers an action listener that calls JXDatePicker’s public Date getDate() method to obtain the selected date, which outputs to the console. Figure 1 shows the date picker as part of DPMVDemo1’s GUI.

Figure 1

Figure 1 The link panel appears below the date picker’s month view component. (Instead of an arrow pointer, a hand pointer—which I was unable to capture—appears.)

The GUI in Figure 1 shows the date picker’s editable text field and button, which presents the month view of the editable text field’s date and the link panel when the button is clicked. The month view identifies the initially selected date with a rectangle and a colored background. Select any date by clicking an arrow and/or a day, but only one date can be selected. The link panel presents the initially selected date.

The GUI also includes a combo box that lists supported formats for entering a date in the editable text field. For example, EEE MM/dd/yyyy recognizes a weekday (long or short, such as Tuesday or Tue), a month (long, short, or two digits, such as July, Jul, or 07), a forward slash, a two-digit day, a forward slash, and a four-digit year. The most recently selected date replaces any invalid date entered in the editable text field.

Listing 1 presents the source code for DPMVDemo1.

Listing 1 DPMVDemo1.java.

// DPMVDemo1.java

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

import java.text.*;

import javax.swing.*;

import org.jdesktop.swingx.JXDatePicker;

public class DPMVDemo1
{
 public static void main (String [] args)
 {
  // Establish a look and feel for this application’s GUI.

  setLookAndFeel ();

  // Create a frame window whose GUI presents the date picker and provides
  // a list of supported date formats.

  final JFrame frame = new JFrame ("Date Picker Month View Demo #1");
  frame.getContentPane ().setLayout (new GridLayout (2, 1));

  // Tell application to automatically exit when the user selects the Close
  // menu item from the frame window’s system menu.

  frame.setDefaultCloseOperation (JFrame.EXIT_ON_CLOSE);

  // Create GUI: date picker at the top and a combo box of date formats --
  // that the date picker supports for entering dates via the editor -- at
  // the bottom.

  JPanel panel = new JPanel ();
  panel.add (new JLabel ("Enter date (if desired) and click button"));
  final JXDatePicker datePicker;
  datePicker = new JXDatePicker ();
  ActionListener al = new ActionListener ()
       {
        public void actionPerformed (ActionEvent e)
        {
         System.out.println (datePicker.getDate ());
        }
       };
  datePicker.addActionListener (al);
  panel.add (datePicker);
  frame.getContentPane ().add (panel);

  panel = new JPanel ();
  panel.setLayout (new FlowLayout (FlowLayout.LEFT));
  panel.add (new JLabel ("Supported date formats"));
  DateFormat [] dfs = datePicker.getFormats ();
  String [] fmts = new String [dfs.length];
  for (int i = 0; i < dfs.length; i++)
   fmts [i] = (dfs [i] instanceof SimpleDateFormat)
      ? ((SimpleDateFormat) dfs [i]).toPattern ()
      : dfs [i].toString ();
  panel.add (new JComboBox (fmts));
  frame.getContentPane ().add (panel);

  // Size frame window to fit the preferred size and layouts of its
  // components.

  frame.pack ();

  // Display GUI and start the AWT’s event-dispatching thread.

  frame.setVisible (true);
 }

 static void setLookAndFeel ()
 {
  try
  {
   // Return the name of the LookAndFeel class that implements the
   // native OS look and feel. If there is no such look and feel, return
   // the name of the default cross platform LookAndFeel class.

   String slafcn = UIManager.getSystemLookAndFeelClassName ();

   // Set the current look and feel to the look and feel identified by
   // the LookAndFeel class name.

   UIManager.setLookAndFeel (slafcn);
  }
  catch(Exception e)
  {
  }
 }
}

After playing with DPMVDemo1, you might want to customize this application. I can think of two items that merit customization:

  • Formats list. JXDatePicker provides a way to change the list of supported formats for entering dates in the editable text field. Call public void setFormats(String[] formats) or public void setFormats(DateFormat[] formats) to change this list. You can also return the current list by calling public DateFormat[] getFormats().
  • Link panel. The default link panel presents the initially selected date as a hyperlink. Nothing happens if you click this hyperlink. If you want to accomplish something useful, try replacing the current link panel with a new panel via the public void setLinkPanel(JPanel linkPanel) method. You can also call public JPanel getLinkPanel() to return the current link panel.

You can interact with the month view component from within the date picker. Accomplish this task by calling JXDatePicker’s public void setMonthView(JXMonthView monthView) and public JXMonthView getMonthView() methods. Or you can ignore JXDatePicker and work directly with JXMonthView, and avoid the date picker’s extra components.

If you decide to work directly with JXMonthView, call public JXMonthView() to create a month view based on the month and year of the current date. Alternatively, call public JXMonthView(long millis) to create a month view based on the month and year of the millis argument’s date.

As with date picker, you can call JXMonthView’s public void addActionListener(ActionListener l) method to register an action listener that is notified whenever the user makes a selection. You can also call the public void removeActionListener(ActionListener l) method to remove the action listener.

You might find occasion to share the same listener among multiple month views. To identify these month views uniquely, call public void setActionCommand(String cmd) with some appropriate identification string for each month view. Call the public String getActionCommand() method to return this identification string.

JXMonthView provides methods to customize this component. For example, JXMonthView’s public void setFlaggedDates(long[] flaggedDates) method can be called to flag (highlight) various dates, perhaps to indicate holidays or appointments. Unfortunately, a bug prevents this method from working in the SwingX 0.8.0 release.

In contrast, JXMonthView’s public void setSelectionMode(int mode) method has no bugs. Call this method with the appropriate constant to change a month view’s selection mode from single selection (the default) to no selection (component is read-only), multiple selection (select an arbitrary range of consecutive dates by dragging the mouse), and week selection (like multiple selection, but in terms of weeks).

I’ve created a DPMVDemo2 application that demonstrates the month view component. In addition to calling JXMonthView() to create the month view, this application calls public void setPreferredCols(int cols) and public void setPreferredRows(int rows) to display a grid of months, and setSelectionMode() to set the selection mode to multiple selection.

DPMVDemo2 also registers an action listener that calls JXMonthView’s public DateSpan getSelectedDateSpan() method to return a multiple selection’s range of consecutive selected dates in an org.jdesktop.swingx.calendar.DateSpan object, calls DateSpan methods to obtain the start and end dates in this selection, and outputs these dates. Figure 2 shows the GUI.

Figure 2

Figure 2 The month view component can display a grid of months, and supports various selection modes.

Figure 2 shows a four-month grid and a multiple selection. It also shows that when you call the JXMonthView() constructor, the day portion of the current date is highlighted with a rectangle. This rectangle is displayed even when you select some other date range. In contrast, it doesn’t appear when you call the JXMonthView(long millis) constructor.

Listing 2 presents the source code for DPMVDemo2.

Listing 2 DPMVDemo2.java.

// DPMVDemo2.java

import java.awt.event.*;

import javax.swing.*;

import org.jdesktop.swingx.calendar.*;

public class DPMVDemo2
{
 public static void main (String [] args)
 {
  // Establish a look and feel for this application’s GUI.

  setLookAndFeel ();

  // Create a frame window whose GUI presents the month view component.

  final JFrame frame = new JFrame ("Date Picker Month View Demo #2");

  // Tell application to automatically exit when the user selects the Close
  // menu item from the frame window’s system menu.

  frame.setDefaultCloseOperation (JFrame.EXIT_ON_CLOSE);

  // Install a month view component that presents four months (where the
  // first month contains the current date), in a 2-by-2 grid, allows
  // multiple consecutive days to be selected, and invokes an action
  // listener at the end of the selection.

  final JXMonthView monthView = new JXMonthView ();
  monthView.setPreferredCols (2);
  monthView.setPreferredRows (2);
  monthView.setSelectionMode (JXMonthView.MULTIPLE_SELECTION);
  ActionListener al;
  al = new ActionListener ()
   {
    public void actionPerformed (ActionEvent e)
    {
     DateSpan ds = monthView.getSelectedDateSpan ();

     System.out.println ("First selected date = " +
          ds.getStartAsDate ());

     System.out.println ("Last selected date = " +
          ds.getEndAsDate ());
    }
   };
  monthView.addActionListener (al);

  frame.getContentPane ().add (monthView);

  // Size frame window to fit the preferred size and layouts of its
  // components.

  frame.pack ();

  // Display GUI and start the AWT’s event-dispatching thread.

  frame.setVisible (true);
 }

 static void setLookAndFeel ()
 {
  try
  {
   // Return the name of the LookAndFeel class that implements the
   // native OS look and feel. If there is no such look and feel, return
   // the name of the default cross platform LookAndFeel class.

   String slafcn = UIManager.getSystemLookAndFeelClassName ();

   // Set the current look and feel to the look and feel identified by
   // the LookAndFeel class name.

   UIManager.setLookAndFeel (slafcn);
  }
  catch(Exception e)
  {
  }
 }
}

Earlier, I presented the DPMVDemo1 application. For homework, modify this application to output a message when the default link panel’s hyperlink is clicked. Keep in mind that JXDatePicker’s getLinkPanel() method returns a reference to the current link panel, and the default link panel contains a single instance of JXHyperlink—a class that I explore in the following section.

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