javax.swing.plaf.basic
Class BasicSpinnerUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      javax.swing.plaf.SpinnerUI
          javax.swing.plaf.basic.BasicSpinnerUI

public class BasicSpinnerUI

extends SpinnerUI

The default Spinner UI delegate.

Since:

1.4

Author:

Hans Muller

Nested Class Summary

private static class	BasicSpinnerUI.ArrowButtonHandler A handler for spinner arrow button mouse and action events.
private static class	BasicSpinnerUI.PropertyChangeHandler Detect JSpinner property changes we're interested in and delegate.
private static class	BasicSpinnerUI.SpinnerLayout A simple layout manager for the editor and the next/previous buttons.

Field Summary

private static BasicSpinnerUI.ArrowButtonHandler	nextButtonHandler The mouse/action listeners that are added to the spinner's arrow buttons.
private static BasicSpinnerUI.ArrowButtonHandler	previousButtonHandler
private static java.beans.PropertyChangeListener	propertyChangeListener The PropertyChangeListener that's added to the JSpinner itself.
protected JSpinner	spinner The spinner that we're a UI delegate for.
private static Dimension	zeroSize Used by the default LayoutManager class - SpinnerLayout for missing (null) editor/nextButton/previousButton children.

Constructor Summary

BasicSpinnerUI()

Method Summary

private ActionMap	createActionMap()
private Component	createArrowButton(int direction, BasicSpinnerUI.ArrowButtonHandler handler)
protected JComponent	createEditor() This method is called by installUI to get the editor component of the JSpinner.
protected LayoutManager	createLayout() Create a LayoutManager that manages the editor, nextButton, and previousButton children of the JSpinner.
protected Component	createNextButton() Create a component that will replace the spinner models value with the object returned by spinner.getNextValue.
protected Component	createPreviousButton() Create a component that will replace the spinner models value with the object returned by spinner.getPreviousValue.
protected java.beans.PropertyChangeListener	createPropertyChangeListener() Create a PropertyChangeListener that can be added to the JSpinner itself.
static ComponentUI	createUI(JComponent c) Returns a new instance of BasicSpinnerUI.
private ActionMap	getActionMap()
private InputMap	getInputMap(int condition) Returns the InputMap to install for condition.
protected void	installDefaults() Initialize the JSpinner border, foreground, and background, properties based on the corresponding "Spinner.*" properties from defaults table.
private void	installEditorBorderListener(JComponent editor) Remove the border around the inner editor component for LaFs that install an outside border around the spinner,
private void	installKeyboardActions() Installs the KeyboardActions onto the JSpinner.
protected void	installListeners() Initializes propertyChangeListener with a shared object that delegates interesting PropertyChangeEvents to protected methods.
void	installUI(JComponent c) Calls installDefaults, installListeners, and then adds the components returned by createNextButton, createPreviousButton, and createEditor.
private void	maybeAdd(Component c, String s)
private void	maybeRemoveEditorBorder(JComponent editor) Remove the border around the inner editor component for LaFs that install an outside border around the spinner,
private void	removeEditorBorderListener(JComponent editor)
protected void	replaceEditor(JComponent oldEditor, JComponent newEditor) Called by the PropertyChangeListener when the JSpinner editor property changes.
protected void	uninstallDefaults() Sets the JSpinner's layout manager to null.
protected void	uninstallListeners() Removes the propertyChangeListener added by installListeners.
void	uninstallUI(JComponent c) Calls uninstallDefaults, uninstallListeners, and then removes all of the spinners children.
private void	updateEnabledState() Updates the enabled state of the children Components based on the enabled state of the JSpinner.
private void	updateEnabledState(Container c, boolean enabled) Recursively updates the enabled state of the child Components of c.

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, getPreferredSize, paint, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

spinner

protected JSpinner spinner

The spinner that we're a UI delegate for. Initialized by the installUI method, and reset to null by uninstallUI.

See Also:

installUI(javax.swing.JComponent), uninstallUI(javax.swing.JComponent)

propertyChangeListener

private static final java.beans.PropertyChangeListener propertyChangeListener

The PropertyChangeListener that's added to the JSpinner itself. This listener is created by the createPropertyChangeListener method, added by the installListeners method, and removed by the uninstallListeners method.

One instance of this listener is shared by all JSpinners.

See Also:

createPropertyChangeListener(), installListeners(), uninstallListeners()

nextButtonHandler

private static final BasicSpinnerUI.ArrowButtonHandler nextButtonHandler

The mouse/action listeners that are added to the spinner's arrow buttons. These listeners are shared by all spinner arrow buttons.

See Also:

createNextButton(), createPreviousButton()

previousButtonHandler

private static final BasicSpinnerUI.ArrowButtonHandler previousButtonHandler

zeroSize

private static final Dimension zeroSize

Used by the default LayoutManager class - SpinnerLayout for missing (null) editor/nextButton/previousButton children.

Constructor Detail

BasicSpinnerUI

public BasicSpinnerUI()

Method Detail

createUI

public static ComponentUI createUI(JComponent c)

Returns a new instance of BasicSpinnerUI. SpinnerListUI delegates are allocated one per JSpinner.

Parameters:

c - the JSpinner (not used)

Returns:

a new BasicSpinnerUI object

See Also:

ComponentUI.createUI(javax.swing.JComponent)

maybeAdd

private void maybeAdd(Component c,
                      String s)

installUI

public void installUI(JComponent c)

Calls installDefaults, installListeners, and then adds the components returned by createNextButton, createPreviousButton, and createEditor.

Overrides:

