FormTextArea (Tentackle Swing 2.1.1 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.text.JTextComponent
      - javax.swing.JTextArea
        
        org.tentackle.swing.FormTextArea

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, FormChangeable, FormChangeableComponent, FormComponent, FormFieldComponent

Direct Known Subclasses:

FormConsole
```
public class FormTextArea
extends JTextArea
implements FormFieldComponent
```
Extended JTextArea as a FormFieldComponent.

Author:

harald

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JTextArea
  JTextArea.AccessibleJTextArea
- Nested classes/interfaces inherited from class javax.swing.text.JTextComponent
  JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary
- Fields 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 org.tentackle.swing.FormFieldComponent
  ADJUST_LEFT, ADJUST_NONE, ADJUST_RIGHT, ADJUST_TRIM, CONVERT_LC, CONVERT_NONE, CONVERT_UC
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`FormTextArea()` Creates an empty `FormTextArea` with the default document model.
`FormTextArea(Document doc, String text, int rows, int columns)` Creates a `FormTextArea`.
`FormTextArea(int rows, int columns)` Creates an empty `FormTextArea` with the default document model.
`FormTextArea(String text)` Creates a `FormTextArea` with the default document model.
`FormTextArea(String text, int rows, int columns)` Creates a `FormTextArea` with the default document model.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActionListener(ActionListener l)` Adds the specified action listener to receive action events from this textfield.
`void`	`addValueListener(ValueListener l)` Adds a value listener that implements the binding between this component and the data.
`void`	`clearText()` Clears the contents of this component.
`void`	`clearValueShownModified()` Clears the value shown status. May be used by components that update the value shown programmatically.
`protected Document`	`createDefaultModel()`
`String`	`doFormat(Object object)` Does the formatting of the given object. Renders the object and returns the string.
`void`	`doSmartEnter()` Transfers the focus to the next field if it is the first key pressed in this JTextArea (and the cursor hasn't been moved by the mouse).
`void`	`downRight()` Move the caret to the right side of field and if already there move to next field.
`protected void`	`fireActionPerformed()` Notifies all listeners that have registered interest for notification on this event type.
`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.
`FormComponentBinding`	`getBinding()` Gets the binding.
`String`	`getBindingPath()` Gets the binding path.
`String`	`getComponentPath()` Gets the component path.
`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.
`FocusTraversalGroup`	`getFocusTraversalGroup()` Gets the focus traversal group for this component.
`String`	`getFormat()` Gets the format string.
`String`	`getFormValue()` Retrieves the value from this component. The method is used to update the data model if the view has changed because the user edited it.
`String`	`getHelpURL()` Gets the online-help URL.
`int`	`getHorizontalAlignment()` Not implemented in FormTextArea.
`String`	`getInvalidChars()` Gets invalid characters.
`int`	`getMaxColumns()` Gets the maximum number of columns.
`Dimension`	`getOptimalSize()` Calculates the dimensions for displaying the text according to the number of lines and max.
`Window`	`getParentWindow()` Gets the parent window of this component.
`PropertyGroup`	`getPropertyGroup()` Gets the property group for this component.
`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.
`String`	`getValueShown()` Gets the value shown to the user. This is the visual representation, not necessarily the model's value.
`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`	`isBindable()` Determines whether this component is bindable.
`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`	`isMandatory()` Gets the mandatory option.
`boolean`	`isNullIfEmpty()` Returns whether empty strings should be returned as null.
`boolean`	`isOverwrite()` Gets the current override mode.
`boolean`	`isSmartEnter()` Returns whether smart enter is enabled.
`boolean`	`isSmartValueEntered()` Returns whether the model should only be updated if the component's value really changed. The default is true.
`boolean`	`isStartEditLeftmost()` Returns whether to start edit leftmost in this component (once).
`boolean`	`isTriggerValueChangedEnabled()` Determines whether triggering value changes is enabled.
`boolean`	`isValueChanged()` Checks whether the contents have been changed since the last savepoint.
`boolean`	`isValueShownModified()` Checks whether the currently shown value differs from the initially shown. Used to implement smartValueEntered.
`void`	`postActionEvent()` Processes action events occurring on this textarea by dispatching them to any registered `ActionListener` objects.
`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)`
`protected void`	`processKeyEvent(KeyEvent e)`
`protected void`	`processMouseEvent(MouseEvent e)`
`void`	`removeActionListener(ActionListener l)` Removes the specified action listener so that it no longer receives action events from this textfield.
`void`	`removeValueListener(ValueListener l)` 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`	`setBindable(boolean bindable)` Sets whether this component is bindable.
`void`	`setBinding(FormComponentBinding binding)` Sets the binding.
`void`	`setBindingPath(String bindingPath)` Sets the path to bind this component to.
`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`	`setComponentPath(String componentPath)` Sets the component path.
`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`	`setEditable(boolean editable)`
`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`	`setFireRunning(boolean fireRunning)` Sets a component's flag that a fire-method is currently running. Used by the framework to minimize valueChanged/valueEntered processing.
`void`	`setFocusTraversalGroup(FocusTraversalGroup group)` Sets the focus traversal group for this component.
`void`	`setFormat(String pattern)` Sets the format string. The format string is used to format the view of the data.
`void`	`setFormTraversable(boolean formTraversable)` Sets whether this component is form traversable or not, i.e.
`void`	`setFormValue(Object object)` Sets a value in this component. The method is used to update the view if the data has changed.
`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`	`setHorizontalAlignment(int alignment)` Not implemented in FormTextArea.
`void`	`setInhibitAutoSelect(boolean inhibitAutoSelect)` Sets auto-select to be inhibited inhibited (once).
`void`	`setInvalidChars(String str)` Sets invalid characters.
`void`	`setMandatory(boolean mandatory)` Sets the mandatory option. Mandatory fields are differently visualized.
`void`	`setMaxColumns(int maxColumns)` Sets the maximum number of columns. The number of columns will be enforced by the model.
`void`	`setNullIfEmpty(boolean nullIfEmpty)` Sets whether empty strings should be returned as null.
`void`	`setOverwrite(boolean override)` Sets the insert/override mode.
`void`	`setPropertyGroup(PropertyGroup group)` Sets the property group for this component.
`void`	`setSmartEnter(boolean smartEnter)` Enable smart enter.
`void`	`setSmartValueEntered(boolean smartValueEntered)` Sets whether the model should only be updated if the component's value really changed. The default is true.
`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`	`setTriggerValueChangedEnabled(boolean enabled)` Enables triggering value changes. Disabling this feature may be necessary for model-agnostic components.
`void`	`setValidChars(String str)` Sets allowed characters.
`void`	`setVerticalAlignment(int alignment)` Sets the vertical alignment. Can only be used in Tentackle-LookAndFeels!
`void`	`showErrorPopup(String message)` Shows the error popup for a given message. The popup component used is an `ErrorToolTip`.
`void`	`showHelp()` Displays online help for this component. Usually triggered by KeyEvent.VK_F1 or VK_HELP or a button.
`void`	`transferFocus()` Transfers keyboard focus forward to the logically next component.
`void`	`transferFocusBackward()` Transfers keyboard focus forward to the logically previous component.
`void`	`triggerValueChanged()` Promotes the fact that value changed to all `FormContainer`s this component is a child of.
`void`	`updateAllChangeable(boolean allChangeable)` Updates the container's changeable flag.
`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.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, 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, setDocument, setDragEnabled, setDropMode, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, 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, 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.swing.FormFieldComponent
getCaretPosition, getColumns, setCaretPosition, setColumns, setToolTipText

Methods inherited from interface org.tentackle.swing.FormComponent
getBaseline, hasFocus

- Constructor Detail
  - FormTextArea
```
public FormTextArea(Document doc,
                    String text,
                    int rows,
                    int columns)
```
    Creates a FormTextArea.
    
    Parameters:
    
    doc - the document model, null if default FormFieldDocument.
    
    text - the text to be displayed, null if none
    
    rows - the number of rows ≥ 0
    
    columns - the number of columns ≥ 0
  - FormTextArea
```
public FormTextArea(String text,
                    int rows,
                    int columns)
```
    Creates a FormTextArea with the default document model.
    
    Parameters:
    
    text - the text to be displayed, null if none
    
    rows - the number of rows ≥ 0
    
    columns - the number of columns ≥ 0
  - FormTextArea
```
public FormTextArea(String text)
```
    Creates a FormTextArea with the default document model.
    
    Parameters:
    
    text - the text to be displayed, null if none
  - FormTextArea
```
public FormTextArea(int rows,
                    int columns)
```
    Creates an empty FormTextArea with the default document model.
    
    Parameters:
    
    rows - the number of rows ≥ 0
    
    columns - the number of columns ≥ 0
  - FormTextArea
```
public FormTextArea()
```
    Creates an empty FormTextArea with the default document model.
- Method Detail
  - showErrorPopup
```
public void showErrorPopup(String message)
```
    Description copied from interface: FormComponent
    
    Shows the error popup for a given message.
    The popup component used is an ErrorToolTip.
    
    Specified by:
    
    showErrorPopup in interface FormComponent
    
    Parameters:
    
    message - the message to be displayed, null to remove
  - setNullIfEmpty
```
public void setNullIfEmpty(boolean nullIfEmpty)
```
    Sets whether empty strings should be returned as null.
    
    Parameters:
    
    nullIfEmpty - true if zero-length input is treated as null (default)
  - isNullIfEmpty
```
public boolean isNullIfEmpty()
```
    Returns whether empty strings should be returned as null.
    
    Returns:
    
    true if zero-length input is treated as null (default)
  - getText
```
public String getText()
```
    Gets the text from the view of this component.
    Overridden because of nullIfEmpty
    
    Specified by:
    
    getText in interface FormFieldComponent
    
    Overrides:
    
    getText in class JTextComponent
    
    Returns:
    
    the text
  - isSmartEnter
```
public boolean isSmartEnter()
```
    Returns whether smart enter is enabled.
    
    Returns:
    
    true if smart enter is enabled (default)
  - setSmartEnter
```
public void setSmartEnter(boolean smartEnter)
```
    Enable smart enter. When enabled pressing the Enter-key at the start of the text area (as long as there are no other keys typed or mouse clicks) will move to the next field and will _not_ insert a newline. Inserting a newline can be achieved with Ctrl+Enter.
    
    Parameters:
    
    smartEnter - true to enable smart enter (default)
  - doSmartEnter
```
public void doSmartEnter()
```
    Transfers the focus to the next field if it is the first key pressed in this JTextArea (and the cursor hasn't been moved by the mouse). This allows the user to ENTER through all fields in a mask without worrying about textareas. In all other cases ENTER inserts a newline and moves the cursor after the newline (as expected).
  - addActionListener
```
public void addActionListener(ActionListener l)
```
    Adds the specified action listener to receive action events from this textfield.
    
    Parameters:
    
    l - the action listener to be added
  - removeActionListener
```
public void removeActionListener(ActionListener l)
```
    Removes the specified action listener so that it no longer receives action events from this textfield.
    
    Parameters:
    
    l - the action listener to be removed
  - fireActionPerformed
```
protected void fireActionPerformed()
```
    Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created. The listener list is processed in last to first order.
  - postActionEvent
```
public void postActionEvent()
```
    Processes action events occurring on this textarea by dispatching them to any registered ActionListener objects.
    
    Specified by:
    
    postActionEvent in interface FormFieldComponent
  - processFocusEvent
```
protected void processFocusEvent(FocusEvent e)
```
    Overridden for enhanced focus handling
    
    Overrides:
    
    processFocusEvent in class Component
  - processKeyEvent
```
protected void processKeyEvent(KeyEvent e)
```
    Overridden due to smart enter.
    
    Overrides:
    
    processKeyEvent in class JComponent
  - processMouseEvent
```
protected void processMouseEvent(MouseEvent e)
```
    Overridden due to smart enter.
    
    Overrides:
    
    processMouseEvent in class JComponent
  - createDefaultModel
```
protected Document createDefaultModel()
```
    Overridden to create a FormFieldDocument.
    
    Overrides:
    
    createDefaultModel in class JTextArea
  - getOptimalSize
```
public Dimension getOptimalSize()
```
    Calculates the dimensions for displaying the text according to the number of lines and max. chars in lines. If the text area is empty the preferred size is returned.
    
    Returns:
    
    the optimal size
  - getToolTipText
```
public String getToolTipText()
```
    Description copied from interface: FormFieldComponent
    
    Gets the tooltip text for this component.
    
    Specified by:
    
    getToolTipText in interface FormFieldComponent
    
    Overrides:
    
    getToolTipText in class JComponent
    
    Returns:
    
    the tooltip text, null = none
  - transferFocus
```
public void transferFocus()
```
    Transfers keyboard focus forward to the logically next component.
    Overridden to implement wasTransferFocus
    
    Specified by:
    
    transferFocus in interface FormComponent
    
    Overrides:
    
    transferFocus in class Component
    
    See Also:
    
    FormFocusTraversalPolicy
  - transferFocusBackward
```
public void transferFocusBackward()
```
    Transfers keyboard focus forward to the logically previous component.
    Overridden to implement wasTransferFocusBackward
    
    Specified by:
    
    transferFocusBackward in interface FormComponent
    
    Overrides:
    
    transferFocusBackward in class Component
    
    See Also:
    
    FormFocusTraversalPolicy
  - 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
  - setFocusTraversalGroup
```
public void setFocusTraversalGroup(FocusTraversalGroup group)
```
    Description copied from interface: FormComponent
    
    Sets the focus traversal group for this component.
    
    Specified by:
    
    setFocusTraversalGroup in interface FormComponent
    
    Parameters:
    
    group - the focus traversal group
  - getFocusTraversalGroup
```
public FocusTraversalGroup getFocusTraversalGroup()
```
    Description copied from interface: FormComponent
    
    Gets the focus traversal group for this component.
    
    Specified by:
    
    getFocusTraversalGroup in interface FormComponent
    
    Returns:
    
    the focus traversal group
  - setPropertyGroup
```
public void setPropertyGroup(PropertyGroup group)
```
    Description copied from interface: FormComponent
    
    Sets the property group for this component.
    
    Specified by:
    
    setPropertyGroup in interface FormComponent
    
    Parameters:
    
    group - the property group
  - getPropertyGroup
```
public PropertyGroup getPropertyGroup()
```
    Description copied from interface: FormComponent
    
    Gets the property group for this component.
    
    Specified by:
    
    getPropertyGroup in interface FormComponent
    
    Returns:
    
    the property group
  - setFormValue
```
public void setFormValue(Object object)
```
    Description copied from interface: FormComponent
    
    Sets a value in this component.
    The method is used to update the view if the data has changed.
    
    Specified by:
    
    setFormValue in interface FormComponent
    
    Parameters:
    
    object - is the object to set
  - getFormValue
```
public String getFormValue()
```
    Description copied from interface: FormComponent
    
    Retrieves the value from this component.
    The method is used to update the data model if the view has changed because the user edited it.
    
    Specified by:
    
    getFormValue in interface FormComponent
    
    Returns:
    
    the object from the form
  - 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:
    
    FormUtilities.openHelpURL(Component)
  - 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
  - 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
  - addValueListener
```
public void addValueListener(ValueListener l)
```
    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:
    
    l - the value listener to add
  - removeValueListener
```
public void removeValueListener(ValueListener l)
```
    Description copied from interface: FormComponent
    
    Remove a value listener.
    
    Specified by:
    
    removeValueListener in interface FormComponent
    
    Parameters:
    
    l - the value listener to remove
  - 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
  - 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()
  - setTriggerValueChangedEnabled
```
public void setTriggerValueChangedEnabled(boolean enabled)
```
    Description copied from interface: FormComponent
    
    Enables triggering value changes.
    Disabling this feature may be necessary for model-agnostic components.
    
    Specified by:
    
    setTriggerValueChangedEnabled in interface FormComponent
    
    Parameters:
    
    enabled - true if invoke FormComponent.triggerValueChanged() on each change (default), false if not.
  - isTriggerValueChangedEnabled
```
public boolean isTriggerValueChangedEnabled()
```
    Description copied from interface: FormComponent
    
    Determines whether triggering value changes is enabled.
    
    Specified by:
    
    isTriggerValueChangedEnabled in interface FormComponent
    
    Returns:
    
    true if invoke FormComponent.triggerValueChanged() on each change (default), false if not.
  - 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.
  - setChangeable
```
public void setChangeable(boolean changeable)
```
    Description copied from interface: FormChangeable
    
    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.
    
    Specified by:
    
    setChangeable in interface FormChangeable
    
    Parameters:
    
    changeable - true the user can edit the data, false if show only
  - isChangeable
```
public boolean isChangeable()
```
    Description copied from interface: FormChangeable
    
    Returns if this component is changeable.
    
    Specified by:
    
    isChangeable in interface FormChangeable
    
    Returns:
    
    true the user can edit the data, false if show only
  - setHonourChangeable
```
public void setHonourChangeable(boolean flag)
```
    Description copied from interface: FormChangeable
    
    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 FormChangeable
    
    Parameters:
    
    flag - true if honour the changeable attribute, false if not
  - isHonourChangeable
```
public boolean isHonourChangeable()
```
    Description copied from interface: FormChangeable
    
    Returns whether this component should honour the changeable-attribute or not.
    
    Specified by:
    
    isHonourChangeable in interface FormChangeable
    
    Returns:
    
    true if honour the changeable attribute, false if not
  - updateAllChangeable
```
public void updateAllChangeable(boolean allChangeable)
```
    Description copied from interface: FormChangeableComponent
    
    Updates the container's changeable flag.
    Whenever FormChangeable.setChangeable(boolean) is invoked all of the container's components get this method invoked.
    
    Specified by:
    
    updateAllChangeable in interface FormChangeableComponent
    
    Parameters:
    
    allChangeable - true if changeable
  - setEditable
```
public void setEditable(boolean editable)
```
    Overrides:
    
    setEditable in class JTextComponent
  - 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
  - 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
  - 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
  - setText
```
public void setText(String str)
```
    Description copied from interface: FormFieldComponent
    
    Sets the given text in the view of this component.
    
    Specified by:
    
    setText in interface FormFieldComponent
    
    Overrides:
    
    setText in class JTextComponent
    
    Parameters:
    
    str - the text
  - clearText
```
public void clearText()
```
    Description copied from interface: FormFieldComponent
    
    Clears the contents of this component.
    
    Specified by:
    
    clearText in interface FormFieldComponent
  - 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
  - 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
  - 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
  - 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
  - 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)
  - setAutoUpdate
```
public void setAutoUpdate(boolean autoupdate)
```
    Description copied from interface: FormComponent
    
    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 FormComponent
    
    Parameters:
    
    autoupdate - true if auto update the data (default), false if not
  - isAutoUpdate
```
public boolean isAutoUpdate()
```
    Description copied from interface: FormComponent
    
    Returns whether the auto-update feature is enabled.
    
    Specified by:
    
    isAutoUpdate in interface FormComponent
    
    Returns:
    
    true if auto update the data (default), false if not
  - setValidChars
```
public void setValidChars(String str)
```
    Description copied from interface: FormFieldComponent
    
    Sets allowed characters.
    
    Specified by:
    
    setValidChars in interface FormFieldComponent
    
    Parameters:
    
    str - 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 str)
