com.gargoylesoftware.htmlunit.javascript.host

Class HTMLFormElement

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Node

com.gargoylesoftware.htmlunit.javascript.host.Element

com.gargoylesoftware.htmlunit.javascript.host.HTMLElement

com.gargoylesoftware.htmlunit.javascript.host.HTMLFormElement

All Implemented Interfaces:

ScriptableWithFallbackGetter, Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class HTMLFormElement
extends HTMLElement

A JavaScript object for a Form.

Version:

$Revision: 2132 $

Author:

Mike Bowler, Daniel Gredler, Kent Tong, Chris Erskine, Marc Guillemot, Ahmed Ashour

See Also:

MSDN documentation, Serialized Form

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
HTMLFormElement() Creates an instance.

Method Summary

Methods

Modifier and Type	Method and Description
Object	get(int index, org.mozilla.javascript.Scriptable start) Return the specified indexed property
protected Object	getWithPreemption(String name) Overridden to allow the retrieval of certain form elements by ID or name.
void	jsConstructor() Javascript constructor.
void	jsxFunction_reset() Reset this form
void	jsxFunction_submit() Submit the form.
String	jsxGet_action() Return the value of the javascript attribute "action".
HTMLCollection	jsxGet_elements() Return the value of the javascript attribute "elements".
String	jsxGet_encoding() Return the value of the javascript attribute "encoding".
int	jsxGet_length() Return the value of the javascript attribute "length".
String	jsxGet_method() Return the value of the javascript attribute "method".
String	jsxGet_name() Return the value of the javascript attribute "name".
Object	jsxGet_onsubmit() Get the onsubmit event handler for this element.
String	jsxGet_target() Return the value of the javascript attribute "target".
void	jsxSet_action(String action) Set the value of the javascript attribute "action".
void	jsxSet_encoding(String encoding) Set the value of the javascript attribute "encoding".
void	jsxSet_method(String method) Set the value of the javascript attribute "method".
void	jsxSet_name(String name) Set the value of the javascript attribute "name".
void	jsxSet_onsubmit(Object onsubmit) Set the onsubmit event handler for this element.
void	jsxSet_target(String target) Set the value of the javascript attribute "target".
void	setHtmlElement(HtmlElement htmlElement) Set the html element that corresponds to this javascript object

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

addComponentRequest, clearComponentRequest, compareVersions, doComponentRequest, getAvailHeight, getAvailWidth, getBoxObject, getBufferDepth, getColorDepth, getComponentVersion, getConnectionType, getCookieEnabled, getCpuClass, getHeight, getHtmlElementOrDie, getHtmlElementOrNull, getJavaEnabled, getPlatform, getSystemLanguage, getUserLanguage, getWidth, getWithFallback, isComponentInstalled, isHomePage, jsxFunction_addBehavior, jsxFunction_blur, jsxFunction_dispatchEvent, jsxFunction_fireEvent, jsxFunction_focus, jsxFunction_getAttribute, jsxFunction_getAttributeNode, jsxFunction_getAttributeNS, jsxFunction_getBoundingClientRect, jsxFunction_getClientRects, jsxFunction_getElementsByTagName, jsxFunction_hasAttribute, jsxFunction_hasAttributeNS, jsxFunction_insertAdjacentElement, jsxFunction_insertAdjacentHTML, jsxFunction_removeAttribute, jsxFunction_removeBehavior, jsxFunction_removeExpression, jsxFunction_scrollIntoView, jsxFunction_setAttribute, jsxFunction_setAttributeNode, jsxFunction_setAttributeNS, jsxFunction_setExpression, jsxGet_all, jsxGet_attributes, jsxGet_children, jsxGet_className, jsxGet_currentStyle, jsxGet_disabled, jsxGet_id, jsxGet_innerHTML, jsxGet_innerText, jsxGet_localName, jsxGet_namespaceURI, jsxGet_offsetHeight, jsxGet_offsetLeft, jsxGet_offsetParent, jsxGet_offsetTop, jsxGet_offsetWidth, jsxGet_onblur, jsxGet_onclick, jsxGet_oncontextmenu, jsxGet_ondblclick, jsxGet_onfocus, jsxGet_onkeydown, jsxGet_onkeypress, jsxGet_onkeyup, jsxGet_onmousedown, jsxGet_onmousemove, jsxGet_onmouseout, jsxGet_onmouseover, jsxGet_onmouseup, jsxGet_onresize, jsxGet_outerHTML, jsxGet_ownerDocument, jsxGet_parentElement, jsxGet_prefix, jsxGet_runtimeStyle, jsxGet_scrollHeight, jsxGet_scrollLeft, jsxGet_scrollTop, jsxGet_scrollWidth, jsxGet_style, jsxGet_tagName, jsxGet_title, jsxGet_uniqueID, jsxSet_className, jsxSet_disabled, jsxSet_id, jsxSet_innerHTML, jsxSet_innerText, jsxSet_onblur, jsxSet_onclick, jsxSet_oncontextmenu, jsxSet_ondblclick, jsxSet_onfocus, jsxSet_onkeydown, jsxSet_onkeypress, jsxSet_onkeyup, jsxSet_onmousedown, jsxSet_onmousemove, jsxSet_onmouseout, jsxSet_onmouseover, jsxSet_onmouseup, jsxSet_onresize, jsxSet_outerHTML, jsxSet_scrollLeft, jsxSet_scrollTop, jsxSet_title, navigateHomePage, readAttributes, setDomNode, setHomePage, startDownload, toString

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

