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, HasName, 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 { primary style }
• .gwt-TextArea-readonly { dependent style set when the text area is read-only }

Example

public class TextBoxExample implements EntryPoint {

  public void onModuleLoad() {
    // Make some text boxes.  The password text box is identical to the text
    // box, except that the input is visually masked by the browser.
    PasswordTextBox ptb = new PasswordTextBox();
    TextBox tb = new TextBox();

    // Let's disallow non-numeric entry in the normal text box.
    tb.addKeyboardListener(new KeyboardListenerAdapter() {
      public void onKeyPress(Widget sender, char keyCode, int modifiers) {
        if ((!Character.isDigit(keyCode)) && (keyCode != (char) KEY_TAB)
            && (keyCode != (char) KEY_BACKSPACE)
            && (keyCode != (char) KEY_DELETE) && (keyCode != (char) KEY_ENTER) 
            && (keyCode != (char) KEY_HOME) && (keyCode != (char) KEY_END)
            && (keyCode != (char) KEY_LEFT) && (keyCode != (char) KEY_UP)
            && (keyCode != (char) KEY_RIGHT) && (keyCode != (char) KEY_DOWN)) {
          // TextBox.cancelKey() suppresses the current keyboard event.
          ((TextBox)sender).cancelKey();
        }
      }
    });

    // Let's make an 80x50 text area to go along with the other two.
    TextArea ta = new TextArea();
    ta.setCharacterWidth(80);
    ta.setVisibleLines(50);

    // Add them to the root panel.
    VerticalPanel panel = new VerticalPanel();
    panel.add(tb);
    panel.add(ptb);
    panel.add(ta);
    RootPanel.get().add(panel);
  }
}

Nested Class Summary

Nested classes/interfaces 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

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	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, getName, getSelectedText, getText, isReadOnly, onBrowserEvent, removeChangeListener, removeClickListener, removeKeyboardListener, selectAll, setCursorPos, setKey, setName, setReadOnly, setSelectionRange, setText, setTextAlignment

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

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

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

doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onDetach, onLoad, onUnload, removeFromParent

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

addStyleDependentName, addStyleName, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

setVisibleLines

public void setVisibleLines(int lines)

Sets the number of text lines that are visible.

Parameters:

lines - the number of visible lines