com.ben12.infxnity.control.text

Class MaskTextFilter

java.lang.Object

com.ben12.infxnity.control.text.MaskTextFilter

All Implemented Interfaces:

Function<TextFormatter.Change,TextFormatter.Change>, UnaryOperator<TextFormatter.Change>

public class MaskTextFilter
extends Object
implements UnaryOperator<TextFormatter.Change>

Mask to use as filter for TextFormatter.

Example for create a TextField allowing only french phone numbers:

 
 	final TextField textField = new TextField();
 	final MaskCharacter[] mask = MaskBuilder.newBuilder()
 			.appendLiteral("+33 ")
 			.appendDigit('6')
 			.appendLiteral(" ")
 			.appendDigit(2)
 			.appendLiteral(" ")
 			.appendDigit(2)
 			.appendLiteral(" ")
 			.appendDigit(2)
 			.appendLiteral(" ")
 			.appendDigit(2)
 			.build();
 	textField.setTextFormatter(new TextFormatter<>(new MaskTextFilter(textField, false, mask)));
 
 

Default text will be "+33 6 00 00 00 00".
Caret will be placed in 4th position : "+33 |6 00 00 00 00".
An navigation to the right will do that:
"+33 6 |00 00 00 00"
"+33 6 0|0 00 00 00"
"+33 6 00 |00 00 00"
"+33 6 00 0|0 00 00"
"+33 6 00 00 |00 00"
"+33 6 00 00 0|0 00"
"+33 6 00 00 00 |00"
"+33 6 00 00 00 0|0"
"+33 6 00 00 00 00|"

Author:

Benoît Moreau (ben.12)

See Also:

MaskBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MaskTextFilter.MaskCharacter Mask character interface.

Constructor Summary

Constructors

Constructor and Description
MaskTextFilter(MaskTextFilter.MaskCharacter... pMask)
MaskTextFilter(TextInputControl input, boolean setDefaultOnFocus, MaskTextFilter.MaskCharacter... pMask)

Method Summary

Modifier and Type	Method and Description
TextFormatter.Change	apply(TextFormatter.Change c)
void	applyDefault(TextInputControl input)
void	install(TextInputControl input, boolean setDefaultOnFocus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.UnaryOperator

identity

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

MaskTextFilter

public MaskTextFilter(MaskTextFilter.MaskCharacter... pMask)

Parameters:

pMask - the mask to use

MaskTextFilter

public MaskTextFilter(TextInputControl input,
                      boolean setDefaultOnFocus,
                      MaskTextFilter.MaskCharacter... pMask)

Parameters:

input - TextInputControl where the filter will be applied

setDefaultOnFocus - true to set the default value when it gain the focus, otherwise the default value is immediately applied

pMask - the mask to use

Method Detail

install

public void install(TextInputControl input,
                    boolean setDefaultOnFocus)

Parameters:

input - TextInputControl where set the default value

setDefaultOnFocus - true to set the default value when it gain the focus, otherwise the default value is immediately applied

applyDefault

public void applyDefault(TextInputControl input)

Parameters:

input - TextInputControl where set the default value

apply

public TextFormatter.Change apply(TextFormatter.Change c)

Specified by:

apply in interface Function<TextFormatter.Change,TextFormatter.Change>