Module org.autogui

Package org.autogui.swing

Class GuiSwingViewNumberSpinner.PropertyNumberSpinner

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JSpinner

org.autogui.swing.GuiSwingViewNumberSpinner.InfinityNumberSpinner

org.autogui.swing.GuiSwingViewNumberSpinner.PropertyNumberSpinner

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, GuiMappingContext.SourceUpdateListener, GuiSwingView.SettingsWindowClient, GuiSwingView.ValuePane<Object>, GuiSwingPrefsSupports.PreferencesUpdateSupport

Direct Known Subclasses:

GuiSwingTableColumnNumber.ColumnEditNumberSpinner, LambdaProperty.LambdaNumberSpinner

Enclosing class:

GuiSwingViewNumberSpinner

public static class GuiSwingViewNumberSpinner.PropertyNumberSpinner
extends GuiSwingViewNumberSpinner.InfinityNumberSpinner
implements GuiMappingContext.SourceUpdateListener, GuiSwingView.ValuePane<Object>, GuiSwingView.SettingsWindowClient, GuiSwingPrefsSupports.PreferencesUpdateSupport

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JSpinner

JSpinner.AccessibleJSpinner, JSpinner.DateEditor, JSpinner.DefaultEditor, JSpinner.ListEditor, JSpinner.NumberEditor

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

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

Field Summary

Fields

Modifier and Type	Field	Description
protected GuiMappingContext	context
protected boolean	currentValueSupported
protected List<Runnable>	editFinishHandlers
protected EditingRunner	editingRunner
protected MenuBuilder.MenuLabel	infoLabel
protected List<PopupCategorized.CategorizedMenuItem>	menuItems
protected GuiSwingViewNumberSpinner.TypedSpinnerNumberModelPreferencesUpdater	modelPreferencesUpdater
protected PopupExtensionText	popup
protected GuiSwingViewNumberSpinner.NumberSettingAction	settingAction
protected SettingsWindow	settingsWindow
protected GuiSwingView.SpecifierManager	specifierManager
protected KeyUndoManager	undoManager
protected GuiTaskClock	viewClock

Fields inherited from class javax.swing.JComponent

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

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
PropertyNumberSpinner(GuiMappingContext context, GuiSwingView.SpecifierManager specifierManager)

Method Summary

Modifier and Type	Method	Description
void	addSwingEditFinishHandler(Runnable eventHandler)	the method is used for table cell-editors, in order to observe the completion of editing.
static GuiSwingViewNumberSpinner.TypedSpinnerNumberModel	createModel(GuiMappingContext context)
EditingRunner	getEditingRunner()
JFormattedTextField	getEditorField()
GuiSwingViewNumberSpinner.TypedSpinnerNumberModel	getModelTyped()
GuiSwingViewNumberSpinner.NumberSettingAction	getSettingAction()
SettingsWindow	getSettingsWindow()
GuiReprValue.ObjectSpecifier	getSpecifier()
PopupExtension.PopupMenuBuilder	getSwingMenuBuilder()	a typical implementation if there are no dynamic items becomes like the following code:
List<PopupCategorized.CategorizedMenuItem>	getSwingStaticMenuItems()	a typical implementation becomes like the following code:
GuiMappingContext	getSwingViewContext()
Object	getSwingViewValue()
void	init()
void	initAfter()
void	initContextUpdate()
void	initDragDrop()
void	initEditable()
void	initListener()
void	initModelPreferencesUpdater()
void	initName()
void	initPopup()
void	initUndo()
void	initValue()
boolean	isImmediate(List<Object> events)
boolean	isSwingCurrentValueSupported()
void	loadSwingPreferences(GuiPreferences prefs, GuiSwingPrefsApplyOptions options)	a sub-class which wraps another value-pane should overrides the method in order to omit needless value setting.
void	prepareForRefresh()	for each component, the method is called before refreshing in order to clear the view-clock.
void	requestSwingViewFocus()
void	saveSwingPreferences(GuiPreferences prefs)	only save the component itself, not including children.
void	setCurrentValueSupported(boolean currentValueSupported)
void	setKeyStrokeString(String keyStrokeString)	set the key-stroke info.
void	setModel(SpinnerModel model)
void	setPreferencesUpdater(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> updater)
void	setSettingsWindow(SettingsWindow settingsWindow)	at initialization of the root-pane, the method will be called for existing sub-panes.
void	setSwingViewValue(Object value)	update GUI display, and it does NOT update the target model value.
void	setSwingViewValue(Object value, GuiTaskClock clock)	update if the clock is newer than the current view-clock of the pane.
void	setSwingViewValueWithUpdate(Object value)	update the GUI display and the model.
void	setSwingViewValueWithUpdate(Object value, GuiTaskClock clock)	update the GUI display and the model if the clock is newer than the current view-clock of the pane.
void	shutdownSwingView()	for each component, at the end of the process, this method will be called
void	update(GuiMappingContext cause, Object newValue, GuiTaskClock contextClock)
void	updateFromGui(Object value, GuiTaskClock viewClock)
void	updateNumber(List<Object> events)

