Class HtmlButton
- 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.HtmlButton
-
- All Implemented Interfaces:
DisabledElement,FormFieldWithNameHistory,LabelableElement,SubmittableElement,java.io.Serializable,java.lang.Cloneable,org.w3c.dom.Element,org.w3c.dom.Node
public class HtmlButton extends HtmlElement implements DisabledElement, SubmittableElement, LabelableElement, FormFieldWithNameHistory
Wrapper for the HTML element "button".- 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.StringTAG_NAMEThe HTML tag represented by this element.-
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 Modifier and Type Method Description protected booleandoClickStateUpdate(boolean shiftKey, boolean ctrlKey)This method implements the control state update part of the click action.java.lang.StringgetAccessKeyAttribute()Returns the value of the attributeaccesskey.java.lang.StringgetAttribute(java.lang.String attributeName)Overwritten, because Internet Explorer doesn't follow the spec when the type isn't specified.HtmlElement.DisplayStylegetDefaultStyleDisplay()INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns the default display style.java.lang.StringgetDefaultValue()Returns the default value to use when this element gets reset, if applicable.java.lang.StringgetDisabledAttribute()Returns the value of the attributedisabled.java.lang.StringgetNameAttribute()Returns the value of the attributename.java.util.Collection<java.lang.String>getNewNames()Get all the names this field got after the original one.java.lang.StringgetOnBlurAttribute()Returns the value of the attributeonblur.java.lang.StringgetOnFocusAttribute()Returns the value of the attributeonfocus.java.lang.StringgetOriginalName()Gets the first value of thenameattribute of this field before any change.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.java.lang.StringgetTabIndexAttribute()Returns the value of the attributetabindex.java.lang.StringgetType()java.lang.StringgetTypeAttribute()Returns the value of the attributetype.java.lang.StringgetValueAttribute()Returns the value of the attributevalue.booleanhandles(com.gargoylesoftware.htmlunit.javascript.host.event.Event event)Indicates if the provided event can be applied to this node.booleanisDefaultChecked()Returns the default checked state to use when this element gets reset, if applicable.booleanisDisabled()Returnstrueif the disabled attribute is set for this element.protected booleanisEmptyXmlTagExpanded()Indicates if a node without children should be written in expanded form as XML (i.e. with closing tag rather than with "/>")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.voidsetDefaultValue(java.lang.String defaultValue)Sets the default value to use when this element gets reset, if applicable.voidsetValueAttribute(java.lang.String newValue)Sets the content of thevalueattribute.-
Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, cloneNode, 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, isRequiredSupported, isShiftPressed, isSubmittableByEnter, isValid, 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, focus, getAttributeDirect, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStyleElement, getStyleElementCaseInSensitive, getStyleMap, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isDisabledElementAndDisabled, isMouseOver, isStateUpdateFirst, matches, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, printOpeningTagContentAsXml, printXml, propagateClickStateUpdateToParent, removeAttributeNode, removeAttributeNS, removeFocus, removeStyleAttribute, replaceStyleAttribute, rightClick, rightClick, setAttribute, 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, 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 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
-
TAG_NAME
public static final java.lang.String TAG_NAME
The HTML tag represented by this element.- See Also:
- Constant Field Values
-
-
Method Detail
-
setValueAttribute
public void setValueAttribute(java.lang.String newValue)
Sets the content of thevalueattribute.- Parameters:
newValue- the new content
-
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
-
isDisabled
public final boolean isDisabled()
Returnstrueif the disabled attribute is set for this element.- Specified by:
isDisabledin interfaceDisabledElement- Returns:
trueif the disabled attribute is set for this element
-
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.
- Specified by:
getSubmitNameValuePairsin interfaceSubmittableElement- Returns:
- the values that will be sent back to the server whenever this element's containing form is submitted
-
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:
resetin interfaceSubmittableElement- See Also:
SubmittableElement.reset()
-
setDefaultValue
public void setDefaultValue(java.lang.String defaultValue)
Sets the default value to use when this element gets reset, if applicable.- Specified by:
setDefaultValuein interfaceSubmittableElement- Parameters:
defaultValue- the default value to use when this element gets reset, if applicable- See Also:
SubmittableElement.setDefaultValue(String)
-
getDefaultValue
public java.lang.String getDefaultValue()
Returns the default value to use when this element gets reset, if applicable.- Specified by:
getDefaultValuein interfaceSubmittableElement- Returns:
- the default value to use when this element gets reset, if applicable
- See Also:
SubmittableElement.getDefaultValue()
-
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. This 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)
-
isDefaultChecked
public boolean isDefaultChecked()
Returns the default checked state to use when this element gets reset, if applicable. This implementation returnsfalse; only checkboxes and radio buttons really care what the default checked value is.- Specified by:
isDefaultCheckedin interfaceSubmittableElement- Returns:
- the default checked state to use when this element gets reset, if applicable
- See Also:
SubmittableElement.isDefaultChecked(),HtmlRadioButtonInput.isDefaultChecked(),HtmlCheckBoxInput.isDefaultChecked()
-
handles
public boolean handles(com.gargoylesoftware.htmlunit.javascript.host.event.Event event)
Indicates if the provided event can be applied to this node. Overwrite this.- Overrides:
handlesin classHtmlElement- Parameters:
event- the event- Returns:
falseif the event can't be applied
-
getNameAttribute
public final java.lang.String getNameAttribute()
Returns the value of the attributename. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
nameor an empty string if that attribute isn't defined
-
getValueAttribute
public final java.lang.String getValueAttribute()
Returns the value of the attributevalue. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
valueor an empty string if that attribute isn't defined
-
getAttribute
public java.lang.String getAttribute(java.lang.String attributeName)
Overwritten, because Internet Explorer doesn't follow the spec when the type isn't specified. It will return button" rather than the "submit" specified in the spec.- Specified by:
getAttributein interfaceorg.w3c.dom.Element- Overrides:
getAttributein classDomElement- Parameters:
attributeName- the name of the attribute- Returns:
- the value of the attribute or
DomElement.ATTRIBUTE_NOT_DEFINEDorDomElement.ATTRIBUTE_VALUE_EMPTY
-
getTypeAttribute
public final java.lang.String getTypeAttribute()
Returns the value of the attributetype. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
typeor the default value if that attribute isn't defined
-
getType
public java.lang.String getType()
- Returns:
- the normalized type value (submit|reset|button).
-
getDisabledAttribute
public final java.lang.String getDisabledAttribute()
Returns the value of the attributedisabled. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Specified by:
getDisabledAttributein interfaceDisabledElement- Returns:
- the value of the attribute
disabledor an empty string if that attribute isn't defined
-
getTabIndexAttribute
public final java.lang.String getTabIndexAttribute()
Returns the value of the attributetabindex. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
tabindexor an empty string if that attribute isn't defined
-
getAccessKeyAttribute
public final java.lang.String getAccessKeyAttribute()
Returns the value of the attributeaccesskey. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
accesskeyor an empty string if that attribute isn't defined
-
getOnFocusAttribute
public final java.lang.String getOnFocusAttribute()
Returns the value of the attributeonfocus. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
onfocusor an empty string if that attribute isn't defined
-
getOnBlurAttribute
public final java.lang.String getOnBlurAttribute()
Returns the value of the attributeonblur. Refer to the HTML 4.01 documentation for details on the use of this attribute.- Returns:
- the value of the attribute
onbluror an empty string if that attribute isn't defined
-
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 classHtmlElement- 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
-
getOriginalName
public java.lang.String getOriginalName()
Gets the first value of thenameattribute of this field before any change.- Specified by:
getOriginalNamein interfaceFormFieldWithNameHistory- Returns:
- the original name (which is the same as the current one when no change has been made)
-
getNewNames
public java.util.Collection<java.lang.String> getNewNames()
Get all the names this field got after the original one.- Specified by:
getNewNamesin interfaceFormFieldWithNameHistory- Returns:
- an empty collection if the name attribute has never been changed.
-
getDefaultStyleDisplay
public HtmlElement.DisplayStyle getDefaultStyleDisplay()
INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns the default display style.- Overrides:
getDefaultStyleDisplayin classHtmlElement- Returns:
- the default display style
-
isEmptyXmlTagExpanded
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 "/>")- Overrides:
isEmptyXmlTagExpandedin classDomElement- Returns:
trueto make generated XML readable as HTML.
-
-