Package org.htmlunit.html

Class HtmlTextArea

    • Field Detail

      • TAG_NAME

        public static final java.lang.String TAG_NAME
        The HTML tag represented by this element.
        See Also:
        Constant Field Values

    • Method Detail

      • handles

        public boolean handles​(org.htmlunit.javascript.host.event.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 java.lang.String getText()
        Returns the value that would be displayed in the text area.
        Specified by:
        getText in interface org.htmlunit.html.impl.SelectableTextInput
        Returns:
        the text

      • setText

        public final void setText​(java.lang.String newValue)
        Sets the new value of this text area.

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

        Specified by:
        setText in interface org.htmlunit.html.impl.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).
        Specified by:
        reset in interface SubmittableElement
        See Also:
        SubmittableElement.reset()

      • getNameAttribute

        public final java.lang.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 java.lang.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 java.lang.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

      • isDisabled

        public final boolean isDisabled()
        Returns true if the disabled attribute is set for this element.
        Specified by:
        isDisabled in interface DisabledElement
        Returns:
        true if the disabled attribute is set for this element

      • getDisabledAttribute

        public final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 org.htmlunit.html.impl.SelectableTextInput

      • getSelectedText

        public java.lang.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 org.htmlunit.html.impl.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 org.htmlunit.html.impl.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 org.htmlunit.html.impl.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 org.htmlunit.html.impl.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 org.htmlunit.html.impl.SelectableTextInput
        Parameters:
        selectionEnd - the end position of the selected text in this element

      • printXml

        protected void printXml​(java.lang.String indent,
                        java.io.PrintWriter printWriter)
        Recursively write the XML data for the node tree starting at node.
        Overrides:
        printXml in class DomElement
        Parameters:
        indent - white space to indent child nodes
        printWriter - writer where child nodes are written

      • 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​(java.lang.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 by "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 org.htmlunit.html.impl.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

      • setAttributeNS

        protected void setAttributeNS​(java.lang.String namespaceURI,
                              java.lang.String qualifiedName,
                              java.lang.String attributeValue,
                              boolean notifyAttributeChangeListeners,
                              boolean notifyMutationObservers)
        Sets the value of the attribute specified by namespace and qualified name.
        Overrides:
        setAttributeNS in class HtmlElement
        Parameters:
        namespaceURI - the URI that identifies an XML namespace
        qualifiedName - the qualified name (prefix:local) of the attribute
        attributeValue - the value of the attribute
        notifyAttributeChangeListeners - to notify the associated HtmlAttributeChangeListeners
        notifyMutationObservers - to notify MutationObservers or not

      • getOriginalName

        public java.lang.String getOriginalName()
        Gets the first value of the name attribute of this field before any change.
        Specified by:
        getOriginalName in interface FormFieldWithNameHistory
        Returns:
        the original name (which is the same as the current one when no change has been made)

      • getNewNames

        public java.util.Collection<java.lang.String> getNewNames()
        Get all the names this field got after the original one.
        Specified by:
        getNewNames in interface FormFieldWithNameHistory
        Returns:
        an empty collection if the name attribute has never been changed.

      • 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

      • getPlaceholder

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

      • setPlaceholder

        public void setPlaceholder​(java.lang.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 org.w3c.dom.Node
        Overrides:
        cloneNode in class HtmlElement

      • willValidate

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

      • setCustomValidity

        public void setCustomValidity​(java.lang.String message)
        Sets the custom validity message for the element to the specified message.
        Specified by:
        setCustomValidity in interface ValidatableElement
        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()
        Specified by:
        isCustomErrorValidityState in interface ValidatableElement
        Returns:
        a boolean value indicating whether the element's custom validity message has been set to a non-empty string by calling the element's setCustomValidity() method.

      • isValidValidityState

        public boolean isValidValidityState()
        Specified by:
        isValidValidityState in interface ValidatableElement
        Returns:
        true if the element meets all its validation constraints, and is therefore considered to be valid, or false if it fails any constraint. If true, the element matches the :valid CSS pseudo-class; the :invalid CSS pseudo-class otherwise.

      • isValueMissingValidityState

        public boolean isValueMissingValidityState()
        Specified by:
        isValueMissingValidityState in interface ValidatableElement
        Returns:
        true if the element has a required attribute, but no value, or false otherwise. If true, the element matches the :invalid CSS pseudo-class.