Class TextArea

  • All Implemented Interfaces:
    com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasChangeHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.client.AutoDirectionHandler.Target, com.google.gwt.i18n.client.HasDirection, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<String>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<String>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, HasAutocomplete, HasAutofocus, HasDataList, HasFormNoValidate, HasPlaceholder, HasRequired, HasValidationMessageElement<String,​ValueBoxEditor<String>>, HasValidationPattern, HasValidity, org.gwtproject.editor.client.Editor<String>, org.gwtproject.editor.client.HasEditorErrors<String>, org.gwtproject.editor.client.IsEditor<ValueBoxEditor<String>>, org.gwtproject.editor.client.TakesValue<String>

    public class TextArea
    extends TextBoxBase
    A text box that allows multiple lines of text to be entered.

    <img class='gallery' src='doc-files/TextArea.png'/>

    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 ValueBoxBase.setDirectionEstimator(boolean), and is available by default when at least one of the application's locales is right-to-left.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

        com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
      • Nested classes/interfaces inherited from interface org.gwtproject.editor.client.Editor

        org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path
      • Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection

        com.google.gwt.i18n.client.HasDirection.Direction
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        TextArea()
      Creates an empty text area.
      protected TextArea​(com.google.gwt.dom.client.Element element)
      This constructor may be used by subclasses to explicitly use an existing element.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean checkValidity()
      Returns false if the element is a candidate for constraint validation, and it does not satisfy its constraints.
      String getAutocomplete()
      get autocomplete attribute value.
      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()  
      elemental2.dom.HTMLInputElement getInputElement()  
      int getMaxLength()
      Gets the maximum allowable length of the text box.
      String getPattern()
      get validation pattern.
      String getPlaceholder()
      get place holder text.
      int getSelectionLength()  
      String getValidationMessage()
      A localized message that describes the validation constraints that the control does not satisfy (if any).
      elemental2.dom.ValidityState getValidity()
      The validity states that this element is in.
      int getVisibleLines()
      Gets the number of text lines that are visible.
      boolean isAutofocus()
      get autofocus value.
      boolean isFormNoValidate()
      check if validation of the widget is enabled (doesn't affect bean validation).
      boolean isRequired()
      Reflects the required HTML attribute, indicating that the user must fill in a value before submitting a form.
      void setAutocomplete​(String arg)
      set autocomplete attribute value.
      void setAutofocus​(boolean arg)
      set autofocus value.
      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 setCustomValidity​(String message)
      set custom validity if supported.
      void setFormNoValidate​(boolean arg)
      enable/disable validation of the widget (doesn't affect bean validation).
      void setMaxLength​(int length)
      Sets the maximum allowable length of the text box.
      void setPattern​(String arg)
      set validation pattern.
      void setPlaceholder​(String arg)
      set place holder text.
      void setRequired​(boolean arg)
      Reflects the required HTML attribute, indicating that the user must fill in a value before submitting a form.
      void setVisibleLines​(int lines)
      Sets the number of text lines that are visible.
      static TextArea wrap​(com.google.gwt.dom.client.Element element)
      Creates a TextArea widget that wraps an existing <textarea> element.
      • Methods inherited from class com.google.gwt.user.client.ui.FocusWidget

        addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, getTabIndex, isEnabled, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setEnabled, setFocus, setTabIndex
      • Methods inherited from class com.google.gwt.user.client.ui.Widget

        addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onDetach, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
      • Methods inherited from class com.google.gwt.user.client.ui.UIObject

        addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
      • Methods inherited from interface com.google.gwt.event.shared.HasHandlers

        fireEvent
      • Methods inherited from interface com.google.gwt.event.dom.client.HasKeyUpHandlers

        addKeyUpHandler
      • Methods inherited from interface org.gwtproject.editor.client.IsEditor

        asEditor