maspack.widgets

Class LabeledTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

maspack.widgets.LabeledComponentBase

maspack.widgets.LabeledComponent

maspack.widgets.LabeledControl

maspack.widgets.LabeledTextField

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:

AxisAngleField, ClassField, ComponentPropertyField, DoubleField, GridResolutionField, IntegerField, ScaleField, StringField, VectorField, VectoriField

public abstract class LabeledTextField
extends LabeledControl

A LabeledControl that uses a JTextField to input its data.

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

Fields

Modifier and Type	Field and Description
static int	MAX_COLUMNS
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

Constructors

Constructor and Description
LabeledTextField(java.lang.String label, int ncols)

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
int	getColumns() Gets the number of visible columns in this component's text field.
java.lang.String	getDefaultFormat() Returns the default format string used to convert numeric values into text.
boolean	getEnterValueOnFocusLost() Queries whether the current field value is ``entered'' when focus is lost.
java.lang.String	getFormat() Returns the format string used to convert numeric values into text.
Range	getFormatRange()
java.lang.String	getText() Returns the current text stored in this control's JTextField.
javax.swing.JTextField	getTextField() Returns the JTextField associated with this control.
boolean	lastEntryWasAccepted() Returns true if the most recent text entry to this field was accepted, either directly, or by substituting a corrected value.
void	setColumns(int numc) Sets the number of visible columns in this component's text field.
void	setEnterValueOnFocusLost(boolean enable) Sets whether the current field value is ``entered'' when focus is lost.
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.

Methods inherited from class maspack.widgets.LabeledControl

addValueChangeListener, addValueCheckListener, clearValueChangeListeners, 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, isScanning, isSelected, setBackgroundColor, setLabelFontColor, setLabelFontColor, setScanning, 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, hide, 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, 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, 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, transferFocusBackward, 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

MAX_COLUMNS

public static int MAX_COLUMNS

myProps

public static PropertyList myProps

Constructor Detail

LabeledTextField

public LabeledTextField(java.lang.String label,
                        int ncols)

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

getTextField

public javax.swing.JTextField getTextField()

Returns the JTextField associated with this control.

Returns:

text field for this control

getText

public java.lang.String getText()

Returns the current text stored in this control's JTextField.

Returns:

current text value

lastEntryWasAccepted

public boolean lastEntryWasAccepted()

Returns true if the most recent text entry to this field was accepted, either directly, or by substituting a corrected 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.

Parameters:

fmtStr - format specification string

Throws:

java.lang.IllegalArgumentException - if the format string syntax is invalid

See Also:

getFormat()

setFormat

public void setFormat(NumberFormat fmt)

Directly sets the formatter used used to convert numeric values into text.

Parameters:

fmt - numeric formatter

See Also:

getFormat(), setFormat(String)

getFormatRange

public Range getFormatRange()

getFormat

public java.lang.String getFormat()

Returns the format string used to convert numeric values into text. See setFormat for more details.

Returns:

numeric formatter

See Also:

setFormat(java.lang.String)

getDefaultFormat

public java.lang.String getDefaultFormat()

Returns the default format string used to convert numeric values into text. This the value that will be returned by getFormat() if setFormat() has not been called.

Returns:

default numeric formatter

See Also:

setFormat(java.lang.String)

getColumns

public int getColumns()

Gets the number of visible columns in this component's text field.

Returns:

number of columns

See Also:

setColumns(int)

setColumns

public void setColumns(int numc)

Sets the number of visible columns in this component's text field.

Parameters:

numc - number of columns

See Also:

getColumns()

getEnterValueOnFocusLost

public boolean getEnterValueOnFocusLost()

Queries whether the current field value is ``entered'' when focus is lost.

Returns:

true if value entered when focus is lost

setEnterValueOnFocusLost

public void setEnterValueOnFocusLost(boolean enable)

Sets whether the current field value is ``entered'' when focus is lost. The default value is true.

Parameters:

enable - if true, values will be entered when focus is lost