com.portal.pfc.ui

Class IntegerTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

com.portal.pfc.ui.ValidatedTextField

com.portal.pfc.ui.IntegerTextField

All Implemented Interfaces:

CyclerListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, Scrollable, SwingConstants

Direct Known Subclasses:

PIAIntegerField

public class IntegerTextField
extends ValidatedTextField

A textfield that accepts numeric data only. Decimal/fractional input is rejected - the number represented by this textfield must be an integer.

See Also:

Serialized Form

Nested Class Summary

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

JTextField.AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding

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 inherited from class javax.swing.JTextField

notifyAction

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
IntegerTextField() Constructs a new IntegerTextField.
IntegerTextField(int cols) Constructs a new IntegerTextField containing the specified number of columns.

Method Summary

Modifier and Type	Method and Description
void	addNotify()
boolean	coalesceEvents()
int	getMaximumValue() Gets the maximum value allowed
int	getMinimumValue() Gets the minimum value allowed when spinning up.
int	getNumDigitsAllowed()
Object	getValue() Used to retrieve the value of component as an Integer instead of a String (using getText()).
boolean	isAllowEmptyValue() Reports whether the textfield can have an empty value.
boolean	isAllowNegativeNumbers() This will return whether this field allows negative values.
protected boolean	isValidInput(String str) This method verifies that the specified string doesn't contain alphabetic characters.
void	replaceSelection(String str) Replaces the currently selected content with the specified text, granted the specified text contains numeric data only.
void	setAllowEmptyValue(boolean b) If true, the textfield appears initially empty and getText() will return an empty string.
void	setAllowNegativeNumbers(boolean allowNegativeNumbers) This will allow negative values to be entered in the field
void	setMaximumValue(int max) Sets the minimum value allowed
void	setMinimumValue(int min) Sets the minimum value allowed
void	setNumDigitsAllowed(int len) Establishes the maximum number of digits allowed in this textfield Note that if the resulting number exceeds the maximum value of an Integer you will not be able to retrieve the value as an Integer. The default is 10.
void	setText(String str) Sets the text of this textfield to the specified text, granted the specified text contains numeric data only.
void	valueChange(CyclerEvent e) Called when this component is embedded in a SpinnerField and the associated Cycler is selected.

Methods inherited from class com.portal.pfc.ui.ValidatedTextField

getSpecialChars, setSpecialChars

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, 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, 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, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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

Constructor Detail

IntegerTextField

public IntegerTextField()

Constructs a new IntegerTextField. The number of columns is set to 10. The default minimum value allowed (when in a SpinnerField) is 0, and the maximum value is 100.

IntegerTextField

public IntegerTextField(int cols)

Constructs a new IntegerTextField containing the specified number of columns. The default minimum value allowed (when in a SpinnerField) is 0, and the maximum value is 100.

Parameters:

columns - the number of columns to use to calculate the preferred width.

Method Detail

setText

public void setText(String str)

Sets the text of this textfield to the specified text, granted the specified text contains numeric data only. If the specified text contains alphabetic characters (including the currency symbol and/or the grouping separator) the text is rejected.

Overrides:

setText in class JTextComponent

Parameters:

str - the new text to display

coalesceEvents

public boolean coalesceEvents()

replaceSelection

public void replaceSelection(String str)

Replaces the currently selected content with the specified text, granted the specified text contains numeric data only. If the specified text contains alphabetic characters the text is rejected. If there is no selection this amounts to an insert of the specified text.

Overrides:

replaceSelection in class JTextComponent

Parameters:

str - the text to use when replacing the selected text

getValue

public Object getValue()

Used to retrieve the value of component as an Integer instead of a String (using getText()). Note that you may get a NumberFormatException if the number represented in the textfield exceeds the maximum Integer value. If that is the case, you may choose to retrieve the number as a String instead.

Specified by:

getValue in class ValidatedTextField

Returns:

the numeric value of the component

valueChange

public void valueChange(CyclerEvent e)

Called when this component is embedded in a SpinnerField and the associated Cycler is selected.

Specified by:

valueChange in interface CyclerListener

Specified by:

valueChange in class ValidatedTextField

Parameters:

e - the CyclerEvent

setMaximumValue

public void setMaximumValue(int max)

Sets the minimum value allowed

Parameters:

max - the max value

getMaximumValue

public int getMaximumValue()

Gets the maximum value allowed

Returns:

the max value

setMinimumValue

public void setMinimumValue(int min)

Sets the minimum value allowed

Parameters:

the - minimum value

getMinimumValue

public int getMinimumValue()

Gets the minimum value allowed when spinning up.

Returns:

the min value

setAllowEmptyValue

public void setAllowEmptyValue(boolean b)

If true, the textfield appears initially empty and getText() will return an empty string. Otherwise, the textfield will have an initial value of the minimum value.
This is initially false;

Parameters:

b - Determines the state

isAllowEmptyValue

public boolean isAllowEmptyValue()

Reports whether the textfield can have an empty value.

Returns:

true if the textfield can have an empty value; false otherwise.

setNumDigitsAllowed

public void setNumDigitsAllowed(int len)

Establishes the maximum number of digits allowed in this textfield Note that if the resulting number exceeds the maximum value of an Integer you will not be able to retrieve the value as an Integer.
The default is 10.

Parameters:

len -

getNumDigitsAllowed

public int getNumDigitsAllowed()

addNotify

public void addNotify()

Overrides:

addNotify in class JComponent

isValidInput

protected boolean isValidInput(String str)

This method verifies that the specified string doesn't contain alphabetic characters. It allows negative character "-"

Overrides:

isValidInput in class ValidatedTextField

Parameters:

str - the string to be validated

Returns:

true if the input contains numeric data only; false otherwise

setAllowNegativeNumbers

public void setAllowNegativeNumbers(boolean allowNegativeNumbers)

This will allow negative values to be entered in the field

Parameters:

allowNegativeNumbers - will determine if negative values should be allowed

isAllowNegativeNumbers

public boolean isAllowNegativeNumbers()

This will return whether this field allows negative values.

Returns:

true if negative values are allowed.