Module java.desktop
Package javax.swing

Class JSpinner

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible
    @JavaBean(defaultProperty="UI",
          description="A single line input field that lets the user select a number or an object value from an ordered set.")
public class JSpinner
extends JComponent
implements Accessible
    A single line input field that lets the user select a number or an object value from an ordered sequence. Spinners typically provide a pair of tiny arrow buttons for stepping through the elements of the sequence. The keyboard up/down arrow keys also cycle through the elements. The user may also be allowed to type a (legal) value directly into the spinner. Although combo boxes provide similar functionality, spinners are sometimes preferred because they don't require a drop down list that can obscure important data.

    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 JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

    Since:
    1.4
    See Also:
    SpinnerModel, AbstractSpinnerModel, SpinnerListModel, SpinnerNumberModel, SpinnerDateModel, JFormattedTextField, Serialized Form

    • Constructor Detail

      • JSpinner

        public JSpinner​(SpinnerModel model)
        Constructs a spinner for the given model. The spinner has a set of previous/next buttons, and an editor appropriate for the model.
        Parameters:
        model - a model for the new spinner
        Throws:
        NullPointerException - if the model is null

      • JSpinner

        public JSpinner()
        Constructs a spinner with an Integer SpinnerNumberModel with initial value 0 and no minimum or maximum limits.

    • Method Detail

      • getUI

        public SpinnerUI getUI()
        Returns the look and feel (L&F) object that renders this component.
        Overrides:
        getUI in class JComponent
        Returns:
        the SpinnerUI object that renders this component

      • createEditor

        protected JComponent createEditor​(SpinnerModel model)
        This method is called by the constructors to create the 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
        • all others => JSpinner.DefaultEditor

        Parameters:
        model - the value of getModel
        Returns:
        a component that displays the current value of the sequence
        See Also:
        getModel(), setEditor(javax.swing.JComponent)

      • getValue

        public Object getValue()
        Returns the current value of the model, typically this value is displayed by the 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()

        Returns:
        the current value of the model
        See Also:
        setValue(java.lang.Object), SpinnerModel.getValue()

      • setValue

        public void setValue​(Object value)
        Changes current value of the model, typically this value is displayed by the 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)

        Parameters:
        value - new value for the spinner
        Throws:
        IllegalArgumentException - if value isn't allowed
        See Also:
        getValue(), SpinnerModel.setValue(java.lang.Object)

      • getNextValue

        @BeanProperty(bound=false)
public Object getNextValue()
        Returns the object in the sequence that comes after the object returned by 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()

        Returns:
        the next legal value or null if one doesn't exist
        See Also:
        getValue(), getPreviousValue(), SpinnerModel.getNextValue()

      • addChangeListener

        public void addChangeListener​(ChangeListener listener)
        Adds a listener to the list that is notified each time a change to the model occurs. The source of 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.
        Parameters:
        listener - the ChangeListener to add
        See Also:
        removeChangeListener(javax.swing.event.ChangeListener), getModel()

      • getChangeListeners

        @BeanProperty(bound=false)
public ChangeListener[] getChangeListeners()
        Returns an array of all the ChangeListeners added to this JSpinner with addChangeListener().
        Returns:
        all of the ChangeListeners added or an empty array if no listeners have been added
        Since:
        1.4

      • getPreviousValue

        @BeanProperty(bound=false)
public Object getPreviousValue()
        Returns the object in the sequence that comes before the object returned by 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()

        Returns:
        the previous legal value or null if one doesn't exist
        See Also:
        getValue(), getNextValue(), SpinnerModel.getPreviousValue()

      • commitEdit

        public void commitEdit()
                throws ParseException
        Commits the currently edited value to the SpinnerModel.

        If the editor is an instance of DefaultEditor, the call if forwarded to the editor, otherwise this does nothing.

        Throws:
        ParseException - if the currently edited value couldn't be committed.