xdev.ui

Class XdevSpinner

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JSpinner

xdev.ui.XdevSpinner

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, FormularComponent<XdevSpinner>, NumberFormularComponent<XdevSpinner>, XdevFocusCycleComponent

@BeanSettings(useXdevCustomizer=true)
public class XdevSpinner
extends JSpinner
implements NumberFormularComponent<XdevSpinner>, XdevFocusCycleComponent

The standard spinner in XDEV. Based on JSpinner.

Since:

2.0

Author:

XDEV Software

See Also:

JSpinner, FormularComponent, XdevFocusCycleComponent, 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

Nested classes/interfaces inherited from interface xdev.ui.FormularComponent

FormularComponent.ValueChangeListener

Field Summary

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 xdev.ui.FormularComponent

DATA_FIELD_SEPARATOR

Fields inherited from interface xdev.ui.XdevFocusCycleComponent

TAB_INDEX_PROPERTY

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
XdevSpinner() Constructs a XdevSpinner with an Integer SpinnerNumberModel with initial value 0 and no minimum or maximum limits.
XdevSpinner(SpinnerModel model) Constructs a complete XdevSpinner with pair of next/previous buttons and an editor for the SpinnerModel.

Method Summary

Modifier and Type	Method and Description
void	addFocusListener(FocusListener l)
void	addValidator(Validator validator) Adds a validator to this component
void	addValueChangeListener(FormularComponent.ValueChangeListener l) Registers a FormularComponent.ValueChangeListener.
Color	getBackground()
String	getDataField() Returns the name of the bound data field of this formular component.
Operator	getFilterOperator() Returns the operator used in Formular.createCondition(String)
Font	getFont()
Color	getForeground()
String	getFormularName() Returns the name of the component in the formular context.
Object	getFormularValue() Returns the value of the component.
Number	getNumber() Returns the value of this NumberFormularComponent as Number.
Number	getNumber(Number defaultValue) Returns the value of this NumberFormularComponent as Number.
int	getTabIndex() Returns the tabindex assigned to this component.
JTextField	getTextField() Returns the component that displays and potentially changes the model's value.
Validator[]	getValidators() Returns all validators of this component.
boolean	hasStateChanged() Checks if the component's state since the last call of FormularComponent.saveState() has changed.
boolean	isMultiSelect() Returns whether the component supports multi selection or not.
boolean	isOpaque()
boolean	isReadOnly() Determines whether this component is only used to display values.
void	removeFocusListener(FocusListener l)
void	removeValidator(Validator validator) Removes a validator from this component
void	requestFocus()
void	restoreState() Restores the internally saved state of the component.
void	saveState() Saves the state of the component internally.
void	setBackground(Color bg)
void	setDataField(String dataField) Sets the name of the bound data field of this formular component.
void	setEnabled(boolean enabled)
void	setFilterOperator(Operator filterOperator) Sets the filter operator used in Formular.createCondition(String)
void	setFont(Font f)
void	setForeground(Color fg)
void	setFormularValue(VirtualTable vt, int col, Object value) Deprecated.
void	setFormularValue(VirtualTable vt, Map<String,Object> record) Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().
void	setListModel(List<?> values) Constructs a SpinnerListModel whose sequence of values is defined by the specified List and changes the model that represents the value of this XdevSpinner.
void	setNumber(Number number) Sets the number of this NumberFormularComponent.
void	setNumberModel(int value, int minimum, int maximum, int stepSize) Constructs a SpinnerNumberModel with the specified value, minimum/maximum bounds, and stepSize and changes the model that represents the value of this XdevSpinner.
void	setOpaque(boolean b)
void	setReadOnly(boolean readOnly) Sets if this form component is only used to display values.
void	setTabIndex(int tabIndex) Sets the tabindex of this component.
String	toString()
void	updateUI()
void	validateState() Calls Validator.validate(Object) of all registered Validators.
void	validateState(Validation validation) Calls Validator.validate(Object) of all registered Validators.
boolean	verify() Returns whether the component's value adheres all set constraints.

Methods inherited from class javax.swing.JSpinner

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

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, 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, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, 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, 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, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdev.ui.FormularComponent

getClientProperty, isEnabled, isVisible, putClientProperty

Constructor Detail

XdevSpinner

public XdevSpinner()

Constructs a XdevSpinner with an Integer SpinnerNumberModel with initial value 0 and no minimum or maximum limits.

See Also:

JSpinner.setModel(SpinnerModel)

XdevSpinner

public XdevSpinner(SpinnerModel model)

Constructs a complete XdevSpinner with pair of next/previous buttons and an editor for the SpinnerModel.

