org.tentackle.ui
Class FormField

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JTextField
                      org.tentackle.ui.FormField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, SwingConstants, FormComponent, FormFieldComponent

Direct Known Subclasses:

DateFormField, NumberFormField, StringFormField

public abstract class FormField
extends JTextField
implements FormFieldComponent

Abstract base class for all text fields.

All Tentackle beans providing a single-line text field bean subclass the FormField class which implements FormFieldComponent. FormFields provide a lot of features essential for typical business applications, such as data binding.

Author:

harald

See Also:

Serialized Form

Nested Class Summary

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

static char	ADJUST_LEFT remove leading fillers
static char	ADJUST_NONE no adjustment at all
static char	ADJUST_RIGHT remove trailing fillers
static char	ADJUST_TRIM trim to both sides (default)
static char	CONVERT_LC to lowercase
static char	CONVERT_NONE no conversion (default)
static char	CONVERT_UC to uppercase
protected int	errorOffset caret position for (first) error, -1 if no error

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

FormField()
Creates an empty FormField with the default document model, and minimum column width.

FormField(Document doc, String str, int columns)
Creates a FormField.
Notice: setting doc != null requires a doc derived from FormFieldDocument.

FormField(int columns)
Creates a FormField with the default document model and given column width.

FormField(String str)
Creates a FormField with the default document model, minimum width and given initial text.

FormField(String str, int columns)
Creates a FormField with the default document model.

Method Summary

