Package sim.util.gui

Class NumberTextField

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
sim.util.gui.NumberTextField
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable
public class NumberTextField extends JComponent
A simple class that lets you specify a label and validate a numerical value. NumberTextField assumes access to several image files for the widgets to the right of the text field: a left-arrow button, a right-arrow button, and a "belly button". The left-arrow button decreases the numerical value, the right-arrow button increases it, and the belly button resets it to its initial default value. You can also change the value in the text field proper. Why use this class instead of a slider? Because it is not ranged: the numbers can be any value.

NumberTextField lets users increase values according to a provided formula of the form value = value * M + A, and similarly decrease values as value = (value - A) / M. You specify the values of M and A and the initial default value. This gives you some control on how values should change: linearly or geometrically.

You can exercise further control by subclassing the class and overriding the newValue(val) method, which filters all newly user-set values and "corrects" them. Programmatically set values (by calling setValue(...)) are not filtered through newValue by default. If you need to filter, you should do setValue(newValue(val));

NumberTextFields can also be provided with an optional label.

See Also:

  • Field Details

    • currentValue

      protected double currentValue

    • I_DOWN

      public static final ImageIcon I_DOWN

    • I_DOWN_PRESSED

      public static final ImageIcon I_DOWN_PRESSED

    • I_BELLY

      public static final ImageIcon I_BELLY

    • I_BELLY_PRESSED

      public static final ImageIcon I_BELLY_PRESSED

    • I_UP

      public static final ImageIcon I_UP

    • I_UP_PRESSED

      public static final ImageIcon I_UP_PRESSED

  • Constructor Details

    • NumberTextField

      public NumberTextField(double initialValue)
      Creates a NumberTextField which does not display the belly button or arrows.

    • NumberTextField

      public NumberTextField(String label, double initialValue)
      Creates a NumberTextField which does not display the belly button or arrows.

    • NumberTextField

      public NumberTextField(double initialValue, boolean doubleEachTime)
      Creates a NumberTextField which (if doubleEachTime) doubles or halves the current value, or (if not doubleEachTime) increases or decreases by 1 each time.

    • NumberTextField

      public NumberTextField(double initialValue, double multiply, double add)
      Creates a NumberTextField according to the provided parameters. initialValue specifies the initial number value. multiply and add work as follows: If the right arrow is pressed, then the current value is changed to newValue(value * multiply + add); similarly, if the left arrow is pressed, then the current value is changed to newValue((value - add) / multiply); if the belly button is pressed, then the current value is changed to newValue(initialValue); Common settings include:

      initialValue = 1, multiply = 2, add = 0 (start at 1, double each time)
      initialValue = 0, multiply = 1, add = 1 (start at 0, add 1 each time)

      If multiply is 0, then no arrows are shown at all.

    • NumberTextField

      public NumberTextField(String label, double initialValue, boolean doubleEachTime)
      Creates a NumberTextField with a provided label. If the label is null or empty, no label is created. Creates a NumberTextField which (if doubleEachTime) doubles or halves the current value, or (if not doubleEachTime) increases or decreases by 1 each time.

    • NumberTextField

      public NumberTextField(String label, double initialValue, double multiply, double add)
      Creates a NumberTextField with a provided label. If the label is null or empty, no label is created. initialValue specifies the initial number value. multiply and add work as follows: If the right arrow is pressed, then the current value is changed to newValue(value * multiply + add); similarly, if the left arrow is pressed, then the current value is changed to newValue((value - add) / multiply); if the belly button is pressed, then the current value is changed to newValue(initialValue); Common settings include:

      initialValue = 1, multiply = 2, add = 0 (start at 1, double each time)
      initialValue = 0, multiply = 1, add = 1 (start at 0, add 1 each time)

      If multiply is 0, then no arrows are shown at all.

  • Method Details

    • setEditedColor

      public void setEditedColor(Color c)

    • getEditedColor

      public Color getEditedColor()

    • submit

      public void submit()

    • update

      public void update()

    • setValue

      public void setValue(double val)
      Sets the value without filtering first.

    • getValue

      public double getValue()
      Returns the most recently set value.

    • getField

      public JTextField getField()

    • setInitialValue

      public void setInitialValue(double initialValue)

    • getInitialValue

      public double getInitialValue()

    • newValue

      public double newValue(double newValue)
      Override this to be informed when a new value has been set. The return value should be the value you want the display to show instead.

    • setToolTipText

      public void setToolTipText(String text)
      Overrides:
      setToolTipText in class JComponent

    • setEnabled

      public void setEnabled(boolean b)
      Overrides:
      setEnabled in class JComponent

    • setText

      public void setText(String val)
      Only call this to access the value field directly

    • getText

      public String getText()