Class HTMLFormElement

java.lang.Object

org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.javascript.HtmlUnitScriptable

org.htmlunit.javascript.host.event.EventTarget

org.htmlunit.javascript.host.dom.Node

org.htmlunit.javascript.host.Element

org.htmlunit.javascript.host.html.HTMLElement

org.htmlunit.javascript.host.html.HTMLFormElement

All Implemented Interfaces:

Serializable, Cloneable, org.htmlunit.corejs.javascript.Callable, org.htmlunit.corejs.javascript.ConstProperties, org.htmlunit.corejs.javascript.Constructable, org.htmlunit.corejs.javascript.debug.DebuggableObject, org.htmlunit.corejs.javascript.Function, org.htmlunit.corejs.javascript.Scriptable, org.htmlunit.corejs.javascript.SymbolScriptable

public class HTMLFormElement
extends HTMLElement
implements org.htmlunit.corejs.javascript.Function

A JavaScript object HTMLFormElement.

See Also:

• MSDN documentation
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class HTMLElement

HTMLElement.ProxyDomNode

Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class 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

Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
HTMLFormElement()	Creates an instance.

Method Summary

Modifier and Type	Method	Description
Object	call(org.htmlunit.corejs.javascript.Context cx, org.htmlunit.corejs.javascript.Scriptable scope, org.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args)
boolean	checkValidity()	Checks whether the element has any constraints and whether it satisfies them.
org.htmlunit.corejs.javascript.Scriptable	construct(org.htmlunit.corejs.javascript.Context cx, org.htmlunit.corejs.javascript.Scriptable scope, Object[] args)
boolean	dispatchEvent(Event event)	Dispatches an event into the event system (standards-conformant browsers only).
(package private) List<HtmlElement>	findElements(String name)
private HtmlElement	findFirstElement(String name)
Object	get(int index, org.htmlunit.corejs.javascript.Scriptable start)	Returns the specified indexed property.
String	getAction()	Returns the value of the property action.
HTMLCollection	getElements()	Returns the value of the property elements.
String	getEncoding()	Returns the value of the property encoding.
String	getEnctype()	Returns the value of the property enctype.
HtmlForm	getHtmlForm()
int	getLength()	Returns the value of the property length.
String	getMethod()	Returns the value of the property method.
String	getName()	Returns the value of the property name.
protected org.htmlunit.corejs.javascript.ScriptableObject	getOwnPropertyDescriptor(org.htmlunit.corejs.javascript.Context cx, Object id)	Overridden to allow the retrieval of certain form elements by ID or name.
String	getRel()	Returns the value of the rel property.
DOMTokenList	getRelList()	Returns the relList attribute.
String	getTarget()	Returns the value of the property target.
protected Object	getWithPreemption(String name)	Overridden to allow the retrieval of certain form elements by ID or name.
boolean	has(String name, org.htmlunit.corejs.javascript.Scriptable start)	Overridden to allow the retrieval of certain form elements by ID or name.
private boolean	isAccessibleByIdOrName(HtmlElement element, String name)	Indicates if the element can be reached by id or name in expressions like "myForm.myField".
boolean	isNoValidate()	Returns the value of the property novalidate.
org.htmlunit.corejs.javascript.Scriptable	iterator()
void	jsConstructor()	JavaScript constructor.
void	requestSubmit(Object submitter)	Submits the form by submitted using a specific submit button.
void	reset()	Resets this form.
void	setAction(String action)	Sets the value of the property action.
void	setEncoding(String encoding)	Sets the value of the property encoding.
void	setEnctype(String enctype)	Sets the value of the property enctype.
void	setMethod(String method)	Sets the value of the property method.
void	setName(String name)	Sets the value of the property name.
void	setNoValidate(boolean value)	Sets the value of the property novalidate.
void	setRel(String rel)	Sets the rel property.
void	setRelList(Object rel)	Sets the relList property.
void	setTarget(String target)	Sets the value of the property target.
void	submit()	Submits the form (at the end of the current script execution).

Methods inherited from class HTMLElement