void	addValueListener(ValueListener listener) Adds a value listener that implements the binding between this component and the data.
void	clearText() Clears the contents of this component.
protected Document	createDefaultModel() Creates the default implementation of the model to be used at construction if one isn't explicitly given.
void	doActionPerformed() Invokes the action performed handler.
void	downRight() Move the caret to the right side of field and if already there move to next field.
void	fireValueChanged() Fires all value listeners registered on this component invoking their valueChanged-handler. This method is invoked whenever the data has been changed and that change should be reflected in the view.
void	fireValueEntered() Fires all listeners registered on this component invoking their valueEntered-handler. This method is invoked whenever the user edited the view and that change should be reflected in the data.
char	getAdjust() Gets the current adjustment.
char	getConvert() Gets the current convesion
StringConverter	getConverter() Gets the current converter.
int	getErrorOffset() Gets the offset in this components text for the first error.
char	getFiller() Gets the current fill char.
String	getHelpURL() Gets the online-help URL.
String	getInvalidChars() Gets invalid characters.
int	getMaxColumns() Gets the maximum number of columns.
Window	getParentWindow() Gets the parent window of this component.
String	getText() Returns the text contained in this TextComponent.
String	getToolTipText() Returns the tooltip string that has been set with setToolTipText.
String	getValidChars() Gets allowed characters.
int	getVerticalAlignment() Gets the vertical alignment.
void	invalidateParentInfo() Invalidates all container-relevant (cached) information for the hierarchy of this component's parents. For optimization purposes.
boolean	isAutoNext() Returns whether the auto-next feature is enabled.
boolean	isAutoSelect() Returns whether the auto-select feature is enabled.
boolean	isAutoUpdate() Returns whether the auto-update feature is enabled.
boolean	isCaretLeft() Returns whether carat is at leftmost position.
boolean	isCaretRight() Returns whether caret is at rightmost position.
boolean	isCellEditorUsage() Returns whether this component is used as a cell editor.
boolean	isChangeable() Returns if this component is changeable.
boolean	isEmpty() Determines whether this component is empty.
boolean	isEraseFirst() Returns whether to erase the field after first setText().
boolean	isFireRunning() Checks whether a fire-method is running.
boolean	isFormTraversable() Returns whether this component is form traversable or not.
boolean	isHonourChangeable() Returns whether this component should honour the changeable-attribute or not.
boolean	isInhibitAutoSelect() Returns whether auto-select is inhibited (once).
boolean	isOverwrite() Gets the current override mode.
boolean	isStartEditLeftmost() Returns whether to start edit leftmost in this component (once).
boolean	isValueChanged() Checks whether the contents have been changed since the last savepoint.
void	prepareFocusLost() Prepares for FOCUS_LOST. Gives this component the opportunity to invoke fireValueEntered() earlier than FOCUS_LOST is really received.
protected void	processFocusEvent(FocusEvent e) Processes focus events occurring on this component by dispatching them to any registered FocusListener objects.
protected boolean	processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed) Invoked to process the key bindings for ks as the result of the KeyEvent e.
void	removeValueListener(ValueListener listener) Remove a value listener.
void	requestFocusLater() Requests the keyboard focus for this component by appending an event to the end of the event queue. Applications should not use requestFocus() or requestFocusInWindow() unless the order in which the events are processed is unimportant.
void	saveValue() Sets a savepoint for the data of this component. Allows to decide whether the user has changed the data associated with this component or not.
void	setAdjust(char adjust) Sets character adjustment. By default the text input data is trimmed, i.e.
void	setAutoNext(boolean autonext) Sets the auto-next feature. If autonext is enabled the next component will automatically receive the focus if the maximum number of characters is reached.
void	setAutoSelect(boolean autoselect) Sets the auto-select feature. A component with autoselect enabled will automatically select all characters if the component gets the keyboard focus.
void	setAutoUpdate(boolean autoupdate) Sets the auto-update feature. By default, all components update the data model if the view changes (due to certain events, for example focus lost).
void	setCaretLeft() Sets the caret to leftmost position.
void	setCaretRight() Sets the caret to rightmost position.
void	setCellEditorUsage(boolean flag) Sets a hint that this component is used as a cell editor. Some components behave differently in tables than in forms, for example.
void	setChangeable(boolean changeable) Set the component to be changeable. This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.
void	setColumns(int columns) Sets the number of columns in this TextField, and then invalidate the layout.
void	setConvert(char convert) Sets character upper/lowercase conversion. Notice that changing the character conversion will immediately convert.
void	setConverter(StringConverter converter) Sets the string converter. Besides the lower/uppercase conversion an optional StringConverter may be set to translate characters.
void	setEraseFirst(boolean erasefirst) Sets whether to erase the field after first setText().
void	setFiller(char filler) Sets the fill char. The fill char determines the adjustment of the text data.
void	setFireRunning(boolean running) Sets a component's flag that a fire-method is currently running. Used by the framework to minimize valueChanged/valueEntered processing.
void	setFormTraversable(boolean formTraversable) Sets whether this component is form traversable or not, i.e.
void	setFormWrapWindow(FormWindow parent) Sets the window that will fire a FormWrapEvent when this components loses the keyboard focus.
void	setHelpURL(String helpURL) Sets the online-help URL. If a help url is set for this component, a browser will be launched to show that url.
void	setHonourChangeable(boolean flag) Sets whether this component should honour the changeable-attribute or not. The default is true.
void	setInhibitAutoSelect(boolean inhibitAutoSelect) Sets auto-select to be inhibited inhibited (once).
void	setInvalidChars(String invalidChars) Sets invalid characters.
void	setMaxColumns(int columns) Sets the maximum number of columns.
void	setOverwrite(boolean override) Sets the insert/override mode.
void	setStartEditLeftmost(boolean startEditLeftmost) Sets whether to start edit leftmost in this component (once).
void	setText(String str) Sets the text of this TextComponent to the specified text.
void	setValidChars(String validChars) Sets allowed characters.
void	setVerticalAlignment(int alignment) Sets the vertical alignment. Can only be used in Tentackle-LookAndFeels!
void	showHelp() Displays online help for this component. Usually triggered by KeyEvent.VK_F1 or VK_HELP or a button.
void	transferFocus() Transfers the focus to the next component, as though this Component were the focus owner.
void	transferFocusBackward() Transfers the focus to the previous component, as though this Component were the focus owner.
void	triggerValueChanged() Promotes the fact that value changed to all FormContainers this component is a child of.
void	upLeft() Move caret to the left side of field and if already there move to previous field.
boolean	wasFocusGainedFromTransfer() Returns whether the keyboard focus was gained due to FormComponent.transferFocus() in the opposite component.
boolean	wasFocusGainedFromTransferBackward() Returns whether the keyboard focus was gained due to FormComponent.transferFocusBackward() in the opposite component.
boolean	wasTransferFocus() Returns whether this component lost the keyboard focus due to FormComponent.transferFocus().
boolean	wasTransferFocusBackward() Returns whether this component lost the keyboard focus due to FormComponent.transferFocusBackward().
boolean	wasTransferFocusByEnter() Returns whether this component lost the keyboard focus due to KeyEvent.VK_ENTER.

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, 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, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, 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, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tentackle.ui.FormFieldComponent

