elemental.html

Interface ButtonElement

All Superinterfaces:

Element, ElementTraversal, EventTarget, Node, NodeSelector

All Known Implementing Classes:

JsButtonElement

public interface ButtonElement
extends Element

DOM Button objects expose the HTMLButtonElement HTML5 (or HTMLButtonElement HTML 4) interface, which provides properties and methods (beyond the element object interface they also have available to them by inheritance) for manipulating the layout and presentation of button elements.

Field Summary

Fields inherited from interface elemental.dom.Element

ALLOW_KEYBOARD_INPUT

Fields inherited from interface elemental.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

Methods

Modifier and Type	Method and Description
boolean	checkValidity() Not supported for button elements.
FormElement	getForm() The form that this button is associated with.
String	getFormAction() The URI of a program that processes information submitted by the button.
String	getFormEnctype()
String	getFormMethod() The HTTP method that the browser uses to submit the form.
String	getFormTarget() A name or keyword indicating where to display the response that is received after submitting the form.
NodeList	getLabels() A list of <label> elements that are labels for this button.
String	getName() The name of the object when submitted with a form.
String	getType() Indicates the behavior of the button.
String	getValidationMessage() A localized message that describes the validation constraints that the control does not satisfy (if any).
ValidityState	getValidity() The validity states that this button is in.
String	getValue() The current form control value of the button.
boolean	isAutofocus() The control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control.
boolean	isDisabled() The control is disabled, meaning that it does not accept any clicks.
boolean	isFormNoValidate() Indicates that the form is not to be validated when it is submitted.
boolean	isWillValidate() Indicates whether the button is a candidate for constraint validation.
void	setAutofocus(boolean arg)
void	setCustomValidity(String error) Not supported for button elements.
void	setDisabled(boolean arg)
void	setFormAction(String arg)
void	setFormEnctype(String arg)
void	setFormMethod(String arg)
void	setFormNoValidate(boolean arg)
void	setFormTarget(String arg)
void	setName(String arg)
void	setValue(String arg)

Methods inherited from interface elemental.dom.Element

blur, click, focus, getAccessKey, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getBoundingClientRect, getChildElementCount, getChildren, getClassList, getClassName, getClientHeight, getClientLeft, getClientRects, getClientTop, getClientWidth, getContentEditable, getDataset, getDir, getElementsByClassName, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getId, getInnerHTML, getInnerText, getLang, getLastElementChild, getNextElementSibling, getOffsetHeight, getOffsetLeft, getOffsetParent, getOffsetTop, getOffsetWidth, getOnabort, getOnbeforecopy, getOnbeforecut, getOnbeforepaste, getOnblur, getOnchange, getOnclick, getOncontextmenu, getOncopy, getOncut, getOndblclick, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOnerror, getOnfocus, getOninput, getOninvalid, getOnkeydown, getOnkeypress, getOnkeyup, getOnload, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel, getOnpaste, getOnreset, getOnscroll, getOnsearch, getOnselect, getOnselectstart, getOnsubmit, getOntouchcancel, getOntouchend, getOntouchmove, getOntouchstart, getOnwebkitfullscreenchange, getOnwebkitfullscreenerror, getOuterHTML, getOuterText, getPreviousElementSibling, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getStyle, getTabIndex, getTagName, getTitle, getWebkitdropzone, getWebkitRegionOverflow, hasAttribute, hasAttributeNS, insertAdjacentElement, insertAdjacentHTML, insertAdjacentText, isContentEditable, isDraggable, isHidden, isSpellcheck, isTranslate, querySelector, querySelectorAll, removeAttribute, removeAttributeNode, removeAttributeNS, scrollByLines, scrollByPages, scrollIntoView, scrollIntoView, scrollIntoViewIfNeeded, scrollIntoViewIfNeeded, setAccessKey, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setClassName, setContentEditable, setDir, setDraggable, setHidden, setId, setInnerHTML, setInnerText, setLang, setOnabort, setOnbeforecopy, setOnbeforecut, setOnbeforepaste, setOnblur, setOnchange, setOnclick, setOncontextmenu, setOncopy, setOncut, setOndblclick, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOnerror, setOnfocus, setOninput, setOninvalid, setOnkeydown, setOnkeypress, setOnkeyup, setOnload, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnpaste, setOnreset, setOnscroll, setOnsearch, setOnselect, setOnselectstart, setOnsubmit, setOntouchcancel, setOntouchend, setOntouchmove, setOntouchstart, setOnwebkitfullscreenchange, setOnwebkitfullscreenerror, setOuterHTML, setOuterText, setScrollLeft, setScrollTop, setSpellcheck, setTabIndex, setTitle, setTranslate, setWebkitdropzone, webkitMatchesSelector, webkitRequestFullscreen, webkitRequestFullScreen

