maspack.widgets
Class DoubleField

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by maspack.widgets.LabeledComponentBase
                      extended by maspack.widgets.LabeledComponent
                          extended by maspack.widgets.LabeledControl
                              extended by maspack.widgets.LabeledTextField
                                  extended by maspack.widgets.DoubleField
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, HasProperties, Disposable, HasAlignableLabels, LabeledWidget
Direct Known Subclasses:
DoubleFieldSlider

public class DoubleField
extends LabeledTextField

Author:
lloyd
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
 
Field Summary
static PropertyList myProps
           
 
Fields inherited from class maspack.widgets.LabeledTextField
MAX_COLUMNS
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
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
 
Constructor Summary
DoubleField()
          Creates a DoubleField with an empty label.
DoubleField(java.lang.String labelText)
          Creates a DoubleField with specified label text.
DoubleField(java.lang.String labelText, double initialValue)
          Creates a DoubleField with specified label text and initial value.
DoubleField(java.lang.String labelText, double initialValue, java.lang.String fmtStr)
          Creates a DoubleField with specified label text, initial value, and format for converting numeric values to text.
DoubleField(java.lang.String labelText, java.lang.String fmtStr)
          Creates a DoubleField with specified label text and format for converting numeric values to text.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
           
 PropertyList getAllPropertyInfo()
          Returns a list giving static information about all properties exported by this object.
 double getDoubleValue()
           
 Range getFormatRange()
           
 NumericInterval getRange()
           
 DoubleHolder getResultHolder()
          Returns the current result holder for this control.
 void setFormat(NumberFormat fmt)
          Directly sets the formatter used used to convert numeric values into text.
 void setFormat(java.lang.String fmtStr)
          Sets the formatter used to convert numeric values into text.
 void setGUIVoidEnabled(boolean enable)
          
 void setLabelStretchable(boolean stretchable)
           
 void setRange(double min, double max)
          Sets the minimum and maximum values associated with this control.
 void setRange(NumericInterval range)
           
 void setResultHolder(DoubleHolder holder)
          Sets the result holder for this control, into which updated values are copied.
 
Methods inherited from class maspack.widgets.LabeledTextField
getColumns, getDefaultFormat, getFormat, getText, getTextField, lastEntryWasAccepted, setColumns
 
Methods inherited from class maspack.widgets.LabeledControl
addValueChangeListener, addValueCheckListener, dispose, getGUIVoidEnabled, getNullValueEnabled, getValue, getValueChangeListeners, getValueCheckListeners, getVoidValueEnabled, isEnabledAll, maskValueChangeListeners, maskValueChecks, removeValueChangeListener, setBackgroundAll, setEnabledAll, setValue, setVoidValueEnabled, valueChangeListenersMasked, valueChecksMasked, valueIsNull, valueIsVoid
 
Methods inherited from class maspack.widgets.LabeledComponent
addMajorComponent, addMajorComponent, getActions, getLabel, getLabelSpacing, getMainComponent, getMajorComponent, getMaximumSize, getMinimumSize, getPreferredLabelSpacing, getSpacing, indexOfMajor, isLabelStretchable, isStretchable, numMajorComponents, removeMajorComponent, setLabelSpacing, setLabelText, setSpacing, setStretchable
 
Methods inherited from class maspack.widgets.LabeledComponentBase
getBackgroundColor, getLabelFontColor, getLabelText, getLeftInset, getProperty, isSelected, setBackgroundColor, setLabelFontColor, setSelected
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface maspack.widgets.LabeledWidget
getToolTipText, setToolTipText
 

Field Detail

myProps

public static PropertyList myProps
Constructor Detail

DoubleField

public DoubleField()
Creates a DoubleField with an empty label.


DoubleField

public DoubleField(java.lang.String labelText,
                   java.lang.String fmtStr)
Creates a DoubleField with specified label text and format for converting numeric values to text.

Parameters:
labelText - text for the control label
fmtStr - format string (printf style; see setFormat)

DoubleField

public DoubleField(java.lang.String labelText,
                   double initialValue,
                   java.lang.String fmtStr)
Creates a DoubleField with specified label text, initial value, and format for converting numeric values to text.

Parameters:
labelText - text for the control label
initialValue - initial double value
fmtStr - format string (printf style; see setFormat)

DoubleField

public DoubleField(java.lang.String labelText,
                   double initialValue)
Creates a DoubleField with specified label text and initial value.

Parameters:
labelText - text for the control label
initialValue - initial double value

DoubleField

public DoubleField(java.lang.String labelText)
Creates a DoubleField with specified label text.

Parameters:
labelText - text for the control label
Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()
Description copied from interface: HasProperties
Returns a list giving static information about all properties exported by this object.

Specified by:
getAllPropertyInfo in interface HasProperties
Overrides:
getAllPropertyInfo in class LabeledTextField
Returns:
static information for all exported properties

getResultHolder

public DoubleHolder getResultHolder()
Returns the current result holder for this control.

Returns:
result holder
See Also:
setResultHolder(maspack.util.DoubleHolder)

setResultHolder

public void setResultHolder(DoubleHolder holder)
Sets the result holder for this control, into which updated values are copied. No copying is performed if the result holder is set to null.

Parameters:
holder - new result holder for this control
See Also:
getResultHolder()

setFormat

public void setFormat(java.lang.String fmtStr)
Sets the formatter used to convert numeric values into text. The formatter is specified using a C printf style format string. A space is inserted between values. For a description of the format string syntax, see NumberFormat. The format conversion character must be appropriate for floating point values (i.e., one of "eEfgaA").

Overrides:
setFormat in class LabeledTextField
Parameters:
fmtStr - format specification string
See Also:
LabeledTextField.getFormat()

setFormat

public void setFormat(NumberFormat fmt)
Directly sets the formatter used used to convert numeric values into text. The format conversion character must be appropriate for floating point values (i.e., one of "eEfgaA").

Overrides:
setFormat in class LabeledTextField
Parameters:
fmt - numeric formatter
See Also:
LabeledTextField.getFormat(), LabeledTextField.setFormat(String)

getFormatRange

public Range getFormatRange()
Overrides:
getFormatRange in class LabeledTextField

getDoubleValue

public double getDoubleValue()

setRange

public void setRange(double min,
                     double max)
Sets the minimum and maximum values associated with this control.

Parameters:
min - minimum value
max - maximum value
See Also:
getRange()

setRange

public void setRange(NumericInterval range)

getRange

public NumericInterval getRange()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Specified by:
actionPerformed in interface java.awt.event.ActionListener
Overrides:
actionPerformed in class LabeledComponent

setGUIVoidEnabled

public void setGUIVoidEnabled(boolean enable)


setLabelStretchable

public void setLabelStretchable(boolean stretchable)
Overrides:
setLabelStretchable in class LabeledComponent