Parameters:

model - the new SpinnerModel for this XdevSpinner

Method Detail

getTextField

public JTextField getTextField()

Returns the component that displays and potentially changes the model's value.

Returns:

the JTextField that gives the user access to the SpinnerDateModel's value. If the editor is not a DefaultEditor, null is returned.

getFormularName

public String getFormularName()

Returns the name of the component in the formular context.

Specified by:

getFormularName in interface FormularComponent<XdevSpinner>

Returns:

the name of the component in the formular context.

setDataField

public void setDataField(String dataField)

Sets the name of the bound data field of this formular component.

Specified by:

setDataField in interface FormularComponent<XdevSpinner>

Parameters:

dataField - the new bound data field

Since:

3.1

getDataField

public String getDataField()

Returns the name of the bound data field of this formular component.

Specified by:

getDataField in interface FormularComponent<XdevSpinner>

Returns:

the name of the bound data field

Since:

3.1

setFormularValue

@Deprecated
public final void setFormularValue(VirtualTable vt,
                                               int col,
                                               Object value)

Deprecated.

Sets the value of the component according to the provided value value. The value is formatted using the column format of the provided VirtualTable and columnIndex.

Specified by:

setFormularValue in interface FormularComponent<XdevSpinner>

Parameters:

vt - VirtualTable to use the format from

col - of the column to use the format from

value - value to set

setFormularValue

public void setFormularValue(VirtualTable vt,
                             Map<String,Object> record)

Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().

Specified by:

setFormularValue in interface FormularComponent<XdevSpinner>

Parameters:

vt - the underlying virtual table

record - the data <column,value>

Since:

3.2

getFormularValue

public Object getFormularValue()

Returns the value of the component.

Specified by:

getFormularValue in interface FormularComponent<XdevSpinner>

Returns:

the value of the component.

saveState

public void saveState()

Saves the state of the component internally.

A saved state can be restored using FormularComponent.restoreState().

Specified by:

saveState in interface FormularComponent<XdevSpinner>

restoreState

public void restoreState()

Restores the internally saved state of the component.

The state of the component can be saved using FormularComponent.saveState().

Specified by:

restoreState in interface FormularComponent<XdevSpinner>

hasStateChanged

public boolean hasStateChanged()

Checks if the component's state since the last call of FormularComponent.saveState() has changed.

Specified by:

hasStateChanged in interface FormularComponent<XdevSpinner>

Returns:

true if the component's state has changed, false otherwise

Since:

3.1

addValueChangeListener

public void addValueChangeListener(FormularComponent.ValueChangeListener l)

Registers a FormularComponent.ValueChangeListener.

Specified by:

addValueChangeListener in interface FormularComponent<XdevSpinner>

Parameters:

l - the listener to register

Since:

3.1

isMultiSelect

public boolean isMultiSelect()

Returns whether the component supports multi selection or not.

A component that supports multi selection can have more than one selected item / value.

Specified by:

isMultiSelect in interface FormularComponent<XdevSpinner>

Returns:

true if the component supports multi selection, false otherwise.

verify

public boolean verify()

Returns whether the component's value adheres all set constraints.

This is a alternative method for FormularComponent.validateState(), but this method returns a boolean depending on the validation's result and doesn't throw an ValidationException.

Specified by:

verify in interface FormularComponent<XdevSpinner>

Returns:

true if the value of the component adheres all set constraints; otherwise false.

addValidator

public void addValidator(Validator validator)

Adds a validator to this component

Specified by:

addValidator in interface FormularComponent<XdevSpinner>

Parameters:

validator - the validator to add

Since:

3.1

See Also:

FormularComponent.validateState()

removeValidator

public void removeValidator(Validator validator)

Removes a validator from this component

Specified by:

removeValidator in interface FormularComponent<XdevSpinner>

Parameters:

validator - the validator to remove

Since:

3.1

See Also:

FormularComponent.validateState()

getValidators

public Validator[] getValidators()

Returns all validators of this component.

If no validator is present an empty array is returned.

Specified by:

getValidators in interface FormularComponent<XdevSpinner>

Returns:

all validators of this component

Since:

3.1

validateState

public void validateState()
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Specified by:

validateState in interface FormularComponent<XdevSpinner>

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

validateState

public void validateState(Validation validation)
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Every ValidationException is recorded in the validation object, and if Validation.continueValidation(ValidationException) returns false this exception is re-thrown by this method.

Specified by:

validateState in interface FormularComponent<XdevSpinner>

Parameters:

validation - the validation process object

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

setFilterOperator

public void setFilterOperator(Operator filterOperator)

