public class

JTextField

extends JTextComponent
implements SwingConstants

java.lang.Object
↳	java.awt.Component
	↳	java.awt.Container
		↳	javax.swing.JComponent
			↳	javax.swing.text.JTextComponent
				↳	javax.swing.JTextField

Known Direct Subclasses

DefaultTreeCellEditor.DefaultTextField, JFormattedTextField, JPasswordField

Class Overview

JTextField is a lightweight component that allows the editing of a single line of text. For information on and examples of using text fields, see How to Use Text Fields in The Java Tutorial.

JTextField is intended to be source-compatible with java.awt.TextField where it is reasonable to do so. This component has capabilities not found in the java.awt.TextField class. The superclass should be consulted for additional capabilities.

JTextField has a method to establish the string used as the command string for the action event that gets fired. The java.awt.TextField used the text of the field as the command string for the ActionEvent. JTextField will use the command string set with the setActionCommand method if not null, otherwise it will use the text of the field as a compatibility with java.awt.TextField.

The method setEchoChar and getEchoChar are not provided directly to avoid a new implementation of a pluggable look-and-feel inadvertently exposing password characters. To provide password-like services a separate class JPasswordField extends JTextField to provide this service with an independently pluggable look-and-feel.

The java.awt.TextField could be monitored for changes by adding a TextListener for TextEvent's. In the JTextComponent based components, changes are broadcasted from the model via a DocumentEvent to DocumentListeners. The DocumentEvent gives the location of the change and the kind of change if desired. The code fragment might look something like:


     DocumentListener myListener = ??;
     JTextField myArea = ??;
     myArea.getDocument().addDocumentListener(myListener);

The horizontal alignment of JTextField can be set to be left justified, leading justified, centered, right justified or trailing justified. Right/trailing justification is useful if the required size of the field text is smaller than the size allocated to it. This is determined by the setHorizontalAlignment and getHorizontalAlignment methods. The default is to be leading justified.

How the text field consumes VK_ENTER events depends on whether the text field has any action listeners. If so, then VK_ENTER results in the listeners getting an ActionEvent, and the VK_ENTER event is consumed. This is compatible with how AWT text fields handle VK_ENTER events. If the text field has no action listeners, then as of v 1.3 the VK_ENTER event is not consumed. Instead, the bindings of ancestor components are processed, which enables the default button feature of JFC/Swing to work.

Customized fields can easily be created by extending the model and changing the default model provided. For example, the following piece of code will create a field that holds only upper case characters. It will work even if text is pasted into from the clipboard or it is altered via programmatic changes.



 public class UpperCaseField extends JTextField {
 
     public UpperCaseField(int cols) {
         super(cols);
     }
 
     protected Document createDefaultModel() {
         return new UpperCaseDocument();
     }
 
     static class UpperCaseDocument extends PlainDocument {
 
         public void insertString(int offs, String str, AttributeSet a)
             throws BadLocationException {
 
             if (str == null) {
                 return;
             }
             char[] upper = str.toCharArray();
             for (int i = 0; i < upper.length; i++) {
                 upper[i] = Character.toUpperCase(upper[i]);
             }
             super.insertString(offs, new String(upper), a);
         }
     }
 }

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class	JTextField.AccessibleJTextField	This class implements accessibility support for the `JTextField` class.

Constants
String	notifyAction	Name of the action to send notification that the contents of the field have been accepted.

[Expand]

Inherited Constants

From class javax.swing.text.JTextComponent

From class javax.swing.JComponent

From class java.awt.Component

From interface java.awt.image.ImageObserver

From interface javax.swing.SwingConstants

[Expand]

Inherited Fields

From class javax.swing.JComponent

Public Constructors
	JTextField() Constructs a new `TextField`.
	JTextField(String text) Constructs a new `TextField` initialized with the specified text.
	JTextField(int columns) Constructs a new empty `TextField` with the specified number of columns.
	JTextField(String text, int columns) Constructs a new `TextField` initialized with the specified text and columns.
	JTextField(Document doc, String text, int columns) Constructs a new `JTextField` that uses the given text storage model and the given number of columns.

Public Methods
synchronized void	addActionListener(ActionListener l) Adds the specified action listener to receive action events from this textfield.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `JTextField`.
Action	getAction() Returns the currently set `Action` for this `ActionEvent` source, or `null` if no `Action` is set.
synchronized ActionListener[]	getActionListeners() Returns an array of all the `ActionListener`s added to this JTextField with addActionListener().
Action[]	getActions() Fetches the command list for the editor.
int	getColumns() Returns the number of columns in this `TextField`.
int	getHorizontalAlignment() Returns the horizontal alignment of the text.
BoundedRangeModel	getHorizontalVisibility() Gets the visibility of the text field.
Dimension	getPreferredSize() Returns the preferred size `Dimensions` needed for this `TextField`.
int	getScrollOffset() Gets the scroll offset, in pixels.
String	getUIClassID() Gets the class ID for a UI.
boolean	isValidateRoot() Calls to `revalidate` that come from within the textfield itself will be handled by validating the textfield, unless the textfield is contained within a `JViewport`, in which case this returns false.
void	postActionEvent() Processes action events occurring on this textfield by dispatching them to any registered `ActionListener` objects.
synchronized void	removeActionListener(ActionListener l) Removes the specified action listener so that it no longer receives action events from this textfield.
void	scrollRectToVisible(Rectangle r) Scrolls the field left or right.
void	setAction(Action a) Sets the `Action` for the `ActionEvent` source.
void	setActionCommand(String command) Sets the command string used for action events.
void	setColumns(int columns) Sets the number of columns in this `TextField`, and then invalidate the layout.
void	setDocument(Document doc) Associates the editor with a text document.
void	setFont(Font f) Sets the current font.
void	setHorizontalAlignment(int alignment) Sets the horizontal alignment of the text.
void	setScrollOffset(int scrollOffset) Sets the scroll offset, in pixels.

Protected Methods
void	actionPropertyChanged(Action action, String propertyName) Updates the textfield's state in response to property changes in associated action.
void	configurePropertiesFromAction(Action a) Sets the properties on this textfield to match those in the specified `Action`.
PropertyChangeListener	createActionPropertyChangeListener(Action a) Creates and returns a `PropertyChangeListener` that is responsible for listening for changes from the specified `Action` and updating the appropriate properties.
Document	createDefaultModel() Creates the default implementation of the model to be used at construction if one isn't explicitly given.
void	fireActionPerformed() Notifies all listeners that have registered interest for notification on this event type.
int	getColumnWidth() Returns the column width.
String	paramString() Returns a string representation of this `JTextField`.

[Expand]

Inherited Methods

From class javax.swing.text.JTextComponent

