xdev.ui

Class XdevTextArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextArea

xdev.ui.XdevTextArea

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, ClientProperties, FormularComponent<XdevTextArea>, TextComponent, XdevFocusCycleComponent

@BeanSettings(useXdevCustomizer=true)
public class XdevTextArea
extends JTextArea
implements ClientProperties, TextComponent, FormularComponent<XdevTextArea>, XdevFocusCycleComponent

The standard formatted textfield in XDEV. Based on JTextArea.

Since:

2.0

Author:

XDEV Software

See Also:

ClientProperties, FormularComponent, XdevFocusCycleComponent, 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

Nested classes/interfaces inherited from interface xdev.ui.FormularComponent

FormularComponent.ValueChangeListener

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 xdev.ui.ClientProperties

DATA_FIELD, FORMULAR_CONDITION_FILTER, FORMULAR_CONDITION_PRECISION, FORMULAR_FILTER_OPERATOR, FORMULAR_SKIP, FORMULAR_VERIFIER, TAG_DATA

Fields inherited from interface xdev.ui.FormularComponent

DATA_FIELD_SEPARATOR

Fields inherited from interface xdev.ui.XdevFocusCycleComponent

TAB_INDEX_PROPERTY

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
XdevTextArea() Constructor for creating a new instance of a XdevTextArea.
XdevTextArea(int maxSigns) Constructor for creating a new instance of a XdevTextArea.
XdevTextArea(String text) Constructor for creating a new instance of a XdevTextArea.
XdevTextArea(String text, int maxSigns) Constructor for creating a new instance of a XdevTextArea.

Method Summary

Modifier and Type	Method and Description
void	addDocumentListener(DocumentListener listener) Registers the given DocumentListener to begin receiving notifications when changes are made to the document.
void	addValidator(Validator validator) Adds a validator to this component
void	addValueChangeListener(FormularComponent.ValueChangeListener l) Registers a FormularComponent.ValueChangeListener.
String	getDataField() Returns the name of the bound data field of this formular component.
Operator	getFilterOperator() Returns the operator used in Formular.createCondition(String)
FocusGainedBehavior	getFocusGainedBehavior() Returns the FocusGainedBehavior of this TextComponent.
String	getFormularName() Returns the name of the component in the formular context.
Object	getFormularValue() Returns the value of the component.
int	getMaxSignCount() Returns the max sign count of this XdevTextArea.
Dimension	getPreferredSize()
String	getSelectedText() Returns the selected text contained in this XdevTextArea.
int	getTabIndex() Returns the tabindex assigned to this component.
TextChangedBehavior	getTextChangedBehavior() Return the TextChangedBehavior of this TextComponent
Validator[]	getValidators() Returns all validators of this component.
boolean	hasStateChanged() Checks if the component's state since the last call of FormularComponent.saveState() has changed.
void	insertText(String text) Inserts a String into this XdevTextArea.
boolean	isMultiSelect() Returns whether the component supports multi selection or not.
boolean	isReadOnly() Determines whether this component is only used to display values.
void	removeDocumentListener(DocumentListener listener) Unregisters the given DocumentListener from the notification list so it will no longer receive change updates.
void	removeValidator(Validator validator) Removes a validator from this component
void	restoreState() Restores the internally saved state of the component.
void	saveState() Saves the state of the component internally.
void	setDataField(String dataField) Sets the name of the bound data field of this formular component.
void	setFilterOperator(Operator filterOperator) Sets the filter operator used in Formular.createCondition(String)
void	setFocusGainedBehavior(FocusGainedBehavior focusGainedBehavior) Sets the new FocusGainedBehavior for this TextComponent.
void	setFormularValue(VirtualTable vt, int col, Object value) Deprecated.
void	setFormularValue(VirtualTable vt, Map<String,Object> record) Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().
void	setMaxSignCount(int maxSignCount) Sets the max sign count of this XdevTextArea.
void	setReadOnly(boolean readOnly) Sets if this form component is only used to display values.
void	setTabIndex(int tabIndex) Sets the tabindex of this component.
void	setText(String t) Sets the text of this TextComponent to the specified text.
void	setTextChangedBehavior(TextChangedBehavior textChangedBehavior) Sets the new TextChangedBehavior for this TextComponent.
String	toString()
void	validateState() Calls Validator.validate(Object) of all registered Validators.
void	validateState(Validation validation) Calls Validator.validate(Object) of all registered Validators.
boolean	verify() Returns whether the component's value adheres all set constraints.

Methods inherited from class javax.swing.JTextArea

append, createDefaultModel, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getRowHeight, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, insert, paramString, replaceRange, setColumns, setFont, setLineWrap, setRows, setTabSize, setWrapStyleWord

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, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, 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, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdev.ui.TextComponent

getText

Methods inherited from interface xdev.ui.FormularComponent

getClientProperty, isEnabled, isVisible, putClientProperty

Constructor Detail

XdevTextArea

public XdevTextArea()

