Jiffie: Java InterFace For Internet Explorer

net.sf.jiffie
Interface ElementList

All Superinterfaces:

java.util.Collection<IDispatch>, java.lang.Iterable<IDispatch>, java.util.List<IDispatch>, Releaseable

All Known Implementing Classes:

EmptyElementList, MultipleElementList, SingleElementList

public interface ElementList
extends java.util.List<IDispatch>, Releaseable

This interface represents a collection of IHTMLElements and is similar in operation to an IHTMLElementCollection. It is used to simplify the management of methods which can potentially return null, a single object, or a list of objects. For these cases an instance of an object implementing this interface is returned. These objects may represent an empty list, a list containing a single object, or a list containing multiple objects.

Method Summary

IDispatch	item(int index) This is a convenience method designed to emulate the behaviour of the item method of the IHTMLElementCollection interface.
ElementList	item(java.lang.String name) This is a convenience method designed to emulate the behaviour of the item method of the IHTMLElementCollection interface.
ElementList	tags(java.lang.String name) This is a convenience method designed to emulate the behaviour of the tags method of the IHTMLElementCollection interface.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from interface net.sf.jiffie.Releaseable

isReleased, release

Method Detail

item

IDispatch item(int index)
               throws JiffieException

This is a convenience method designed to emulate the behaviour of the item method of the IHTMLElementCollection interface.

Parameters:

index - zero based array index

Returns:

object at this index in the collection

Throws:

JiffieException - if there is an error creating list

item

ElementList item(java.lang.String name)
                 throws JiffieException

This is a convenience method designed to emulate the behaviour of the item method of the IHTMLElementCollection interface.

Parameters:

name - name or id attribute of a tag

Returns:

list of tags with id or name attributes matching the supplied value

Throws:

JiffieException - if there is an error creating list

tags

ElementList tags(java.lang.String name)
                 throws JiffieException

This is a convenience method designed to emulate the behaviour of the tags method of the IHTMLElementCollection interface.

Parameters:

name - tag type name

Returns:

list of tags whose tage type matches the supplied value

Throws:

JiffieException - if there is an error creating list