java.lang.Object java.awt.Component java.awt.TextComponent java.awt.TextField
public class TextField
A TextField
object is a text component that allows for the editing of a single line of text.
For example, the following image depicts a frame with four text fields of varying widths. Two of these text fields display the predefined text "Hello"
.
Here is the code that produces these four text fields:
TextField tf1, tf2, tf3, tf4; // a blank text field tf1 = new TextField(); // blank field of 20 columns tf2 = new TextField("", 20); // predefined text displayed tf3 = new TextField("Hello!"); // predefined text in 30 columns tf4 = new TextField("Hello", 30);
Every time the user types a key in the text field, one or more key events are sent to the text field. A KeyEvent
may be one of three types: keyPressed, keyReleased, or keyTyped. The properties of a key event indicate which of these types it is, as well as additional information about the event, such as what modifiers are applied to the key event and the time at which the event occurred.
The key event is passed to every KeyListener
or KeyAdapter
object which registered to receive such events using the component's addKeyListener
method. (KeyAdapter
objects implement the KeyListener
interface.)
It is also possible to fire an ActionEvent
. If action events are enabled for the text field, they may be fired by pressing the Return
key.
The TextField
class's processEvent
method examines the action event and passes it along to processActionEvent
. The latter method redirects the event to any ActionListener
objects that have registered to receive action events generated by this text field.
KeyEvent
, KeyAdapter
, KeyListener
, ActionEvent
, Component.addKeyListener(java.awt.event.KeyListener)
, processEvent(java.awt.AWTEvent)
, processActionEvent(java.awt.event.ActionEvent)
, addActionListener(java.awt.event.ActionListener)
, Serialized Form
TextField()
TextField(int columns)
TextField(String text)
TextField(String text, int columns)
addTextListener, enableInputMethods, getBackground, getCaretPosition, getInputMethodRequests, getSelectedText, getSelectionEnd, getSelectionStart, getText, getTextListeners, isEditable, processTextEvent, removeNotify, removeTextListener, select, selectAll, setBackground, setCaretPosition, setEditable, setSelectionEnd, setSelectionStart
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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, 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, 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
TextField
public TextField() throws HeadlessException
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.
GraphicsEnvironment.isHeadless()
public TextField(String text) throws HeadlessException
text
- the text to be displayed. If text
is null
, the empty string ""
will be displayed.
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.
GraphicsEnvironment.isHeadless()
public TextField(int columns) throws HeadlessException
columns
- the number of columns. If columns
is less than 0
, columns
is set to 0
.
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.
GraphicsEnvironment.isHeadless()
public TextField(String text, int columns) throws HeadlessException
text
- the text to be displayed. If text
is null
, the empty string ""
will be displayed.
columns
- the number of columns. If columns
is less than 0
, columns
is set to 0
.
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.
GraphicsEnvironment.isHeadless()
public void addNotify()
addNotify
in class TextComponent
TextComponent.removeNotify()
public char getEchoChar()
An echo character is useful for text fields where user input should not be echoed to the screen, as in the case of a text field for entering a password. If echoChar
= 0
, user input is echoed to the screen unchanged.
echoCharIsSet()
, setEchoChar(char)
public void setEchoChar(char c)
An echo character is useful for text fields where user input should not be echoed to the screen, as in the case of a text field for entering a password. Setting echoChar
= 0
allows user input to be echoed to the screen again.
c
- the echo character for this text field.
echoCharIsSet()
, getEchoChar()
@Deprecated public void setEchoCharacter(char c)
setEchoChar(char)
.
public void setText(String t)
setText
in class TextComponent
t
- the new text.
TextComponent.getText()
public boolean echoCharIsSet()
An echo character is useful for text fields where user input should not be echoed to the screen, as in the case of a text field for entering a password.
true
if this text field has a character set for echoing; false
otherwise.
setEchoChar(char)
, getEchoChar()
public int getColumns()
setColumns(int)
public void setColumns(int columns)
columns
- the number of columns.
IllegalArgumentException
- if the value supplied for columns
is less than 0
.
getColumns()
public Dimension getPreferredSize(int columns)
columns
- the number of columns in this text field.
@Deprecated public Dimension preferredSize(int columns)
getPreferredSize(int)
.
public Dimension getPreferredSize()
getPreferredSize
in class Component
Component.getMinimumSize()
, LayoutManager
@Deprecated public Dimension preferredSize()
getPreferredSize()
.
preferredSize
in class Component
public Dimension getMinimumSize(int columns)
columns
- the number of columns in this text field.
@Deprecated public Dimension minimumSize(int columns)
getMinimumSize(int)
.
public Dimension getMinimumSize()
getMinimumSize
in class Component
Component.getPreferredSize()
, LayoutManager
@Deprecated public Dimension minimumSize()
getMinimumSize()
.
minimumSize
in class Component
public void addActionListener(ActionListener l)
l
- the action listener.
removeActionListener(java.awt.event.ActionListener)
, getActionListeners()
, ActionListener
public void removeActionListener(ActionListener l)
l
- the action listener.
addActionListener(java.awt.event.ActionListener)
, getActionListeners()
, ActionListener
public ActionListener[] getActionListeners()
ActionListener
s or an empty array if no action listeners are currently registered
addActionListener(java.awt.event.ActionListener)
, removeActionListener(java.awt.event.ActionListener)
, java.awt.event
public <T extends EventListener> T[] getListeners(Class<T> listenerType)
FooListener
s upon this TextField
. FooListener
s are registered using the addFooListener
method.
You can specify the listenerType
argument with a class literal, such as FooListener.class
. For example, you can query a TextField
t
for its action listeners with the following code:
ActionListener[] als = (ActionListener[])(t.getListeners(ActionListener.class));If no such listeners exist, this method returns an empty array.
getListeners
in class TextComponent
listenerType
- the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
FooListener
s on this textfield, or an empty array if no such listeners have been added
ClassCastException
- if listenerType
doesn't specify a class or interface that implements java.util.EventListener
getActionListeners()
protected void processEvent(AWTEvent e)
ActionEvent
, it invokes the processActionEvent
method. Otherwise, it invokes processEvent
on the superclass.
Note that if the event parameter is null
the behavior is unspecified and may result in an exception.
processEvent
in class TextComponent
e
- the event
ActionEvent
, processActionEvent(java.awt.event.ActionEvent)
protected void processActionEvent(ActionEvent e)
ActionListener
objects.
This method is not called unless action events are enabled for this component. Action events are enabled when one of the following occurs:
ActionListener
object is registered via addActionListener
.enableEvents
.Note that if the event parameter is null
the behavior is unspecified and may result in an exception.
e
- the action event
ActionListener
, addActionListener(java.awt.event.ActionListener)
, Component.enableEvents(long)
protected String paramString()
TextField
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null
.
paramString
in class TextComponent
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class TextComponent
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4