public class HtmlButton extends HtmlElement implements DisabledElement, SubmittableElement, LabelableElement, FormFieldWithNameHistory, ValidatableElement
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.
|
ATTRIBUTE_CHECKED, ATTRIBUTE_HIDDEN, ATTRIBUTE_REQUIRED, TAB_INDEX_OUT_OF_BOUNDS
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, ID_ATTRIBUTE, NAME_ATTRIBUTE, SRC_ATTRIBUTE, TYPE_ATTRIBUTE, VALUE_ATTRIBUTE
PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED
ATTRIBUTE_DISABLED
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
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 . |
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
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 |
getType() |
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 |
isCustomErrorValidityState() |
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 "/>")
|
boolean |
isFormNoValidate() |
boolean |
isReadOnly()
Returns
true if this element is read only. |
boolean |
isValid()
Returns whether this element satisfies all form validation constraints set.
|
boolean |
isValidValidityState() |
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 |
setCustomValidity(String message)
Sets the custom validity message for the element to the specified message.
|
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 |
setFormNoValidate(boolean noValidate)
Sets the value of the attribute
formnovalidate . |
void |
setValueAttribute(String newValue)
Sets the content of the
value attribute. |
boolean |
willValidate() |
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, notifyAttributeChangeListeners, removeAttribute, removeChild, removeHtmlAttributeChangeListener, setAttributeNode, setHidden, setHidden, setOwningForm, setRequired, type, type, type, type, typeDone
blur, click, click, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, fireEvent, fireEvent, focus, getAttribute, getAttributeDirect, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNodeType, getSchemaTypeInfo, getStaticElementsByTagName, 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, setDefaults, setId, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setInnerHtml, setNodeValue, toString, writeStyleToElement
getLocalName, getLowercaseName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix
addCharacterDataChangeListener, addDomChangeListener, appendChild, asNormalizedText, asXml, basicRemove, closest, 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, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, parseHtmlSnippet, printChildrenAsXml, querySelector, querySelectorAll, quietlyRemoveAndMoveChildrenTo, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setEndLocation, setParentNode, setReadyState, setScriptableObject, setStartLocation, setTextContent, setUserData
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
hasBadInputValidityState, hasPatternMismatchValidityState, hasRangeOverflowValidityState, hasRangeUnderflowValidityState, hasTypeMismatchValidityState, isStepMismatchValidityState, isTooLongValidityState, isTooShortValidityState, isValueMissingValidityState
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
public static final String TAG_NAME
public void setValueAttribute(String newValue)
value
attribute.newValue
- the new contentprotected boolean doClickStateUpdate(boolean shiftKey, boolean ctrlKey) throws IOException
The default implementation only calls doClickStateUpdate on parent's DomElement (if any).
Subclasses requiring different behavior (like HtmlSubmitInput
) will override this method.
doClickStateUpdate
in class DomElement
shiftKey
- true
if SHIFT is pressedctrlKey
- true
if CTRL is pressedIOException
- if an IO error occurspublic final boolean isDisabled()
true
if the disabled attribute is set for this element.isDisabled
in interface DisabledElement
true
if the disabled attribute is set for this elementpublic boolean isReadOnly()
true
if this element is read only.true
if this element is read onlypublic NameValuePair[] getSubmitNameValuePairs()
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.
getSubmitNameValuePairs
in interface SubmittableElement
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)
public 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()
false
; only checkboxes and radio buttons really care what
the default checked value is.isDefaultChecked
in interface SubmittableElement
SubmittableElement.isDefaultChecked()
,
HtmlRadioButtonInput.isDefaultChecked()
,
HtmlCheckBoxInput.isDefaultChecked()
public boolean handles(Event event)
handles
in class HtmlElement
event
- the eventfalse
if the event can't be appliedpublic final String getNameAttribute()
name
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.name
or an empty string if that attribute isn't definedpublic final String getValueAttribute()
value
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.value
or an empty string if that attribute isn't definedpublic final String getTypeAttribute()
type
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.type
or the default value if that attribute isn't definedpublic String getType()
public final String getDisabledAttribute()
disabled
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.getDisabledAttribute
in interface DisabledElement
disabled
or an empty string if that attribute isn't definedpublic final String getTabIndexAttribute()
tabindex
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.tabindex
or an empty string if that attribute isn't definedpublic final String getAccessKeyAttribute()
accesskey
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.accesskey
or an empty string if that attribute isn't definedpublic final String getOnFocusAttribute()
onfocus
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.onfocus
or an empty string if that attribute isn't definedpublic final String getOnBlurAttribute()
onblur
. Refer to the
HTML 4.01
documentation for details on the use of this attribute.onblur
or an empty string if that attribute isn't definedprotected void setAttributeNS(String namespaceURI, String qualifiedName, String attributeValue, boolean notifyAttributeChangeListeners, boolean notifyMutationObservers)
setAttributeNS
in class HtmlElement
namespaceURI
- the URI that identifies an XML namespacequalifiedName
- the qualified name (prefix:local) of the attributeattributeValue
- the value of the attributenotifyAttributeChangeListeners
- to notify the associated HtmlAttributeChangeListener
snotifyMutationObservers
- to notify MutationObserver
s or notpublic String getOriginalName()
name
attribute of this field before any change.getOriginalName
in interface FormFieldWithNameHistory
public Collection<String> getNewNames()
getNewNames
in interface FormFieldWithNameHistory
public HtmlElement.DisplayStyle getDefaultStyleDisplay()
getDefaultStyleDisplay
in class HtmlElement
protected boolean isEmptyXmlTagExpanded()
isEmptyXmlTagExpanded
in class DomElement
true
to make generated XML readable as HTML.public boolean isValid()
isValid
in class HtmlElement
public boolean willValidate()
willValidate
in interface ValidatableElement
public void setCustomValidity(String message)
setCustomValidity
in interface ValidatableElement
message
- the new messagepublic boolean isCustomErrorValidityState()
isCustomErrorValidityState
in interface ValidatableElement
public boolean isValidValidityState()
isValidValidityState
in interface ValidatableElement
public final boolean isFormNoValidate()
formnovalidate
or an empty string if that attribute isn't definedpublic final void setFormNoValidate(boolean noValidate)
formnovalidate
.noValidate
- the value of the attribute formnovalidate
Copyright © 2002–2024 Gargoyle Software Inc.. All rights reserved.