Constructor for creating a new instance of a XdevTextArea.

XdevTextArea

public XdevTextArea(String text)

Constructor for creating a new instance of a XdevTextArea.

Parameters:

text - the text to be displayed, null if none

XdevTextArea

public XdevTextArea(int maxSigns)
             throws IllegalArgumentException

Constructor for creating a new instance of a XdevTextArea.

Parameters:

maxSigns - a int to determine the max signs of the MaxSignDocument

Throws:

IllegalArgumentException - if the maxSigns is <= 0

XdevTextArea

public XdevTextArea(String text,
                    int maxSigns)
             throws IllegalArgumentException

Constructor for creating a new instance of a XdevTextArea.

Parameters:

text - the text to be displayed, null if none

maxSigns - a int to determine the max signs of the MaxSignDocument

Throws:

IllegalArgumentException - if the maxSigns is <= 0

Method Detail

getFocusGainedBehavior

public FocusGainedBehavior getFocusGainedBehavior()

Returns the FocusGainedBehavior of this TextComponent.

Returns:

the FocusGainedBehavior of this TextComponent

Since:

3.1

setFocusGainedBehavior

public void setFocusGainedBehavior(FocusGainedBehavior focusGainedBehavior)

Sets the new FocusGainedBehavior for this TextComponent.

Parameters:

focusGainedBehavior - the new FocusGainedBehavior

Throws:

{@link - IllegalArgumentException} if focusGainedBehavior is null

Since:

3.1

getTextChangedBehavior

public TextChangedBehavior getTextChangedBehavior()

Return the TextChangedBehavior of this TextComponent

Returns:

the TextChangedBehavior of this TextComponent

Since:

4.0

setTextChangedBehavior

public void setTextChangedBehavior(TextChangedBehavior textChangedBehavior)

Sets the new TextChangedBehavior for this TextComponent.

Parameters:

textChangedBehavior - the new TextChangedBehavior

Throws:

{@link - IllegalArgumentException} if textChangedBehavior is null

Since:

4.0

setText

public void setText(String t)

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.

Specified by:

setText in interface TextComponent

Overrides:

setText in class JTextComponent

Parameters:

t - the new text to be set

See Also:

UIUtils.scrollToStart(javax.swing.JComponent)

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JTextArea

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Registers the given DocumentListener to begin receiving notifications when changes are made to the document.

Parameters:

listener - the DocumentListener to register

See Also:

removeDocumentListener(DocumentListener)

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Unregisters the given DocumentListener from the notification list so it will no longer receive change updates.

Parameters:

listener - the observer to register

See Also:

addDocumentListener(DocumentListener)

getFormularName

public String getFormularName()

Returns the name of the component in the formular context.

Specified by:

getFormularName in interface FormularComponent<XdevTextArea>

Returns:

the name of the component in the formular context.

setDataField

public void setDataField(String dataField)

Sets the name of the bound data field of this formular component.

Specified by:

setDataField in interface FormularComponent<XdevTextArea>

Parameters:

dataField - the new bound data field

Since:

3.1

getDataField

public String getDataField()

Returns the name of the bound data field of this formular component.

Specified by:

getDataField in interface FormularComponent<XdevTextArea>

Returns:

the name of the bound data field

Since:

3.1

getMaxSignCount

public int getMaxSignCount()

Returns the max sign count of this XdevTextArea.

Returns:

the max sign count of this XdevTextArea, -1 if the Document is not an instance of MaxSignDocument.

See Also:

MaxSignDocument

setMaxSignCount

public void setMaxSignCount(int maxSignCount)

Sets the max sign count of this XdevTextArea.

Parameters:

maxSignCount - the max sign count of this XdevTextArea

setFormularValue

@Deprecated
public final void setFormularValue(VirtualTable vt,
                                               int col,
                                               Object value)

Deprecated.

Sets the value of the component according to the provided value value. The value is formatted using the column format of the provided VirtualTable and columnIndex.

Specified by:

setFormularValue in interface FormularComponent<XdevTextArea>

Parameters:

vt - VirtualTable to use the format from

col - of the column to use the format from

value - value to set

setFormularValue

public void setFormularValue(VirtualTable vt,
                             Map<String,Object> record)

Sets the value of the component, taking the value(s) of the record according to FormularComponent.getDataField().

Specified by:

setFormularValue in interface FormularComponent<XdevTextArea>

Parameters:

vt - the underlying virtual table

record - the data <column,value>

Since:

3.2

getFormularValue

public Object getFormularValue()

Returns the value of the component.

Specified by:

getFormularValue in interface FormularComponent<XdevTextArea>

Returns:

the value of the component.

saveState

public void saveState()

Saves the state of the component internally.

A saved state can be restored using FormularComponent.restoreState().

Specified by:

saveState in interface FormularComponent<XdevTextArea>

restoreState

public void restoreState()

Restores the internally saved state of the component.

The state of the component can be saved using FormularComponent.saveState().

