Package rma.swing

Class RmaJTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

rma.swing.RmaJTextField

All Implemented Interfaces:

FocusListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, Scrollable, SwingConstants, Modifiable, ModifiedEventControl, EditableComponent, FormManagementListener, RmaValidComponent

Direct Known Subclasses:

AbstractFileChooserField, RmaJ24HourTimeField, RmaJDateField, RmaJDecimalField, RmaJDssPathPartField, RmaJIntegerField, RmaJLongField, RmaJToggleField

public class RmaJTextField
extends JTextField
implements DocumentListener, RmaValidComponent, FocusListener, MouseMotionListener, FormManagementListener, Modifiable, ModifiedEventControl, EditableComponent

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RmaJTextField.RedoAction
class	RmaJTextField.UndoAction

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
protected RmaJTable	_minMaxTable
protected int	_minMaxTableCol
protected boolean	_modifiable
protected String	_name
protected Window	_parentWindow
protected JTextComponent	_statusLine
protected String	_statusText
protected boolean	_trimTrailingWhiteSpaceTxt
protected boolean	_trimTxt

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
RmaJTextField()	Constructs a new TextField.
RmaJTextField(int columns)	Constructs a new empty TextField with the specified number of columns.
RmaJTextField(String text)	Constructs a new TextField initialized with the specified text.
RmaJTextField(String text, int columns)	Constructs a new TextField initialized with the specified text and columns.
RmaJTextField(Document doc, String text, int columns)	Constructs a new JTextField that uses the given text storage model and the given number of columns.

Method Summary

Modifier and Type	Method	Description
void	addPopupAction(Action action)
void	changedUpdate(DocumentEvent e)
void	clearPerformed()	Called when the parent form calls clear().
protected Document	createDefaultModel()	Creates the default implementation of the model to be used at construction if one isn't explicitly given.
protected void	displayMsg(String msg)
protected boolean	displayMsgInQueue()
void	errorMsg(String msg)
protected String	fixToolTip(String superToolTip)
void	focusGained(FocusEvent e)	Invoked when a this component gains the keyboard focus.
void	focusLost(FocusEvent e)	Invoked when this component loses the keyboard focus.
boolean	forwardModifiedEvents()
boolean	getForwardModifiedEvents()
boolean	getIgnoreModifiedEvents()
int	getMaxLength()
String	getName()
String	getText()
String	getToolTipText()
String	getToolTipText(MouseEvent e)
void	insertUpdate(DocumentEvent e)
static final boolean	isCursorKey(int keyCode)	final because this gets checked for every keystroke
boolean	isEmptyOk()
boolean	isIgnoringModifiedEvents()
boolean	isModified()
boolean	isValid(boolean showErr)	return whether this component has valid data
void	mouseDragged(MouseEvent e)
void	mouseMoved(MouseEvent e)
protected void	popupMenuAction(Point pt)
static void	removeAWTEnterKeyCompatibility()
void	removeUpdate(DocumentEvent e)
void	replaceSelection(String content)
void	setChangeColor(Color changeColor)	set the foreground color when the user changes the text.
void	setDisplayMsgInQueue(boolean displayInQueue)
void	setDocument(Document doc)
void	setEditable(boolean b)
void	setEmptyOk(boolean b)
void	setEnabled(boolean b)
void	setFowardModifiedEvents(boolean b)	set whether this text field should forward modified events to it parent.
void	setIgnoreModifiedEvents(boolean ignore)
void	setIsEditable(boolean b)
void	setLowercaseOnly(boolean lowerOnly)
void	setMaxLength(int length)
void	setMinMaxTable(RmaJTable tbl, int col)
void	setModifiable(boolean b)
void	setModified(boolean b)
void	setName(String name)
void	setShowErrorMsg(boolean b)
void	setStatusLineField(JTextComponent statusLine, String statusText)	setup a status line field so when the mouse enters this field some status info text is displayed in the statusLine field.
void	setTrimTrailingWhiteSpace(boolean b)
void	setTrimWhiteSpace(boolean b)
void	setUppercaseOnly(boolean upperOnly)
protected void	showToolTipWindow()
void	takeFocus()	allows the text field to take the focus back while within the focusLost() method.
protected boolean	validateData(boolean showErrorMsg)

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, 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, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, 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, 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, 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, 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, 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

_minMaxTable

protected RmaJTable _minMaxTable

_minMaxTableCol

protected int _minMaxTableCol

_statusLine

protected JTextComponent _statusLine

_statusText

protected String _statusText

_name

protected String _name

_parentWindow

protected Window _parentWindow

_modifiable

protected boolean _modifiable

_trimTxt

protected boolean _trimTxt

_trimTrailingWhiteSpaceTxt

protected boolean _trimTrailingWhiteSpaceTxt

Constructor Details

RmaJTextField

public RmaJTextField(String text,
 int columns)

Constructs a new TextField initialized with the specified text and columns.

RmaJTextField

