OpenJDK 27 · javax.swing.JTextField · APIdia, the JavaDoc alternative

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 has been added to the java.beans package. Please see java.beans.XMLEncoder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	JTextField.AccessibleJTextField This class implements accessibility support for the `JTextField` class.
pack-priv static class	JTextField.NotifyAction
pack-priv class	JTextField.ScrollRepainter
private static class	JTextField.TextFieldActionPropertyChangeListener

Field Summary

Modifier and Type	Field and Description
private Action	action
private PropertyChangeListener	actionPropertyChangeListener
private int	columns
private int	columnWidth
private String	command
private static final Action[]	defaultActions
private int	horizontalAlignment
public static final String	notifyAction Name of the action to send notification that the contents of the field have been accepted.
private static final String	uiClassID Hides javax.swing.JComponent.uiClassID.
private BoundedRangeModel	visibility

Inherited from javax.swing.text.JTextComponent:: DEFAULT_KEYMAP FOCUS_ACCELERATOR_KEY

Constructor Summary

Access	Constructor and Description
public	JTextField() Constructs a new `TextField`.
public	JTextField(String the text to be displayed, or `null` text) Constructs a new `TextField` initialized with the specified text.
public	JTextField(int 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 columns) Constructs a new empty `TextField` with the specified number of columns.
public	JTextField(String the text to be displayed, or `null` text, int 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 columns) Constructs a new `TextField` initialized with the specified text and columns.
public	JTextField(Document the text storage to use; if this is `null`, a default will be provided by calling the `createDefaultModel` method doc, String the initial string to display, or `null` text, int 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 columns) Constructs a new `JTextField` that uses the given text storage model and the given number of columns.

Method Summary

