com.gargoylesoftware.htmlunit.html

Class HtmlTextArea

java.lang.Object

com.gargoylesoftware.htmlunit.html.DomNode

com.gargoylesoftware.htmlunit.html.DomNamespaceNode

com.gargoylesoftware.htmlunit.html.DomElement

com.gargoylesoftware.htmlunit.html.HtmlElement

com.gargoylesoftware.htmlunit.html.HtmlTextArea

All Implemented Interfaces:

DisabledElement, FormFieldWithNameHistory, SelectableTextInput, SubmittableElement, Serializable, Cloneable, Element, ElementTraversal, Node

public class HtmlTextArea
extends HtmlElement
implements DisabledElement, SubmittableElement, SelectableTextInput, FormFieldWithNameHistory

Wrapper for the HTML element "textarea".

Version:

$Revision: 10913 $

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

HtmlElement.DisplayStyle

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomElement

DomElement.ChildElementsIterator

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode

DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_NAME The HTML tag represented by this element.

Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

TAB_INDEX_OUT_OF_BOUNDS

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomElement

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

AS_TEXT_BLANK, AS_TEXT_BLOCK_SEPARATOR, AS_TEXT_NEW_LINE, AS_TEXT_TAB, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	acceptChar(char c) Indicates if the provided character can by "typed" in the element.
protected Object	clone()
protected void	doType(char c, boolean shiftKey, boolean ctrlKey, boolean altKey) Performs the effective type action, called after the keyPress event and before the keyUp event.
void	focus() Sets the focus on this element.
String	getAccessKeyAttribute() Returns the value of the attribute "accesskey".
String	getColumnsAttribute() Returns the value of the attribute "cols".
HtmlElement.DisplayStyle	getDefaultStyleDisplay() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
String	getDefaultValue() Returns the default value to use when this element gets reset, if applicable.
String	getDisabledAttribute() Returns the value of the attribute "disabled".
String	getNameAttribute() Returns the value of the attribute "name".
Collection<String>	getNewNames() Get all the names this field got after the original one.
String	getOnBlurAttribute() Returns the value of the attribute "onblur".
String	getOnChangeAttribute() Returns the value of the attribute "onchange".
String	getOnFocusAttribute() Returns the value of the attribute "onfocus".
String	getOnSelectAttribute() Returns the value of the attribute "onselect".
String	getOriginalName() Gets the first value of the name attribute of this field before any change.
String	getReadOnlyAttribute() Returns the value of the attribute "readonly".
String	getRowsAttribute() Returns the value of the attribute "rows".
String	getSelectedText() Returns the selected text in this element, or null if there is no selected text in this element.
int	getSelectionEnd() Returns the end position of the selected text in this element.
int	getSelectionStart() Returns the start position of the selected text in this element.
NameValuePair[]	getSubmitKeyValuePairs() 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.
String	getTabIndexAttribute() Returns the value of the attribute "tabindex".
String	getText() Returns the value that would be displayed in the text area.
boolean	isDefaultChecked() Returns the default checked state to use when this element gets reset, if applicable.
boolean	isDisabled() Returns true if the disabled attribute is set for this element.
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 "/>")
boolean	isReadOnly() Returns true if this element is read only.
protected void	printXml(String indent, PrintWriter printWriter) Recursively write the XML data for the node tree starting at node.
void	removeFocus() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
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).
void	select() Focuses this element and selects all of its text.
void	setAttributeNS(String namespaceURI, String qualifiedName, String attributeValue) Sets the value of the specified attribute.
void	setDefaultChecked(boolean defaultChecked) Sets the default checked state to use when this element gets reset, if applicable.
void	setDefaultValue(String defaultValue) Sets the default value to use when this element gets reset, if applicable.
void	setReadOnly(boolean isReadOnly) Sets the "readOnly" attribute.
void	setSelectionEnd(int selectionEnd) Sets the end position of the selected text in this element.
void	setSelectionStart(int selectionStart) Sets the start position of the selected text in this element.
void	setText(String newValue) Sets the new value of this text area.
protected void	typeDone(String newValue) Called from DoTypeProcessor.

Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, doType, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getHtmlElementsByTagName, getHtmlElementsByTagNames, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, isAttributeCaseSensitive, isDisplayed, isSubmittableByEnter, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, setAttributeNode, setEventHandler, setEventHandler, setId, type, type, type, type, type, type, type

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomElement

blur, click, click, click, cloneNode, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, fireEvent, fireEvent, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNextElementSibling, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isStateUpdateFirst, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, namespaces, preventDefault, printOpeningTagContentAsXml, propagateClickStateUpdateToParent, removeAttributeNode, removeAttributeNS, rightClick, rightClick, setAttribute, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, toString

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addCharacterDataChangeListener, addDomChangeListener, appendChild, asText, asXml, compareDocumentPosition, detach, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDescendant, isDirectlyAttachedToPage, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, querySelector, querySelectorAll, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gargoylesoftware.htmlunit.html.impl.SelectableTextInput

getPage

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final String TAG_NAME

The HTML tag represented by this element.

See Also:

Constant Field Values

Method Detail

getText

public final String getText()

Returns the value that would be displayed in the text area.

Specified by:

getText in interface SelectableTextInput

Returns:

the text

setText

public final void setText(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 SelectableTextInput

Parameters:

newValue - the new value

getSubmitKeyValuePairs

public NameValuePair[] getSubmitKeyValuePairs()

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:

getSubmitKeyValuePairs 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()

setDefaultValue

public void setDefaultValue(String defaultValue)

Sets the default value to use when this element gets reset, if applicable.

Specified by:

setDefaultValue in interface SubmittableElement

Parameters:

defaultValue - the default value to use when this element gets reset, if applicable

See Also:

SubmittableElement.setDefaultValue(String)

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:

SubmittableElement.getDefaultValue()

setDefaultChecked

public void setDefaultChecked(boolean defaultChecked)

Sets the default checked state to use when this element gets reset, if applicable. This implementation is empty; only checkboxes 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:

SubmittableElement.setDefaultChecked(boolean), HtmlRadioButtonInput.setDefaultChecked(boolean), HtmlCheckBoxInput.setDefaultChecked(boolean)

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:

SubmittableElement.isDefaultChecked(), HtmlRadioButtonInput.isDefaultChecked(), HtmlCheckBoxInput.isDefaultChecked()

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

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 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 void printXml(String indent,
            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 shiftKey,
          boolean ctrlKey,
          boolean altKey)

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

shiftKey - true if SHIFT is pressed during the typing

ctrlKey - true if CTRL is pressed during the typing

altKey - true if ALT is pressed during the typing

typeDone

protected void typeDone(String newValue)

Called from DoTypeProcessor.

Overrides:

typeDone in class HtmlElement

Parameters:

newValue - the new value

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 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

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

setAttributeNS

public void setAttributeNS(String namespaceURI,
                  String qualifiedName,
                  String attributeValue)

Sets the value of the specified attribute. This method may be overridden by subclasses which are interested in specific attribute value changes, but such methods must invoke super.setAttributeValue(), and should consider the value of the cloning parameter when deciding whether or not to execute custom logic.

Specified by:

setAttributeNS in interface Element

Overrides:

setAttributeNS in class HtmlElement

Parameters:

namespaceURI - the URI that identifies an XML namespace

qualifiedName - the qualified name of the attribute

attributeValue - the value of the attribute

getOriginalName

public 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 Collection<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

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