void	addCaretListener(CaretListener listener) Adds a caret listener for notification of any changes to the caret.
void	addInputMethodListener(InputMethodListener l) Adds the specified input method listener to receive input method events from this component.
static Keymap	addKeymap(String nm, Keymap parent) Adds a new keymap into the keymap hierarchy.
void	copy() Transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model.
void	cut() Transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model.
void	fireCaretUpdate(CaretEvent e) Notifies all listeners that have registered interest for notification on this event type.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `JTextComponent`.
Action[]	getActions() Fetches the command list for the editor.
Caret	getCaret() Fetches the caret that allows text-oriented navigation over the view.
Color	getCaretColor() Fetches the current color used to render the caret.
CaretListener[]	getCaretListeners() Returns an array of all the caret listeners registered on this text component.
int	getCaretPosition() Returns the position of the text insertion caret for the text component.
Color	getDisabledTextColor() Fetches the current color used to render the disabled text.
Document	getDocument() Fetches the model associated with the editor.
boolean	getDragEnabled() Returns whether or not automatic drag handling is enabled.
final JTextComponent.DropLocation	getDropLocation() Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or `null` if no location is to currently be shown.
final DropMode	getDropMode() Returns the drop mode for this component.
char	getFocusAccelerator() Returns the key accelerator that will cause the receiving text component to get the focus.
Highlighter	getHighlighter() Fetches the object responsible for making highlights.
InputMethodRequests	getInputMethodRequests() Gets the input method request handler which supports requests from input methods for this component.
Keymap	getKeymap() Fetches the keymap currently active in this text component.
static Keymap	getKeymap(String nm) Fetches a named keymap previously added to the document.
Insets	getMargin() Returns the margin between the text component's border and its text.
NavigationFilter	getNavigationFilter() Returns the `NavigationFilter`.
Dimension	getPreferredScrollableViewportSize() Returns the preferred size of the viewport for a view component.
Printable	getPrintable(MessageFormat headerFormat, MessageFormat footerFormat) Returns a `Printable` to use for printing the content of this `JTextComponent`.
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one block of rows or columns, depending on the value of orientation.
boolean	getScrollableTracksViewportHeight() Returns true if a viewport should always force the height of this `Scrollable` to match the height of the viewport.
boolean	getScrollableTracksViewportWidth() Returns true if a viewport should always force the width of this `Scrollable` to match the width of the viewport.
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation.
String	getSelectedText() Returns the selected text contained in this `TextComponent`.
Color	getSelectedTextColor() Fetches the current color used to render the selected text.
Color	getSelectionColor() Fetches the current color used to render the selection.
int	getSelectionEnd() Returns the selected text's end position.
int	getSelectionStart() Returns the selected text's start position.
String	getText(int offs, int len) Fetches a portion of the text represented by the component.
String	getText() Returns the text contained in this `TextComponent`.
String	getToolTipText(MouseEvent event) Returns the string to be used as the tooltip for `event`.
TextUI	getUI() Fetches the user-interface factory for this text-oriented editor.
boolean	isEditable() Returns the boolean indicating whether this `TextComponent` is editable or not.
static void	loadKeymap(Keymap map, KeyBinding[] bindings, Action[] actions) Loads a keymap with a bunch of bindings.
Rectangle	modelToView(int pos) Converts the given location in the model to a place in the view coordinate system.
void	moveCaretPosition(int pos) Moves the caret to a new position, leaving behind a mark defined by the last time `setCaretPosition` was called.
String	paramString() Returns a string representation of this `JTextComponent`.
void	paste() Transfers the contents of the system clipboard into the associated text model.
boolean	print() A convenience print method that displays a print dialog, and then prints this `JTextComponent` in interactive mode with no header or footer text.
boolean	print(MessageFormat headerFormat, MessageFormat footerFormat) A convenience print method that displays a print dialog, and then prints this `JTextComponent` in interactive mode with the specified header and footer text.
boolean	print(MessageFormat headerFormat, MessageFormat footerFormat, boolean showPrintDialog, PrintService service, PrintRequestAttributeSet attributes, boolean interactive) Prints the content of this `JTextComponent`.
void	processInputMethodEvent(InputMethodEvent e) Processes input method events occurring on this component by dispatching them to any registered `InputMethodListener` objects.
void	read(Reader in, Object desc) Initializes from a stream.
void	removeCaretListener(CaretListener listener) Removes a caret listener.
static Keymap	removeKeymap(String nm) Removes a named keymap previously added to the document.
void	removeNotify() Notifies this component that it no longer has a parent component.
void	replaceSelection(String content) Replaces the currently selected content with new content represented by the given string.
void	select(int selectionStart, int selectionEnd) Selects the text between the specified start and end positions.
void	selectAll() Selects all the text in the `TextComponent`.
void	setCaret(Caret c) Sets the caret to be used.
void	setCaretColor(Color c) Sets the current color used to render the caret.
void	setCaretPosition(int position) Sets the position of the text insertion caret for the `TextComponent`.
void	setComponentOrientation(ComponentOrientation o) Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
void	setDisabledTextColor(Color c) Sets the current color used to render the disabled text.
void	setDocument(Document doc) Associates the editor with a text document.
void	setDragEnabled(boolean b) Turns on or off automatic drag handling.
final void	setDropMode(DropMode dropMode) Sets the drop mode for this component.
void	setEditable(boolean b) Sets the specified boolean to indicate whether or not this `TextComponent` should be editable.
void	setFocusAccelerator(char aKey) Sets the key accelerator that will cause the receiving text component to get the focus.
void	setHighlighter(Highlighter h) Sets the highlighter to be used.
void	setKeymap(Keymap map) Sets the keymap to use for binding events to actions.
void	setMargin(Insets m) Sets margin space between the text component's border and its text.
void	setNavigationFilter(NavigationFilter filter) Sets the `NavigationFilter`.
void	setSelectedTextColor(Color c) Sets the current color used to render the selected text.
void	setSelectionColor(Color c) Sets the current color used to render the selection.
void	setSelectionEnd(int selectionEnd) Sets the selection end to the specified position.
void	setSelectionStart(int selectionStart) Sets the selection start to the specified position.
void	setText(String t) Sets the text of this `TextComponent` to the specified text.
void	setUI(TextUI ui) Sets the user-interface factory for this text-oriented editor.
void	updateUI() Reloads the pluggable UI.
int	viewToModel(Point pt) Converts the given place in the view coordinate system to the nearest representative location in the model.
void	write(Writer out) Stores the contents of the model into the given stream.

From class javax.swing.JComponent