```
    Description copied from interface: FormFieldComponent
    
    Sets invalid characters.
    
    Specified by:
    
    setInvalidChars in interface FormFieldComponent
    
    Parameters:
    
    str - 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)
  - 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
  - setFormat
```
public void setFormat(String pattern)
```
    Sets the format string.
    The format string is used to format the view of the data.
    The format will be ignored in FormTextArea.
    
    Specified by:
    
    setFormat in interface FormFieldComponent
    
    Parameters:
    
    pattern - the format string
  - getFormat
```
public String getFormat()
```
    Gets the format string.
    The format will be ignored in FormTextArea.
    
    Specified by:
    
    getFormat in interface FormFieldComponent
    
    Returns:
    
    the format string
  - doFormat
```
public String doFormat(Object object)
```
    Does the formatting of the given object.
    Renders the object and returns the string.
    The format will be ignored in FormTextArea.
    
    Specified by:
    
    doFormat in interface FormFieldComponent
    
    Parameters:
    
    object - the object
    
    Returns:
    
    just returns the given string
  - 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)
  - 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
  - setMaxColumns
```
public void setMaxColumns(int maxColumns)
```
    Description copied from interface: FormFieldComponent
    
    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.
    
    Specified by:
    
    setMaxColumns in interface FormFieldComponent
    
    Parameters:
    
    maxColumns - 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)
  - setDefaultColumns
```
public 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).
    Ignored in FormTextArea.
    
    Specified by:
    
    setDefaultColumns in interface FormFieldComponent
    
    Parameters:
    
    defaultColumns - the default columns
  - getDefaultColumns
