org.itsnat.core.domutil

Interface ElementList

All Superinterfaces:

ElementGroup, ElementListBase, ItsNatUserData, NodeList

public interface ElementList
extends ElementListBase

Manages a pattern based DOM Element list. The pattern is used to create new elements (by using a deep clone), so all elements have the same tag name (same as the pattern).

The starting point is a DOM element list with almost a child element, this first child element is saved as the pattern (really a deep clone), and new elements are created using this element as the pattern. The initial element list (including the pattern) may be initially cleared or kept as is when this object is created and attached to the underlying DOM list.

This type of list helps to render a list of values into the DOM element list, for instance, this interface support "out the box" the typical DOM element list where every child element contains some value usually as the data of a text node. Methods to add new elements include optionally a value parameter. The structure and renderer objects are used to customize how and where this value is saved in the list beyond the default cases.

A pattern based DOM Element list ever works in "master" mode, see ElementListFree.isMaster().

Author:

Jose Maria Arranz Santamaria

See Also:

ElementGroupManager.createElementList(org.w3c.dom.Element,boolean)

Method Summary

Methods

Modifier and Type	Method and Description
Element	addElement() Adds a new child element at the end of the list using the pattern (the new element is a clone).
Element	addElement(Object value) Adds a new child element at the end of the list and renders the specified value using the current structure and renderer.
DocumentFragment	getChildContentPatternFragment() Returns the pattern used to render values if isUsePatternMarkupToRender() is true.
Element	getChildPatternElement() Returns the element used as a pattern.
Element	getContentElementAt(int index) Returns the "content" element, this element is used to render below the associated value of the child element.
ElementListRenderer	getElementListRenderer() Returns the current renderer used by this list.
ElementListStructure	getElementListStructure() Returns the current structure used by this list.
Element	insertElementAt(int index) Inserts a new child element at the specified position using the pattern (the new element is a clone).
Element	insertElementAt(int index, Object value) Inserts a new child element at the specified position and renders the specified value using the current structure and renderer.
boolean	isUsePatternMarkupToRender() Informs whether the original (saved as pattern) markup is used to render.
void	setElementListRenderer(ElementListRenderer renderer) Sets the renderer used by this list.
void	setElementListStructure(ElementListStructure structure) Sets the structure used by this list.
void	setElementValueAt(int index, Object value) Renders the specified value into the element with the given position using the current structure and renderer.
void	setLength(int len) Increases or shrinks the list to fit the new size.
void	setUsePatternMarkupToRender(boolean value) Sets whether the original (saved as pattern) markup is used to render.

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

Method Detail

getElementListStructure

ElementListStructure getElementListStructure()

Returns the current structure used by this list.

Returns:

the current structure.

See Also:

setElementListStructure(ElementListStructure)

setElementListStructure

void setElementListStructure(ElementListStructure structure)

Sets the structure used by this list.

Parameters:

structure - the new structure.

See Also:

getElementListStructure()

getElementListRenderer

ElementListRenderer getElementListRenderer()

Returns the current renderer used by this list.

Returns:

the current renderer.

See Also:

setElementListRenderer(ElementListRenderer)

setElementListRenderer

void setElementListRenderer(ElementListRenderer renderer)

Sets the renderer used by this list.

Parameters:

renderer - the new renderer.

See Also:

getElementListRenderer()

getChildPatternElement

Element getChildPatternElement()

Returns the element used as a pattern. This element is a clone of the original first child element used as a pattern.

Returns:

the pattern element.

setLength

void setLength(int len)

Increases or shrinks the list to fit the new size.

If the new size is bigger new elements are added at the end, if the size is lower tail elements are removed.

Note: getLength() returns the current length, this method is defined in org.w3c.dom.NodeList.getLength().

Parameters:

len - the new length.

See Also:

addElement(), ElementListBase.removeElementAt(int)

addElement

Element addElement()

Adds a new child element at the end of the list using the pattern (the new element is a clone).

Returns:

the new element.

See Also:

addElement(Object)

addElement

Element addElement(Object value)

Adds a new child element at the end of the list and renders the specified value using the current structure and renderer.

Parameters:

value - the value to render.

Returns:

the new element.

See Also:

addElement(), getElementListStructure(), getElementListRenderer(), ElementListStructure.getContentElement(ElementList,int,Element), ElementListRenderer.renderList(ElementList,int,Object,Element,boolean)

insertElementAt

Element insertElementAt(int index)

Inserts a new child element at the specified position using the pattern (the new element is a clone).

Parameters:

index - index of the new element.

Returns:

the new element.

See Also:

insertElementAt(int,Object)

insertElementAt

Element insertElementAt(int index,
                      Object value)

Inserts a new child element at the specified position and renders the specified value using the current structure and renderer.

Parameters:

index - index of the element.

value - the value to render.

Returns:

the new element.

See Also:

insertElementAt(int), getElementListStructure(), getElementListRenderer(), ElementListStructure.getContentElement(ElementList,int,Element), ElementListRenderer.renderList(ElementList,int,Object,Element,boolean)

setElementValueAt

void setElementValueAt(int index,
                     Object value)

Renders the specified value into the element with the given position using the current structure and renderer.

Parameters:

index - index of the element.

value - the value to render.

See Also:

insertElementAt(int,Object), getElementListStructure(), getElementListRenderer(), ElementListStructure.getContentElement(ElementList,int,Element), ElementListRenderer.renderList(ElementList,int,Object,Element,boolean)

getContentElementAt

Element getContentElementAt(int index)

Returns the "content" element, this element is used to render below the associated value of the child element. This element is obtained using the current structure.

Parameters:

index - index of the element.

Returns:

the content element.

See Also:

getElementListStructure(), ElementListStructure.getContentElement(ElementList,int,Element), ElementListRenderer.renderList(ElementList,int,Object,Element,boolean)

isUsePatternMarkupToRender

boolean isUsePatternMarkupToRender()

Informs whether the original (saved as pattern) markup is used to render.

The default value is defined by ItsNatDocument.isUsePatternMarkupToRender()

Returns:

true if the original markup is used.

See Also:

setUsePatternMarkupToRender(boolean)

setUsePatternMarkupToRender

void setUsePatternMarkupToRender(boolean value)

Sets whether the original (saved as pattern) markup is used to render.

Parameters:

value - true to enable the use of original markup to render.

See Also:

isUsePatternMarkupToRender()

getChildContentPatternFragment

DocumentFragment getChildContentPatternFragment()

Returns the pattern used to render values if isUsePatternMarkupToRender() is true.

Returns:

the pattern used to render values.