|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.htmlunit.corejs.javascript.ScriptableObject
com.gargoylesoftware.htmlunit.javascript.SimpleScriptable
com.gargoylesoftware.htmlunit.javascript.host.html.HTMLCollection
public class HTMLCollection
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
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 | |
---|---|
HTMLCollection()
Deprecated. |
|
HTMLCollection(DomNode parentScope)
Creates an instance. |
|
HTMLCollection(net.sourceforge.htmlunit.corejs.javascript.ScriptableObject parentScope)
Creates an instance. |
Method Summary | |
---|---|
boolean |
avoidObjectDetection()
Only needed to make collections like document.all available but "invisible" when simulating Firefox. |
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 List<Object> |
computeElements()
Returns the elements whose associated host objects are available through this collection. |
net.sourceforge.htmlunit.corejs.javascript.Scriptable |
construct(net.sourceforge.htmlunit.corejs.javascript.Context cx,
net.sourceforge.htmlunit.corejs.javascript.Scriptable scope,
Object[] args)
|
protected Object |
equivalentValues(Object other)
Called for the js "==". |
Object |
get(int index,
net.sourceforge.htmlunit.corejs.javascript.Scriptable start)
Returns the element at the specified index, or NOT_FOUND if the index is invalid. |
String |
getClassName()
Returns the JavaScript class name. |
protected List<Object> |
getElements()
Gets the HTML elements from cache or retrieve them at first call. |
Object[] |
getIds()
. |
int |
getLength()
|
protected net.sourceforge.htmlunit.corejs.javascript.Scriptable |
getScriptableForElement(Object object)
Gets the scriptable for the provided element that may already be the right scriptable. |
protected Object |
getWithPreemption(String name)
Returns the element or elements that match the specified key. |
boolean |
has(String name,
net.sourceforge.htmlunit.corejs.javascript.Scriptable start)
|
void |
init(DomNode node,
String xpath)
Initializes the content of this collection. |
void |
init(DomNode node,
String xpath,
org.apache.commons.collections.Transformer transformer)
Initializes the content of this collection. |
void |
initFromChildren(DomNode node)
Initializes the collection. |
Node |
item(int index)
|
Object |
jsxFunction_item(Object index)
Returns 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_nextNode()
Returns the next node in the collection (supporting iteration in IE only). |
void |
jsxFunction_reset()
Resets the node iterator accessed via jsxFunction_nextNode() . |
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. |
void |
setAvoidObjectDetection(boolean newValue)
|
String |
toString()
|
Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable |
---|
clone, defineFunctionProperties, defineProperty, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getTransformerScriptableFor, getWindow, getWindow, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement |
Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject |
---|
applyDescriptorToAttributeBitset, associateValue, buildDataDescriptor, callMethod, callMethod, clear, containsKey, containsValue, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, entrySet, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypeOf, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, keySet, preventExtensions, put, put, put, putAll, putConst, putConstProperty, putProperty, putProperty, redefineProperty, remove, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype, size, values |
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, getDefaultValue, getParentScope, getPrototype, has, hasInstance, put, put, setParentScope, setPrototype |
Methods inherited from interface java.util.Map |
---|
equals, hashCode |
Constructor Detail |
---|
@Deprecated public HTMLCollection()
public HTMLCollection(DomNode parentScope)
parentScope
- parent scopepublic HTMLCollection(net.sourceforge.htmlunit.corejs.javascript.ScriptableObject parentScope)
parentScope
- parent scopeMethod Detail |
---|
public boolean avoidObjectDetection()
avoidObjectDetection
in class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
public void setAvoidObjectDetection(boolean newValue)
newValue
- the new valuepublic void init(DomNode node, String xpath)
node
- the node to serve as root for the XPath expressionxpath
- the XPath expression which determines the elements of the collectionpublic void init(DomNode node, String xpath, org.apache.commons.collections.Transformer transformer)
node
- the node to serve as root for the XPath expressionxpath
- the XPath expression which determines the elements of the collectiontransformer
- the transformer enabling the retrieval of the expected objects from
the results of the XPath evaluationpublic void initFromChildren(DomNode node)
node
- the node to grab children frompublic final 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)
call
in interface net.sourceforge.htmlunit.corejs.javascript.Callable
call
in interface net.sourceforge.htmlunit.corejs.javascript.Function
public final net.sourceforge.htmlunit.corejs.javascript.Scriptable construct(net.sourceforge.htmlunit.corejs.javascript.Context cx, net.sourceforge.htmlunit.corejs.javascript.Scriptable scope, Object[] args)
construct
in interface net.sourceforge.htmlunit.corejs.javascript.Function
public final Object get(int index, net.sourceforge.htmlunit.corejs.javascript.Scriptable start)
get
in interface net.sourceforge.htmlunit.corejs.javascript.Scriptable
get
in class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
protected List<Object> getElements()
HtmlElement
contained in this collectionprotected List<Object> computeElements()
protected Object getWithPreemption(String name)
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!
getWithPreemption
in class SimpleScriptable
name
- the property name
Scriptable.NOT_FOUND
if not foundpublic final int jsxGet_length()
public final Object jsxFunction_item(Object index)
index
- the index or key corresponding to the element or elements to return
public final Object jsxFunction_namedItem(String name)
name
- the name or id the element or elements to return
public Object jsxFunction_nextNode()
public void jsxFunction_reset()
jsxFunction_nextNode()
.
public Object jsxFunction_tags(String tagName)
tagName
- the name of the tag of the elements to return
public String toString()
toString
in class Object
protected Object equivalentValues(Object other)
equivalentValues
in class SimpleScriptable
public boolean has(String name, net.sourceforge.htmlunit.corejs.javascript.Scriptable start)
has
in interface net.sourceforge.htmlunit.corejs.javascript.Scriptable
has
in class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
public Object[] getIds()
getIds
in interface net.sourceforge.htmlunit.corejs.javascript.Scriptable
getIds
in class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
public int getLength()
getLength
in interface NodeList
public Node item(int index)
item
in interface NodeList
protected net.sourceforge.htmlunit.corejs.javascript.Scriptable getScriptableForElement(Object object)
object
- the object for which to get the scriptable
public String getClassName()
getClassName
in interface net.sourceforge.htmlunit.corejs.javascript.Scriptable
getClassName
in class SimpleScriptable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |