com.gargoylesoftware.htmlunit.javascript

Class HTMLCollection

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.HTMLCollection

All Implemented Interfaces:

Serializable, org.mozilla.javascript.Callable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Function, org.mozilla.javascript.Scriptable

public class HTMLCollection
extends SimpleScriptable
implements org.mozilla.javascript.Function

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.

Version:

$Revision: 2158 $

Author:

Daniel Gredler, Marc Guillemot, Chris Erskine, Ahmed Ashour

See Also:

Serialized Form

Field Summary

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
HTMLCollection() Create an instance.
HTMLCollection(SimpleScriptable parentScope) Create an instance

Method Summary

Methods

Modifier and Type	Method and Description
Object	call(org.mozilla.javascript.Context context, org.mozilla.javascript.Scriptable scope, org.mozilla.javascript.Scriptable thisObj, Object[] args)
org.mozilla.javascript.Scriptable	construct(org.mozilla.javascript.Context arg0, org.mozilla.javascript.Scriptable arg1, Object[] arg2)
protected Object	equivalentValues(Object other) Called for the js "==".
Object	get(int index, org.mozilla.javascript.Scriptable start) Returns the element at the specified index, or NOT_FOUND if the index is invalid.
Object[]	getIds() Returns the element or elements that match the specified key.
protected Object	getWithPreemption(String name) Returns the element or elements that match the specified key.
boolean	has(String name, org.mozilla.javascript.Scriptable start)
void	init(DomNode node, org.jaxen.XPath xpath) Init the content of this collection.
void	init(DomNode node, org.jaxen.XPath xpath, org.apache.commons.collections.Transformer transformer) Init the content of this collection.
Object	jsxFunction_item(Object index) Retrieves the item or items corresponding to the specified index or key.
Object	jsxFunction_namedItem(String name) Retrieves the item or items corresponding to the specified name (checks ids, and if that does not work, then names).
Object	jsxFunction_tags(String tagName) Returns all the elements in this element array that have the specified tag name.
int	jsxGet_length() Returns the length of this element array.
String	toString() Just for debug purpose.

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, setDomNode, setHtmlElement

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, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, 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, getParentScope, getPrototype, has, hasInstance, put, put, setParentScope, setPrototype

Constructor Detail

HTMLCollection

public HTMLCollection()

Create an instance. Javascript objects must have a default constructor.

HTMLCollection

public HTMLCollection(SimpleScriptable parentScope)

Create an instance

Parameters:

parentScope - parent scope

Method Detail

init

public void init(DomNode node,
        org.jaxen.XPath xpath)

Init the content of this collection. The elements will be "calculated" at each access using the xpath applied on the node.

Parameters:

node - the node to serve as root for the xpath expression

xpath - the xpath giving the elements of the collection

init

public void init(DomNode node,
        org.jaxen.XPath xpath,
        org.apache.commons.collections.Transformer transformer)

Init the content of this collection. The elements will be "calculated" at each access using the xpath applied on the node and transformed using the transformer.

Parameters:

node - the node to serve as root for the xpath expression

xpath - the xpath giving the elements of the collection

transformer - the transformer allowing to get the expected objects from the xpath evaluation

call

public final Object call(org.mozilla.javascript.Context context,
          org.mozilla.javascript.Scriptable scope,
          org.mozilla.javascript.Scriptable thisObj,
          Object[] args)
                  throws org.mozilla.javascript.JavaScriptException

Specified by:

call in interface org.mozilla.javascript.Callable

Specified by:

call in interface org.mozilla.javascript.Function

Throws:

org.mozilla.javascript.JavaScriptException

construct

public final org.mozilla.javascript.Scriptable construct(org.mozilla.javascript.Context arg0,
                                          org.mozilla.javascript.Scriptable arg1,
                                          Object[] arg2)
                                                  throws org.mozilla.javascript.JavaScriptException

Specified by:

construct in interface org.mozilla.javascript.Function

Throws:

org.mozilla.javascript.JavaScriptException

get

public final Object get(int index,
         org.mozilla.javascript.Scriptable start)

Returns the element at the specified index, or NOT_FOUND if the index is invalid.

Specified by:

get in interface org.mozilla.javascript.Scriptable

Overrides:

get in class org.mozilla.javascript.ScriptableObject

getWithPreemption

protected Object getWithPreemption(String name)

Returns the element or elements that match the specified key. If it is the name of a property, the property value is returned. If it is the id of an element in the array, that element is returned. Finally, if it is the name of an element or elements in the array, then all those elements are returned. Otherwise, Scriptable.NOT_FOUND is returned.

Called by SimpleScriptable.get(String, Scriptable) to allow retrieval of the property before the prototype chain is searched.

IMPORTANT: This method is invoked *very* often by Rhino. If you override this method, the implementation needs to be as fast as possible!

Overrides:

getWithPreemption in class SimpleScriptable

Parameters:

name - the property name

Returns:

Scriptable.NOT_FOUND if not found

jsxGet_length

public final int jsxGet_length()

Returns the length of this element array.

Returns:

The length of this element array.

See Also:

MSDN doc

jsxFunction_item

public final Object jsxFunction_item(Object index)

Retrieves 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

jsxFunction_namedItem

public final Object jsxFunction_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

jsxFunction_tags

public final Object jsxFunction_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

toString

public String toString()

Just for debug purpose.

Overrides:

toString in class Object

equivalentValues

protected Object equivalentValues(Object other)

Called for the js "==".

Overrides:

equivalentValues in class org.mozilla.javascript.ScriptableObject

has

public boolean has(String name,
          org.mozilla.javascript.Scriptable start)

Specified by:

has in interface org.mozilla.javascript.Scriptable

Overrides:

has in class org.mozilla.javascript.ScriptableObject

getIds

public Object[] getIds()

Returns the element or elements that match the specified key. If it is the name of a property, the property value is returned. If it is the id of an element in the array, that element is returned. Finally, if it is the name of an element or elements in the array, then all those elements are returned. Otherwise, .

Specified by:

getIds in interface org.mozilla.javascript.Scriptable

Overrides:

getIds in class org.mozilla.javascript.ScriptableObject