How to mask an EditText to show the dd/mm/yyyy date format
AndroidAndroid EdittextMaskTextwatcherAndroid Problem Overview
How can I format an EditText to follow the "dd/mm/yyyy" format the same way that we can format using a TextWatcher to mask the user input to look like "0.05€". I'm not talking about limiting the characters, or validating a date, just masking to the previous format.
Android Solutions
Solution 1 - Android
I wrote this TextWatcher for a project, hopefully it will be helpful to someone. Note that it does not validate the date entered by the user, and you should handle that when the focus changes, since the user may not have finished entering the date.
Update 25/06 Made it a wiki to see if we reach a better final code.
Update 07/06 I finally added some sort of validation to the watcher itself. It will do the following with invalid dates:
- If the month is greater than 12, it will be 12 (December)
- If the date is greater than the one for the month selected, make it the max for that month.
- If the year is not in the range
1900-2100, change it to be in the range
This validation fits my needs, but some of you may want to change it a little bit, ranges are easily changeable and you could hook this validations to Toast message for instance, to notify the user that we've modified his/her date since it was invalid.
In this code, I will be assuming that we have a reference to our EditText called date that has this TextWatcher attached to it, this can be done something like this:
EditText date;
date = (EditText)findViewById(R.id.whichdate);
date.addTextChangedListener(tw);
TextWatcher tw = new TextWatcher() {
private String current = "";
private String ddmmyyyy = "DDMMYYYY";
private Calendar cal = Calendar.getInstance();
When user changes text of the EditText
@Override
public void onTextChanged(CharSequence s, int start, int before, int count) {
if (!s.toString().equals(current)) {
String clean = s.toString().replaceAll("[^\\d.]|\\.", "");
String cleanC = current.replaceAll("[^\\d.]|\\.", "");
int cl = clean.length();
int sel = cl;
for (int i = 2; i <= cl && i < 6; i += 2) {
sel++;
}
//Fix for pressing delete next to a forward slash
if (clean.equals(cleanC)) sel--;
if (clean.length() < 8){
clean = clean + ddmmyyyy.substring(clean.length());
}else{
//This part makes sure that when we finish entering numbers
//the date is correct, fixing it otherwise
int day = Integer.parseInt(clean.substring(0,2));
int mon = Integer.parseInt(clean.substring(2,4));
int year = Integer.parseInt(clean.substring(4,8));
mon = mon < 1 ? 1 : mon > 12 ? 12 : mon;
cal.set(Calendar.MONTH, mon-1);
year = (year<1900)?1900:(year>2100)?2100:year;
cal.set(Calendar.YEAR, year);
// ^ first set year for the line below to work correctly
//with leap years - otherwise, date e.g. 29/02/2012
//would be automatically corrected to 28/02/2012
day = (day > cal.getActualMaximum(Calendar.DATE))? cal.getActualMaximum(Calendar.DATE):day;
clean = String.format("%02d%02d%02d",day, mon, year);
}
clean = String.format("%s/%s/%s", clean.substring(0, 2),
clean.substring(2, 4),
clean.substring(4, 8));
sel = sel < 0 ? 0 : sel;
current = clean;
date.setText(current);
date.setSelection(sel < current.length() ? sel : current.length());
}
}
We also implement the other two functions because we have to
@Override
public void beforeTextChanged(CharSequence s, int start, int count, int after) {}
@Override
public void afterTextChanged(Editable s) {}
};
This produces the following effect, where deleting or inserting characters will reveal or hide the dd/mm/yyyy mask. It should be easy to modify to fit other format masks since I tried to leave the code as simple as possible.
Solution 2 - Android
The current answer is very good and helped guide me towards my own solution. There are a few reasons why I decided to post my own solution even though this question already has a valid answer:
- I´m working in Kotlin, not Java. People who find themselves with the same issue will have to translate the current solution.
- I wanted to write an answer that was more legible so that people can more easily adapt it to their own problems.
- As suggested by dengue8830, I encapsulated the solution to this problem in a class, so anyone can use without even worrying about the implementation.
To use it, just do something like:
- DateInputMask(mEditText).listen()
And the solution is shown below:
class DateInputMask(val input : EditText) {
fun listen() {
input.addTextChangedListener(mDateEntryWatcher)
}
private val mDateEntryWatcher = object : TextWatcher {
var edited = false
val dividerCharacter = "/"
override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
if (edited) {
edited = false
return
}
var working = getEditText()
working = manageDateDivider(working, 2, start, before)
working = manageDateDivider(working, 5, start, before)
edited = true
input.setText(working)
input.setSelection(input.text.length)
}
private fun manageDateDivider(working: String, position : Int, start: Int, before: Int) : String{
if (working.length == position) {
return if (before <= position && start < position)
working + dividerCharacter
else
working.dropLast(1)
}
return working
}
private fun getEditText() : String {
return if (input.text.length >= 10)
input.text.toString().substring(0,10)
else
input.text.toString()
}
override fun afterTextChanged(s: Editable) {}
override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {}
}
}
Solution 3 - Android
a cleaner way to use the Juan Cortés's code is put it in a class:
public class DateInputMask implements TextWatcher {
private String current = "";
private String ddmmyyyy = "DDMMYYYY";
private Calendar cal = Calendar.getInstance();
private EditText input;
public DateInputMask(EditText input) {
this.input = input;
this.input.addTextChangedListener(this);
}
@Override
public void beforeTextChanged(CharSequence s, int start, int count, int after) {
}
@Override
public void onTextChanged(CharSequence s, int start, int before, int count) {
if (s.toString().equals(current)) {
return;
}
String clean = s.toString().replaceAll("[^\\d.]|\\.", "");
String cleanC = current.replaceAll("[^\\d.]|\\.", "");
int cl = clean.length();
int sel = cl;
for (int i = 2; i <= cl && i < 6; i += 2) {
sel++;
}
//Fix for pressing delete next to a forward slash
if (clean.equals(cleanC)) sel--;
if (clean.length() < 8){
clean = clean + ddmmyyyy.substring(clean.length());
}else{
//This part makes sure that when we finish entering numbers
//the date is correct, fixing it otherwise
int day = Integer.parseInt(clean.substring(0,2));
int mon = Integer.parseInt(clean.substring(2,4));
int year = Integer.parseInt(clean.substring(4,8));
mon = mon < 1 ? 1 : mon > 12 ? 12 : mon;
cal.set(Calendar.MONTH, mon-1);
year = (year<1900)?1900:(year>2100)?2100:year;
cal.set(Calendar.YEAR, year);
// ^ first set year for the line below to work correctly
//with leap years - otherwise, date e.g. 29/02/2012
//would be automatically corrected to 28/02/2012
day = (day > cal.getActualMaximum(Calendar.DATE))? cal.getActualMaximum(Calendar.DATE):day;
clean = String.format("%02d%02d%02d",day, mon, year);
}
clean = String.format("%s/%s/%s", clean.substring(0, 2),
clean.substring(2, 4),
clean.substring(4, 8));
sel = sel < 0 ? 0 : sel;
current = clean;
input.setText(current);
input.setSelection(sel < current.length() ? sel : current.length());
}
@Override
public void afterTextChanged(Editable s) {
}
}
then you can reuse it
new DateInputMask(myEditTextInstance);
Solution 4 - Android
Try using a library that solves this problem since masking it's not available out of the box. There are a lot of corner cases (like adding/deleting characters in the middle of already masked text) and to properly handle this you'll end up with a lot of code (and bugs).
Here are some available libraries:
https://github.com/egslava/edittext-mask
https://github.com/dimitar-zabaznoski/MaskedEditText
https://github.com/pinball83/Masked-Edittext
https://github.com/RedMadRobot/input-mask-android
https://github.com/santalu/mask-edittext
** Mind that at the time of writing these libraries are not without issues, so it's your responsibility to choose which one fits you best and test the code.
Solution 5 - Android
Juan Cortés' wiki works like a charm https://stackoverflow.com/a/16889503/3480740
Here my Kotlin version
fun setBirthdayEditText() {
birthdayEditText.addTextChangedListener(object : TextWatcher {
private var current = ""
private val ddmmyyyy = "DDMMYYYY"
private val cal = Calendar.getInstance()
override fun onTextChanged(p0: CharSequence?, p1: Int, p2: Int, p3: Int) {
if (p0.toString() != current) {
var clean = p0.toString().replace("[^\\d.]|\\.".toRegex(), "")
val cleanC = current.replace("[^\\d.]|\\.", "")
val cl = clean.length
var sel = cl
var i = 2
while (i <= cl && i < 6) {
sel++
i += 2
}
//Fix for pressing delete next to a forward slash
if (clean == cleanC) sel--
if (clean.length < 8) {
clean = clean + ddmmyyyy.substring(clean.length)
} else {
//This part makes sure that when we finish entering numbers
//the date is correct, fixing it otherwise
var day = Integer.parseInt(clean.substring(0, 2))
var mon = Integer.parseInt(clean.substring(2, 4))
var year = Integer.parseInt(clean.substring(4, 8))
mon = if (mon < 1) 1 else if (mon > 12) 12 else mon
cal.set(Calendar.MONTH, mon - 1)
year = if (year < 1900) 1900 else if (year > 2100) 2100 else year
cal.set(Calendar.YEAR, year)
// ^ first set year for the line below to work correctly
//with leap years - otherwise, date e.g. 29/02/2012
//would be automatically corrected to 28/02/2012
day = if (day > cal.getActualMaximum(Calendar.DATE)) cal.getActualMaximum(Calendar.DATE) else day
clean = String.format("%02d%02d%02d", day, mon, year)
}
clean = String.format("%s/%s/%s", clean.substring(0, 2),
clean.substring(2, 4),
clean.substring(4, 8))
sel = if (sel < 0) 0 else sel
current = clean
birthdayEditText.setText(current)
birthdayEditText.setSelection(if (sel < current.count()) sel else current.count())
}
}
override fun beforeTextChanged(p0: CharSequence?, p1: Int, p2: Int, p3: Int) {
}
override fun afterTextChanged(p0: Editable) {
}
})
}
Solution 6 - Android
Kotlin version without validation
editText.addTextChangedListener(object : TextWatcher{
var sb : StringBuilder = StringBuilder("")
var _ignore = false
override fun afterTextChanged(s: Editable?) {}
override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {}
override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {
if(_ignore){
_ignore = false
return
}
sb.clear()
sb.append(if(s!!.length > 10){ s.subSequence(0,10) }else{ s })
if(sb.lastIndex == 2){
if(sb[2] != '/'){
sb.insert(2,"/")
}
} else if(sb.lastIndex == 5){
if(sb[5] != '/'){
sb.insert(5,"/")
}
}
_ignore = true
editText.setText(sb.toString())
editText.setSelection(sb.length)
}
})
Solution 7 - Android
This answer does not apply a full mask for the remaining untyped digits. However, it is related and is the solution I needed. It works similar to how PhoneNumberFormattingTextWatcher works.
As you type it adds slashes to separate a date formatted like mm/dd/yyyy. It does not do any validation - just formatting.
No need for an EditText reference.
Just set the listener and it works.
myEditText.addTextChangedListener(new DateTextWatcher());
import android.text.Editable;
import android.text.TextWatcher;
import java.util.Locale;
/**
* Adds slashes to a date so that it matches mm/dd/yyyy.
*
* Created by Mark Miller on 12/4/17.
*/
public class DateTextWatcher implements TextWatcher {
public static final int MAX_FORMAT_LENGTH = 8;
public static final int MIN_FORMAT_LENGTH = 3;
private String updatedText;
private boolean editing;
@Override
public void beforeTextChanged(CharSequence charSequence, int start, int before, int count) {
}
@Override
public void onTextChanged(CharSequence text, int start, int before, int count) {
if (text.toString().equals(updatedText) || editing) return;
String digitsOnly = text.toString().replaceAll("\\D", "");
int digitLen = digitsOnly.length();
if (digitLen < MIN_FORMAT_LENGTH || digitLen > MAX_FORMAT_LENGTH) {
updatedText = digitsOnly;
return;
}
if (digitLen <= 4) {
String month = digitsOnly.substring(0, 2);
String day = digitsOnly.substring(2);
updatedText = String.format(Locale.US, "%s/%s", month, day);
}
else {
String month = digitsOnly.substring(0, 2);
String day = digitsOnly.substring(2, 4);
String year = digitsOnly.substring(4);
updatedText = String.format(Locale.US, "%s/%s/%s", month, day, year);
}
}
@Override
public void afterTextChanged(Editable editable) {
if (editing) return;
editing = true;
editable.clear();
editable.insert(0, updatedText);
editing = false;
}
}
Solution 8 - Android
You can use below code and it adds all the validations for a date to be valid as well. Like days cnt be more than 31; month cant be greater than 12 etc.
class DateMask : TextWatcher {
private var updatedText: String? = null
private var editing: Boolean = false
companion object {
private const val MAX_LENGTH = 8
private const val MIN_LENGTH = 2
}
override fun beforeTextChanged(charSequence: CharSequence, start: Int, before: Int, count: Int) {
}
override fun onTextChanged(text: CharSequence, start: Int, before: Int, count: Int) {
if (text.toString() == updatedText || editing) return
var digits = text.toString().replace("\\D".toRegex(), "")
val length = digits.length
if (length <= MIN_LENGTH) {
digits = validateMonth(digits)
updatedText = digits
return
}
if (length > MAX_LENGTH) {
digits = digits.substring(0, MAX_LENGTH)
}
updatedText = if (length <= 4) {
digits = validateDay(digits.substring(0, 2), digits.substring(2))
val month = digits.substring(0, 2)
val day = digits.substring(2)
String.format(Locale.US, "%s/%s", month, day)
} else {
digits = digits.substring(0, 2) + digits.substring(2, 4) + validateYear(digits.substring(4))
val month = digits.substring(0, 2)
val day = digits.substring(2, 4)
val year = digits.substring(4)
String.format(Locale.US, "%s/%s/%s", month, day, year)
}
}
private fun validateDay(month: String, day: String): String {
val arr31 = intArrayOf(1, 3, 5, 7, 8, 10, 12)
val arr30 = intArrayOf(4, 6, 9, 11)
val arrFeb = intArrayOf(2)
if (day.length == 1 &&
((day.toInt() > 3 && month.toInt() !in arrFeb)
|| (day.toInt() > 2 && month.toInt() in arrFeb))) {
return month
}
return when (month.toInt()) {
in arr31 -> validateDay(month, arr31, day, 31)
in arr30 -> validateDay(month, arr30, day, 30)
in arrFeb -> validateDay(month, arrFeb, day, 29)
else -> "$month$day"
}
}
private fun validateDay(month: String, arr: IntArray, day: String, maxDay: Int): String {
if (month.toInt() in arr) {
if (day.toInt() > maxDay) {
return "$month${day.substring(0, 1)}"
}
}
return "$month$day"
}
private fun validateYear(year: String): String {
if (year.length == 1 && (year.toInt() in 3..9 || year.toInt() == 0)) {
return ""
}
if (year.length == 2 && year.toInt() !in 19..20) {
return year.substring(0, 1)
}
return year
}
private fun validateMonth(month: String): String {
if (month.length == 1 && month.toInt() in 2..9) {
return "0$month"
}
if (month.length == 2 && month.toInt() > 12) {
return month.substring(0, 1)
}
return month
}
override fun afterTextChanged(editable: Editable) {
if (editing) return
editing = true
editable.clear()
editable.insert(0, updatedText)
editing = false
}
}
In your fragment or Activity you can use this DateMask as this :
mEditText?.addTextChangedListener(dateMask)
Solution 9 - Android
add android:inputType="date" to your EditText
Solution 10 - Android
Spent 6 hours making my own format. Just give it a try and if you like it then go through the code. You can edit the date at any place like day only, month only. It will automatically escape the '/' character and update the next digit.
// initialized with the current date
String date = new SimpleDateFormat("dd/MM/yyyy", Locale.getDefault()).format(new Date());
edit_date_editEntity.setText(date);
public void formatDate(){
edit_date_editEntity.addTextChangedListener(new TextWatcher() {
@Override
public void beforeTextChanged(CharSequence s, int start, int count, int after) {
String ss = s.toString();
if (after==0) { // when a single character is deleted
if (s.charAt(start) == '/') { // if the character is '/' , restore it and put the cursor at correct position
edit_date_editEntity.setText(s);
edit_date_editEntity.setSelection(start);
}
else if (s.charAt(start) == '-') { // if the character is '-' , restore it and put the cursor at correct position
edit_date_editEntity.setText(s);
edit_date_editEntity.setSelection(start);
}
else if (ss.charAt(start) >= '0' && ss.charAt(start) <= '9') { // if the character is a digit, replace it with '-'
ss = ss.substring(0, start) + "-" + ss.substring(start +1, ss.length());
edit_date_editEntity.setText(ss);
edit_date_editEntity.setSelection(start);
}
}
}
@Override
public void onTextChanged(CharSequence s, int start, int before, int count) {
String ss = s.toString();
if (before==0 ){ // when a single character is added
if (edit_date_editEntity.getSelectionStart()==3 || edit_date_editEntity.getSelectionStart()==6) {
// if the new character was just before '/' character
// getSelection value gets incremented by 1, because text has been changed and hence cursor position updated
// Log.d("test", ss);
ss = ss.substring(0, start) + "/" + ss.substring(start, start + 1) + ss.substring(start + 3, ss.length());
// Log.d("test", ss);
edit_date_editEntity.setText(ss);
edit_date_editEntity.setSelection(start + 2);
}
else {
if (edit_date_editEntity.getSelectionStart()==11){
// if cursor was at last, do not add anything
ss = ss.substring(0,ss.length()-1);
edit_date_editEntity.setText(ss);
edit_date_editEntity.setSelection(10);
}
else {
// else replace the next digit with the entered digit
ss = ss.substring(0, start + 1) + ss.substring(start + 2, ss.length());
edit_date_editEntity.setText(ss);
edit_date_editEntity.setSelection(start + 1);
}
}
}
}
@Override
public void afterTextChanged(Editable s) {
}
});
}
Solution 11 - Android
Use TextWatcher for edittext. isDeleting flag is important addTextChangedListener. Add variables like this-
EditText edtDateFormat;
private boolean isDeleting=false;
private boolean isWrongDate=false;
private boolean isWrongMonth=false;
edtDateFormat.addTextChangedListener(new TextWatcher() {
@Override
public void beforeTextChanged(CharSequence charSequence, int start, int count, int after) {
Log.e("beforeTextChanged","-->"+charSequence);
Log.e("start",""+start);
Log.e("after",""+after);
Log.e("count",""+count);
isDeleting = count > after;
}
@Override
public void onTextChanged(CharSequence charSequence, int start, int before, int count) {
String text=charSequence.toString();
Log.e("onTextChanged","-->"+charSequence);
Log.e("start1",""+start);
Log.e("before1",""+before);
Log.e("count1",""+count);
Log.e("isDeleting ",""+isDeleting);
char subChar = 'T';
if(text.length()>0){
subChar=text.charAt(text.length()-1);
Log.e("LastChar","-->"+subChar);
}
if(isDeleting){
return;
}
if(text.length()==1){
return;
}
if(text.length()==4){
return;
}
if(subChar=='/'){
return;
}
if(charSequence.length()==2){
int date=Integer.parseInt(String.valueOf(charSequence));
if(date<1 || date >31){
edtDateFormat.setError("Please enter correct date");
isWrongDate=true;
return;
}
isWrongDate=false;
isDeleting=false;
charSequence=charSequence+"/";
edtDateFormat.setText(charSequence);
isRunning=true;
edtDateFormat.setSelection(edtDateFormat.getText().length());
isDeleting=true;
}
if(text.length()==5){
String month=text.substring(3,5);
Log.e("Month","-->"+month);
int monthVal=Integer.parseInt(month);
if(monthVal<0 || monthVal>12){
edtDateFormat.setError("Please enter correct month");
isWrongMonth=true;
return;
}
isWrongMonth=false;
isDeleting=false;
charSequence=charSequence+"/";
edtDateFormat.setText(charSequence);
isRunning=true;
edtDateFormat.setSelection(edtDateFormat.getText().length());
isDeleting=true;
}
if(text.length()==10){
String year=text.substring(6,10);
Log.e("year","-->"+year);
int yearVal=Integer.parseInt(year);
if(yearVal<1900 || yearVal>2050){
edtDateFormat.setError("Please enter correct year");
isWrongYear=true;
return;
}
}
if(isWrongDate){
Log.e("isWrongDate","-->"+isWrongDate);
if(text.length()>2){
isDeleting=false;
edtDateFormat.setText(text.substring(0, text.length() - 1));
isDeleting=true;
edtDateFormat.setSelection(edtDateFormat.getText().length());
}
}
if(isWrongMonth){
if(text.length()>2){
isDeleting=false;
edtDateFormat.setText(text.substring(0, text.length() - 1));
isDeleting=true;
edtDateFormat.setSelection(edtDateFormat.getText().length());
}
}
}
@Override
public void afterTextChanged(Editable editable) {
}
});