org.itsnat.core.domutil

Interface ElementListFree

All Superinterfaces:

Collection<Element>, ElementGroup, ElementListBase, Iterable<Element>, ItsNatUserData, List<Element>, NodeList

All Known Subinterfaces:

ElementTableFree

public interface ElementListFree
extends ElementListBase, List<Element>

Represents an integer indexed DOM Element list, child elements can have different tag names (the meaning of "free").

The interface inherits from java.util.List and supports both types of iterators. List and Iterator methods accept and return DOM Element objects.

Author:

Jose Maria Arranz Santamaria

See Also:

ElementGroupManager.createElementListFree(Element,boolean)

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(Element elem) Adds a new child element at the end of the list.
void	insertElementAt(int index, Element elem) Inserts a new child element at the specified position.
boolean	isMaster() Informs whether the list works in master mode.
Element	setElementAt(int index, Element elem) Replaces the specified element with a new one.
Element[]	setElements(Element[] newElems) Clears the current list and fills again with new elements.

Methods inherited from interface org.itsnat.core.domutil.ElementListBase

getElementAt, getElementFromNode, getElements, getFirstElement, getLastElement, getListElementInfoAt, getListElementInfoFromNode, indexOfElement, isEmpty, lastIndexOfElement, moveElement, removeAllElements, removeElementAt, removeElementRange

Methods inherited from interface org.itsnat.core.domutil.ElementGroup

getItsNatDocument, getParentElement

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Methods inherited from interface org.w3c.dom.NodeList

getLength, item

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

Method Detail

isMaster

boolean isMaster()

Informs whether the list works in master mode.

In master mode DOM elements must be added, removed or replaced using this interface avoiding direct DOM operations (Node.appendChild, Node.removeChild etc), this is the fastest mode. In slave mode (master is false) direct DOM operations can be used and element list changes are automatically reflected by this object, nevertheless method calls are slower in this mode.

Returns:

true if the list is in master mode.

addElement

void addElement(Element elem)

Adds a new child element at the end of the list.

If the new element is already in the list a deep clone (calling Node.cloneNode(boolean deep)) is inserted. This avoids an indirect delete by DOM.

Parameters:

elem - the new element.

See Also:

insertElementAt(int,org.w3c.dom.Element)

insertElementAt

void insertElementAt(int index,
                   Element elem)

Inserts a new child element at the specified position.

If the new element is already in the list a deep clone (calling Node.cloneNode(boolean deep)) is inserted. This avoids an indirect delete by DOM.

Parameters:

index - index of the element.

elem - the new element.

See Also:

addElement(Element)

setElementAt

Element setElementAt(int index,
                   Element elem)

Replaces the specified element with a new one.

If the new element is already in the list a deep clone (calling Node.cloneNode(boolean deep)) is used to replac the element in that position. This avoids an indirect delete by DOM.

Parameters:

index - index of the element.

elem - the new element.

Returns:

the element replaced.

See Also:

ElementListBase.getElementAt(int), insertElementAt(int,Element)

setElements

Element[] setElements(Element[] newElems)

Clears the current list and fills again with new elements. The length may change.

If the new element is already in the list a deep clone (calling Node.cloneNode(boolean deep)) is used to replace the element in that position. This avoids an indirect delete by DOM.

Parameters:

newElems - new elements.

Returns:

the elements replaced.

See Also:

ElementListBase.getElements()