org.itsnat.core.domutil

Interface ElementTableFree

All Superinterfaces:

java.util.Collection<org.w3c.dom.Element>, ElementGroup, ElementListBase, ElementListFree, ElementTableBase, java.lang.Iterable<org.w3c.dom.Element>, ItsNatUserData, java.util.List<org.w3c.dom.Element>, org.w3c.dom.NodeList

public interface ElementTableFree
extends ElementTableBase, ElementListFree

Represents an integer indexed DOM Element table, row elements and cell elements can have different tag names (the meaning of "free").

The interface inherits from ElementListFree and java.util.List indirectly and supports both types of iterators. List and Iterator methods accept and return DOM Element objects. They see the table as a list of rows.

The table can work in master and slave modes, see ElementListFree.isMaster(). If in master mode direct DOM structural changes (add/remove/replace a row, column, cell) must be avoided.

In a "free" table the number of columns may not be the same between rows.

Author:

Jose Maria Arranz Santamaria

See Also:

ElementGroupManager.createElementTableFree(Element,boolean)

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(org.w3c.dom.Element[] cells) Adds a new column at the end of columns.
void	addRow(org.w3c.dom.Element elem) Adds a new row element at the end of the table.
ElementListFree	getCellElementListOfRow(int row) Returns the cell elements of the specified row as an element list.
void	insertColumnAt(int column, org.w3c.dom.Element[] cells) Inserts a new column at the specified position.
void	insertRowAt(int row, org.w3c.dom.Element elem) Inserts a new row element at the specified position.
org.w3c.dom.Element	setCellElementAt(int row, int column, org.w3c.dom.Element elem) Replaces the specified cell element with a new one.
org.w3c.dom.Element[]	setCellElementsOfColumn(int column, org.w3c.dom.Element[] cells) Replaces the specified column with a new one.
org.w3c.dom.Element[]	setCellElementsOfRow(int row, org.w3c.dom.Element[] cells) Clears the specified row and fills again with new elements.
org.w3c.dom.Element	setRowAt(int row, org.w3c.dom.Element elem) Replaces the specified row element with a new one.

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

getCellElementAt, getCellElementsOfColumn, getCellElementsOfRow, getElementRows, getFirstRowElement, getLastRowElement, getRowCount, getRowElementAt, getRowElementFromNode, getRowListElementInfoAt, getRowListElementInfoFromNode, getTableCellElementInfoAt, getTableCellElementInfoFromNode, indexOfRowElement, lastIndexOfRowElement, moveColumn, moveRow, removeAllColumns, removeAllRows, removeColumnAt, removeRowAt, removeRowRange

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

addElement, insertElementAt, isMaster, setElementAt, setElements

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

addRow

void addRow(org.w3c.dom.Element elem)

Adds a new row element at the end of the table.

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

Parameters:

elem - the new row element.

See Also:

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

insertRowAt

void insertRowAt(int row,
               org.w3c.dom.Element elem)

Inserts a new row element at the specified position.

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

Parameters:

row - row index of the element.

elem - the new element.

See Also:

addRow(Element)

setRowAt

org.w3c.dom.Element setRowAt(int row,
                           org.w3c.dom.Element elem)

Replaces the specified row element with a new one.

If the new row 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:

row - row index of the element.

elem - the new element.

Returns:

the element replaced.

See Also:

insertRowAt(int,Element), ElementTableBase.getRowElementAt(int)

setCellElementsOfRow

org.w3c.dom.Element[] setCellElementsOfRow(int row,
                                         org.w3c.dom.Element[] cells)

Clears the specified row and fills again with new elements. The number of columns of the row may change.

If a new cell 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:

cells - new cell elements.

Returns:

the cell elements replaced.

See Also:

ElementTableBase.getCellElementsOfRow(int)

setCellElementAt

org.w3c.dom.Element setCellElementAt(int row,
                                   int column,
                                   org.w3c.dom.Element elem)

Replaces the specified cell element with a new one.

If the new cell 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:

row - row index of the cell element.

column - column index of the cell element.

elem - the new element.

Returns:

the element replaced.

See Also:

ElementTableBase.getCellElementAt(int,int), setRowAt(int,Element)

getCellElementListOfRow

ElementListFree getCellElementListOfRow(int row)

Returns the cell elements of the specified row as an element list. Modifications performed in this list affects to the original table.

Parameters:

row - the row index.

Returns:

the cell element list.

addColumn

void addColumn(org.w3c.dom.Element[] cells)

Adds a new column at the end of columns.

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

Parameters:

cells - the cells of the new column.

See Also:

insertColumnAt(int,org.w3c.dom.Element[])

insertColumnAt

void insertColumnAt(int column,
                  org.w3c.dom.Element[] cells)

Inserts a new column at the specified position.

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

Parameters:

column - index of column to insert.

cells - the cells of the new column.

See Also:

addColumn(Element[])

setCellElementsOfColumn

org.w3c.dom.Element[] setCellElementsOfColumn(int column,
                                            org.w3c.dom.Element[] cells)

Replaces the specified column with a new one.

If a new cell 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:

column - index of column to replace.

cells - the new cells of the column.

Returns:

the cell elements replaced.

See Also:

insertColumnAt(int,Element[]), ElementTableBase.getCellElementsOfColumn(int)