Package rma.swing

Class RmaJTextArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextArea

rma.swing.RmaJTextArea

All Implemented Interfaces:

FocusListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, DocumentListener, Scrollable, Modifiable, EditableComponent, FormManagementListener, RmaValidComponent

Direct Known Subclasses:

RmaJDescriptionField, SearchableJTextArea

public class RmaJTextArea
extends JTextArea
implements DocumentListener, RmaValidComponent, FocusListener, MouseMotionListener, FormManagementListener, Modifiable, EditableComponent

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

Modifier and Type	Field	Description
protected boolean	_modifiable
protected String	_name
protected Window	_parentWindow
protected JTextComponent	_statusLine
protected String	_statusText

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
RmaJTextArea()	Constructs a new TextArea.
RmaJTextArea(int rows, int columns)	Constructs a new empty TextArea with the specified number of columns.
RmaJTextArea(String text)	Constructs a new TextArea initialized with the specified text.
RmaJTextArea(String text, int rows, int columns)	Constructs a new TextArea initialized with the specified text, rows and columns.
RmaJTextArea(Document doc, String text, int rows, int columns)	Constructs a new JTextArea that uses the given text storage model and the given number of rows and columns.

Method Summary

Modifier and Type	Method	Description
void	addPopupAction(Action action)
void	changedUpdate(DocumentEvent e)
void	clearPerformed()	Called when the parent form calls clear().
void	errorMsg(String msg)
void	focusGained(FocusEvent e)	Invoked when a this component gains the keyboard focus.
void	focusLost(FocusEvent e)	Invoked when this component loses the keyboard focus.
String	getName()
String	getToolTipText(MouseEvent e)
boolean	getToolTipTextDisabled()
void	insertUpdate(DocumentEvent e)
boolean	isEmptyOk()
boolean	isModified()
boolean	isValid(boolean showErr)	return whether this component has valid data
void	mouseDragged(MouseEvent e)
void	mouseMoved(MouseEvent e)
protected void	popupMenuAction(Point pt)
protected void	processComponentKeyEvent(KeyEvent e)
void	removeUpdate(DocumentEvent e)
void	setChangeColor(Color changeColor)	set the foreground color when the user changes the text.
void	setEditable(boolean b)
void	setEmptyOk(boolean b)
void	setEnabled(boolean b)
void	setIsEditable(boolean b)
void	setModifiable(boolean m)
void	setModified(boolean b)
void	setName(String name)
void	setShowErrorMsg(boolean b)
void	setStatusLineField(JTextComponent statusLine, String statusText)	setup a status line field so when the mouse enters this field some status info text is displayed in the statusLine field.
void	setText(String text)
void	setToolTipTextDisabled(boolean toolTipTextDisabled)
void	takeFocus()	allows the text field to take the focus back while within the focusLost() method.
protected boolean	validateData(boolean showErrorMsg)

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, 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, 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, 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, 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, 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 Details

_statusLine

protected JTextComponent _statusLine

_statusText

protected String _statusText

_name

protected String _name

_parentWindow

protected Window _parentWindow

_modifiable

protected boolean _modifiable

Constructor Details

RmaJTextArea

public RmaJTextArea(String text,
 int rows,
 int columns)

Constructs a new TextArea initialized with the specified text, rows and columns.

RmaJTextArea

public RmaJTextArea(Document doc,
 String text,
 int rows,
 int columns)

Constructs a new JTextArea that uses the given text storage model and the given number of rows and columns.

RmaJTextArea

public RmaJTextArea(int rows,
 int columns)

Constructs a new empty TextArea with the specified number of columns.

RmaJTextArea

public RmaJTextArea()

Constructs a new TextArea.

RmaJTextArea

public RmaJTextArea(String text)

Constructs a new TextArea initialized with the specified text.

Method Details

popupMenuAction

protected void popupMenuAction(Point pt)

addPopupAction

public void addPopupAction(Action action)

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class JComponent

setEditable

public void setEditable(boolean b)

Overrides:

setEditable in class JTextComponent

setChangeColor

public void setChangeColor(Color changeColor)

set the foreground color when the user changes the text.

changedUpdate

public void changedUpdate(DocumentEvent e)

Specified by:

changedUpdate in interface DocumentListener

insertUpdate

public void insertUpdate(DocumentEvent e)

Specified by:

insertUpdate in interface DocumentListener

removeUpdate

public void removeUpdate(DocumentEvent e)

Specified by:

removeUpdate in interface DocumentListener

setEmptyOk

public void setEmptyOk(boolean b)

isEmptyOk

public boolean isEmptyOk()

errorMsg

public void errorMsg(String msg)

takeFocus

public void takeFocus()

allows the text field to take the focus back while within the focusLost() method.

isValid

public boolean isValid(boolean showErr)

return whether this component has valid data

Specified by:

isValid in interface RmaValidComponent

focusGained

public void focusGained(FocusEvent e)

Invoked when a this component gains the keyboard focus.

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent e)

Invoked when this component loses the keyboard focus.

Specified by:

focusLost in interface FocusListener

setShowErrorMsg

public void setShowErrorMsg(boolean b)

validateData

protected boolean validateData(boolean showErrorMsg)

setStatusLineField

public void setStatusLineField(JTextComponent statusLine,
 String statusText)

setup a status line field so when the mouse enters this field some status info text is displayed in the statusLine field. if statusLine is null then remove the mouselistener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

getName

public String getName()

Overrides:

getName in class Component

setName

public void setName(String name)

Overrides:

setName in class Component

getToolTipTextDisabled

public boolean getToolTipTextDisabled()

setToolTipTextDisabled

public void setToolTipTextDisabled(boolean toolTipTextDisabled)

getToolTipText

public String getToolTipText(MouseEvent e)

Overrides:

getToolTipText in class JTextComponent

clearPerformed

public void clearPerformed()

Called when the parent form calls clear(). Part of the Form management listener interface

Specified by:

clearPerformed in interface FormManagementListener

isModified

public boolean isModified()

Specified by:

isModified in interface Modifiable

setModified

public void setModified(boolean b)

Specified by:

setModified in interface Modifiable

processComponentKeyEvent

protected void processComponentKeyEvent(KeyEvent e)

Overrides:

processComponentKeyEvent in class JComponent

setIsEditable

public void setIsEditable(boolean b)

Specified by:

setIsEditable in interface EditableComponent

setModifiable

public void setModifiable(boolean m)

setText

public void setText(String text)

Overrides:

setText in class JTextComponent