Methods inherited from class org.autogui.swing.GuiSwingViewNumberSpinner.InfinityNumberSpinner

createEditor

Methods inherited from class javax.swing.JSpinner

addChangeListener, commitEdit, fireStateChanged, getAccessibleContext, getChangeListeners, getEditor, getModel, getNextValue, getPreviousValue, getUI, getUIClassID, getValue, removeChangeListener, setEditor, setUI, setValue, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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

Methods inherited from 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 inherited from 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, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.swing.GuiSwingView.ValuePane

asSwingViewComponent, executeContextTask, getActionByContext, getActionByName, getChildByName, getDescendantActionByContext, getDescendantByContext, getDescendantByValue, getDescendantByValueIf, getPrefsJsonSupported, getSwingFocusKeyStroke, isSwingEditable, loadSwingPreferences, refreshByContext, setPrefsJsonSupported, setSwingViewHistoryValue, setSwingViewValueForTable, updateSwingViewSource, updateSwingViewSourceFromRoot, wrapSwingNamed, wrapSwingPane, wrapSwingProperty, wrapSwingScrollPane

Field Details

context

protected GuiMappingContext context

specifierManager

protected GuiSwingView.SpecifierManager specifierManager

editingRunner

protected volatile EditingRunner editingRunner

popup

protected PopupExtensionText popup

undoManager

protected KeyUndoManager undoManager

settingsWindow

protected SettingsWindow settingsWindow

modelPreferencesUpdater

protected GuiSwingViewNumberSpinner.TypedSpinnerNumberModelPreferencesUpdater modelPreferencesUpdater

menuItems

protected List<PopupCategorized.CategorizedMenuItem> menuItems

settingAction

protected GuiSwingViewNumberSpinner.NumberSettingAction settingAction

infoLabel

protected MenuBuilder.MenuLabel infoLabel

currentValueSupported

protected boolean currentValueSupported

viewClock

protected GuiTaskClock viewClock

editFinishHandlers

protected List<Runnable> editFinishHandlers

Constructor Details

PropertyNumberSpinner

public PropertyNumberSpinner(GuiMappingContext context,
 GuiSwingView.SpecifierManager specifierManager)

Method Details

init

public void init()

initName

public void initName()

initEditable

public void initEditable()

initModelPreferencesUpdater

public void initModelPreferencesUpdater()

initContextUpdate

public void initContextUpdate()

initValue

public void initValue()

initListener

public void initListener()

initPopup

public void initPopup()

initDragDrop

public void initDragDrop()

initUndo

public void initUndo()

initAfter

public void initAfter()

isSwingCurrentValueSupported

public boolean isSwingCurrentValueSupported()

Specified by:

isSwingCurrentValueSupported in interface GuiSwingView.ValuePane<Object>

setCurrentValueSupported

