Module org.htmlunit
Package org.htmlunit.html

Class HtmlTextArea

java.lang.Object
org.htmlunit.html.DomNode
org.htmlunit.html.DomNamespaceNode
org.htmlunit.html.DomElement
org.htmlunit.html.HtmlElement
org.htmlunit.html.HtmlTextArea
All Implemented Interfaces:
Serializable, Cloneable, DisabledElement, SelectableTextInput, LabelableElement, SubmittableElement, ValidatableHtmlElement, Element, Node
public class HtmlTextArea extends HtmlElement implements DisabledElement, SubmittableElement, LabelableElement, SelectableTextInput, ValidatableHtmlElement
Wrapper for the HTML element "textarea".
Author:
Mike Bowler, Barnaby Court, David K. Taylor, Christian Sell, David D. Kilzer, Marc Guillemot, Daniel Gredler, Ahmed Ashour, Sudhan Moghe, Amit Khanna, Ronald Brill, Frank Danek, Lai Quang Duong
See Also:

  • Field Details

  • Method Details

    • handles

      public boolean handles(Event event)
      Indicates if the provided event can be applied to this node. Overwrite this.
      Overrides:
      handles in class HtmlElement
      Parameters:
      event - the event
      Returns:
      false if the event can't be applied

    • getText

      public final String getText()
      Returns the value that would be displayed in the text area. This is the element's "raw value" (spec term). While the dirty value flag is false, this is always computed fresh from the current child text content -- deliberately NOT cached and re-synced via mutation hooks, since that approach cannot reliably catch every way the children can change (e.g. a child DomText's data being reassigned directly bypasses any hook on this element). Once the dirty flag becomes true (via setText(String) or typing), the value is held in rawValue_ and is fully decoupled from the children until reset() clears the flag again.
      Specified by:
      getText in interface SelectableTextInput
      Returns:
      the text

    • setText

      public final void setText(String newValue)
      Sets the new value of this text area. Per spec, this sets the raw value directly and marks the dirty flag -- it must NOT touch the DOM child nodes at all, and no subsequent child mutation may affect this value again until reset().

      Note that this acts like 'pasting' the text, but to simulate characters entry you should use HtmlElement.type(String).

      Specified by:
      setText in interface SelectableTextInput
      Parameters:
      newValue - the new value

    • getSubmitNameValuePairs

      public NameValuePair[] getSubmitNameValuePairs()

      Returns an array of NameValuePairs that are the values that will be sent back to the server whenever this element's containing form is submitted.

      THIS METHOD IS INTENDED FOR THE USE OF THE FRAMEWORK ONLY AND SHOULD NOT BE USED BY CONSUMERS OF HTMLUNIT. USE AT YOUR OWN RISK.

      Specified by:
      getSubmitNameValuePairs in interface SubmittableElement
      Returns:
      the values that will be sent back to the server whenever this element's containing form is submitted

    • reset

      public void reset()
      Returns the value of this element to the default value or checked state (usually what it was at the time the page was loaded, unless it has been modified via JavaScript). Per the spec's reset algorithm for textarea elements: clears the dirty value flag. Once clear, getText() automatically recomputes from the CURRENT child text content (not the page's originally-parsed text, and not defaultValue_ -- those can differ from the live children if the children were mutated while the dirty flag was true). Deliberately does not call setText(String) / fire the onchange handler: a form reset fires a reset event, not a change event.
      Specified by:
      reset in interface SubmittableElement
      See Also:

    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      Sets the default value to use when this element gets reset, if applicable. Per spec, defaultValue is specified in terms of the element's child text content -- setting it mutates the children (here, via the same node-replacement helper the old setTextInternal() used). Since getText() recomputes directly from the current children whenever the dirty flag is false, value is automatically updated as a side effect ONLY while still clean -- exactly matching observed real-browser behavior (replacing the old, less precise "if value still equals old default value" equality check).
      Specified by:
      setDefaultValue in interface SubmittableElement
      Parameters:
      defaultValue - the default value to use when this element gets reset, if applicable
      See Also:

    • getDefaultValue

      public String getDefaultValue()
      Returns the default value to use when this element gets reset, if applicable.
      Specified by:
      getDefaultValue in interface SubmittableElement
      Returns:
      the default value to use when this element gets reset, if applicable
      See Also:

    • setDefaultChecked

      public void setDefaultChecked(boolean defaultChecked)
      Sets the default checked state to use when this element gets reset, if applicable. The default implementation is empty; only checkboxes and radio buttons really care what the default checked value is. This implementation is empty; only check boxes and radio buttons really care what the default checked value is.
      Specified by:
      setDefaultChecked in interface SubmittableElement
      Parameters:
      defaultChecked - the default checked state to use when this element gets reset, if applicable
      See Also:

    • isDefaultChecked

      public boolean isDefaultChecked()
      Returns the default checked state to use when this element gets reset, if applicable. This implementation returns false; only checkboxes and radio buttons really care what the default checked value is.
      Specified by:
      isDefaultChecked in interface SubmittableElement
      Returns:
      the default checked state to use when this element gets reset, if applicable
      See Also:

    • getNameAttribute

      public final String getNameAttribute()
      Returns the value of the attribute name. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute name or an empty string if that attribute isn't defined

    • getRowsAttribute

      public final String getRowsAttribute()
      Returns the value of the attribute rows. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute rows or an empty string if that attribute isn't defined

    • getColumnsAttribute

      public final String getColumnsAttribute()
      Returns the value of the attribute cols. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute cols or an empty string if that attribute isn't defined

    • getDisabledAttribute

      public final String getDisabledAttribute()
      Returns the value of the attribute disabled. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Specified by:
      getDisabledAttribute in interface DisabledElement
      Returns:
      the value of the attribute disabled or an empty string if that attribute isn't defined

    • getReadOnlyAttribute

      public final String getReadOnlyAttribute()
      Returns the value of the attribute readonly. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute readonly or an empty string if that attribute isn't defined

    • getTabIndexAttribute

      public final String getTabIndexAttribute()
      Returns the value of the attribute tabindex. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute tabindex or an empty string if that attribute isn't defined

    • getAccessKeyAttribute

      public final String getAccessKeyAttribute()
      Returns the value of the attribute accesskey. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute accesskey or an empty string if that attribute isn't defined

    • getOnFocusAttribute

      public final String getOnFocusAttribute()
      Returns the value of the attribute onfocus. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute onfocus or an empty string if that attribute isn't defined

    • getOnBlurAttribute

      public final String getOnBlurAttribute()
      Returns the value of the attribute onblur. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute onblur or an empty string if that attribute isn't defined

    • getOnSelectAttribute

      public final String getOnSelectAttribute()
      Returns the value of the attribute onselect. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute onselect or an empty string if that attribute isn't defined

    • getOnChangeAttribute

      public final String getOnChangeAttribute()
      Returns the value of the attribute onchange. Refer to the HTML 4.01 documentation for details on the use of this attribute.
      Returns:
      the value of the attribute onchange or an empty string if that attribute isn't defined

    • select

      public void select()
      Focuses this element and selects all of its text.
      Specified by:
      select in interface SelectableTextInput

    • getSelectedText

      public String getSelectedText()
      Returns the selected text in this element, or null if there is no selected text in this element.
      Specified by:
      getSelectedText in interface SelectableTextInput
      Returns:
      the selected text in this element, or null if there is no selected text in this element

    • getSelectionStart

      public int getSelectionStart()
      Returns the start position of the selected text in this element.
      Specified by:
      getSelectionStart in interface SelectableTextInput
      Returns:
      the start position of the selected text in this element

    • setSelectionStart

      public void setSelectionStart(int selectionStart)
      Sets the start position of the selected text in this element.
      Specified by:
      setSelectionStart in interface SelectableTextInput
      Parameters:
      selectionStart - the start position of the selected text in this element

    • getSelectionEnd

      public int getSelectionEnd()
      Returns the end position of the selected text in this element.
      Specified by:
      getSelectionEnd in interface SelectableTextInput
      Returns:
      the end position of the selected text in this element

    • setSelectionEnd

      public void setSelectionEnd(int selectionEnd)
      Sets the end position of the selected text in this element.
      Specified by:
      setSelectionEnd in interface SelectableTextInput
      Parameters:
      selectionEnd - the end position of the selected text in this element

    • printXml

      protected boolean printXml(String indent, boolean indentBefore, PrintWriter printWriter)
      Recursively writes the XML data for the node tree starting at node.
      Overrides:
      printXml in class DomElement
      Parameters:
      indent - white space to indent child nodes
      indentBefore - if true start a new line before outputting
      printWriter - writer where child nodes are written
      Returns:
      true if the last thing printed was a tag

    • doType

      protected void doType(char c, boolean lastType)
      Performs the effective type action, called after the keyPress event and before the keyUp event.
      Overrides:
      doType in class HtmlElement
      Parameters:
      c - the character you with to simulate typing
      lastType - is this the last character to type

    • doType

      protected void doType(int keyCode, boolean lastType)
      Performs the effective type action, called after the keyPress event and before the keyUp event.

      An example of predefined values is KeyboardEvent.DOM_VK_PAGE_DOWN.

      Overrides:
      doType in class HtmlElement
      Parameters:
      keyCode - the key code wish to simulate typing
      lastType - is this the last to type

    • typeDone

      protected void typeDone(String newValue, boolean notifyAttributeChangeListeners)
      Called from DoTypeProcessor.
      Overrides:
      typeDone in class HtmlElement
      Parameters:
      newValue - the new value
      notifyAttributeChangeListeners - to notify the associated HtmlAttributeChangeListeners

    • acceptChar

      protected boolean acceptChar(char c)
      Indicates if the provided character can be "typed" in the element.
      Overrides:
      acceptChar in class HtmlElement
      Parameters:
      c - the character
      Returns:
      true if it is accepted

    • focus

      public void focus()
      Sets the focus on this element.
      Specified by:
      focus in interface SelectableTextInput
      Overrides:
      focus in class DomElement

    • removeFocus

      public void removeFocus()
      INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
      Gets notified that it has lost the focus.
      Overrides:
      removeFocus in class DomElement

    • setReadOnly

      public void setReadOnly(boolean isReadOnly)
      Sets the readOnly attribute.
      Parameters:
      isReadOnly - true if this element is read only

    • isReadOnly

      public boolean isReadOnly()
      Returns true if this element is read only.
      Returns:
      true if this element is read only

    • isEmptyXmlTagExpanded

      protected boolean isEmptyXmlTagExpanded()
      Indicates if a node without children should be written in expanded form as XML (i.e. with closing tag rather than with "/>")
      Overrides:
      isEmptyXmlTagExpanded in class DomElement
      Returns:
      true to make generated XML readable as HTML

    • getDefaultStyleDisplay

      public HtmlElement.DisplayStyle getDefaultStyleDisplay()
      INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
      Returns the default display style.
      Overrides:
      getDefaultStyleDisplay in class HtmlElement
      Returns:
      the default display style

    • getPlaceholder

      public String getPlaceholder()
      Returns the value of the placeholder attribute.
      Returns:
      the value of the placeholder attribute

    • setPlaceholder

      public void setPlaceholder(String placeholder)
      Sets the placeholder attribute.
      Parameters:
      placeholder - the placeholder attribute

    • isRequiredSupported

      protected boolean isRequiredSupported()
      Returns whether this element supports the required constraint.
      Overrides:
      isRequiredSupported in class HtmlElement
      Returns:
      whether this element supports the required constraint

    • cloneNode

      public DomNode cloneNode(boolean deep)
      Specified by:
      cloneNode in interface Node
      Overrides:
      cloneNode in class HtmlElement

    • willValidate

      public boolean willValidate()
      Returns whether the element is a candidate for constraint validation.
      Specified by:
      willValidate in interface ValidatableHtmlElement
      Returns:
      whether the element is a candidate for constraint validation

    • getCustomValidity

      public String getCustomValidity()
      Returns the raw custom validity message set via ValidatableHtmlElement.setCustomValidity(String), or the empty string if none has been set.
      Specified by:
      getCustomValidity in interface ValidatableHtmlElement
      Returns:
      the custom validity message

    • setCustomValidity

      public void setCustomValidity(String message)
      Sets the custom validity message for the element.
      Specified by:
      setCustomValidity in interface ValidatableHtmlElement
      Parameters:
      message - the new message

    • isValid

      public boolean isValid()
      Returns whether this element satisfies all form validation constraints set.
      Overrides:
      isValid in class HtmlElement
      Returns:
      whether this element satisfies all form validation constraints set

    • isCustomErrorValidityState

      public boolean isCustomErrorValidityState()
      Returns whether the element has a custom validity message.
      Specified by:
      isCustomErrorValidityState in interface ValidatableHtmlElement
      Returns:
      true if the element's custom validity message has been set to a non-empty string by calling ValidatableHtmlElement.setCustomValidity(String)

    • isValidValidityState

      public boolean isValidValidityState()
      Description copied from interface: ValidatableHtmlElement
      Returns whether the element satisfies all validation constraints.
      Specified by:
      isValidValidityState in interface ValidatableHtmlElement
      Returns:
      true if the element is valid; if true, the element matches the :valid CSS pseudo-class, otherwise the :invalid CSS pseudo-class

    • isValueMissingValidityState

      public boolean isValueMissingValidityState()
      Returns whether the element is missing a required value.
      Specified by:
      isValueMissingValidityState in interface ValidatableHtmlElement
      Returns:
      true if the element has a required attribute but no value; if true, the element matches the :invalid CSS pseudo-class