- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- javax.swing.JSpinner.DefaultEditor
-
- All Implemented Interfaces:
ImageObserver,LayoutManager,MenuContainer,PropertyChangeListener,Serializable,EventListener,Accessible,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 aJFormattedTextField. Subclasses can configure theJFormattedTextFieldto create an editor that's appropriate for the type of model they support and they may want to override thestateChangedandpropertyChangedmethods, which keep the model and the text field in sync.This class defines a
dismissmethod that removes the editorsChangeListenerfrom theJSpinnerthat it's part of. ThesetEditormethod knows aboutDefaultEditor.dismiss, so if the developer replaces an editor that's derived fromJSpinner.DefaultEditoritsChangeListenerconnection back to theJSpinnerwill be removed. However after that, it's up to the developer to manage their editor listeners. Similarly, if a subclass overridescreateEditor, it's up to the subclasser to deal with their editor subsequently being replaced (withsetEditor). We expect that in most cases, and in editor installed withsetEditoror created by acreateEditoroverride, will not be replaced anyway.This class is the
LayoutManagerfor it's singleJFormattedTextFieldchild. By default the child is just centered with the parents insets.- Since:
- 1.4
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces declared in class javax.swing.JPanel
JPanel.AccessibleJPanel
-
Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponent
-
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
-
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
-
Field Summary
-
Fields declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
-
Fields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
-
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
-
Constructor Summary
Constructors Constructor Description DefaultEditor(JSpinner spinner)Constructs an editor component for the specifiedJSpinner.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddLayoutComponent(String name, Component child)ThisLayoutManagermethod does nothing.voidcommitEdit()Pushes the currently edited value to theSpinnerModel.voiddismiss(JSpinner spinner)Disconnectthiseditor from the specifiedJSpinner.intgetBaseline(int width, int height)Returns the baseline.Component.BaselineResizeBehaviorgetBaselineResizeBehavior()Returns an enum indicating how the baseline of the component changes as the size changes.JSpinnergetSpinner()Returns theJSpinnerancestor of this editor ornullif none of the ancestors are aJSpinner.JFormattedTextFieldgetTextField()Returns theJFormattedTextFieldchild of this editor.voidlayoutContainer(Container parent)Resize the one (and only) child to completely fill the area within the parents insets.DimensionminimumLayoutSize(Container parent)Returns the minimum size of first (and only) child plus the size of the parents insets.DimensionpreferredLayoutSize(Container parent)Returns the preferred size of first (and only) child plus the size of the parents insets.voidpropertyChange(PropertyChangeEvent e)Called by theJFormattedTextFieldPropertyChangeListener.voidremoveLayoutComponent(Component child)ThisLayoutManagermethod does nothing.voidstateChanged(ChangeEvent e)This method is called when the spinner's model's state changes.-
Methods declared in class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
-
Methods declared in class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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
-
Methods declared in class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
-
Methods declared in class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Constructor Detail
-
DefaultEditor
public DefaultEditor(JSpinner spinner)
Constructs an editor component for the specifiedJSpinner. ThisDefaultEditoris it's own layout manager and it is added to the spinner'sChangeListenerlist. The constructor creates a singleJFormattedTextFieldchild, initializes it's value to be the spinner model's current value and adds it tothisDefaultEditor.- Parameters:
spinner- the spinner whose modelthiseditor will monitor- See Also:
getTextField(),JSpinner.addChangeListener(javax.swing.event.ChangeListener)
-
-
Method Detail
-
dismiss
public void dismiss(JSpinner spinner)
Disconnectthiseditor from the specifiedJSpinner. By default, this method removes itself from the spinnersChangeListenerlist.- Parameters:
spinner- theJSpinnerto disconnect this editor from; the same spinner as was passed to the constructor.
-
getSpinner
public JSpinner getSpinner()
Returns theJSpinnerancestor of this editor ornullif none of the ancestors are aJSpinner. Typically the editor's parent is aJSpinnerhowever subclasses ofJSpinnermay override the thecreateEditormethod and insert one or more containers between theJSpinnerand it's editor.- Returns:
JSpinnerancestor;nullif none of the ancestors are aJSpinner- See Also:
JSpinner.createEditor(javax.swing.SpinnerModel)
-
getTextField
public JFormattedTextField getTextField()
Returns theJFormattedTextFieldchild of this editor. By default the text field is the first and only child of editor.- Returns:
- the
JFormattedTextFieldthat gives the user access to theSpinnerDateModel'svalue. - See Also:
getSpinner(),JSpinner.getModel()
-
stateChanged
public void stateChanged(ChangeEvent e)
This method is called when the spinner's model's state changes. It sets thevalueof the text field to the current value of the spinners model.- Specified by:
stateChangedin interfaceChangeListener- Parameters:
e- theChangeEventwhose source is theJSpinnerwhose model has changed.- See Also:
getTextField(),JSpinner.getValue()
-
propertyChange
public void propertyChange(PropertyChangeEvent e)
Called by theJFormattedTextFieldPropertyChangeListener. 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
PropertyChangeEventswhose source is not theJFormattedTextField, so subclasses may safely makethisDefaultEditoraPropertyChangeListeneron other objects.- Specified by:
propertyChangein interfacePropertyChangeListener- Parameters:
e- thePropertyChangeEventwhose source is theJFormattedTextFieldcreated by this class.- See Also:
getTextField()
-
addLayoutComponent
public void addLayoutComponent(String name, Component child)
ThisLayoutManagermethod does nothing. We're only managing a single child and there's no support for layout constraints.- Specified by:
addLayoutComponentin interfaceLayoutManager- Parameters:
name- ignoredchild- ignored
-
removeLayoutComponent
public void removeLayoutComponent(Component child)
ThisLayoutManagermethod does nothing. There isn't any per-child state.- Specified by:
removeLayoutComponentin interfaceLayoutManager- Parameters:
child- ignored
-
preferredLayoutSize
public Dimension preferredLayoutSize(Container parent)
Returns the preferred size of first (and only) child plus the size of the parents insets.- Specified by:
preferredLayoutSizein interfaceLayoutManager- Parameters:
parent- the Container that's managing the layout- Returns:
- the preferred dimensions to lay out the subcomponents of the specified container.
- See Also:
LayoutManager.minimumLayoutSize(java.awt.Container)
-
minimumLayoutSize
public Dimension minimumLayoutSize(Container parent)
Returns the minimum size of first (and only) child plus the size of the parents insets.- Specified by:
minimumLayoutSizein interfaceLayoutManager- Parameters:
parent- the Container that's managing the layout- Returns:
- the minimum dimensions needed to lay out the subcomponents of the specified container.
- See Also:
LayoutManager.preferredLayoutSize(java.awt.Container)
-
layoutContainer
public void layoutContainer(Container parent)
Resize the one (and only) child to completely fill the area within the parents insets.- Specified by:
layoutContainerin interfaceLayoutManager- Parameters:
parent- the container to be laid out
-
commitEdit
public void commitEdit() throws ParseExceptionPushes the currently edited value to theSpinnerModel.The default implementation invokes
commitEditon theJFormattedTextField.- Throws:
ParseException- if the edited value is not legal
-
getBaseline
public int getBaseline(int width, int height)Returns the baseline.- Overrides:
getBaselinein classJComponent- Parameters:
width- the width to get the baseline forheight- the height to get the baseline for- Returns:
- the baseline or < 0 indicating there is no reasonable baseline
- Throws:
IllegalArgumentException- if width or height is < 0- Since:
- 1.6
- See Also:
JComponent.getBaseline(int,int),JComponent.getBaselineResizeBehavior()
-
getBaselineResizeBehavior
public Component.BaselineResizeBehavior getBaselineResizeBehavior()
Returns an enum indicating how the baseline of the component changes as the size changes.- Overrides:
getBaselineResizeBehaviorin classJComponent- Returns:
- an enum indicating how the baseline changes as the component size changes
- Throws:
NullPointerException- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
-