All Implemented Interfaces:

Serializable, Cloneable, org.htmlunit.corejs.javascript.ConstProperties, org.htmlunit.corejs.javascript.debug.DebuggableObject, org.htmlunit.corejs.javascript.ExternalArrayData, org.htmlunit.corejs.javascript.Scriptable, org.htmlunit.corejs.javascript.SymbolScriptable

Direct Known Subclasses:

HTMLFormControlsCollection

public class HTMLCollection
extends AbstractList 

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 org.htmlunit.javascript.host.dom.AbstractList

    AbstractList.EffectOnCache

  • Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator, org.htmlunit.corejs.javascript.ScriptableObject.LambdaGetterFunction, org.htmlunit.corejs.javascript.ScriptableObject.LambdaSetterFunction

• Field Summary

  • Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

  • Fields inherited from interface org.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

  All Methods

  Modifier and Type	Method and Description
  protected HTMLCollection	create (DomNode parentScope, List<DomNode> initialElements) Constructs a new instance with an initial cache value.
  static HTMLCollection	emptyCollection (DomNode domNode) Gets an empty collection.
  int	getLength () Returns the length.
  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.
  org.htmlunit.corejs.javascript.Scriptable	iterator ()
  void	jsConstructor () JavaScript constructor.
  org.htmlunit.corejs.javascript.Scriptable	namedItem (String name) Retrieves the item or items corresponding to the specified name (checks ids, and if that does not work, then names).

  • Methods inherited from class org.htmlunit.javascript.host.dom.AbstractList

    avoidObjectDetection, defineProperty, equivalentValues, getArrayElement, getArrayLength, getElements, getElementSupplier, getIsMatchingPredicate, getIt, getScriptableForElement, getWithPreemption, setArrayElement, setAvoidObjectDetection, setDomNode, setEffectOnCacheFunction, setElementsSupplier, setIsMatchingPredicate, toString

  • Methods inherited from class org.htmlunit.javascript.HtmlUnitScriptable

    clone, get, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getWindow, getWindow, getWindowFromTopCallScope, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setParentScope, setupPromise, setupRejectedPromise

  • Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject

    applyDescriptorToAttributeBitset, associateValue, buildDataDescriptor, callMethod, callMethod, checkPropertyChangeForSlot, checkPropertyDefinition, defineBuiltInProperty, defineBuiltInProperty, defineBuiltInProperty, defineBuiltInProperty, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureScriptableObjectButNotSymbol, ensureSymbolScriptable, ensureType, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSuperProperty, getSuperProperty, getSuperProperty, 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, putOwnProperty, putOwnProperty, putOwnProperty, putProperty, putProperty, putProperty, putSuperProperty, putSuperProperty, putSuperProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size

  • Methods inherited from class org.htmlunit.corejs.javascript.SlotMapOwner

    createSlotMap

  • Methods inherited from class java.lang.Object

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

• 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

  • jsConstructor

    public void jsConstructor()

    JavaScript constructor.

  • emptyCollection

    public static HTMLCollection emptyCollection(DomNode domNode)

    Gets an empty collection.

    Parameters:

    domNode - the DOM node

    Returns:

    an empty collection

  • create

    protected HTMLCollection 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

  • iterator

    public org.htmlunit.corejs.javascript.Scriptable iterator()

    Returns:

    the Iterator symbol

  • getLength

    public final int getLength()

    Returns the length.

    Overrides:

    getLength in class AbstractList

    Returns:

    the length

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

    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 org.htmlunit.corejs.javascript.Scriptable 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