Package org.opensourcephysics.media.core

Class NumberField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

org.opensourcephysics.media.core.NumberField

Direct Known Subclasses:

DecimalField, IntegerField, ScientificField

public class NumberField
extends javax.swing.JTextField

A NumberField is a JTextField that formats and displays numbers. This default implementation displays very small and very large numbers in scientific notation and intermediate-value numbers in decimal form.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

Nested classes/interfaces inherited from class javax.swing.JTextField

javax.swing.JTextField.AccessibleJTextField

Field Summary

Fields

Modifier and Type	Field	Description
protected double	conversionFactor
static java.lang.String	DECIMAL_1_PATTERN
static java.lang.String	DECIMAL_2_PATTERN
static java.lang.String	DECIMAL_3_PATTERN
static java.awt.Color	DISABLED_COLOR
protected boolean	fixedPattern
protected boolean	fixedPatternByDefault
protected java.text.DecimalFormat	format
static java.lang.String	INTEGER_PATTERN
protected java.lang.Double	maxValue
protected java.lang.Double	minValue
protected java.lang.String[]	patterns
protected double	prevValue
protected double[]	ranges
protected int	sigfigs
protected java.lang.String	units
protected java.lang.String	userPattern

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
NumberField(int columns)	Constructs a NumberField with default sigfigs (4)
NumberField(int columns, int sigfigs)	Constructs a NumberField with specified significant figures.

Method Summary

Modifier and Type	Method	Description
double	getConversionFactor()
java.lang.String	getFixedPattern()	Gets the fixed user pattern.
java.text.DecimalFormat	getFormat()	Gets the format for this field.
java.lang.String	getUnits()	Gets the units.
double	getValue()	Gets the value from the text field.
void	setConversionFactor(double factor)
void	setExpectedRange(double lower, double upper)	Sets the expected range of values for this number field.
void	setFixedPattern(java.lang.String pattern)	Sets a fixed user pattern.
void	setFormatFor(double value)	Sets the format for a specified value.
void	setMaxValue(double max)	Sets a maximum value for this field.
void	setMinValue(double min)	Sets a minimum value for this field.
void	setPatterns(java.lang.String[] patterns)	Sets the patterns for this field.
void	setPatterns(java.lang.String[] patterns, double[] limits)	Sets the patterns and limits for this field.
void	setSigFigs(int sigfigs)	Sets the number of significant figures for this number field.
void	setUnits(java.lang.String units)	Sets the units.
void	setValue(double value)	Formats the specified value and enters it in the text field.

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, viewToModel2D, write

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class java.lang.Object

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

Field Detail

DISABLED_COLOR

public static final java.awt.Color DISABLED_COLOR

INTEGER_PATTERN

public static final java.lang.String INTEGER_PATTERN

See Also:

Constant Field Values

DECIMAL_1_PATTERN

public static final java.lang.String DECIMAL_1_PATTERN

See Also:

Constant Field Values

DECIMAL_2_PATTERN

public static final java.lang.String DECIMAL_2_PATTERN

See Also:

Constant Field Values

DECIMAL_3_PATTERN

public static final java.lang.String DECIMAL_3_PATTERN

See Also:

Constant Field Values

format

protected java.text.DecimalFormat format

prevValue

protected double prevValue

maxValue

protected java.lang.Double maxValue

minValue

protected java.lang.Double minValue

sigfigs

protected int sigfigs

fixedPattern

protected boolean fixedPattern

patterns

protected java.lang.String[] patterns

ranges

protected double[] ranges

units

protected java.lang.String units

conversionFactor

protected double conversionFactor

userPattern

protected java.lang.String userPattern

fixedPatternByDefault

protected boolean fixedPatternByDefault

Constructor Detail

NumberField

public NumberField(int columns)

Constructs a NumberField with default sigfigs (4)

Parameters:

columns - the number of character columns

NumberField

public NumberField(int columns,
                   int sigfigs)

Constructs a NumberField with specified significant figures.

Parameters:

columns - the number of character columns

sigfigs - the number of significant figures

Method Detail

getValue

public double getValue()

Gets the value from the text field.

Returns:

the value

setValue

public void setValue(double value)

Formats the specified value and enters it in the text field.

Parameters:

value - the value to be entered

setExpectedRange

public void setExpectedRange(double lower,
                             double upper)

Sets the expected range of values for this number field. Note this does not set a firm max or min--only an expectation.

Parameters:

lower - the lower end of the range

upper - the upper end of the range

setSigFigs

public void setSigFigs(int sigfigs)

Sets the number of significant figures for this number field.

Parameters:

sigfigs - the number of significant figures (between 2 and 6)

setMinValue

public void setMinValue(double min)

Sets a minimum value for this field.

Parameters:

min - the minimum allowed value

setMaxValue

public void setMaxValue(double max)

Sets a maximum value for this field.

Parameters:

max - the maximum allowed value

setUnits

public void setUnits(java.lang.String units)

Sets the units.

Parameters:

units - the units

getUnits

public java.lang.String getUnits()

Gets the units.

Returns:

units the units

setConversionFactor

public void setConversionFactor(double factor)

getConversionFactor

public double getConversionFactor()

getFormat

public java.text.DecimalFormat getFormat()

Gets the format for this field.

Returns:

the format

setFormatFor

public void setFormatFor(double value)

Sets the format for a specified value.

Parameters:

value - the value to be displayed

setPatterns

public void setPatterns(java.lang.String[] patterns)

Sets the patterns for this field. The patterns are applied as follows: value<0.1: patterns[0] value<10: patterns[1] value<100: patterns[2] value<1000: patterns[3] value>=1000: patterns[4]

Parameters:

patterns - the desired patterns

setPatterns

public void setPatterns(java.lang.String[] patterns,
                        double[] limits)

Sets the patterns and limits for this field. The patterns are applied as follows: value=limits[3]: patterns[4]

Parameters:

patterns - the desired patterns

limits - the limits that determine which pattern to use

setFixedPattern

public void setFixedPattern(java.lang.String pattern)

Sets a fixed user pattern.

Parameters:

pattern - the desired pattern (may be null)

getFixedPattern

public java.lang.String getFixedPattern()

Gets the fixed user pattern.

Returns:

the pattern