What is the recommended way to make a numeric TextField in JavaFX

Question

I need to restrict input into a TextField to integers  Any advice

User · Answer

rate text textProperty   addListener new ChangeListener lt String gt            Override     public void changed ObservableValue lt   extends String gt  observable  String oldValue  String newValue            String s             for char c   newValue toCharArray                 if   int c  gt   48  amp  amp   int c  lt   57     int c    46                    s  c                                  rate text setText s               This works fine as it allows you to enter only integer value and decimal value  having ASCII code 46

User · Answer

Update Apr 2016  This answer was created some years ago and the original answer is largely obsolete now     Since Java 8u40  Java has a TextFormatter which is usually best for enforcing input of specific formats such as numerics on JavaFX TextFields    Java 8 U40 TextFormatter  JavaFX  to restrict user input only for decimal number String with numbers and letters to double javafx   See also other answers to this question which specifically mention TextFormatter     Original Answer  There are some examples of this in this gist  I have duplicated one of the examples below      helper text field subclass which restricts text input to a given range of natural int numbers    and exposes the current numeric int value of the edit box as a value property  class IntField extends TextField     final private IntegerProperty value    final private int minValue    final private int maxValue        expose an integer value property for the text field    public int  getValue                     return value getValue        public void setValue int newValue        value setValue newValue       public IntegerProperty valueProperty     return value       IntField int minValue  int maxValue  int initialValue        if  minValue  gt  maxValue         throw new IllegalArgumentException           IntField min value     minValue     greater than max value     maxValue              if  maxValue  lt  minValue         throw new IllegalArgumentException           IntField max value     minValue     less than min value     maxValue              if     minValue  lt   initialValue   amp  amp   initialValue  lt   maxValue           throw new IllegalArgumentException           IntField initialValue     initialValue     not between     minValue     and     maxValue                  initialize the field values      this minValue   minValue      this maxValue   maxValue      value   new SimpleIntegerProperty initialValue       setText initialValue             final IntField intField   this          make sure the value property is clamped to the required range        and update the field s text to be in sync with the value      value addListener new ChangeListener lt Number gt             Override public void changed ObservableValue lt   extends Number gt  observableValue  Number oldValue  Number newValue            if  newValue    null              intField setText                else             if  newValue intValue    lt  intField minValue                value setValue intField minValue               return                         if  newValue intValue    gt  intField maxValue                value setValue intField maxValue               return                         if  newValue intValue      0  amp  amp   textProperty   get      null       equals textProperty   get                       no action required  text property is already blank  we don t need to set it to 0              else               intField setText newValue toString                                                   restrict key input to numerals      this addEventFilter KeyEvent KEY TYPED  new EventHandler lt KeyEvent gt             Override public void handle KeyEvent keyEvent            if intField minValue lt 0                    if    -0123456789  contains keyEvent getCharacter                           keyEvent consume                                                else                   if    0123456789  contains keyEvent getCharacter                           keyEvent consume                                                            ensure any entered values lie inside the required range      this textProperty   addListener new ChangeListener lt String gt             Override public void changed ObservableValue lt   extends String gt  observableValue  String oldValue  String newValue            if  newValue    null       equals newValue      intField minValue lt 0  amp  amp   -  equals newValue                value setValue 0             return                     final int intValue   Integer parseInt newValue            if  intField minValue  gt  intValue    intValue  gt  intField maxValue              textProperty   setValue oldValue                      value set Integer parseInt textProperty   get

User · Answer

I don t like exceptions thus I used the matches function from String-Class  text textProperty   addListener new ChangeListener lt String gt           Override     public void changed ObservableValue lt   extends String gt  observable  String oldValue           String newValue            if  newValue matches    d                   int value   Integer parseInt newValue             else               text setText oldValue

User · Answer