installUI in class ComponentUI

Parameters:

c - the JSpinner

See Also:

installDefaults(), installListeners(), createNextButton(), createPreviousButton(), createEditor()

uninstallUI

public void uninstallUI(JComponent c)

Calls uninstallDefaults, uninstallListeners, and then removes all of the spinners children.

Overrides:

uninstallUI in class ComponentUI

Parameters:

c - the JSpinner (not used)

See Also:

ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()

installListeners

protected void installListeners()

Initializes propertyChangeListener with a shared object that delegates interesting PropertyChangeEvents to protected methods.

This method is called by installUI.

See Also:

replaceEditor(javax.swing.JComponent, javax.swing.JComponent), uninstallListeners()

uninstallListeners

protected void uninstallListeners()

Removes the propertyChangeListener added by installListeners.

This method is called by uninstallUI.

See Also:

installListeners()

installDefaults

protected void installDefaults()

Initialize the JSpinner border, foreground, and background, properties based on the corresponding "Spinner.*" properties from defaults table. The JSpinners layout is set to the value returned by createLayout. This method is called by installUI.

See Also:

uninstallDefaults(), installUI(javax.swing.JComponent), createLayout(), LookAndFeel.installBorder(javax.swing.JComponent, java.lang.String), LookAndFeel.installColors(javax.swing.JComponent, java.lang.String, java.lang.String)

uninstallDefaults

protected void uninstallDefaults()

Sets the JSpinner's layout manager to null. This method is called by uninstallUI.

See Also:

installDefaults(), uninstallUI(javax.swing.JComponent)

createLayout

protected LayoutManager createLayout()

Create a LayoutManager that manages the editor, nextButton, and previousButton children of the JSpinner. These three children must be added with a constraint that identifies their role: "Editor", "Next", and "Previous". The default layout manager can handle the absence of any of these children.

Returns:

a LayoutManager for the editor, next button, and previous button.

See Also:

createNextButton(), createPreviousButton(), createEditor()

createPropertyChangeListener

protected java.beans.PropertyChangeListener createPropertyChangeListener()

Create a PropertyChangeListener that can be added to the JSpinner itself. Typically, this listener will call replaceEditor when the "editor" property changes, since it's the SpinnerUI's responsibility to add the editor to the JSpinner (and remove the old one). This method is called by installListeners.

Returns:

A PropertyChangeListener for the JSpinner itself

See Also:

installListeners()

createPreviousButton

protected Component createPreviousButton()

Create a component that will replace the spinner models value with the object returned by spinner.getPreviousValue. By default the previousButton is a JButton who's ActionListener updates it's JSpinner ancestors model. If a previousButton isn't needed (in a subclass) then override this method to return null.

Returns:

a component that will replace the spinners model with the next value in the sequence, or null

See Also:

installUI(javax.swing.JComponent), createNextButton()

createNextButton

protected Component createNextButton()

Create a component that will replace the spinner models value with the object returned by spinner.getNextValue. By default the nextButton is a JButton who's ActionListener updates it's JSpinner ancestors model. If a nextButton isn't needed (in a subclass) then override this method to return null.

Returns:

a component that will replace the spinners model with the next value in the sequence, or null

See Also:

installUI(javax.swing.JComponent), createPreviousButton()

createArrowButton

private Component createArrowButton(int direction,
                                    BasicSpinnerUI.ArrowButtonHandler handler)

createEditor

protected JComponent createEditor()

This method is called by installUI to get the editor component of the JSpinner. By default it just returns JSpinner.getEditor(). Subclasses can override createEditor to return a component that contains the spinner's editor or null, if they're going to handle adding the editor to the JSpinner in an installUI override.

Typically this method would be overridden to wrap the editor with a container with a custom border, since one can't assume that the editors border can be set directly.

The replaceEditor method is called when the spinners editor is changed with JSpinner.setEditor. If you've overriden this method, then you'll probably want to override replaceEditor as well.

Returns:

the JSpinners editor JComponent, spinner.getEditor() by default

See Also:

installUI(javax.swing.JComponent), replaceEditor(javax.swing.JComponent, javax.swing.JComponent), JSpinner.getEditor()

replaceEditor

protected void replaceEditor(JComponent oldEditor,
                             JComponent newEditor)

Called by the PropertyChangeListener when the JSpinner editor property changes. It's the responsibility of this method to remove the old editor and add the new one. By default this operation is just:

 spinner.remove(oldEditor);
 spinner.add(newEditor, "Editor");
 

The implementation of replaceEditor should be coordinated with the createEditor method.

See Also:

createEditor(), createPropertyChangeListener()

maybeRemoveEditorBorder

private void maybeRemoveEditorBorder(JComponent editor)

Remove the border around the inner editor component for LaFs that install an outside border around the spinner,

installEditorBorderListener

private void installEditorBorderListener(JComponent editor)

Remove the border around the inner editor component for LaFs that install an outside border around the spinner,

removeEditorBorderListener

private void removeEditorBorderListener(JComponent editor)

updateEnabledState

private void updateEnabledState()

Updates the enabled state of the children Components based on the enabled state of the JSpinner.

updateEnabledState

private void updateEnabledState(Container c,
                                boolean enabled)

Recursively updates the enabled state of the child Components of c.

installKeyboardActions

private void installKeyboardActions()

Installs the KeyboardActions onto the JSpinner.

getInputMap

private InputMap getInputMap(int condition)

Returns the InputMap to install for condition.

getActionMap

private ActionMap getActionMap()

createActionMap

private ActionMap createActionMap()