This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.swing
class JSpinner.DefaultEditor
- All Implemented Interfaces:
- LayoutManager, MenuContainer, ImageObserver, PropertyChangeListener, Serializable, Accessible, TransferHandler.HasGetTransferHandler, ChangeListener
- Direct Known Subclasses:
- JSpinner.DateEditor, JSpinner.ListEditor, JSpinner.NumberEditor
- Enclosing class:
- JSpinner
public static class JSpinner.DefaultEditor
extends JPanel
implements ChangeListener, PropertyChangeListener, LayoutManager
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.
Constructor Summary |
Constructs an editor component for the specified JSpinner .
|
Method Summary |
void |
This LayoutManager method does nothing.
|
void |
Pushes the currently edited value to the SpinnerModel .
|
void |
Disconnect this editor from the specified
JSpinner .
|
int |
Returns the baseline.
|
Component.BaselineResizeBehavior |
Returns an enum indicating how the baseline of the component
changes as the size changes.
|
JSpinner |
Returns the JSpinner ancestor of this editor or
null if none of the ancestors are a
JSpinner .
|
JFormattedTextField |
Returns the JFormattedTextField child of this
editor.
|
void |
Resize the one (and only) child to completely fill the area
within the parents insets.
|
Dimension |
Returns the minimum size of first (and only) child plus the
size of the parents insets.
|
Dimension |
Returns the preferred size of first (and only) child plus the
size of the parents insets.
|
void |
Called by the JFormattedTextField
PropertyChangeListener .
|
void |
This LayoutManager method does nothing.
|
void |
This method is called when the spinner's model's state changes.
|
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, update, updateUI |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JSpinner.DefaultEditor
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
addLayoutComponent
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
commitEdit
public void commitEdit()
throws ParseException
-
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
dismiss
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.
getBaseline
public int getBaseline(int width,
int height)
-
Returns the baseline.
- Overrides:
getBaseline
in class JComponent
- Parameters:
width
height
getBaselineResizeBehavior
public Component.BaselineResizeBehavior getBaselineResizeBehavior()
-
Returns an enum indicating how the baseline of the component
changes as the size changes.
- Overrides:
getBaselineResizeBehavior
in class JComponent
getSpinner
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
getTextField
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.
layoutContainer
public void layoutContainer(Container parent)
-
Resize the one (and only) child to completely fill the area
within the parents insets.
- Parameters:
parent
minimumLayoutSize
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.
preferredLayoutSize
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.
propertyChange
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.
removeLayoutComponent
public void removeLayoutComponent(Component child)
-
This
LayoutManager
method does nothing. There
isn't any per-child state.
- Parameters:
child
- ignored
stateChanged
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.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.