public class VariableInput extends TextField implements InputObject, Tieable, Value
Whenever checkInput is called, an error of type JCMError might be generated. If throwErrors is true, this error is thrown; if it is false, the error is caught, the value of the variable is set to Double.NaN, and no error is thrown. The error message associated with the error can be retrieved by calling getErrorMessage(), if desired. (This value is null if no error occurred the last time checkInput was called.)
A VariableInput is a Value, so it can be used directly where a Value object is needed.
An VariableInput will ordinarily be registered with a Controller in TWO ways: It's added to a Controller with the Controller's add() method. This makes the Controller call the VariableInput's checkInput() method during the Controller's compute() method. Secondly, a Controller is set as the "onUserAction" property. This causes the Controller's compute() method to be called when the user presses return in the VariableInput box. This is optional-- you might, for example, only want the Controller to compute() when a Compute button is pressed. You can also set the VariableInput's onTextChange property to a Controller that you want to compute every time the text in the box changes.
After the VariableInput is created, it is possible to specify the largest and smallest allowed values for the variable. It is also possible to specify what sytle of input is allowed. The style can be to allow any constant expression, constant real numbers only, or integers only. Set these parameters with setMin(), setMax(), and setInputStyle(). For setInputStyle(), the legal parameter values are VariableInput.EXPRESSION, VariableInput.REAL, and VariableInput.INTEGER. The default input style is EXPRESSION.
TextField.AccessibleAWTTextField
TextComponent.AccessibleAWTTextComponent
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field and Description |
---|---|
protected String |
errorMessage
Error message from the most recent
time checkInput() as called.
|
static int |
EXPRESSION
A constant for use in the setInputStyle() method.
|
protected int |
inputStyle
One of the constant values EXPRESSION, REAL, or
INTEGER, specifying the style of input.
|
static int |
INTEGER
A constant for use in the setInputStyle() method.
|
protected double |
maxValue
Largest allowable value.
|
protected double |
minValue
Smallest allowable value.
|
protected String |
previousContents
This is set to true if the text in the
box has been changed since the last time
the value of the variable was checked by checkInput().
|
static int |
REAL
A constant for use in the setInputStyle() method.
|
protected long |
serialNumber
This serial number is increased
each time the value of the variable
changes.
|
protected boolean |
throwErrors
True if an error should be thrown
when checkInput() is calles and
the contents do not define a
legal number.
|
protected edu.hws.jcm.awt.VariableInput.VI |
variable
The Variable that represents
the value of this input box.
|
textListener
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
VariableInput()
Create an unnamed VariableInput with initial contents "0".
|
VariableInput(String name,
String initialString)
Construct a VariableInput with the given name
and initial String (which can both be null).
|
VariableInput(String name,
String initialString,
Parser parser)
Create a VariableInput just as in the constructor
VariableInput(String,String).
|
Modifier and Type | Method and Description |
---|---|
void |
addTo(Parser p)
A convenience method that registers this VariableInput's variable
with Parser p (but only if both p and the name of the variable are non-null).
|
void |
checkInput()
Check whether the contents are valid, and change the value
of the associated variable if the new contents do not match
the current value.
|
protected double |
convertInput(String num)
Convert a string into a real value.
|
String |
getErrorMessage()
Get error message from previous call to checkInput().
|
int |
getInputStyle()
Return the input style, which determines what types of things
are allowed in the input box.
|
double |
getMax()
Return the maximum value that will be accepted in this VariableInput box.
|
double |
getMin()
Return the minimum value that will be accepted in this VariableInput box.
|
Controller |
getOnTextChange()
Return the Controller, if any, that is notified when the text
in this input box changes
|
Controller |
getOnUserAction()
Return the Controller, if any, that is notified when the user
presses return in this text-input box.
|
long |
getSerialNumber()
Return this object's serial number, which increases whenever the
value of the associated variable changes.
|
boolean |
getThrowErrors()
Return the value of the throwErrors property.
|
double |
getVal()
Return the value of the associated variable, which might not
reflect the value of the contents of the input box.
|
Variable |
getVariable()
Get the associated variable for the VariableInput box.
|
void |
notifyControllerOnChange(Controller c)
Method required by InputObject interface; in this class, it simply calls
setOnUserAction(c).
|
void |
processActionEvent(ActionEvent evt)
Overridden to call onUserAction.compute() if onUserAction is non-null.
|
void |
processTextEvent(TextEvent evt)
Overridden to call onUserAction.compute() if onUserAction is non-null.
|
void |
setInputStyle(int style)
Specify what types of things are allowed in the input box.
|
void |
setMax(double max)
Specify the largest allowed value for the content of this VariableInput box.
|
void |
setMin(double min)
Specify the smallest allowed value for the content of this VariableInput box.
|
void |
setName(String name)
Set the name of the variable.
|
void |
setOnTextChange(Controller c)
If the Controller, cm is non-null, then its compute() method will be called whenever
the text in this input box changes.
|
void |
setOnUserAction(Controller c)
If the Controller, c, is non-null, then its compute() method will be called whenever
the user presses the return key while typing in this text-input box.
|
void |
setText(String text)
This overrides the setText() method from the TextField class so that
it will also force the contents to be checked the next time
the checkInput() method is called.
|
void |
setThrowErrors(boolean throwErrors)
Set the throwErrors property.
|
void |
setVal(double d)
Set the value of the associated variable.
|
void |
sync(Tie tie,
Tieable newest)
Synchronize serial number and value with newest, unless
this VariableInput is itself newest.
|
JCMPanel |
withLabel()
Convenience method for creating a component containing
this VariableInput together with a label of the form
"
|
JCMPanel |
withLabel(Color back,
Color fore)
Convenience method for creating a component containing
this VariableInput together with a label of the form
"name = ".
|
addActionListener, addNotify, echoCharIsSet, getAccessibleContext, getActionListeners, getColumns, getEchoChar, getListeners, getMinimumSize, getMinimumSize, getPreferredSize, getPreferredSize, minimumSize, minimumSize, paramString, preferredSize, preferredSize, processEvent, removeActionListener, setColumns, setEchoChar, setEchoCharacter
addTextListener, enableInputMethods, getBackground, getCaretPosition, getInputMethodRequests, getSelectedText, getSelectionEnd, getSelectionStart, getText, getTextListeners, isEditable, removeNotify, removeTextListener, select, selectAll, setBackground, setCaretPosition, setEditable, setSelectionEnd, setSelectionStart
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate
protected edu.hws.jcm.awt.VariableInput.VI variable
protected boolean throwErrors
protected String errorMessage
protected long serialNumber
protected String previousContents
protected double minValue
protected double maxValue
protected int inputStyle
public static final int EXPRESSION
public static final int REAL
public static final int INTEGER
public VariableInput()
public VariableInput(String name, String initialString)
public Variable getVariable()
public JCMPanel withLabel()
public JCMPanel withLabel(Color back, Color fore)
public void setName(String name)
public void addTo(Parser p)
public void setOnUserAction(Controller c)
public Controller getOnUserAction()
public void notifyControllerOnChange(Controller c)
notifyControllerOnChange
in interface InputObject
public void setOnTextChange(Controller c)
public Controller getOnTextChange()
public double getVal()
public void setVal(double d)
public void setThrowErrors(boolean throwErrors)
public boolean getThrowErrors()
public void setMin(double min)
public double getMin()
public void setMax(double max)
public double getMax()
public void setInputStyle(int style)
public int getInputStyle()
public String getErrorMessage()
public void checkInput()
checkInput
in interface InputObject
public long getSerialNumber()
getSerialNumber
in interface Tieable
public void sync(Tie tie, Tieable newest)
protected double convertInput(String num)
num
- String to be convertedpublic void setText(String text)
public void processActionEvent(ActionEvent evt)
processActionEvent
in class TextField
public void processTextEvent(TextEvent evt)
processTextEvent
in class TextComponent