Class HtmlSubmitInput
- java.lang.Object
-
- All Implemented Interfaces:
DisabledElement,FormFieldWithNameHistory,LabelableElement,SubmittableElement,java.io.Serializable,java.lang.Cloneable,org.w3c.dom.Element,org.w3c.dom.Node
public class HtmlSubmitInput extends HtmlInput implements LabelableElement
Wrapper for the HTML element "input".- 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 Modifier and Type Field Description static java.lang.StringDEFAULT_VALUEValue to use if no specified value attribute.-
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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.StringasText()Deprecated.as of version 2.48.0; use asNormalizedText() insteadprotected booleandoClickStateUpdate(boolean shiftKey, boolean ctrlKey)This method implements the control state update part of the click action.NameValuePair[]getSubmitNameValuePairs()Returns an array ofNameValuePairs that are the values that will be sent back to the server whenever this element's containing form is submitted.protected booleanisRequiredSupported()Returns whether this element supports therequiredconstraint.protected voidprintOpeningTagContentAsXml(java.io.PrintWriter printWriter)Prints the content between "<" and ">" (or "/>") in the output of the tag name and its attributes in XML format.protected booleanpropagateClickStateUpdateToParent()voidreset()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).protected voidsetAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String attributeValue, boolean notifyAttributeChangeListeners, boolean notifyMutationObservers)Sets the value of the attribute specified by namespace and qualified name.voidsetDefaultChecked(boolean defaultChecked)Sets the default checked state to use when this element gets reset, if applicable.-
Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlInput
cloneNode, focus, getAccept, getAcceptAttribute, getAccessKeyAttribute, getAlignAttribute, getAltAttribute, getAutocomplete, getCheckedAttribute, getDefaultStyleDisplay, getDefaultValue, getDisabledAttribute, getMax, getMaxLength, getMaxLengthAttribute, getMin, getMinLength, getMinLengthAttribute, getNameAttribute, getNewNames, getOnBlurAttribute, getOnChangeAttribute, getOnFocusAttribute, getOnSelectAttribute, getOriginalName, getPattern, getPlaceholder, getReadOnlyAttribute, getSize, getSizeAttribute, getSrcAttribute, getStep, getTabIndexAttribute, getTypeAttribute, getUseMapAttribute, getValueAttribute, handles, isBlankPatternValidated, isChecked, isDefaultChecked, isDisabled, isMinMaxLengthSupported, isPatternSupported, isReadOnly, isValid, markAsCreatedByJavascript, removeFocus, setAccept, setAttribute, setAutocomplete, setChecked, setDefaultValue, setDefaultValue, setMax, setMaxLength, setMin, setMinLength, setPattern, setPlaceholder, setReadOnly, setSize, setSrcAttribute, setStep, setValueAttribute, valueModifiedByJavascript, wasCreatedByJavascript
-
Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, detach, doType, doType, 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, isOptional, isRequired, isShiftPressed, isSubmittableByEnter, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setRequired, type, type, type, type, typeDone
-
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomElement
blur, click, click, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, 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, 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, asNormalizedText, 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 org.w3c.dom.Node
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, setPrefix, setTextContent, setUserData
-
-
-
-
Field Detail
-
DEFAULT_VALUE
public static final java.lang.String DEFAULT_VALUE
Value to use if no specified value attribute.- See Also:
- Constant Field Values
-
-
Method Detail
-
doClickStateUpdate
protected boolean doClickStateUpdate(boolean shiftKey, boolean ctrlKey) throws java.io.IOExceptionThis method implements the control state update part of the click action.The default implementation only calls doClickStateUpdate on parent's DomElement (if any). Subclasses requiring different behavior (like
HtmlSubmitInput) will override this method.- Overrides:
doClickStateUpdatein classDomElement- Parameters:
shiftKey-trueif SHIFT is pressedctrlKey-trueif CTRL is pressed- Returns:
- true if doClickFireEvent method has to be called later on (to signal, that the value was changed)
- Throws:
java.io.IOException- if an IO error occurs
-
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:
setDefaultCheckedin interfaceSubmittableElement- 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). This method does nothing for submit input elements.- Specified by:
resetin interfaceSubmittableElement- Overrides:
resetin classHtmlInput- See Also:
SubmittableElement.reset()
-
asText
@Deprecated public java.lang.String asText()
Deprecated.as of version 2.48.0; use asNormalizedText() insteadReturns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser. For example, a single-selection select element would return the currently selected value as text. Returns "Submit Query" if value attribute is not defined.
-
printOpeningTagContentAsXml
protected void printOpeningTagContentAsXml(java.io.PrintWriter printWriter)
Prints the content between "<" and ">" (or "/>") in the output of the tag name and its attributes in XML format. Doesn't print the attribute if it is value="Submit Query".- Overrides:
printOpeningTagContentAsXmlin classDomElement- Parameters:
printWriter- the writer to print in
-
getSubmitNameValuePairs
public 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.
Returns "Submit Query" if name attribute is defined and value attribute is not defined.- Specified by:
getSubmitNameValuePairsin interfaceSubmittableElement- Overrides:
getSubmitNameValuePairsin classHtmlInput- Returns:
- the values that will be sent back to the server whenever this element's containing form is submitted
-
setAttributeNS
protected void setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String attributeValue, boolean notifyAttributeChangeListeners, boolean notifyMutationObservers)Sets the value of the attribute specified by namespace and qualified name.- Overrides:
setAttributeNSin classHtmlInput- Parameters:
namespaceURI- the URI that identifies an XML namespacequalifiedName- the qualified name (prefix:local) of the attributeattributeValue- the value of the attributenotifyAttributeChangeListeners- to notify the associatedHtmlAttributeChangeListenersnotifyMutationObservers- to notifyMutationObservers or not
-
propagateClickStateUpdateToParent
protected boolean propagateClickStateUpdateToParent()
- Overrides:
propagateClickStateUpdateToParentin classHtmlInput- Returns:
- true or false
- See Also:
Usually the click is propagated to the parent. Overwrite if you like to disable this.
-
isRequiredSupported
protected boolean isRequiredSupported()
Returns whether this element supports therequiredconstraint.- Overrides:
isRequiredSupportedin classHtmlInput- Returns:
- whether this element supports the
requiredconstraint
-
-