Package edu.wisc.ssec.mcidasv.util

Class McVTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

edu.wisc.ssec.mcidasv.util.McVTextField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants

public class McVTextField
extends JTextField

Extend JTextField to add niceties such as uppercase, length limits, and allow/deny character sets

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	McVTextField.McVTextFieldDocument	Extend PlainDocument to get the character validation features we require
static class	McVTextField.Prompt

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

Modifier and Type	Field	Description
private McVTextField.McVTextFieldDocument	document
static Pattern	ipAddress
static char[]	mcidasDeny
private Pattern	validPattern
private String[]	validStrings

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 java.awt.image.ImageObserver

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

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

Constructor Summary

Constructors

Constructor	Description
McVTextField()
McVTextField(String defaultString)
McVTextField(String defaultString, boolean upper)
McVTextField(String defaultString, int limit)
McVTextField(String defaultString, int limit, boolean upper)
McVTextField(String defaultString, int limit, boolean upper, char[] allow, char[] deny)
McVTextField(String defaultString, int limit, boolean upper, String allow, String deny)
McVTextField(String defaultString, int limit, boolean upper, Pattern allow, Pattern deny)

Method Summary

Modifier and Type	Method	Description
private void	addInputVerifier()
int	getLimit()
boolean	getUppercase()
private Pattern	makePattern(char... characters)
private Pattern	makePattern(String string)
private void	removeInputVerifier()
void	setAllow(char... characters)
void	setAllow(char[] characters, boolean useComplete)
void	setAllow(String string)
void	setAllow(String string, boolean useComplete)
void	setAllow(Pattern newPattern)
void	setAllow(Pattern newPattern, boolean useComplete)	Change the regular expression used to match allowed strings.
void	setDeny(char... characters)
void	setDeny(char[] characters, boolean useComplete)
void	setDeny(String string)
void	setDeny(String string, boolean useComplete)
void	setDeny(Pattern newPattern)
void	setDeny(Pattern newPattern, boolean useComplete)	Change the regular expression used to match denied strings.
void	setLimit(int limit)
void	setUppercase(boolean uppercase)
void	setValidPattern(String string)
void	setValidPattern(Pattern pattern)
void	setValidStrings(String... strings)
private boolean	verifyInput()

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, modelToView2D, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, viewToModel2D, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

mcidasDeny

public static char[] mcidasDeny

ipAddress

public static Pattern ipAddress

document

private McVTextField.McVTextFieldDocument document

validPattern

private Pattern validPattern

validStrings

private String[] validStrings

Constructor Details

McVTextField

public McVTextField()

McVTextField

public McVTextField(String defaultString)

McVTextField

public McVTextField(String defaultString,
 int limit)

McVTextField

public McVTextField(String defaultString,
 boolean upper)

McVTextField

public McVTextField(String defaultString,
 int limit,
 boolean upper)

McVTextField

public McVTextField(String defaultString,
 int limit,
 boolean upper,
 String allow,
 String deny)

McVTextField

public McVTextField(String defaultString,
 int limit,
 boolean upper,
 char[] allow,
 char[] deny)

McVTextField

public McVTextField(String defaultString,
 int limit,
 boolean upper,
 Pattern allow,
 Pattern deny)

Method Details

getLimit

public int getLimit()

setLimit

public void setLimit(int limit)

getUppercase

public boolean getUppercase()

setUppercase

public void setUppercase(boolean uppercase)

setAllow

public void setAllow(char... characters)

See Also:

• setAllow(Pattern, boolean)

setAllow

public void setAllow(String string)

See Also:

• setAllow(Pattern, boolean)

setAllow

public void setAllow(Pattern newPattern)

See Also:

• setAllow(Pattern, boolean)

setAllow

public void setAllow(String string,
 boolean useComplete)

See Also:

• setAllow(Pattern, boolean)

setAllow

public void setAllow(char[] characters,
 boolean useComplete)

See Also:

• setAllow(Pattern, boolean)

setDeny

public void setDeny(char... characters)

See Also:

• setDeny(Pattern, boolean)

setDeny

public void setDeny(String string)

See Also:

• setDeny(Pattern, boolean)

setDeny

public void setDeny(Pattern newPattern)

See Also:

• setDeny(Pattern, boolean)

setDeny

public void setDeny(String string,
 boolean useComplete)

See Also:

• setDeny(Pattern, boolean)

setDeny

public void setDeny(char[] characters,
 boolean useComplete)

See Also:

• setDeny(Pattern, boolean)

setAllow

public void setAllow(Pattern newPattern,
 boolean useComplete)

Change the regular expression used to match allowed strings.

Note: if set to true, useComplete parameter will allow you to match newPattern against the complete text of this text field, including the tentative updates. If set to false, newPattern will be used against the only the updated characters.

Parameters:

newPattern - New regular expression. Cannot be null.

useComplete - Whether or not the complete contents of the text field should be used.

setDeny

public void setDeny(Pattern newPattern,
 boolean useComplete)

Change the regular expression used to match denied strings.

Note: if set to true, useComplete parameter will allow you to match newPattern against the complete text of this text field, including the tentative updates. If set to false, newPattern will be used against the only the updated characters.

Parameters:

newPattern - New regular expression. Cannot be null.

useComplete - Whether or not the complete contents of the text field should be used.

makePattern

private Pattern makePattern(String string)

makePattern

private Pattern makePattern(char... characters)

setValidPattern

public void setValidPattern(String string)

setValidPattern

public void setValidPattern(Pattern pattern)

setValidStrings

public void setValidStrings(String... strings)

addInputVerifier

private void addInputVerifier()

removeInputVerifier

private void removeInputVerifier()

verifyInput

private boolean verifyInput()