com.gargoylesoftware.htmlunit.javascript.host.html

Class HTMLFormElement

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

com.gargoylesoftware.htmlunit.javascript.host.dom.Node

com.gargoylesoftware.htmlunit.javascript.host.Element

com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement

com.gargoylesoftware.htmlunit.javascript.host.html.HTMLFormElement

All Implemented Interfaces:

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

public class HTMLFormElement
extends HTMLElement
implements net.sourceforge.htmlunit.corejs.javascript.Function

A JavaScript object for HTMLFormElement.

Author:

Mike Bowler, Daniel Gredler, Kent Tong, Chris Erskine, Marc Guillemot, Ahmed Ashour, Sudhan Moghe, Ronald Brill, Frank Danek

See Also:

MSDN documentation, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement

HTMLElement.ProxyDomNode

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

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement

BEHAVIOR_ID_CLIENT_CAPS, BEHAVIOR_ID_DOWNLOAD, BEHAVIOR_ID_HOMEPAGE

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.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

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
HTMLFormElement() Creates an instance.

Method Summary

Modifier and Type	Method and Description
Object	call(net.sourceforge.htmlunit.corejs.javascript.Context cx, net.sourceforge.htmlunit.corejs.javascript.Scriptable scope, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args)
boolean	checkValidity() Checks whether the element has any constraints and whether it satisfies them.
net.sourceforge.htmlunit.corejs.javascript.Scriptable	construct(net.sourceforge.htmlunit.corejs.javascript.Context cx, net.sourceforge.htmlunit.corejs.javascript.Scriptable scope, Object[] args)
boolean	dispatchEvent(Event event) Dispatches an event into the event system (standards-conformant browsers only).
Object	get(int index, net.sourceforge.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.
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.
Object	item(Object index, Object subIndex) Retrieves a form object or an object from an elements collection.
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	setHtmlElement(HtmlElement htmlElement) Sets the HTML element that corresponds to this JavaScript object.
void	setMethod(String method) Sets the value of the property method.
void	setName(String name) Sets the value of the property name.
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 com.gargoylesoftware.htmlunit.javascript.host.html.HTMLElement

addBehavior, addComponentRequest, blur, clearAttributes, clearComponentRequest, click, compareVersions, contains, doComponentRequest, focus, getAccessKey, getAlign, getAttributeNode, getAvailHeight, getAvailWidth, getBoundingClientRect, getBufferDepth, getCh, getChildren, getChOff, getClassList, getClassName_js, getColorDepth, getComponentVersion, getContentEditable, getCpuClass, getCurrentStyle, getDataset, getDir, getDomNodeOrDie, getDomNodeOrNull, getElementsByClassName, getForm, getHeight, getId, getInnerHTML, getInnerText, getLang, getLanguage, getLocalName, getNodeName, getOffsetHeight, getOffsetLeft, getOffsetParent_js, getOffsetTop, getOffsetWidth, getOnabort, getOnactivate, getOnanimationcancel, getOnanimationend, getOnanimationiteration, getOnanimationstart, getOnauxclick, getOnbeforeactivate, getOnbeforecopy, getOnbeforecut, getOnbeforedeactivate, getOnbeforepaste, getOnblur, getOncancel, getOncanplay, getOncanplaythrough, getOnchange, getOnclick, getOnclose, getOncontextmenu, getOncopy, getOncuechange, getOncut, getOndblclick, getOndeactivate, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOndurationchange, getOnemptied, getOnended, getOnerror, getOnfocus, getOnfocusin, getOnfocusout, getOngotpointercapture, getOnhelp, getOninput, getOninvalid, getOnkeydown, getOnkeypress, getOnkeyup, getOnload, getOnloadeddata, getOnloadedmetadata, getOnloadstart, getOnlostpointercapture, getOnmousedown, getOnmouseenter, getOnmouseleave, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel, getOnmozfullscreenchange, getOnmozfullscreenerror, getOnmscontentzoom, getOnmsmanipulationstatechanged, getOnpaste, getOnpause, getOnplay, getOnplaying, getOnpointercancel, getOnpointerdown, getOnpointerenter, getOnpointerleave, getOnpointermove, getOnpointerout, getOnpointerover, getOnpointerup, getOnprogress, getOnratechange, getOnreset, getOnresize, getOnscroll, getOnseeked, getOnseeking, getOnselect, getOnselectionchange, getOnselectstart, getOnshow, getOnstalled, getOnsubmit, getOnsuspend, getOntimeupdate, getOntoggle, getOntransitioncancel, getOntransitionend, getOntransitionrun, getOntransitionstart, getOnvolumechange, getOnwaiting, getOnwheel, getOuterHTML, getParentElement, getParentHTMLElement, getPlatform, getPosX, getPosY, getPrefix, getRuntimeStyle, getStyle, getSystemLanguage, getTabIndex, getTitle, getUniqueID, getUserLanguage, getVAlign, getValue, getWidth, getWidthOrHeight, insertAdjacentElement, insertAdjacentHTML, insertAdjacentText, isAncestorOfEventTarget, isComponentInstalled, isCookieEnabled, isDisabled, isEndTagForbidden, isHidden, isHomePage, isIsContentEditable, isJavaEnabled, isLowerCaseInOuterHtml, isSpellcheck, mergeAttributes, navigateHomePage, readAttributes, releaseCapture, removeBehavior, removeNode, scrollIntoView, setAccessKey, setActive, setAlign, setAttribute, setCapture, setCh, setChOff, setClassName_js, setColorAttribute, setContentEditable, setDir, setDisabled, setDomNode, setHidden, setHomePage, setId, setInnerHTML, setInnerText, setLang, setLanguage, setOnabort, setOnactivate, setOnanimationcancel, setOnanimationend, setOnanimationiteration, setOnanimationstart, setOnauxclick, setOnbeforeactivate, setOnbeforecopy, setOnbeforecut, setOnbeforedeactivate, setOnbeforepaste, setOnblur, setOncancel, setOncanplay, setOncanplaythrough, setOnchange, setOnclick, setOnclose, setOncontextmenu, setOncopy, setOncuechange, setOncut, setOndblclick, setOndeactivate, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOndurationchange, setOnemptied, setOnended, setOnerror, setOnfocus, setOnfocusin, setOnfocusout, setOngotpointercapture, setOnhelp, setOninput, setOninvalid, setOnkeydown, setOnkeypress, setOnkeyup, setOnload, setOnloadeddata, setOnloadedmetadata, setOnloadstart, setOnlostpointercapture, setOnmousedown, setOnmouseenter, setOnmouseleave, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnmozfullscreenchange, setOnmozfullscreenerror, setOnmscontentzoom, setOnmsmanipulationstatechanged, setOnpaste, setOnpause, setOnplay, setOnplaying, setOnpointercancel, setOnpointerdown, setOnpointerenter, setOnpointerleave, setOnpointermove, setOnpointerout, setOnpointerover, setOnpointerup, setOnprogress, setOnratechange, setOnreset, setOnresize, setOnscroll, setOnseeked, setOnseeking, setOnselect, setOnselectionchange, setOnselectstart, setOnshow, setOnstalled, setOnsubmit, setOnsuspend, setOntimeupdate, setOntoggle, setOntransitioncancel, setOntransitionend, setOntransitionrun, setOntransitionstart, setOnvolumechange, setOnwaiting, setOnwheel, setOuterHTML, setSpellcheck, setStyle, setTabIndex, setTextContent, setTitle, setVAlign, setValue, setWidthOrHeight, startDownload, toString

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.Element

after, before, createAttributesObject, createEventHandler, createTextRange, get, getAttribute, getAttributeNodeNS, getAttributeNS, getAttributes, getChildElementCount, getClientHeight, getClientLeft, getClientRects, getClientTop, getClientWidth, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getInnerHTML, getLastElementChild, getNamespaceURI, getNextElementSibling, getOnmsgesturechange, getOnmsgesturedoubletap, getOnmsgestureend, getOnmsgesturehold, getOnmsgesturestart, getOnmsgesturetap, getOnmsgotpointercapture, getOnmsinertiastart, getOnmslostpointercapture, getOnmspointercancel, getOnmspointerdown, getOnmspointerenter, getOnmspointerleave, getOnmspointermove, getOnmspointerout, getOnmspointerover, getOnmspointerup, getOnsearch, getOnwebkitfullscreenchange, getOnwebkitfullscreenerror, getPreviousElementSibling, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getTagName, hasAttribute, hasAttributeNS, hasAttributes, innerHTML, isDisplayNone, matches, mozMatchesSelector, msMatchesSelector, printChildren, printNode, querySelector, querySelectorAll, remove, removeAttribute, removeAttributeNode, removeAttributeNS, replaceWith, scrollIntoViewIfNeeded, setAttributeNode, setAttributeNS, setDefaults, setOnmsgesturechange, setOnmsgesturedoubletap, setOnmsgestureend, setOnmsgesturehold, setOnmsgesturestart, setOnmsgesturetap, setOnmsgotpointercapture, setOnmsinertiastart, setOnmslostpointercapture, setOnmspointercancel, setOnmspointerdown, setOnmspointerenter, setOnmspointerleave, setOnmspointermove, setOnmspointerout, setOnmspointerover, setOnmspointerup, setOnsearch, setOnwebkitfullscreenchange, setOnwebkitfullscreenerror, setScrollLeft, setScrollTop, webkitMatchesSelector

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.Node

appendChild, asJavaScriptException, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFirstChild, getJavaScriptNode, getLastChild, getNextSibling, getNodeType, getNodeValue, getOwnerDocument, getParent, getParentNode, getPreviousSibling, getTextContent, hasChildNodes, insertBefore, insertBeforeImpl, isSameNode, normalize, removeChild, replaceChild, setNodeValue

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.event.EventTarget

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

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, getBrowserVersion, getDefaultValue, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, has, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, put, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, 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 java.lang.Object

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

Methods inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

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

Constructor Detail

HTMLFormElement

public HTMLFormElement()

Creates an instance.

Method Detail

setHtmlElement

public void setHtmlElement(HtmlElement htmlElement)

Sets the HTML element that corresponds to this JavaScript object.

Overrides:

setHtmlElement in class SimpleScriptable

Parameters:

htmlElement - the HTML element

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

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

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.

item

public Object item(Object index,
                   Object subIndex)

Retrieves a form object or an object from an elements collection.

Parameters:

index - Integer or String that specifies the object or collection to retrieve. If this parameter is an integer, it is the zero-based index of the object. If this parameter is a string, all objects with matching name or id properties are retrieved, and a collection is returned if more than one match is made

subIndex - Optional. Integer that specifies the zero-based index of the object to retrieve when a collection is returned

Returns:

an object or a collection of objects if successful, or null otherwise

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 SimpleScriptable

Parameters:

name - the property name

Returns:

Scriptable.NOT_FOUND if not found

get

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

Returns the specified indexed property.

Specified by:

get in interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

Overrides:

get in class net.sourceforge.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(net.sourceforge.htmlunit.corejs.javascript.Context cx,
                   net.sourceforge.htmlunit.corejs.javascript.Scriptable scope,
                   net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
                   Object[] args)

Specified by:

call in interface net.sourceforge.htmlunit.corejs.javascript.Callable

Specified by:

call in interface net.sourceforge.htmlunit.corejs.javascript.Function

construct

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

Specified by:

construct in interface net.sourceforge.htmlunit.corejs.javascript.Constructable

Specified by:

construct in interface net.sourceforge.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