public static class

JSpinner.DefaultEditor

extends JPanel
implements LayoutManager PropertyChangeListener ChangeListener
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.JPanel
           ↳ javax.swing.JSpinner.DefaultEditor
Known Direct Subclasses

Class Overview

A simple base class for more specialized editors that displays a read-only view of the model's current value with a JFormattedTextField. Subclasses can configure the JFormattedTextField to create an editor that's appropriate for the type of model they support and they may want to override the stateChanged and propertyChanged methods, which keep the model and the text field in sync.

This class defines a dismiss method that removes the editors ChangeListener from the JSpinner that it's part of. The setEditor method knows about DefaultEditor.dismiss, so if the developer replaces an editor that's derived from JSpinner.DefaultEditor its ChangeListener connection back to the JSpinner will be removed. However after that, it's up to the developer to manage their editor listeners. Similarly, if a subclass overrides createEditor, it's up to the subclasser to deal with their editor subsequently being replaced (with setEditor). We expect that in most cases, and in editor installed with setEditor or created by a createEditor override, will not be replaced anyway.

This class is the LayoutManager for it's single JFormattedTextField child. By default the child is just centered with the parents insets.

Summary

[Expand]
Inherited Constants
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
[Expand]
Inherited Fields
From class javax.swing.JComponent
Public Constructors
JSpinner.DefaultEditor(JSpinner spinner)
Constructs an editor component for the specified JSpinner.
Public Methods
void addLayoutComponent(String name, Component child)
This LayoutManager method does nothing.
void commitEdit()
Pushes the currently edited value to the SpinnerModel.
void dismiss(JSpinner spinner)
Disconnect this editor from the specified JSpinner.
int getBaseline(int width, int height)
Returns the baseline.
Component.BaselineResizeBehavior getBaselineResizeBehavior()
Returns an enum indicating how the baseline of the component changes as the size changes.
JSpinner getSpinner()
Returns the JSpinner ancestor of this editor or null if none of the ancestors are a JSpinner.
JFormattedTextField getTextField()
Returns the JFormattedTextField child of this editor.
void layoutContainer(Container parent)
Resize the one (and only) child to completely fill the area within the parents insets.
Dimension minimumLayoutSize(Container parent)
Returns the minimum size of first (and only) child plus the size of the parents insets.
Dimension preferredLayoutSize(Container parent)
Returns the preferred size of first (and only) child plus the size of the parents insets.
void propertyChange(PropertyChangeEvent e)
Called by the JFormattedTextField PropertyChangeListener.
void removeLayoutComponent(Component child)
This LayoutManager method does nothing.
void stateChanged(ChangeEvent e)
This method is called when the spinner's model's state changes.
[Expand]
Inherited Methods
From class javax.swing.JPanel
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.LayoutManager
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface java.beans.PropertyChangeListener
From interface javax.accessibility.Accessible
From interface javax.swing.event.ChangeListener

Public Constructors

public JSpinner.DefaultEditor (JSpinner spinner)

Constructs an editor component for the specified JSpinner. This DefaultEditor is it's own layout manager and it is added to the spinner's ChangeListener list. The constructor creates a single JFormattedTextField child, initializes it's value to be the spinner model's current value and adds it to this DefaultEditor.

Parameters
spinner the spinner whose model this editor will monitor

Public Methods

public void addLayoutComponent (String name, Component child)

This LayoutManager method does nothing. We're only managing a single child and there's no support for layout constraints.

Parameters
name ignored
child ignored

public void commitEdit ()

Pushes the currently edited value to the SpinnerModel.

The default implementation invokes commitEdit on the JFormattedTextField.

Throws
ParseException if the edited value is not legal

public void dismiss (JSpinner spinner)

Disconnect this editor from the specified JSpinner. By default, this method removes itself from the spinners ChangeListener list.

Parameters
spinner the JSpinner to disconnect this editor from; the same spinner as was passed to the constructor.

public int getBaseline (int width, int height)

Returns the baseline.

Parameters
width the width to get the baseline for
height the height to get the baseline for
Returns
  • the baseline or < 0 indicating there is no reasonable baseline

public Component.BaselineResizeBehavior getBaselineResizeBehavior ()

Returns an enum indicating how the baseline of the component changes as the size changes.

Returns
  • an enum indicating how the baseline changes as the component size changes

public JSpinner getSpinner ()

Returns the JSpinner ancestor of this editor or null if none of the ancestors are a JSpinner. Typically the editor's parent is a JSpinner however subclasses of JSpinner may override the the createEditor method and insert one or more containers between the JSpinner and it's editor.

Returns
  • JSpinner ancestor; null if none of the ancestors are a JSpinner

public JFormattedTextField getTextField ()

Returns the JFormattedTextField child of this editor. By default the text field is the first and only child of editor.

Returns
  • the JFormattedTextField that gives the user access to the SpinnerDateModel's value.

public void layoutContainer (Container parent)

Resize the one (and only) child to completely fill the area within the parents insets.

Parameters
parent the container to be laid out

public Dimension minimumLayoutSize (Container parent)

Returns the minimum size of first (and only) child plus the size of the parents insets.

Parameters
parent the Container that's managing the layout
Returns
  • the minimum dimensions needed to lay out the subcomponents of the specified container.

public Dimension preferredLayoutSize (Container parent)

Returns the preferred size of first (and only) child plus the size of the parents insets.

Parameters
parent the Container that's managing the layout
Returns
  • the preferred dimensions to lay out the subcomponents of the specified container.

public void propertyChange (PropertyChangeEvent e)

Called by the JFormattedTextField PropertyChangeListener. When the "value" property changes, which implies that the user has typed a new number, we set the value of the spinners model.

This class ignores PropertyChangeEvents whose source is not the JFormattedTextField, so subclasses may safely make this DefaultEditor a PropertyChangeListener on other objects.

Parameters
e the PropertyChangeEvent whose source is the JFormattedTextField created by this class.
See Also

public void removeLayoutComponent (Component child)

This LayoutManager method does nothing. There isn't any per-child state.

Parameters
child ignored

public void stateChanged (ChangeEvent e)

This method is called when the spinner's model's state changes. It sets the value of the text field to the current value of the spinners model.

Parameters
e the ChangeEvent whose source is the JSpinner whose model has changed.