public class

TextArea

extends TextComponent

java.lang.Object
↳	java.awt.Component
	↳	java.awt.TextComponent
		↳	java.awt.TextArea

Class Overview

A TextArea object is a multi-line region that displays text. It can be set to allow editing or to be read-only.

The following image shows the appearance of a text area:

A TextArea showing the word 'Hello!'

This text area could be created by the following line of code:

 new TextArea("Hello", 5, 40);

Summary

Nested Classes
class	TextArea.AccessibleAWTTextArea	This class implements accessibility support for the `TextArea` class.

Constants
int	SCROLLBARS_BOTH	Create and display both vertical and horizontal scrollbars.
int	SCROLLBARS_HORIZONTAL_ONLY	Create and display horizontal scrollbar only.
int	SCROLLBARS_NONE	Do not create or display any scrollbars for the text area.
int	SCROLLBARS_VERTICAL_ONLY	Create and display vertical scrollbar only.

[Expand]

Inherited Constants

From class java.awt.Component

From interface java.awt.image.ImageObserver

[Expand]

Inherited Fields

From class java.awt.TextComponent

Public Constructors
	TextArea() Constructs a new text area with the empty string as text.
	TextArea(String text) Constructs a new text area with the specified text.
	TextArea(int rows, int columns) Constructs a new text area with the specified number of rows and columns and the empty string as text.
	TextArea(String text, int rows, int columns) Constructs a new text area with the specified text, and with the specified number of rows and columns.
	TextArea(String text, int rows, int columns, int scrollbars) Constructs a new text area with the specified text, and with the rows, columns, and scroll bar visibility as specified.

Public Methods
void	addNotify() Creates the `TextArea`'s peer.
void	append(String str) Appends the given text to the text area's current text.
synchronized void	appendText(String str) This method is deprecated. As of JDK version 1.1, replaced by `append(String)`.
AccessibleContext	getAccessibleContext() Returns the `AccessibleContext` associated with this `TextArea`.
int	getColumns() Returns the number of columns in this text area.
Dimension	getMinimumSize() Determines the minimum size of this text area.
Dimension	getMinimumSize(int rows, int columns) Determines the minimum size of a text area with the specified number of rows and columns.
Dimension	getPreferredSize(int rows, int columns) Determines the preferred size of a text area with the specified number of rows and columns.
Dimension	getPreferredSize() Determines the preferred size of this text area.
int	getRows() Returns the number of rows in the text area.
int	getScrollbarVisibility() Returns an enumerated value that indicates which scroll bars the text area uses.
void	insert(String str, int pos) Inserts the specified text at the specified position in this text area.
synchronized void	insertText(String str, int pos) This method is deprecated. As of JDK version 1.1, replaced by `insert(String, int)`.
Dimension	minimumSize(int rows, int columns) This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize(int, int)`.
Dimension	minimumSize() This method is deprecated. As of JDK version 1.1, replaced by `getMinimumSize()`.
Dimension	preferredSize(int rows, int columns) This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize(int, int)`.
Dimension	preferredSize() This method is deprecated. As of JDK version 1.1, replaced by `getPreferredSize()`.
void	replaceRange(String str, int start, int end) Replaces text between the indicated start and end positions with the specified replacement text.
synchronized void	replaceText(String str, int start, int end) This method is deprecated. As of JDK version 1.1, replaced by `replaceRange(String, int, int)`.
void	setColumns(int columns) Sets the number of columns for this text area.
void	setRows(int rows) Sets the number of rows for this text area.

Protected Methods
String	paramString() Returns a string representing the state of this `TextArea`.

[Expand]

Inherited Methods

From class java.awt.TextComponent

void	addNotify() Makes this Component displayable by connecting it to a native screen resource.
synchronized void	addTextListener(TextListener l) Adds the specified text event listener to receive text events from this text component.
void	enableInputMethods(boolean enable) Enables or disables input method support for this text component.
AccessibleContext	getAccessibleContext() Gets the AccessibleContext associated with this TextComponent.
Color	getBackground() Gets the background color of this text component.
synchronized int	getCaretPosition() Returns the position of the text insertion caret.
InputMethodRequests	getInputMethodRequests() Gets the input method request handler which supports requests from input methods for this component.
<T extends EventListener> T[]	getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as `FooListener`s upon this `TextComponent`.
synchronized String	getSelectedText() Returns the selected text from the text that is presented by this text component.
synchronized int	getSelectionEnd() Gets the end position of the selected text in this text component.
synchronized int	getSelectionStart() Gets the start position of the selected text in this text component.
synchronized String	getText() Returns the text that is presented by this text component.
synchronized TextListener[]	getTextListeners() Returns an array of all the text listeners registered on this text component.
boolean	isEditable() Indicates whether or not this text component is editable.
String	paramString() Returns a string representing the state of this `TextComponent`.
void	processEvent(AWTEvent e) Processes events on this text component.
void	processTextEvent(TextEvent e) Processes text events occurring on this text component by dispatching them to any registered `TextListener` objects.
void	removeNotify() Removes the `TextComponent`'s peer.
synchronized void	removeTextListener(TextListener l) Removes the specified text event listener so that it no longer receives text events from this text component If `l` is `null`, no exception is thrown and no action is performed.
synchronized void	select(int selectionStart, int selectionEnd) Selects the text between the specified start and end positions.
synchronized void	selectAll() Selects all the text in this text component.
void	setBackground(Color c) Sets the background color of this text component.
synchronized void	setCaretPosition(int position) Sets the position of the text insertion caret.
synchronized void	setEditable(boolean b) Sets the flag that determines whether or not this text component is editable.
synchronized void	setSelectionEnd(int selectionEnd) Sets the selection end for this text component to the specified position.
synchronized void	setSelectionStart(int selectionStart) Sets the selection start for this text component to the specified position.
synchronized void	setText(String t) Sets the text that is presented by this text component to be the specified text.

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

Constants

public static final int SCROLLBARS_BOTH

Create and display both vertical and horizontal scrollbars.

Constant Value: 0 (0x00000000)

public static final int SCROLLBARS_HORIZONTAL_ONLY

Create and display horizontal scrollbar only.

Constant Value: 2 (0x00000002)

public static final int SCROLLBARS_NONE

Do not create or display any scrollbars for the text area.

Constant Value: 3 (0x00000003)

public static final int SCROLLBARS_VERTICAL_ONLY

Create and display vertical scrollbar only.

Constant Value: 1 (0x00000001)

Public Constructors

public TextArea ()

Constructs a new text area with the empty string as text. This text area is created with scrollbar visibility equal to SCROLLBARS_BOTH, so both vertical and horizontal scrollbars will be visible for this text area.

Throws

HeadlessException	if `GraphicsEnvironment.isHeadless` returns true

public TextArea (String text)

Constructs a new text area with the specified text. This text area is created with scrollbar visibility equal to SCROLLBARS_BOTH, so both vertical and horizontal scrollbars will be visible for this text area.

Parameters

text	the text to be displayed; if `text` is `null`, the empty string `""` will be displayed

Throws

HeadlessException	if `GraphicsEnvironment.isHeadless` returns true

public TextArea (int rows, int columns)

Constructs a new text area with the specified number of rows and columns and the empty string as text. A column is an approximate average character width that is platform-dependent. The text area is created with scrollbar visibility equal to SCROLLBARS_BOTH, so both vertical and horizontal scrollbars will be visible for this text area.

Parameters

rows	the number of rows
columns	the number of columns

Throws

HeadlessException	if `GraphicsEnvironment.isHeadless` returns true

public TextArea (String text, int rows, int columns)

Constructs a new text area with the specified text, and with the specified number of rows and columns. A column is an approximate average character width that is platform-dependent. The text area is created with scrollbar visibility equal to SCROLLBARS_BOTH, so both vertical and horizontal scrollbars will be visible for this text area.

Parameters

text	the text to be displayed; if `text` is `null`, the empty string `""` will be displayed
rows	the number of rows
columns	the number of columns

Throws

HeadlessException	if `GraphicsEnvironment.isHeadless` returns true

public TextArea (String text, int rows, int columns, int scrollbars)

Constructs a new text area with the specified text, and with the rows, columns, and scroll bar visibility as specified. All TextArea constructors defer to this one.

The TextArea class defines several constants that can be supplied as values for the scrollbars argument:

SCROLLBARS_BOTH,
SCROLLBARS_VERTICAL_ONLY,
SCROLLBARS_HORIZONTAL_ONLY,
SCROLLBARS_NONE.

Any other value for the scrollbars argument is invalid and will result in this text area being created with scrollbar visibility equal to the default value of SCROLLBARS_BOTH.

Parameters

text	the text to be displayed; if `text` is `null`, the empty string `""` will be displayed
rows	the number of rows; if `rows` is less than `0`, `rows` is set to `0`
columns	the number of columns; if `columns` is less than `0`, `columns` is set to `0`
scrollbars	a constant that determines what scrollbars are created to view the text area

Throws

HeadlessException	if `GraphicsEnvironment.isHeadless` returns true

Public Methods

public void addNotify ()

Creates the TextArea's peer. The peer allows us to modify the appearance of the TextArea without changing any of its functionality.

public void append (String str)

Appends the given text to the text area's current text.

Note that passing null or inconsistent parameters is invalid and will result in unspecified behavior.

Parameters

str	the non-`null` text to append

public synchronized void appendText (String str)

This method is deprecated.
As of JDK version 1.1, replaced by append(String).

public AccessibleContext getAccessibleContext ()

Returns the AccessibleContext associated with this TextArea. For text areas, the AccessibleContext takes the form of an AccessibleAWTTextArea. A new AccessibleAWTTextArea instance is created if necessary.

Returns