```
public int getDefaultColumns()
```
    Description copied from interface: FormFieldComponent
    
    Gets the default columns.
    
    Specified by:
    
    getDefaultColumns in interface FormFieldComponent
    
    Returns:
    
    the default columns.
  - setHorizontalAlignment
```
public void setHorizontalAlignment(int alignment)
```
    Not implemented in FormTextArea.
    Sets the horizontal alignment.
    
    Specified by:
    
    setHorizontalAlignment in interface FormFieldComponent
    
    Parameters:
    
    alignment - the alignment
    
    See Also:
    
    Component
  - getHorizontalAlignment
```
public int getHorizontalAlignment()
```
    Not implemented in FormTextArea.
    Gets the horizontal alignment.
    
    Specified by:
    
    getHorizontalAlignment in interface FormFieldComponent
    
    Returns:
    
    the horizontal alignment
    
    See Also:
    
    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
  - 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)
```
    Description copied from interface: FormFieldComponent
    
    Sets auto-select to be inhibited inhibited (once).
    
    Specified by:
    
    setInhibitAutoSelect in interface FormFieldComponent
    
    Parameters:
    
    inhibitAutoSelect - true if inhibited
  - setFireRunning
```
public void setFireRunning(boolean fireRunning)
```
    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:
    
    fireRunning - 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
  - 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).
  - getConverter
```
public Function<String,String> 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(Function<String,String> converter)
```
    Description copied from interface: FormFieldComponent
    
    Sets the string converter.
    Besides the lower/uppercase conversion an optional converter may be set to translate characters.
    
    Specified by:
    
    setConverter in interface FormFieldComponent
    
    Parameters:
    
    converter - the converter, null if none (default)
  - getErrorOffset
```
public int getErrorOffset()
```
    Gets the offset in this components text for the first parsing error.
    
    By default, TextArea's don't provide formatting and thus no possibilities for errors.
    
    Specified by:
    
    getErrorOffset in interface FormFieldComponent
    
    Returns:
    
    always -1 (no error)
  - setErrorOffset
```
public void setErrorOffset(int errorOffset)
```
    Description copied from interface: FormFieldComponent
    
    Sets the error offset.
    
    Specified by:
    
    setErrorOffset in interface FormFieldComponent
    
    Parameters:
    
    errorOffset - the error offset in the text component, -1 to clear
  - getErrorMessage
```
public String getErrorMessage()
```
    Gets the parsing error message for the first error.
    By default, TextArea's don't provide formatting and thus no possibilities for errors.
    
    Specified by:
    
    getErrorMessage in interface FormFieldComponent
    
    Returns:
    
    always null (no error)
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Description copied from interface: FormFieldComponent
    
    Sets the error message.
    
    Specified by:
    
    setErrorMessage in interface FormFieldComponent
    
    Parameters:
    
    errorMessage - the message, null to clear
  - 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
  - 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
  - setMandatory
```
public void setMandatory(boolean mandatory)
```
    Description copied from interface: FormComponent
    
    Sets the mandatory option.
    Mandatory fields are differently visualized. There is no further functional difference.
    
    Specified by:
    
    setMandatory in interface FormComponent
    
    Parameters:
    
    mandatory - true if mandatory
  - isMandatory
```
public boolean isMandatory()
```
    Description copied from interface: FormComponent
    
    Gets the mandatory option.
    
    Specified by:
    
    isMandatory in interface FormComponent
    
    Returns:
    
    true if mandatory
  - setComponentPath
```
public void setComponentPath(String componentPath)
```
    Description copied from interface: FormComponent
    
    Sets the component path.
    The path is <declaring-class-name>.<field-name>. Example "de.krake.invoicer.InvoicePanel.customerNumberField".
    Notice: the component path is set during binding.
    
    Specified by:
    
    setComponentPath in interface FormComponent
    
    Parameters:
    
    componentPath - the component path
  - getComponentPath
```
public String getComponentPath()
```
    Description copied from interface: FormComponent
    
    Gets the component path.
    
    Specified by:
    
    getComponentPath in interface FormComponent
    
    Returns:
    
    the component path, null if not bound
  - setBindingPath
```
public void setBindingPath(String bindingPath)
```
    Description copied from interface: FormComponent
    
    Sets the path to bind this component to.
    Usually the binding path will be determined from the components declared name. However, it can be set programatically as well.
    
    Specified by:
    
    setBindingPath in interface FormComponent
    
    Parameters:
    
    bindingPath - the binding path, for ex. "invoiceNumber", null if autobinding
    
    See Also:
    
    Binder
  - getBindingPath
```
public String getBindingPath()
```
    Description copied from interface: FormComponent
    
    Gets the binding path.
    
    Specified by:
    
    getBindingPath in interface FormComponent
    
    Returns:
    
    the field path, null if autobinding (default)
  - setBinding
```
public void setBinding(FormComponentBinding binding)
```
    Description copied from interface: FormComponent
    
    Sets the binding.
    
    Specified by:
    
    setBinding in interface FormComponent
    
    Parameters:
    
    binding - the binding, null if none.
  - getBinding
```
public FormComponentBinding getBinding()
```
    Description copied from interface: FormComponent
    
    Gets the binding.
    
    Specified by:
    
    getBinding in interface FormComponent
    
    Returns:
    
    the binding, null if none
  - setBindable
```
public void setBindable(boolean bindable)
```
    Description copied from interface: FormComponent
    
    Sets whether this component is bindable.
    FormComponents are bindable by default.
    
    Specified by:
    
    setBindable in interface FormComponent
    
    Parameters:
    
    bindable - true if bindable, else not eligible for the binding process
  - isBindable
```
public boolean isBindable()
```
    Description copied from interface: FormComponent
    
    Determines whether this component is bindable.
    
    Specified by:
    
    isBindable in interface FormComponent
    
    Returns:
    
    true if bindable, else not eligible for the binding process
  - setSmartValueEntered
```
public void setSmartValueEntered(boolean smartValueEntered)
```
    Description copied from interface: FormComponent
    
    Sets whether the model should only be updated if the component's value really changed.
    The default is true.
    
    Specified by:
    
    setSmartValueEntered in interface FormComponent
    
    Parameters:
    
    smartValueEntered - true if optimize, false if always update the model
  - isSmartValueEntered
```
public boolean isSmartValueEntered()
```
    Description copied from interface: FormComponent
    
    Returns whether the model should only be updated if the component's value really changed.
    The default is true.
    
    Specified by:
    
    isSmartValueEntered in interface FormComponent
    
    Returns:
    
    true if optimize, false if always update the model
  - getValueShown
```
public String getValueShown()
```
    Description copied from interface: FormComponent
    
    Gets the value shown to the user.
    This is the visual representation, not necessarily the model's value. Used to implemement smartValueEntered.
    
    Specified by:
    
    getValueShown in interface FormComponent
    
    Returns:
    
    the value visible to the user
  - isValueShownModified
```
public boolean isValueShownModified()
```
    Description copied from interface: FormComponent
    
    Checks whether the currently shown value differs from the initially shown.
    Used to implement smartValueEntered.
    
    Specified by:
    
    isValueShownModified in interface FormComponent
    
    Returns:
    
    true if user changed the visual representation
  - clearValueShownModified
```
public void clearValueShownModified()
```
    Description copied from interface: FormComponent
    
    Clears the value shown status.
    May be used by components that update the value shown programmatically.
    
    Specified by:
    
    clearValueShownModified in interface FormComponent

Class FormTextArea

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JTextArea

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.text.JTextComponent

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface org.tentackle.swing.FormFieldComponent

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JTextArea

Methods inherited from class javax.swing.text.JTextComponent

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface org.tentackle.swing.FormFieldComponent

Methods inherited from interface org.tentackle.swing.FormComponent

Constructor Detail

FormTextArea

FormTextArea

FormTextArea

FormTextArea

FormTextArea

Method Detail

showErrorPopup

setNullIfEmpty

isNullIfEmpty

getText

isSmartEnter

setSmartEnter

doSmartEnter

addActionListener

removeActionListener

fireActionPerformed

postActionEvent

processFocusEvent

processKeyEvent

processMouseEvent

createDefaultModel

getOptimalSize

getToolTipText

transferFocus

transferFocusBackward

setFormTraversable

isFormTraversable

setFocusTraversalGroup

getFocusTraversalGroup

setPropertyGroup

getPropertyGroup

setFormValue

getFormValue

getHelpURL

setHelpURL

showHelp

requestFocusLater

addValueListener

removeValueListener

fireValueChanged

fireValueEntered

saveValue

isValueChanged

setTriggerValueChangedEnabled

isTriggerValueChangedEnabled

triggerValueChanged

setCellEditorUsage

isCellEditorUsage

setChangeable

isChangeable

setHonourChangeable

isHonourChangeable

updateAllChangeable

setEditable

prepareFocusLost

getParentWindow