Gui button with calendar popup

[John Vorwald]

I have a form where the date should be entered. Right now, I enter a text format. I would like to add a calendar popup to allow selection of the date. The calendar should allow switching year since most of the dates would be from more than 6 years ago.

Can you provided suggestions on how to implement a calendar popup? Is this part of swing?

John

[Paul Clapham]

I typed "java calendar popup" into Google and got this as the first link returned: Java Swing Calendar Popup Button.

I haven't reviewed this code in any way but if you're looking for the feature (instead of a coding opportunity) I recommend you do that. It's not the only possibility I got from my web search either.

[John Vorwald]

Thanks for the suggestion, I did try a few google searches.
Here are some other good links, but haven't tried them yet:
http://www.java2s.com/Product/Java/Swing/Calendar-Date-Time.htm
http://www.java2s.com/Code/Java/Swing-Components/JavaDateChooserComboBox.htm

John

[John Jai]

Hi,

I have implemented a Calendar popup inside a Combo Box using one such resource. I don't remember the resource source. I have attached here the DateComboBox i have used.
It should be initialized like below

 JComboBox classificationDateComboBox = new DateComboBox(new SimpleDateFormat("MMM d, yyyy"));

import java.awt.*;
import java.awt.event.*;
import java.util.Calendar;
import java.text.SimpleDateFormat;

import javax.swing.*;
import javax.swing.event.PopupMenuListener;
import javax.swing.event.PopupMenuEvent;
import javax.swing.plaf.ComboBoxUI;
import javax.swing.plaf.basic.ComboPopup;
import javax.swing.plaf.metal.MetalComboBoxUI;
import javax.swing.border.Border;
import javax.swing.border.EtchedBorder;
import javax.swing.border.EmptyBorder;

import com.jgoodies.looks.plastic.PlasticComboBoxUI;
import com.sun.java.swing.plaf.motif.MotifComboBoxUI;
import com.sun.java.swing.plaf.windows.WindowsComboBoxUI;

/**
 * This class is a JComboBox Component used to select the Date from the displayed Calendar Popup 
 *
 */
@SuppressWarnings("serial")
public class DateComboBox extends JComboBox {
	
	protected SimpleDateFormat dateFormat;
	
	
	/**
	 * This is the constructor method that sets the Date Format to be displayed in the Combo Box
	 * @param dateFormat - SimpleDateFormat to display
	 */
	public DateComboBox(SimpleDateFormat dateFormat) {
		this.dateFormat = dateFormat;
		this.setSelectedItem(dateFormat.format(Calendar.getInstance().getTime()));

	}
	
	
	/**
	 * This method sets the Selected Item for the ComboBox. 
	 */
	public void setSelectedItem(Object item) {		
		removeAllItems(); 
		addItem(item);
		super.setSelectedItem(item);
	}
	
	
	/**
	 * updateUI() method overrides JComboBox updateUI() method. This method will be first called even before the 
	 * JComboBox constructor to set the UI. 
	 * PlasticComboBoxUI -> This is the ComboBoxUI used if the L&F is set to com.jgoodies.looks.plastic.PlasticXPLookAndFeel 
	 */
	public void updateUI() {
		ComboBoxUI comboBoxUI = (ComboBoxUI) UIManager.getUI(this);
		if (comboBoxUI instanceof PlasticComboBoxUI){
			comboBoxUI = new PlasticDateComboBoxUI();
		}else if (comboBoxUI instanceof MetalComboBoxUI) {
			comboBoxUI = new MetalDateComboBoxUI();
		} else if (comboBoxUI instanceof MotifComboBoxUI) {
			comboBoxUI = new MotifDateComboBoxUI();	    
		} else if (comboBoxUI instanceof WindowsComboBoxUI) {
			comboBoxUI = new WindowsDateComboBoxUI();
		}
		setUI(comboBoxUI);
	}
	
	
	/**
	 * Class to set the PlasticComboBoxUI to the DatePopUp
	 *
	 */
	class PlasticDateComboBoxUI extends PlasticComboBoxUI {
		protected ComboPopup createPopup() {
			return new DatePopup( comboBox );
		}
	}
	
	
	/**
	 * Class to set the MetalDateComboBoxUI to the DatePopUp
	 *
	 */
	class MetalDateComboBoxUI extends MetalComboBoxUI {
		protected ComboPopup createPopup() {
			return new DatePopup( comboBox );
		}
	}
	
	
	/**
	 * Class to set the WindowsDateComboBoxUI to the DatePopUp
	 *
	 */
	class WindowsDateComboBoxUI extends WindowsComboBoxUI {
		protected ComboPopup createPopup() {
			return new DatePopup( comboBox );
		}
	}
	
	
	/**
	 * Class to set the MotifDateComboBoxUI to the DatePopUp
	 *
	 */
	class MotifDateComboBoxUI extends MotifComboBoxUI {
		protected ComboPopup createPopup() {
			return new DatePopup( comboBox );
		}
	}

	
	/**
	 * This is the main Date Popup class that implements ComboPopUp & other listener interfaces	 
	 *
	 */
	class DatePopup implements ComboPopup, MouseMotionListener, MouseListener, KeyListener, PopupMenuListener {