Here is a simple class that handles some basic validations on TextField  using TextFormatter introduced in JavaFX 8u40  EDIT     Code added regarding Floern s comment   import java text DecimalFormatSymbols  import java util regex Pattern   import javafx beans NamedArg  import javafx scene control TextFormatter  import javafx scene control TextFormatter Change   public class TextFieldValidator        private static final String CURRENCY SYMBOL     DecimalFormatSymbols getInstance   getCurrencySymbol        private static final char   DECIMAL SEPARATOR   DecimalFormatSymbols getInstance   getDecimalSeparator         private final Pattern       INPUT PATTERN       public TextFieldValidator  NamedArg  modus   ValidationModus modus   NamedArg  countOf   int countOf            this modus createPattern countOf               public TextFieldValidator  NamedArg  regex   String regex            this Pattern compile regex               public TextFieldValidator Pattern inputPattern            INPUT PATTERN   inputPattern             public static TextFieldValidator maxFractionDigits int countOf            return new TextFieldValidator maxFractionPattern countOf               public static TextFieldValidator maxIntegers int countOf            return new TextFieldValidator maxIntegerPattern countOf               public static TextFieldValidator integersOnly             return new TextFieldValidator integersOnlyPattern                public TextFormatter lt Object gt  getFormatter             return new TextFormatter lt  gt  this  validateChange              private Change validateChange Change c            if  validate c getControlNewText                   return c                    return null             public boolean validate String input            return INPUT PATTERN matcher input  matches               private static Pattern maxFractionPattern int countOf            return Pattern compile    d        DECIMAL SEPARATOR      d 0     countOf                      private static Pattern maxCurrencyFractionPattern int countOf            return Pattern compile         CURRENCY SYMBOL       s   d        DECIMAL SEPARATOR      d 0     countOf         s                       CURRENCY SYMBOL                    private static Pattern maxIntegerPattern int countOf            return Pattern compile    d 0     countOf                    private static Pattern integersOnlyPattern             return Pattern compile    d                public enum ValidationModus            MAX CURRENCY FRACTION DIGITS                Override             public Pattern createPattern int countOf                    return maxCurrencyFractionPattern countOf                                     MAX FRACTION DIGITS                Override             public Pattern createPattern int countOf                    return maxFractionPattern countOf                                    MAX INTEGERS                Override             public Pattern createPattern int countOf                    return maxIntegerPattern countOf                                     INTEGERS ONLY                Override             public Pattern createPattern int countOf                    return integersOnlyPattern                                      public abstract Pattern createPattern int countOf              You can use it like this   textField setTextFormatter new TextFieldValidator ValidationModus INTEGERS ONLY  getFormatter       or you can instantiate it in a fxml file  and apply it to a customTextField with the according properties   app fxml    lt fx define gt       lt TextFieldValidator fx id  validator  modus  INTEGERS ONLY   gt   lt  fx define gt    CustomTextField class     public class CustomTextField    private TextField textField   public CustomTextField  NamedArg  validator   TextFieldValidator validator            this            textField setTextFormatter validator getFormatter               Code on github

User · Answer

This is what I use   private TextField textField  textField textProperty   addListener new ChangeListener lt String gt           Override     public void changed ObservableValue lt   extends String gt  observable  String oldValue  String newValue            if  newValue matches   0-9                   textField setText oldValue                          The same in lambda notation would be   private TextField textField  textField textProperty   addListener  observable  oldValue  newValue  - gt        if  newValue matches   0-9               textField setText oldValue

User · Answer

this Code Make your textField Accept only Number   textField lengthProperty   addListener  observable  oldValue  newValue  - gt            if newValue intValue    gt  oldValue intValue                 char c   textField getText   charAt oldValue intValue                     Check if the new character is the number or other s                if  c  gt   9     c  lt   0                        if it s not number then just setText to previous one                    textField setText textField getText   substring 0 textField getText   length  -1

User · Answer

Try this simple code it will do the job   DecimalFormat format   new DecimalFormat     0     TextField field   new TextField    field setTextFormatter  new TextFormatter lt  gt  c - gt        if   c getControlNewText   isEmpty                   return c             ParsePosition parsePosition   new ParsePosition  0        Object object   format parse  c getControlNewText    parsePosition         if   object    null    parsePosition getIndex    lt           c getControlNewText   length                   return null            else               return c

User · Answer

This one worked for me   public void RestrictNumbersOnly TextField tf       tf textProperty   addListener new ChangeListener lt String gt               Override         public void changed ObservableValue lt   extends String gt  observable  String oldValue               String newValue                if   newValue matches    -       -       d       -       d       d                      tf setText oldValue