void	addAncestorListener(AncestorListener listener) Registers `listener` so that it will receive `AncestorEvents` when it or any of its ancestors move or are made visible or invisible.
void	addNotify() Notifies this component that it now has a parent component.
synchronized void	addVetoableChangeListener(VetoableChangeListener listener) Adds a `VetoableChangeListener` to the listener list.
void	computeVisibleRect(Rectangle visibleRect) Returns the `Component`'s "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.
boolean	contains(int x, int y) Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.
JToolTip	createToolTip() Returns the instance of `JToolTip` that should be used to display the tooltip.
void	disable() This method is deprecated. As of JDK version 1.1, replaced by `java.awt.Component.setEnabled(boolean)`.
void	enable() This method is deprecated. As of JDK version 1.1, replaced by `java.awt.Component.setEnabled(boolean)`.
void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties.
void	firePropertyChange(String propertyName, char oldValue, char newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties.
void	fireVetoableChange(String propertyName, Object oldValue, Object newValue) Supports reporting constrained property changes.
AccessibleContext	getAccessibleContext() Returns the `AccessibleContext` associated with this `JComponent`.
ActionListener	getActionForKeyStroke(KeyStroke aKeyStroke) Returns the object that will perform the action registered for a given keystroke.
final ActionMap	getActionMap() Returns the `ActionMap` used to determine what `Action` to fire for particular `KeyStroke` binding.
float	getAlignmentX() Overrides `Container.getAlignmentX` to return the vertical alignment.
float	getAlignmentY() Overrides `Container.getAlignmentY` to return the horizontal alignment.
AncestorListener[]	getAncestorListeners() Returns an array of all the ancestor listeners registered on this component.
boolean	getAutoscrolls() Gets the `autoscrolls` property.
int	getBaseline(int width, int height) Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior() Returns an enum indicating how the baseline of the component changes as the size changes.
Border	getBorder() Returns the border of this component or `null` if no border is currently set.
Rectangle	getBounds(Rectangle rv) Stores the bounds of this component into "return value" `rv` and returns `rv`.
final Object	getClientProperty(Object key) Returns the value of the property with the specified key.
Graphics	getComponentGraphics(Graphics g) Returns the graphics object used to paint this component.
JPopupMenu	getComponentPopupMenu() Returns `JPopupMenu` that assigned for this component.
int	getConditionForKeyStroke(KeyStroke aKeyStroke) Returns the condition that determines whether a registered action occurs in response to the specified keystroke.
int	getDebugGraphicsOptions() Returns the state of graphics debugging.
static Locale	getDefaultLocale() Returns the default locale used to initialize each JComponent's locale property upon creation.
FontMetrics	getFontMetrics(Font font) Gets the `FontMetrics` for the specified `Font`.
Graphics	getGraphics() Returns this component's graphics context, which lets you draw on a component.
int	getHeight() Returns the current height of this component.
boolean	getInheritsPopupMenu() Returns true if the JPopupMenu should be inherited from the parent.
final InputMap	getInputMap() Returns the `InputMap` that is used when the component has focus.
final InputMap	getInputMap(int condition) Returns the `InputMap` that is used during `condition`.
InputVerifier	getInputVerifier() Returns the input verifier for this component.
Insets	getInsets() If a border has been set on this component, returns the border's insets; otherwise calls `super.getInsets`.
Insets	getInsets(Insets insets) Returns an `Insets` object containing this component's inset values.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `JComponent`.
Point	getLocation(Point rv) Stores the x,y origin of this component into "return value" `rv` and returns `rv`.
Dimension	getMaximumSize() If the maximum size has been set to a non-`null` value just returns it.
Dimension	getMinimumSize() If the minimum size has been set to a non-`null` value just returns it.
Component	getNextFocusableComponent() This method is deprecated. As of 1.4, replaced by `FocusTraversalPolicy`.
Point	getPopupLocation(MouseEvent event) Returns the preferred location to display the popup menu in this component's coordinate system.
Dimension	getPreferredSize() If the `preferredSize` has been set to a non-`null` value just returns it.
KeyStroke[]	getRegisteredKeyStrokes() Returns the `KeyStrokes` that will initiate registered actions.
JRootPane	getRootPane() Returns the `JRootPane` ancestor for this component.
Dimension	getSize(Dimension rv) Stores the width/height of this component into "return value" `rv` and returns `rv`.
Point	getToolTipLocation(MouseEvent event) Returns the tooltip location in this component's coordinate system.
String	getToolTipText() Returns the tooltip string that has been set with `setToolTipText`.
String	getToolTipText(MouseEvent event) Returns the string to be used as the tooltip for event.
Container	getTopLevelAncestor() Returns the top-level ancestor of this component (either the containing `Window` or `Applet`), or `null` if this component has not been added to any container.
TransferHandler	getTransferHandler() Gets the `transferHandler` property.
String	getUIClassID() Returns the `UIDefaults` key used to look up the name of the `swing.plaf.ComponentUI` class that defines the look and feel for this component.
boolean	getVerifyInputWhenFocusTarget() Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.
synchronized VetoableChangeListener[]	getVetoableChangeListeners() Returns an array of all the vetoable change listeners registered on this component.
Rectangle	getVisibleRect() Returns the `Component`'s "visible rectangle" - the intersection of this component's visible rectangle, `new Rectangle(0, 0, getWidth(), getHeight())`, and all of its ancestors' visible rectangles.
int	getWidth() Returns the current width of this component.
int	getX() Returns the current x coordinate of the component's origin.
int	getY() Returns the current y coordinate of the component's origin.
void	grabFocus() Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
boolean	isDoubleBuffered() Returns whether this component should use a buffer to paint.
static boolean	isLightweightComponent(Component c) Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.
boolean	isManagingFocus() This method is deprecated. As of 1.4, replaced by `Component.setFocusTraversalKeys(int, Set)` and `Container.setFocusCycleRoot(boolean)`.
boolean	isOpaque() Returns true if this component is completely opaque.
boolean	isOptimizedDrawingEnabled() Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap.
final boolean	isPaintingForPrint() Returns `true` if the current painting operation on this component is part of a `print` operation.
boolean	isPaintingTile() Returns true if the component is currently painting a tile.
boolean	isRequestFocusEnabled() Returns `true` if this `JComponent` should get focus; otherwise returns `false`.
boolean	isValidateRoot() If this method returns true, `revalidate` calls by descendants of this component will cause the entire tree beginning with this root to be validated.
void	paint(Graphics g) Invoked by Swing to draw components.
void	paintBorder(Graphics g) Paints the component's border.
void	paintChildren(Graphics g) Paints this component's children.
void	paintComponent(Graphics g) Calls the UI delegate's paint method, if the UI delegate is non-`null`.
void	paintImmediately(int x, int y, int w, int h) Paints the specified region in this component and all of its descendants that overlap the region, immediately.
void	paintImmediately(Rectangle r) Paints the specified region now.
String	paramString() Returns a string representation of this `JComponent`.
void	print(Graphics g) Invoke this method to print the component to the specified `Graphics`.
void	printAll(Graphics g) Invoke this method to print the component.
void	printBorder(Graphics g) Prints the component's border.
void	printChildren(Graphics g) Prints this component's children.
void	printComponent(Graphics g) This is invoked during a printing operation.
void	processComponentKeyEvent(KeyEvent e) Processes any key events that the component itself recognizes.
boolean	processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed) Invoked to process the key bindings for `ks` as the result of the `KeyEvent` `e`.
void	processKeyEvent(KeyEvent e) Overrides `processKeyEvent` to process events.
void	processMouseEvent(MouseEvent e) Processes mouse events occurring on this component by dispatching them to any registered `MouseListener` objects, refer to `processMouseEvent(MouseEvent)` for a complete description of this method.
void	processMouseMotionEvent(MouseEvent e) Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.
final void	putClientProperty(Object key, Object value) Adds an arbitrary key/value "client property" to this component.
void	registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination of `getActionMap()` and `getInputMap()` for similiar behavior.
void	registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination of `getActionMap()` and `getInputMap()` for similiar behavior.
void	removeAncestorListener(AncestorListener listener) Unregisters `listener` so that it will no longer receive `AncestorEvents`.
void	removeNotify() Notifies this component that it no longer has a parent component.
synchronized void	removeVetoableChangeListener(VetoableChangeListener listener) Removes a `VetoableChangeListener` from the listener list.
void	repaint(long tm, int x, int y, int width, int height) Adds the specified region to the dirty region list if the component is showing.
void	repaint(Rectangle r) Adds the specified region to the dirty region list if the component is showing.
boolean	requestDefaultFocus() This method is deprecated. As of 1.4, replaced by `FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()`
void	requestFocus() Requests that this `Component` gets the input focus.
boolean	requestFocus(boolean temporary) Requests that this `Component` gets the input focus.
boolean	requestFocusInWindow(boolean temporary) Requests that this `Component` gets the input focus.
boolean	requestFocusInWindow() Requests that this `Component` gets the input focus.
void	resetKeyboardActions() Unregisters all the bindings in the first tier `InputMaps` and `ActionMap`.
void	reshape(int x, int y, int w, int h) This method is deprecated. As of JDK 5, replaced by `Component.setBounds(int, int, int, int)`. Moves and resizes this component.
void	revalidate() Supports deferred automatic layout.
void	scrollRectToVisible(Rectangle aRect) Forwards the `scrollRectToVisible()` message to the `JComponent`'s parent.
final void	setActionMap(ActionMap am) Sets the `ActionMap` to `am`.
void	setAlignmentX(float alignmentX) Sets the the vertical alignment.
void	setAlignmentY(float alignmentY) Sets the the horizontal alignment.
void	setAutoscrolls(boolean autoscrolls) Sets the `autoscrolls` property.
void	setBackground(Color bg) Sets the background color of this component.
void	setBorder(Border border) Sets the border of this component.
void	setComponentPopupMenu(JPopupMenu popup) Sets the `JPopupMenu` for this `JComponent`.
void	setDebugGraphicsOptions(int debugOptions) Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.
static void	setDefaultLocale(Locale l) Sets the default locale used to initialize each JComponent's locale property upon creation.
void	setDoubleBuffered(boolean aFlag) Sets whether this component should use a buffer to paint.
void	setEnabled(boolean enabled) Sets whether or not this component is enabled.
void	setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component.
void	setFont(Font font) Sets the font for this component.
void	setForeground(Color fg) Sets the foreground color of this component.
void	setInheritsPopupMenu(boolean value) Sets whether or not `getComponentPopupMenu` should delegate to the parent if this component does not have a `JPopupMenu` assigned to it.
final void	setInputMap(int condition, InputMap map) Sets the `InputMap` to use under the condition `condition` to `map`.
void	setInputVerifier(InputVerifier inputVerifier) Sets the input verifier for this component.
void	setMaximumSize(Dimension maximumSize) Sets the maximum size of this component to a constant value.
void	setMinimumSize(Dimension minimumSize) Sets the minimum size of this component to a constant value.
void	setNextFocusableComponent(Component aComponent) This method is deprecated. As of 1.4, replaced by `FocusTraversalPolicy`
void	setOpaque(boolean isOpaque) If true the component paints every pixel within its bounds.
void	setPreferredSize(Dimension preferredSize) Sets the preferred size of this component.
void	setRequestFocusEnabled(boolean requestFocusEnabled) Provides a hint as to whether or not this `JComponent` should get focus.
void	setToolTipText(String text) Registers the text to display in a tool tip.
void	setTransferHandler(TransferHandler newHandler) Sets the `transferHandler` property, which is `null` if the component does not support data transfer operations.
void	setUI(ComponentUI newUI) Sets the look and feel delegate for this component.
void	setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget) Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.
void	setVisible(boolean aFlag) Makes the component visible or invisible.
void	unregisterKeyboardAction(KeyStroke aKeyStroke) This method is now obsolete.
void	update(Graphics g) Calls `paint`.
void	updateUI() Resets the UI property to a value from the current look and feel.