		protected JComboBox comboBox;
		protected Calendar calendar;
		protected JPopupMenu popup;
		protected JLabel monthLabel;
		protected JPanel days = null;
		protected SimpleDateFormat monthFormat = new SimpleDateFormat("MMM yyyy");
		protected JList list = new JList();
		protected boolean mouseInside = false;

		protected Color selectedBackground;
		protected Color selectedForeground;
		protected Color background;
		protected Color foreground;
		
		/**
		 * This is the constructor method of DatePopup class
		 * @param comboBox - ComboBoxUI comboBox variable
		 */
		public DatePopup(JComboBox comboBox) {
			this.comboBox = comboBox;
			calendar = Calendar.getInstance();
			// Check Look & Feel
			background = UIManager.getColor("ComboBox.background");
			foreground = UIManager.getColor("ComboBox.foreground");
			selectedBackground = UIManager.getColor("ComboBox.selectionBackground");
			selectedForeground = UIManager.getColor("ComboBox.selectionForeground");
			// Initialize the Popup
			initializePopup();
		}
		

		/**
		 * This method is used to show the Popup. This method overrides show() in ComboPopup() interface.
		 */		
		public void show() {
			try {
				// If setSelectedItem() was called with a valid date, adjust the calendar
				calendar.setTime( dateFormat.parse( comboBox.getSelectedItem().toString() ) );
			} catch (Exception e) {}
			updatePopup(); 
			popup.show(comboBox, 0, comboBox.getHeight());
		}
		
		
		/**
		 * This method hides the Popup. This method overrides hide() in ComboPopup() interface
		 */
		public void hide() {
			popup.setVisible(false);
		}
		
		
		/**
		 * Returns the List that is being used to draw the items in the Combo Box. This method overrides getList() method in ComboPopup() interface
		 */
		public JList getList() {
			return list;
		}

		public MouseListener getMouseListener() {
			return this;
		}

		public MouseMotionListener getMouseMotionListener() {
			return this;
		}

		public KeyListener getKeyListener() {
			return this;
		}
		
		
		/**
		 * This method overrides isVisible() method in ComboPopup Interface. Returns whether Popup is visible or not.
		 */
		public boolean isVisible() {
			return popup.isVisible();
		}
		
		
		/**
		 * This method overrides unistallingUI() method in ComboPopup Interface. Used to remove listeners added to the Popup
		 */
		public void uninstallingUI() {
			popup.removePopupMenuListener(this);
		}

		
		public void mousePressed( MouseEvent e ) {}
		
		public void mouseReleased( MouseEvent e ) {}
		
		/**
		 * This method listens mouse clicked events. Used to show / hide Popup based on the mouse clicked
		 */
		public void mouseClicked(MouseEvent e) {
			if ( !SwingUtilities.isLeftMouseButton(e) )
				return;
			if ( !comboBox.isEnabled() )
				return;
			if ( comboBox.isEditable() ) {
				comboBox.getEditor().getEditorComponent().requestFocus();
			} else {
				comboBox.requestFocus();
			}
			togglePopup();
		}
		
		
		/**
		 * Invoked when mouse enters the Date ComboBox. Method overrides mouseEntered() method in MouseListener Interface
		 */
		public void mouseEntered(MouseEvent e) {
			mouseInside = true;
		}
		
		
		/**
		 * This method is called when mouse leaves the Date ComboBox. Method overrides mouseExited() method in MouseListener Interface
		 */
		public void mouseExited(MouseEvent e) {
			mouseInside = false;
		}

