no.g9.client.component

Class G9TextField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JTextField

no.g9.client.component.G9TextField

All Implemented Interfaces:

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

public class G9TextField
extends JTextField
implements G9ValueState, G9FieldValue

g9 Text Field is basically a fix on a bug in Java 1.4, which does not set the background color when the text field is disabled. In addition, the g9 Text Field holds a state

See Also:

Serialized Form

Nested Class Summary

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

JTextField.AccessibleJTextField

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.JTextField

notifyAction

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
G9TextField() Constructs a new G9TextField.
G9TextField(Document doc, String text, int columns) Constructs a new G9TextField that uses the given text storage model and the given number of columns.
G9TextField(int columns) Constructs a new empty G9TextField with the specified number of columns.
G9TextField(String text) Constructs a new G9TextField initialized with the specified text.
G9TextField(String text, int columns) Constructs a new G9TextField initialized with the specified text 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() Try creating a new value by parsing the displayed text according to the output format.
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 specified object
Object	parse(String formattedString) Returns a value object.
void	resetState() Forces the currently displayed text to be considered the old text.
void	setDocument(Document doc)
void	setEditable(boolean editable)
void	setEnabled(boolean enable)
void	setInitialValue(Object value) Sets the initial value to be the specified value.
void	setInputJustification(int justification) Sets the input justification of this component
void	setOutputJustification(int justification) Sets the output justifiaction of this component
void	setSelectAllOnFocus(boolean selectAllOnFocus) If the selectAllOnFocus property is true the displayed text is selected each time this component gains focus.
void	setText(String s)
void	setValue(Object value) Set the documents new value.
String	toString()

Methods inherited from class javax.swing.JTextField

actionPropertyChanged, addActionListener, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultModel, fireActionPerformed, getAccessibleContext, getAction, getActionListeners, getActions, getColumns, getColumnWidth, getHorizontalAlignment, getHorizontalVisibility, getPreferredSize, getScrollOffset, getUIClassID, isValidateRoot, paramString, postActionEvent, removeActionListener, scrollRectToVisible, setAction, setActionCommand, setColumns, setFont, setHorizontalAlignment, setScrollOffset

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, 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, 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, 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, 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, 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, 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

G9TextField

public G9TextField()

Constructs a new G9TextField. A default model is created, the initial string is null, and the number of columns is set to 0.

G9TextField

public G9TextField(String text)

Constructs a new G9TextField initialized with the specified text. A default model is created and the number of columns is 0.

Parameters:

text - the text to be displayed, or null

G9TextField

public G9TextField(int columns)

Constructs a new empty G9TextField with the specified number of columns. A default model is created and the initial string is set to null.

Parameters:

columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

G9TextField

public G9TextField(String text,
                   int columns)

Constructs a new G9TextField initialized with the specified text and columns. A default model is created.

Parameters:

text - the text to be displayed, or null

columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

G9TextField

public G9TextField(Document doc,
                   String text,
                   int columns)

Constructs a new G9TextField that uses the given text storage model and the given number of columns. This is the constructor through which the other constructors feed. If the document is null, a default model is created.

Parameters:

doc - the text storage to use; if this is null, a default will be provided by calling the createDefaultModel method

text - the initial string to display, or null

columns - the number of columns to use to calculate the preferred width >= 0; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

Throws:

IllegalArgumentException - if columns < 0

Method Detail

setDocument

public void setDocument(Document doc)

Overrides:

setDocument in class JTextField

toString

public String toString()

Overrides:

toString in class Component

resetState

public void resetState()

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

Specified by:

resetState in interface G9ValueState

setEnabled

public void setEnabled(boolean enable)

Overrides:

setEnabled in class JComponent

setEditable

public void setEditable(boolean editable)

Overrides:

setEditable in class JTextComponent

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

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.

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

setText

public void setText(String s)

Overrides:

setText in class JTextComponent

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.

setInputJustification

public void setInputJustification(int justification)

Sets the input justification of this component

Parameters:

justification - the input justification

setOutputJustification

public void setOutputJustification(int justification)

Sets the output justifiaction of this component

Parameters:

justification - the output justification

setValue

public void setValue(Object value)

Set the documents new value. The document is responsible for formatting the value, and inserting it.

Specified by:

setValue in interface G9FieldValue

Parameters:

value - (missing javadoc)

getValue

public Object getValue()

Try creating a new value by parsing the displayed text according to the output format. If unsuccessful the old value is used.

Specified by:

getValue in interface G9FieldValue

Returns:

the new value

format

public String format()

Specified by:

format in interface G9FieldValue

Returns:

the formatted value according to the internal 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 specified object

Parameters:

o - the object to parse

Returns:

the parsed object

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.