Methods inherited from interface elemental.dom.Node

addEventListener, addEventListener, appendChild, cloneNode, compareDocumentPosition, contains, dispatchEvent, getAttributes, getBaseURI, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, removeEventListener, removeEventListener, replaceChild, setNodeValue, setPrefix, setTextContent

Method Detail

isAutofocus

boolean isAutofocus()

The control should have input focus when the page loads, unless the user overrides it, for example by typing in a different control. Only one form-associated element in a document can have this attribute specified.

setAutofocus

void setAutofocus(boolean arg)

isDisabled

boolean isDisabled()

The control is disabled, meaning that it does not accept any clicks.

setDisabled

void setDisabled(boolean arg)

getForm

FormElement getForm()

The form that this button is associated with. If the button is a descendant of a form element, then this attribute is the ID of that form element.

If the button is not a descendant of a form element, then:

• HTML5 The attribute can be the ID of any form element in the same document.
• HTML 4 The attribute is null.

getFormAction

String getFormAction()

The URI of a program that processes information submitted by the button. If specified, this attribute overrides the action attribute of the <form> element that owns this element.

setFormAction

void setFormAction(String arg)

getFormEnctype

String getFormEnctype()

setFormEnctype

void setFormEnctype(String arg)

getFormMethod

String getFormMethod()

The HTTP method that the browser uses to submit the form. If specified, this attribute overrides the method attribute of the <form> element that owns this element.

setFormMethod

void setFormMethod(String arg)

isFormNoValidate

boolean isFormNoValidate()

Indicates that the form is not to be validated when it is submitted. If specified, this attribute overrides the enctype attribute of the <form> element that owns this element.

setFormNoValidate

void setFormNoValidate(boolean arg)

getFormTarget

String getFormTarget()

A name or keyword indicating where to display the response that is received after submitting the form. If specified, this attribute overrides the target attribute of the <form> element that owns this element.

setFormTarget

void setFormTarget(String arg)

getLabels

NodeList getLabels()

A list of <label> elements that are labels for this button.

getName

String getName()

The name of the object when submitted with a form. HTML5 If specified, it must not be the empty string.

setName

void setName(String arg)

getType

String getType()

Indicates the behavior of the button. This is an enumerated attribute with the following possible values:

• submit: The button submits the form. This is the default value if the attribute is not specified, HTML5 or if it is dynamically changed to an empty or invalid value.
• reset: The button resets the form.
• button: The button does nothing.

getValidationMessage

String getValidationMessage()

A localized message that describes the validation constraints that the control does not satisfy (if any). This attribute is the empty string if the control is not a candidate for constraint validation (willValidate is false), or it satisfies its constraints.

getValidity

ValidityState getValidity()

The validity states that this button is in.

getValue

String getValue()

The current form control value of the button.

setValue

void setValue(String arg)

isWillValidate

boolean isWillValidate()

Indicates whether the button is a candidate for constraint validation. It is false if any conditions bar it from constraint validation.

checkValidity

boolean checkValidity()

Not supported for button elements.

setCustomValidity

void setCustomValidity(String error)

Not supported for button elements.