public void setCurrentValueSupported(boolean currentValueSupported)

getSettingAction

public GuiSwingViewNumberSpinner.NumberSettingAction getSettingAction()

getEditingRunner

public EditingRunner getEditingRunner()

Returns:

the editingRunner for the number

Since:

1.3

getSwingStaticMenuItems

public List<PopupCategorized.CategorizedMenuItem> getSwingStaticMenuItems()

Description copied from interface: GuiSwingView.ValuePane

a typical implementation becomes like the following code:

      if (menuItems == null) { menuItems = PopupCategorized.getMenuItems(actions, menus); }
      return menuItems;
  

the method returns original menu items for the pane. so, if a wrapper pane has a wrapped sub-pane added as a child component, it should not include items of the wrapped sub-pane.

Specified by:

getSwingStaticMenuItems in interface GuiSwingView.ValuePane<Object>

Returns:

a list of actions (or menu-components) statically determined, that should be always same instances

getSwingMenuBuilder

public PopupExtension.PopupMenuBuilder getSwingMenuBuilder()

Description copied from interface: GuiSwingView.ValuePane

a typical implementation if there are no dynamic items becomes like the following code:

     if (popup == null) { popup = new PopupExtension(this,
                                    new PopupCategorized(this::getSwingStaticMenuItems)); }
     return popup.getMenuBuilder();
 

Specified by:

getSwingMenuBuilder in interface GuiSwingView.ValuePane<Object>

Returns:

a menu builder

getModelTyped

public GuiSwingViewNumberSpinner.TypedSpinnerNumberModel getModelTyped()

createModel

public static GuiSwingViewNumberSpinner.TypedSpinnerNumberModel createModel(GuiMappingContext context)

updateNumber

public void updateNumber(List<Object> events)

isImmediate

public boolean isImmediate(List<Object> events)

update

public void update(GuiMappingContext cause,
 Object newValue,
 GuiTaskClock contextClock)

Specified by:

update in interface GuiMappingContext.SourceUpdateListener

getSwingViewValue

public Object getSwingViewValue()

Specified by:

getSwingViewValue in interface GuiSwingView.ValuePane<Object>

Returns:

basically, the source value of the context, held by the component without touching the context.

setSwingViewValue

public void setSwingViewValue(Object value)

Description copied from interface: GuiSwingView.ValuePane

update GUI display, and it does NOT update the target model value. processed under the event thread. also increment the view-clock.

Specified by:

setSwingViewValue in interface GuiSwingView.ValuePane<Object>

Parameters:

value - the new value

setSwingViewValueWithUpdate

public void setSwingViewValueWithUpdate(Object value)

Description copied from interface: GuiSwingView.ValuePane

update the GUI display and the model. processed under the event thread. also increment the view-clock

Specified by:

setSwingViewValueWithUpdate in interface GuiSwingView.ValuePane<Object>

Parameters:

value - the new value

setSwingViewValue

public void setSwingViewValue(Object value,
 GuiTaskClock clock)

Description copied from interface: GuiSwingView.ValuePane

update if the clock is newer than the current view-clock of the pane. the view-clock becomes the given clock. Note: instead, GuiSwingView.ValuePane.setSwingViewValue(Object) increments the current clock

Specified by:

setSwingViewValue in interface GuiSwingView.ValuePane<Object>

Parameters:

value - the new value

clock - the clock of the value: if the clock is newer than the current view-clock of the pane, it can update

setSwingViewValueWithUpdate

public void setSwingViewValueWithUpdate(Object value,
 GuiTaskClock clock)

Description copied from interface: GuiSwingView.ValuePane

update the GUI display and the model if the clock is newer than the current view-clock of the pane. the view-clock becomes the given clock.

Specified by:

setSwingViewValueWithUpdate in interface GuiSwingView.ValuePane<Object>

Parameters:

value - the new value

clock - the clock of the value

updateFromGui

public void updateFromGui(Object value,
 GuiTaskClock viewClock)