blur, click, focus, getAccessKey, getAlign, getAttributeNode, getAutofocus, getBoundingClientRect, getCh, getChOff, getContentEditable, getDataset, getDir, getDomNodeOrDie, getDomNodeOrNull, getEnterKeyHint, getForm, getInnerText, getLang, getLocalName, getNodeName, getOffsetHeight, getOffsetLeft, getOffsetParent_js, getOffsetTop, getOffsetWidth, getOnabort, getOnanimationcancel, getOnanimationend, getOnanimationiteration, getOnanimationstart, getOnauxclick, getOnblur, getOncancel, getOncanplay, getOncanplaythrough, getOnchange, getOnclick, getOnclose, getOncontextmenu, getOncopy, getOncuechange, getOncut, getOndblclick, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOndurationchange, getOnemptied, getOnended, getOnerror, getOnfocus, getOngotpointercapture, getOninput, getOninvalid, getOnkeydown, getOnkeypress, getOnkeyup, getOnload, getOnloadeddata, getOnloadedmetadata, getOnloadstart, getOnlostpointercapture, getOnmousedown, getOnmouseenter, getOnmouseleave, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel, getOnmozfullscreenchange, getOnmozfullscreenerror, getOnpaste, getOnpause, getOnplay, getOnplaying, getOnpointercancel, getOnpointerdown, getOnpointerenter, getOnpointerleave, getOnpointermove, getOnpointerout, getOnpointerover, getOnpointerup, getOnprogress, getOnratechange, getOnreset, getOnresize, getOnscroll, getOnscrollend, getOnseeked, getOnseeking, getOnselect, getOnselectionchange, getOnselectstart, getOnstalled, getOnsubmit, getOnsuspend, getOntimeupdate, getOntoggle, getOntransitioncancel, getOntransitionend, getOntransitionrun, getOntransitionstart, getOnvolumechange, getOnwaiting, getOnwheel, getOuterText, getParentHTMLElement, getPosX, getPosY, getPrefix, getStyle, getTabIndex, getTitle, getVAlign, getValue, getWidthOrHeight, isAncestorOfEventTarget, isDisabled, isEndTagForbidden, isHidden, isIsContentEditable, isLowerCaseInOuterHtml, isSpellcheck, setAccessKey, setAlign, setAttribute, setAutofocus, setCh, setChOff, setColorAttribute, setContentEditable, setDir, setDisabled, setDomNode, setEnterKeyHint, setHidden, setInnerText, setLang, setOnabort, setOnanimationcancel, setOnanimationend, setOnanimationiteration, setOnanimationstart, setOnauxclick, setOnblur, setOncancel, setOncanplay, setOncanplaythrough, setOnchange, setOnclick, setOnclose, setOncontextmenu, setOncopy, setOncuechange, setOncut, setOndblclick, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOndurationchange, setOnemptied, setOnended, setOnerror, setOnfocus, setOngotpointercapture, setOninput, setOninvalid, setOnkeydown, setOnkeypress, setOnkeyup, setOnload, setOnloadeddata, setOnloadedmetadata, setOnloadstart, setOnlostpointercapture, setOnmousedown, setOnmouseenter, setOnmouseleave, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnmozfullscreenchange, setOnmozfullscreenerror, setOnpaste, setOnpause, setOnplay, setOnplaying, setOnpointercancel, setOnpointerdown, setOnpointerenter, setOnpointerleave, setOnpointermove, setOnpointerout, setOnpointerover, setOnpointerup, setOnprogress, setOnratechange, setOnreset, setOnresize, setOnscroll, setOnscrollend, setOnseeked, setOnseeking, setOnselect, setOnselectionchange, setOnselectstart, setOnstalled, setOnsubmit, setOnsuspend, setOntimeupdate, setOntoggle, setOntransitioncancel, setOntransitionend, setOntransitionrun, setOntransitionstart, setOnvolumechange, setOnwaiting, setOnwheel, setOuterText, setSpellcheck, setStyle, setTabIndex, setTextContent, setTitle, setVAlign, setValue, setWidthOrHeight, toString

Methods inherited from class Element