doFormat, getBaseline, getCaretPosition, getColumns, getFormat, getHorizontalAlignment, setCaretPosition, setFormat, setHorizontalAlignment, setToolTipText

Methods inherited from interface org.tentackle.ui.FormComponent

getFormValue, hasFocus, setFormValue

Field Detail

ADJUST_NONE

public static final char ADJUST_NONE

no adjustment at all

See Also:

Constant Field Values

ADJUST_LEFT

public static final char ADJUST_LEFT

remove leading fillers

See Also:

Constant Field Values

ADJUST_RIGHT

public static final char ADJUST_RIGHT

remove trailing fillers

See Also:

Constant Field Values

ADJUST_TRIM

public static final char ADJUST_TRIM

trim to both sides (default)

See Also:

Constant Field Values

CONVERT_NONE

public static final char CONVERT_NONE

no conversion (default)

See Also:

Constant Field Values

CONVERT_UC

public static final char CONVERT_UC

to uppercase

See Also:

Constant Field Values

CONVERT_LC

public static final char CONVERT_LC

to lowercase

See Also:

Constant Field Values

errorOffset

protected int errorOffset

caret position for (first) error, -1 if no error

Constructor Detail

FormField

public FormField(Document doc,
                 String str,
                 int columns)

Creates a FormField.
Notice: setting doc != null requires a doc derived from FormFieldDocument.

Parameters:

doc - the document model, null = default

str - the initial text, null = empty

columns - the number of columns, 0 = minimum width

FormField

public FormField(String str,
                 int columns)

Creates a FormField with the default document model.

Parameters:

str - the initial text, null = empty

columns - the number of columns, 0 = minimum width

FormField

public FormField(String str)

Creates a FormField with the default document model, minimum width and given initial text.

Parameters:

str - the initial text, null = empty

FormField

public FormField(int columns)

Creates a FormField with the default document model and given column width.

Parameters:

columns - the number of columns, 0 = minimum width

FormField

public FormField()

Creates an empty FormField with the default document model, and minimum column width.

Method Detail

processKeyBinding

protected boolean processKeyBinding(KeyStroke ks,
                                    KeyEvent e,
                                    int condition,
                                    boolean pressed)

Invoked to process the key bindings for ks as the result of the KeyEvent e. This obtains the appropriate InputMap, gets the binding, gets the action from the ActionMap, and then (if the action is found and the component is enabled) invokes notifyAction to notify the action.

Overridden: Changes the nerving behaviour that pressing backspace at the end of a selection clears the whole selection. Especially in autoselected numeric fields its often necessary to overtype the last digits. With this hack backspace simply clears the selection.

Overrides:

processKeyBinding in class JComponent

Parameters:

ks - the KeyStroke queried

e - the KeyEvent

condition - one of the following values:

• JComponent.WHEN_FOCUSED
• JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
• JComponent.WHEN_IN_FOCUSED_WINDOW

pressed - true if the key is pressed

Returns:

true if there was a binding to an action, and the action was enabled

setColumns

public void setColumns(int columns)

Sets the number of columns in this TextField, and then invalidate the layout.

Overridden to inhibit excessive geometry-management (for example in Gridbaglayout).

Specified by:

setColumns in interface FormFieldComponent

Overrides:

setColumns in class JTextField

Parameters:

columns - the number of columns >= 0

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 PlainDocument is returned.

Overridden to set the default FormFieldDocument.

Overrides:

createDefaultModel in class JTextField

Returns:

the default model implementation

processFocusEvent

protected void processFocusEvent(FocusEvent e)

Processes focus events occurring on this component by dispatching them to any registered FocusListener objects.

This method is not called unless focus events are enabled for this component. Focus events are enabled when one of the following occurs:

• A FocusListener object is registered via addFocusListener.
• Focus events are enabled via enableEvents.

If focus events are enabled for a Component, the current KeyboardFocusManager determines whether or not a focus event should be dispatched to registered FocusListener objects. If the events are to be dispatched, the KeyboardFocusManager calls the Component's dispatchEvent method, which results in a call to the Component's processFocusEvent method.

If focus events are enabled for a Component, calling the Component's dispatchEvent method with a FocusEvent as the argument will result in a call to the Component's processFocusEvent method regardless of the current KeyboardFocusManager.

