Directory

← Back

MaskedTextField

TextField extension to allow masked input

Author

Contributors

Rating

UPDATE: An updated version for Vaadin 7 is on the way! Check our Github repository.

An extension to the TextField to allow the developer to specify a mask. It's an pure Vaadin/GWT implementation with no external dependencies.

It is still experimental, so if you find any bug or have a suggestion please let me know.

You can use it the same way you use the default TextField, listening to the same events or calling the same methods, the mask is the only difference. The input should satisfy the mask in order to be considered valid.

Currently available masks:

- any digit

U - upper-case letter L - lower-case letter ? - any letter A - any number or character

    • anything H - hex sign (0-9, a-f or A-F) ' - Escape character, used to escape any of the special formatting characters. ~ - +/- sign

Any character not matching one of the above mask character or if it escaped with the single quote character (') is considered to be a literal.

Some mask examples:

Phone Number: (###) ###-#### USPS Express Mail: EU#########'US Date / time: ##/##/#### ##:## State: UU HTML Color: '#HHHHHH An capitalized 6 letter word: ULLLLL

Sample code

package com.andersonfreitas.vaadin.maskedtextfield;

import com.vaadin.Application;
import com.vaadin.ui.Button;
import com.vaadin.ui.FormLayout;
import com.vaadin.ui.Label;
import com.vaadin.ui.MaskedTextField;
import com.vaadin.ui.NumericField;
import com.vaadin.ui.TabSheet;
import com.vaadin.ui.Window;
import com.vaadin.ui.Button.ClickEvent;
import com.vaadin.ui.Button.ClickListener;

@SuppressWarnings("serial")
public class DemoApplication extends Application {
	@Override
	public void init() {
		final Window mainWindow = new Window("Vaadin MaskedTextField Demo Application");
		
		TabSheet tabSheet = new TabSheet();
		
		FormLayout numbers = new FormLayout();
		
		final MaskedTextField phoneField = new MaskedTextField("Phone (##) ####-####", "+55 (##) ####-####");
		
		Button btnShowValue = new Button("Show value");
		btnShowValue.addListener(new ClickListener() {
			@Override
			public void buttonClick(ClickEvent event) {
				mainWindow.showNotification((String) phoneField.getValue());
			}
		});
		
		numbers.addComponent(phoneField);
		numbers.addComponent(btnShowValue);
		
		numbers.addComponent(new MaskedTextField("UU###-###-###LL", "UU###-###-###LL"));
		numbers.addComponent(new MaskedTextField("USPS Express Mail", "EU#########'US"));
		numbers.addComponent(new MaskedTextField("Alphanumeric", "AAAAAAAAAA"));
		numbers.addComponent(new MaskedTextField("Hex 0xHHHHHHHH", "0xHHHHHHHH"));
		numbers.addComponent(new MaskedTextField("Signed number", "~####"));
		numbers.addComponent(new MaskedTextField("Escape #2010", "'#####"));
		numbers.addComponent(new MaskedTextField("'2010'", "''####''"));
		
		FormLayout misc = new FormLayout();
		misc.addComponent(new MaskedTextField("Capitalized name", "ULLLLLLLLLLLLLL"));
		misc.addComponent(new MaskedTextField("Upper-case letters only", "UUUUUUUUU"));
		misc.addComponent(new MaskedTextField("Lower-case letters only", "LLLLLLLLL"));
		misc.addComponent(new MaskedTextField("Any letter", "????????"));
		misc.addComponent(new MaskedTextField("Anything", "***********"));
		misc.addComponent(new MaskedTextField("Time", "##:##"));
		misc.addComponent(new MaskedTextField("Some preffix", "TR-####"));
		
		FormLayout numeric = new FormLayout();
		numeric.addComponent(new Label("Use UP and DOWN keys to change the value"));
		numeric.addComponent(new NumericField("Numeric Value"));
		
		tabSheet.addTab(numbers, "Numbers", null);
		tabSheet.addTab(misc, "Misc", null);
		tabSheet.addTab(numeric, "NumericField", null);
		mainWindow.addComponent(tabSheet);
		
		setMainWindow(mainWindow);
	}
}

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Fixed a minor issue with the setValue() method

Released
2010-07-29
Maturity
STABLE
License
Apache License 2.0

Compatibility

Framework
Vaadin 6.0+
Browser
Internet Explorer
Internet Explorer
Internet Explorer
Firefox
Safari

MaskedTextField - Vaadin Add-on Directory

TextField extension to allow masked input MaskedTextField - Vaadin Add-on Directory
UPDATE: An updated version for Vaadin 7 is on the way! Check our Github repository. An extension to the TextField to allow the developer to specify a mask. It's an pure Vaadin/GWT implementation with no external dependencies. It is still experimental, so if you find any bug or have a suggestion please let me know. You can use it the same way you use the default TextField, listening to the same events or calling the same methods, the mask is the only difference. The input should satisfy the mask in order to be considered valid. Currently available masks: # - any digit U - upper-case letter L - lower-case letter ? - any letter A - any number or character * - anything H - hex sign (0-9, a-f or A-F) ' - Escape character, used to escape any of the special formatting characters. ~ - +/- sign Any character not matching one of the above mask character or if it escaped with the single quote character (') is considered to be a literal. Some mask examples: Phone Number: (###) ###-#### USPS Express Mail: EU#########'US Date / time: ##/##/#### ##:## State: UU HTML Color: '#HHHHHH An capitalized 6 letter word: ULLLLL
Online