com.portal.ctrl

Class SpinnerField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.portal.ctrl.SpinnerField

All Implemented Interfaces:

ActionListener, FocusListener, ImageObserver, MenuContainer, Serializable, EventListener

public class SpinnerField
extends JComponent
implements ActionListener, FocusListener

A wrapper around a component implementing the CyclerListener interface and a Cycler component. Clicking on the up/down arrow buttons of the Cycler component results in notifications being sent to the CyclerListener component.

Version:

%revision%

See Also:

Serialized Form

Nested Class Summary

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 and Description
protected ValidatedTextField	mComp

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 and Description
SpinnerField() Creates a new SpinnerField instance containing an IntegerTextField
SpinnerField(ValidatedTextField l) Creates a new SpinnerField containing the given ValidatedTextField
SpinnerField(ValidatedTextField l, boolean newVersion) Creates a new SpinnerField containing the given ValidatedTextField This version of the SpinnerField uses JButton's with arrow glyphs instead of the Cycler component for the up/down arrows.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent ae)
void	addChangeListener(ChangeListener l)
void	focusGained(FocusEvent e) Invoked when a component gains the keyboard focus.
void	focusLost(FocusEvent e) Invoked when a component loses the keyboard focus.
int	getMaximumValue() Gets the maximum value allowed when spinning up Currently only supported for IntegerTextField components
int	getMinimumValue() Gets the minimum value allowed when spinning up Currently only supported for IntegerTextField components
Object	getValue() Used to retrieve the value of component as an Object (Double, Integer) instead of a String (using getText()).
void	removeChangeListener(ChangeListener l)
void	requestFocus() Override requestFocus to pass it on to the actual text field
void	setBackground(Color bg)
void	setEnabled(boolean b) Enables/disables the subcomponents that comprise the main component
void	setLayout(LayoutManager lm)
void	setMaximumValue(int max) Sets the maximum value allowed when spinning up Currently only supported for IntegerTextField components
void	setMinimumValue(int min) Sets the minimum value allowed when spinning up Currently only supported for IntegerTextField components
void	setValue(Object val)

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, getUIClassID, 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, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, 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, 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, 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, getAccessibleContext, 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, 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, removeFocusListener, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

mComp

protected ValidatedTextField mComp

Constructor Detail

SpinnerField

public SpinnerField()

Creates a new SpinnerField instance containing an IntegerTextField

SpinnerField

public SpinnerField(ValidatedTextField l,
                    boolean newVersion)

Creates a new SpinnerField containing the given ValidatedTextField This version of the SpinnerField uses JButton's with arrow glyphs instead of the Cycler component for the up/down arrows. It also uses a BoxLayout instead of a GridBag (if that makes any difference).

Parameters:

field - - the ValidatedTextField to use

SpinnerField

public SpinnerField(ValidatedTextField l)

Creates a new SpinnerField containing the given ValidatedTextField

Parameters:

field - - the ValidatedTextField to use

Method Detail

actionPerformed

public void actionPerformed(ActionEvent ae)

Specified by:

actionPerformed in interface ActionListener

requestFocus

public void requestFocus()

Override requestFocus to pass it on to the actual text field

Overrides:

requestFocus in class JComponent

setLayout

public void setLayout(LayoutManager lm)

Overrides:

setLayout in class Container

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

setValue

public void setValue(Object val)

getValue

public Object getValue()

Used to retrieve the value of component as an Object (Double, Integer) instead of a String (using getText()).

Returns:

the numeric value of the component

addChangeListener

public void addChangeListener(ChangeListener l)

removeChangeListener

public void removeChangeListener(ChangeListener l)

setMaximumValue

public void setMaximumValue(int max)

Sets the maximum value allowed when spinning up Currently only supported for IntegerTextField components

Parameters:

max - the max value

getMaximumValue

public int getMaximumValue()

Gets the maximum value allowed when spinning up Currently only supported for IntegerTextField components

Returns:

the maximum value

setMinimumValue

public void setMinimumValue(int min)

Sets the minimum value allowed when spinning up Currently only supported for IntegerTextField components

Parameters:

min - the minimum value

getMinimumValue

public int getMinimumValue()

Gets the minimum value allowed when spinning up Currently only supported for IntegerTextField components

Returns:

the minimum value

setEnabled

public void setEnabled(boolean b)

Enables/disables the subcomponents that comprise the main component

Overrides:

setEnabled in class JComponent

Parameters:

b - If true, the component is enabled; otherwise it is disabled.

focusGained

public void focusGained(FocusEvent e)

Invoked when a component gains the keyboard focus.

Specified by:

focusGained in interface FocusListener

Parameters:

event - The focus event

focusLost

public void focusLost(FocusEvent e)

Invoked when a component loses the keyboard focus.

Specified by:

focusLost in interface FocusListener

Parameters:

event - The focus event