FormFieldComponent (Tentackle Swing 2.1.5 API)

All Superinterfaces:

FormChangeable, FormChangeableComponent, FormComponent

All Known Implementing Classes:

AbstractFormField, AbstractFractionNumberFormField, AbstractNumberFormField, BMoneyFormField, ByteFormField, DateFormField, DoubleFormField, FloatFormField, FormCalendarField, FormConsole, FormFieldComboBox, FormFieldComponentPanel, FormFileChooser, FormMailField, FormTelnoField, FormTextArea, FormUrlField, IntegerFormField, LongFormField, ShortFormField, StringFormField, TimeZoneComboBox, WeekdayComboBox
```
public interface FormFieldComponent
extends FormComponent
```
Extended FormComponent for editable text fields.
Adds features like max columns, autoselect, autotext, conversion, etc...

Author:

harald

Field Summary

Fields
Modifier and Type	Field and Description
`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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearText()` Clears the contents of this component.
`String`	`doFormat(Object object)` Does the formatting of the given object. Renders the object and returns the string.
`void`	`downRight()` Move the caret to the right side of field and if already there move to next field.
`char`	`getAdjust()` Gets the current adjustment.
`int`	`getCaretPosition()` Gets the caret position.
`int`	`getColumns()` Gets the columns.
`char`	`getConvert()` Gets the current convesion
`Function<String,String>`	`getConverter()` Gets the current converter.
`int`	`getDefaultColumns()` Gets the default columns.
`String`	`getErrorMessage()` Gets the parsing error message for the first error.
`int`	`getErrorOffset()` Gets the offset in this components text for the first parsing error.
`char`	`getFiller()` Gets the current fill char.
`String`	`getFormat()` Gets the format string.
`int`	`getHorizontalAlignment()` Gets the horizontal alignment.
`String`	`getInvalidChars()` Gets invalid characters.
`int`	`getMaxColumns()` Gets the maximum number of columns.
`String`	`getText()` Gets the text from the view of this component.
`String`	`getToolTipText()` Gets the tooltip text for this component.
`String`	`getValidChars()` Gets allowed characters.
`int`	`getVerticalAlignment()` Gets the vertical alignment.
`boolean`	`isAutoNext()` Returns whether the auto-next feature is enabled.
`boolean`	`isAutoSelect()` Returns whether the auto-select feature is enabled.
`boolean`	`isCaretLeft()` Returns whether carat is at leftmost position.
`boolean`	`isCaretRight()` Returns whether caret is at rightmost position.
`boolean`	`isEmpty()` Determines whether this component is empty.
`boolean`	`isEraseFirst()` Returns whether to erase the field after first setText().
`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).
`void`	`postActionEvent()` Invokes the action performed handler.
`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`	`setCaretLeft()` Sets the caret to leftmost position.
`void`	`setCaretPosition(int pos)` Sets the caret position.
`void`	`setCaretRight()` Sets the caret to rightmost position.
`void`	`setColumns(int columns)` Sets the number of columns in this component. The visible width is adjusted according to the current font.
`void`	`setConvert(char convert)` Sets character upper/lowercase conversion. Notice that changing the character conversion will immediately convert.
`void`	`setConverter(Function<String,String> converter)` Sets the string converter. Besides the lower/uppercase conversion an optional converter may be set to translate characters.
`void`	`setDefaultColumns(int defaultColumns)` Sets the default columns. The method is mainly provided for GUI-designers and will change the displayed size if, and only if, setColumns() and setMaxColumns() has not been invoked yet.
`void`	`setEraseFirst(boolean eraseFirst)` Sets whether to erase the field after first setText().
`void`	`setErrorMessage(String errorMessage)` Sets the error message.
`void`	`setErrorOffset(int errorOffset)` Sets the error offset.
`void`	`setFiller(char filler)` Sets the fill char. The fill char determines the adjustment of the text data.
`void`	`setFormat(String pattern)` Sets the format string. The format string is used to format the view of the data.
`void`	`setHorizontalAlignment(int alignment)` Sets the horizontal alignment.
`void`	`setInhibitAutoSelect(boolean inhibitAutoSelect)` Sets auto-select to be inhibited inhibited (once).
`void`	`setInvalidChars(String invalidChars)` Sets invalid characters.
`void`	`setMaxColumns(int maxColumns)` Sets the maximum number of columns. The number of columns will be enforced by the model.
`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 given text in the view of this component.
`void`	`setToolTipText(String text)` Sets the tooltip text for this component.
`void`	`setValidChars(String validChars)` Sets allowed characters.
`void`	`setVerticalAlignment(int alignment)` Sets the vertical alignment. Can only be used in Tentackle-LookAndFeels!
`void`	`upLeft()` Move caret to the left side of field and if already there move to previous field.