Modifier and Type	Method and Description
protected void	actionPropertyChanged(Action the `Action` associated with this textfield action, String the name of the property that changed propertyName) Updates the textfield's state in response to property changes in associated action.
public synchronized void	addActionListener(ActionListener the action listener to be added l) Adds the specified action listener to receive action events from this textfield.
protected void	configurePropertiesFromAction(Action the `Action` from which to get the properties, or `null` a) Sets the properties on this textfield to match those in the specified `Action`.
protected PropertyChangeListener	Returns: a `PropertyChangeListener` that is responsible for listening for changes from the specified `Action` and updating the appropriate properties createActionPropertyChangeListener(Action the textfield's action a) Creates and returns a `PropertyChangeListener` that is responsible for listening for changes from the specified `Action` and updating the appropriate properties.
protected Document	Returns: the default model implementation createDefaultModel() Creates the default implementation of the model to be used at construction if one isn't explicitly given.
protected void	fireActionPerformed() Notifies all listeners that have registered interest for notification on this event type.
public AccessibleContext	Returns: an `AccessibleJTextField` that serves as the `AccessibleContext` of this `JTextField` getAccessibleContext() Overrides javax.swing.text.JTextComponent.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the `AccessibleContext` associated with this `JTextField`.
public Action	Returns: the `Action` for this `ActionEvent` source, or `null` getAction() Returns the currently set `Action` for this `ActionEvent` source, or `null` if no `Action` is set.
public synchronized ActionListener[]	Returns: all of the `ActionListener`s added or an empty array if no listeners have been added getActionListeners() Returns an array of all the `ActionListener`s added to this JTextField with addActionListener().
public Action[]	Returns: the command list getActions() Overrides javax.swing.text.JTextComponent.getActions. Fetches the command list for the editor.
public int	Returns: the number of columns >= 0 getColumns() Returns the number of columns in this `TextField`.
protected int	Returns: the column width >= 1 getColumnWidth() Returns the column width.
public int	Returns: the horizontal alignment getHorizontalAlignment() Returns the horizontal alignment of the text.
public BoundedRangeModel	Returns: the visibility getHorizontalVisibility() Gets the visibility of the text field.
public Dimension	Returns: the dimension of this textfield getPreferredSize() Overrides javax.swing.JComponent.getPreferredSize. Returns the preferred size `Dimensions` needed for this `TextField`.
public int	Returns: the offset >= 0 getScrollOffset() Gets the scroll offset, in pixels.
public String	Returns: the string "TextFieldUI" getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Gets the class ID for a UI.
pack-priv boolean	hasActionListener() Returns true if the receiver has an `ActionListener` installed.
private boolean	isListener(Class<?> c, ActionListener a)
public boolean	Returns: if the parent of this textfield is a `JViewPort` return false, otherwise return true isValidateRoot() Overrides javax.swing.JComponent.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.
protected String	Returns: a string representation of this `JTextField` paramString() Overrides javax.swing.text.JTextComponent.paramString. Returns a string representation of this `JTextField`.
public void	postActionEvent() Processes action events occurring on this textfield by dispatching them to any registered `ActionListener` objects.
public synchronized void	removeActionListener(ActionListener the action listener to be removed l) Removes the specified action listener so that it no longer receives action events from this textfield.
public void	scrollRectToVisible(Rectangle the region to scroll r) Overrides javax.swing.JComponent.scrollRectToVisible. Scrolls the field left or right.
public void	setAction(Action the `Action` for the `JTextField`, or `null` a) Sets the `Action` for the `ActionEvent` source.
public void	setActionCommand(String the command string command) Sets the command string used for action events.
private void	setActionCommandFromAction(Action action)
public void	setColumns(int the number of columns >= 0 columns) Sets the number of columns in this `TextField`, and then invalidate the layout.
public void	setDocument(Document the document to display/edit doc) Overrides javax.swing.text.JTextComponent.setDocument. Associates the editor with a text document.
public void	setFont(Font the new font f) Overrides javax.swing.JComponent.setFont. Sets the current font.
public void	setHorizontalAlignment(int the alignment alignment) Sets the horizontal alignment of the text.
public void	setScrollOffset(int the offset >= 0 scrollOffset) Sets the scroll offset, in pixels.
private void	writeObject(ObjectOutputStream s) Hides javax.swing.JComponent.writeObject. See `readObject` and `writeObject` in `JComponent` for more information about serialization in Swing.

Inherited from javax.swing.text.JTextComponent:: addCaretListener addInputMethodListener addKeymap copy cut fireCaretUpdate getCaret getCaretColor getCaretListeners getCaretPosition getDisabledTextColor getDocument getDragEnabled getDropLocation getDropMode getFocusAccelerator getHighlighter getInputMethodRequests getKeymap getKeymap getMargin getNavigationFilter getPreferredScrollableViewportSize getPrintable getScrollableBlockIncrement getScrollableTracksViewportHeight getScrollableTracksViewportWidth getScrollableUnitIncrement getSelectedText getSelectedTextColor getSelectionColor getSelectionEnd getSelectionStart getText getText getToolTipText getUI isEditable loadKeymap modelToView modelToView2D moveCaretPosition paste print print print processInputMethodEvent read removeCaretListener removeKeymap removeNotify replaceSelection restoreComposedText saveComposedText select selectAll setCaret setCaretColor setCaretPosition setComponentOrientation setDisabledTextColor setDragEnabled setDropMode setEditable setFocusAccelerator setHighlighter setKeymap setMargin setNavigationFilter setSelectedTextColor setSelectionColor setSelectionEnd setSelectionStart setText setUI updateUI viewToModel viewToModel2D write

Field Detail

action	back to summary
private Action action

actionPropertyChangeListener	back to summary
private PropertyChangeListener actionPropertyChangeListener

columns	back to summary
private int columns

columnWidth	back to summary
private int columnWidth

command	back to summary
private String command

defaultActions	back to summary
private static final Action[] defaultActions

horizontalAlignment	back to summary
private int horizontalAlignment

notifyAction	back to summary
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.

uiClassID back to summary

uiClassID	back to summary
private static final String uiClassID Hides javax.swing.JComponent.uiClassID. See Also `getUIClassID`, `readObject`

private static final String uiClassID

Hides javax.swing.JComponent.uiClassID.

See Also: getUIClassID, readObject

visibility	back to summary
private BoundedRangeModel visibility

Constructor Detail

JTextField	back to summary
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.

JTextField back to summary

JTextField	back to summary
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:String the text to be displayed, or `null`

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:String: the text to be displayed, or null

JTextField back to summary

JTextField	back to summary
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:int 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(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:int: 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

JTextField back to summary

JTextField	back to summary
public JTextField(String text, int columns) Constructs a new `TextField` initialized with the specified text and columns. A default model is created. Parameters text:String the text to be displayed, or `null` columns:int 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:String: the text to be displayed, or null
columns:int: 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

JTextField back to summary

JTextField	back to summary
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:Document the text storage to use; if this is `null`, a default will be provided by calling the `createDefaultModel` method text:String the initial string to display, or `null` columns:int 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 Exceptions IllegalArgumentException: if `columns` < 0

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:Document: the text storage to use; if this is null, a default will be provided by calling the createDefaultModel method
text:String: the initial string to display, or null
columns:int: 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

Exceptions

IllegalArgumentException:: if columns < 0

Method Detail

actionPropertyChanged back to summary

actionPropertyChanged	back to summary
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:Action the `Action` associated with this textfield propertyName:String the name of the property that changed Since 1.6 See Also `Action`, `configurePropertiesFromAction`

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:Action: the Action associated with this textfield
propertyName:String: the name of the property that changed

Since

1.6

addActionListener	back to summary
public synchronized void addActionListener(ActionListener l) Adds the specified action listener to receive action events from this textfield. Parameters l:ActionListener the action listener to be added

addActionListener

back to summary

public synchronized void addActionListener(ActionListener l)

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

Parameters

l:ActionListener: the action listener to be added

configurePropertiesFromAction back to summary

configurePropertiesFromAction	back to summary
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:Action the `Action` from which to get the properties, or `null` Since 1.3 See Also `Action`, `setAction`

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:Action: the Action from which to get the properties, or null

Since

1.3

See Also

Action, setAction

createActionPropertyChangeListener back to summary

createActionPropertyChangeListener	back to summary
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:Action the textfield's action Returns:PropertyChangeListener a `PropertyChangeListener` that is responsible for listening for changes from the specified `Action` and updating the appropriate properties Since 1.3 See Also `Action`, `setAction`

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:Action: the textfield's action

Returns:PropertyChangeListener

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

Since

1.3

See Also

Action, setAction

createDefaultModel back to summary

createDefaultModel	back to summary
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:Document the default model implementation

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:Document: the default model implementation

fireActionPerformed back to summary

fireActionPerformed	back to summary
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. Annotations @SuppressWarnings:deprecation See Also `EventListenerList`

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.

Annotations

@SuppressWarnings:deprecation

See Also

EventListenerList

getAccessibleContext back to summary

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides javax.swing.text.JTextComponent.getAccessibleContext. Implements javax.accessibility.Accessible.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:AccessibleContext an `AccessibleJTextField` that serves as the `AccessibleContext` of this `JTextField` Annotations @BeanProperty bound:false

public AccessibleContext getAccessibleContext()

Overrides javax.swing.text.JTextComponent.getAccessibleContext.

Implements javax.accessibility.Accessible.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:AccessibleContext

an AccessibleJTextField that serves as the AccessibleContext of this JTextField

Annotations

@BeanProperty
bound:false

getAction back to summary

getAction	back to summary
public Action getAction() Returns the currently set `Action` for this `ActionEvent` source, or `null` if no `Action` is set. Returns:Action the `Action` for this `ActionEvent` source, or `null` Since 1.3 See Also `Action`, `setAction`

public Action getAction()

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

Returns:Action: the Action for this ActionEvent source, or null
Since: 1.3
See Also: Action, setAction

getActionListeners back to summary

getActionListeners	back to summary
public synchronized ActionListener[] getActionListeners() Returns an array of all the `ActionListener`s added to this JTextField with addActionListener(). Returns:ActionListener[] all of the `ActionListener`s added or an empty array if no listeners have been added Annotations @BeanProperty bound:false Since 1.4

public synchronized ActionListener[] getActionListeners()

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

Returns:ActionListener[]

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

Annotations

@BeanProperty
bound:false

Since

1.4

getActions	back to summary
public Action[] getActions() Overrides javax.swing.text.JTextComponent.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:Action[] the command list Annotations @BeanProperty bound:false

getActions

back to summary

public Action[] getActions()

Overrides javax.swing.text.JTextComponent.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:Action[]

the command list

Annotations

@BeanProperty
bound:false

getColumns back to summary

getColumns	back to summary
public int getColumns() Returns the number of columns in this `TextField`. Returns:int the number of columns >= 0

public int getColumns()

Returns the number of columns in this TextField.

Returns:int: the number of columns >= 0

getColumnWidth	back to summary
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:int the column width >= 1

getColumnWidth

back to summary

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:int: the column width >= 1

getHorizontalAlignment back to summary

getHorizontalAlignment	back to summary
public int getHorizontalAlignment() Returns the horizontal alignment of the text. Valid keys are: `JTextField.LEFT` `JTextField.CENTER` `JTextField.RIGHT` `JTextField.LEADING` `JTextField.TRAILING` Returns:int the horizontal alignment

public int getHorizontalAlignment()

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

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

Returns:int: the horizontal alignment

getHorizontalVisibility back to summary

getHorizontalVisibility	back to summary
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:BoundedRangeModel the visibility Annotations @BeanProperty bound:false See Also `BoundedRangeModel`

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:BoundedRangeModel

the visibility

Annotations

@BeanProperty
bound:false

See Also

BoundedRangeModel

getPreferredSize back to summary

getPreferredSize	back to summary
public Dimension getPreferredSize() Overrides javax.swing.JComponent.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:Dimension the dimension of this textfield

public Dimension getPreferredSize()

Overrides javax.swing.JComponent.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:Dimension: the dimension of this textfield

getScrollOffset	back to summary
public int getScrollOffset() Gets the scroll offset, in pixels. Returns:int the offset >= 0

getScrollOffset

back to summary

public int getScrollOffset()

Gets the scroll offset, in pixels.

Returns:int: the offset >= 0

getUIClassID back to summary

getUIClassID	back to summary
public String getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Gets the class ID for a UI. Returns:String the string "TextFieldUI" Annotations @BeanProperty bound:false See Also `JComponent#getUIClassID`, `UIDefaults#getUI`

public String getUIClassID()

Overrides javax.swing.JComponent.getUIClassID.

Gets the class ID for a UI.

Returns:String

the string "TextFieldUI"

Annotations

@BeanProperty
bound:false

hasActionListener	back to summary
pack-priv boolean hasActionListener() Returns true if the receiver has an `ActionListener` installed.

isListener	back to summary
private boolean isListener(Class<?> c, ActionListener a)

isValidateRoot back to summary

isValidateRoot	back to summary
public boolean isValidateRoot() Overrides javax.swing.JComponent.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:boolean if the parent of this textfield is a `JViewPort` return false, otherwise return true Annotations @Override See Also `JComponent#revalidate`, `JComponent#isValidateRoot`, `java.awt.Container#isValidateRoot`

public boolean isValidateRoot()

Overrides javax.swing.JComponent.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:boolean

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

Annotations

@Override

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.text.JTextComponent.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:String a string representation of this `JTextField`

protected String paramString()

Overrides javax.swing.text.JTextComponent.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:String: a string representation of this JTextField

postActionEvent	back to summary
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.

removeActionListener	back to summary
public synchronized void removeActionListener(ActionListener l) Removes the specified action listener so that it no longer receives action events from this textfield. Parameters l:ActionListener the action listener to be removed

removeActionListener

back to summary

public synchronized void removeActionListener(ActionListener l)

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

Parameters

l:ActionListener: the action listener to be removed

scrollRectToVisible	back to summary
public void scrollRectToVisible(Rectangle r) Overrides javax.swing.JComponent.scrollRectToVisible. Scrolls the field left or right. Parameters r:Rectangle the region to scroll

scrollRectToVisible

back to summary

public void scrollRectToVisible(Rectangle r)

Overrides javax.swing.JComponent.scrollRectToVisible.

Scrolls the field left or right.

Parameters

r:Rectangle: the region to scroll

setAction back to summary

setAction	back to summary
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:Action the `Action` for the `JTextField`, or `null` Annotations @BeanProperty visualUpdate:true description:the Action instance connected with this ActionEvent source Since 1.3 See Also `Action`, `getAction`, `configurePropertiesFromAction`, `createActionPropertyChangeListener`, `actionPropertyChanged`

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:Action: the Action for the JTextField, or null

Annotations

@BeanProperty
visualUpdate:true
description:the Action instance connected with this ActionEvent source

Since

1.3

setActionCommand	back to summary
public void setActionCommand(String command) Sets the command string used for action events. Parameters command:String the command string

setActionCommand

back to summary

public void setActionCommand(String command)

Sets the command string used for action events.

Parameters

command:String: the command string

setActionCommandFromAction	back to summary
private void setActionCommandFromAction(Action action)

setColumns back to summary

setColumns	back to summary
public void setColumns(int columns) Sets the number of columns in this `TextField`, and then invalidate the layout. Parameters columns:int the number of columns >= 0 Annotations @BeanProperty bound:false description:the number of columns preferred for display Exceptions IllegalArgumentException: if `columns` is less than 0

public void setColumns(int columns)

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

Parameters

columns:int: the number of columns >= 0

Annotations

@BeanProperty
bound:false
description:the number of columns preferred for display

Exceptions

IllegalArgumentException:: if columns is less than 0

setDocument back to summary

setDocument	back to summary
public void setDocument(Document doc) Overrides javax.swing.text.JTextComponent.setDocument. 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:Document the document to display/edit Annotations @BeanProperty expert:true description:the text document model See Also `getDocument`

public void setDocument(Document doc)

Overrides javax.swing.text.JTextComponent.setDocument.

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:Document: the document to display/edit

Annotations

@BeanProperty
expert:true
description:the text document model

See Also

getDocument

setFont back to summary

setFont	back to summary
public void setFont(Font f) Overrides javax.swing.JComponent.setFont. 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:Font the new font

public void setFont(Font f)

Overrides javax.swing.JComponent.setFont.

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:Font: the new font

setHorizontalAlignment back to summary

setHorizontalAlignment	back to summary
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:int the alignment Annotations @BeanProperty preferred:true enumerationValues:JTextField.LEFT, JTextField.CENTER, JTextField.RIGHT, JTextField.LEADING, JTextField.TRAILING description:Set the field alignment to LEFT, CENTER, RIGHT, LEADING (the default) or TRAILING Exceptions IllegalArgumentException: if `alignment` is not a valid key

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:int: the alignment

Annotations

@BeanProperty
preferred:true
enumerationValues:JTextField.LEFT, JTextField.CENTER, JTextField.RIGHT, JTextField.LEADING, JTextField.TRAILING
description:Set the field alignment to LEFT, CENTER, RIGHT, LEADING (the default) or TRAILING

Exceptions

IllegalArgumentException:: if alignment is not a valid key

setScrollOffset

back to summary

public void setScrollOffset(int scrollOffset)

Sets the scroll offset, in pixels.

Parameters

scrollOffset:int: the offset >= 0

writeObject back to summary

private void writeObject(ObjectOutputStream s) throws IOException

Hides javax.swing.JComponent.writeObject.

See readObject and writeObject in JComponent for more information about serialization in Swing.

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.writeObject.

if an I/O error occurs

public Class JTextField

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JTextField.AccessibleJTextField

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class JTextField.NotifyAction

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class JTextField.ScrollRepainter

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class JTextField.TextFieldActionPropertyChangeListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public void	actionPerformed(ActionEvent e) Implements java.awt.event.ActionListener.actionPerformed. Invoked when an action occurs.
public boolean	isEnabled() Overrides javax.swing.AbstractAction.isEnabled. Implements javax.swing.Action.isEnabled. Returns true if the action is enabled.