public class BasicSpinnerUI extends SpinnerUI
The default Spinner UI delegate.
protected JSpinner spinner
The spinner that we're a UI delegate for. Initialized by the installUI
method, and reset to null by uninstallUI
.
public BasicSpinnerUI()
public static ComponentUI createUI(JComponent c)
Returns a new instance of BasicSpinnerUI. SpinnerListUI delegates are allocated one per JSpinner.
c
- the JSpinner (not used)ComponentUI.createUI(javax.swing.JComponent)
public void installUI(JComponent c)
Calls installDefaults
, installListeners
, and then adds the components returned by createNextButton
, createPreviousButton
, and createEditor
.
installUI
in class ComponentUI
c
- the JSpinnerinstallDefaults()
, installListeners()
, createNextButton()
, createPreviousButton()
, createEditor()
public void uninstallUI(JComponent c)
Calls uninstallDefaults
, uninstallListeners
, and then removes all of the spinners children.
uninstallUI
in class ComponentUI
c
- the JSpinner (not used)ComponentUI.installUI(javax.swing.JComponent)
, JComponent.updateUI()
protected void installListeners()
Initializes PropertyChangeListener
with a shared object that delegates interesting PropertyChangeEvents to protected methods.
This method is called by installUI
.
protected void uninstallListeners()
Removes the PropertyChangeListener
added by installListeners.
This method is called by uninstallUI
.
installListeners()
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
.
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)
protected void uninstallDefaults()
Sets the JSpinner's
layout manager to null. This method is called by uninstallUI
.
protected void installNextButtonListeners(Component c)
Installs the necessary listeners on the next button, c
, to update the JSpinner
in response to a user gesture.
c
- Component to install the listeners onNullPointerException
- if c
is null.createNextButton()
protected void installPreviousButtonListeners(Component c)
Installs the necessary listeners on the previous button, c
, to update the JSpinner
in response to a user gesture.
c
- Component to install the listeners on.NullPointerException
- if c
is null.createPreviousButton()
protected LayoutManager createLayout()
Creates 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.
createNextButton()
, createPreviousButton()
, createEditor()
protected PropertyChangeListener createPropertyChangeListener()
Creates 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
.
installListeners()
protected Component createPreviousButton()
Creates a decrement button, i.e. component that replaces the spinner value with the object returned by spinner.getPreviousValue
. By default the previousButton
is a JButton
. If the decrement button is not needed this method should return null
.
null
installUI(javax.swing.JComponent)
, createNextButton()
, installPreviousButtonListeners(java.awt.Component)
protected Component createNextButton()
Creates an increment button, i.e. component that replaces the spinner value with the object returned by spinner.getNextValue
. By default the nextButton
is a JButton
. If the increment button is not needed this method should return null
.
null
installUI(javax.swing.JComponent)
, createPreviousButton()
, installNextButtonListeners(java.awt.Component)
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.
installUI(javax.swing.JComponent)
, replaceEditor(javax.swing.JComponent, javax.swing.JComponent)
, JSpinner.getEditor()
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. createEditor()
, createPropertyChangeListener()
protected void installKeyboardActions()
Installs the keyboard Actions onto the JSpinner.
public int getBaseline(JComponent c, int width, int height)
Returns the baseline.
getBaseline
in class ComponentUI
c
- JComponent
baseline is being requested forwidth
- the width to get the baseline forheight
- the height to get the baseline forNullPointerException
- if c
is null
IllegalArgumentException
- if width or height is < 0JComponent.getBaseline(int, int)
public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.
getBaselineResizeBehavior
in class ComponentUI
c
- JComponent
to return baseline resize behavior forNullPointerException
- if c
is null
JComponent.getBaseline(int, int)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.