de.must.wuic

Class MustTextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

de.must.wuic.MustTextField

All Implemented Interfaces:

ModifiedInformer, SearchContent, ContextHelp, Undoable, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.Scrollable, javax.swing.SwingConstants

Direct Known Subclasses:

DataFloatField, DataLongField, DataTextField, FileStreamTextField, FilterTextField, InfoLinkTextField2, MustDateField, MustIntField, MustLongField, MustTimeField, ParamTextField, PointNumberField, RemTextField

public class MustTextField
extends javax.swing.JTextField
implements ContextHelp, java.awt.event.KeyListener, Undoable, ModifiedInformer, SearchContent

JTextField without keystroke binding to VK_ENTER, with length control and help context. The size is oriented to the char width of the char '0'

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.DropLocation, 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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	capitalization
protected java.lang.String	editBeginValue
protected MustTabbedPane	locatedTabbedPane
protected int	locatedTabbedPaneIndex
protected java.lang.String	textBefore
protected java.awt.Toolkit	thisToolkit
protected boolean	umlautTransformation

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
MustTextField() Constructs a new text field with a default size of 20 characters and no length control.
MustTextField(int length) Constructs a new text field with the specified length.
MustTextField(int length, int maxChars, boolean controlLength) Constructs a new text field with length, max chars and length control as specified.

Method Summary

Modifier and Type	Method and Description
void	addContentChangeListener(ContentChangeListener l) Adds the specified ContentChangeListener to receive content change events.
protected void	fireContentChanged()
protected void	fireContentChanged(int changeType)
protected void	fireContentChangedDelayed()
protected void	fireContentChangedDelayed(java.awt.event.KeyEvent e) Fires content change event after a delay.
protected int	getColumnWidth() Returns the column width.
java.lang.String	getContent()
java.lang.String	getEditBeginValue() Returns the value of the text field before user started editing.
java.lang.String	getHelpTarget() Returns the target of the component's help context.
java.lang.String	getHelpTopic() Returns the topic of the component's help context.
int	getMaxChars() Returns the maximum number of characters to be inserted.
java.awt.Dimension	getPreferredSize() Returns the preferred size.
RightMouseProvider	getRightMouseProvider() Returns the right mouse provider.
boolean	hasContent() Returns true if the textfield is filled with more than spaces.
boolean	isFilled() Indicates whether the component has a value.
boolean	isFilledEvenBlank() Indicates whether the component has a value even if value is blanks only.
boolean	isModified() Indicates whether the component's value differs from its initial value.
boolean	isRequired() Returns true if the text field is specified as mandatory.
boolean	isRequirementUnfulfilled() Returns true if the component's value is mandatory but not filled.
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e) Invoked when a key has been released.
void	keyTyped(java.awt.event.KeyEvent e)
void	removeContentChangeListener(ContentChangeListener l) Removes the specified ContentChangeListener to receive data selection events from this entity.
boolean	requestFocusInWindow() Set focus on the receiving component if isRequestFocusEnabled returns true and ensures, that the tabbed pane switches to the page where this text field is located.
void	setCapitalization(boolean capitalization) Sets the capitalization flag.
void	setCapitalizationAndUmlautTransformation(boolean b)
static void	setCapitalizationByDefault(boolean capitalization) Sets the default for capitalization.
void	setControlLength(boolean controlLength) Sets the length control flag.
void	setFont(java.awt.Font f) Sets the font.
void	setHelpContext(java.lang.String helpTopic) Sets the component's context help.
void	setHelpContext(java.lang.String helpTopic, java.lang.String helpTarget) Sets the component's context help.
void	setHttpParamToFetch(java.lang.String httpParamToFetch) Sets the parameter name to fetch the parameter value for the case input is a URL, e.g. by a QR code.
void	setMaxChars(int maxChars) Sets the maximum number of characters to be inserted
void	setOnSelectAllOnFocusGained() Sets on 'SelectAll' on event 'focusGained'.
void	setRequired(boolean required) Sets the previously added component to be mandatory.
void	setTabbedPaneLocation(MustTabbedPane locatedTabbedPane, int locatedTabbedPaneIndex) Sets the component's location on the tabbed pane.
void	setText(java.lang.String text) Sets the text.
void	setTextAsEditBeginValue(java.lang.String text) Sets the text as edit begin value which causes isModified to return false as long as user doesn't change the value.
void	setUmlautTransformation(boolean umlautTransformation)
void	undo() Undo last action.

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getHorizontalAlignment, getHorizontalVisibility, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setDocument, 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, replaceSelection, 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, 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, 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

