ProgramixGenericLib v5.0.1

com.programix.gui.text
Class IntegerField

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.text.JTextComponent
                  extended by javax.swing.JTextField
                      extended by com.programix.gui.text.FormatField
                          extended by com.programix.gui.text.IntegerField
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants

public class IntegerField
extends FormatField

A kind of FormatField (which is a JTextField) that only allows the input of integer values. The default range allows for all possible int values). By default, the numbers are formatted using a comma for the "thousands" separator, but this can be turned off (or back on) with setUseComma(boolean).

Author:
Paul Hyde
See Also:
Serialized Form

Nested Class Summary
static class IntegerField.RangePair
          A pair of IntegerField's that are linked together to specify a range.
 
Nested classes/interfaces inherited from class com.programix.gui.text.FormatField
FormatField.ValueListener
 
Nested classes/interfaces inherited from class javax.swing.JTextField
JTextField.AccessibleJTextField
 
Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
JTextComponent.AccessibleJTextComponent, 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.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class com.programix.gui.text.FormatField
allowValueListenerNotification, emptyReplacement, lock, value, valueStr
 
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
accessibleContext, 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
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
IntegerField()
           
IntegerField(IntegerRange validRange)
           
IntegerField(IntegerRange validRange, int initialValue)
           
IntegerField(IntegerRange validRange, Integer initialValue)
           
IntegerField(IntegerRange validRange, String initialValue)
           
IntegerField(IntegerRange validRange, Value initialValue)
           
 
Method Summary
protected  Value approveValue(Value proposedValue)
          Gives subclasses a chance to approved the proposed new value.
 BigDecimal getBigDecimal()
          Returns the current value as an BigDecimal or null if the field is empty.
 int getInt()
          Returns the current value as an int.
 Integer getInteger()
          Returns the current value as an Integer or null if the field is empty.
 IntegerRange getValidRange()
          Returns the current range of valid values.
 boolean isUseComma()
          Returns true if commas are currently being used.
 void setUseComma(boolean useComma)
          Sets the use of a comma as the thousands grouping character.
 void setValidRange(IntegerRange newRange)
          Sets the allowable range of values.
 void setValidRangeEnd(int newEnd)
          Changes the end of the valid range.
 void setValidRangeEnd(Integer newEnd)
          Changes the end of the valid range.
 void setValidRangeEnd(String newEnd)
          Changes the end of the valid range.
 void setValidRangeEnd(Value newEnd)
          Changes the end of the valid range.
 void setValidRangeStart(int newStart)
          Changes the start of the valid range.
 void setValidRangeStart(Integer newStart)
          Changes the start of the valid range.
 void setValidRangeStart(String newStart)
          Changes the start of the valid range.
 void setValidRangeStart(Value newStart)
          Changes the start of the valid range.
 void setValue(int newValue)
          Sets the value specified as an int.
 void setValue(Number newValue)
          Sets the value specified as a Number (which is the superclass of Integer, BigDecimal, and more).
 void updateUI()
           
 
Methods inherited from class com.programix.gui.text.FormatField
addValueListener, appendFilter, getEmptyReplacement, getFilterChainDocument, getString, getValue, isEmpty, isNotEmpty, notifyValueListeners, parseCurrentText, removeValueListener, setEmptyReplacement, setEmptyReplacement, setText, setValue, setValue, signalWarning
 
Methods inherited from class javax.swing.JTextField
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, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, viewToModel, write
 
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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IntegerField

public IntegerField(IntegerRange validRange,
                    Value initialValue)

IntegerField

public IntegerField(IntegerRange validRange,
                    Integer initialValue)

IntegerField

public IntegerField(IntegerRange validRange,
                    int initialValue)

IntegerField

public IntegerField(IntegerRange validRange,
                    String initialValue)

IntegerField

public IntegerField(IntegerRange validRange)

IntegerField

public IntegerField()
Method Detail

approveValue

protected Value approveValue(Value proposedValue)
Description copied from class: FormatField
Gives subclasses a chance to approved the proposed new value. If the subclass wants to override the proposed value, the subclass should override this method to return a different value. This method should also be overridden in subclasses that want to add formatting for the displayed text.

The original version of this method on FormatField simply returns the value unchanged.

Overrides:
approveValue in class FormatField

updateUI

public void updateUI()
Overrides:
updateUI in class JTextComponent

setValue

public void setValue(int newValue)
Sets the value specified as an int.


getInt

public int getInt()
           throws ValueException
Returns the current value as an int. This method throws an exception if the field is empty, for an alternative that can handle empty, see getInteger().

Throws:
ValueException - if the field is empty or otherwise can't be interpreted as an int.

setValue

public void setValue(Number newValue)
Sets the value specified as a Number (which is the superclass of Integer, BigDecimal, and more). If the specified Number is a type that can have a fractional part, then it is rounded off to the nearest integer.


getInteger

public Integer getInteger()
Returns the current value as an Integer or null if the field is empty. Specifically, if FormatField.isEmpty() returns true then this method returns null.


getBigDecimal

public BigDecimal getBigDecimal()
Returns the current value as an BigDecimal or null if the field is empty. Specifically, if FormatField.isEmpty() returns true then this method returns null.


setValidRange

public void setValidRange(IntegerRange newRange)
Sets the allowable range of values. If null is passed in, then IntegerRange.MIN_TO_MAX_INT is used instead. If the start of the range is open, then Integer.MIN_VALUE is used instead. If the end of the range is open, then Integer.MAX_VALUE is used instead.


getValidRange

public IntegerRange getValidRange()
Returns the current range of valid values.


setValidRangeStart

public void setValidRangeStart(Integer newStart)
Changes the start of the valid range.


setValidRangeStart

public void setValidRangeStart(int newStart)
Changes the start of the valid range.


setValidRangeStart

public void setValidRangeStart(String newStart)
Changes the start of the valid range.


setValidRangeStart

public void setValidRangeStart(Value newStart)
Changes the start of the valid range.


setValidRangeEnd

public void setValidRangeEnd(Integer newEnd)
Changes the end of the valid range.


setValidRangeEnd

public void setValidRangeEnd(int newEnd)
Changes the end of the valid range.


setValidRangeEnd

public void setValidRangeEnd(String newEnd)
Changes the end of the valid range.


setValidRangeEnd

public void setValidRangeEnd(Value newEnd)
Changes the end of the valid range.


setUseComma

public void setUseComma(boolean useComma)
Sets the use of a comma as the thousands grouping character.


isUseComma

public boolean isUseComma()
Returns true if commas are currently being used.


ProgramixGenericLib v5.0.1

Copyright © 2001-2009 Programix Incorporated. All rights reserved. ProgramixGenericLib is free and is OSI Certified Open Source Software under the BSD license.