com.partnersoft.gui.forms

Class AbstractFormTextField<T>

java.lang.Object

com.partnersoft.gui.forms.AbstractFormField<T>

com.partnersoft.gui.forms.AbstractFormTextField<T>

All Implemented Interfaces:

FormField<T>, java.awt.event.KeyListener, java.util.EventListener

Direct Known Subclasses:

FormDateAndTimeField, FormDurationField, FormIntegerField, FormNumberField, FormSearchField, FormStringField, FormTimeField

public class AbstractFormTextField<T>
extends AbstractFormField<T>
implements java.awt.event.KeyListener

A FormField for single-line entry of values that can be represented as a text primitive. Includes a facility for providing a javax.swing.text.Document, which it uses to control the contents. See FormValidatedDocument, FormIntegerDocument, etc. for examples. Subclasses FormStringField, FormIntegerField, FormNumberField, etc. are provided as well.javax.swing.text.Document

Copyright 2004-2008 Partner Software, Inc.

Author:

Paul Reavis

Field Summary

Fields inherited from class com.partnersoft.gui.forms.AbstractFormField

gui

Constructor Summary

Constructors

Constructor and Description
AbstractFormTextField()
AbstractFormTextField(boolean noPopup)
AbstractFormTextField(javax.swing.text.Document document)
AbstractFormTextField(javax.swing.text.Document document, boolean noPopup)

Method Summary

Methods

Modifier and Type	Method and Description
void	down()
javax.swing.JTextField	getJTextField()
T	getValue() Returns the current value for this field.
void	grabFocus() Grab the GUI keyboard/mouse focus, if possible.
void	keyPressed(java.awt.event.KeyEvent event)
void	keyReleased(java.awt.event.KeyEvent event)
void	keyTyped(java.awt.event.KeyEvent event)
void	left()
void	right()
void	selectAll() If appropriate, select all (all text, all values in a list, etc.).
void	selectNone() If appropriate, select none (no text, no values in a list, etc.).
void	setDisabled(boolean disabled) If true, disables the form (no input allowed).
void	setValue(T newValue) Sets the current value for this field.
void	setValueSafely(java.lang.Object newValue) Sets the value safely, e.g.
void	up()

Methods inherited from class com.partnersoft.gui.forms.AbstractFormField

addFieldListener, createPopup, doAction, fireActionRequested, fireValueChanged, getGui, getToolTipText, isDisabled, removeFieldListener, setToolTipText, toString, valueChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFormTextField

public AbstractFormTextField()

AbstractFormTextField

public AbstractFormTextField(boolean noPopup)

AbstractFormTextField

public AbstractFormTextField(javax.swing.text.Document document)

AbstractFormTextField

public AbstractFormTextField(javax.swing.text.Document document,
                     boolean noPopup)

Method Detail

getValue

public T getValue()

Returns the current value for this field.

Specified by:

getValue in interface FormField<T>

setValue

public void setValue(T newValue)

Sets the current value for this field.

Specified by:

setValue in interface FormField<T>

setValueSafely

public void setValueSafely(java.lang.Object newValue)

Description copied from interface: FormField

Sets the value safely, e.g. by doing any casting or conversion necessary.

Specified by:

setValueSafely in interface FormField<T>

selectAll

public void selectAll()

Description copied from interface: FormField

If appropriate, select all (all text, all values in a list, etc.).

Specified by:

selectAll in interface FormField<T>

Overrides:

selectAll in class AbstractFormField<T>

selectNone

public void selectNone()

Description copied from interface: FormField

If appropriate, select none (no text, no values in a list, etc.).

Specified by:

selectNone in interface FormField<T>

Overrides:

selectNone in class AbstractFormField<T>

grabFocus

public void grabFocus()

Description copied from interface: FormField

Grab the GUI keyboard/mouse focus, if possible.

Specified by:

grabFocus in interface FormField<T>

Overrides:

grabFocus in class AbstractFormField<T>

setDisabled

public void setDisabled(boolean disabled)

Description copied from class: AbstractFormField

If true, disables the form (no input allowed). Default is enabled.

Specified by:

setDisabled in interface FormField<T>

Overrides:

setDisabled in class AbstractFormField<T>

keyPressed

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

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

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

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

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

Specified by:

keyTyped in interface java.awt.event.KeyListener

up

public void up()

down

public void down()

right

public void right()

left

public void left()

getJTextField

public javax.swing.JTextField getJTextField()