de.must.wuic

Class MustTextArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextArea

de.must.wuic.MustTextArea

All Implemented Interfaces:

ModifiedInformer, ContextHelp, Undoable, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.Scrollable

Direct Known Subclasses:

DataTextArea, FileStreamField, InfoTextArea, ParamTextArea, RemTextArea

public class MustTextArea
extends javax.swing.JTextArea
implements ContextHelp, java.awt.event.KeyListener, Undoable, ModifiedInformer

Text input Area with context help among others.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JTextArea.AccessibleJTextArea

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

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	editBeginValue

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 and Description
MustTextArea()
MustTextArea(int rows, int columns) Constructs a new text area with a size as specified.
MustTextArea(int rows, int columns, int maxChars) Constructs a new text area with a size as specified.
MustTextArea(java.lang.String info) Constructs a new text area with a default width of 60 characters and default height of 3 rows with the initial text as specified.
MustTextArea(java.lang.String text, int rows, int columns) Constructs a new text area with initial text and size as specified.
MustTextArea(java.lang.String text, int rows, int columns, int maxChars) Constructs a new text area with initial text and size as specified.

Method Summary

Modifier and Type	Method and Description
void	free() Releases external resources.
java.lang.String	getHelpTarget()
java.lang.String	getHelpTopic()
RightMouseProvider	getRightMouseProvider() Returns the right mouse provider.
boolean	isFilled() Indicates whether the component has a value.
boolean	isModified() Indicates whether the component's value differs from its initial value.
boolean	isRequired() Returns true if the text field is specified as mandatory.
boolean	isRequirementUnfulfilled() Returns true if the component's value is mandatory but not filled.
void	keyPressed(java.awt.event.KeyEvent e) Invoked when a key has been pressed.
void	keyReleased(java.awt.event.KeyEvent e) Invoked when a key has been released.
void	keyTyped(java.awt.event.KeyEvent e) Invoked when a key has been typed.
void	setHelpContext(java.lang.String helpTopic) Sets the component's context help.
void	setHelpContext(java.lang.String helpTopic, java.lang.String helpTarget) Sets the component's context help.
void	setMaxChars(int maxChars) Sets the maximum of characters to be inserted.
void	setRequired(boolean required) Sets the previously added component to be mandatory.
void	setText(java.lang.String t)
void	setTextAsEditBeginValue(java.lang.String text) Sets the text as edit begin value which causes isModified to return false as long as user doesn't change the value.
void	undo() Undo last action.

Methods inherited from class javax.swing.JTextArea

append, createDefaultModel, 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, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

editBeginValue

protected java.lang.String editBeginValue

Constructor Detail

MustTextArea

public MustTextArea()

MustTextArea

public MustTextArea(java.lang.String info)

Constructs a new text area with a default width of 60 characters and default height of 3 rows with the initial text as specified.

Parameters:

info - the initial text

MustTextArea

public MustTextArea(int rows,
                    int columns)

Constructs a new text area with a size as specified.

Parameters:

rows - the number of rows used for rendering

columns - the number of columns to determine the width

MustTextArea

public MustTextArea(int rows,
                    int columns,
                    int maxChars)

Constructs a new text area with a size as specified.

Parameters:

rows - the number of rows used for rendering

columns - the number of columns to determine the width

maxChars - the maximum number of characters for input

MustTextArea

public MustTextArea(java.lang.String text,
                    int rows,
                    int columns)

Constructs a new text area with initial text and size as specified.

Parameters:

text - the initial text of the text area

rows - the number of rows used for rendering

columns - the number of columns to determine the width

MustTextArea

public MustTextArea(java.lang.String text,
                    int rows,
                    int columns,
                    int maxChars)

Constructs a new text area with initial text and size as specified.

Parameters:

text - the initial text of the text area

rows - the number of rows used for rendering

columns - the number of columns to determine the width

maxChars - the maximum number of characters for input

Method Detail

getRightMouseProvider

public RightMouseProvider getRightMouseProvider()

Returns the right mouse provider.

Returns:

the right mouse provider

setHelpContext

public void setHelpContext(java.lang.String helpTopic)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

setHelpContext

public void setHelpContext(java.lang.String helpTopic,
                           java.lang.String helpTarget)

Sets the component's context help.

Specified by:

setHelpContext in interface ContextHelp

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

getHelpTopic

public java.lang.String getHelpTopic()

Specified by:

getHelpTopic in interface ContextHelp

Returns:

the topic of the component's help context

getHelpTarget

public java.lang.String getHelpTarget()

Specified by:

getHelpTarget in interface ContextHelp

Returns:

the target of the component's help context

setMaxChars

public void setMaxChars(int maxChars)

Sets the maximum of characters to be inserted.

Parameters:

maxChars - the max characters to be inserted

setRequired

public void setRequired(boolean required)

Sets the previously added component to be mandatory.

Parameters:

required - whether the component is mandatory or not

isRequired

public boolean isRequired()

Returns true if the text field is specified as mandatory.

Returns:

true if the text field is specified as mandatory

isRequirementUnfulfilled

public boolean isRequirementUnfulfilled()

Returns true if the component's value is mandatory but not filled.

Returns:

if mandatory input is unfulfilled

setTextAsEditBeginValue

public void setTextAsEditBeginValue(java.lang.String text)

Sets the text as edit begin value which causes isModified to return false as long as user doesn't change the value.

Parameters:

newText - the new text

setText

public void setText(java.lang.String t)

Overrides:

setText in class javax.swing.text.JTextComponent

isFilled

public boolean isFilled()

Indicates whether the component has a value.

Returns:

true if the component has a value

isModified

public boolean isModified()

Description copied from interface: ModifiedInformer

Indicates whether the component's value differs from its initial value.

Specified by:

isModified in interface ModifiedInformer

Returns:

true if the component's value differs from its initial value

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Invoked when a key has been pressed.

Specified by:

keyPressed in interface java.awt.event.KeyListener

Parameters:

e - the key event

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Invoked when a key has been released. Used for length control.

Specified by:

keyReleased in interface java.awt.event.KeyListener

Parameters:

e - the key event

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Invoked when a key has been typed. Used for length control.

Specified by:

keyTyped in interface java.awt.event.KeyListener

Parameters:

e - the key event

undo

public void undo()

Description copied from interface: Undoable

Undo last action.

Specified by:

undo in interface Undoable

free

public void free()

Releases external resources.