Класс JSpinner

javax.swing.JSpinner

Все реализованные интерфейсы:: ImageObserver, MenuContainer, Serializable, Accessible

@JavaBean(defaultProperty="UI", description="A single line input field that lets the user select a number or an object value from an ordered set.") public class JSpinner extends JComponent implements Accessible

Однострочное поле ввода, которое позволяет пользователю выбирать число или значение объекта из упорядоченной последовательности. Спиннеры обычно предоставляют пару маленьких стрелочных кнопок для перехода по элементам последовательности. Клавиши со стрелками вверх/вниз на клавиатуре также циклически просматривают элементы. Пользователь также может ввести (допустимое) значение напрямую в спиннер. Хотя комбинированные поля (combo boxes) обеспечивают аналогичную функциональность, спиннеры иногда предпочтительнее, так как им не требуется раскрывающееся меню, которое может закрыть важные данные.

Последовательность значений спиннера определяется его моделью. Модель может быть задана в качестве аргумента конструктора и изменена свойством модели. Предоставляются классы-модели для некоторых распространённых типов: SpinnerListModel, SpinnerNumberModel, и SpinnerDateModel.

Спиннер имеет один дочерний компонент, ответственный за отображение и потенциальное изменение текущего элемента или значения модели, который называется редактором. Редактор создаётся конструктором спиннера и может быть изменён свойством редактора. Редактор спиннера синхронизируется с моделью, прослушивая изменения модели. Если пользователь изменил значение, отображаемое редактором, значение спиннера может отличаться от значения модели. Чтобы убедиться, что значение спиннера совпадает со значением редактора, используйте метод commitEdit, например:

   try {
       spinner.commitEdit();
   }
   catch (ParseException pe) {
       // Edited value is invalid, spinner.getValue() will return
       // the last valid value, you could revert the spinner to show that:
       JComponent editor = spinner.getEditor();
       if (editor instanceof DefaultEditor) {
           ((DefaultEditor)editor).getTextField().setValue(spinner.getValue());
       }
       // reset the value to some known value:
       spinner.setValue(fallbackValue);
       // or treat the last valid value as the current, in which
       // case you don't need to do anything.
   }
   return spinner.getValue();

Дополнительную информацию и примеры использования спиннеров см. на странице Как использовать спиннеры в Руководстве по Java.

Предупреждение: Swing не является потокобезопасным. Дополнительную информацию см. на странице Политика потоков Swing.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, поддержка долгосрочного хранения всех JavaBeans была добавлена в пакет java.beans. Обратитесь к XMLEncoder.

Since:

1.4

См. также:

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`protected class`	`JSpinner.AccessibleJSpinner`	`AccessibleJSpinner` реализует поддержку доступности для класса `JSpinner`.
`static class`	`JSpinner.DateEditor`	Редактор для `JSpinner`, модель которого — `SpinnerDateModel`.
`static class`	`JSpinner.DefaultEditor`	Простой базовый класс для более специализированных редакторов, отображающий только для чтения текущее значение модели с `JFormattedTextField`.
`static class`	`JSpinner.ListEditor`	Редактор для `JSpinner`, модель которого — `SpinnerListModel`.
`static class`	`JSpinner.NumberEditor`	Редактор для `JSpinner`, модель которого — `SpinnerNumberModel`.

Вложенные классы/интерфейсы, объявленные в классе javax.swing.JComponent

JComponent.AccessibleJComponent

Вложенные классы/интерфейсы, объявленные в классе java.awt.Container

Container.AccessibleAWTContainer

Вложенные классы/интерфейсы, объявленные в классе java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Краткое описание полей

Поля, объявленные в классе javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Поля, объявленные в классе java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Поля, объявленные в интерфейсе java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Краткое описание конструкторов

