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.StyledElement
                      com.gargoylesoftware.htmlunit.html.ClickableElement
                          com.gargoylesoftware.htmlunit.html.FocusableElement
                              com.gargoylesoftware.htmlunit.html.HtmlTextArea

All Implemented Interfaces:

DisabledElement, SubmittableElement, Serializable, Cloneable

public class HtmlTextArea
extends FocusableElement
implements DisabledElement, SubmittableElement

Wrapper for the html element "textarea"

Version:

$Revision: 2132 $

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.ChildElementsIterator, HtmlElement.MapEntryWrappingIterator

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

DomNode.ChildIterator, DomNode.DescendantElementsIterator

Field Summary

static 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, TAB_INDEX_OUT_OF_BOUNDS

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

ATTRIBUTE_NODE, COMMENT_NODE, DOCUMENT_NODE, ELEMENT_NODE, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED, TEXT_NODE

Constructor Summary

HtmlTextArea(HtmlPage page, Map attributes)
Deprecated. You should not directly construct HtmlTextArea.

Method Summary

String	getAccessKeyAttribute() Return the value of the attribute "accesskey".
String	getColumnsAttribute() Return the value of the attribute "cols".
String	getDefaultValue() Returns the default value to use when this element gets reset, if applicable.
String	getDisabledAttribute() Return the value of the attribute "disabled".
String	getNameAttribute() Return the value of the attribute "name".
String	getOnBlurAttribute() Return the value of the attribute "onblur".
String	getOnChangeAttribute() Return the value of the attribute "onchange".
String	getOnFocusAttribute() Return the value of the attribute "onfocus".
String	getOnSelectAttribute() Return the value of the attribute "onselect".
String	getReadOnlyAttribute() Return the value of the attribute "readonly".
String	getRowsAttribute() Return the value of the attribute "rows".
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.
String	getTabIndexAttribute() Return the value of the attribute "tabindex".
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.
protected void	preventDefault() This method is called if the current fired event is canceled by preventDefault() in FireFox, or by returning false in Internet Explorer.
protected void	printXml(String indent, PrintWriter printWriter) recursively write the XML data for the node tree starting at node
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(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(String newValue) Set the new value of this text area.
Page	type(char c, boolean shiftKey, boolean ctrlKey, boolean altKey) Simulates typing the specified character while this element has focus.

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

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

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

getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute, isRenderedVisible

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

addHtmlAttributeChangeListener, appendChildIfNoneExists, assertNotEmpty, blur, cloneDomNode, cloneNode, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getAttribute, getAttributeEntriesIterator, getAttributeNS, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTabIndex, getTagName, hasAttribute, hasAttributeNS, hasAttributes, hasHtmlElementWithId, isAttributeDefined, isEmptyXmlTagExpanded, isSubmittableByEnter, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, notImplemented, printOpeningTagContentAsXml, removeAttribute, removeAttributeNS, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttribute, setAttributeNS, setAttributeValue, setAttributeValue, setEventHandler, setEventHandler, setId, toString, type, type, type

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

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix

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

addDomChangeListener, addPropertyChangeListener, appendChild, appendDomChild, asText, asXml, fireNodeAdded, fireNodeDeleted, firePropertyChange, getAllHtmlChildElements, getByXPath, getChildIterator, getChildrenAsText, getEndColumnNumber, getEndLineNumber, getFirstByXPath, getFirstChild, getFirstDomChild, getLastChild, getLastDomChild, getLog, getNativePage, getNextDomSibling, getNextSibling, getNodeValue, getPage, getParentDomNode, getParentNode, getPreviousDomSibling, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, isAncestorOf, isTrimmedText, notifyIncorrectness, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, reduceWhitespace, remove, removeAllChildren, removeDomChangeListener, removePropertyChangeListener, replace, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final String TAG_NAME

the HTML tag represented by this element

See Also:

Constant Field Values

Constructor Detail

HtmlTextArea

public HtmlTextArea(HtmlPage page,
                    Map attributes)

Deprecated. You should not directly construct HtmlTextArea.

Create an instance

Parameters:

page - The page that contains this element

attributes - the initial attributes

Method Detail

getText

public final String getText()

Return the value that would be displayed in the text area

Returns:

The text

setText

public final void setText(String newValue)

Set the new value of this text area.

Parameters:

newValue - The new value.

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

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

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

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.

getRowsAttribute

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

getColumnsAttribute

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

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.

getDisabledAttribute

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

getReadOnlyAttribute

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

getTabIndexAttribute

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

getAccessKeyAttribute

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

getOnFocusAttribute

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

getOnBlurAttribute

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

getOnSelectAttribute

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

getOnChangeAttribute

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

getSelectedText

public String getSelectedText()

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

Returns:

the text

getSelectionStart

public int getSelectionStart()

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

Returns:

the start position >= 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

getSelectionEnd

public int getSelectionEnd()

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

Returns:

the end position >= 0

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

printXml

protected void printXml(String indent,
                        PrintWriter printWriter)

recursively write the XML data for the node tree starting at node

Overrides:

printXml in class HtmlElement

Parameters:

indent - white space to indent child nodes

printWriter - writer where child nodes are written

type

public Page type(char c,
                 boolean shiftKey,
                 boolean ctrlKey,
                 boolean altKey)
          throws IOException

Simulates typing the specified character while this element has focus. Note that for some elements, typing '\n' submits the enclosed form.

Overrides:

type in class HtmlElement

Parameters:

c - the character you with to simulate typing

shiftKey - true if SHIFT is pressed

ctrlKey - true if CTRL is pressed

altKey - true if ALT is pressed

Returns:

The page that occupies this window after typing. It may be the same window or it may be a freshly loaded one.

Throws:

IOException - If an IO error occurs

preventDefault

protected void preventDefault()

This method is called if the current fired event is canceled by preventDefault() in FireFox, or by returning false in Internet Explorer. The default implementation does nothing.

Overrides:

preventDefault in class HtmlElement