java.awt

Class TextField

java.lang.Object

java.awt.Component

java.awt.TextComponent

java.awt.TextField

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class TextField
extends TextComponent

This class implements a single line text entry field widget

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextField.AccessibleAWTTextField

Nested classes/interfaces inherited from class java.awt.TextComponent

TextComponent.AccessibleAWTTextComponent

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class java.awt.TextComponent

textListener

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

Constructors

Constructor and Description
TextField() Initializes a new instance of TextField that is empty and has one column.
TextField(int columns) Initializes a new instance of TextField that is empty and has the specified number of columns.
TextField(String text) Initializes a new instance of TextField containing the specified text.
TextField(String text, int columns) Initializes a new instance of TextField with the specified text and number of columns.

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionListener(ActionListener listener) Addes a new listener to the list of action listeners for this object.
void	addNotify() Notifies this object that it should create its native peer.
boolean	echoCharIsSet() Tests whether or not this text field has an echo character set so that characters the user type are not echoed to the screen.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this TextComponent.
ActionListener[]	getActionListeners() Return all ActionListeners register to this TextField object as an array.
int	getColumns() Returns the number of columns in the field.
char	getEchoChar() Returns the character that is echoed to the screen when a text field is protected (such as when a password is being entered).
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as FooListeners upon this TextField.
Dimension	getMinimumSize() Returns the minimum size for this text field.
Dimension	getMinimumSize(int columns) Returns the minimum size of a text field with the specified number of columns.
Dimension	getPreferredSize() Returns the preferred size for this text field.
Dimension	getPreferredSize(int columns) Returns the preferred size of a text field with the specified number of columns.
Dimension	minimumSize() Deprecated. This method is deprecated in favor of getMinimumSize().
Dimension	minimumSize(int columns) Deprecated. This method is deprecated in favor of getMinimumSize(int).
protected String	paramString() Returns a debug string for this object.
Dimension	preferredSize() Deprecated. This method is deprecated in favor of getPreferredSize().
Dimension	preferredSize(int columns) Deprecated. This method is deprecated in favor of getPreferredSize(int).
protected void	processActionEvent(ActionEvent event) Processes an action event by calling any registered listeners.
protected void	processEvent(AWTEvent event) Processes the specified event.
void	removeActionListener(ActionListener listener) Removes the specified listener from the list of action listeners for this object.
void	setColumns(int columns) Sets the number of columns in this field to the specified value.
void	setEchoChar(char echoChar) Sets the character that is echoed when protected input such as a password is displayed.
void	setEchoCharacter(char echoChar) Deprecated. This method is deprecated in favor of setEchoChar()

Methods inherited from class java.awt.TextComponent

addTextListener, getCaretPosition, getSelectedText, getSelectionEnd, getSelectionStart, getText, getTextListeners, isEditable, processTextEvent, removeNotify, removeTextListener, select, selectAll, setCaretPosition, setEditable, setSelectionEnd, setSelectionStart, setText

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

TextField

public TextField()

Initializes a new instance of TextField that is empty and has one column.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true,

TextField

public TextField(String text)

Initializes a new instance of TextField containing the specified text. The number of columns will be equal to the length of the text string.

Parameters:

text - The text to display in the field.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true,

TextField

public TextField(int columns)

Initializes a new instance of TextField that is empty and has the specified number of columns.

Parameters:

columns - The number of columns in the text field.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true,

TextField

public TextField(String text,
         int columns)

Initializes a new instance of TextField with the specified text and number of columns.

Parameters:

text - The text to display in the field.

columns - The number of columns in the field.

Throws:

HeadlessException - If GraphicsEnvironment.isHeadless() is true,

Method Detail

getColumns

public int getColumns()

Returns the number of columns in the field.

Returns:

The number of columns in the field.

setColumns

public void setColumns(int columns)

Sets the number of columns in this field to the specified value.

Parameters:

columns - The new number of columns in the field.

Throws:

IllegalArgumentException - If columns is less than zero.

getEchoChar

public char getEchoChar()

Returns the character that is echoed to the screen when a text field is protected (such as when a password is being entered).

Returns:

The echo character for this text field.

setEchoChar

public void setEchoChar(char echoChar)

Sets the character that is echoed when protected input such as a password is displayed.

Parameters:

echoChar - The new echo character.

setEchoCharacter

public void setEchoCharacter(char echoChar)

Deprecated. This method is deprecated in favor of setEchoChar()

Sets the character that is echoed when protected input such as a password is displayed.

Parameters:

echoChar - The new echo character.

echoCharIsSet

public boolean echoCharIsSet()