Specified by:

restoreState in interface FormularComponent<XdevTextArea>

hasStateChanged

public boolean hasStateChanged()

Checks if the component's state since the last call of FormularComponent.saveState() has changed.

Specified by:

hasStateChanged in interface FormularComponent<XdevTextArea>

Returns:

true if the component's state has changed, false otherwise

Since:

3.1

addValueChangeListener

public void addValueChangeListener(FormularComponent.ValueChangeListener l)

Registers a FormularComponent.ValueChangeListener.

Specified by:

addValueChangeListener in interface FormularComponent<XdevTextArea>

Parameters:

l - the listener to register

Since:

3.1

isMultiSelect

public boolean isMultiSelect()

Returns whether the component supports multi selection or not.

A component that supports multi selection can have more than one selected item / value.

Specified by:

isMultiSelect in interface FormularComponent<XdevTextArea>

Returns:

true if the component supports multi selection, false otherwise.

verify

public boolean verify()

Returns whether the component's value adheres all set constraints.

This is a alternative method for FormularComponent.validateState(), but this method returns a boolean depending on the validation's result and doesn't throw an ValidationException.

Specified by:

verify in interface FormularComponent<XdevTextArea>

Returns:

true if the value of the component adheres all set constraints; otherwise false.

addValidator

public void addValidator(Validator validator)

Adds a validator to this component

Specified by:

addValidator in interface FormularComponent<XdevTextArea>

Parameters:

validator - the validator to add

Since:

3.1

See Also:

FormularComponent.validateState()

removeValidator

public void removeValidator(Validator validator)

Removes a validator from this component

Specified by:

removeValidator in interface FormularComponent<XdevTextArea>

Parameters:

validator - the validator to remove

Since:

3.1

See Also:

FormularComponent.validateState()

getValidators

public Validator[] getValidators()

Returns all validators of this component.

If no validator is present an empty array is returned.

Specified by:

getValidators in interface FormularComponent<XdevTextArea>

Returns:

all validators of this component

Since:

3.1

validateState

public void validateState()
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Specified by:

validateState in interface FormularComponent<XdevTextArea>

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

validateState

public void validateState(Validation validation)
                   throws ValidationException

Calls Validator.validate(Object) of all registered Validators.

Every ValidationException is recorded in the validation object, and if Validation.continueValidation(ValidationException) returns false this exception is re-thrown by this method.

Specified by:

validateState in interface FormularComponent<XdevTextArea>

Parameters:

validation - the validation process object

Throws:

ValidationException

Since:

3.1

See Also:

FormularComponent.verify()

setFilterOperator

public void setFilterOperator(Operator filterOperator)

Sets the filter operator used in Formular.createCondition(String)

Specified by:

setFilterOperator in interface FormularComponent<XdevTextArea>

Parameters:

filterOperator - the new filter operator

Since:

3.1

getFilterOperator

public Operator getFilterOperator()

Returns the operator used in Formular.createCondition(String)

Specified by:

getFilterOperator in interface FormularComponent<XdevTextArea>

Returns:

the component's filter operator

Since:

3.1

setReadOnly

public void setReadOnly(boolean readOnly)

Sets if this form component is only used to display values.

Specified by:

setReadOnly in interface FormularComponent<XdevTextArea>

Parameters:

readOnly - true to only display values

Since:

3.2

isReadOnly

public boolean isReadOnly()

Determines whether this component is only used to display values.

Specified by:

isReadOnly in interface FormularComponent<XdevTextArea>

Returns:

true if this component is only used to display values.

Since:

3.2

getSelectedText

public String getSelectedText()
                       throws IllegalArgumentException

Returns the selected text contained in this XdevTextArea. If the selection is null or the document empty, returns a empty String.

Overrides:

getSelectedText in class JTextComponent

Returns:

the selected text, or a empty String

Throws:

IllegalArgumentException - if the selection doesn't have a valid mapping into the document for some reason

See Also:

setText(java.lang.String), JTextComponent.getSelectedText()

insertText

public void insertText(String text)
                throws IllegalArgumentException

Inserts a String into this XdevTextArea.

Parameters:

text - the String to insert

Throws:

IllegalArgumentException - if the caret position is not an valid position in the model

See Also:

JTextComponent.getCaretPosition(), Document.insertString(int, String, javax.swing.text.AttributeSet)

getTabIndex

public int getTabIndex()

Returns the tabindex assigned to this component. The tabindex defines the position of the component in the focus cycle.

Specified by:

getTabIndex in interface XdevFocusCycleComponent

Returns:

tabindex of this component

setTabIndex

public void setTabIndex(int tabIndex)

Sets the tabindex of this component. The tabindex defines the position of the component in the focus cycle.

To exclude this component from the focus cycle set tabindex to -1.

Specified by:

setTabIndex in interface XdevFocusCycleComponent

Parameters:

tabIndex - to be set

toString

public String toString()

Overrides:

toString in class Component