Methods inherited from interface org.tentackle.swing.FormComponent
addValueListener, clearValueShownModified, fireValueChanged, fireValueEntered, getBaseline, getBinding, getBindingPath, getComponentPath, getFocusTraversalGroup, getFormValue, getHelpURL, getParentWindow, getPropertyGroup, getValueShown, hasFocus, invalidateParentInfo, isAutoUpdate, isBindable, isCellEditorUsage, isFireRunning, isFormTraversable, isMandatory, isSmartValueEntered, isTriggerValueChangedEnabled, isValueChanged, isValueShownModified, prepareFocusLost, removeValueListener, requestFocusLater, saveValue, setAutoUpdate, setBindable, setBinding, setBindingPath, setCellEditorUsage, setComponentPath, setFireRunning, setFocusTraversalGroup, setFormTraversable, setFormValue, setFormWrapWindow, setHelpURL, setMandatory, setPropertyGroup, setSmartValueEntered, setTriggerValueChangedEnabled, showErrorPopup, showHelp, transferFocus, transferFocusBackward, triggerValueChanged, wasFocusGainedFromTransfer, wasFocusGainedFromTransferBackward, wasTransferFocus, wasTransferFocusBackward, wasTransferFocusByEnter

Methods inherited from interface org.tentackle.swing.FormChangeableComponent
updateAllChangeable

Methods inherited from interface org.tentackle.swing.FormChangeable
isChangeable, isHonourChangeable, setChangeable, setHonourChangeable

- Field Detail
  - ADJUST_NONE
```
static final char ADJUST_NONE
```
    no adjustment at all
    
    See Also:
    
    Constant Field Values
  - ADJUST_LEFT
```
static final char ADJUST_LEFT
```
    remove leading fillers
    
    See Also:
    
    Constant Field Values
  - ADJUST_RIGHT
```
static final char ADJUST_RIGHT
```
    remove trailing fillers
    
    See Also:
    
    Constant Field Values
  - ADJUST_TRIM
```
static final char ADJUST_TRIM
```
    trim to both sides (default)
    
    See Also:
    
    Constant Field Values
  - CONVERT_NONE
```
static final char CONVERT_NONE
```
    no conversion (default)
    
    See Also:
    
    Constant Field Values
  - CONVERT_UC
```
static final char CONVERT_UC
```
    to uppercase
    
    See Also:
    
    Constant Field Values
  - CONVERT_LC
```
static final char CONVERT_LC
```
    to lowercase
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setFormat
```
void setFormat(String pattern)
```
    Sets the format string.
    The format string is used to format the view of the data.
    
    Parameters:
    
    pattern - the format string
  - getFormat
```
String getFormat()
```
    Gets the format string.
    
    Returns:
    
    the format string
  - setAutoSelect
```
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. Useful for numerical fields, for example.
    
    Parameters:
    
    autoSelect - true if autoselect enabled, false if disabled (default)
  - isAutoSelect
```
boolean isAutoSelect()
```
    Returns whether the auto-select feature is enabled.
    
    Returns:
    
    true if autoselect enabled, false if disabled (default)
  - setAutoNext
```
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. Only meaningful if maxColumns > 0
    
    Parameters:
    
    autoNext - true if autonext enabled, false if disabled (default)
  - isAutoNext
```
boolean isAutoNext()
```
    Returns whether the auto-next feature is enabled.
    
    Returns:
    
    true if autonext enabled, false if disabled (default)
  - setConvert
```
void setConvert(char convert)
```
    Sets character upper/lowercase conversion.
    Notice that changing the character conversion will immediately convert.
    
    Parameters:
    
    convert - one of FormField.CONVERT_...
  - getConvert
```
char getConvert()
```
    Gets the current convesion
    
    Returns:
    
    the conversion, default is CONVERT_NONE
  - setConverter
```
void setConverter(Function<String,String> converter)
```
    Sets the string converter.
    Besides the lower/uppercase conversion an optional converter may be set to translate characters.
    
    Parameters:
    
    converter - the converter, null if none (default)
  - getConverter
```
Function<String,String> getConverter()
```
    Gets the current converter. Default is null.
    
    Returns:
    
    the converter.
  - setAdjust
```
void setAdjust(char adjust)
```
    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!
    
    Parameters:
    
    adjust - one of FormField.ADJUST_...
    
    See Also:
    
    setFiller(char)
  - getAdjust
