com.gargoylesoftware.htmlunit.javascript.host.xml

Class FormData

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.xml.FormData

All Implemented Interfaces:

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

public class FormData
extends SimpleScriptable

A JavaScript object for FormData.

Author:

Ahmed Ashour, Ronald Brill, Thorsten Wendelmuth

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormData.FormDataIterator

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORM_DATA_TAG Constant used to register the prototype in the context.

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
FormData() Default constructor.
FormData(Object formObj) Constructor.

Method Summary

Modifier and Type	Method and Description
void	append(String name, Object value, Object filename) Appends a new value onto an existing key inside a FormData object, or adds the key if it does not already exist.
void	delete_js(String name) Removes the entry (if exists).
net.sourceforge.htmlunit.corejs.javascript.Scriptable	entries()
void	fillRequest(WebRequest webRequest) Sets the specified request with the parameters in this FormData.
String	get(String name)
net.sourceforge.htmlunit.corejs.javascript.Scriptable	getAll(String name)
boolean	has(String name)
void	set(String name, Object value, Object filename) Sets a new value for an existing key inside a FormData object, or adds the key if it does not already exist.

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

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

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, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, 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, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isReadOnlySettable, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Field Detail

FORM_DATA_TAG

public static final String FORM_DATA_TAG

Constant used to register the prototype in the context.

See Also:

Constant Field Values

Constructor Detail

FormData

public FormData()

Default constructor.

FormData

public FormData(Object formObj)

Constructor.

Parameters:

formObj - a form

Method Detail

append

public void append(String name,
                   Object value,
                   Object filename)

Appends a new value onto an existing key inside a FormData object, or adds the key if it does not already exist.

Parameters:

name - the name of the field whose data is contained in value

value - the field's value

filename - the filename reported to the server (optional)

delete_js

public void delete_js(String name)

Removes the entry (if exists).

Parameters:

name - the name of the field to remove

get

public String get(String name)

Parameters:

name - the name of the field to check

Returns:

the first value found for the give name

getAll

public net.sourceforge.htmlunit.corejs.javascript.Scriptable getAll(String name)

Parameters:

name - the name of the field to check

Returns:

the values found for the give name

has

public boolean has(String name)

Parameters:

name - the name of the field to check

Returns:

true if the name exists

set

public void set(String name,
                Object value,
                Object filename)

Sets a new value for an existing key inside a FormData object, or adds the key if it does not already exist.

Parameters:

name - the name of the field whose data is contained in value

value - the field's value

filename - the filename reported to the server (optional)

entries

public net.sourceforge.htmlunit.corejs.javascript.Scriptable entries()

Returns:

An Iterator that contains all the requestParameters name[0] and value[1]

fillRequest

public void fillRequest(WebRequest webRequest)

Sets the specified request with the parameters in this FormData.

Parameters:

webRequest - the web request to fill