Field Detail

capitalization

protected boolean capitalization

umlautTransformation

protected boolean umlautTransformation

thisToolkit

protected java.awt.Toolkit thisToolkit

textBefore

protected java.lang.String textBefore

editBeginValue

protected java.lang.String editBeginValue

locatedTabbedPane

protected MustTabbedPane locatedTabbedPane

locatedTabbedPaneIndex

protected int locatedTabbedPaneIndex

Constructor Detail

MustTextField

public MustTextField()

Constructs a new text field with a default size of 20 characters and no length control.

MustTextField

public MustTextField(int length)

Constructs a new text field with the specified length.

Parameters:

length - the length (size) of the text field max char specification above

MustTextField

public MustTextField(int length,
                     int maxChars,
                     boolean controlLength)

Constructs a new text field with length, max chars and length control as specified. length control.

Parameters:

length - the length (size) of the text field

maxChars - the max characters to be inserted

controlLength - if true, characters are removed, if they exceed the max char specification above

Method Detail

setCapitalizationByDefault

public static void setCapitalizationByDefault(boolean capitalization)

Sets the default for capitalization.

Parameters:

capitalization - whether capitalization should be default

setHttpParamToFetch

public void setHttpParamToFetch(java.lang.String httpParamToFetch)

Sets the parameter name to fetch the parameter value for the case input is a URL, e.g. by a QR code.

Parameters:

httpParamToFetch - the parameter name to use to fetch the input value

setControlLength

public void setControlLength(boolean controlLength)

Sets the length control flag.

Parameters:

controlLength - if true, characters are removed, if they exceed the length definition

getRightMouseProvider

public RightMouseProvider getRightMouseProvider()

Returns the right mouse provider.

Returns:

the right mouse provider

getMaxChars

public int getMaxChars()

Returns the maximum number of characters to be inserted.

Returns:

the maximum number of characters to be inserted

setMaxChars

public void setMaxChars(int maxChars)

Sets the maximum number of characters to be inserted

Parameters:

maxChars - the max characters to be inserted

setCapitalizationAndUmlautTransformation

public void setCapitalizationAndUmlautTransformation(boolean b)

setCapitalization

public void setCapitalization(boolean capitalization)

Sets the capitalization flag. If set, all typed letters are automatically transformed to upper case; Size of the text field is increased.

Parameters:

capitalization - whether all typed letters should be automatically transformed via upperCase();

setUmlautTransformation

public void setUmlautTransformation(boolean umlautTransformation)

setOnSelectAllOnFocusGained

public void setOnSelectAllOnFocusGained()

Sets on 'SelectAll' on event 'focusGained'. Useful for query fields which will be replaced by new entry in most of the cases.

setText

public void setText(java.lang.String text)

Sets the text.

Overrides:

setText in class javax.swing.text.JTextComponent

Parameters:

newText - the new text

setFont

public void setFont(java.awt.Font f)

Sets the font.

Overrides:

setFont in class javax.swing.JTextField

Parameters:

f - the new font.

getColumnWidth

protected int getColumnWidth()

Returns the column width.

Overrides:

getColumnWidth in class javax.swing.JTextField

Returns:

the column width

getPreferredSize

public java.awt.Dimension getPreferredSize()

Returns the preferred size.

