public class HtmlTextArea extends HtmlElement implements DisabledElement, SubmittableElement, SelectableTextInput, FormFieldWithNameHistory
HtmlElement.ChildElementsIterator
DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>
Modifier and Type | Field and Description |
---|---|
static String |
TAG_NAME
The HTML tag represented by this element.
|
TAB_INDEX_OUT_OF_BOUNDS
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY
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
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
Modifier and Type | Method and Description |
---|---|
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".
|
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".
|
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. |
Collection<String> |
getPreviousNames()
Get all the names this field had before the current one.
|
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
NameValuePair s 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.
|
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 |
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.
|
addHtmlAttributeChangeListener, appendChildIfNoneExists, blur, checkChildHierarchy, click, click, click, dblClick, dblClick, doClickAction, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getChildElements, getElementById, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventTargetElement, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, hasHtmlElementWithId, isAttributeCaseSensitive, isStateUpdateFirst, isSubmittableByEnter, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, querySelector, querySelectorAll, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setEventHandler, setEventHandler, setId, toString, type, type, type, type
cloneNode, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getElementsByTagName, getElementsByTagNameNS, getNodeType, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, hasAttributes, namespaces, printOpeningTagContentAsXml, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix
addDomChangeListener, appendChild, asText, asXml, compareDocumentPosition, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getChildNodes, getChildren, getDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getIndex, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasChildNodes, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDirectlyAttachedToPage, isDisplayed, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, remove, removeAllChildren, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject, setTextContent, setUserData
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getPage
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
public static final String TAG_NAME
public final String getText()
getText
in interface SelectableTextInput
public final void setText(String newValue)
HtmlElement.type(String)
.setText
in interface SelectableTextInput
newValue
- the new valuepublic NameValuePair[] getSubmitKeyValuePairs()
Returns an array of NameValuePair
s 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.
getSubmitKeyValuePairs
in interface SubmittableElement
public void reset()
reset
in interface SubmittableElement
SubmittableElement.reset()
public void setDefaultValue(String defaultValue)
setDefaultValue
in interface SubmittableElement
defaultValue
- the default value to use when this element gets reset, if applicableSubmittableElement.setDefaultValue(String)
public String getDefaultValue()
getDefaultValue
in interface SubmittableElement
SubmittableElement.getDefaultValue()
public void setDefaultChecked(boolean defaultChecked)
setDefaultChecked
in interface SubmittableElement
defaultChecked
- the default checked state to use when this element gets reset, if applicableSubmittableElement.setDefaultChecked(boolean)
,
HtmlRadioButtonInput.setDefaultChecked(boolean)
,
HtmlCheckBoxInput.setDefaultChecked(boolean)
public boolean isDefaultChecked()
isDefaultChecked
in interface SubmittableElement
SubmittableElement.isDefaultChecked()
,
HtmlRadioButtonInput.isDefaultChecked()
,
HtmlCheckBoxInput.isDefaultChecked()
public final String getNameAttribute()
public final String getRowsAttribute()
public final String getColumnsAttribute()
public final boolean isDisabled()
isDisabled
in interface DisabledElement
public final String getDisabledAttribute()
getDisabledAttribute
in interface DisabledElement
public final String getReadOnlyAttribute()
public final String getTabIndexAttribute()
public final String getAccessKeyAttribute()
public final String getOnFocusAttribute()
public final String getOnBlurAttribute()
public final String getOnSelectAttribute()
public final String getOnChangeAttribute()
public void select()
select
in interface SelectableTextInput
public String getSelectedText()
getSelectedText
in interface SelectableTextInput
public int getSelectionStart()
getSelectionStart
in interface SelectableTextInput
public void setSelectionStart(int selectionStart)
setSelectionStart
in interface SelectableTextInput
selectionStart
- the start position of the selected text in this elementpublic int getSelectionEnd()
getSelectionEnd
in interface SelectableTextInput
public void setSelectionEnd(int selectionEnd)
setSelectionEnd
in interface SelectableTextInput
selectionEnd
- the end position of the selected text in this elementprotected void printXml(String indent, PrintWriter printWriter)
node
.printXml
in class DomElement
indent
- white space to indent child nodesprintWriter
- writer where child nodes are writtenprotected void doType(char c, boolean shiftKey, boolean ctrlKey, boolean altKey)
doType
in class HtmlElement
c
- the character you with to simulate typingshiftKey
- true if SHIFT is pressed during the typingctrlKey
- true if CTRL is pressed during the typingaltKey
- true if ALT is pressed during the typingpublic void focus()
focus
in interface SelectableTextInput
focus
in class HtmlElement
public void setReadOnly(boolean isReadOnly)
isReadOnly
- true if this element is read onlypublic boolean isReadOnly()
protected Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public void setAttributeNS(String namespaceURI, String qualifiedName, String attributeValue)
setAttributeNS
in interface Element
setAttributeNS
in class HtmlElement
namespaceURI
- the URI that identifies an XML namespacequalifiedName
- the qualified name of the attributeattributeValue
- the value of the attributepublic String getOriginalName()
name
attribute of this field before any change.getOriginalName
in interface FormFieldWithNameHistory
public Collection<String> getPreviousNames()
getPreviousNames
in interface FormFieldWithNameHistory
protected boolean isEmptyXmlTagExpanded()
isEmptyXmlTagExpanded
in class DomElement
true
to make generated XML readable as HTMLCopyright © 2002–2013 Gargoyle Software Inc.. All rights reserved.