Sets the filter operator used in Formular.createCondition(String)

Specified by:

setFilterOperator in interface FormularComponent<XdevSpinner>

Parameters:

filterOperator - the new filter operator

Since:

3.1

getFilterOperator

public Operator getFilterOperator()

Returns the operator used in Formular.createCondition(String)

Specified by:

getFilterOperator in interface FormularComponent<XdevSpinner>

Returns:

the component's filter operator

Since:

3.1

setReadOnly

public void setReadOnly(boolean readOnly)

Sets if this form component is only used to display values.

Specified by:

setReadOnly in interface FormularComponent<XdevSpinner>

Parameters:

readOnly - true to only display values

Since:

3.2

isReadOnly

public boolean isReadOnly()

Determines whether this component is only used to display values.

Specified by:

isReadOnly in interface FormularComponent<XdevSpinner>

Returns:

true if this component is only used to display values.

Since:

3.2

getNumber

public Number getNumber()
                 throws NumberFormatException

Returns the value of this NumberFormularComponent as Number.

Specified by:

getNumber in interface NumberFormularComponent<XdevSpinner>

Returns:

the value of this NumberFormularComponent as Number.

Throws:

NumberFormatException - if the value of this NumberFormularComponent can not be converted.

Since:

3.1

See Also:

NumberFormularComponent.getNumber(Number)

getNumber

public Number getNumber(Number defaultValue)

Returns the value of this NumberFormularComponent as Number. If the internal value can not be converted into a Number, the defaultValue is returned.

Specified by:

getNumber in interface NumberFormularComponent<XdevSpinner>

Parameters:

defaultValue - the default Number

Returns:

the value of this NumberFormularComponent. If the internal value can not be converted into a Number, the defaultValue is returned.

Since:

3.1

See Also:

NumberFormularComponent.getNumber()

setNumber

public void setNumber(Number number)

Sets the number of this NumberFormularComponent.

Specified by:

setNumber in interface NumberFormularComponent<XdevSpinner>

Parameters:

number - the new number

Since:

3.1

setNumberModel

public void setNumberModel(int value,
                           int minimum,
                           int maximum,
                           int stepSize)
                    throws IllegalArgumentException

Constructs a SpinnerNumberModel with the specified value, minimum/maximum bounds, and stepSize and changes the model that represents the value of this XdevSpinner.

Parameters:

value - the current value of the SpinnerNumberModel

minimum - the first number in the sequence

maximum - the last number in the sequence

stepSize - the difference between elements of the sequence

Throws:

IllegalArgumentException - if the following expression is false: minimum <= value <= maximum

setListModel

public void setListModel(List<?> values)
                  throws IllegalArgumentException

Constructs a SpinnerListModel whose sequence of values is defined by the specified List and changes the model that represents the value of this XdevSpinner.

Parameters:

values - the values of the SpinnerListModel

Throws:

IllegalArgumentException - if model is null

See Also:

JSpinner.getModel(), JSpinner.getEditor(), JSpinner.setEditor(javax.swing.JComponent), SpinnerListModel

updateUI

public void updateUI()

Overrides:

updateUI in class JSpinner

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

getBackground

public Color getBackground()

Overrides:

getBackground in class Component

setForeground

public void setForeground(Color fg)

Overrides:

setForeground in class JComponent

getForeground

public Color getForeground()

Overrides:

getForeground in class Component

setFont

public void setFont(Font f)

Overrides:

setFont in class JComponent

getFont

public Font getFont()

Specified by:

getFont in interface MenuContainer

Overrides:

getFont in class Component

setOpaque

public void setOpaque(boolean b)

Overrides:

setOpaque in class JComponent

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class JComponent

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

requestFocus

public void requestFocus()

Overrides:

requestFocus in class JComponent

addFocusListener

public void addFocusListener(FocusListener l)

Overrides:

addFocusListener in class Component

removeFocusListener

public void removeFocusListener(FocusListener l)

Overrides:

removeFocusListener in class Component

toString

public String toString()

Overrides:

toString in class Component

getTabIndex

public int getTabIndex()

Returns the tabindex assigned to this component. The tabindex defines the position of the component in the focus cycle.

Specified by:

getTabIndex in interface XdevFocusCycleComponent

Returns:

tabindex of this component

setTabIndex

public void setTabIndex(int tabIndex)

Sets the tabindex of this component. The tabindex defines the position of the component in the focus cycle.

To exclude this component from the focus cycle set tabindex to -1.

Specified by:

setTabIndex in interface XdevFocusCycleComponent

Parameters:

tabIndex - to be set