com.taursys.swing
Class MTextArea

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JTextArea
                      com.taursys.swing.MTextArea

All Implemented Interfaces:

javax.accessibility.Accessible, EnableListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable

public class MTextArea

extends javax.swing.JTextArea

implements EnableListener

MTextArea is a TextArea which which is bound to a MDocument.

Version:

1.0

Author:

Marty Phelan

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JTextArea

javax.swing.JTextArea.AccessibleJTextArea

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

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

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

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

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

MTextArea()
Constructs a new MTextArea and underlying MDocument as a String type field.

MTextArea(int javaDataType)
Constructs a new MTextField and underlying MDocument as the given javaDataType field.

Method Summary

void	enableChange(EnableEvent e) Invoked whenever an EnableChange event is generated by the model.
java.text.Format	getFormat() Returns the Format of the TextModel.
java.lang.String	getFormatPattern() Returns the Format pattern of the TextModel.
java.lang.String	getPropertyName() Returns the propertyName in the valueHolder where the model stores the value.
javax.swing.InputVerifier	getSecondaryInputVerifier() Get the secondary InputVerifier for this component.
ValueHolder	getValueHolder() Returns the valueHolder for the model.
void	setDocument(javax.swing.text.Document newDoc) Binds this MTextField to the given Document.
void	setFormat(java.text.Format format) Sets the Format of the TextModel.
void	setFormatPattern(java.lang.String newPattern) Sets the Format patten of the TextModel.
void	setPropertyName(java.lang.String newPropertyName) Sets the propertyName in the valueHolder where the model stores the value.
void	setSecondaryInputVerifier(javax.swing.InputVerifier newInputVerifier) Set the secondary InputVerifier for this component.
void	setValueHolder(ValueHolder newValueHolder) Sets the valueHolder for the model.

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, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

MTextArea

public MTextArea()

Constructs a new MTextArea and underlying MDocument as a String type field.

MTextArea

public MTextArea(int javaDataType)
          throws UnsupportedDataTypeException

Constructs a new MTextField and underlying MDocument as the given javaDataType field.

Throws:

UnsupportedDataTypeException - if invalid javaDataType is given

See Also:

for defined data type constants TYPE_XXXXXX.

Method Detail

setSecondaryInputVerifier

public void setSecondaryInputVerifier(javax.swing.InputVerifier newInputVerifier)

Set the secondary InputVerifier for this component. This MTextField also contains its own internal InputVerifier which is invoked for handling text to object parsing (Date, Number, etc). The given InputVerifier is invoked after the internal InputVerifier has successfully verified the input.

Parameters:

newInputVerifier - the secondary InputVerifier for this component.

getSecondaryInputVerifier

public javax.swing.InputVerifier getSecondaryInputVerifier()

Get the secondary InputVerifier for this component. This MTextField also contains its own internal InputVerifier which is invoked for handling text to object parsing (Date, Number, etc). The given InputVerifier is invoked after the internal InputVerifier has successfully verified the input.

Returns:

the secondary InputVerifier for this component.

setFormat

public void setFormat(java.text.Format format)

Sets the Format of the TextModel.

getFormat

public java.text.Format getFormat()

Returns the Format of the TextModel.

setFormatPattern

public void setFormatPattern(java.lang.String newPattern)

Sets the Format patten of the TextModel.

getFormatPattern

public java.lang.String getFormatPattern()

Returns the Format pattern of the TextModel.

setValueHolder

public void setValueHolder(ValueHolder newValueHolder)

Sets the valueHolder for the model. The valueHolder is the object which holds the Object where the model stores the value. The default valueHolder is a VariantValueHolder with a javaDataType of String.

getValueHolder

public ValueHolder getValueHolder()

Returns the valueHolder for the model. The valueHolder is the object which holds the Object where the model stores the value. The default valueHolder is a VariantValueHolder with a javaDataType of String.

setPropertyName

public void setPropertyName(java.lang.String newPropertyName)

Sets the propertyName in the valueHolder where the model stores the value. This name is ignored if you are using the default model (A DefaultTextModel with a VariantValueHolder).

getPropertyName

public java.lang.String getPropertyName()

Returns the propertyName in the valueHolder where the model stores the value. This name is ignored if you are using the default model (A DefaultTextModel with a VariantValueHolder).

setDocument

public void setDocument(javax.swing.text.Document newDoc)

Binds this MTextField to the given Document. The given Document should be an instance of MDocument for this component to function properly. This method registers this component as an EnableListener with the model.

Parameters:

newDoc - the document to display/edit

enableChange

public void enableChange(EnableEvent e)

Invoked whenever an EnableChange event is generated by the model. The model will issue the EnableChange event to indicate whether or not this control should allow edits. The enabled and editable properties are set based on this.

Specified by:

enableChange in interface EnableListener

Parameters:

e - EnableEvent indicating whether or not a control component be enabled.