net.wotonomy.ui.swing.components
Class AlphaTextField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JTextField
                      net.wotonomy.ui.swing.components.SmartTextField
                          net.wotonomy.ui.swing.components.AlphaTextField

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

public class AlphaTextField
extends SmartTextField

AlphaTextField is a "smart" text field that restricts the user's input. The input can be restricted to alphabetic, alphanumeric, or all characters. The maximum number of characters can also be limited. The defaults for this component is alphabetic only string of unlimited length.

Version:

$Revision: 893 $

Author:

rob@straylight.princeton.com, $Author: cgruber $

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JTextField.AccessibleJTextField

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

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.KeyBinding

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	ALL Sets the input to all characters without restriction.
static int	ALPHABETIC Sets the input to alphabetic characters only.
static int	ALPHANUMERIC Sets the input to alphanumeric characters only.
static int	ALPHANUMERIC_PLUS Sets the input to alphanumeric characters and a few special characters only.

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

AlphaTextField()
The default constructor of this class.

AlphaTextField(int columns)
Constructor of this class with width (in columns) of the text field specified.

AlphaTextField(int anAlphaType, int aLength)
Constructor that allows the user to set the Alpha type of the text field and the maximum string length.

AlphaTextField(java.lang.String text)
Constructor of this class with the initial text of the text field specified.

AlphaTextField(java.lang.String text, int columns)
Constructor of this class with width (in columns) and initial text of the text field specified.

Method Summary

int	getAlphaType() Gets the current restriction type of this text field.
int	getStringLength() Gets the current length of the maximum string size the user can enter.
protected boolean	isValidCharacter(char aChar) PROTECTED METHODS
protected boolean	isValidString(java.lang.String aString) Returns whether a string is valid for this text field.
protected void	postProcessing() This method is used by the any subclass that need to complete any processing of the text string in the text field after all the requirement checks have been performed.
void	setAlphaType(int newAlphaType) Sets the restriction type of this text field.
void	setStringLength(int newStringLength) Sets the maximum string length of this text field.

Methods inherited from class net.wotonomy.ui.swing.components.SmartTextField

processKeyEvent

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, setText, setUI, updateUI, 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, 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

Field Detail

ALPHABETIC

public static final int ALPHABETIC

Sets the input to alphabetic characters only. The characters "a-z" and "A-Z" are the only valid characters. All other characters will be ignored.

See Also:

getAlphaType(), Constant Field Values

ALPHANUMERIC

public static final int ALPHANUMERIC

Sets the input to alphanumeric characters only. The characters "a-z", "A-Z" and "0-9" are the only valid characters. All other characters will be ignored.

See Also:

getAlphaType(), Constant Field Values

ALPHANUMERIC_PLUS

public static final int ALPHANUMERIC_PLUS

Sets the input to alphanumeric characters and a few special characters only. The valid characters are "a-z", "A-Z", "0-9", space, "-", "_", "\", and ":". This is helpful for file names (with paths) as input strings. All other characters will be ignored.

See Also:

getAlphaType(), Constant Field Values

ALL

public static final int ALL

Sets the input to all characters without restriction.

See Also:

getAlphaType(), Constant Field Values

Constructor Detail

AlphaTextField

public AlphaTextField()

The default constructor of this class. The default string of this text field is set to the empty string (""). The maximum length is set to 0, which specifies no limit.

AlphaTextField

public AlphaTextField(java.lang.String text)

Constructor of this class with the initial text of the text field specified. The maximum length is set to 0, which specifies no limit.

Parameters:

text - Initial text of the text field.

AlphaTextField

public AlphaTextField(int columns)

Constructor of this class with width (in columns) of the text field specified. The initial text is set to the empty string (""). The maximum length is set to 0, which specifies no limit.

Parameters:

columns - The width of the text field in characters.

AlphaTextField

public AlphaTextField(java.lang.String text,
                      int columns)

Constructor of this class with width (in columns) and initial text of the text field specified. The maximum length is set to 0, which specifies no limit.

Parameters:

text - Initial text of the text field.

columns - The width of the text field in characters.

AlphaTextField

public AlphaTextField(int anAlphaType,
                      int aLength)

Constructor that allows the user to set the Alpha type of the text field and the maximum string length.

Parameters:

anAlphaType - The character restriction type.

aLength - The maximum number of characters allowed in the string.

Method Detail

getAlphaType

public int getAlphaType()

Gets the current restriction type of this text field.

Returns:

The current restriction type as defined by the constansts of this class.

See Also:

ALPHABETIC, ALPHANUMERIC, ALPHANUMERIC_PLUS, ALL

setAlphaType

public void setAlphaType(int newAlphaType)

Sets the restriction type of this text field.

Parameters:

newAlphaType - The restriction of this text field.

See Also:

ALPHABETIC, ALPHANUMERIC, ALPHANUMERIC_PLUS, ALL

setStringLength

public void setStringLength(int newStringLength)

Sets the maximum string length of this text field. If the length is set to zero, then there is no limit. The default string length is zero. Negative sizes will set the length to zero.

Parameters:

newStringLength - The maximum length of the string that the user can input.

getStringLength

public int getStringLength()

Gets the current length of the maximum string size the user can enter.

Returns:

The maximum length the string of the text field can be.

isValidCharacter

protected boolean isValidCharacter(char aChar)

PROTECTED METHODS

Specified by:

isValidCharacter in class SmartTextField

Parameters:

aChar - A character to perform the validity test with.

Returns:

True if the character is valid for this subclassed text field.
False is the character is not valid.

isValidString

protected boolean isValidString(java.lang.String aString)

Description copied from class: SmartTextField

Returns whether a string is valid for this text field. As the user types from the keyboard, this method is called to determine if the new string in the text field is valid based upon the restriction of the subclass. This is done after the character has been determined to be valid since there can be restrictions placed on the text string as a whole, such a maximum length or date format.

Specified by:

isValidString in class SmartTextField

Parameters:

aString - The string to perform the validity check with.

Returns:

True if the string is valid for this subclassed text field.
False if the character is not valud.

postProcessing

protected void postProcessing()

Description copied from class: SmartTextField

This method is used by the any subclass that need to complete any processing of the text string in the text field after all the requirement checks have been performed.

Specified by:

postProcessing in class SmartTextField