addSwingEditFinishHandler

public void addSwingEditFinishHandler(Runnable eventHandler)

Description copied from interface: GuiSwingView.ValuePane

the method is used for table cell-editors, in order to observe the completion of editing. the default impl. is empty.

Specified by:

addSwingEditFinishHandler in interface GuiSwingView.ValuePane<Object>

Parameters:

eventHandler - the handler called when the editing is finished

getEditorField

public JFormattedTextField getEditorField()

getSwingViewContext

public GuiMappingContext getSwingViewContext()

Specified by:

getSwingViewContext in interface GuiSwingView.ValuePane<Object>

saveSwingPreferences

public void saveSwingPreferences(GuiPreferences prefs)

Description copied from interface: GuiSwingView.ValuePane

only save the component itself, not including children. it can use GuiSwingView.savePreferencesDefault(JComponent, GuiPreferences)

Specified by:

saveSwingPreferences in interface GuiSwingView.ValuePane<Object>

Parameters:

prefs - target prefs or ancestor of the target; actual target can be obtained by GuiPreferences.getDescendant(GuiMappingContext)

loadSwingPreferences

public void loadSwingPreferences(GuiPreferences prefs,
 GuiSwingPrefsApplyOptions options)

Description copied from interface: GuiSwingView.ValuePane

a sub-class which wraps another value-pane should overrides the method in order to omit needless value setting. it can use GuiSwingView.loadPreferencesDefault(JComponent, GuiPreferences)

Specified by:

loadSwingPreferences in interface GuiSwingView.ValuePane<Object>

Parameters:

prefs - target prefs or ancestor of the target; actual target can be obtained by GuiPreferences.getDescendant(GuiMappingContext)

options - options for applying

setSettingsWindow

public void setSettingsWindow(SettingsWindow settingsWindow)

Description copied from interface: GuiSwingView.SettingsWindowClient

at initialization of the root-pane, the method will be called for existing sub-panes. a dynamically created view needs to be manually set by those panes.

Specified by:

setSettingsWindow in interface GuiSwingView.SettingsWindowClient

Parameters:

settingsWindow - a settings-window from the root-pane, which will be disposed at closing of the main window

getSettingsWindow

public SettingsWindow getSettingsWindow()

Specified by:

getSettingsWindow in interface GuiSwingView.SettingsWindowClient

shutdownSwingView

public void shutdownSwingView()

Description copied from interface: GuiSwingView.ValuePane

for each component, at the end of the process, this method will be called

Specified by:

shutdownSwingView in interface GuiSwingView.ValuePane<Object>

setPreferencesUpdater

public void setPreferencesUpdater(Consumer<GuiSwingPrefsSupports.PreferencesUpdateEvent> updater)

Specified by:

setPreferencesUpdater in interface GuiSwingPrefsSupports.PreferencesUpdateSupport

setModel

public void setModel(SpinnerModel model)

Overrides:

setModel in class JSpinner

getSpecifier

public GuiReprValue.ObjectSpecifier getSpecifier()

Specified by:

getSpecifier in interface GuiSwingView.ValuePane<Object>

Returns:

the specifier for the context value, typically obtained from GuiSwingView.SpecifierManager

requestSwingViewFocus

public void requestSwingViewFocus()

Specified by:

requestSwingViewFocus in interface GuiSwingView.ValuePane<Object>

setKeyStrokeString

public void setKeyStrokeString(String keyStrokeString)

Description copied from interface: GuiSwingView.ValuePane

set the key-stroke info. to the pane as a guide

Specified by:

setKeyStrokeString in interface GuiSwingView.ValuePane<Object>

Parameters:

keyStrokeString - the key stroke info to be set.

prepareForRefresh

public void prepareForRefresh()

Description copied from interface: GuiSwingView.ValuePane

for each component, the method is called before refreshing in order to clear the view-clock.

Specified by:

prepareForRefresh in interface GuiSwingView.ValuePane<Object>