after, append, before, closest, createAttributesObject, createEventHandler, getAttribute, getAttributeNodeNS, getAttributeNS, getAttributes, getChildElementCount, getChildren, getClassList, getClassName_js, getClientHeight, getClientLeft, getClientRects, getClientTop, getClientWidth, getElementsByClassName, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getId, getInnerHTML, getInnerHTML, getLastElementChild, getNamespaceURI, getNextElementSibling, getOnbeforecopy, getOnbeforecut, getOnbeforepaste, getOnsearch, getOnwebkitfullscreenchange, getOnwebkitfullscreenerror, getOuterHTML, getParentElement, getPreviousElementSibling, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getTagName, hasAttribute, hasAttributeNS, hasAttributes, innerHTML, insertAdjacentElement, insertAdjacentHTML, insertAdjacentText, isDisplayNone, matches, mozMatchesSelector, prepend, printChildren, printNode, querySelector, querySelectorAll, releaseCapture, remove, removeAttribute, removeAttributeNode, removeAttributeNS, replaceChildren, replaceWith, scroll, scrollBy, scrollIntoView, scrollIntoViewIfNeeded, scrollTo, setAttributeNode, setAttributeNS, setCapture, setClassName_js, setId, setInnerHTML, setOnbeforecopy, setOnbeforecut, setOnbeforepaste, setOnsearch, setOnwebkitfullscreenchange, setOnwebkitfullscreenerror, setOuterHTML, setScrollLeft, setScrollTop, toggleAttribute, webkitMatchesSelector

Methods inherited from class Node

after, append, appendChild, before, cloneNode, compareDocumentPosition, contains, getBaseURI, getChildNodes, getFirstChild, getJavaScriptNode, getLastChild, getNextSibling, getNodeType, getNodeValue, getOwnerDocument, getParent, getParentNode, getPreviousSibling, getRootNode, getTextContent, hasChildNodes, insertBefore, insertBeforeImpl, isEqualNode, isSameNode, normalize, prepend, removeChild, replaceChild, replaceChildren, replaceWith, setNodeValue

Methods inherited from class EventTarget

addEventListener, clearEventListenersContainer, executeEventLocally, fireEvent, getEventHandler, getEventListenersContainer, hasEventHandlers, isEventHandlerOnWindow, removeEventListener, setEventHandler

Methods inherited from class HtmlUnitScriptable

clone, equivalentValues, get, getBrowserVersion, getClassName, getDefaultValue, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setParentScope, setupPromise, setupRejectedPromise

Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.htmlunit.corejs.javascript.Scriptable

delete, delete, get, getClassName, getDefaultValue, getIds, getParentScope, getPrototype, has, hasInstance, put, put, setParentScope, setPrototype

Constructor Details

HTMLFormElement

public HTMLFormElement()

Creates an instance.

Method Details

jsConstructor

public void jsConstructor()

JavaScript constructor.

Overrides:

jsConstructor in class HTMLElement

getName

public String getName()

Returns the value of the property name.

Overrides:

getName in class HTMLElement

Returns:

the value of this property

setName

public void setName(String name)

Sets the value of the property name.

Overrides:

setName in class HTMLElement

Parameters:

name - the new value

getElements

public HTMLCollection getElements()

Returns the value of the property elements.

Returns:

the value of this property

iterator

public org.htmlunit.corejs.javascript.Scriptable iterator()

getLength

public int getLength()

Returns the value of the property length. Does not count input type=image elements (MSDN doc)

Returns:

the value of this property

getAction

public String getAction()

Returns the value of the property action.

Returns:

the value of this property

setAction

public void setAction(String action)

Sets the value of the property action.

Parameters:

action - the new value

getMethod

public String getMethod()

Returns the value of the property method.

Returns:

the value of this property

setMethod

public void setMethod(String method)

Sets the value of the property method.

Parameters:

method - the new property

getTarget

public String getTarget()

Returns the value of the property target.

Returns:

the value of this property

setTarget

public void setTarget(String target)

Sets the value of the property target.

Parameters:

target - the new value

getRel

public String getRel()

Returns the value of the rel property.

Returns:

the rel property

setRel

public void setRel(String rel)

Sets the rel property.

Parameters:

rel - rel attribute value

getRelList

public DOMTokenList getRelList()

Returns the relList attribute.

Returns:

the relList attribute

setRelList

public void setRelList(Object rel)

Sets the relList property.

Parameters:

rel - attribute value

getEnctype

public String getEnctype()

Returns the value of the property enctype.

