org.itsnat.core.domutil
Interface ElementGroupManager

public interface ElementGroupManager

Utility interface used as factory of ElementGroup objects and related resources.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatDocument.getElementGroupManager()

Method Summary

ElementLabelRenderer	createDefaultElementLabelRenderer() Creates the default DOM element label renderer.
ElementListRenderer	createDefaultElementListRenderer() Creates the default DOM element list renderer.
ElementListStructure	createDefaultElementListStructure() Creates the default DOM element list structure.
ElementRenderer	createDefaultElementRenderer() Creates the default DOM element renderer.
ElementTableRenderer	createDefaultElementTableRenderer() Creates the default DOM element table renderer.
ElementTableStructure	createDefaultElementTableStructure() Creates the default DOM element table structure.
ElementTreeNodeRenderer	createDefaultElementTreeNodeRenderer() Creates the default DOM element table renderer.
ElementTreeNodeStructure	createDefaultElementTreeNodeStructure() Creates the default DOM element tree node structure.
ElementLabel	createElementLabel(org.w3c.dom.Element parentElement, boolean removePattern, ElementLabelRenderer renderer) Creates a pattern based DOM element label.
ElementList	createElementList(org.w3c.dom.Element parentElement, boolean removePattern) Creates a pattern based DOM element list.
ElementList	createElementList(org.w3c.dom.Element parentElement, boolean removePattern, ElementListStructure structure, ElementListRenderer renderer) Creates a pattern based DOM element list.
ElementListFree	createElementListFree(org.w3c.dom.Element parentElement, boolean master) Creates a DOM element list manager.
ElementTable	createElementTable(org.w3c.dom.Element parentElement, boolean removePattern) Creates a pattern based DOM element table.
ElementTable	createElementTable(org.w3c.dom.Element parentElement, boolean removePattern, ElementTableStructure structure, ElementTableRenderer renderer) Creates a pattern based DOM element table.
ElementTableFree	createElementTableFree(org.w3c.dom.Element parentElement, boolean master) Creates a DOM element table manager.
ElementTree	createElementTree(boolean treeTable, org.w3c.dom.Element parentElement, boolean removePattern) Creates a pattern based DOM element tree.
ElementTree	createElementTree(boolean treeTable, org.w3c.dom.Element parentElement, boolean removePattern, ElementTreeNodeStructure structure, ElementTreeNodeRenderer renderer) Creates a pattern based DOM element tree.
ElementTreeNode	createElementTreeNode(org.w3c.dom.Element parentElement, boolean removePattern) Creates a pattern based DOM element tree node.
ElementTreeNode	createElementTreeNode(org.w3c.dom.Element parentElement, boolean removePattern, ElementTreeNodeStructure structure, ElementTreeNodeRenderer renderer) Creates a pattern based DOM element tree node.
ElementTreeNodeList	createElementTreeNodeList(boolean treeTable, org.w3c.dom.Element parentElement, boolean removePattern) Creates a pattern based rootless DOM element tree.
ElementTreeNodeList	createElementTreeNodeList(boolean treeTable, org.w3c.dom.Element parentElement, boolean removePattern, ElementTreeNodeStructure structure, ElementTreeNodeRenderer renderer) Creates a pattern based rootless DOM element tree.
ItsNatDocument	getItsNatDocument() Returns the parent document this object belongs to.

Method Detail

getItsNatDocument

ItsNatDocument getItsNatDocument()

Returns the parent document this object belongs to.

Returns:

the parent document.

createElementListFree

ElementListFree createElementListFree(org.w3c.dom.Element parentElement,
                                      boolean master)

Creates a DOM element list manager. Initial DOM list may be not empty and child elements may have different tag names.

Parameters:

parentElement - the parent element of the list.

master - if true only the manager must be used to make structural changes (add, remove or replace elements), avoiding direct DOM manipulation.

Returns:

the element list.

See Also:

createElementList(org.w3c.dom.Element,boolean,org.itsnat.core.domutil.ElementListStructure,org.itsnat.core.domutil.ElementListRenderer)

createElementTableFree

ElementTableFree createElementTableFree(org.w3c.dom.Element parentElement,
                                        boolean master)

Creates a DOM element table manager. Initial DOM table may be not empty and row elements and cells may have different tag names.

Parameters:

parentElement - the parent element of the table.

master - if true only the manager must be used to make structural changes (add, remove or replace elements), avoiding direct DOM manipulation.

Returns:

the element table.

See Also:

createElementTable(org.w3c.dom.Element,boolean,org.itsnat.core.domutil.ElementTableStructure,org.itsnat.core.domutil.ElementTableRenderer)

