maspack.widgets
Class IntegerMultiField

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.LabeledMultiTextField
                                  extended by maspack.widgets.IntegerMultiField
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

public class IntegerMultiField
extends LabeledMultiTextField

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 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
IntegerMultiField(java.lang.String labelText, int vectorSize)
          Creates a new IntMultiField with specified label text and number of elements.
IntegerMultiField(java.lang.String labelText, int[] initialValue, java.lang.String fmtStr)
          Creates a new IntMultiField with specified label text and initial value.
IntegerMultiField(java.lang.String labelText, java.lang.String[] fieldLabels, int[] initialValue, java.lang.String fmtStr, int ncols)
          Creates a new IntMultiField with specified label text, labels for each field, and initial value.
 
Method Summary
 PropertyList getAllPropertyInfo()
          Returns a list giving static information about all properties exported by this object.
 int getMaximum()
          Gets the maximum value associated with this control.
 int getMinimum()
          Gets the minimum value associated with this control.
 IntegerInterval getRange()
           
 int[] getResultHolder()
          Returns the current result holder for this control.
 double getValue(int idx)
           
 int getVectorSize()
          Returns the size of the vector value associated with this control.
 int[] getVectorValue()
           
 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 setRange(IntegerInterval range)
           
 void setRange(int min, int max)
          Sets the minimum and maximum values associated with this control.
 void setResultHolder(int[] holder)
          Sets the result holder for this control, into which updated values are copied.
 java.lang.Object textToValue(java.lang.String[] text, boolean[] corrected, StringHolder errMsg)
           
 
Methods inherited from class maspack.widgets.LabeledMultiTextField
getAllCurrentText, getColumns, getHorizontalAlignment, getText, getTextField, numTextFields, setColumns, setHorizontalAlignment
 
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
actionPerformed, addMajorComponent, addMajorComponent, getActions, getLabel, getLabelSpacing, getMainComponent, getMajorComponent, getMaximumSize, getMinimumSize, getPreferredLabelSpacing, getSpacing, indexOfMajor, isLabelStretchable, isStretchable, numMajorComponents, removeMajorComponent, setLabelSpacing, setLabelStretchable, 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

IntegerMultiField

public IntegerMultiField(java.lang.String labelText,
                         int vectorSize)
Creates a new IntMultiField with specified label text and number of elements.

Parameters:
labelText - text for the control label
vectorSize - number of elements in the vector

IntegerMultiField

public IntegerMultiField(java.lang.String labelText,
                         int[] initialValue,
                         java.lang.String fmtStr)
Creates a new IntMultiField with specified label text and initial value. A format string is provided which specifies how to convert numeric values to text.

Parameters:
labelText - text for the control label
initialValue - initial value for the vector
fmtStr - format string (printf style; see setFormat)
Throws:
java.lang.IllegalArgumentException - if the size of initialValue vector does not equal vectorSize

IntegerMultiField

public IntegerMultiField(java.lang.String labelText,
                         java.lang.String[] fieldLabels,
                         int[] initialValue,
                         java.lang.String fmtStr,
                         int ncols)
Creates a new IntMultiField with specified label text, labels for each field, and initial value. A format string is provided which specifies how to convert numeric values to text.

Parameters:
labelText - text for the control label
fieldLabels - labels for each field
initialValue - initial value for the vector
fmtStr - format string (printf style; see setFormat)
ncols - column width of each field. The actual field with is roughly equal to this number times the width of a wide character, such as a 'M'.
Throws:
java.lang.IllegalArgumentException - if the number of fieldLabels does not equal the size of the vector as indicated by the initial value.
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 LabeledComponent
Returns:
static information for all exported properties

getResultHolder

public int[] getResultHolder()
Returns the current result holder for this control.

Returns:
result holder
See Also:
setResultHolder(int[])

setResultHolder

public void setResultHolder(int[] 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
Throws:
java.lang.IllegalArgumentException - if holder does not have the same size as the vector associated with this control.
See Also:
getResultHolder()

getVectorSize

public int getVectorSize()
Returns the size of the vector value associated with this control.

Returns:
size of this control's vector value.

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 integer values (i.e., one of "dox").

Parameters:
fmtStr - format specification string
See Also:
LabeledMultiTextField.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 integer values (i.e., one of "dox").

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

getValue

public double getValue(int idx)

getVectorValue

public int[] getVectorValue()

getMinimum

public int getMinimum()
Gets the minimum value associated with this control.

Returns:
minimum control value
See Also:
setRange(int, int)

getMaximum

public int getMaximum()
Gets the maximum value associated with this control.

Returns:
maximum control value
See Also:
setRange(int, int)

setRange

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

Parameters:
min - minimum value
max - maximum value
See Also:
getMaximum(), getMinimum()

setRange

public void setRange(IntegerInterval range)

getRange

public IntegerInterval getRange()

textToValue

public java.lang.Object textToValue(java.lang.String[] text,
                                    boolean[] corrected,
                                    StringHolder errMsg)

setGUIVoidEnabled

public void setGUIVoidEnabled(boolean enable)