javax.swing

Class JTextField

Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Scrollable, Serializable, SwingConstants
Known Direct Subclasses:
DefaultTreeCellEditor.DefaultTextField, JFormattedTextField, JPasswordField

public class JTextField
extends JTextComponent
implements SwingConstants

See Also:
Serialized Form

Nested Class Summary

protected class
JTextField.AccessibleJTextField
AccessibleJTextField

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

JTextComponent.AccessibleJTextComponent, 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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String
notifyAction
Name of the action that gets sent when the content of the text field gets accepted.

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW, accessibleContext, listenerList, ui

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

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

Constructor Summary

JTextField()
Creates a new instance of JTextField.
JTextField(int columns)
Creates a new instance of JTextField.
JTextField(String text)
Creates a new instance of JTextField.
JTextField(String text, int columns)
Creates a new instance of JTextField.
JTextField(Document doc, String text, int columns)
Creates a new instance of JTextField.

Method Summary

void
addActionListener(ActionListener listener)
Adds a new listener object to this text field.
protected void
configurePropertiesFromAction(Action action)
protected PropertyChangeListener
createActionPropertyChangeListener(Action action)
protected Document
createDefaultModel()
Creates the default model for this text field.
protected void
fireActionPerformed()
Sends an action event to all registered ActionListener objects.
Action
getAction()
ActionListener[]
getActionListeners()
Returns all registered ActionListener objects.
Action[]
getActions()
Returns the set of available Actions this component's associated editor can run.
protected int
getColumnWidth()
int
getColumns()
Returns the number of columns of this text field.
int
getHorizontalAlignment()
Dimension
getPreferredSize()
Get the component's preferred size.
int
getScrollOffset()
Returns the scroll offset in pixels.
String
getUIClassID()
Returns the class ID for the UI.
void
postActionEvent()
void
removeActionListener(ActionListener listener)
Removes a listener object from this text field.
void
setAction(Action newAction)
void
setActionCommand(String command)
void
setColumns(int columns)
void
setFont(Font newFont)
Set the value of the font property.
void
setHorizontalAlignment(int newAlign)
void
setScrollOffset(int offset)
Sets the scroll offset in pixels.

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getAccessibleContext, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodListeners, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getUI, getUIClassID, isEditable, loadKeymap, modelToView, moveCaretPosition, paramString, paste, read, removeCaretListener, removeInputMethodListener, removeKeymap, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, setLayout, swapComponents, transferFocusDownCycle, update, validate, validateTree

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, 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, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, setName, 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, toString, wait, wait, wait

Field Details

notifyAction

public static final String notifyAction
Name of the action that gets sent when the content of the text field gets accepted.

Field Value:
""

Constructor Details

JTextField

public JTextField()
Creates a new instance of JTextField.


JTextField

public JTextField(int columns)
Creates a new instance of JTextField.

Parameters:
columns - the number of columns

Throws:
IllegalArgumentException - if columns %lt; 0


JTextField

public JTextField(String text)
Creates a new instance of JTextField.

Parameters:
text - the initial text


JTextField

public JTextField(String text,
                  int columns)
Creates a new instance of JTextField.

Parameters:
text - the initial text
columns - the number of columns

Throws:
IllegalArgumentException - if columns %lt; 0


JTextField

public JTextField(Document doc,
                  String text,
                  int columns)
Creates a new instance of JTextField.

Parameters:
doc - the document to use
text - the initial text
columns - the number of columns

Throws:
IllegalArgumentException - if columns %lt; 0

Method Details

addActionListener

public void addActionListener(ActionListener listener)
Adds a new listener object to this text field.

Parameters:
listener - the listener to add


configurePropertiesFromAction

protected void configurePropertiesFromAction(Action action)

Since:
1.3


createActionPropertyChangeListener

protected PropertyChangeListener createActionPropertyChangeListener(Action action)

Since:
1.3


createDefaultModel

protected Document createDefaultModel()
Creates the default model for this text field. This implementation returns an instance of PlainDocument.

Returns:
a new instance of the default model


fireActionPerformed

protected void fireActionPerformed()
Sends an action event to all registered ActionListener objects.


getAction

public Action getAction()

Since:
1.3


getActionListeners

public ActionListener[] getActionListeners()
Returns all registered ActionListener objects.

Returns:
an array of listeners

Since:
1.4


getActions

public Action[] getActions()
Returns the set of available Actions this component's associated editor can run. Equivalent to calling getUI().getEditorKit().getActions(). This set of Actions is a reasonable value to provide as a parameter to JTextComponent.loadKeymap(Keymap,JTextComponent.KeyBinding[],Action[]), when resolving a set of JTextComponent.KeyBinding objects against this component.
Overrides:
getActions in interface JTextComponent

Returns:
The set of available Actions on this component's EditorKit

See Also:
TextUI.getEditorKit(JTextComponent), EditorKit.getActions()


getColumnWidth

protected int getColumnWidth()


getColumns

public int getColumns()
Returns the number of columns of this text field.

Returns:
the number of columns


getHorizontalAlignment

public int getHorizontalAlignment()


getPreferredSize

public Dimension getPreferredSize()
Get the component's preferred size. If the JComponent property has been explicitly set, it is returned. If the JComponent property has not been set but the JComponent.ui property has been, the result of ComponentUI.getPreferredSize(JComponent) is returned. If neither property has been set, the result of Container.getPreferredSize() is returned.
Overrides:
getPreferredSize in interface JComponent

Returns:
The preferred size of the component

See Also:
JComponent, JComponent.setPreferredSize(Dimension)


getScrollOffset

public int getScrollOffset()
Returns the scroll offset in pixels.

Returns:
the scroll offset


getUIClassID

public String getUIClassID()
Returns the class ID for the UI.
Overrides:
getUIClassID in interface JTextComponent

Returns:
"TextFieldUI";


postActionEvent

public void postActionEvent()


removeActionListener

public void removeActionListener(ActionListener listener)
Removes a listener object from this text field.

Parameters:
listener - the listener to remove


setAction

public void setAction(Action newAction)

Since:
1.3


setActionCommand

public void setActionCommand(String command)

Since:
1.3


setColumns

public void setColumns(int columns)


setFont

public void setFont(Font newFont)
Set the value of the font property.
Overrides:
setFont in interface JComponent

Parameters:


setHorizontalAlignment

public void setHorizontalAlignment(int newAlign)


setScrollOffset

public void setScrollOffset(int offset)
Sets the scroll offset in pixels.

Parameters:
offset - the scroll offset


JTextField.java -- Copyright (C) 2002, 2004, 2005 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.