```
char getAdjust()
```
    Gets the current adjustment.
    
    Returns:
    
    the adjustment, default ADJUST_TRIM
  - setMaxColumns
```
void setMaxColumns(int maxColumns)
```
    Sets the maximum number of columns.
    The number of columns will be enforced by the model.
    If JTextField.getColumns() == 0 the component will resize as if setColumns has been invoked with the given maxColumns. However, getColumns() remains 0.
    
    Parameters:
    
    maxColumns - the maximum number of columns, 0 if unlimited (default)
  - getMaxColumns
```
int getMaxColumns()
```
    Gets the maximum number of columns.
    
    Returns:
    
    the maximum number of columns, 0 if unlimited (default)
  - setDefaultColumns
```
void setDefaultColumns(int defaultColumns)
```
    Sets the default columns.
    The method is mainly provided for GUI-designers and will change the displayed size if, and only if, setColumns() and setMaxColumns() has not been invoked yet. The default columns will not affect the model in any way.
    With defaultColumns it is possible to set the width of a field to a reasonable size and let the application use setMaxColumn() to set the real value from the model (which is not available at design time).
    
    Parameters:
    
    defaultColumns - the default columns
  - getDefaultColumns
```
int getDefaultColumns()
```
    Gets the default columns.
    
    Returns:
    
    the default columns.
  - setFiller
```
void setFiller(char filler)
```
    Sets the fill char.
    The fill char determines the adjustment of the text data.
    
    Parameters:
    
    filler - the fill character
    
    See Also:
    
    setAdjust(char)
  - getFiller
```
char getFiller()
```
    Gets the current fill char.
    
    Returns:
    
    the filler, default is blank (space)
  - setOverwrite
```
void setOverwrite(boolean override)
```
    Sets the insert/override mode.
    
    Parameters:
    
    override - true if override, false if insert (default)
  - isOverwrite
```
boolean isOverwrite()
```
    Gets the current override mode.
    
    Returns:
    
    true if override, false if insert (default)
  - setValidChars
```
void setValidChars(String validChars)
```
    Sets allowed characters.
    
    Parameters:
    
    validChars - the valid characters, null = all (default)
  - getValidChars
```
String getValidChars()
```
    Gets allowed characters.
    
    Returns:
    
    the valid characters, null = all (default)
  - setInvalidChars
```
void setInvalidChars(String invalidChars)
```
    Sets invalid characters.
    
    Parameters:
    
    invalidChars - the invalid characters, null = none (default)
  - getInvalidChars
```
String getInvalidChars()
```
    Gets invalid characters.
    
    Returns:
    
    the invalid characters, null = none (default)
  - isCaretLeft
```
boolean isCaretLeft()
```
    Returns whether carat is at leftmost position.
    
    Returns:
    
    true if caret is at leftmost position
  - isCaretRight
```
boolean isCaretRight()
```
    Returns whether caret is at rightmost position.
    
    Returns:
    
    true if caret is at rightmost position
  - setCaretLeft
```
void setCaretLeft()
```
    Sets the caret to leftmost position.
  - setCaretRight
```
void setCaretRight()
```
    Sets the caret to rightmost position.
  - upLeft
```
void upLeft()
```
    Move caret to the left side of field and if already there move to previous field.
  - downRight
```
void downRight()
```
    Move the caret to the right side of field and if already there move to next field.
  - setEraseFirst
```
void setEraseFirst(boolean eraseFirst)
```
    Sets whether to erase the field after first setText().
    
    Parameters:
    
    eraseFirst - true to clear after first setText
  - isEraseFirst
```
boolean isEraseFirst()
```
    Returns whether to erase the field after first setText().
    
    Returns:
    
    true to clear after first setText
  - setInhibitAutoSelect
```
void setInhibitAutoSelect(boolean inhibitAutoSelect)
```
    Sets auto-select to be inhibited inhibited (once).
    
    Parameters:
    
    inhibitAutoSelect - true if inhibited
  - isInhibitAutoSelect
```
boolean isInhibitAutoSelect()
```
    Returns whether auto-select is inhibited (once).
    
    Returns:
    
    true if inhibited
  - clearText
```
void clearText()
```
    Clears the contents of this component.
  - doFormat
```
String doFormat(Object object)
```
    Does the formatting of the given object.
    Renders the object and returns the string.
    
    Parameters:
    
    object - the object
    
    Returns:
    
    the formatted object as a string
  - isEmpty
```
boolean isEmpty()
```
    Determines whether this component is empty.
    
    Returns:
    
    true if empty
  - setStartEditLeftmost
