Package net.simplace.pipe.util.components

Class FWTextArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextArea

net.simplace.pipe.util.components.FWTextArea

All Implemented Interfaces:

FocusListener, MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, Scrollable

public class FWTextArea
extends JTextArea
implements MouseListener, FocusListener, DocumentListener

Predefines some default behaviour for text-inputfields.

Author:

jschoder, hschmitt

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
FWTextArea(boolean aRequired)	Default constructor.
FWTextArea(int aMaxSize, boolean aRequired)	This construcotr has the maxsize as parameter.
FWTextArea(String aString, boolean aRequired)	Default constructor.
FWTextArea(String aString, int aMaxSize, boolean aRequired)	Default constructor.
FWTextArea(String aString, int aMaxSize, int aMaxInput, boolean aRequiredBorder)	This construcotr has the maxsize and the maxInput as parameter.
FWTextArea(String aString, int aMaxSize, int aMaxInput, boolean aRequiredBorder, String aRegularExpression)	This construcotr has the maxsize and the maxInput as parameter.

Method Summary

Modifier and Type	Method	Description
void	changedUpdate(DocumentEvent eDocumentEvent)
Document	createDefaultModel()	Returns a new instance of LimitedDocument.
void	focusGained(FocusEvent aFocusEvent)
void	focusLost(FocusEvent aFocusEvent)
Color	getDefaultBackgroundColor()	Returns the default background color.
Color	getDisabledBackground()
Color	getDisabledForeground()
int	getMaxSize()
Color	getRequiredBackgroundColor()	Returns the required background color.
void	insertUpdate(DocumentEvent eDocumentEvent)
boolean	isRequired()	Returns the required mode.
void	mouseClicked(MouseEvent aMouseEvent)
void	mouseEntered(MouseEvent aMouseEvent)
void	mouseExited(MouseEvent aMouseEvent)
void	mousePressed(MouseEvent aMouseEvent)
void	mouseReleased(MouseEvent aMouseEvent)
void	removeUpdate(DocumentEvent eDocumentEvent)
void	setBorder(Border aBorder)
void	setDefaultBackgroundColor(Color aDefaultBackgroundColor)	Changes the default background color.
void	setDefaultForeground(Color aDefaultForeground)	Sets the default forground color used for enabled fields
void	setDisabledBackground(Color aDisabledBackground)
void	setDisabledForeground(Color aDisabledForeground)
void	setEditable(boolean aEditable)	Sets the editable property of the textfield.
void	setMaxSize(int aMaxSize)
void	setRequired(boolean aRequired)	Sets the required property of the textfield.
void	setRequiredBackgroundColor(Color aRequiredBackgroundColor)	Changes the required background color.
void	setText(String aText)
void	updateColors()

Methods inherited from class javax.swing.JTextArea

append, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getPreferredSize, 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, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, 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, viewToModel2D, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

FWTextArea

public FWTextArea(boolean aRequired)

Default constructor. Sets the default-textsize to this field.

FWTextArea

public FWTextArea(String aString,
 boolean aRequired)

Default constructor. Sets the default-textsize to this field.

FWTextArea

public FWTextArea(String aString,
 int aMaxSize,
 boolean aRequired)

Default constructor. Sets the default-textsize to this field.

FWTextArea

public FWTextArea(int aMaxSize,
 boolean aRequired)

This construcotr has the maxsize as parameter. This allows the developer to choose a size different from the default.

FWTextArea

public FWTextArea(String aString,
 int aMaxSize,
 int aMaxInput,
 boolean aRequiredBorder)

This construcotr has the maxsize and the maxInput as parameter. This allows the developer separate the MaxSize and the max. input of letters

FWTextArea

public FWTextArea(String aString,
 int aMaxSize,
 int aMaxInput,
 boolean aRequiredBorder,
 String aRegularExpression)

This construcotr has the maxsize and the maxInput as parameter. This allows the developer separate the MaxSize and the max. input of letters

Method Details

createDefaultModel

public Document createDefaultModel()

Returns a new instance of LimitedDocument.

Overrides:

createDefaultModel in class JTextArea

mouseReleased

public void mouseReleased(MouseEvent aMouseEvent)

Specified by:

mouseReleased in interface MouseListener

See Also:

• MouseListener.mouseReleased(java.awt.event.MouseEvent)

mouseEntered

public void mouseEntered(MouseEvent aMouseEvent)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent aMouseEvent)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent aMouseEvent)

Specified by:

mousePressed in interface MouseListener

mouseClicked

public void mouseClicked(MouseEvent aMouseEvent)

Specified by:

mouseClicked in interface MouseListener

setText

public void setText(String aText)

Overrides:

setText in class JTextComponent

See Also:

• JTextComponent.setText(java.lang.String)

focusGained

public void focusGained(FocusEvent aFocusEvent)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent aFocusEvent)

Specified by:

focusLost in interface FocusListener

updateColors

public void updateColors()

getMaxSize

public int getMaxSize()

Returns:

Returns the maxSize.

setMaxSize

public void setMaxSize(int aMaxSize)

Parameters:

aMaxSize - The maxSize to set.

isRequired

public boolean isRequired()

Returns the required mode.

setEditable

public void setEditable(boolean aEditable)

Sets the editable property of the textfield.

Overrides:

setEditable in class JTextComponent

setRequired

public void setRequired(boolean aRequired)

Sets the required property of the textfield.

getRequiredBackgroundColor

public Color getRequiredBackgroundColor()

Returns the required background color.

setRequiredBackgroundColor

public void setRequiredBackgroundColor(Color aRequiredBackgroundColor)

Changes the required background color.

getDefaultBackgroundColor

public Color getDefaultBackgroundColor()

Returns the default background color.

setDefaultBackgroundColor

public void setDefaultBackgroundColor(Color aDefaultBackgroundColor)

Changes the default background color.

insertUpdate

public void insertUpdate(DocumentEvent eDocumentEvent)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent eDocumentEvent)

Specified by:

removeUpdate in interface DocumentListener

changedUpdate

public void changedUpdate(DocumentEvent eDocumentEvent)

Specified by:

changedUpdate in interface DocumentListener

setDefaultForeground

public void setDefaultForeground(Color aDefaultForeground)

Sets the default forground color used for enabled fields

getDisabledBackground

public Color getDisabledBackground()

Returns:

the background color for disabled components

setDisabledBackground

public void setDisabledBackground(Color aDisabledBackground)

Parameters:

aDisabledBackground -

getDisabledForeground

public Color getDisabledForeground()

Returns:

the foreground color for disabled components

setDisabledForeground

public void setDisabledForeground(Color aDisabledForeground)

Parameters:

aDisabledForeground -

setBorder

public void setBorder(Border aBorder)

Overrides:

setBorder in class JComponent

See Also:

• JComponent.setBorder(javax.swing.border.Border)