Note that if the event parameter is null the behavior is unspecified and may result in an exception.

Overridden to perform focus handling and data binding

Overrides:

processFocusEvent in class Component

Parameters:

e - the focus event

See Also:

FocusEvent, FocusListener, KeyboardFocusManager, Component.addFocusListener(java.awt.event.FocusListener), Component.enableEvents(long), Component.dispatchEvent(java.awt.AWTEvent)

setText

public void setText(String str)

Sets the text of this TextComponent to the specified text. If the text is null or empty, has the effect of simply deleting the old text. When text has been inserted, the resulting caret location is determined by the implementation of the caret class.

This method is thread safe, although most Swing methods are not. Please see How to Use Threads for more information. Note that text is not a bound property, so no PropertyChangeEvent is fired when it changes. To listen for changes to the text, use DocumentListener.

Overridden to turn off autoNext during inserts and to implement eraseFirst.

Specified by:

setText in interface FormFieldComponent

Overrides:

setText in class JTextComponent

Parameters:

str - the new text to be set

See Also:

JTextComponent.getText(int, int), DefaultCaret

getText

public String getText()

Returns the text contained in this TextComponent. If the underlying document is null, will give a NullPointerException. Note that text is not a bound property, so no PropertyChangeEvent is fired when it changes. To listen for changes to the text, use DocumentListener.

Overridden because of text adjustment.

Specified by:

getText in interface FormFieldComponent

Overrides:

getText in class JTextComponent

Returns:

the text

See Also:

JTextComponent.setText(java.lang.String)

transferFocus

public void transferFocus()

Transfers the focus to the next component, as though this Component were the focus owner.

Ovwerwritten to set transferFocusDone.

Specified by:

transferFocus in interface FormComponent

Overrides:

transferFocus in class Component

See Also:

Component.requestFocus()

transferFocusBackward

public void transferFocusBackward()

Transfers the focus to the previous component, as though this Component were the focus owner.

Ovwerwritten to set transferFocusBackwardDone.

Specified by:

transferFocusBackward in interface FormComponent

Overrides:

transferFocusBackward in class Container

See Also:

Component.requestFocus()

addValueListener

public void addValueListener(ValueListener listener)

Description copied from interface: FormComponent

Adds a value listener that implements the binding between this component and the data.

Specified by:

addValueListener in interface FormComponent

Parameters:

listener - the value listener to add

removeValueListener

public void removeValueListener(ValueListener listener)

Description copied from interface: FormComponent

Remove a value listener.

Specified by:

removeValueListener in interface FormComponent

Parameters:

listener - the value listener to remove

requestFocusLater

public void requestFocusLater()

Description copied from interface: FormComponent

Requests the keyboard focus for this component by appending an event to the end of the event queue.
Applications should not use requestFocus() or requestFocusInWindow() unless the order in which the events are processed is unimportant. This method guarantees that this component gets the focus when all events queued so far have been processed.

Specified by:

requestFocusLater in interface FormComponent

fireValueChanged

public void fireValueChanged()

Description copied from interface: FormComponent

Fires all value listeners registered on this component invoking their valueChanged-handler.
This method is invoked whenever the data has been changed and that change should be reflected in the view.

Specified by:

fireValueChanged in interface FormComponent

fireValueEntered

public void fireValueEntered()

Description copied from interface: FormComponent

Fires all listeners registered on this component invoking their valueEntered-handler.
This method is invoked whenever the user edited the view and that change should be reflected in the data.

Specified by:

fireValueEntered in interface FormComponent

doActionPerformed

public void doActionPerformed()

Description copied from interface: FormFieldComponent

Invokes the action performed handler.

Specified by:

doActionPerformed in interface FormFieldComponent

saveValue

public void saveValue()

Description copied from interface: FormComponent

Sets a savepoint for the data of this component.
Allows to decide whether the user has changed the data associated with this component or not.

Specified by:

saveValue in interface FormComponent

See Also:

FormComponent.isValueChanged()

isValueChanged

public boolean isValueChanged()

Description copied from interface: FormComponent

Checks whether the contents have been changed since the last savepoint.

Specified by:

isValueChanged in interface FormComponent

Returns:

true if changed

See Also:

FormComponent.saveValue()

triggerValueChanged

public void triggerValueChanged()

Description copied from interface: FormComponent

Promotes the fact that value changed to all FormContainers this component is a child of.

Specified by:

triggerValueChanged in interface FormComponent

setCellEditorUsage

public void setCellEditorUsage(boolean flag)

Description copied from interface: FormComponent

Sets a hint that this component is used as a cell editor.
Some components behave differently in tables than in forms, for example.

Specified by:

setCellEditorUsage in interface FormComponent

Parameters:

flag - true if component is a cell editor, false if not.

isCellEditorUsage

public boolean isCellEditorUsage()

Description copied from interface: FormComponent

Returns whether this component is used as a cell editor.

Specified by:

isCellEditorUsage in interface FormComponent

Returns:

true true if component is a cell editor, false if not.

prepareFocusLost

public void prepareFocusLost()

Description copied from interface: FormComponent

Prepares for FOCUS_LOST.
Gives this component the opportunity to invoke fireValueEntered() earlier than FOCUS_LOST is really received. Useful because the next focused component is determined before FOCUS_LOST is sent to this component. Thus, if this component changes the focusability of the next component, the focus policy would probably pick the wrong component otherwise.

Specified by:

prepareFocusLost in interface FormComponent

showHelp

public void showHelp()

Description copied from interface: FormComponent

Displays online help for this component.
Usually triggered by KeyEvent.VK_F1 or VK_HELP or a button. If help is not configured for this component, the parent's help is used.

Specified by:

showHelp in interface FormComponent

clearText

public void clearText()

Description copied from interface: FormFieldComponent

Clears the contents of this component.

Specified by:

clearText in interface FormFieldComponent

isEmpty

public boolean isEmpty()

Description copied from interface: FormFieldComponent

Determines whether this component is empty.

Specified by:

isEmpty in interface FormFieldComponent

Returns:

true if empty

isCaretLeft

public boolean isCaretLeft()

Description copied from interface: FormFieldComponent

Returns whether carat is at leftmost position.

Specified by:

isCaretLeft in interface FormFieldComponent

Returns:

true if caret is at leftmost position

isCaretRight

public boolean isCaretRight()

Description copied from interface: FormFieldComponent

Returns whether caret is at rightmost position.

Specified by:

isCaretRight in interface FormFieldComponent

Returns:

true if caret is at rightmost position

upLeft

public void upLeft()

Description copied from interface: FormFieldComponent

Move caret to the left side of field and if already there move to previous field.

Specified by:

upLeft in interface FormFieldComponent

downRight

public void downRight()

Description copied from interface: FormFieldComponent

Move the caret to the right side of field and if already there move to next field.

Specified by:

downRight in interface FormFieldComponent

setCaretLeft

public void setCaretLeft()

Description copied from interface: FormFieldComponent

Sets the caret to leftmost position.

Specified by:

setCaretLeft in interface FormFieldComponent

setCaretRight

public void setCaretRight()

Description copied from interface: FormFieldComponent

Sets the caret to rightmost position.

Specified by:

setCaretRight in interface FormFieldComponent

setEraseFirst

public void setEraseFirst(boolean erasefirst)

Description copied from interface: FormFieldComponent

Sets whether to erase the field after first setText().

Specified by:

setEraseFirst in interface FormFieldComponent

Parameters:

erasefirst - true to clear after first setText

isEraseFirst

public boolean isEraseFirst()

Description copied from interface: FormFieldComponent

Returns whether to erase the field after first setText().

Specified by:

isEraseFirst in interface FormFieldComponent

Returns:

true to clear after first setText

setChangeable

public void setChangeable(boolean changeable)

Set the component to be changeable.
This is a unified abstraction and will be translated to setEditable or setEnabled, whatever is appropriate to this component.

Changeable is translated to editable.

Specified by:

setChangeable in interface FormComponent

Parameters:

changeable - true the user can edit the data, false if show only

isChangeable

public boolean isChangeable()

Description copied from interface: FormComponent

Returns if this component is changeable.

Specified by:

isChangeable in interface FormComponent

Returns:

true the user can edit the data, false if show only

setHonourChangeable

public void setHonourChangeable(boolean flag)

Description copied from interface: FormComponent

Sets whether this component should honour the changeable-attribute or not.
The default is true. Notice: if this component does not honour the changeable flag, isValueChanged() always returns false and it will not perform any saveValue().

Specified by:

setHonourChangeable in interface FormComponent

Parameters:

flag - true if honour the changeable attribute, false if not

isHonourChangeable

public boolean isHonourChangeable()

Description copied from interface: FormComponent

Returns whether this component should honour the changeable-attribute or not.

Specified by:

isHonourChangeable in interface FormComponent

Returns:

true if honour the changeable attribute, false if not

setMaxColumns

public void setMaxColumns(int columns)

Description copied from interface: FormFieldComponent

Sets the maximum number of columns.

Specified by:

setMaxColumns in interface FormFieldComponent

Parameters:

columns - the maximum number of columns, 0 if unlimited (default)

getMaxColumns

public int getMaxColumns()

Description copied from interface: FormFieldComponent

Gets the maximum number of columns.

Specified by:

getMaxColumns in interface FormFieldComponent

Returns:

the maximum number of columns, 0 if unlimited (default)

setConvert

public void setConvert(char convert)

Description copied from interface: FormFieldComponent

Sets character upper/lowercase conversion.
Notice that changing the character conversion will immediately convert.

Specified by:

setConvert in interface FormFieldComponent

Parameters:

convert - one of FormField.CONVERT_...

getConvert

public char getConvert()

Description copied from interface: FormFieldComponent

Gets the current convesion

Specified by:

getConvert in interface FormFieldComponent

Returns:

the conversion, default is CONVERT_NONE

setAdjust

public void setAdjust(char adjust)

Description copied from interface: FormFieldComponent

Sets character adjustment.
By default the text input data is trimmed, i.e. fill characters (space by default) to the left and right are removed. This is not be mixed up with the horizontal orientation!

Specified by:

setAdjust in interface FormFieldComponent

Parameters:

adjust - one of FormField.ADJUST_...

See Also:

FormFieldComponent.setFiller(char)

getAdjust

public char getAdjust()

Description copied from interface: FormFieldComponent

Gets the current adjustment.

Specified by:

getAdjust in interface FormFieldComponent

Returns:

the adjustment, default ADJUST_TRIM

setAutoSelect

public void setAutoSelect(boolean autoselect)

Description copied from interface: FormFieldComponent

Sets the auto-select feature.
A component with autoselect enabled will automatically select all characters if the component gets the keyboard focus. Useful for numerical fields, for example.

Specified by:

setAutoSelect in interface FormFieldComponent

Parameters:

autoselect - true if autoselect enabled, false if disabled (default)

isAutoSelect

public boolean isAutoSelect()

Description copied from interface: FormFieldComponent

Returns whether the auto-select feature is enabled.

Specified by:

isAutoSelect in interface FormFieldComponent

Returns:

true if autoselect enabled, false if disabled (default)

setAutoNext

public void setAutoNext(boolean autonext)

Description copied from interface: FormFieldComponent

Sets the auto-next feature.
If autonext is enabled the next component will automatically receive the focus if the maximum number of characters is reached. Only meaningful if maxColumns > 0

Specified by:

setAutoNext in interface FormFieldComponent

Parameters:

autonext - true if autonext enabled, false if disabled (default)

isAutoNext

public boolean isAutoNext()

Description copied from interface: FormFieldComponent

Returns whether the auto-next feature is enabled.

Specified by:

isAutoNext in interface FormFieldComponent

Returns:

true if autonext enabled, false if disabled (default)

setAutoUpdate

public void setAutoUpdate(boolean autoupdate)

Description copied from interface: FormFieldComponent

Sets the auto-update feature.
By default, all components update the data model if the view changes (due to certain events, for example focus lost).

Specified by:

setAutoUpdate in interface FormFieldComponent

Parameters:

autoupdate - true if auto update the data (default), false if not

isAutoUpdate

public boolean isAutoUpdate()

Description copied from interface: FormFieldComponent

Returns whether the auto-update feature is enabled.

Specified by:

isAutoUpdate in interface FormFieldComponent

Returns:

true if auto update the data (default), false if not

setValidChars

public void setValidChars(String validChars)

Description copied from interface: FormFieldComponent

Sets allowed characters.

Specified by:

setValidChars in interface FormFieldComponent

Parameters:

validChars - the valid characters, null = all (default)

getValidChars

public String getValidChars()

Description copied from interface: FormFieldComponent

Gets allowed characters.

Specified by:

getValidChars in interface FormFieldComponent

Returns:

the valid characters, null = all (default)

setInvalidChars