User · Answer

I would like to improve Evan Knowles answer  https   stackoverflow com a 30796829 2628125  In my case I had class with handlers for UI Component part  Initialization   this dataText textProperty   addListener  observable  oldValue  newValue  - gt  this numericSanitization observable  oldValue  newValue      And the numbericSanitization method   private synchronized void numericSanitization ObservableValue lt   extends String gt  observable  String oldValue  String newValue        final String allowedPattern      d         if   newValue matches allowedPattern             this dataText setText oldValue             Keyword synchronized is added to prevent possible render lock issue in javafx if setText will be called before old one is finished execution  It is easy to reproduce if you will start typing wrong chars really fast   Another advantage is that you keep only one pattern to match and just do rollback  It is better because you can easily abstragate solution for different sanitization patterns

User · Answer

This method lets TextField to finish all processing  copy paste undo safe   Does not require to extend classes and allows you to decide what to do with new text after every change  to push it to logic  or turn back to previous value  or even to modify it         fired by every text property change textField textProperty   addListener     observable  oldValue  newValue  - gt           Your validation rules  anything you like             note 1    make sure that empty string  newValue equals                  or initial text is always valid            to prevent inifinity cycle        do whatever you want with newValue         If newValue is not valid for your rules       StringProperty observable  setValue oldValue               note 2    do not bind textProperty  textProperty   bind someProperty              to anything in your code   TextProperty implementation            of StringProperty in TextFieldControl            will throw RuntimeException in this case on setValue string  call             Or catch and handle this exception          If you want to change something in text          When it is valid for you with some changes that can be automated           For example change it to upper case       StringProperty observable  setValue newValue toUpperCase              For your case just add this logic inside  Works perfectly      if  newValue equals      return      try        Integer i   Integer valueOf newValue           do what you want with this i      catch  Exception e           StringProperty observable  setValue oldValue

User · Answer

The preffered answer can be even smaller if you make use of Java 1 8 Lambdas  textfield textProperty   addListener  observable  oldValue  newValue  - gt        if  newValue matches    d     return      textfield setText newValue replaceAll      d

User · Answer

Mmmm  I ran into that problem weeks ago  As the API doesn t provide a control to achieve that  you may want to use your own one  I used something like   public class IntegerBox extends TextBox       public-init var value   Integer   0      protected function apply             try               value   Integer parseInt text             catch  e   NumberFormatException             text     value              override var focused   false on replace  apply         override var action   function     apply        It s used the same way that a normal TextBox  but has also a value attribute which stores the entered integer  When the control looses the focus  it validates the value and reverts it  if isn t valid

User · Answer

TextField text   new TextField     text textProperty   addListener new ChangeListener lt String gt           Override     public void changed ObservableValue lt   extends String gt  observable              String oldValue  String newValue            try               Integer parseInt newValue               if  newValue endsWith  f      newValue endsWith  d                      manualPriceInput setText newValue substring 0  newValue length  -1                            catch  ParseException e                text setText oldValue                         The if clause is important to handle inputs like 0 5d or 0 7f which are correctly parsed by Int parseInt    but shouldn t appear in the text field

User · Answer

The TextInput has a TextFormatter which can be used to format  convert and limit the types of text that can be input    The TextFormatter has a filter which can be used to reject input  We need to set this to reject anything that s not a valid integer  It also has a converter which we need to set to convert the string value to an integer value which we can bind later on   Lets create a reusable filter   public class IntegerFilter implements UnaryOperator lt TextFormatter Change gt        private final static Pattern DIGIT PATTERN   Pattern compile    d           Override     public Change apply TextFormatter Change aT            return DIGIT PATTERN matcher aT getText    matches     aT   null            The filter can do one of three things  it can return the change unmodified to accept it as it is  it can alter the change in some way it deems fit or it can return null to reject the change all together   We will use the standard IntegerStringConverter as a converter    Putting it all together we have   TextField textField         TextFormatter lt Integer gt  formatter   new TextFormatter lt  gt       new IntegerStringConverter       Standard converter form JavaFX     defaultValue       new IntegerFilter     formatter valueProperty   bindBidirectional myIntegerProperty    textField setTextFormatter formatter     If you want don t need a reusable filter you can do this fancy one-liner instead   TextFormatter lt Integer gt  formatter   new TextFormatter lt  gt       new IntegerStringConverter         defaultValue        c - gt  Pattern matches    d    c getText      c   null

