public class HtmlTextArea extends HtmlElement implements DisabledElement, SubmittableElement, LabelableElement, SelectableTextInput, FormFieldWithNameHistory, ValidatableElement
HtmlElement.DisplayStyleDomElement.ChildElementsIteratorDomNode.ChildIterator, DomNode.DescendantDomElementsIterator, DomNode.DescendantDomNodesIterator, DomNode.DescendantHtmlElementsIterator| Modifier and Type | Field and Description |
|---|---|
static String |
TAG_NAME
The HTML tag represented by this element.
|
ATTRIBUTE_CHECKED, ATTRIBUTE_HIDDEN, ATTRIBUTE_REQUIRED, TAB_INDEX_OUT_OF_BOUNDSATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, ID_ATTRIBUTE, NAME_ATTRIBUTE, SRC_ATTRIBUTE, TYPE_ATTRIBUTE, VALUE_ATTRIBUTEPROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZEDATTRIBUTE_DISABLEDATTRIBUTE_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 boolean |
acceptChar(char c)
Indicates if the provided character can be "typed" in the element.
|
DomNode |
cloneNode(boolean deep) |
protected void |
doType(char c,
boolean lastType)
Performs the effective type action, called after the keyPress event and before the keyUp event.
|
protected void |
doType(int keyCode,
boolean lastType)
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 |
getPlaceholder()
Returns the value of the
placeholder attribute. |
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[] |
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. |
String |
getTabIndexAttribute()
Returns the value of the attribute
tabindex. |
String |
getText()
Returns the value that would be displayed in the text area.
|
boolean |
handles(Event event)
Indicates if the provided event can be applied to this node.
|
boolean |
isCustomErrorValidityState() |
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 boolean |
isRequiredSupported()
Returns whether this element supports the
required constraint. |
boolean |
isValid()
Returns whether this element satisfies all form validation constraints set.
|
boolean |
isValidValidityState() |
boolean |
isValueMissingValidityState() |
protected boolean |
printXml(String indent,
boolean tagBefore,
PrintWriter printWriter)
Recursively writes 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.
|
protected void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String attributeValue,
boolean notifyAttributeChangeListeners,
boolean notifyMutationObservers)
Sets the value of the attribute specified by namespace and qualified name.
|
void |
setCustomValidity(String message)
Sets the custom validity message for the element to the specified message.
|
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 |
setPlaceholder(String placeholder)
Sets the
placeholder attribute. |
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,
boolean notifyAttributeChangeListeners)
Called from
DoTypeProcessor. |
boolean |
willValidate() |
addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, detach, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getHidden, getLangAttribute, getNodeName, getOffsetLeft, getOffsetParentInternal, getOffsetTop, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getPosX, getPosY, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, isAltPressed, isAttributeCaseSensitive, isCtrlPressed, isDisplayed, isHidden, isOptional, isRequired, isShiftPressed, isSubmittableByEnter, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setHidden, setHidden, setOwningForm, setRequired, type, type, type, typeblur, click, click, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, fireEvent, fireEvent, getAttribute, getAttributeDirect, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStaticElementsByTagName, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isDisabledElementAndDisabled, isMouseOver, isStateUpdateFirst, matches, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, printOpeningTagContentAsXml, propagateClickStateUpdateToParent, removeAttributeNode, removeAttributeNS, removeStyleAttribute, replaceStyleAttribute, rightClick, rightClick, setAttribute, setAttributeNodeNS, setAttributeNS, setDefaults, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setInnerHtml, setNodeValue, toString, writeStyleToElementgetLocalName, getLowercaseName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefixaddCharacterDataChangeListener, addDomChangeListener, appendChild, asNormalizedText, asXml, basicRemove, closest, compareDocumentPosition, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextElementSibling, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousElementSibling, getPreviousSibling, getReadyState, getScriptableObject, getSelectorList, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, getVisibleText, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, parseHtmlSnippet, printChildrenAsXml, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setParentNode, setReadyState, setScriptableObject, setStartLocation, setTextContent, setUserDataclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetPagehasBadInputValidityState, hasPatternMismatchValidityState, hasRangeOverflowValidityState, hasRangeUnderflowValidityState, hasTypeMismatchValidityState, isStepMismatchValidityState, isTooLongValidityState, isTooShortValidityStateappendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setPrefix, setTextContent, setUserDatapublic static final String TAG_NAME
public boolean handles(Event event)
handles in class HtmlElementevent - the eventfalse if the event can't be appliedpublic final String getText()
getText in interface SelectableTextInputpublic final void setText(String newValue)
Note that this acts like 'pasting' the text, but to simulate characters entry
you should use HtmlElement.type(String).
setText in interface SelectableTextInputnewValue - the new valuepublic 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.
getSubmitNameValuePairs in interface SubmittableElementpublic void reset()
reset in interface SubmittableElementSubmittableElement.reset()public void setDefaultValue(String defaultValue)
setDefaultValue in interface SubmittableElementdefaultValue - the default value to use when this element gets reset, if applicableSubmittableElement.setDefaultValue(String)public String getDefaultValue()
getDefaultValue in interface SubmittableElementSubmittableElement.getDefaultValue()public void setDefaultChecked(boolean defaultChecked)
setDefaultChecked in interface SubmittableElementdefaultChecked - the default checked state to use when this element gets reset, if applicableSubmittableElement.setDefaultChecked(boolean),
HtmlRadioButtonInput.setDefaultChecked(boolean),
HtmlCheckBoxInput.setDefaultChecked(boolean)public boolean isDefaultChecked()
false; only checkboxes and
radio buttons really care what the default checked value is.isDefaultChecked in interface SubmittableElementSubmittableElement.isDefaultChecked(),
HtmlRadioButtonInput.isDefaultChecked(),
HtmlCheckBoxInput.isDefaultChecked()public final String getNameAttribute()
name. Refer to the
HTML 4.01
documentation for details on the use of this attribute.name or an empty string if that attribute isn't definedpublic final String getRowsAttribute()
rows. Refer to the
HTML 4.01
documentation for details on the use of this attribute.rows or an empty string if that attribute isn't definedpublic final String getColumnsAttribute()
cols. Refer to the
HTML 4.01
documentation for details on the use of this attribute.cols or an empty string if that attribute isn't definedpublic final boolean isDisabled()
true if the disabled attribute is set for this element.isDisabled in interface DisabledElementtrue if the disabled attribute is set for this elementpublic final String getDisabledAttribute()
disabled. Refer to the
HTML 4.01
documentation for details on the use of this attribute.getDisabledAttribute in interface DisabledElementdisabled or an empty string if that attribute isn't definedpublic final String getReadOnlyAttribute()
readonly. Refer to the
HTML 4.01
documentation for details on the use of this attribute.readonly or an empty string if that attribute isn't definedpublic final String getTabIndexAttribute()
tabindex. Refer to the
HTML 4.01
documentation for details on the use of this attribute.tabindex or an empty string if that attribute isn't definedpublic final String getAccessKeyAttribute()
accesskey. Refer to the
HTML 4.01
documentation for details on the use of this attribute.accesskey or an empty string if that attribute isn't definedpublic final String getOnFocusAttribute()
onfocus. Refer to the
HTML 4.01
documentation for details on the use of this attribute.onfocus or an empty string if that attribute isn't definedpublic final String getOnBlurAttribute()
onblur. Refer to the
HTML 4.01
documentation for details on the use of this attribute.onblur or an empty string if that attribute isn't definedpublic final String getOnSelectAttribute()
onselect. Refer to the
HTML 4.01
documentation for details on the use of this attribute.onselect or an empty string if that attribute isn't definedpublic final String getOnChangeAttribute()
onchange. Refer to the
HTML 4.01
documentation for details on the use of this attribute.onchange or an empty string if that attribute isn't definedpublic void select()
select in interface SelectableTextInputpublic String getSelectedText()
null if there is no selected text in this element.getSelectedText in interface SelectableTextInputnull if there is no selected text in this elementpublic int getSelectionStart()
getSelectionStart in interface SelectableTextInputpublic void setSelectionStart(int selectionStart)
setSelectionStart in interface SelectableTextInputselectionStart - the start position of the selected text in this elementpublic int getSelectionEnd()
getSelectionEnd in interface SelectableTextInputpublic void setSelectionEnd(int selectionEnd)
setSelectionEnd in interface SelectableTextInputselectionEnd - the end position of the selected text in this elementprotected boolean printXml(String indent, boolean tagBefore, PrintWriter printWriter)
node.printXml in class DomElementindent - white space to indent child nodestagBefore - true if the last thing printed was a tagprintWriter - writer where child nodes are writtenprotected void doType(char c,
boolean lastType)
doType in class HtmlElementc - the character you with to simulate typinglastType - is this the last character to typeprotected void doType(int keyCode,
boolean lastType)
An example of predefined values is KeyboardEvent.DOM_VK_PAGE_DOWN.
doType in class HtmlElementkeyCode - the key code wish to simulate typinglastType - is this the last to typeprotected void typeDone(String newValue, boolean notifyAttributeChangeListeners)
DoTypeProcessor.typeDone in class HtmlElementnewValue - the new valuenotifyAttributeChangeListeners - to notify the associated HtmlAttributeChangeListenersprotected boolean acceptChar(char c)
acceptChar in class HtmlElementc - the charactertrue if it is acceptedpublic void focus()
focus in interface SelectableTextInputfocus in class DomElementpublic void removeFocus()
removeFocus in class DomElementpublic void setReadOnly(boolean isReadOnly)
readOnly attribute.isReadOnly - true if this element is read onlypublic boolean isReadOnly()
true if this element is read only.true if this element is read onlyprotected void setAttributeNS(String namespaceURI, String qualifiedName, String attributeValue, boolean notifyAttributeChangeListeners, boolean notifyMutationObservers)
setAttributeNS in class HtmlElementnamespaceURI - the URI that identifies an XML namespacequalifiedName - the qualified name (prefix:local) of the attributeattributeValue - the value of the attributenotifyAttributeChangeListeners - to notify the associated HtmlAttributeChangeListenersnotifyMutationObservers - to notify MutationObservers or notpublic String getOriginalName()
name attribute of this field before any change.getOriginalName in interface FormFieldWithNameHistorypublic Collection<String> getNewNames()
getNewNames in interface FormFieldWithNameHistoryprotected boolean isEmptyXmlTagExpanded()
isEmptyXmlTagExpanded in class DomElementtrue to make generated XML readable as HTMLpublic HtmlElement.DisplayStyle getDefaultStyleDisplay()
getDefaultStyleDisplay in class HtmlElementpublic String getPlaceholder()
placeholder attribute.placeholder attributepublic void setPlaceholder(String placeholder)
placeholder attribute.placeholder - the placeholder attributeprotected boolean isRequiredSupported()
required constraint.isRequiredSupported in class HtmlElementrequired constraintpublic DomNode cloneNode(boolean deep)
cloneNode in interface NodecloneNode in class HtmlElementpublic boolean willValidate()
willValidate in interface ValidatableElementpublic void setCustomValidity(String message)
setCustomValidity in interface ValidatableElementmessage - the new messagepublic boolean isValid()
isValid in class HtmlElementpublic boolean isCustomErrorValidityState()
isCustomErrorValidityState in interface ValidatableElementpublic boolean isValidValidityState()
isValidValidityState in interface ValidatableElementpublic boolean isValueMissingValidityState()
isValueMissingValidityState in interface ValidatableElementCopyright © 2002–2025 Gargoyle Software Inc.. All rights reserved.