public void setInvalidChars(String invalidChars)

Description copied from interface: FormFieldComponent

Sets invalid characters.

Specified by:

setInvalidChars in interface FormFieldComponent

Parameters:

invalidChars - the invalid characters, null = none (default)

getInvalidChars

public String getInvalidChars()

Description copied from interface: FormFieldComponent

Gets invalid characters.

Specified by:

getInvalidChars in interface FormFieldComponent

Returns:

the invalid characters, null = none (default)

setFiller

public void setFiller(char filler)

Description copied from interface: FormFieldComponent

Sets the fill char.
The fill char determines the adjustment of the text data.

Specified by:

setFiller in interface FormFieldComponent

Parameters:

filler - the fill character

See Also:

FormFieldComponent.setAdjust(char)

getFiller

public char getFiller()

Description copied from interface: FormFieldComponent

Gets the current fill char.

Specified by:

getFiller in interface FormFieldComponent

Returns:

the filler, default is blank (space)

setOverwrite

public void setOverwrite(boolean override)

Description copied from interface: FormFieldComponent

Sets the insert/override mode.

Specified by:

setOverwrite in interface FormFieldComponent

Parameters:

override - true if override, false if insert (default)

isOverwrite

public boolean isOverwrite()

Description copied from interface: FormFieldComponent

Gets the current override mode.

Specified by:

isOverwrite in interface FormFieldComponent

Returns:

true if override, false if insert (default)

setStartEditLeftmost

public void setStartEditLeftmost(boolean startEditLeftmost)

Description copied from interface: FormFieldComponent

Sets whether to start edit leftmost in this component (once).

Specified by:

setStartEditLeftmost in interface FormFieldComponent

Parameters:

startEditLeftmost - true if start edit leftmost

isStartEditLeftmost

public boolean isStartEditLeftmost()

Description copied from interface: FormFieldComponent

Returns whether to start edit leftmost in this component (once).

Specified by:

isStartEditLeftmost in interface FormFieldComponent

Returns:

true if start edit leftmost

getErrorOffset

public int getErrorOffset()

Description copied from interface: FormFieldComponent

Gets the offset in this components text for the first error.

Specified by:

getErrorOffset in interface FormFieldComponent

Returns:

the error offset, -1 if no error

setFireRunning

public void setFireRunning(boolean running)

Description copied from interface: FormComponent

Sets a component's flag that a fire-method is currently running.
Used by the framework to minimize valueChanged/valueEntered processing.

Specified by:

setFireRunning in interface FormComponent

Parameters:

running - true if some fire-method is running

isFireRunning

public boolean isFireRunning()

Description copied from interface: FormComponent

Checks whether a fire-method is running.

Specified by:

isFireRunning in interface FormComponent

Returns:

true if some fire-method is running

isInhibitAutoSelect

public boolean isInhibitAutoSelect()

Description copied from interface: FormFieldComponent

Returns whether auto-select is inhibited (once).

Specified by:

isInhibitAutoSelect in interface FormFieldComponent

Returns:

true if inhibited

setInhibitAutoSelect

public void setInhibitAutoSelect(boolean inhibitAutoSelect)

Sets auto-select to be inhibited inhibited (once).

When set inhibits autoSelect once after having performed eraseFirst. This is necessary for components in a JTable because after pressing a key eraseFirst will be executed, then the key inserted and THEN the field gets the focusGained which will selectAll if autoSelect enabled. The eraseFirst is triggered in FormFieldComponentCellEditor. This flag is really package internal!

Specified by:

setInhibitAutoSelect in interface FormFieldComponent

Parameters:

inhibitAutoSelect - true if inhibited

setFormWrapWindow

public void setFormWrapWindow(FormWindow parent)

Description copied from interface: FormComponent

Sets the window that will fire a FormWrapEvent when this components loses the keyboard focus. When fired the reference to the window is cleared.

Specified by:

setFormWrapWindow in interface FormComponent

Parameters:

parent - the window (usually the parent window of this component).

setVerticalAlignment

public void setVerticalAlignment(int alignment)

Description copied from interface: FormFieldComponent

Sets the vertical alignment.
Can only be used in Tentackle-LookAndFeels!

Specified by:

setVerticalAlignment in interface FormFieldComponent

Parameters:

alignment - the vertical alignment

getVerticalAlignment

public int getVerticalAlignment()

