public class

TextArea

extends TextBoxBase

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.FocusWidget
			↳	com.google.gwt.user.client.ui.ValueBoxBase<T>
				↳	com.google.gwt.user.client.ui.TextBoxBase
					↳	com.google.gwt.user.client.ui.TextArea

Class Overview

A text box that allows multiple lines of text to be entered.

CSS Style Rules

.gwt-TextArea { primary style }
.gwt-TextArea-readonly { dependent style set when the text area is read-only }

Built-in Bidi Text Support

This widget is capable of automatically adjusting its direction according to the input text. This feature is controlled by setDirectionEstimator(boolean), and is available by default when at least one of the application's locales is right-to-left.

Example

{@example com.google.gwt.examples.TextBoxExample}

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

[Expand]

Inherited Fields

From class com.google.gwt.user.client.ui.TextBoxBase

Public Constructors
	TextArea() Creates an empty text area.

Protected Constructors
	TextArea(Element element) This constructor may be used by subclasses to explicitly use an existing element.

Public Methods
int	getCharacterWidth() Gets the requested width of the text box (this is not an exact value, as not all characters are created equal).
int	getCursorPos() Gets the current position of the cursor (this also serves as the beginning of the text selection).
int	getSelectionLength() Gets the length of the current text selection.
int	getVisibleLines() Gets the number of text lines that are visible.
void	setCharacterWidth(int width) Sets the requested width of the text box (this is not an exact value, as not all characters are created equal).
void	setVisibleLines(int lines) Sets the number of text lines that are visible.
static TextArea	wrap(Element element) Creates a TextArea widget that wraps an existing <textarea> element.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.TextBoxBase

From class com.google.gwt.user.client.ui.ValueBoxBase

From class com.google.gwt.user.client.ui.FocusWidget

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.editor.client.IsEditor

From interface com.google.gwt.event.dom.client.HasBlurHandlers

From interface com.google.gwt.event.dom.client.HasChangeHandlers

From interface com.google.gwt.event.dom.client.HasClickHandlers

From interface com.google.gwt.event.dom.client.HasDoubleClickHandlers

From interface com.google.gwt.event.dom.client.HasFocusHandlers

From interface com.google.gwt.event.dom.client.HasGestureChangeHandlers

From interface com.google.gwt.event.dom.client.HasGestureEndHandlers

From interface com.google.gwt.event.dom.client.HasGestureStartHandlers

From interface com.google.gwt.event.dom.client.HasKeyDownHandlers

From interface com.google.gwt.event.dom.client.HasKeyPressHandlers

From interface com.google.gwt.event.dom.client.HasKeyUpHandlers

From interface com.google.gwt.event.dom.client.HasMouseDownHandlers

From interface com.google.gwt.event.dom.client.HasMouseMoveHandlers

From interface com.google.gwt.event.dom.client.HasMouseOutHandlers

From interface com.google.gwt.event.dom.client.HasMouseOverHandlers

From interface com.google.gwt.event.dom.client.HasMouseUpHandlers

From interface com.google.gwt.event.dom.client.HasMouseWheelHandlers

From interface com.google.gwt.event.dom.client.HasTouchCancelHandlers

From interface com.google.gwt.event.dom.client.HasTouchEndHandlers

From interface com.google.gwt.event.dom.client.HasTouchMoveHandlers

From interface com.google.gwt.event.dom.client.HasTouchStartHandlers

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.logical.shared.HasValueChangeHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.i18n.client.HasDirection

From interface com.google.gwt.i18n.shared.HasDirectionEstimator

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.TakesValue

From interface com.google.gwt.user.client.ui.Focusable

From interface com.google.gwt.user.client.ui.HasEnabled

From interface com.google.gwt.user.client.ui.HasName

From interface com.google.gwt.user.client.ui.HasText

From interface com.google.gwt.user.client.ui.HasValue

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.user.client.ui.SourcesChangeEvents

From interface com.google.gwt.user.client.ui.SourcesClickEvents

From interface com.google.gwt.user.client.ui.SourcesFocusEvents

From interface com.google.gwt.user.client.ui.SourcesKeyboardEvents

From interface com.google.gwt.user.client.ui.SourcesMouseEvents

Public Constructors

public TextArea ()

Creates an empty text area.

Protected Constructors

protected TextArea (Element element)

This constructor may be used by subclasses to explicitly use an existing element. This element must be a <textarea> element.

Parameters

element	the element to be used

Public Methods

public int getCharacterWidth ()

Gets the requested width of the text box (this is not an exact value, as not all characters are created equal).

Returns

the requested width, in characters

public int getCursorPos ()

Gets the current position of the cursor (this also serves as the beginning of the text selection).

Returns

the cursor's position

public int getSelectionLength ()

Gets the length of the current text selection.

Returns

the text selection length

public int getVisibleLines ()

Gets the number of text lines that are visible.

Returns

the number of visible lines

public void setCharacterWidth (int width)

Sets the requested width of the text box (this is not an exact value, as not all characters are created equal).

Parameters

width	the requested width, in characters

public void setVisibleLines (int lines)

Sets the number of text lines that are visible.

Parameters

lines	the number of visible lines

public static TextArea wrap (Element element)

Creates a TextArea widget that wraps an existing <textarea> element. This element must already be attached to the document. If the element is removed from the document, you must call detachNow(Widget).

Parameters

element	the element to be wrapped

Interfaces

Classes

Annotations

Enums

Exceptions

TextArea

Class Overview

CSS Style Rules

Built-in Bidi Text Support

Example

Summary

Public Constructors

public TextArea ()

Protected Constructors

protected TextArea (Element element)

Parameters

Public Methods

public int getCharacterWidth ()

Returns

public int getCursorPos ()

Returns

public int getSelectionLength ()

Returns

public int getVisibleLines ()

Returns

public void setCharacterWidth (int width)

Parameters

public void setVisibleLines (int lines)

Parameters

public static TextArea wrap (Element element)

Parameters