com.gargoylesoftware.htmlunit.javascript.host.dom

Class DOMTokenList

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.dom.DOMTokenList

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

Direct Known Subclasses:

DOMSettableTokenList

public class DOMTokenList
extends SimpleScriptable

A JavaScript object for DOMTokenList.

Author:

Ahmed Ashour, Ronald Brill, Marek Gawlicki

See Also:

Serialized Form

Nested Class Summary

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 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
DOMTokenList() Creates an instance.
DOMTokenList(Node node, String attributeName) Creates an instance.

Method Summary

Modifier and Type	Method and Description
void	add(String token) Adds the specified token to the underlying string.
boolean	contains(String token) Checks if the specified token is contained in the underlying string.
Object	get(int index, net.sourceforge.htmlunit.corejs.javascript.Scriptable start)
String	getDefaultValue(Class<?> hint) Returns the JavaScript default value of this object.
int	getLength() Returns the length property.
Object	item(int index) Returns the item at the specified index.
void	remove(String token) Removes the specified token from the underlying string.
boolean	toggle(String token) Toggle the token, by adding or removing.

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

clone, equivalentValues, get, getBrowserVersion, 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, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, 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

Constructor Detail

DOMTokenList

public DOMTokenList()

Creates an instance.

DOMTokenList

public DOMTokenList(Node node,
                    String attributeName)

Creates an instance.

Parameters:

node - the node which contains the underlying string

attributeName - the attribute name of the DomElement of the specified node

Method Detail

getLength

public int getLength()

Returns the length property.

Returns:

the length

getDefaultValue

public String getDefaultValue(Class<?> hint)

Returns the JavaScript default value of this object. This is the JavaScript equivalent of a toString() in Java.

Specified by:

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

Overrides:

getDefaultValue in class SimpleScriptable

Parameters:

hint - a hint as to the format of the default value (ignored in this case)

Returns:

the default value

add

public void add(String token)

Adds the specified token to the underlying string.

Parameters:

token - the token to add

remove

public void remove(String token)

Removes the specified token from the underlying string.

Parameters:

token - the token to remove

toggle

public boolean toggle(String token)

Toggle the token, by adding or removing.

Parameters:

token - the token to add or remove

Returns:

whether the string now contains the token or not

contains

public boolean contains(String token)

Checks if the specified token is contained in the underlying string.

Parameters:

token - the token to add

Returns:

true if the underlying string contains token, otherwise false

item

public Object item(int index)

Returns the item at the specified index.

Parameters:

index - the index of the item

Returns:

the item

get

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

Specified by:

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

Overrides:

get in class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject