com.gargoylesoftware.htmlunit.html
Class HtmlTextArea

java.lang.Object
  com.gargoylesoftware.htmlunit.html.DomNode
      com.gargoylesoftware.htmlunit.html.DomNamespaceNode
          com.gargoylesoftware.htmlunit.html.HtmlElement
              com.gargoylesoftware.htmlunit.html.StyledElement
                  com.gargoylesoftware.htmlunit.html.ClickableElement
                      com.gargoylesoftware.htmlunit.html.FocusableElement
                          com.gargoylesoftware.htmlunit.html.HtmlTextArea

All Implemented Interfaces:

DisabledElement, SubmittableElement, java.io.Serializable, java.lang.Cloneable

public class HtmlTextArea
extends FocusableElement
implements DisabledElement, SubmittableElement

Wrapper for the html element "textarea"

Version:

$Revision: 1.3 $

Author:

Mike Bowler, Barnaby Court, David K. Taylor, Christian Sell, David D. Kilzer, Marc Guillemot, Daniel Gredler, Ahmed Ashour

See Also:

Serialized Form

Nested Class Summary

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

HtmlElement.MapEntryWrappingIterator

Field Summary

static java.lang.String

TAG_NAME the HTML tag represented by this element

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

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY

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

PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Method Summary

java.lang.String	getAccessKeyAttribute() Return the value of the attribute "accesskey".
java.lang.String	getColumnsAttribute() Return the value of the attribute "cols".
java.lang.String	getDefaultValue() Returns the default value to use when this element gets reset, if applicable.
java.lang.String	getDisabledAttribute() Return the value of the attribute "disabled".
java.lang.String	getNameAttribute() Return the value of the attribute "name".
java.lang.String	getOnBlurAttribute() Return the value of the attribute "onblur".
java.lang.String	getOnChangeAttribute() Return the value of the attribute "onchange".
java.lang.String	getOnFocusAttribute() Return the value of the attribute "onfocus".
java.lang.String	getOnSelectAttribute() Return the value of the attribute "onselect".
java.lang.String	getReadOnlyAttribute() Return the value of the attribute "readonly".
java.lang.String	getRowsAttribute() Return the value of the attribute "rows".
java.lang.String	getSelectedText() Returns the selected text contained in this HtmlTextArea, null if no selection (Firefox only).
int	getSelectionEnd() Returns the selected text's end position (Firefox only).
int	getSelectionStart() Returns the selected text's start position (Firefox only).
KeyValuePair[]	getSubmitKeyValuePairs() Return an array of KeyValuePairs that are the values that will be sent back to the server whenever the current form is submitted.
java.lang.String	getTabIndexAttribute() Return the value of the attribute "tabindex".
java.lang.String	getText() Return 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. This implementation returns false; only checkboxes and radio buttons really care what the default checked value is.
boolean	isDisabled() Return true if the disabled attribute is set for this element.
void	reset() Return 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	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.
void	setDefaultValue(java.lang.String defaultValue) Sets the default value to use when this element gets reset, if applicable.
void	setSelectionEnd(int selectionEnd) Sets the selection end to the specified position (Firefox only).
void	setSelectionStart(int selectionStart) Sets the selection start to the specified position (Firefox only).
void	setText(java.lang.String newValue) Set the new value of this text area.

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

blur, focus

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

click, click, dblClick, dblClick, getLangAttribute, getOnClickAttribute, getOnDblClickAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTextDirectionAttribute, getXmlLangAttribute

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

getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute

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

addHtmlAttributeChangeListener, appendChildIfNoneExists, cloneDomNode, fireEvent, fireEvent, getAttributeEntriesIterator, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTagName, hasHtmlElementWithId, isAttributeDefined, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeValue, setEventHandler, setEventHandler, setId, toString

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

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix

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

addDomChangeListener, appendDomChild, asText, asXml, getAllHtmlChildElements, getByXPath, getChildIterator, getEndColumnNumber, getEndLineNumber, getFirstDomChild, getLastDomChild, getNextDomSibling, getNodeValue, getPage, getParentDomNode, getPreviousDomSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, remove, removeAllChildren, removeDomChangeListener, replace, setNodeValue, setReadyState, setScriptObject

Methods inherited from class java.lang.Object

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

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

getAccessKeyAttribute

public final java.lang.String getAccessKeyAttribute()

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

getColumnsAttribute

public final java.lang.String getColumnsAttribute()

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

getDefaultValue

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

getDisabledAttribute

public final java.lang.String getDisabledAttribute()

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

getNameAttribute

public final java.lang.String getNameAttribute()

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

getOnBlurAttribute

public final java.lang.String getOnBlurAttribute()

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

getOnChangeAttribute

public final java.lang.String getOnChangeAttribute()

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

getOnFocusAttribute

public final java.lang.String getOnFocusAttribute()

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

getOnSelectAttribute

public final java.lang.String getOnSelectAttribute()

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

getReadOnlyAttribute

public final java.lang.String getReadOnlyAttribute()

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

getRowsAttribute

public final java.lang.String getRowsAttribute()

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

getSelectedText

public java.lang.String getSelectedText()

Returns the selected text contained in this HtmlTextArea, null if no selection (Firefox only).

Returns:

the text

getSelectionEnd

public int getSelectionEnd()

Returns the selected text's end position (Firefox only).

Returns:

the end position >= 0

getSelectionStart

public int getSelectionStart()

Returns the selected text's start position (Firefox only).

Returns:

the start position >= 0

getSubmitKeyValuePairs

public KeyValuePair[] getSubmitKeyValuePairs()

Return an array of KeyValuePairs that are the values that will be sent back to the server whenever the current 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:

See above

getTabIndexAttribute

public final java.lang.String getTabIndexAttribute()

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

getText

public final java.lang.String getText()

Return the value that would be displayed in the text area

Returns:

The text

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

isDisabled

public final boolean isDisabled()

Return true if the disabled attribute is set for this element.

Specified by:

isDisabled in interface DisabledElement

Returns:

Return true if this element is disabled.

reset

public void reset()

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

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)

setDefaultValue

public void setDefaultValue(java.lang.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)

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

Sets the selection end to the specified position (Firefox only).

Parameters:

selectionEnd - the end position of the text >= 0

setSelectionStart

public void setSelectionStart(int selectionStart)

Sets the selection start to the specified position (Firefox only).

Parameters:

selectionStart - the start position of the text >= 0

setText

public final void setText(java.lang.String newValue)

Set the new value of this text area.

Parameters:

newValue - The new value.