no.g9.client.component

Class G9TextArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextArea

no.g9.client.component.G9TextArea

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, G9ValueState, G9FieldValue

public class G9TextArea
extends JTextArea
implements G9ValueState, G9FieldValue

In addition to being a JTextArea, this class implements the G9ValueState interface.

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 and Description
protected EventListenerList	vcListeners List of value changed listeners

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
G9TextArea() Constructs a new TextArea.
G9TextArea(Document doc) Constructs a new JTextArea with the given document model, and defaults for all of the other arguments (null, 0, 0).
G9TextArea(Document doc, String text, int rows, int columns) Constructs a new JTextArea with the specified number of rows and columns, and the given model.
G9TextArea(int rows, int columns) Constructs a new empty TextArea with the specified number of rows and columns.
G9TextArea(String text) Constructs a new TextArea with the specified text displayed.
G9TextArea(String text, int rows, int columns) Constructs a new TextArea with the specified text and number of rows and columns.

Method Summary

Modifier and Type	Method and Description
void	addValueChangedListener(G9ValueChangedListener listener) Adds a change listener to this component.
void	display(Object value) Updates the displayed value of the component, without affecting the state of the component.
protected void	fireG9ValueChangedEvent(int id, Object oldValue, Object newValue) Fires a g9 value changed event.
String	format()
Object	getInitialValue() Returns the initial displayed value.
Object	getValue()
boolean	isChanged() Checks if the currently displayed value is the same as the initial value.
boolean	isSelectAllOnFocus() If the selectAllOnFocus property is true the displayed text is selected each time this component gains focus.
Object	parse(Object o) Parses the object
Object	parse(String formattedString) Returns a value object.
void	resetState() Forces the currently displayed value to be considered the old value.
void	setEditable(boolean editable)
void	setEnabled(boolean enable)
void	setInitialValue(Object value) Sets the initial value to be the specified value.
void	setSelectAllOnFocus(boolean selectAllOnFocus) If the selectAllOnFocus property is true the displayed text is selected each time this component gains focus.
void	setText(String t)
void	setValue(Object value)
void	setVisible(boolean show)

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, 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, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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

vcListeners

protected EventListenerList vcListeners

List of value changed listeners

Constructor Detail

G9TextArea

public G9TextArea()

Constructs a new TextArea. A default model is set, the initial string is null, and rows/columns are set to 0.

G9TextArea

public G9TextArea(int rows,
                  int columns)

Constructs a new empty TextArea with the specified number of rows and columns. A default model is created, and the initial string is null.

Parameters:

rows - the number of rows >= 0

columns - the number of columns >= 0

Throws:

IllegalArgumentException - if the rows or columns arguments are negative.

G9TextArea

public G9TextArea(String text)

Constructs a new TextArea with the specified text displayed. A default model is created and rows/columns are set to 0.

Parameters:

text - the text to be displayed, or null

G9TextArea

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

Constructs a new TextArea with the specified text and number of rows and columns. A default model is created.

Parameters:

text - the text to be displayed, or null

rows - the number of rows >= 0

columns - the number of columns >= 0

Throws:

IllegalArgumentException - if the rows or columns arguments are negative.

G9TextArea

public G9TextArea(Document doc)

Constructs a new JTextArea with the given document model, and defaults for all of the other arguments (null, 0, 0).

Parameters:

doc - the model to use

G9TextArea

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

Constructs a new JTextArea with the specified number of rows and columns, and the given model. All of the constructors feed through this constructor.

Parameters:

doc - the model to use, or create a default one if null

text - the text to be displayed, null if none

rows - the number of rows >= 0

columns - the number of columns >= 0

Throws:

IllegalArgumentException - if the rows or columns arguments are negative.

Method Detail

addValueChangedListener

public void addValueChangedListener(G9ValueChangedListener listener)

Description copied from interface: G9ValueState

Adds a change listener to this component. The change listener will be notified when a value changed event occurs.

Specified by:

addValueChangedListener in interface G9ValueState

Parameters:

listener - the listener to add

fireG9ValueChangedEvent

protected void fireG9ValueChangedEvent(int id,
                                       Object oldValue,
                                       Object newValue)

Fires a g9 value changed event.

Parameters:

id - the type of event

oldValue - the old value

newValue - the new value

getValue

public Object getValue()

Specified by:

getValue in interface G9FieldValue

Returns:

(missing javadoc)

setValue

public void setValue(Object value)

Specified by:

setValue in interface G9FieldValue

Parameters:

value - (missing javadoc)

format

public String format()

Specified by:

format in interface G9FieldValue

Returns:

the formatted value according to the internal format.

See Also:

G9FieldValue.format()

parse

public Object parse(String formattedString)

Description copied from interface: G9FieldValue

Returns a value object. The specified string must be a representation of a value in the internal format.

Specified by:

parse in interface G9FieldValue

Parameters:

formattedString - (missing javadoc)

Returns:

(missing javadoc)

parse

public Object parse(Object o)

Parses the object

Parameters:

o - the object to parse

Returns:

the object

resetState

public void resetState()

Description copied from interface: G9ValueState

Forces the currently displayed value to be considered the old value.

Specified by:

resetState in interface G9ValueState

isChanged

public boolean isChanged()

Description copied from interface: G9ValueState

Checks if the currently displayed value is the same as the initial value. The initial value is updated when the component is updated programaticly.

Specified by:

isChanged in interface G9ValueState

Returns:

true if the displayed value differs from the initial value.

setText

public void setText(String t)

Overrides:

setText in class JTextComponent

display

public void display(Object value)

Description copied from interface: G9ValueState

Updates the displayed value of the component, without affecting the state of the component.

Specified by:

display in interface G9ValueState

Parameters:

value - the new value to display

getInitialValue

public Object getInitialValue()

Description copied from interface: G9ValueState

Returns the initial displayed value.

Specified by:

getInitialValue in interface G9ValueState

Returns:

the initial displayed value

setInitialValue

public void setInitialValue(Object value)

Description copied from interface: G9ValueState

Sets the initial value to be the specified value.

Specified by:

setInitialValue in interface G9ValueState

Parameters:

value - the (new) initial value.

setEnabled

public void setEnabled(boolean enable)

Overrides:

setEnabled in class JComponent

setEditable

public void setEditable(boolean editable)

Overrides:

setEditable in class JTextComponent

setVisible

public void setVisible(boolean show)

Overrides:

setVisible in class JComponent

isSelectAllOnFocus

public boolean isSelectAllOnFocus()

If the selectAllOnFocus property is true the displayed text is selected each time this component gains focus.

Returns:

Returns the selectAllOnFocus.

setSelectAllOnFocus

public void setSelectAllOnFocus(boolean selectAllOnFocus)

If the selectAllOnFocus property is true the displayed text is selected each time this component gains focus.

Parameters:

selectAllOnFocus - The selectAllOnFocus property.