Description copied from interface: FormFieldComponent

Gets the vertical alignment.

Specified by:

getVerticalAlignment in interface FormFieldComponent

Returns:

the vertical alignment

getHelpURL

public String getHelpURL()

Description copied from interface: FormComponent

Gets the online-help URL.

Specified by:

getHelpURL in interface FormComponent

Returns:

the help url, default is null

setHelpURL

public void setHelpURL(String helpURL)

Description copied from interface: FormComponent

Sets the online-help URL.
If a help url is set for this component, a browser will be launched to show that url. If there is no url the next higher level container will determine the url, and so forth.

Specified by:

setHelpURL in interface FormComponent

Parameters:

helpURL - the help url

See Also:

FormHelper.openHelpURL(Component)

getConverter

public StringConverter getConverter()

Description copied from interface: FormFieldComponent

Gets the current converter. Default is null.

Specified by:

getConverter in interface FormFieldComponent

Returns:

the converter.

setConverter

public void setConverter(StringConverter converter)

Description copied from interface: FormFieldComponent

Sets the string converter.
Besides the lower/uppercase conversion an optional StringConverter may be set to translate characters.

Specified by:

setConverter in interface FormFieldComponent

Parameters:

converter - the converter, null if none (default)

getParentWindow

public Window getParentWindow()

Description copied from interface: FormComponent

Gets the parent window of this component.

Specified by:

getParentWindow in interface FormComponent

Returns:

the parent window, null if none

invalidateParentInfo

public void invalidateParentInfo()

Description copied from interface: FormComponent

Invalidates all container-relevant (cached) information for the hierarchy of this component's parents.
For optimization purposes.

Specified by:

invalidateParentInfo in interface FormComponent

getToolTipText

public String getToolTipText()

Returns the tooltip string that has been set with setToolTipText.

Overridden to show tooltip in tooltipdisplay OR via mouse but not both.

Specified by:

getToolTipText in interface FormFieldComponent

Overrides:

getToolTipText in class JComponent

Returns:

the text of the tool tip

See Also:

JComponent.TOOL_TIP_TEXT_KEY

wasTransferFocus

public boolean wasTransferFocus()

Description copied from interface: FormComponent

Returns whether this component lost the keyboard focus due to FormComponent.transferFocus().

Specified by:

wasTransferFocus in interface FormComponent

Returns:

true if focus lost due to transferFocus

wasTransferFocusBackward

public boolean wasTransferFocusBackward()

Description copied from interface: FormComponent

Returns whether this component lost the keyboard focus due to FormComponent.transferFocusBackward().

Specified by:

wasTransferFocusBackward in interface FormComponent

Returns:

true if focus lost due to transferFocusBackward

wasFocusGainedFromTransfer

public boolean wasFocusGainedFromTransfer()

Description copied from interface: FormComponent

Returns whether the keyboard focus was gained due to FormComponent.transferFocus() in the opposite component.

Specified by:

wasFocusGainedFromTransfer in interface FormComponent

Returns:

true if this component gained the focus from the logically previous component

See Also:

FormFocusTraversalPolicy

wasFocusGainedFromTransferBackward

public boolean wasFocusGainedFromTransferBackward()

Description copied from interface: FormComponent

Returns whether the keyboard focus was gained due to FormComponent.transferFocusBackward() in the opposite component.

Specified by:

wasFocusGainedFromTransferBackward in interface FormComponent

Returns:

true if this component gained the focus from the logically next component

See Also:

FormFocusTraversalPolicy

wasTransferFocusByEnter

public boolean wasTransferFocusByEnter()

Description copied from interface: FormComponent

Returns whether this component lost the keyboard focus due to KeyEvent.VK_ENTER.

Specified by:

wasTransferFocusByEnter in interface FormComponent

Returns:

true if pressing the Enter/Return key caused a focus lost

setFormTraversable

public void setFormTraversable(boolean formTraversable)

Description copied from interface: FormComponent

Sets whether this component is form traversable or not, i.e. gets the focus or is skipped.

Specified by:

setFormTraversable in interface FormComponent

Parameters:

formTraversable - true if traversable, false if not

isFormTraversable

public boolean isFormTraversable()

Description copied from interface: FormComponent

Returns whether this component is form traversable or not.

Specified by:

isFormTraversable in interface FormComponent

Returns:

the focus traversable flag