Overrides:

getPreferredSize in class javax.swing.JTextField

Returns:

the preferred size

setRequired

public void setRequired(boolean required)

Sets the previously added component to be mandatory.

Parameters:

required - whether the component is mandatory or not

setHelpContext

public void setHelpContext(java.lang.String helpTopic)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

setHelpContext

public void setHelpContext(java.lang.String helpTopic,
                           java.lang.String helpTarget)

Sets the component's context help.

Specified by:

setHelpContext in interface ContextHelp

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

getHelpTopic

public java.lang.String getHelpTopic()

Returns the topic of the component's help context.

Specified by:

getHelpTopic in interface ContextHelp

Returns:

the topic of the component's help context

getHelpTarget

public java.lang.String getHelpTarget()

Returns the target of the component's help context.

Specified by:

getHelpTarget in interface ContextHelp

Returns:

the target of the component's help context

setTabbedPaneLocation

public void setTabbedPaneLocation(MustTabbedPane locatedTabbedPane,
                                  int locatedTabbedPaneIndex)

Sets the component's location on the tabbed pane.

Parameters:

locatedTabbedPane - the tabbed pane that contains this text field

locatedTabbedPaneIndex - the page's index of the tabbed pane

requestFocusInWindow

public boolean requestFocusInWindow()

Set focus on the receiving component if isRequestFocusEnabled returns true and ensures, that the tabbed pane switches to the page where this text field is located.

Overrides:

requestFocusInWindow in class javax.swing.JComponent

Returns:

isRequired

public boolean isRequired()

Returns true if the text field is specified as mandatory.

Returns:

true if the text field is specified as mandatory

isRequirementUnfulfilled

public boolean isRequirementUnfulfilled()

Returns true if the component's value is mandatory but not filled.

Returns:

if mandatory input is unfulfilled

setTextAsEditBeginValue

public void setTextAsEditBeginValue(java.lang.String text)

Sets the text as edit begin value which causes isModified to return false as long as user doesn't change the value.

Parameters:

newText - the new text

isFilledEvenBlank

public boolean isFilledEvenBlank()

Indicates whether the component has a value even if value is blanks only.

Returns:

true if the component has a value even if value is blanks only

isFilled

public boolean isFilled()

Indicates whether the component has a value.

Returns:

true if the component has a value

isModified

public boolean isModified()

Description copied from interface: ModifiedInformer

Indicates whether the component's value differs from its initial value.

Specified by:

isModified in interface ModifiedInformer

Returns:

true if the component's value differs from its initial value

getEditBeginValue

public java.lang.String getEditBeginValue()

Returns the value of the text field before user started editing.

Returns:

the value of the text field before user started editing

getContent

public java.lang.String getContent()

Specified by:

getContent in interface SearchContent

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Invoked when a key has been released. Used for length control.

Specified by:

keyReleased in interface java.awt.event.KeyListener

Parameters:

e - the key event

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

hasContent

public boolean hasContent()

Returns true if the textfield is filled with more than spaces.

Returns:

true if the textfield is filled with more than spaces

fireContentChangedDelayed

protected void fireContentChangedDelayed(java.awt.event.KeyEvent e)

Fires content change event after a delay. Thus, multiple typing may be treated as a single content change.

Parameters:

e - the key event causing the content change

fireContentChangedDelayed

protected void fireContentChangedDelayed()

addContentChangeListener

public void addContentChangeListener(ContentChangeListener l)

Adds the specified ContentChangeListener to receive content change events.

removeContentChangeListener

public void removeContentChangeListener(ContentChangeListener l)

Removes the specified ContentChangeListener to receive data selection events from this entity.

See Also:

DataSelectionEvent

fireContentChanged

protected void fireContentChanged()

fireContentChanged

protected void fireContentChanged(int changeType)

undo

public void undo()

Description copied from interface: Undoable

Undo last action.

Specified by:

undo in interface Undoable