org.kde.koala
Class HTMLCollection

java.lang.Object
  org.kde.koala.HTMLCollection

All Implemented Interfaces:

org.kde.qt.QtSupport

Direct Known Subclasses:

HTMLFormCollection

public class HTMLCollection
extends java.lang.Object
implements org.kde.qt.QtSupport

An HTMLCollection is a list of nodes. An individual node may be accessed by either ordinal index or the node's name or id attributes. Note: Collections in the HTML DOM are assumed to be live meaning that they are automatically updated when the underlying document is changed.

Constructor Summary

	HTMLCollection()
protected	HTMLCollection(java.lang.Class dummy)
	HTMLCollection(HTMLCollection other)

Method Summary

Node	base() not part of the DOM
Node	firstItem()
boolean	isNull()
Node	item(long index) This method retrieves a node specified by ordinal index.
long	length() This attribute specifies the length or size of the list.
Node	namedItem(java.lang.String name) This method retrieves a Node using a name.
Node	nextItem()
Node	nextNamedItem(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLCollection

protected HTMLCollection(java.lang.Class dummy)

HTMLCollection

public HTMLCollection()

HTMLCollection

public HTMLCollection(HTMLCollection other)

Method Detail

length

public long length()

This attribute specifies the length or size of the list.

item

public Node item(long index)

This method retrieves a node specified by ordinal index. Nodes are numbered in tree order (depth-first traversal order).

Parameters:

index - The index of the node to be fetched. The index origin is 0.

Returns:

The Node at the corresponding position upon success. A value of null is returned if the index is out of range.

namedItem

public Node namedItem(java.lang.String name)

This method retrieves a Node using a name. It first searches for a Node with a matching id attribute. If it doesn't find one, it then searches for a Node with a matching name attribute, but only on those elements that are allowed a name attribute.

Parameters:

name - The name of the Node to be fetched.

Returns:

The Node with a name or id attribute whose value corresponds to the specified string. Upon failure (e.g., no node with this name exists), returns null .

base

public Node base()

not part of the DOM

isNull

public boolean isNull()

firstItem

public Node firstItem()

nextItem

public Node nextItem()

nextNamedItem

public Node nextNamedItem(java.lang.String name)