public class JSpinner extends JComponent implements Accessible
A JSpinner's sequence value is defined by its
SpinnerModel.
The model can be specified as a constructor argument and
changed with the model property. SpinnerModel
classes for some common types are provided: SpinnerListModel,
SpinnerNumberModel, and SpinnerDateModel.
A JSpinner has a single child component that's
responsible for displaying
and potentially changing the current element or value of
the model, which is called the editor. The editor is created
by the JSpinner's constructor and can be changed with the
editor property. The JSpinner's editor stays
in sync with the model by listening for ChangeEvents. If the
user has changed the value displayed by the editor it is
possible for the model's value to differ from that of
the editor. To make sure the model has the same
value as the editor use the commitEdit method, eg:
try {
spinner.commitEdit();
}
catch (ParseException pe) {{
// Edited value is invalid, spinner.getValue() will return
// the last valid value, you could revert the spinner to show that:
JComponent editor = spinner.getEditor()
if (editor instanceof DefaultEditor) {
((DefaultEditor)editor).getTextField().setValue(spinner.getValue();
}
// reset the value to some known value:
spinner.setValue(fallbackValue);
// or treat the last valid value as the current, in which
// case you don't need to do anything.
}
return spinner.getValue();
For information and examples of using spinner see How to Use Spinners, a section in The Java Tutorial.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
SpinnerModel,
AbstractSpinnerModel,
SpinnerListModel,
SpinnerNumberModel,
SpinnerDateModel,
JFormattedTextField| Modifier and Type | Class and Description |
|---|---|
protected class |
JSpinner.AccessibleJSpinner
AccessibleJSpinner implements accessibility
support for the JSpinner class. |
static class |
JSpinner.DateEditor
An editor for a
JSpinner whose model is a
SpinnerDateModel. |
static class |
JSpinner.DefaultEditor
A simple base class for more specialized editors
that displays a read-only view of the model's current
value with a
JFormattedTextField. |
static class |
JSpinner.ListEditor
An editor for a
JSpinner whose model is a
SpinnerListModel. |
static class |
JSpinner.NumberEditor
An editor for a
JSpinner whose model is a
SpinnerNumberModel. |
JComponent.AccessibleJComponentContainer.AccessibleAWTContainerComponent.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategyaccessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWBOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH| Constructor and Description |
|---|
JSpinner()
Constructs a spinner with an
Integer SpinnerNumberModel
with initial value 0 and no minimum or maximum limits. |
JSpinner(SpinnerModel model)
Constructs a spinner for the given model.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addChangeListener(ChangeListener listener)
Adds a listener to the list that is notified each time a change
to the model occurs.
|
void |
commitEdit()
Commits the currently edited value to the
SpinnerModel. |
protected JComponent |
createEditor(SpinnerModel model)
This method is called by the constructors to create the
JComponent
that displays the current value of the sequence. |
protected void |
fireStateChanged()
Sends a
ChangeEvent, whose source is this
JSpinner, to each ChangeListener. |
AccessibleContext |
getAccessibleContext()
Gets the
AccessibleContext for the JSpinner |
ChangeListener[] |
getChangeListeners()
Returns an array of all the
ChangeListeners added
to this JSpinner with addChangeListener(). |
JComponent |
getEditor()
Returns the component that displays and potentially
changes the model's value.
|
SpinnerModel |
getModel()
Returns the
SpinnerModel that defines
this spinners sequence of values. |
Object |
getNextValue()
Returns the object in the sequence that comes after the object returned
by
getValue(). |
Object |
getPreviousValue()
Returns the object in the sequence that comes
before the object returned by
getValue(). |
SpinnerUI |
getUI()
Returns the look and feel (L&F) object that renders this component.
|
String |
getUIClassID()
Returns the suffix used to construct the name of the look and feel
(L&F) class used to render this component.
|
Object |
getValue()
Returns the current value of the model, typically
this value is displayed by the
editor. |
void |
removeChangeListener(ChangeListener listener)
Removes a
ChangeListener from this spinner. |
void |
setEditor(JComponent editor)
Changes the
JComponent that displays the current value
of the SpinnerModel. |
void |
setModel(SpinnerModel model)
Changes the model that represents the value of this spinner.
|
void |
setUI(SpinnerUI ui)
Sets the look and feel (L&F) object that renders this component.
|
void |
setValue(Object value)
Changes current value of the model, typically
this value is displayed by the
editor. |
void |
updateUI()
Resets the UI property with the value from the current look and feel.
|
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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, updateadd, 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, validateTreeaction, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, 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, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, 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, transferFocusUpCyclepublic JSpinner(SpinnerModel model)
NullPointerException - if the model is nullpublic JSpinner()
Integer SpinnerNumberModel
with initial value 0 and no minimum or maximum limits.public SpinnerUI getUI()
SpinnerUI object that renders this componentpublic void setUI(SpinnerUI ui)
ui - the SpinnerUI L&F objectUIDefaults.getUI(javax.swing.JComponent)public String getUIClassID()
getUIClassID in class JComponentJComponent.getUIClassID(),
UIDefaults.getUI(javax.swing.JComponent)public void updateUI()
updateUI in class JComponentUIManager.getUI(javax.swing.JComponent)protected JComponent createEditor(SpinnerModel model)
JComponent
that displays the current value of the sequence. The editor may
also allow the user to enter an element of the sequence directly.
An editor must listen for ChangeEvents on the
model and keep the value it displays
in sync with the value of the model.
Subclasses may override this method to add support for new
SpinnerModel classes. Alternatively one can just
replace the editor created here with the setEditor
method. The default mapping from model type to editor is:
SpinnerNumberModel => JSpinner.NumberEditor
SpinnerDateModel => JSpinner.DateEditor
SpinnerListModel => JSpinner.ListEditor
JSpinner.DefaultEditor
model - the value of getModelgetModel(),
setEditor(javax.swing.JComponent)public void setModel(SpinnerModel model)
"model"
PropertyChangeEvent has been fired. The editor
property is set to the value returned by createEditor,
as in:
setEditor(createEditor(model));
model - the new SpinnerModelIllegalArgumentException - if model is nullgetModel(),
getEditor(),
setEditor(javax.swing.JComponent)public SpinnerModel getModel()
SpinnerModel that defines
this spinners sequence of values.setModel(javax.swing.SpinnerModel)public Object getValue()
editor. If the
user has changed the value displayed by the editor it is
possible for the model's value to differ from that of
the editor, refer to the class level javadoc for examples
of how to deal with this.
This method simply delegates to the model.
It is equivalent to:
getModel().getValue()
public void setValue(Object value)
editor.
If the SpinnerModel implementation
doesn't support the specified value then an
IllegalArgumentException is thrown.
This method simply delegates to the model.
It is equivalent to:
getModel().setValue(value)
IllegalArgumentException - if value isn't allowedgetValue(),
SpinnerModel.setValue(java.lang.Object)public Object getNextValue()
getValue(). If the end of the sequence has been reached
then return null.
Calling this method does not effect value.
This method simply delegates to the model.
It is equivalent to:
getModel().getNextValue()
null if one doesn't existgetValue(),
getPreviousValue(),
SpinnerModel.getNextValue()public void addChangeListener(ChangeListener listener)
ChangeEvents
delivered to ChangeListeners will be this
JSpinner. Note also that replacing the model
will not affect listeners added directly to JSpinner.
Applications can add listeners to the model directly. In that
case is that the source of the event would be the
SpinnerModel.listener - the ChangeListener to addremoveChangeListener(javax.swing.event.ChangeListener),
getModel()public void removeChangeListener(ChangeListener listener)
ChangeListener from this spinner.listener - the ChangeListener to removefireStateChanged(),
addChangeListener(javax.swing.event.ChangeListener)public ChangeListener[] getChangeListeners()
ChangeListeners added
to this JSpinner with addChangeListener().ChangeListeners added or an empty
array if no listeners have been addedprotected void fireStateChanged()
ChangeEvent, whose source is this
JSpinner, to each ChangeListener.
When a ChangeListener has been added
to the spinner, this method method is called each time
a ChangeEvent is received from the model.public Object getPreviousValue()
getValue().
If the end of the sequence has been reached then
return null. Calling this method does
not effect value.
This method simply delegates to the model.
It is equivalent to:
getModel().getPreviousValue()
null
if one doesn't existgetValue(),
getNextValue(),
SpinnerModel.getPreviousValue()public void setEditor(JComponent editor)
JComponent that displays the current value
of the SpinnerModel. It is the responsibility of this
method to disconnect the old editor from the model and to
connect the new editor. This may mean removing the
old editors ChangeListener from the model or the
spinner itself and adding one for the new editor.editor - the new editorIllegalArgumentException - if editor is nullgetEditor(),
createEditor(javax.swing.SpinnerModel),
getModel()public JComponent getEditor()
setEditor(javax.swing.JComponent),
createEditor(javax.swing.SpinnerModel)public void commitEdit()
throws ParseException
SpinnerModel.
If the editor is an instance of DefaultEditor, the
call if forwarded to the editor, otherwise this does nothing.
ParseException - if the currently edited value couldn't
be commited.public AccessibleContext getAccessibleContext()
AccessibleContext for the JSpinnergetAccessibleContext in interface AccessiblegetAccessibleContext in class JComponentAccessibleContext for the JSpinner Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138