createElementLabel

ElementLabel createElementLabel(org.w3c.dom.Element parentElement,
                                boolean removePattern,
                                ElementLabelRenderer renderer)

Creates a pattern based DOM element label. The content of the element is used as the pattern to render the first value.

Parameters:

parentElement - the parent element of the label.

removePattern - if true the current content is removed, otherwise the label shows the current content.

renderer - the used label renderer. If null the default renderer is used.

Returns:

the element label.

createElementList

ElementList createElementList(org.w3c.dom.Element parentElement,
                              boolean removePattern,
                              ElementListStructure structure,
                              ElementListRenderer renderer)

Creates a pattern based DOM element list. The first child element is used as the pattern to create new child elements.

Parameters:

parentElement - the parent element of the list.

removePattern - if true the current content (the pattern as minimun) is removed, otherwise the list represents the current content.

structure - the used list structure. If null the default structure is used.

renderer - the used list renderer. If null the default renderer is used.

Returns:

the element list.

See Also:

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

createElementList

ElementList createElementList(org.w3c.dom.Element parentElement,
                              boolean removePattern)

Creates a pattern based DOM element list. The first child element is used as the pattern to create new child elements. The list uses the default structure and renderer.

Parameters:

parentElement - the parent element of the list.

removePattern - if true the current content (the pattern as minimun) is removed, otherwise the list represents the current content.

Returns:

the element list.

See Also:

createElementList(org.w3c.dom.Element,boolean,org.itsnat.core.domutil.ElementListStructure,org.itsnat.core.domutil.ElementListRenderer), createDefaultElementListStructure(), createDefaultElementListRenderer()

createElementTable

ElementTable createElementTable(org.w3c.dom.Element parentElement,
                                boolean removePattern,
                                ElementTableStructure structure,
                                ElementTableRenderer renderer)

Creates a pattern based DOM element table. The first child element is used as the row pattern and the first element cell is the cell pattern used to create new cells (columns).

Parameters:

parentElement - the parent element of the table.

removePattern - if true the current content (the first row as minimu) is removed, otherwise the table represents the current content.

structure - the used table structure. If null the default structure is used.

renderer - the used table renderer. If null the default renderer is used.

Returns:

the element table.

See Also:

createElementTable(org.w3c.dom.Element,boolean), createElementTableFree(Element,boolean)

createElementTable

ElementTable createElementTable(org.w3c.dom.Element parentElement,
                                boolean removePattern)

Creates a pattern based DOM element table. The first child element is used as the row pattern and the first element cell is the cell pattern used to create new cells (columns). The table uses the default structure and renderer.

Parameters:

parentElement - the parent element of the table.

removePattern - if true the current content (the first row as minimu) is removed, otherwise the table represents the current content.

Returns:

the element table.

See Also:

createElementTable(org.w3c.dom.Element,boolean,org.itsnat.core.domutil.ElementTableStructure,org.itsnat.core.domutil.ElementTableRenderer), createDefaultElementTableStructure(), createDefaultElementTableRenderer()

createElementTreeNode

ElementTreeNode createElementTreeNode(org.w3c.dom.Element parentElement,
                                      boolean removePattern,
                                      ElementTreeNodeStructure structure,
                                      ElementTreeNodeRenderer renderer)

Creates a pattern based DOM element tree node. This node is the fixed root of the tree.

Parameters:

parentElement - the parent element of the node and tree.

removePattern - if true the pattern of child nodes (the first child if any) is removed, otherwise the child node list represents the current child node list.

structure - the used tree node structure. If null the default structure is used.

renderer - the used tree node renderer. If null the default renderer is used.

Returns:

the element tree node.

See Also:

createElementTreeNode(org.w3c.dom.Element,boolean), createElementTree(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer), createElementTreeNodeList(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer)

createElementTreeNode

ElementTreeNode createElementTreeNode(org.w3c.dom.Element parentElement,
                                      boolean removePattern)

Creates a pattern based DOM element tree node. This node is the fixed (non-removable) root of the tree. The tree node uses the default structure and renderer.

Parameters:

parentElement - the parent element of the node and tree.

removePattern - if true the pattern of child nodes (the first child if any) is removed, otherwise the child node list represents the current child node list.

Returns:

the element tree node.

See Also:

createElementTreeNode(org.w3c.dom.Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer), createDefaultElementTreeNodeStructure(), createDefaultElementTreeNodeRenderer()

createElementTree

ElementTree createElementTree(boolean treeTable,
                              org.w3c.dom.Element parentElement,
                              boolean removePattern,
                              ElementTreeNodeStructure structure,
                              ElementTreeNodeRenderer renderer)