executeEvent, fireEvent, getEventHandler, getEventHandlerProp, getJavaScriptNode, jsxFunction_addEventListener, jsxFunction_appendChild, jsxFunction_attachEvent, jsxFunction_cloneNode, jsxFunction_detachEvent, jsxFunction_hasChildNodes, jsxFunction_insertBefore, jsxFunction_isSameNode, jsxFunction_removeChild, jsxFunction_removeEventListener, jsxFunction_replaceChild, jsxGet_childNodes, jsxGet_firstChild, jsxGet_lastChild, jsxGet_nextSibling, jsxGet_nodeName, jsxGet_nodeType, jsxGet_nodeValue, jsxGet_parentNode, jsxGet_previousSibling, jsxSet_nodeValue, setEventHandler, setEventHandlerProp

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

get, getBooleanArg, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getIntArg, getLog, getObjectArg, getPrototype, getScriptableFor, getStartingScope, getStringArg, getTransformerScriptableFor, getWindow, getWindow, makeScriptableFor, setDomNode

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.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. A default constructor is required for all JavaScript objects.

Method Detail

jsConstructor

public final void jsConstructor()

Javascript constructor. This must be declared in every javascript file because the rhino engine won't walk up the hierarchy looking for constructors.

setHtmlElement

public void setHtmlElement(HtmlElement htmlElement)

Set the html element that corresponds to this javascript object

Overrides:

setHtmlElement in class SimpleScriptable

Parameters:

htmlElement - The html element

jsxGet_name

public String jsxGet_name()

Return the value of the javascript attribute "name".

Returns:

The value of this attribute.

jsxSet_name

public void jsxSet_name(String name)

Set the value of the javascript attribute "name".

Parameters:

name - The new value.

jsxGet_elements

public HTMLCollection jsxGet_elements()

Return the value of the javascript attribute "elements".

Returns:

The value of this attribute.

jsxGet_length

public int jsxGet_length()

Return the value of the javascript attribute "length". Does not count input type=image elements as browsers (IE6, Mozilla 1.7) do (cf MSDN doc)

Returns:

The value of this attribute.

jsxGet_action

public String jsxGet_action()

Return the value of the javascript attribute "action".

Returns:

The value of this attribute.

jsxSet_action

public void jsxSet_action(String action)

Set the value of the javascript attribute "action".

Parameters:

action - The new value.

jsxGet_method

public String jsxGet_method()

Return the value of the javascript attribute "method".

Returns:

The value of this attribute.

jsxSet_method

public void jsxSet_method(String method)

Set the value of the javascript attribute "method".

Parameters:

method - The new value.

jsxGet_target

public String jsxGet_target()

Return the value of the javascript attribute "target".

Returns:

The value of this attribute.

jsxGet_onsubmit

public Object jsxGet_onsubmit()

Get the onsubmit event handler for this element.

Returns:

org.mozilla.javascript.Function

jsxSet_onsubmit

public void jsxSet_onsubmit(Object onsubmit)

Set the onsubmit event handler for this element.

Parameters:

onsubmit - the new handler

jsxSet_target

public void jsxSet_target(String target)

Set the value of the javascript attribute "target".

Parameters:

target - The new value.

jsxGet_encoding

public String jsxGet_encoding()

Return the value of the javascript attribute "encoding".

Returns:

The value of this attribute.

jsxSet_encoding

public void jsxSet_encoding(String encoding)

Set the value of the javascript attribute "encoding".

Parameters:

encoding - The new value.

jsxFunction_submit

public void jsxFunction_submit()
                        throws IOException

Submit the form.

Throws:

IOException - if an io error occurs

jsxFunction_reset

public void jsxFunction_reset()

Reset 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,
         org.mozilla.javascript.Scriptable start)

Return the specified indexed property

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class org.mozilla.javascript.ScriptableObject

Parameters:

index - The index of the property

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

Returns:

The property.