		// MouseMotionListener Interface Methods
		
		public void mouseDragged(MouseEvent e) {}
		public void mouseMoved(MouseEvent e) {}

		// KeyListener Interface Methods
		
		public void keyPressed(KeyEvent e) {}
		public void keyTyped(KeyEvent e) {}
		
		
		/**
		 * This method will be invoked when a Key is Released when DateComboBox is in focus. It shows the Popup when "Space" or "Enter" is stroked
		 */
		public void keyReleased( KeyEvent e ) {
			if ( e.getKeyCode() == KeyEvent.VK_SPACE ||
					e.getKeyCode() == KeyEvent.VK_ENTER ) {
				togglePopup();
			}
		}
					
		
		// PopupMenuListener Interface Methods
		public void popupMenuCanceled(PopupMenuEvent e) {}
		
		/**
		 * Variables hideNext and mouseInside are used to 
		 * hide the popupMenu by clicking the mouse in the JComboBox
		 */
		
		protected boolean hideNext = false;
		
		/**
		 * This method overrides popupMenuWillBecomeInvisible() in PopupMenuLister Interface. It is invoked before the Popup menu becomes invisible
		 */
		public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {
			hideNext = mouseInside;
		}
		public void popupMenuWillBecomeVisible(PopupMenuEvent e) {}
	
		
		/**
		 * This method toggles the Popup (shows & hides the Popup)
		 */
		protected void togglePopup() {
			if ( isVisible() || hideNext ) { 
				hide();
			} else {
				show();
			}
			hideNext = false;
		}
		
		
		/**
		 * This method is used to created Labels to be shown on the Popup (like << , >> , < , > )
		 * @param field - Tells whether to add/subtract Month or Year when clicked.
		 * @param amount - Tells the amount to add/subtract from the Month or Year (+1 & -1)
		 * @return - Returns the Label Created 
		 */
		protected JLabel createUpdateButton(final int field, final int amount) {
			final JLabel label = new JLabel();
			final Border selectedBorder = new EtchedBorder();
			final Border unselectedBorder = new EmptyBorder(selectedBorder.getBorderInsets(new JLabel()));
			label.setBorder(unselectedBorder);
			label.setForeground(foreground);
			label.addMouseListener(new MouseAdapter() {
				public void mouseReleased(MouseEvent e) {
					calendar.add(field, amount);
					updatePopup();
				}
				public void mouseEntered(MouseEvent e) {
					label.setBorder(selectedBorder);
				}
				public void mouseExited(MouseEvent e) {
					label.setBorder(unselectedBorder);
				}
			});
			return label;
		}

		
		/**
		 * This method initializes the Popup Swings Components
		 */
		protected void initializePopup() {
			JPanel header = new JPanel(); // used Box, but it wasn't Opaque
			header.setLayout(new BoxLayout(header, BoxLayout.X_AXIS));
			header.setBackground(background);
			header.setOpaque(true);

			JLabel label;
			label = createUpdateButton(Calendar.YEAR, -1);
			label.setText("<<");
			label.setToolTipText("Previous Year");

			header.add(Box.createHorizontalStrut(12));
			header.add(label);
			header.add(Box.createHorizontalStrut(12));

			label = createUpdateButton(Calendar.MONTH, -1);
			label.setText("<");
			label.setToolTipText("Previous Month");
			header.add(label);

			monthLabel = new JLabel("", JLabel.CENTER);
			monthLabel.setForeground(foreground);
			header.add(Box.createHorizontalGlue());
			header.add(monthLabel);
			header.add(Box.createHorizontalGlue());

			label = createUpdateButton(Calendar.MONTH, 1);
			label.setText(">");
			label.setToolTipText("Next Month");
			header.add(label);

			label = createUpdateButton(Calendar.YEAR, 1);
			label.setText(">>");
			label.setToolTipText("Next Year");

			header.add(Box.createHorizontalStrut(12));
			header.add(label);
			header.add(Box.createHorizontalStrut(12));

			popup = new JPopupMenu();
			popup.setBorder(BorderFactory.createLineBorder(Color.black));
			popup.setLayout(new BorderLayout());
			popup.setBackground(background);
			popup.addPopupMenuListener(this);
			popup.add(BorderLayout.NORTH, header);
		}
		
		
		/**
		 * This method updates the Popup when user changes the Month / Year in the Popup.
		 * It also sets the Day selected by the User as the ComboBox value.
		 */
		protected void updatePopup() {
			monthLabel.setText( monthFormat.format(calendar.getTime()) );
			if (days != null) {
				popup.remove(days);
			}
			days = new JPanel(new GridLayout(0, 7));
			days.setBackground(background);
			days.setOpaque(true);

			Calendar setupCalendar = (Calendar) calendar.clone();
			setupCalendar.set(Calendar.DAY_OF_WEEK, setupCalendar.getFirstDayOfWeek());
			for (int i = 0; i < 7; i++) {
				int dayInt = setupCalendar.get(Calendar.DAY_OF_WEEK);
				JLabel label = new JLabel();
				label.setHorizontalAlignment(JLabel.CENTER);
				label.setForeground(foreground);
				if (dayInt == Calendar.SUNDAY) {
					label.setText("Sun");
				} else if (dayInt == Calendar.MONDAY) {
					label.setText("Mon");
				} else if (dayInt == Calendar.TUESDAY) {
					label.setText("Tue");
				} else if (dayInt == Calendar.WEDNESDAY) {
					label.setText("Wed");
				} else if (dayInt == Calendar.THURSDAY) {
					label.setText("Thu");
				} else if (dayInt == Calendar.FRIDAY) {
					label.setText("Fri");
				} else if (dayInt == Calendar.SATURDAY){
					label.setText("Sat");
				}
				days.add(label);
				setupCalendar.roll(Calendar.DAY_OF_WEEK, true);
			}

			setupCalendar = (Calendar) calendar.clone();
			setupCalendar.set(Calendar.DAY_OF_MONTH, 1);
			int first = setupCalendar.get(Calendar.DAY_OF_WEEK);
			for (int i = 0; i < (first - 1); i++) {
				days.add(new JLabel(""));		
			}
			for (int i = 1; i <= setupCalendar.getActualMaximum(Calendar.DAY_OF_MONTH); i++) {    
				final int day = i;
				final JLabel label = new JLabel(String.valueOf(day));				
				label.setHorizontalAlignment(JLabel.CENTER);
				label.setForeground(foreground);
				if(day == Calendar.getInstance().get(Calendar.DAY_OF_MONTH)){
					label.setOpaque(true);
					label.setBackground(selectedBackground);
					label.setForeground(selectedForeground);
				}
				label.addMouseListener(new MouseListener() {
					public void mousePressed(MouseEvent e) {}
					public void mouseClicked(MouseEvent e) {}
					public void mouseReleased(MouseEvent e) {
						label.setOpaque(false);
						label.setBackground(background);
						label.setForeground(foreground);
						calendar.set(Calendar.DAY_OF_MONTH, day);
						comboBox.setSelectedItem(dateFormat.format(calendar.getTime()));
						hide();
						// hide is called with setSelectedItem() ... removeAll()
						//comboBox.requestFocus(); // Call this if you want the Popup to stay after a date selection
					}
					public void mouseEntered(MouseEvent e) {
						label.setOpaque(true);
						label.setBackground(selectedBackground);
						label.setForeground(selectedForeground);
					}
					public void mouseExited(MouseEvent e) {
						label.setOpaque(false);
						label.setBackground(background);
						label.setForeground(foreground);
					}
				});

				days.add(label);
			}

			popup.add(BorderLayout.CENTER, days);
			popup.pack();	    
		}
	}

	
	/**
	 * Main method for testing purposes
	 * @param args
	 * @throws Exception
	 */
	public static void main(String args[])throws Exception {
		JFrame f = new JFrame();
		Container c = f.getContentPane();
		c.setLayout(new FlowLayout());
		c.add(new JLabel("Date 1:"));
		c.add(new DateComboBox(new SimpleDateFormat("MMM d, yyyy")));
		System.out.println("New date1 combobox created");
		c.add(new JLabel("Date 2:"));
		DateComboBox dcb = new DateComboBox(new SimpleDateFormat("MMM d, yyyy"));
		System.out.println("New date2 combobox created");
		dcb.setEditable(true);
		c.add(dcb);
		f.addWindowListener(new WindowAdapter() {
			public void windowClosing(WindowEvent e) {
				System.exit(0);
			}
		});
		f.setSize(500, 200);
		f.setVisible(true);
	}

}

[John Vorwald]

Thanks, that works fine...

John