Creates a pattern based DOM element tree. The root node is the only one top level node and is not fixed (removable).

Parameters:

treeTable - if true the tree is a tree-table structurally.

parentElement - the parent element of the tree.

removePattern - if true the first node (the root node used as pattern) is removed, otherwise this node is the root.

structure - the used tree node structure. If null the default structure is used.

renderer - the used tree node renderer. If null the default renderer is used.

Returns:

the element tree.

See Also:

createElementTree(boolean,Element,boolean), createElementTreeNode(org.w3c.dom.Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer), createElementTreeNodeList(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer)

createElementTree

ElementTree createElementTree(boolean treeTable,
                              org.w3c.dom.Element parentElement,
                              boolean removePattern)

Creates a pattern based DOM element tree. The root node is the only one top level node and is not fixed (removable). The tree uses the default structure and renderer.

Parameters:

treeTable - if true the tree is a tree-table structurally.

parentElement - the parent element of the tree.

removePattern - if true the first tree node (used as pattern) is removed, otherwise this node is the root.

Returns:

the element tree.

See Also:

createElementTree(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer), createDefaultElementTreeNodeStructure(), createDefaultElementTreeNodeRenderer()

createElementTreeNodeList

ElementTreeNodeList createElementTreeNodeList(boolean treeTable,
                                              org.w3c.dom.Element parentElement,
                                              boolean removePattern,
                                              ElementTreeNodeStructure structure,
                                              ElementTreeNodeRenderer renderer)

Creates a pattern based rootless DOM element tree.

Parameters:

treeTable - if true the tree is a tree-table structurally.

parentElement - the parent element of the tree.

removePattern - if true the first child node is removed, otherwise the tree represents the current content (current top child nodes).

structure - the used tree node structure. If null the default structure is used.

renderer - the used tree node renderer. If null the default renderer is used.

Returns:

the rootless element tree.

See Also:

createElementTreeNodeList(boolean,Element,boolean), createElementTreeNode(org.w3c.dom.Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer), createElementTree(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer)

createElementTreeNodeList

ElementTreeNodeList createElementTreeNodeList(boolean treeTable,
                                              org.w3c.dom.Element parentElement,
                                              boolean removePattern)

Creates a pattern based rootless DOM element tree. The tree uses the default structure and renderer.

Parameters:

treeTable - if true the tree is a tree-table structurally.

parentElement - the parent element of the tree.

removePattern - if true the first child node is removed, otherwise the tree represents the current content (current top child nodes).

Returns:

the rootless element tree.

See Also:

createElementTreeNodeList(boolean,Element,boolean,ElementTreeNodeStructure,ElementTreeNodeRenderer), createDefaultElementTreeNodeStructure(), createDefaultElementTreeNodeRenderer()

createDefaultElementRenderer

ElementRenderer createDefaultElementRenderer()

Creates the default DOM element renderer. This renderer writes the specified value as a string into the first found text node.

Returns:

the default renderer.

createDefaultElementLabelRenderer

ElementLabelRenderer createDefaultElementLabelRenderer()

Creates the default DOM element label renderer. This renderer uses the default ElementRenderer to render the specified value.

Returns:

the default renderer.

createDefaultElementListRenderer

ElementListRenderer createDefaultElementListRenderer()

Creates the default DOM element list renderer. This renderer uses the default ElementRenderer to render the specified value.

Returns:

the default renderer.

createDefaultElementTableRenderer

ElementTableRenderer createDefaultElementTableRenderer()

Creates the default DOM element table renderer. This renderer uses the default ElementRenderer to render the specified value.

Returns:

the default renderer.

createDefaultElementTreeNodeRenderer

ElementTreeNodeRenderer createDefaultElementTreeNodeRenderer()

Creates the default DOM element table renderer. This renderer uses the default ElementRenderer to render a user value usually into the label element.

Returns:

the default renderer.

createDefaultElementListStructure

ElementListStructure createDefaultElementListStructure()

Creates the default DOM element list structure. This structure returns as content element the <td> element if the item parent is a <tr> otherwise the item parent element.

Returns:

the default structure.

createDefaultElementTableStructure

ElementTableStructure createDefaultElementTableStructure()

Creates the default DOM element table structure. This structure returns as row content element the row parent element (itself), and as cell content element the cell parent element (itself).

Returns:

the default structure.

createDefaultElementTreeNodeStructure

ElementTreeNodeStructure createDefaultElementTreeNodeStructure()

Creates the default DOM element tree node structure. This structure is flexible enough to deal with several scenarios like tree-table, no handle and icon etc.

The reference manual explains with examples how this default structure works.

Returns:

the default structure.