From class java.awt.Container

void	add(Component comp, Object constraints) Adds the specified component to the end of this container.
Component	add(String name, Component comp) Adds the specified component to this container.
Component	add(Component comp, int index) Adds the specified component to this container at the given position.
Component	add(Component comp) Appends the specified component to the end of this container.
void	add(Component comp, Object constraints, int index) Adds the specified component to this container with the specified constraints at the specified index.
synchronized void	addContainerListener(ContainerListener l) Adds the specified container listener to receive container events from this container.
void	addImpl(Component comp, Object constraints, int index) Adds the specified component to this container at the specified index.
void	addNotify() Makes this Container displayable by connecting it to a native screen resource.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
void	applyComponentOrientation(ComponentOrientation o) Sets the `ComponentOrientation` property of this container and all components contained within it.
boolean	areFocusTraversalKeysSet(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.
int	countComponents() This method is deprecated. As of JDK version 1.1, replaced by getComponentCount().
void	deliverEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by `dispatchEvent(AWTEvent e)`
void	doLayout() Causes this container to lay out its components.
Component	findComponentAt(Point p) Locates the visible child component that contains the specified point.
Component	findComponentAt(int x, int y) Locates the visible child component that contains the specified position.
float	getAlignmentX() Returns the alignment along the x axis.
float	getAlignmentY() Returns the alignment along the y axis.
Component	getComponent(int n) Gets the nth component in this container.
Component	getComponentAt(int x, int y) Locates the component that contains the x,y position.
Component	getComponentAt(Point p) Gets the component that contains the specified point.
int	getComponentCount() Gets the number of components in this panel.
int	getComponentZOrder(Component comp) Returns the z-order index of the component inside the container.
Component[]	getComponents() Gets all the components in this container.
synchronized ContainerListener[]	getContainerListeners() Returns an array of all the container listeners registered on this container.
Set<AWTKeyStroke>	getFocusTraversalKeys(int id) Returns the Set of focus traversal keys for a given traversal operation for this Container.
FocusTraversalPolicy	getFocusTraversalPolicy() Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.
Insets	getInsets() Determines the insets of this container, which indicate the size of the container's border.
LayoutManager	getLayout() Gets the layout manager for this container.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `Container`.
Dimension	getMaximumSize() Returns the maximum size of this container.
Dimension	getMinimumSize() Returns the minimum size of this container.
Point	getMousePosition(boolean allowChildren) Returns the position of the mouse pointer in this `Container`'s coordinate space if the `Container` is under the mouse pointer, otherwise returns `null`.
Dimension	getPreferredSize() Returns the preferred size of this container.
Insets	insets() This method is deprecated. As of JDK version 1.1, replaced by `getInsets()`.
void	invalidate() Invalidates the container.
boolean	isAncestorOf(Component c) Checks if the component is contained in the component hierarchy of this container.
boolean	isFocusCycleRoot(Container container) Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.
boolean	isFocusCycleRoot() Returns whether this Container is the root of a focus traversal cycle.
final boolean	isFocusTraversalPolicyProvider() Returns whether this container provides focus traversal policy.
boolean	isFocusTraversalPolicySet() Returns whether the focus traversal policy has been explicitly set for this Container.
void	layout() This method is deprecated. As of JDK version 1.1, replaced by `doLayout()`.
void	list(PrintStream out, int indent) Prints a listing of this container to the specified output stream.
void	list(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer.
Component	locate(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by `getComponentAt(int, int)`.
Dimension	minimumSize() This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
void	paint(Graphics g) Paints the container.
void	paintComponents(Graphics g) Paints each of the components in this container.
String	paramString() Returns a string representing the state of this `Container`.
Dimension	preferredSize() This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
void	print(Graphics g) Prints the container.
void	printComponents(Graphics g) Prints each of the components in this container.
void	processContainerEvent(ContainerEvent e) Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.
void	processEvent(AWTEvent e) Processes events on this container.
void	remove(Component comp) Removes the specified component from this container.
void	remove(int index) Removes the component, specified by `index`, from this container.
void	removeAll() Removes all the components from this container.
synchronized void	removeContainerListener(ContainerListener l) Removes the specified container listener so it no longer receives container events from this container.
void	removeNotify() Makes this Container undisplayable by removing its connection to its native screen resource.
void	setComponentZOrder(Component comp, int index) Moves the specified component to the specified z-order index in the container.
void	setFocusCycleRoot(boolean focusCycleRoot) Sets whether this Container is the root of a focus traversal cycle.
void	setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Container.
void	setFocusTraversalPolicy(FocusTraversalPolicy policy) Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.
final void	setFocusTraversalPolicyProvider(boolean provider) Sets whether this container will be used to provide focus traversal policy.
void	setFont(Font f) Sets the font of this container.
void	setLayout(LayoutManager mgr) Sets the layout manager for this container.
void	transferFocusDownCycle() Transfers the focus down one focus traversal cycle.
void	update(Graphics g) Updates the container.
void	validate() Validates this container and all of its subcomponents.
void	validateTree() Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).

From class java.awt.Component

boolean	action(Event evt, Object what) This method is deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
void	add(PopupMenu popup) Adds the specified popup menu to the component.
synchronized void	addComponentListener(ComponentListener l) Adds the specified component listener to receive component events from this component.
synchronized void	addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component when this component gains input focus.
void	addHierarchyBoundsListener(HierarchyBoundsListener l) Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.
void	addHierarchyListener(HierarchyListener l) Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.
synchronized void	addInputMethodListener(InputMethodListener l) Adds the specified input method listener to receive input method events from this component.
synchronized void	addKeyListener(KeyListener l) Adds the specified key listener to receive key events from this component.
synchronized void	addMouseListener(MouseListener l) Adds the specified mouse listener to receive mouse events from this component.
synchronized void	addMouseMotionListener(MouseMotionListener l) Adds the specified mouse motion listener to receive mouse motion events from this component.
synchronized void	addMouseWheelListener(MouseWheelListener l) Adds the specified mouse wheel listener to receive mouse wheel events from this component.
void	addNotify() Makes this `Component` displayable by connecting it to a native screen resource.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list.
void	applyComponentOrientation(ComponentOrientation orientation) Sets the `ComponentOrientation` property of this component and all components contained within it.
boolean	areFocusTraversalKeysSet(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Component.
Rectangle	bounds() This method is deprecated. As of JDK version 1.1, replaced by `getBounds()`.
int	checkImage(Image image, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.
int	checkImage(Image image, int width, int height, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image.
AWTEvent	coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent) Potentially coalesce an event being posted with an existing event.
boolean	contains(Point p) Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.
boolean	contains(int x, int y) Checks whether this component "contains" the specified point, where `x` and `y` are defined to be relative to the coordinate system of this component.
Image	createImage(int width, int height) Creates an off-screen drawable image to be used for double buffering.
Image	createImage(ImageProducer producer) Creates an image from the specified image producer.
VolatileImage	createVolatileImage(int width, int height, ImageCapabilities caps) Creates a volatile off-screen drawable image, with the given capabilities.
VolatileImage	createVolatileImage(int width, int height) Creates a volatile off-screen drawable image to be used for double buffering.
void	deliverEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by `dispatchEvent(AWTEvent e)`.
void	disable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	disableEvents(long eventsToDisable) Disables the events defined by the specified event mask parameter from being delivered to this component.
final void	dispatchEvent(AWTEvent e) Dispatches an event to this component or one of its sub components.
void	doLayout() Prompts the layout manager to lay out this component.
void	enable() This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
void	enable(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setEnabled(boolean)`.
final void	enableEvents(long eventsToEnable) Enables the events defined by the specified event mask parameter to be delivered to this component.
void	enableInputMethods(boolean enable) Enables or disables input method support for this component.
void	firePropertyChange(String propertyName, float oldValue, float newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, byte oldValue, byte newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, char oldValue, char newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, short oldValue, short newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, long oldValue, long newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties.
void	firePropertyChange(String propertyName, double oldValue, double newValue) Reports a bound property change.
void	firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes for Object properties.
void	firePropertyChange(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties.
AccessibleContext	getAccessibleContext() Gets the `AccessibleContext` associated with this `Component`.
float	getAlignmentX() Returns the alignment along the x axis.
float	getAlignmentY() Returns the alignment along the y axis.
Color	getBackground() Gets the background color of this component.
int	getBaseline(int width, int height) Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior() Returns an enum indicating how the baseline of the component changes as the size changes.
Rectangle	getBounds(Rectangle rv) Stores the bounds of this component into "return value" rv and return rv.
Rectangle	getBounds() Gets the bounds of this component in the form of a `Rectangle` object.
ColorModel	getColorModel() Gets the instance of `ColorModel` used to display the component on the output device.
Component	getComponentAt(Point p) Returns the component or subcomponent that contains the specified point.
Component	getComponentAt(int x, int y) Determines if this component or one of its immediate subcomponents contains the (x, y) location, and if so, returns the containing component.
synchronized ComponentListener[]	getComponentListeners() Returns an array of all the component listeners registered on this component.
ComponentOrientation	getComponentOrientation() Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.
Cursor	getCursor() Gets the cursor set in the component.
synchronized DropTarget	getDropTarget() Gets the `DropTarget` associated with this `Component`.
Container	getFocusCycleRootAncestor() Returns the Container which is the focus cycle root of this Component's focus traversal cycle.
synchronized FocusListener[]	getFocusListeners() Returns an array of all the focus listeners registered on this component.
Set<AWTKeyStroke>	getFocusTraversalKeys(int id) Returns the Set of focus traversal keys for a given traversal operation for this Component.
boolean	getFocusTraversalKeysEnabled() Returns whether focus traversal keys are enabled for this Component.
Font	getFont() Gets the font of this component.
FontMetrics	getFontMetrics(Font font) Gets the font metrics for the specified font.
Color	getForeground() Gets the foreground color of this component.
Graphics	getGraphics() Creates a graphics context for this component.
GraphicsConfiguration	getGraphicsConfiguration() Gets the `GraphicsConfiguration` associated with this `Component`.
int	getHeight() Returns the current height of this component.
synchronized HierarchyBoundsListener[]	getHierarchyBoundsListeners() Returns an array of all the hierarchy bounds listeners registered on this component.
synchronized HierarchyListener[]	getHierarchyListeners() Returns an array of all the hierarchy listeners registered on this component.
boolean	getIgnoreRepaint()
InputContext	getInputContext() Gets the input context used by this component for handling the communication with input methods when text is entered in this component.
synchronized InputMethodListener[]	getInputMethodListeners() Returns an array of all the input method listeners registered on this component.
InputMethodRequests	getInputMethodRequests() Gets the input method request handler which supports requests from input methods for this component.
synchronized KeyListener[]	getKeyListeners() Returns an array of all the key listeners registered on this component.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `Component`.
Locale	getLocale() Gets the locale of this component.
Point	getLocation() Gets the location of this component in the form of a point specifying the component's top-left corner.
Point	getLocation(Point rv) Stores the x,y origin of this component into "return value" rv and return rv.
Point	getLocationOnScreen() Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.
Dimension	getMaximumSize() Gets the maximum size of this component.
Dimension	getMinimumSize() Gets the mininimum size of this component.
synchronized MouseListener[]	getMouseListeners() Returns an array of all the mouse listeners registered on this component.
synchronized MouseMotionListener[]	getMouseMotionListeners() Returns an array of all the mouse motion listeners registered on this component.
Point	getMousePosition() Returns the position of the mouse pointer in this `Component`'s coordinate space if the `Component` is directly under the mouse pointer, otherwise returns `null`.
synchronized MouseWheelListener[]	getMouseWheelListeners() Returns an array of all the mouse wheel listeners registered on this component.
String	getName() Gets the name of the component.
Container	getParent() Gets the parent of this component.
ComponentPeer	getPeer() This method is deprecated. As of JDK version 1.1, programs should not directly manipulate peers; replaced by `boolean isDisplayable()`.
Dimension	getPreferredSize() Gets the preferred size of this component.
PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the property change listeners registered on this component.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName) Returns an array of all the listeners which have been associated with the named property.
Dimension	getSize() Returns the size of this component in the form of a `Dimension` object.
Dimension	getSize(Dimension rv) Stores the width/height of this component into "return value" rv and return rv.
Toolkit	getToolkit() Gets the toolkit of this component.
final Object	getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations.
int	getWidth() Returns the current width of this component.
int	getX() Returns the current x coordinate of the components origin.
int	getY() Returns the current y coordinate of the components origin.
boolean	gotFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
boolean	handleEvent(Event evt) This method is deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent).
boolean	hasFocus() Returns `true` if this `Component` is the focus owner.
void	hide() This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
boolean	imageUpdate(Image img, int infoflags, int x, int y, int w, int h) Repaints the component when the image has changed.
boolean	inside(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by contains(int, int).
void	invalidate() Invalidates this component.
boolean	isBackgroundSet() Returns whether the background color has been explicitly set for this Component.
boolean	isCursorSet() Returns whether the cursor has been explicitly set for this Component.
boolean	isDisplayable() Determines whether this component is displayable.
boolean	isDoubleBuffered() Returns true if this component is painted to an offscreen image ("buffer") that's copied to the screen later.
boolean	isEnabled() Determines whether this component is enabled.
boolean	isFocusCycleRoot(Container container) Returns whether the specified Container is the focus cycle root of this Component's focus traversal cycle.
boolean	isFocusOwner() Returns `true` if this `Component` is the focus owner.
boolean	isFocusTraversable() This method is deprecated. As of 1.4, replaced by `isFocusable()`.
boolean	isFocusable() Returns whether this Component can be focused.
boolean	isFontSet() Returns whether the font has been explicitly set for this Component.
boolean	isForegroundSet() Returns whether the foreground color has been explicitly set for this Component.
boolean	isLightweight() A lightweight component doesn't have a native toolkit peer.
boolean	isMaximumSizeSet() Returns true if the maximum size has been set to a non-`null` value otherwise returns false.
boolean	isMinimumSizeSet() Returns whether or not `setMinimumSize` has been invoked with a non-null value.
boolean	isOpaque() Returns true if this component is completely opaque, returns false by default.
boolean	isPreferredSizeSet() Returns true if the preferred size has been set to a non-`null` value otherwise returns false.
boolean	isShowing() Determines whether this component is showing on screen.
boolean	isValid() Determines whether this component is valid.
boolean	isVisible() Determines whether this component should be visible when its parent is visible.
boolean	keyDown(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
boolean	keyUp(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
void	layout() This method is deprecated. As of JDK version 1.1, replaced by `doLayout()`.
void	list(PrintStream out) Prints a listing of this component to the specified output stream.
void	list() Prints a listing of this component to the standard system output stream `System.out`.
void	list(PrintStream out, int indent) Prints out a list, starting at the specified indentation, to the specified print stream.
void	list(PrintWriter out) Prints a listing to the specified print writer.
void	list(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer.
Component	locate(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int).
Point	location() This method is deprecated. As of JDK version 1.1, replaced by `getLocation()`.
boolean	lostFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
Dimension	minimumSize() This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
boolean	mouseDown(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseDrag(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseEnter(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseExit(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseMove(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseUp(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
void	move(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by `setLocation(int, int)`.
void	nextFocus() This method is deprecated. As of JDK version 1.1, replaced by transferFocus().
void	paint(Graphics g) Paints this component.
void	paintAll(Graphics g) Paints this component and all of its subcomponents.
String	paramString() Returns a string representing the state of this component.
boolean	postEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
Dimension	preferredSize() This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
boolean	prepareImage(Image image, ImageObserver observer) Prepares an image for rendering on this component.
boolean	prepareImage(Image image, int width, int height, ImageObserver observer) Prepares an image for rendering on this component at the specified width and height.
void	print(Graphics g) Prints this component.
void	printAll(Graphics g) Prints this component and all of its subcomponents.
void	processComponentEvent(ComponentEvent e) Processes component events occurring on this component by dispatching them to any registered `ComponentListener` objects.
void	processEvent(AWTEvent e) Processes events occurring on this component.
void	processFocusEvent(FocusEvent e) Processes focus events occurring on this component by dispatching them to any registered `FocusListener` objects.
void	processHierarchyBoundsEvent(HierarchyEvent e) Processes hierarchy bounds events occurring on this component by dispatching them to any registered `HierarchyBoundsListener` objects.
void	processHierarchyEvent(HierarchyEvent e) Processes hierarchy events occurring on this component by dispatching them to any registered `HierarchyListener` objects.
void	processInputMethodEvent(InputMethodEvent e) Processes input method events occurring on this component by dispatching them to any registered `InputMethodListener` objects.
void	processKeyEvent(KeyEvent e) Processes key events occurring on this component by dispatching them to any registered `KeyListener` objects.
void	processMouseEvent(MouseEvent e) Processes mouse events occurring on this component by dispatching them to any registered `MouseListener` objects.
void	processMouseMotionEvent(MouseEvent e) Processes mouse motion events occurring on this component by dispatching them to any registered `MouseMotionListener` objects.
void	processMouseWheelEvent(MouseWheelEvent e) Processes mouse wheel events occurring on this component by dispatching them to any registered `MouseWheelListener` objects.
void	remove(MenuComponent popup) Removes the specified popup menu from the component.
synchronized void	removeComponentListener(ComponentListener l) Removes the specified component listener so that it no longer receives component events from this component.
synchronized void	removeFocusListener(FocusListener l) Removes the specified focus listener so that it no longer receives focus events from this component.
void	removeHierarchyBoundsListener(HierarchyBoundsListener l) Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.
void	removeHierarchyListener(HierarchyListener l) Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.
synchronized void	removeInputMethodListener(InputMethodListener l) Removes the specified input method listener so that it no longer receives input method events from this component.
synchronized void	removeKeyListener(KeyListener l) Removes the specified key listener so that it no longer receives key events from this component.
synchronized void	removeMouseListener(MouseListener l) Removes the specified mouse listener so that it no longer receives mouse events from this component.
synchronized void	removeMouseMotionListener(MouseMotionListener l) Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
synchronized void	removeMouseWheelListener(MouseWheelListener l) Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.
void	removeNotify() Makes this `Component` undisplayable by destroying it native screen resource.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes a `PropertyChangeListener` from the listener list for a specific property.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list.
void	repaint(int x, int y, int width, int height) Repaints the specified rectangle of this component.
void	repaint(long tm, int x, int y, int width, int height) Repaints the specified rectangle of this component within `tm` milliseconds.
void	repaint() Repaints this component.
void	repaint(long tm) Repaints the component.
void	requestFocus() Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
boolean	requestFocus(boolean temporary) Requests that this `Component` get the input focus, and that this `Component`'s top-level ancestor become the focused `Window`.
boolean	requestFocusInWindow(boolean temporary) Requests that this `Component` get the input focus, if this `Component`'s top-level ancestor is already the focused `Window`.
boolean	requestFocusInWindow() Requests that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.
void	reshape(int x, int y, int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setBounds(int, int, int, int)`.
void	resize(Dimension d) This method is deprecated. As of JDK version 1.1, replaced by `setSize(Dimension)`.
void	resize(int width, int height) This method is deprecated. As of JDK version 1.1, replaced by `setSize(int, int)`.
void	setBackground(Color c) Sets the background color of this component.
void	setBounds(int x, int y, int width, int height) Moves and resizes this component.
void	setBounds(Rectangle r) Moves and resizes this component to conform to the new bounding rectangle `r`.
void	setComponentOrientation(ComponentOrientation o) Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
void	setCursor(Cursor cursor) Sets the cursor image to the specified cursor.
synchronized void	setDropTarget(DropTarget dt) Associate a `DropTarget` with this component.
void	setEnabled(boolean b) Enables or disables this component, depending on the value of the parameter `b`.
void	setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component.
void	setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled) Sets whether focus traversal keys are enabled for this Component.
void	setFocusable(boolean focusable) Sets the focusable state of this Component to the specified value.
void	setFont(Font f) Sets the font of this component.
void	setForeground(Color c) Sets the foreground color of this component.
void	setIgnoreRepaint(boolean ignoreRepaint) Sets whether or not paint messages received from the operating system should be ignored.
void	setLocale(Locale l) Sets the locale of this component.
void	setLocation(int x, int y) Moves this component to a new location.
void	setLocation(Point p) Moves this component to a new location.
void	setMaximumSize(Dimension maximumSize) Sets the maximum size of this component to a constant value.
void	setMinimumSize(Dimension minimumSize) Sets the minimum size of this component to a constant value.
void	setName(String name) Sets the name of the component to the specified string.
void	setPreferredSize(Dimension preferredSize) Sets the preferred size of this component to a constant value.
void	setSize(int width, int height) Resizes this component so that it has width `width` and height `height`.
void	setSize(Dimension d) Resizes this component so that it has width `d.width` and height `d.height`.
void	setVisible(boolean b) Shows or hides this component depending on the value of parameter `b`.
void	show() This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
void	show(boolean b) This method is deprecated. As of JDK version 1.1, replaced by `setVisible(boolean)`.
Dimension	size() This method is deprecated. As of JDK version 1.1, replaced by `getSize()`.
String	toString() Returns a string representation of this component and its values.
void	transferFocus() Transfers the focus to the next component, as though this Component were the focus owner.
void	transferFocusBackward() Transfers the focus to the previous component, as though this Component were the focus owner.
void	transferFocusUpCycle() Transfers the focus up one focus traversal cycle.
void	update(Graphics g) Updates this component.
void	validate() Ensures that this component has a valid layout.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.MenuContainer

From interface java.awt.image.ImageObserver

From interface javax.accessibility.Accessible

From interface javax.swing.Scrollable

Constants

public static final String notifyAction

Name of the action to send notification that the contents of the field have been accepted. Typically this is bound to a carriage-return.

Constant Value: "notify-field-accept"

Public Constructors

public JTextField ()

Constructs a new TextField. A default model is created, the initial string is null, and the number of columns is set to 0.

public JTextField (String text)

Constructs a new TextField initialized with the specified text. A default model is created and the number of columns is 0.

Parameters

text	the text to be displayed, or `null`

public JTextField (int columns)

Constructs a new empty TextField with the specified number of columns. A default model is created and the initial string is set to null.

Parameters

columns	the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

public JTextField (String text, int columns)

Constructs a new TextField initialized with the specified text and columns. A default model is created.

Parameters

text	the text to be displayed, or `null`
columns	the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation

public JTextField (Document doc, String text, int columns)

Constructs a new JTextField that uses the given text storage model and the given number of columns. This is the constructor through which the other constructors feed. If the document is null, a default model is created.

Parameters

doc	the text storage to use; if this is `null`, a default will be provided by calling the `createDefaultModel` method
text	the initial string to display, or `null`
columns	the number of columns to use to calculate the preferred width >= 0; if `columns` is set to zero, the preferred width will be whatever naturally results from the component implementation

Throws

IllegalArgumentException	if `columns` < 0

Public Methods

public synchronized void addActionListener (ActionListener l)

Adds the specified action listener to receive action events from this textfield.

Parameters

l	the action listener to be added

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this JTextField. For JTextFields, the AccessibleContext takes the form of an AccessibleJTextField. A new AccessibleJTextField instance is created if necessary.

Returns

an AccessibleJTextField that serves as the AccessibleContext of this JTextField

public Action getAction ()

Returns the currently set Action for this ActionEvent source, or null if no Action is set.

Returns

the Action for this ActionEvent source, or null

public synchronized ActionListener[] getActionListeners ()

Returns an array of all the ActionListeners added to this JTextField with addActionListener().

Returns

all of the ActionListeners added or an empty array if no listeners have been added

public Action[] getActions ()

Fetches the command list for the editor. This is the list of commands supported by the plugged-in UI augmented by the collection of commands that the editor itself supports. These are useful for binding to events, such as in a keymap.

Returns

the command list

public int getColumns ()

Returns the number of columns in this TextField.

Returns

the number of columns >= 0

public int getHorizontalAlignment ()

Returns the horizontal alignment of the text. Valid keys are:

JTextField.LEFT
JTextField.CENTER
JTextField.RIGHT
JTextField.LEADING
JTextField.TRAILING

Returns

the horizontal alignment

public BoundedRangeModel getHorizontalVisibility ()

Gets the visibility of the text field. This can be adjusted to change the location of the visible area if the size of the field is greater than the area that was allocated to the field.

The fields look-and-feel implementation manages the values of the minimum, maximum, and extent properties on the BoundedRangeModel.

Returns

the visibility

public Dimension getPreferredSize ()

Returns the preferred size Dimensions needed for this TextField. If a non-zero number of columns has been set, the width is set to the columns multiplied by the column width.

Returns

the dimension of this textfield

public int getScrollOffset ()

Gets the scroll offset, in pixels.

Returns

the offset >= 0

public String getUIClassID ()

Gets the class ID for a UI.

Returns

the string "TextFieldUI"

public boolean isValidateRoot ()

Calls to revalidate that come from within the textfield itself will be handled by validating the textfield, unless the textfield is contained within a JViewport, in which case this returns false.

Returns

if the parent of this textfield is a JViewPort return false, otherwise return true

public void postActionEvent ()

Processes action events occurring on this textfield by dispatching them to any registered ActionListener objects. This is normally called by the controller registered with textfield.

public synchronized void removeActionListener (ActionListener l)

Removes the specified action listener so that it no longer receives action events from this textfield.

Parameters

l	the action listener to be removed

public void scrollRectToVisible (Rectangle r)

Scrolls the field left or right.

Parameters

r	the region to scroll

public void setAction (Action a)

Sets the Action for the ActionEvent source. The new Action replaces any previously set Action but does not affect ActionListeners independently added with addActionListener. If the Action is already a registered ActionListener for the ActionEvent source, it is not re-registered.

Setting the Action results in immediately changing all the properties described in Swing Components Supporting Action. Subsequently, the textfield's properties are automatically updated as the Action's properties change.

This method uses three other methods to set and help track the Action's property values. It uses the configurePropertiesFromAction method to immediately change the textfield's properties. To track changes in the Action's property values, this method registers the PropertyChangeListener returned by createActionPropertyChangeListener. The default PropertyChangeListener invokes the actionPropertyChanged method when a property in the Action changes.

Parameters

a	the `Action` for the `JTextField`, or `null`

public void setActionCommand (String command)

Sets the command string used for action events.

Parameters

command	the command string

public void setColumns (int columns)

Sets the number of columns in this TextField, and then invalidate the layout.

Parameters

columns	the number of columns >= 0

Throws

IllegalArgumentException	if `columns` is less than 0

public void setDocument (Document doc)

Associates the editor with a text document. The currently registered factory is used to build a view for the document, which gets displayed by the editor after revalidation. A PropertyChange event ("document") is propagated to each listener.

Parameters

doc	the document to display/edit

public void setFont (Font f)

Sets the current font. This removes cached row height and column width so the new font will be reflected. revalidate is called after setting the font.

Parameters

f	the new font

public void setHorizontalAlignment (int alignment)

Sets the horizontal alignment of the text. Valid keys are:

JTextField.LEFT
JTextField.CENTER
JTextField.RIGHT
JTextField.LEADING
JTextField.TRAILING

invalidate and repaint are called when the alignment is set, and a PropertyChange event ("horizontalAlignment") is fired.

Parameters

alignment	the alignment

Throws

IllegalArgumentException	if `alignment` is not a valid key

public void setScrollOffset (int scrollOffset)

Sets the scroll offset, in pixels.

Parameters

scrollOffset	the offset >= 0

Protected Methods

protected void actionPropertyChanged (Action action, String propertyName)

Updates the textfield's state in response to property changes in associated action. This method is invoked from the PropertyChangeListener returned from createActionPropertyChangeListener. Subclasses do not normally need to invoke this. Subclasses that support additional Action properties should override this and configurePropertiesFromAction.

Refer to the table at Swing Components Supporting Action for a list of the properties this method sets.

Parameters

action	the `Action` associated with this textfield
propertyName	the name of the property that changed

protected void configurePropertiesFromAction (Action a)

Sets the properties on this textfield to match those in the specified Action. Refer to Swing Components Supporting Action for more details as to which properties this sets.

Parameters

a	the `Action` from which to get the properties, or `null`

protected PropertyChangeListener createActionPropertyChangeListener (Action a)

Creates and returns a PropertyChangeListener that is responsible for listening for changes from the specified Action and updating the appropriate properties.

Warning: If you subclass this do not create an anonymous inner class. If you do the lifetime of the textfield will be tied to that of the Action.

Parameters

a	the textfield's action

protected Document createDefaultModel ()

Creates the default implementation of the model to be used at construction if one isn't explicitly given. An instance of PlainDocument is returned.

Returns

the default model implementation

protected void fireActionPerformed ()

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created. The listener list is processed in last to first order.

protected int getColumnWidth ()

Returns the column width. The meaning of what a column is can be considered a fairly weak notion for some fonts. This method is used to define the width of a column. By default this is defined to be the width of the character m for the font used. This method can be redefined to be some alternative amount

Returns

the column width >= 1

protected String paramString ()

Returns a string representation of this JTextField. 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.

Returns

a string representation of this JTextField

Interfaces

Classes

Enums

Exceptions

JTextField

Class Overview

See Also

Summary

Constants

public static final String notifyAction

Public Constructors

public JTextField ()

public JTextField (String text)

Parameters

public JTextField (int columns)

Parameters

public JTextField (String text, int columns)

Parameters

public JTextField (Document doc, String text, int columns)

Parameters

Throws

Public Methods

public synchronized void addActionListener (ActionListener l)

Parameters

public AccessibleContext getAccessibleContext ()

Returns

public Action getAction ()

Returns

See Also

public synchronized ActionListener[] getActionListeners ()

Returns

public Action[] getActions ()

Returns

public int getColumns ()

Returns

public int getHorizontalAlignment ()

Returns

public BoundedRangeModel getHorizontalVisibility ()

Returns

See Also

public Dimension getPreferredSize ()

Returns

public int getScrollOffset ()

Returns

public String getUIClassID ()

Returns

See Also

public boolean isValidateRoot ()

Returns

See Also

public void postActionEvent ()

public synchronized void removeActionListener (ActionListener l)

Parameters

public void scrollRectToVisible (Rectangle r)

Parameters

public void setAction (Action a)

Parameters

See Also

public void setActionCommand (String command)

Parameters

public void setColumns (int columns)

Parameters

Throws

public void setDocument (Document doc)

Parameters

See Also

public void setFont (Font f)

Parameters

public void setHorizontalAlignment (int alignment)

Parameters

Throws

public void setScrollOffset (int scrollOffset)

Parameters

Protected Methods

protected void actionPropertyChanged (Action action, String propertyName)

Parameters

See Also

protected void configurePropertiesFromAction (Action a)

Parameters

See Also