Конструктор	Описание
`JSpinner()`	Создаёт спиннер с `Integer SpinnerNumberModel` начальным значением 0 и без минимальных или максимальных ограничений.
`JSpinner(SpinnerModel model)`	Создаёт спиннер для заданной модели.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`addChangeListener(ChangeListener listener)`	Добавляет слушателя к списку, который уведомляется каждый раз при изменении модели.
`void`	`commitEdit()`	Сохраняет текущее изменённое значение в `SpinnerModel`.
`protected JComponent`	`createEditor(SpinnerModel model)`	Этот метод вызывается конструкторами для создания `JComponent` для отображения текущего значения последовательности.
`protected void`	`fireStateChanged()`	Отправляет `ChangeEvent`, источник которого — этот `JSpinner`, каждому `ChangeListener`.
`AccessibleContext`	`getAccessibleContext()`	Получает `AccessibleContext` для `JSpinner`
`ChangeListener[]`	`getChangeListeners()`	Возвращает массив всех `ChangeListener` добавленных в этот JSpinner с помощью addChangeListener().
`JComponent`	`getEditor()`	Возвращает компонент, отображающий и, возможно, изменяющий значение модели.
`SpinnerModel`	`getModel()`	Возвращает `SpinnerModel`, который определяет последовательность значений для этого спиннера.
`Object`	`getNextValue()`	Возвращает объект в последовательности, следующий за объектом, возвращённым `getValue()`.
`Object`	`getPreviousValue()`	Возвращает объект в последовательности, предшествующий объекту, возвращённому `getValue()`.
`SpinnerUI`	`getUI()`	Возвращает объект визуального оформления (L&F), который отображает этот компонент.
`String`	`getUIClassID()`	Возвращает суффикс, используемый для построения имени класса визуального оформления (L&F), используемого для отображения этого компонента.
`Object`	`getValue()`	Возвращает текущее значение модели; обычно это значение отображается `editor`.
`void`	`removeChangeListener(ChangeListener listener)`	Удаляет `ChangeListener` из этого спиннера.
`void`	`setEditor(JComponent editor)`	Изменяет `JComponent` для отображения текущего значения `SpinnerModel`.
`void`	`setModel(SpinnerModel model)`	Изменяет модель, представляющую значение этого спиннера.
`void`	`setUI(SpinnerUI ui)`	Устанавливает объект визуального оформления (L&F), который отображает этот компонент.
`void`	`setValue(Object value)`	Изменяет текущее значение модели; обычно это значение отображается `editor`.
`void`	`updateUI()`	Сбрасывает свойство UI со значением из текущего визуального оформления.

Методы, объявленные в классе javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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

Методы, объявленные в классе 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

Методы, объявленные в классе 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, 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

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

JSpinner

public JSpinner(SpinnerModel model)

Создаёт спиннер для заданной модели. Спиннер имеет набор кнопок «предыдущий»/«следующий» и редактор, соответствующий модели.

Параметры:: model - модель для нового спиннера
Исключения:: NullPointerException - если модель является null

JSpinner

public JSpinner()

Создаёт спиннер со значением по умолчанию 0 и без минимальных или максимальных ограничений.

Подробное описание методов

getUI

public SpinnerUI getUI()

Возвращает объект внешнего вида (L&F), который отображает этот компонент.

Переопределяет:: getUI в классе JComponent
Возвращает:: объект внешнего вида (L&F), который отображает этот компонент

setUI

public void setUI(SpinnerUI ui)

Устанавливает объект внешнего вида (L&F), который отображает этот компонент.

Параметры:

ui - объект внешнего вида (L&F)

См. также:

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()

Возвращает суффикс, используемый для построения имени класса внешнего вида (L&F), используемого для отображения этого компонента.

Переопределяет:

getUIClassID в классе JComponent

Возвращает:

строку "SpinnerUI"

См. также:

updateUI

public void updateUI()

Сбрасывает свойство UI со значением из текущего внешнего вида.

Переопределяет:

updateUI в классе JComponent

См. также:

createEditor

protected JComponent createEditor(SpinnerModel model)

Этот метод вызывается конструкторами для создания редактора, который отображает текущее значение последовательности. Редактор также может позволить пользователю вводить элемент последовательности напрямую. Редактор должен отслеживать изменения в модели и синхронизировать отображаемое значение с значением модели.

Подклассы могут переопределить этот метод, чтобы добавить поддержку новых типов редакторов. Кроме того, можно просто заменить созданный здесь редактор с помощью метода setEditor. Стандартное отображение типов модели на редактор:

SpinnerNumberModel => JSpinner.NumberEditor
SpinnerDateModel => JSpinner.DateEditor
SpinnerListModel => JSpinner.ListEditor
все остальные => JSpinner.DefaultEditor

Параметры:

model - значение getModel

Возвращает:

компонент, отображающий текущее значение последовательности

См. также:

setModel

@BeanProperty(visualUpdate=true, description="Model that represents the value of this spinner.") public void setModel(SpinnerModel model)

Изменяет модель, которая представляет значение этого спиннера. Если свойство редактора не было явно установлено, свойство редактора (неявно) устанавливается после того, как был вызван "model" PropertyChangeEvent. Свойство редактора устанавливается в значение, возвращаемое createEditor, как в:

 setEditor(createEditor(model));