an AccessibleAWTTextArea that serves as the AccessibleContext of this TextArea

public int getColumns ()

Returns the number of columns in this text area.

Returns

the number of columns in the text area

public Dimension getMinimumSize ()

Determines the minimum size of this text area.

Returns

the preferred dimensions needed for this text area

public Dimension getMinimumSize (int rows, int columns)

Determines the minimum size of a text area with the specified number of rows and columns.

Parameters

rows	the number of rows
columns	the number of columns

Returns

the minimum dimensions required to display the text area with the specified number of rows and columns

public Dimension getPreferredSize (int rows, int columns)

Determines the preferred size of a text area with the specified number of rows and columns.

Parameters

rows	the number of rows
columns	the number of columns

Returns

the preferred dimensions required to display the text area with the specified number of rows and columns

public Dimension getPreferredSize ()

Determines the preferred size of this text area.

Returns

the preferred dimensions needed for this text area

public int getRows ()

Returns the number of rows in the text area.

Returns

the number of rows in the text area

public int getScrollbarVisibility ()

Returns an enumerated value that indicates which scroll bars the text area uses.

The TextArea class defines four integer constants that are used to specify which scroll bars are available. TextArea has one constructor that gives the application discretion over scroll bars.

Returns

an integer that indicates which scroll bars are used

public void insert (String str, int pos)

Inserts the specified text at the specified position in this text area.

Note that passing null or inconsistent parameters is invalid and will result in unspecified behavior.

Parameters

str	the non-`null` text to insert
pos	the position at which to insert

public synchronized void insertText (String str, int pos)

This method is deprecated.
As of JDK version 1.1, replaced by insert(String, int).

public Dimension minimumSize (int rows, int columns)

This method is deprecated.
As of JDK version 1.1, replaced by getMinimumSize(int, int).

public Dimension minimumSize ()

This method is deprecated.
As of JDK version 1.1, replaced by getMinimumSize().

public Dimension preferredSize (int rows, int columns)

This method is deprecated.
As of JDK version 1.1, replaced by getPreferredSize(int, int).

public Dimension preferredSize ()

This method is deprecated.
As of JDK version 1.1, replaced by getPreferredSize().

public void replaceRange (String str, int start, int end)

Replaces text between the indicated start and end positions with the specified replacement text. The text at the end position will not be replaced. The text at the start position will be replaced (unless the start position is the same as the end position). The text position is zero-based. The inserted substring may be of a different length than the text it replaces.

Note that passing null or inconsistent parameters is invalid and will result in unspecified behavior.

Parameters

str	the non-`null` text to use as the replacement
start	the start position
end	the end position

public synchronized void replaceText (String str, int start, int end)

This method is deprecated.
As of JDK version 1.1, replaced by replaceRange(String, int, int).

public void setColumns (int columns)

Sets the number of columns for this text area.

Parameters

columns	the number of columns

Throws

IllegalArgumentException	if the value supplied for `columns` is less than `0`

public void setRows (int rows)

Sets the number of rows for this text area.

Parameters

rows	the number of rows

Throws

IllegalArgumentException	if the value supplied for `rows` is less than `0`

Protected Methods

protected String paramString ()

Returns a string representing the state of this TextArea. 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

the parameter string of this text area

Interfaces

Classes

Enums

Exceptions

Errors

TextArea

Class Overview

Summary

Constants

public static final int SCROLLBARS_BOTH

public static final int SCROLLBARS_HORIZONTAL_ONLY

public static final int SCROLLBARS_NONE

public static final int SCROLLBARS_VERTICAL_ONLY

Public Constructors

public TextArea ()

Throws

See Also

public TextArea (String text)

Parameters

Throws

See Also

public TextArea (int rows, int columns)

Parameters

Throws

See Also

public TextArea (String text, int rows, int columns)

Parameters

Throws

See Also

public TextArea (String text, int rows, int columns, int scrollbars)

Parameters

Throws

See Also

Public Methods

public void addNotify ()

public void append (String str)

Parameters

See Also

public synchronized void appendText (String str)

public AccessibleContext getAccessibleContext ()

Returns

public int getColumns ()

Returns

See Also

public Dimension getMinimumSize ()

Returns

See Also

public Dimension getMinimumSize (int rows, int columns)

Parameters

Returns

See Also

public Dimension getPreferredSize (int rows, int columns)

Parameters

Returns

See Also

public Dimension getPreferredSize ()

Returns

See Also

public int getRows ()

Returns

See Also

public int getScrollbarVisibility ()

Returns

See Also

public void insert (String str, int pos)

Parameters

See Also

public synchronized void insertText (String str, int pos)

public Dimension minimumSize (int rows, int columns)

public Dimension minimumSize ()

public Dimension preferredSize (int rows, int columns)

public Dimension preferredSize ()

public void replaceRange (String str, int start, int end)

Parameters

See Also

public synchronized void replaceText (String str, int start, int end)

public void setColumns (int columns)

Parameters

Throws

See Also