Returns:

the value of this property

setEnctype

public void setEnctype(String enctype)

Sets the value of the property enctype.

Parameters:

enctype - the new value

getEncoding

public String getEncoding()

Returns the value of the property encoding.

Returns:

the value of this property

setEncoding

public void setEncoding(String encoding)

Sets the value of the property encoding.

Parameters:

encoding - the new value

getHtmlForm

public HtmlForm getHtmlForm()

Returns:

the associated HtmlForm

submit

public void submit()

Submits the form (at the end of the current script execution).

requestSubmit

public void requestSubmit(Object submitter)

Submits the form by submitted using a specific submit button.

Parameters:

submitter - The submit button whose attributes describe the method by which the form is to be submitted. This may be either an <input> or <button> element whose type attribute is submit. If you omit the submitter parameter, the form element itself is used as the submitter.

reset

public void reset()

Resets this form.

getWithPreemption

protected Object getWithPreemption(String name)

Overridden to allow the retrieval of certain form elements by ID or name.

Overrides:

getWithPreemption in class HtmlUnitScriptable

Parameters:

name - the property name

Returns:

Scriptable.NOT_FOUND if not found

has

public boolean has(String name,
 org.htmlunit.corejs.javascript.Scriptable start)

Overridden to allow the retrieval of certain form elements by ID or name.

Specified by:

has in interface org.htmlunit.corejs.javascript.Scriptable

Overrides:

has in class org.htmlunit.corejs.javascript.ScriptableObject

Parameters:

name -

start -

Returns:

getOwnPropertyDescriptor

protected org.htmlunit.corejs.javascript.ScriptableObject getOwnPropertyDescriptor(org.htmlunit.corejs.javascript.Context cx,
 Object id)

Overridden to allow the retrieval of certain form elements by ID or name.

Overrides:

getOwnPropertyDescriptor in class org.htmlunit.corejs.javascript.ScriptableObject

Parameters:

cx -

id -

Returns:

findElements

List<HtmlElement> findElements(String name)

findFirstElement

private HtmlElement findFirstElement(String name)

isAccessibleByIdOrName

private boolean isAccessibleByIdOrName(HtmlElement element,
 String name)

Indicates if the element can be reached by id or name in expressions like "myForm.myField".

Parameters:

element - the element to test

name - the name used to address the element

Returns:

true if this element matches the conditions

get

public Object get(int index,
 org.htmlunit.corejs.javascript.Scriptable start)

Returns the specified indexed property.

Specified by:

get in interface org.htmlunit.corejs.javascript.Scriptable

Overrides:

get in class org.htmlunit.corejs.javascript.ScriptableObject

Parameters:

index - the index of the property

start - the scriptable object that was originally queried for this property

Returns:

the property

call

public Object call(org.htmlunit.corejs.javascript.Context cx,
 org.htmlunit.corejs.javascript.Scriptable scope,
 org.htmlunit.corejs.javascript.Scriptable thisObj,
 Object[] args)

Specified by:

call in interface org.htmlunit.corejs.javascript.Callable

Specified by:

call in interface org.htmlunit.corejs.javascript.Function

construct

public org.htmlunit.corejs.javascript.Scriptable construct(org.htmlunit.corejs.javascript.Context cx,
 org.htmlunit.corejs.javascript.Scriptable scope,
 Object[] args)

Specified by:

construct in interface org.htmlunit.corejs.javascript.Constructable

Specified by:

construct in interface org.htmlunit.corejs.javascript.Function

dispatchEvent

public boolean dispatchEvent(Event event)

Description copied from class: EventTarget

Dispatches an event into the event system (standards-conformant browsers only). See the Gecko DOM reference for more information.

Overrides:

dispatchEvent in class EventTarget

Parameters:

event - the event to be dispatched

Returns:

false if at least one of the event handlers which handled the event called preventDefault; true otherwise

checkValidity

public boolean checkValidity()

Checks whether the element has any constraints and whether it satisfies them.

Returns:

if the element is valid

isNoValidate

public boolean isNoValidate()

Returns the value of the property novalidate.

Returns:

the value of this property

setNoValidate

public void setNoValidate(boolean value)

Sets the value of the property novalidate.

Parameters:

value - the new value