User · Answer

Starting with JavaFX 8u40  you can set a TextFormatter object on a text field   UnaryOperator lt Change gt  filter   change - gt        String text   change getText         if  text matches   0-9                return change             return null     TextFormatter lt String gt  textFormatter   new TextFormatter lt  gt  filter   fieldNport   new TextField    fieldNport setTextFormatter textFormatter     This avoids both subclassing and duplicate change events which you will get when you add a change listener to the text property and modify the text in that listener

User · Answer

This code works fine for me even if you try to copy paste   myTextField textProperty   addListener  observable  oldValue  newValue  - gt        if   newValue matches    d               myTextField setText oldValue

User · Answer

I know this is a rather old thread  but for future readers here is another solution I found quite intuitive   public class NumberTextField extends TextField         Override     public void replaceText int start  int end  String text                if  validate text                         super replaceText start  end  text                         Override     public void replaceSelection String text                if  validate text                         super replaceSelection text                        private boolean validate String text                return text matches   0-9                Edit  Thanks none  and SCBoy for your suggested improvements

User · Answer

In recent updates of JavaFX  you have to set new text in Platform runLater method just like this       private void set normal number TextField textField  String oldValue  String newValue        try           int p   textField getCaretPosition            if   newValue matches    d                   Platform runLater    - gt                    textField setText newValue replaceAll      d                          textField positionCaret p                                   catch  Exception e              It s a good idea to set caret position too

User · Answer

Starting from Java SE 8u40  for such need you can use an  integer  Spinner allowing to safely select a valid integer by using the keyboard s up arrow down arrow keys or the up arrow down arrow provided buttons    You can also define a min  a max and an initial value to limit the allowed values and an amount to increment or decrement by  per step   For example     Creates an integer spinner with 1 as min  10 as max and 2 as initial value Spinner lt Integer gt  spinner1   new Spinner lt  gt  1  10  2      Creates an integer spinner with 0 as min  100 as max and 10 as initial     value and 10 as amount to increment or decrement by  per step Spinner lt Integer gt  spinner2   new Spinner lt  gt  0  100  10  10     Example of result with an  integer  spinner and a  double  spinner       A spinner is a single-line text field control that lets the user   select a number or an object value from an ordered sequence of such   values  Spinners typically provide a pair of tiny arrow buttons for   stepping through the elements of the sequence  The keyboard s up   arrow down arrow keys also cycle through the elements  The user may   also be allowed to type a  legal  value directly into the spinner    Although combo boxes provide similar functionality  spinners are   sometimes preferred because they don t require a drop-down list that   can obscure important data  and also because they allow for features   such as wrapping from the maximum value back to the minimum value    e g   from the largest positive integer to 0     More details about the Spinner control

User · Answer

If you want to apply the same listener to more than one TextField here is the simplest solution   TextField txtMinPrice  txtMaxPrice   new TextField     ChangeListener lt String gt  forceNumberListener    observable  oldValue  newValue  - gt        if   newValue matches    d             StringProperty  observable  set oldValue       txtMinPrice textProperty   addListener forceNumberListener   txtMaxPrice textProperty   addListener forceNumberListener

User · Answer

Very old thread  but this seems neater and strips out non-numeric characters if pasted      force the field to be numeric only textField textProperty   addListener new ChangeListener lt String gt           Override     public void changed ObservableValue lt   extends String gt  observable  String oldValue           String newValue            if   newValue matches    d                   textField setText newValue replaceAll      d

User · Answer

I want to help with my idea from combining Evan Knowles answer with TextFormatter from JavaFX 8   textField setTextFormatter new TextFormatter lt  gt  c - gt        if   c getControlNewText   matches    d              return null      else         return c              so good luck    keep calm and code java

[input] What is the recommended way to make a numeric TextField in JavaFX?

Examples related to input

Examples related to filter

Examples related to textfield

Examples related to javafx