com.gargoylesoftware.htmlunit.html

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, SubmittableElement, Serializable, Cloneable, Element, Node

public class HtmlButton
extends HtmlElement
implements DisabledElement, SubmittableElement, FormFieldWithNameHistory

Wrapper for the HTML element "button".

Author:

Mike Bowler, David K. Taylor, Christian Sell, David D. Kilzer, Daniel Gredler, Ahmed Ashour, Dmitri Zoubkov, 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

Modifier and Type	Field and Description
static String	TAG_NAME The 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

Modifier and Type	Method and Description
protected boolean	doClickStateUpdate(boolean shiftKey, boolean ctrlKey) This method implements the control state update part of the click action.
String	getAccessKeyAttribute() Returns the value of the attribute accesskey.
String	getAttribute(String attributeName) Overwritten, because Internet Explorer doesn't follow the spec when the type isn't specified.
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	getOnFocusAttribute() Returns the value of the attribute onfocus.
String	getOriginalName() Gets the first value of the name attribute of this field before any change.
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	getTypeAttribute() Returns the value of the attribute type.
String	getValueAttribute() Returns the value of the attribute value.
boolean	handles(Event event) Indicates if the provided event can be applied to this node.
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 "/>")
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).
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	setValueAttribute(String newValue) Sets the content of the value attribute.

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, 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, 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, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, querySelector, querySelectorAll, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setParentNode, setPreviousSibling, setReadyState, setScriptableObject, 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 String TAG_NAME

The HTML tag represented by this element.

See Also:

Constant Field Values

Method Detail

setValueAttribute

public void setValueAttribute(String newValue)

Sets the content of the value attribute.

Parameters:

newValue - the new content

doClickStateUpdate

protected boolean doClickStateUpdate(boolean shiftKey,
                                     boolean ctrlKey)
                              throws IOException

This 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:

doClickStateUpdate in class DomElement

Parameters:

shiftKey - true if SHIFT is pressed

ctrlKey - true if CTRL is pressed

Returns:

true if doClickFireEvent method has to be called later on (to signal, that the value was changed)

Throws:

IOException - if an IO error occurs

isDisabled

public final boolean isDisabled()

Returns true if the disabled attribute is set for this element.

Specified by:

isDisabled in interface DisabledElement

Returns:

true if 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:

getSubmitNameValuePairs in interface SubmittableElement

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:

reset in interface SubmittableElement

See Also:

SubmittableElement.reset()

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

Parameters:

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

See Also:

SubmittableElement.setDefaultValue(String)

getDefaultValue

public String getDefaultValue()

Returns the default value to use when this element gets reset, if applicable.

Specified by:

getDefaultValue in interface SubmittableElement

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:

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)

isDefaultChecked

public boolean isDefaultChecked()

Returns the default checked state to use when this element gets reset, if applicable. This implementation returns false; only checkboxes and radio buttons really care what the default checked value is.

Specified by:

isDefaultChecked in interface SubmittableElement

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(Event event)

Indicates if the provided event can be applied to this node. Overwrite this.

Overrides:

handles in class HtmlElement

Parameters:

event - the event

Returns:

false if the event can't be applied

getNameAttribute

public final String getNameAttribute()

Returns the value of the attribute name. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute name or an empty string if that attribute isn't defined

getValueAttribute

public final String getValueAttribute()

Returns the value of the attribute value. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute value or an empty string if that attribute isn't defined

getAttribute

public String getAttribute(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:

getAttribute in interface Element

Overrides:

getAttribute in class DomElement

Parameters:

attributeName - the name of the attribute

Returns:

the value of the attribute or DomElement.ATTRIBUTE_NOT_DEFINED or DomElement.ATTRIBUTE_VALUE_EMPTY

getTypeAttribute

public final String getTypeAttribute()

Returns the value of the attribute type. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute type or the default value if that attribute isn't defined

getDisabledAttribute

public final String getDisabledAttribute()

Returns the value of the attribute disabled. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Specified by:

getDisabledAttribute in interface DisabledElement

Returns:

the value of the attribute disabled or an empty string if that attribute isn't defined

getTabIndexAttribute

public final String getTabIndexAttribute()

Returns the value of the attribute tabindex. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute tabindex or an empty string if that attribute isn't defined

getAccessKeyAttribute

public final String getAccessKeyAttribute()

Returns the value of the attribute accesskey. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute accesskey or an empty string if that attribute isn't defined

getOnFocusAttribute

public final String getOnFocusAttribute()

Returns the value of the attribute onfocus. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute onfocus or an empty string if that attribute isn't defined

getOnBlurAttribute

public final String getOnBlurAttribute()

Returns the value of the attribute onblur. Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute onblur or an empty string if that attribute isn't defined

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 HtmlElement

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

getOriginalName

public String getOriginalName()

Gets the first value of the name attribute of this field before any change.

Specified by:

getOriginalName in interface FormFieldWithNameHistory

Returns:

the original name (which is the same as the current one when no change has been made)

getNewNames

public Collection<String> getNewNames()

Get all the names this field got after the original one.

Specified by:

getNewNames in interface FormFieldWithNameHistory

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:

getDefaultStyleDisplay in class HtmlElement

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:

isEmptyXmlTagExpanded in class DomElement

Returns:

true to make generated XML readable as HTML.