Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt

Class TextField

Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Serializable
public class TextField
extends TextComponent
This class implements a single line text entry field widget
See Also:
Serialized Form

Nested Class Summary

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

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

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.
extends EventListener> T[] getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this TextField.
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).
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, extends EventListener> T[] getListeners, getAccessibleContext, getCaretPosition, getSelectedText, getSelectionEnd, getSelectionStart, getText, getTextListeners, isEditable, paramString, processEvent, 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, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, 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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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(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)
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(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 Details

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.

addNotify

public void addNotify()
Notifies this object that it should create its native peer.
Overrides:
addNotify in interface Component

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.

extends EventListener> T[] getListeners

public extends EventListener> T[] getListeners(Class listenerType)
Returns an array of all the objects currently registered as FooListeners upon this TextField. FooListeners are registered using the addFooListener method.
Overrides:
extends EventListener> T[] getListeners in interface TextComponent
Throws:
ClassCastException - If listenerType doesn't specify a class or interface that implements java.util.EventListener.
Since:
1.3

getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this TextComponent. The context is created, if necessary.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in interface TextComponent
Returns:
the associated context

getActionListeners

public ActionListener[] getActionListeners()
Return all ActionListeners register to this TextField object as an array.
Since:
1.4

getColumns

public int getColumns()
Returns the number of columns in the field.
Returns:
The number of columns in the field.

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.

getMinimumSize

public Dimension getMinimumSize()
Returns the minimum size for this text field.
Overrides:
getMinimumSize in interface Component
Returns:
The minimum size for this text field.

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.

getPreferredSize

public Dimension getPreferredSize()
Returns the preferred size for this text field.
Overrides:
getPreferredSize in interface Component
Returns:
The preferred size for this text field.

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.

minimumSize

public Dimension minimumSize()

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

Returns the minimum size for this text field.
Overrides:
minimumSize in interface 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.

paramString

protected String paramString()
Returns a debug string for this object.
Overrides:
paramString in interface TextComponent
Returns:
A debug string for this object.

preferredSize

public Dimension preferredSize()

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

Returns the preferred size for this text field.
Overrides:
preferredSize in interface 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.

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.

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 interface TextComponent
Parameters:
event - The event to process.

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.

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.

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.
TextField.java -- A one line text entry field Copyright (C) 1999, 2002, 2004, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About