vmm3d.core

Class ParameterInput

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

vmm3d.core.ParameterInput

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

public class ParameterInput
extends javax.swing.JTextField

An input box that lets the user enter a value for a Parameter. A ParameterInput box can be used to get a value for a parameter, or the animation start value or animation end value for an Animateable parameter.

See Also:

Serialized Form

Nested Class Summary

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.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	ANIMATION_END Indicates that this input box is used to input the animation end value for an Animateable parameter.
static int	ANIMATION_START Indicates that this input box is used to input the animation start value for an Animateable parameter.
static int	VALUE Indicates that this input box is used to input a parameter's value.

Fields inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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 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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ParameterInput(Parameter param) Creates a text box for inputting the value of a specified parameter.
ParameterInput(Parameter param, int propertyToInput) Creates a text box for inputting the value, animation start value, or animation end value of a specified parameter.

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkContents() Checks whether the contents of the text box represent a legal value for the parameter.
void	defaultVal() Set the contents of the text box to the appropriate default value, as stored in the Parameter.
Parameter	getParameter() Returns the parameter whose value is input by this ParameterInput.
void	revert() Reset the contents of the text box to its original value.
void	setColumns(int columns) Sets the preferred size to the specified number of columns.
void	setValueAndDefaultFromContents() Sets the parameter's value, animation start value, or animation end value (as appropriate) from the contents of the text box, and also sets the corresponding default for the parameter to the same value.
void	setValueFromContents() Sets the parameter's value, animation start value, or animation end value (as appropriate) from the contents of the text box.

Methods inherited from class javax.swing.JTextField

addActionListener, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, 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, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

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, 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, isPaintingTile, isRequestFocusEnabled, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, 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, 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, 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, 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

Field Detail

VALUE

public static final int VALUE

Indicates that this input box is used to input a parameter's value. This constant is for use in the constructor ParameterInput(Parameter, int).

See Also:

Constant Field Values

ANIMATION_START

public static final int ANIMATION_START

Indicates that this input box is used to input the animation start value for an Animateable parameter. This constant is for use in the constructor ParameterInput(Parameter, int).

See Also:

Constant Field Values

ANIMATION_END

public static final int ANIMATION_END

Indicates that this input box is used to input the animation end value for an Animateable parameter. This constant is for use in the constructor ParameterInput(Parameter, int).

See Also:

Constant Field Values

Constructor Detail

ParameterInput

public ParameterInput(Parameter param)

Creates a text box for inputting the value of a specified parameter.

Parameters:

param - The non-null parameter whose value is to be input.

ParameterInput

public ParameterInput(Parameter param,
                      int propertyToInput)

Creates a text box for inputting the value, animation start value, or animation end value of a specified parameter. Animation start and end values can only be input for animated parameters such as RealParamAnimateable.

Parameters:

param - The non-null parameter whose value or other property is to be input.

propertyToInput - The property of the parameter that is to be input. This must be one of: ParameterInput.VALUE, ParameterInput.ANIMATION_START, or ParameterInput.ANIMATION_END. Illegal vaues have the same effect as ParameterInput.VALUE.

Method Detail

setColumns

public void setColumns(int columns)

Sets the preferred size to the specified number of columns. In addtion, if the content has not been modified and its length is too big for the preferred size, then the content is truncated to a size that will fit in the specified number of columns, if possible. (The content is changed only in the case of a RealParam.)

Overrides:

setColumns in class javax.swing.JTextField

getParameter

public Parameter getParameter()

Returns the parameter whose value is input by this ParameterInput.

checkContents

public java.lang.String checkContents()

Checks whether the contents of the text box represent a legal value for the parameter. Calling this method does not change the value of the parameter.

Returns:

returns null if the string in the text box is a legal value for the parameter, or an error message if the content is not legal

See Also:

setValueFromContents()

setValueFromContents

public void setValueFromContents()

Sets the parameter's value, animation start value, or animation end value (as appropriate) from the contents of the text box. The parameter is not touched if the contents of the text box has not been modified since it was created (or since a previous call to this method or to setValueAndDefaultFromContents(), if there was one). It is assumed that the checkContents method is called before this method is called, so if an error occurs while the value is being set, it is simply ignored and the parameter value is not changed.

See Also:

checkContents()

setValueAndDefaultFromContents

public void setValueAndDefaultFromContents()

Sets the parameter's value, animation start value, or animation end value (as appropriate) from the contents of the text box, and also sets the corresponding default for the parameter to the same value. The parameter is not touched if the contents of the text box has not been modified since it was created (or since a previous call to this method or to setValueFromContents(), if there was one). It is assumed that the checkContents method is called before this method is called, so if an error occurs while the value is being set, it is simply ignored and the parameter value is not changed.

See Also:

checkContents()

revert

public void revert()

Reset the contents of the text box to its original value. The original string is taken from the parameter when this object is constructed.

defaultVal

public void defaultVal()

Set the contents of the text box to the appropriate default value, as stored in the Parameter.