public abstract class HtmlInput extends HtmlElement implements DisabledElement, SubmittableElement, FormFieldWithNameHistory
HtmlElement.DisplayStyle
DomElement.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
Constructor and Description |
---|
HtmlInput(SgmlPage page,
Map<String,DomAttr> attributes)
Creates an instance.
|
HtmlInput(String qualifiedName,
SgmlPage page,
Map<String,DomAttr> attributes)
Creates an instance.
|
Modifier and Type | Method and Description |
---|---|
<P extends Page> |
click(int x,
int y)
Simulate clicking this input with a pointing device.
|
void |
focus()
Sets the focus on this element.
|
String |
getAccept()
Returns the value of the
accept attribute. |
String |
getAcceptAttribute()
Returns the value of the attribute "accept".
|
String |
getAccessKeyAttribute()
Returns the value of the attribute "accesskey".
|
String |
getAlignAttribute()
Returns the value of the attribute "align".
|
String |
getAltAttribute()
Returns the value of the attribute "alt".
|
String |
getAutocomplete()
Returns the value of the
autocomplete attribute. |
String |
getCheckedAttribute()
Returns the value of the attribute "checked".
|
HtmlElement.DisplayStyle |
getDefaultStyleDisplay()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns the default display style. |
String |
getDefaultValue()
Returns the default value to use when this element gets reset, if applicable.
|
String |
getDisabledAttribute()
Returns the value of the attribute "disabled".
|
protected int |
getMaxLength()
Gets the max length if defined, Integer.MAX_VALUE if none.
|
String |
getMaxLengthAttribute()
Returns the value of the attribute "maxlength".
|
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 |
getReadOnlyAttribute()
Returns the value of the attribute "readonly".
|
String |
getSize()
Returns the value of the
size attribute. |
String |
getSizeAttribute()
Returns the value of the attribute "size".
|
String |
getSrcAttribute()
Returns the value of the attribute "src".
|
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 |
getTypeAttribute()
Returns the value of the attribute "type".
|
String |
getUseMapAttribute()
Returns the value of the attribute "usemap".
|
String |
getValueAttribute()
Return the value of the attribute "value".
|
boolean |
isChecked()
Returns true if this element is currently selected.
|
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.
|
boolean |
isReadOnly()
Returns true if this element is read only.
|
boolean |
isRequired()
Returns the
required attribute. |
void |
markAsCreatedByJavascript()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Marks this frame as created by javascript. |
protected boolean |
propagateClickStateUpdateToParent() |
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 |
setAccept(String accept)
Sets the
accept attribute. |
void |
setAttributeNS(String namespaceURI,
String qualifiedName,
String attributeValue)
Sets the value of the specified attribute.
|
void |
setAutocomplete(String autocomplete)
Sets the
autocomplete attribute. |
Page |
setChecked(boolean isChecked)
Sets the "checked" attribute, returning the page that occupies this input's window after setting
the 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.
|
protected void |
setDefaultValue(String defaultValue,
boolean modifyValue)
Sets the default value, optionally also modifying the current value.
|
void |
setMaxLength(int maxLength)
Sets the
maxLength attribute. |
void |
setMinLength(int minLength)
Sets the
minLength attribute. |
void |
setReadOnly(boolean isReadOnly)
Sets the "readOnly" attribute.
|
void |
setRequired(boolean required)
Sets the
required attribute. |
void |
setSize(String size)
Sets the
size attribute. |
Page |
setValueAttribute(String newValue)
Sets the content of the "value" attribute, executing onchange handlers if appropriate.
|
boolean |
wasCreatedByJavascript()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns true if this frame was created by javascript. |
addHtmlAttributeChangeListener, appendChildIfNoneExists, blur, checkChildHierarchy, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, doType, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventTargetElement, getHtmlElementsByTagName, getHtmlElementsByTagNames, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, isAttributeCaseSensitive, isDisplayed, isStateUpdateFirst, isSubmittableByEnter, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, querySelector, querySelectorAll, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeNode, setEventHandler, setEventHandler, setId, toString, type, type, type, type, type, type
cloneNode, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getId, getLastElementChild, getNextElementSibling, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isEmptyXmlTagExpanded, namespaces, printOpeningTagContentAsXml, printXml, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix
addDomChangeListener, appendChild, asText, asXml, compareDocumentPosition, detach, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDescendant, isDirectlyAttachedToPage, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, remove, removeAllChildren, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject, setTextContent, setUserData
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
appendChild, 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, setNodeValue, setPrefix, setTextContent, setUserData
public static final String TAG_NAME
public HtmlInput(SgmlPage page, Map<String,DomAttr> attributes)
page
- the page that contains this elementattributes
- the initial attributespublic Page setValueAttribute(String newValue)
newValue
- the new contentpublic 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 final String getTypeAttribute()
public final String getNameAttribute()
public final String getValueAttribute()
Return the value of the attribute "value". Refer to the HTML 4.01 documentation for details on the use of this attribute.
public final String getCheckedAttribute()
public final String getDisabledAttribute()
getDisabledAttribute
in interface DisabledElement
public final boolean isDisabled()
isDisabled
in interface DisabledElement
public final String getReadOnlyAttribute()
public final String getSizeAttribute()
public final String getMaxLengthAttribute()
protected int getMaxLength()
public final String getSrcAttribute()
public final String getAltAttribute()
public final String getUseMapAttribute()
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 final String getAcceptAttribute()
public final String getAlignAttribute()
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)
,
HtmlFileInput.setDefaultValue(String)
protected void setDefaultValue(String defaultValue, boolean modifyValue)
defaultValue
- the new default valuemodifyValue
- Whether or not to set the current value to the default valuepublic 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 Page setChecked(boolean isChecked)
isChecked
- true if this element is to be selectedpublic void setReadOnly(boolean isReadOnly)
isReadOnly
- true if this element is read onlypublic boolean isChecked()
public boolean isReadOnly()
public <P extends Page> P click(int x, int y) throws IOException, ElementNotFoundException
P
- the page typex
- the x coordinate of the pointing device at the time of clickingy
- the y coordinate of the pointing device at the time of clickingIOException
- If an io error occursElementNotFoundException
- If a particular XML element could not be found in the DOM modelprotected boolean propagateClickStateUpdateToParent()
propagateClickStateUpdateToParent
in class HtmlElement
Usually the click is propagated to the parent. Overwrite if you
like to disable this.
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> getNewNames()
getNewNames
in interface FormFieldWithNameHistory
public void markAsCreatedByJavascript()
public boolean wasCreatedByJavascript()
public final void focus()
focus
in class HtmlElement
public HtmlElement.DisplayStyle getDefaultStyleDisplay()
getDefaultStyleDisplay
in class HtmlElement
public boolean isRequired()
required
attribute.required
attributepublic void setRequired(boolean required)
required
attribute.required
- the new attribute valuepublic String getSize()
size
attribute.size
attributepublic void setSize(String size)
size
attribute.size
- the size
attributepublic void setMaxLength(int maxLength)
maxLength
attribute.maxLength
- the maxLength
attributepublic void setMinLength(int minLength)
minLength
attribute.minLength
- the minLength
attributepublic String getAccept()
accept
attribute.accept
attributepublic void setAccept(String accept)
accept
attribute.accept
- the accept
attributepublic String getAutocomplete()
autocomplete
attribute.autocomplete
attributepublic void setAutocomplete(String autocomplete)
autocomplete
attribute.autocomplete
- the autocomplete
attributeCopyright © 2002–2015 Gargoyle Software Inc.. All rights reserved.