com.gargoylesoftware.htmlunit.html

Class HtmlTextInput

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

com.gargoylesoftware.htmlunit.html.HtmlTextInput

All Implemented Interfaces:

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

Direct Known Subclasses:

HtmlSearchInput

public class HtmlTextInput
extends HtmlInput
implements SelectableTextInput, LabelableElement

Wrapper for the HTML element "input" with type="text".

Author:

Mike Bowler, David K. Taylor, Christian Sell, Daniel Gredler, Ahmed Ashour, Marc Guillemot, 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 inherited from class com.gargoylesoftware.htmlunit.html.HtmlInput

TAG_NAME

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

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

Modifier and Type	Method and Description
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.
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.
String	getText() Returns all of the text in this element.
protected boolean	isSubmittableByEnter() Returns true if clicking Enter (ASCII 10, or '\n') should submit the enclosed form (if any).
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	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	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 text) Sets the text in this element.
protected void	typeDone(String newValue, boolean notifyAttributeChangeListeners) Called from DoTypeProcessor.

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

focus, getAccept, getAcceptAttribute, getAccessKeyAttribute, getAlignAttribute, getAltAttribute, getAutocomplete, getCheckedAttribute, getDefaultStyleDisplay, getDefaultValue, getDisabledAttribute, getMaxLength, getMaxLengthAttribute, getNameAttribute, getNewNames, getOnBlurAttribute, getOnChangeAttribute, getOnFocusAttribute, getOnSelectAttribute, getOriginalName, getPlaceholder, getReadOnlyAttribute, getSize, getSizeAttribute, getSrcAttribute, getSubmitNameValuePairs, getTabIndexAttribute, getTypeAttribute, getUseMapAttribute, getValueAttribute, handles, isChecked, isDefaultChecked, isDisabled, isReadOnly, isRequiredSupported, markAsCreatedByJavascript, propagateClickStateUpdateToParent, removeFocus, setAccept, setAttribute, setAutocomplete, setChecked, setDefaultValue, setMaxLength, setMinLength, setPlaceholder, setReadOnly, setSize, setValueAttribute, wasCreatedByJavascript

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

acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, detach, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, isAltPressed, isAttributeCaseSensitive, isCtrlPressed, isDisplayed, isHidden, isRequired, isShiftPressed, isValid, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setRequired, type, type, type, type

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

blur, 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, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isDisabledElementAndDisabled, isEmptyXmlTagExpanded, isMouseOver, isStateUpdateFirst, matches, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, printOpeningTagContentAsXml, printXml, removeAttributeNode, removeAttributeNS, removeStyleAttribute, replaceStyleAttribute, rightClick, rightClick, setAttributeNodeNS, setAttributeNS, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, toString, writeStyleToElement

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

getLocalName, getLowercaseName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix

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

addCharacterDataChangeListener, addDomChangeListener, appendChild, asText, asXml, basicRemove, 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, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setNextSibling, setParentNode, setPreviousSibling, setReadyState, setScriptableObject, setStartLocation, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

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

focus, getPage

Methods inherited from interface org.w3c.dom.Node

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

Method Detail

doType

protected void doType(char c,
                      boolean lastType)

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

lastType - is this the last character to type

doType

protected void doType(int keyCode,
                      boolean lastType)

Performs the effective type action, called after the keyPress event and before the keyUp event. An example of predefined values is KeyboardEvent.DOM_VK_PAGE_DOWN.

Overrides:

doType in class HtmlElement

Parameters:

keyCode - the key code wish to simulate typing

lastType - is this the last to type

typeDone

protected void typeDone(String newValue,
                        boolean notifyAttributeChangeListeners)

Called from DoTypeProcessor.

Overrides:

typeDone in class HtmlElement

Parameters:

newValue - the new value

notifyAttributeChangeListeners - to notify the associated HtmlAttributeChangeListeners

isSubmittableByEnter

protected boolean isSubmittableByEnter()

Returns true if clicking Enter (ASCII 10, or '\n') should submit the enclosed form (if any). The default implementation returns false.

Overrides:

isSubmittableByEnter in class HtmlElement

Returns:

true if clicking Enter should submit the enclosed form (if any)

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

getText

public String getText()

Returns all of the text in this element.

Specified by:

getText in interface SelectableTextInput

Returns:

all of the text in this element

setText

public void setText(String text)

Sets the text in this element.

Specified by:

setText in interface SelectableTextInput

Parameters:

text - the text to put 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

setAttributeNS

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.

Overrides:

setAttributeNS in class HtmlInput

Parameters:

namespaceURI - the URI that identifies an XML namespace

qualifiedName - the qualified name (prefix:local) of the attribute

attributeValue - the value of the attribute

notifyAttributeChangeListeners - to notify the associated HtmlAttributeChangeListeners

notifyMutationObservers - to notify MutationObservers or not

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

Overrides:

setDefaultValue in class HtmlInput

Parameters:

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

See Also:

SubmittableElement.setDefaultValue(String)

setDefaultChecked

public void setDefaultChecked(boolean defaultChecked)

Sets the default checked state to use when this element gets reset, if applicable. The default 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)

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

Overrides:

reset in class HtmlInput

See Also:

HtmlInput.reset()

cloneNode

public DomNode cloneNode(boolean deep)

Specified by:

cloneNode in interface Node

Overrides:

cloneNode in class HtmlInput