com.google.gwt.user.client.ui
Class TextArea

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.TextBoxBase
                  com.google.gwt.user.client.ui.TextArea

All Implemented Interfaces:

EventListener, HasFocus, HasText, SourcesChangeEvents, SourcesClickEvents, SourcesFocusEvents, SourcesKeyboardEvents

public class TextArea

extends TextBoxBase

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

CSS Style Rules

• .gwt-TextArea { }

Example

code

Nested Class Summary

Nested classes inherited from class com.google.gwt.user.client.ui.TextBoxBase

TextBoxBase.TextAlignConstant

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.TextBoxBase

ALIGN_CENTER, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_RIGHT

Fields inherited from class java.lang.Object

typeId, typeName

Constructor Summary

TextArea()
Creates an empty text area.

Method Summary

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	setSelectionRange(int pos, int length) Sets the range of text to be selected.
void	setVisibleLines(int lines) Sets the number of text lines that are visible.

Methods inherited from class com.google.gwt.user.client.ui.TextBoxBase

addChangeListener, addClickListener, addKeyboardListener, cancelKey, getImpl, getSelectedText, getText, onBrowserEvent, removeChangeListener, removeClickListener, removeKeyboardListener, selectAll, setCursorPos, setKey, setText, setTextAlignment

Methods inherited from class com.google.gwt.user.client.ui.FocusWidget

addFocusListener, getTabIndex, isEnabled, removeFocusListener, setAccessKey, setEnabled, setFocus, setTabIndex

Methods inherited from class com.google.gwt.user.client.ui.Widget

getParent, isAttached, onAttach, onDetach, onLoad

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleName, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, isVisible, isVisible, removeStyleName, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, finalize, hashCode

Constructor Detail

TextArea

public TextArea()

Creates an empty text area.

Method Detail

getCharacterWidth

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

getCursorPos

public int getCursorPos()

Description copied from class: TextBoxBase

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

Overrides:

getCursorPos in class TextBoxBase

Returns:

the cursor's position

getSelectionLength

public int getSelectionLength()

Description copied from class: TextBoxBase

Gets the length of the current text selection.

Overrides:

getSelectionLength in class TextBoxBase

Returns:

the text selection length

getVisibleLines

public int getVisibleLines()

Gets the number of text lines that are visible.

Returns:

the number of visible lines

setCharacterWidth

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

setSelectionRange

public void setSelectionRange(int pos,
                              int length)

Description copied from class: TextBoxBase

Sets the range of text to be selected.

Overrides:

setSelectionRange in class TextBoxBase

Parameters:

pos - the position of the first character to be selected

length - the number of characters to be selected

setVisibleLines

public void setVisibleLines(int lines)

Sets the number of text lines that are visible.

Parameters:

lines - the number of visible lines