Параметры:

model - новая модель

Исключения:

IllegalArgumentException - если модель является null

См. также:

getModel

public SpinnerModel getModel()

Возвращает модель, которая определяет последовательность значений этого спиннера.

Возвращает:

значение свойства модели

См. также:

getValue

public Object getValue()

Возвращает текущее значение модели, которое обычно отображается спиннером. Если пользователь изменил значение, отображаемое спиннером, возможно, что значение спиннера отличается от значения модели. Обратитесь к документации класса для примеров того, как справиться с этим.

Этот метод просто делегирует model. Он эквивалентен:

 getModel().getValue()

Возвращает:

текущее значение модели

См. также:

setValue

public void setValue(Object value)

Изменяет текущее значение модели, которое обычно отображается спиннером. Если реализация спиннера не поддерживает заданное значение, выбрасывается исключение.

Этот метод просто делегирует model. Он эквивалентен:

 getModel().setValue(value)

Параметры:

value - новое значение спиннера

Исключения:

IllegalArgumentException - если value недопустимо

См. также:

getNextValue

@BeanProperty(bound=false) public Object getNextValue()

Возвращает объект в последовательности, который следует за объектом, возвращаемым getValue(). Если достигнут конец последовательности, возвращается null. Вызов этого метода не влияет на value.

Этот метод просто делегирует model. Он эквивалентен:

 getModel().getNextValue()

Возвращает:

следующее допустимое значение или null , если оно не существует

См. также:

addChangeListener

public void addChangeListener(ChangeListener listener)

Добавляет слушателя в список, который уведомляется каждый раз, когда происходит изменение модели. Источником события, передаваемого ChangeListeners, является этот спиннер. Обратите также внимание, что замена модели не повлияет на слушателей, добавленных непосредственно в JSpinner. Приложения могут добавлять слушателей непосредственно к модели. В этом случае источником события будет модель.

Параметры:

listener - слушатель

См. также:

removeChangeListener

public void removeChangeListener(ChangeListener listener)

Удаляет слушателя из этого спиннера.

Параметры:

listener - слушатель для удаления

См. также:

getChangeListeners

@BeanProperty(bound=false) public ChangeListener[] getChangeListeners()

Возвращает массив всех слушателей, добавленных к этому JSpinner с помощью addChangeListener().

Возвращает:: все добавленные слушатели или пустой массив, если слушатели не были добавлены
С:: 1.4

fireStateChanged

protected void fireStateChanged()

Отправляет событие изменения модели всем слушателям. Источником события является этот спиннер. При добавлении слушателя к спиннеру этот метод вызывается каждый раз, когда спиннер получает событие изменения от модели.

См. также:

getPreviousValue

@BeanProperty(bound=false) public Object getPreviousValue()

Возвращает объект в последовательности, который предшествует объекту, возвращённому методом getValue(). Если достигнут конец последовательности, то возвращает null. Вызов этого метода не влияет на value.

Этот метод просто делегирует вызов методу model. Он эквивалентен следующему:

 getModel().getPreviousValue()

Возвращает:

предыдущее допустимое значение или null, если оно отсутствует

См. также:

setEditor

@BeanProperty(visualUpdate=true, description="JComponent that displays the current value of the model") public void setEditor(JComponent editor)

Изменяет компонент, отображающий текущее значение SpinnerModel. Метод обязан отсоединить старый редактор от модели и подключить новый. Это может означать удаление старого редактора из модели или спиннера и добавление нового для нового редактора.

Параметры:

editor - новый редактор

Исключения:

IllegalArgumentException - если редактор null

См. также:

getEditor

public JComponent getEditor()

Возвращает компонент, отображающий и, возможно, изменяющий значение модели.

Возвращает:

компонент, отображающий и, возможно, изменяющий значение модели

См. также:

commitEdit

public void commitEdit() throws ParseException

Сохраняет текущее редактируемое значение в SpinnerModel.

Если редактор является экземпляром DefaultEditor, вызов перенаправляется редактору; в противном случае ничего не происходит.

Исключения:: ParseException - если текущее редактируемое значение не удалось сохранить.

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

Возвращает AccessibleContext для JSpinner.

Определено в:: getAccessibleContext в интерфейсе Accessible
Переопределяет:: getAccessibleContext в классе Component
Возвращает:: AccessibleContext для JSpinner
С тех пор:: 1.5

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/JSpinner.html