public RmaJTextField(Document doc,
 String text,
 int columns)

Constructs a new JTextField that uses the given text storage model and the given number of columns.

RmaJTextField

public RmaJTextField(int columns)

Constructs a new empty TextField with the specified number of columns.

RmaJTextField

public RmaJTextField()

Constructs a new TextField.

RmaJTextField

public RmaJTextField(String text)

Constructs a new TextField initialized with the specified text.

Method Details

removeAWTEnterKeyCompatibility

public static void removeAWTEnterKeyCompatibility()

showToolTipWindow

protected void showToolTipWindow()

popupMenuAction

protected void popupMenuAction(Point pt)

addPopupAction

public void addPopupAction(Action action)

replaceSelection

public void replaceSelection(String content)

Overrides:

replaceSelection in class JTextComponent

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class JComponent

setEditable

public void setEditable(boolean b)

Overrides:

setEditable in class JTextComponent

setChangeColor

public void setChangeColor(Color changeColor)

set the foreground color when the user changes the text.

setDocument

public void setDocument(Document doc)

Overrides:

setDocument in class JTextField

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

setEmptyOk

public void setEmptyOk(boolean b)

isEmptyOk

public boolean isEmptyOk()

errorMsg

public void errorMsg(String msg)

displayMsg

protected void displayMsg(String msg)

Parameters:

msg -

displayMsgInQueue

protected boolean displayMsgInQueue()

Returns:

setDisplayMsgInQueue

public void setDisplayMsgInQueue(boolean displayInQueue)

takeFocus

public void takeFocus()

allows the text field to take the focus back while within the focusLost() method.

isValid

public boolean isValid(boolean showErr)

return whether this component has valid data

Specified by:

isValid in interface RmaValidComponent

focusGained

public void focusGained(FocusEvent e)

Invoked when a this component gains the keyboard focus.

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Invoked when this component loses the keyboard focus.

Specified by:

focusLost in interface FocusListener

setTrimWhiteSpace

public void setTrimWhiteSpace(boolean b)

setTrimTrailingWhiteSpace

public void setTrimTrailingWhiteSpace(boolean b)

setShowErrorMsg

public void setShowErrorMsg(boolean b)

validateData

protected boolean validateData(boolean showErrorMsg)

setMinMaxTable

public void setMinMaxTable(RmaJTable tbl,
 int col)

setStatusLineField

public void setStatusLineField(JTextComponent statusLine,
 String statusText)

setup a status line field so when the mouse enters this field some status info text is displayed in the statusLine field. if statusLine is null then remove the mouselistener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

getName

public String getName()

Overrides:

getName in class Component

setName

public void setName(String name)

Overrides:

setName in class Component

getToolTipText

public String getToolTipText(MouseEvent e)

Overrides:

getToolTipText in class JTextComponent

getToolTipText

public String getToolTipText()

Overrides:

getToolTipText in class JComponent

fixToolTip

protected String fixToolTip(String superToolTip)

clearPerformed

public void clearPerformed()

Called when the parent form calls clear(). Part of the Form management listener interface

Specified by:

clearPerformed in interface FormManagementListener

getText

public String getText()

Overrides:

getText in class JTextComponent

isModified

public boolean isModified()

Specified by:

isModified in interface Modifiable

setModified

public void setModified(boolean b)

Specified by:

setModified in interface Modifiable

forwardModifiedEvents

public boolean forwardModifiedEvents()

getForwardModifiedEvents

public boolean getForwardModifiedEvents()

Specified by:

getForwardModifiedEvents in interface ModifiedEventControl

setFowardModifiedEvents

public void setFowardModifiedEvents(boolean b)

set whether this text field should forward modified events to it parent. by default it forwards the events.

Specified by:

setFowardModifiedEvents in interface ModifiedEventControl

Parameters:

b -

isCursorKey

public static final boolean isCursorKey(int keyCode)

final because this gets checked for every keystroke

setIsEditable

public void setIsEditable(boolean b)

Specified by:

setIsEditable in interface EditableComponent

setModifiable

public void setModifiable(boolean b)

setMaxLength

public void setMaxLength(int length)

getMaxLength

public int getMaxLength()

setUppercaseOnly

public void setUppercaseOnly(boolean upperOnly)

setLowercaseOnly

public void setLowercaseOnly(boolean lowerOnly)

setIgnoreModifiedEvents

public void setIgnoreModifiedEvents(boolean ignore)

Specified by:

setIgnoreModifiedEvents in interface ModifiedEventControl

isIgnoringModifiedEvents

public boolean isIgnoringModifiedEvents()

getIgnoreModifiedEvents

public boolean getIgnoreModifiedEvents()

Specified by:

getIgnoreModifiedEvents in interface ModifiedEventControl

createDefaultModel

protected Document createDefaultModel()

Creates the default implementation of the model to be used at construction if one isn't explicitly given. An instance of RMADocument is returned.

Overrides:

createDefaultModel in class JTextField

Returns:

the default model implementation