Download JFormattedText Field with Date

Personal webpage of Aminur Rashid
JFormattedText Field with Date
Contributed by Aminur Rashid
Wednesday, 25 March 2009
Last Updated Wednesday, 05 June 2013
While trying JFormattedTextField, I had this requirement to show placeholder to the user to guide him while providing the
date input. There was also a need to pop up user with the error message, if the input was incorrect. (Yeah, I understand
that many prefer inline error messages than the pop-ups but then requirements are requirements.)
One way could be to provide a MaskFormat to the JFormattedTextField and use directly validates the date, yourself
using the pattern.
What I tried is used both the DateFormat and MastFormat with the JFormattedTextField. The code can be modified for
individual needs but the idea is to provide an input verifier to the JFormattedTextField. Use the formatter set for
JFormattedTextField to verify the inputs. Along with these, also install a mask formatter to show placeholders to user.
Code to create a JFormattedTextField to verify dateinputs:
package com.aminur.swing;
import java.awt.event.FocusAdapter;
import java.awt.event.FocusEvent;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import javax.swing.InputVerifier;
import javax.swing.JComponent;
import javax.swing.JFormattedTextField;
import javax.swing.JOptionPane;
import javax.swing.text.DateFormatter;
import javax.swing.text.MaskFormatter;
/*
* @author Aminur Rashid (aminur ^ aminurrashid.com)
*
* Usage
* DateFormattedTextFieldVerifier.getFormattedTextField("dd/MM/yyyy",true,true,
*
"##/##/####","__/__/____",new Character('_'))
* or in case you do not want to use mask
* DateFormattedTextFieldVerifier.getFormattedTextField("dd/mm/yyyy", true,false,null,null,null)
* DateFormattedTextFieldVerifier.getFormattedTextField("dd/mm/yyyy");
*/
public class DateFormattedTextFieldVerifier
{
private String mask = null; // e.g "##/##/####";
private SimpleDateFormat format;
private DateFormatter df;
protected String datePattern; // = "dd/MM/yyyy";
private String placeholder; // e.g "__/__/____";
private char placeholderChar; //e.g '_'
private DateVerifier objDateVerifier;
private JFormattedTextField dateTextField;
private String patternString;
http://aminurrashid.com
Powered by Joomla!
Generated: 23 October, 2016, 18:19
Personal webpage of Aminur Rashid
public static JFormattedTextField getFormattedTextField(String pattern)
{
return (DateFormattedTextFieldVerifier.getFormattedTextField(pattern, true, false, null, null,
null));
}
/**
* @param pattern
* @param showPopUp
* @return
*/
public static JFormattedTextField getFormattedTextField(String pattern, boolean showPopUp,
boolean installMask, String mask,
String maskPlaceholder,
Character placeholder)
{
DateFormattedTextFieldVerifier thisClass =
new DateFormattedTextFieldVerifier(pattern, showPopUp, installMask, mask, maskPlaceholder,
placeholder);
return thisClass.dateTextField;
}
/*******************************************
* Private methods
******************************************/
private DateFormattedTextFieldVerifier(String pattern, boolean showErrorPopUp,
boolean installMask, String mask, String maskPlaceholder,
Character placeholderChar)
{
patternString = pattern;
format = new SimpleDateFormat(pattern);
df = new DateFormatter(format)
{
public Object stringToValue(String string)
throws ParseException
{
if (string == null || string.length() == 0 || string.equals(placeholder))
{
return null;
}
return super.stringToValue(string);
}
};
/**
* Change this as per your requirement.
* See docs on setLeient
* http://docs.oracle.com/javase/1.5.0/docs/api/java/text/DateFormat.html#setLenient(boolean)
*/
format.setLenient(false);
dateTextField = new JFormattedTextField(df);
if (installMask)
{
placeholder = maskPlaceholder;
this.mask = mask;
this.placeholderChar = placeholderChar.charValue();
installMask(dateTextField);
dateTextField.setFocusLostBehavior(JFormattedTextField.PERSIST);
dateTextField.addFocusListener(new FocusAdapter()
{
public void focusGained(FocusEvent e)
{
installMask(dateTextField);
}
http://aminurrashid.com
Powered by Joomla!
Generated: 23 October, 2016, 18:19
Personal webpage of Aminur Rashid
});
}
objDateVerifier = new DateVerifier(format, placeholder, showErrorPopUp, installMask);
dateTextField.setInputVerifier(objDateVerifier);
}
private void installMask(JFormattedTextField tfObject)
{
MaskFormatter objMask = new MaskFormatter()
{
public void install(JFormattedTextField ftf)
{
String currentText = ftf.getText();
super.install(ftf);
if (ftf != null) /*&& !ftf.isEditValid()*/
{
if (currentText != null && currentText.length() > 0)
{
ftf.setText(currentText);
}
}
}
public String valueToString(Object obj)
throws ParseException
{
if (obj instanceof Date)
{
return (format.format((Date) obj));
}
return super.valueToString(obj);
}
};
try
{
objMask.setMask(mask);
objMask.setAllowsInvalid(true);
objMask.setPlaceholderCharacter(placeholderChar);
objMask.install(tfObject);
}
catch (Exception pe)
{
//change to use logger
System.out.println("Exception " + pe);
}
}
class DateVerifier
extends InputVerifier
{
private DateFormat dateFormat = null;
private boolean isPopupErrorEnable = true;
private String formatPlaceholder = null;
private boolean useMask;
DateVerifier(DateFormat df, String fPlaceholder, boolean isPopupErrorEnable, boolean useMask)
{
this.dateFormat = df;
this.isPopupErrorEnable = isPopupErrorEnable;
this.useMask = useMask;
http://aminurrashid.com
Powered by Joomla!
Generated: 23 October, 2016, 18:19
Personal webpage of Aminur Rashid
formatPlaceholder = fPlaceholder;
}
private boolean isDateValid(String p_Date)
throws ParseException
{
try
{
dateFormat.parse(p_Date);
return true;
}
catch (ParseException dfe)
{
throw dfe;
}
}
public boolean verify(JComponent input)
{
try
{
if (input instanceof JFormattedTextField)
{
JFormattedTextField jtf = (JFormattedTextField) input;
String currentValue = jtf.getText();
if (currentValue == null || currentValue.equalsIgnoreCase(formatPlaceholder) ||
currentValue.length() == 0)
{
jtf.setValue(null);
jtf.commitEdit();
//uncomment if you want to see placeholder when not in focus as well
/*if(useMask)
installMask(jtf);*/
return true;
}
try
{
isDateValid(jtf.getText());
jtf.commitEdit();
return true;
}
catch (Exception e)
{
if (isPopupErrorEnable)
{
JOptionPane.showMessageDialog(jtf.getParent(),
e.getMessage() + "\n Please specify date as " +
patternString, "Date Error..",
JOptionPane.ERROR_MESSAGE);
}
jtf.selectAll();
return false;
}
}
}
catch (Exception ex)
{
//change to proper logging
ex.printStackTrace();
return false;
}
return true;
}
http://aminurrashid.com
Powered by Joomla!
Generated: 23 October, 2016, 18:19
Personal webpage of Aminur Rashid
}
}
Edited : 06 June 2013: On request from a blog reader, below is a sample Java Panel client to demonstrate the usage.
package client;
import com.aminur.swing.DateFormattedTextFieldVerifier;
import java.awt.Dimension;
import java.awt.event.ActionEvent;
import javax.swing.JButton;
import javax.swing.JFormattedTextField;
import javax.swing.JFrame;
import javax.swing.JPanel;
/**
*
* @author aminur ^ aminurrashid.com
*/
public class TestPanel
extends JPanel
{
private JButton testButton;
private JFormattedTextField form_date;
/** Creates new form TestPanel */
public TestPanel()
{
initPanelComponents();
}
/** This method is called from within the constructor to
* initialize the form.
*/
@SuppressWarnings("unchecked")
private void initPanelComponents()
{
testButton = new JButton();
form_date = DateFormattedTextFieldVerifier.getFormattedTextField("dd/MM/yyyy", // pattern
true, // Show error pop up
true, // Install mask
"##/##/####", // mask
"__/__/____", // placeholder
'_');
testButton.setText("Test");
form_date.setPreferredSize(new Dimension(200,25));
testButton.addActionListener(new java.awt.event.ActionListener()
{
public void actionPerformed(java.awt.event.ActionEvent evt)
{
testButtonActionPerformed(evt);
}
});
add(form_date);
add(testButton);
}
http://aminurrashid.com
Powered by Joomla!
Generated: 23 October, 2016, 18:19
Personal webpage of Aminur Rashid
private void testButtonActionPerformed(ActionEvent evt)
{
//just placeholder to tab out from textfield.
}
public static void main(String[] args)
{
JFrame f = new JFrame("JFormatted Input Verifier demo");
f.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
f.setSize(800, 600);
TestPanel testPanel = new TestPanel();
f.add(testPanel);
f.setVisible(true);
}
}
http://aminurrashid.com
Powered by Joomla!
Generated: 23 October, 2016, 18:19