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.
AccessibleContext
getAccessibleContext()
Returns the accessible context associated with the JTextField.
Action
getAction()
ActionListener[]
getActionListeners()
Returns all registered ActionListener objects.
Action[]
getActions()
Returns the set of Actions that are commands for the editor.
protected int
getColumnWidth()
Returns the column width, which is the width of the character m for the font in use.
int
getColumns()
Returns the number of columns of this text field.
int
getHorizontalAlignment()
Returns the horizontal alignment, which is one of: JTextField.LEFT, JTextField.CENTER, JTextField.RIGHT, JTextField.LEADING, JTextField.TRAILING.
BoundedRangeModel
getHorizontalVisibility()
Returns the bounded range model that describes the horizontal visibility of the text field in the case when the text does not fit into the available space.
Dimension
getPreferredSize()
Returns the preferred size.
int
getScrollOffset()
Returns the scroll offset in pixels.
String
getUIClassID()
Returns the class ID for the UI.
boolean
isValidateRoot()
Returns true, unless this is embedded in a JViewport in which case the viewport takes responsibility of validating.
void
postActionEvent()
void
removeActionListener(ActionListener listener)
Removes a listener object from this text field.
void
scrollRectToVisible(Rectangle r)
Calls scrollRectToVisible on the component's parent.
void
setAction(Action newAction)
void
setActionCommand(String command)
Sets the command string used in action events.
void
setColumns(int columns)
Sets the number of columns and then invalidates the layout.
void
setDocument(Document doc)
Sets the document to be used for this JTextField.
void
setFont(Font newFont)
Sets the current font and revalidates so the font will take effect.
void
setHorizontalAlignment(int newAlign)
Sets the horizontal alignment of the text.
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, getToolTipText, 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, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, 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, extends EventListener> T[] getListeners, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, 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, 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

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:
"notify-field-accept"

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.

getAccessibleContext

public AccessibleContext getAccessibleContext()
Returns the accessible context associated with the JTextField.
Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in interface JTextComponent
Returns:
the accessible context associated with the JTextField

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 Actions that are commands for the editor. This is the actions supported by this editor plus the actions of the UI (returned by JTextComponent.getActions()).
Overrides:
getActions in interface JTextComponent

getColumnWidth

protected int getColumnWidth()
Returns the column width, which is the width of the character m for the font in use.
Returns:
the width of the character m for the font in use.

getColumns

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

getHorizontalAlignment

public int getHorizontalAlignment()
Returns the horizontal alignment, which is one of: JTextField.LEFT, JTextField.CENTER, JTextField.RIGHT, JTextField.LEADING, JTextField.TRAILING.
Returns:
the horizontal alignment

getHorizontalVisibility

public BoundedRangeModel getHorizontalVisibility()
Returns the bounded range model that describes the horizontal visibility of the text field in the case when the text does not fit into the available space. The actual values of this model are managed by the look and feel implementation.
Returns:
the bounded range model that describes the horizontal visibility

getPreferredSize

public Dimension getPreferredSize()
Returns the preferred size. If there is a non-zero number of columns, this is the number of columns multiplied by the column width, otherwise it returns super.getPreferredSize().
Overrides:
getPreferredSize in interface JComponent

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";

isValidateRoot

public boolean isValidateRoot()
Returns true, unless this is embedded in a JViewport in which case the viewport takes responsibility of validating.
Overrides:
isValidateRoot in interface JComponent
Returns:
true, unless this is embedded in a JViewport in which case the viewport takes responsibility of validating

postActionEvent

public void postActionEvent()

removeActionListener

public void removeActionListener(ActionListener listener)
Removes a listener object from this text field.
Parameters:
listener - the listener to remove

scrollRectToVisible

public void scrollRectToVisible(Rectangle r)
Calls scrollRectToVisible on the component's parent. Components which can service this call should override.
Overrides:
scrollRectToVisible in interface JComponent
Parameters:
r - The rectangle to make visible

setAction

public void setAction(Action newAction)
Since:
1.3

setActionCommand

public void setActionCommand(String command)
Sets the command string used in action events.
Since:
1.3

setColumns

public void setColumns(int columns)
Sets the number of columns and then invalidates the layout.
Parameters:
columns - the number of columns
Throws:
IllegalArgumentException - if columns <320

setDocument

public void setDocument(Document doc)
Sets the document to be used for this JTextField. This sets the document property filterNewlines to true and then calls the super behaviour to setup a view and revalidate the text field.
Overrides:
setDocument in interface JTextComponent
Parameters:
doc - the document to set

setFont

public void setFont(Font newFont)
Sets the current font and revalidates so the font will take effect.
Overrides:
setFont in interface JComponent

setHorizontalAlignment

public void setHorizontalAlignment(int newAlign)
Sets the horizontal alignment of the text. Calls invalidate and repaint and fires a property change event.
Parameters:
newAlign - must be one of: JTextField.LEFT, JTextField.CENTER, JTextField.RIGHT, JTextField.LEADING, JTextField.TRAILING.
Throws:
IllegalArgumentException - if newAlign is not one of the above.

setScrollOffset

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

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