Tests whether or not this text field has an echo character set so that characters the user type are not echoed to the screen.

Returns:

true if an echo character is set, false otherwise.

getMinimumSize

public Dimension getMinimumSize()

Returns the minimum size for this text field.

Overrides:

getMinimumSize in class Component

Returns:

The minimum size for this text field.

See Also:

Component.getPreferredSize(), Component.setMinimumSize(Dimension), LayoutManager

getMinimumSize

public Dimension getMinimumSize(int columns)

Returns the minimum size of a text field with the specified number of columns.

Parameters:

columns - The number of columns to get the minimum size for.

minimumSize

public Dimension minimumSize()

Deprecated. This method is deprecated in favor of getMinimumSize().

Returns the minimum size for this text field.

Overrides:

minimumSize in class Component

Returns:

The minimum size for this text field.

minimumSize

public Dimension minimumSize(int columns)

Deprecated. This method is deprecated in favor of getMinimumSize(int).

Returns the minimum size of a text field with the specified number of columns.

Parameters:

columns - The number of columns to get the minimum size for.

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size for this text field.

Overrides:

getPreferredSize in class Component

Returns:

The preferred size for this text field.

See Also:

Component.getMinimumSize(), Component.setPreferredSize(Dimension), LayoutManager

getPreferredSize

public Dimension getPreferredSize(int columns)

Returns the preferred size of a text field with the specified number of columns.

Parameters:

columns - The number of columns to get the preferred size for.

preferredSize

public Dimension preferredSize()

Deprecated. This method is deprecated in favor of getPreferredSize().

Returns the preferred size for this text field.

Overrides:

preferredSize in class Component

Returns:

The preferred size for this text field.

preferredSize

public Dimension preferredSize(int columns)

Deprecated. This method is deprecated in favor of getPreferredSize(int).

Returns the preferred size of a text field with the specified number of columns.

Parameters:

columns - The number of columns to get the preferred size for.

addNotify

public void addNotify()

Notifies this object that it should create its native peer.

Overrides:

addNotify in class Component

See Also:

Component.isDisplayable(), Component.removeNotify()

addActionListener

public void addActionListener(ActionListener listener)

Addes a new listener to the list of action listeners for this object.

Parameters:

listener - The listener to add to the list.

removeActionListener

public void removeActionListener(ActionListener listener)

Removes the specified listener from the list of action listeners for this object.

Parameters:

listener - The listener to remove from the list.

processEvent

protected void processEvent(AWTEvent event)

Processes the specified event. If the event is an instance of ActionEvent then processActionEvent() is called to process it, otherwise the event is sent to the superclass.

Overrides:

processEvent in class TextComponent

Parameters:

event - The event to process.

See Also:

Component.processComponentEvent(ComponentEvent), Component.processFocusEvent(FocusEvent), Component.processKeyEvent(KeyEvent), Component.processMouseEvent(MouseEvent), Component.processMouseMotionEvent(MouseEvent), Component.processInputMethodEvent(InputMethodEvent), Component.processHierarchyEvent(HierarchyEvent), Component.processMouseWheelEvent(MouseWheelEvent)

processActionEvent

protected void processActionEvent(ActionEvent event)

Processes an action event by calling any registered listeners. Note to subclasses: This method is not called unless action events are enabled on this object. This will be true if any listeners are registered, or if action events were specifically enabled using enableEvents().

Parameters:

event - The event to process.

paramString

protected String paramString()

Returns a debug string for this object.

Overrides:

paramString in class TextComponent

Returns:

A debug string for this object.

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

Returns an array of all the objects currently registered as FooListeners upon this TextField. FooListeners are registered using the addFooListener method.

Overrides:

getListeners in class TextComponent

Parameters:

listenerType - the class of listeners to filter (null not permitted).

Returns:

An array of registered listeners.

Throws:

ClassCastException - If listenerType doesn't specify a class or interface that implements java.util.EventListener.

Since:

1.3

See Also:

Component.getComponentListeners(), Component.getFocusListeners(), Component.getHierarchyListeners(), Component.getHierarchyBoundsListeners(), Component.getKeyListeners(), Component.getMouseListeners(), Component.getMouseMotionListeners(), Component.getMouseWheelListeners(), Component.getInputMethodListeners(), Component.getPropertyChangeListeners()

getActionListeners

public ActionListener[] getActionListeners()

Return all ActionListeners register to this TextField object as an array.

Since:

1.4

getAccessibleContext

public AccessibleContext getAccessibleContext()

Description copied from class: TextComponent

Gets the AccessibleContext associated with this TextComponent. The context is created, if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class TextComponent

Returns:

the associated context