```
void setStartEditLeftmost(boolean startEditLeftmost)
```
    Sets whether to start edit leftmost in this component (once).
    
    Parameters:
    
    startEditLeftmost - true if start edit leftmost
  - isStartEditLeftmost
```
boolean isStartEditLeftmost()
```
    Returns whether to start edit leftmost in this component (once).
    
    Returns:
    
    true if start edit leftmost
  - getErrorOffset
```
int getErrorOffset()
```
    Gets the offset in this components text for the first parsing error.
    
    Returns:
    
    the error offset, -1 if no error
  - setErrorOffset
```
void setErrorOffset(int errorOffset)
```
    Sets the error offset.
    
    Parameters:
    
    errorOffset - the error offset in the text component, -1 to clear
  - getErrorMessage
```
String getErrorMessage()
```
    Gets the parsing error message for the first error.
    
    Returns:
    
    the error message (may be null)
  - setErrorMessage
```
void setErrorMessage(String errorMessage)
```
    Sets the error message.
    
    Parameters:
    
    errorMessage - the message, null to clear
  - postActionEvent
```
void postActionEvent()
```
    Invokes the action performed handler.
  - setText
```
void setText(String str)
```
    Sets the given text in the view of this component.
    
    Parameters:
    
    str - the text
  - getText
```
String getText()
```
    Gets the text from the view of this component.
    
    Returns:
    
    the text
  - setColumns
```
void setColumns(int columns)
```
    Sets the number of columns in this component.
    The visible width is adjusted according to the current font.
    
    Parameters:
    
    columns - the number of columns ≥ 0
  - getColumns
```
int getColumns()
```
    Gets the columns.
    
    Returns:
    
    the columns
  - setToolTipText
```
void setToolTipText(String text)
```
    Sets the tooltip text for this component.
    
    Parameters:
    
    text - the tooltip text, null = none
  - getToolTipText
```
String getToolTipText()
```
    Gets the tooltip text for this component.
    
    Returns:
    
    the tooltip text, null = none
  - setHorizontalAlignment
```
void setHorizontalAlignment(int alignment)
```
    Sets the horizontal alignment.
    
    Parameters:
    
    alignment - the alignment
    
    See Also:
    
    Component
  - getHorizontalAlignment
```
int getHorizontalAlignment()
```
    Gets the horizontal alignment.
    
    Returns:
    
    the horizontal alignment
    
    See Also:
    
    Component
  - setVerticalAlignment
```
void setVerticalAlignment(int alignment)
```
    Sets the vertical alignment.
    Can only be used in Tentackle-LookAndFeels!
    
    Parameters:
    
    alignment - the vertical alignment
  - getVerticalAlignment
```
int getVerticalAlignment()
```
    Gets the vertical alignment.
    
    Returns:
    
    the vertical alignment
  - setCaretPosition
```
void setCaretPosition(int pos)
```
    Sets the caret position.
    
    Parameters:
    
    pos - the caret position, 0 = start of field
  - getCaretPosition
```
int getCaretPosition()
```
    Gets the caret position.
    
    Returns:
    
    the caret position, 0 = start of field

Interface FormFieldComponent

Field Summary

Method Summary

Methods inherited from interface org.tentackle.swing.FormComponent

Methods inherited from interface org.tentackle.swing.FormChangeableComponent

Methods inherited from interface org.tentackle.swing.FormChangeable

Field Detail

ADJUST_NONE

ADJUST_LEFT

ADJUST_RIGHT

ADJUST_TRIM

CONVERT_NONE

CONVERT_UC

CONVERT_LC

Method Detail

setFormat

getFormat

setAutoSelect

isAutoSelect

setAutoNext

isAutoNext

setConvert

getConvert

setConverter

getConverter

setAdjust

getAdjust

setMaxColumns

getMaxColumns

setDefaultColumns

getDefaultColumns

setFiller

getFiller

setOverwrite

isOverwrite

setValidChars

getValidChars

setInvalidChars

getInvalidChars

isCaretLeft

isCaretRight

setCaretLeft

setCaretRight

upLeft

downRight

setEraseFirst

isEraseFirst

setInhibitAutoSelect

isInhibitAutoSelect

clearText

doFormat

isEmpty

setStartEditLeftmost

isStartEditLeftmost

getErrorOffset

setErrorOffset

getErrorMessage

setErrorMessage

postActionEvent

setText

getText

setColumns

getColumns

setToolTipText

getToolTipText

setHorizontalAlignment

getHorizontalAlignment

setVerticalAlignment

getVerticalAlignment

setCaretPosition

getCaretPosition