com.gargoylesoftware.htmlunit.javascript.host.html

Class HTMLCollection

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.AbstractList

com.gargoylesoftware.htmlunit.javascript.host.html.HTMLCollection

All Implemented Interfaces:

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

Direct Known Subclasses:

HTMLAllCollection, HTMLFormControlsCollection

public class HTMLCollection
extends AbstractList

An array of elements. Used for the element arrays returned by document.all, document.all.tags('x'), document.forms, window.frames, etc. Note that this class must not be used for collections that can be modified, for example map.areas and select.options.
This class (like all classes in this package) is specific for the JavaScript engine. Users of HtmlUnit shouldn't use it directly.

Author:

Daniel Gredler, Marc Guillemot, Chris Erskine, Ahmed Ashour, Frank Danek, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.javascript.host.dom.AbstractList

AbstractList.EffectOnCache

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
HTMLCollection() Creates an instance.
HTMLCollection(DomNode domNode, boolean attributeChangeSensitive) 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)
protected AbstractList	create(DomNode parentScope, List<DomNode> initialElements) Constructs a new instance with an initial cache value.
static HTMLCollection	emptyCollection(DomNode domNode) Gets an empty collection.
protected Object	getWithPreemptionByName(String name, List<DomNode> elements) Helper for AbstractList.getWithPreemption(String) when finding by id doesn't get results.
protected boolean	isGetWithPreemptionSearchName() Returns whether AbstractList.getWithPreemption(String) should search by name or not.
Object	item(Object index) Returns the item or items corresponding to the specified index or key.
Object	namedItem(String name) Retrieves the item or items corresponding to the specified name (checks ids, and if that does not work, then names).
Object	nextNode() Returns the next node in the collection (supporting iteration in IE only).
void	reset() Resets the node iterator accessed via nextNode().
protected boolean	supportsParentheses() Is parentheses supported.
Object	tags(String tagName) Returns all the elements in this element array that have the specified tag name.

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

avoidObjectDetection, computeElements, construct, defineProperty, equivalentValues, getArrayElement, getArrayLength, getCandidates, getEffectOnCache, getElements, getLength, getScriptableForElement, getWithPreemption, isMatching, setArrayElement, setAvoidObjectDetection, setDomNode, toString

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

clone, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, has, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, 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, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, 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, wait, wait, wait

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

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

Constructor Detail

HTMLCollection

public HTMLCollection()

Creates an instance.

HTMLCollection

public HTMLCollection(DomNode domNode,
                      boolean attributeChangeSensitive)

Creates an instance.

Parameters:

domNode - parent scope

attributeChangeSensitive - indicates if the content of the collection may change when an attribute of a descendant node of parentScope changes (attribute added, modified or removed)

Method Detail

emptyCollection

public static HTMLCollection emptyCollection(DomNode domNode)

Gets an empty collection.

Parameters:

domNode - the DOM node

Returns:

an empty collection

create

protected AbstractList create(DomNode parentScope,
                              List<DomNode> initialElements)

Constructs a new instance with an initial cache value.

Overrides:

create in class AbstractList

Parameters:

parentScope - the parent scope, on which we listen for changes

initialElements - the initial content for the cache

Returns:

the newly created instance

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

Overrides:

call in class AbstractList

supportsParentheses

protected boolean supportsParentheses()

Is parentheses supported.

Returns:

true or false

getWithPreemptionByName

protected Object getWithPreemptionByName(String name,
                                         List<DomNode> elements)

Helper for AbstractList.getWithPreemption(String) when finding by id doesn't get results.

Overrides:

getWithPreemptionByName in class AbstractList

Parameters:

name - the property name

elements - the children elements.

Returns:

Scriptable.NOT_FOUND if not found

isGetWithPreemptionSearchName

protected boolean isGetWithPreemptionSearchName()

Returns whether AbstractList.getWithPreemption(String) should search by name or not.

Returns:

whether AbstractList.getWithPreemption(String) should search by name or not

item

public Object item(Object index)

Returns the item or items corresponding to the specified index or key.

Overrides:

item in class AbstractList

Parameters:

index - the index or key corresponding to the element or elements to return

Returns:

the element or elements corresponding to the specified index or key

See Also:

MSDN doc

namedItem

public Object namedItem(String name)

Retrieves the item or items corresponding to the specified name (checks ids, and if that does not work, then names).

Parameters:

name - the name or id the element or elements to return

Returns:

the element or elements corresponding to the specified name or id

See Also:

MSDN doc

nextNode

public Object nextNode()

Returns the next node in the collection (supporting iteration in IE only).

Returns:

the next node in the collection

reset

public void reset()

Resets the node iterator accessed via nextNode().

tags

public Object tags(String tagName)

Returns all the elements in this element array that have the specified tag name. This method returns an empty element array if there are no elements with the specified tag name.

Parameters:

tagName - the name of the tag of the elements to return

Returns:

all the elements in this element array that have the specified tag name

See Also:

MSDN doc