IndexTreeNode (collections-we 0.2 API)

java.lang.Object
- xyz.cofe.collection.tree.AbstractTreeNode<Node>
- - xyz.cofe.collection.tree.BasicTreeNode<Node>
  - - xyz.cofe.collection.tree.PopupTreeNode<Node>
    - - xyz.cofe.collection.tree.IndexTreeNode<Node>

Type Parameters:

Node - Тип узла

All Implemented Interfaces:

OnTreeNodeAdded<Node>, OnTreeNodeAdding<Node>, OnTreeNodeRemoved<Node>, OnTreeNodeRemoving<Node>, TreeNode<Node>, TreeNodeAppendChild<Node>, TreeNodeAssignSelfParent<Node>, TreeNodeChildrenList<Node>, TreeNodeDeepCounter<Node>, TreeNodeDeepOffset<Node>, TreeNodeGetNodePath<Node>, TreeNodeInsertChild<Node>, TreeNodeListeners<Node>, TreeNodeNotifier<Node>, TreeNodeRemoveChild<Node>, TreeNodeRemoveChildAt, TreeNodeReplaceChild<Node>, TreeNodeSetParent<Node>, TreeNodeUpdateParent<Node>

Direct Known Subclasses:

SyncTreeNode
```
public abstract class IndexTreeNode<Node extends TreeNode>
extends PopupTreeNode<Node>
implements TreeNodeDeepCounter<Node>, TreeNodeDeepOffset<Node>
```
Реализация узла древа с поддержкой сквозного индексирования узлов.

Основные возможности:
- Дочерниее узлы храняться виде списка (EventList).
- После добавления/удаления дочернего узла вызываются методы onTreeNodeAdded / onTreeNodeRemoved
- Для каждого добавляемого узла устанавливается родитель (TreeNodeSetParent)
- onTreeNodeAdded - устанавливает родителя для дочернего узла
- Уведомления о измении стркутуры древа. События TreeNodeAdded / TreeNodeRemoved
- Скозная нумерация узлов
Все узлы древа нумеруются в порядке обхода в глубину.
Пример 1(а):
- А (0)
  - B (1)
    - D (2)
    - E (3)
  - C (4)
    - F (5)
      
      H (6)
      
      I (7)
      
      J (8)
    - G (9)
Пример 1(б):

A (0)

B (1) C (4)

D (2) E (3) F (5) G (9)

H (6) I (7) J (8)

deepOffset()
Смещение +3 относительно узла A вернет узел E, а для узла E вернет узел H
a.deepOffset(3) == e
e.deepOffset(3) == h

Смещение -5 относительно узла I вернет узел D:
i.deepOffset(-5) == d

getRootOffset()
getRootOffset - возвращает смещение относительно корня.
Так для узла A значение будет 0, а для узла H - 6:
a.getRootOffset() == 0
h.getRootOffset() == 6

Пример реализации класса:
public static class TNode extends IndexTreeNode<TNode> { @Override public TNode[] getChildren() { return getChildrenList().toArray( new TNode[]{} ); } // Полезная нагрузка public String name = null; @Override public String toString() { return "TNode{" + "name=" + name + '}'; } }
Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Field Summary

Fields
Modifier and Type Field and Description

protected Integer nodesCount
кол-во узлов включая себя, или null
- Fields inherited from class xyz.cofe.collection.tree.BasicTreeNode
  notifyListener
- Fields inherited from class xyz.cofe.collection.tree.AbstractTreeNode
  defaultNodesExtracter, parent

Fields
Modifier and Type	Field and Description
`protected Integer`	`nodesCount` кол-во узлов включая себя, или null

Constructor Summary

Constructors
Constructor and Description

IndexTreeNode()

Constructors
Constructor and Description
`IndexTreeNode()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node`	`deepOffset(int offset)` Возвращает узел относительно текущего в древе, движение согласно порядку обхода узлов вглубь.
`int`	`getNodesCount()` Возвращает кол-во узлов включая себя и всех вложенных
`int`	`getRootOffset()` Возвращает смещение узла относительно корня древа
`void`	`onTreeNodeAdded(Integer index, Node child)` Уведомление о добавлении дочернего узла
`void`	`onTreeNodeAdding(Integer index, Node child)` Уведомление перед началом добавления дочернего узла
`void`	`onTreeNodeRemoved(Integer index, Node child)` Уведомление о удалении дочернего узла
`void`	`onTreeNodeRemoving(Integer index, Node child)` Уведомление перед началом удаления дочернего узла
`void`	`popup(TreeNodeEvent<Node> ev)` Передача события вверх по древу
`protected void`	`resetNodesCount()`
`protected void`	`setNodesCount(int cnt)`

Methods inherited from class xyz.cofe.collection.tree.PopupTreeNode
addTreeNodeListener, addTreeNodeListener, fireTreeNodeEvent, getTreeNodeListeners, hasTreeNodeListener, onTreeNodeEvent, onTreeNodeEvent, removeTreeNodeListener

Methods inherited from class xyz.cofe.collection.tree.BasicTreeNode
appendChild, assignParentTo, attachListeners, createEventList, getChildrenList, insertChildAt, removeChild, removeChildAt, resetParent, setChild

Methods inherited from class xyz.cofe.collection.tree.AbstractTreeNode
getIndex, getIndex, getNextSibling, getNodePath, getNodePath, getParent, getPreviousSibling, getSibling, getSibling, setParent, syncrun, tree, tree, tree, tree, updateParent, visit, visit, visit, visit, visit, visit, visit, walk, walk, walk

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface xyz.cofe.collection.tree.TreeNodeListeners
addTreeNodeListener, addTreeNodeListener, fireTreeNodeEvent, getTreeNodeListeners, hasTreeNodeListener, onTreeNodeEvent, onTreeNodeEvent, removeTreeNodeListener

Methods inherited from interface xyz.cofe.collection.tree.TreeNode
getChildren, getIndex, getNextSibling, getParent, getPreviousSibling, getSibling, tree, visit, visit, visit, walk

- Field Detail
  - nodesCount
```
protected Integer nodesCount
```
    кол-во узлов включая себя, или null
- Constructor Detail
  - IndexTreeNode
```
public IndexTreeNode()
```
- Method Detail
  - getNodesCount
```
public int getNodesCount()
```
    Возвращает кол-во узлов включая себя и всех вложенных
    
    Specified by:
    
    getNodesCount in interface TreeNodeDeepCounter<Node extends TreeNode>
    
    Returns:
    
    кол-во узлов (всегда больше 0)
  - deepOffset
```
public Node deepOffset(int offset)
```
    Description copied from interface: TreeNodeDeepOffset
    
    Возвращает узел относительно текущего в древе, движение согласно порядку обхода узлов вглубь.
    
    Specified by:
    
    deepOffset in interface TreeNodeDeepOffset<Node extends TreeNode>
    
    Parameters:
    
    offset - смещение,
    для 0 - вернет текущий.
    
    Returns:
    
    Узел в древе относительно указанного или null
  - getRootOffset
```
public int getRootOffset()
```
    Description copied from interface: TreeNodeDeepOffset
    
    Возвращает смещение узла относительно корня древа
    
    Specified by:
    
    getRootOffset in interface TreeNodeDeepOffset<Node extends TreeNode>
    
    Returns:
    
    смещение (0 для корня).
  - resetNodesCount
```
protected void resetNodesCount()
```
  - setNodesCount
```
protected void setNodesCount(int cnt)
```
  - popup
```
public void popup(TreeNodeEvent<Node> ev)
```
    Передача события вверх по древу
    
    Specified by:
    
    popup in interface TreeNodeNotifier<Node extends TreeNode>
    
    Overrides:
    
    popup in class PopupTreeNode<Node extends TreeNode>
    
    Parameters:
    
    ev - Событие
  - onTreeNodeAdded
```
public void onTreeNodeAdded(Integer index,
                            Node child)
```
    Description copied from interface: OnTreeNodeAdded
    
    Уведомление о добавлении дочернего узла
    
    Specified by:
    
    onTreeNodeAdded in interface OnTreeNodeAdded<Node extends TreeNode>
    
    Specified by:
    
    onTreeNodeAdded in interface TreeNodeDeepCounter<Node extends TreeNode>
    
    Specified by:
    
    onTreeNodeAdded in interface TreeNodeNotifier<Node extends TreeNode>
    
    Overrides:
    
    onTreeNodeAdded in class PopupTreeNode<Node extends TreeNode>
    
    Parameters:
    
    index - индекс узла
    
    child - дочерний узел
  - onTreeNodeAdding
```
public void onTreeNodeAdding(Integer index,
                             Node child)
```
    Description copied from interface: OnTreeNodeAdding
    
    Уведомление перед началом добавления дочернего узла
    
    Specified by:
    
    onTreeNodeAdding in interface OnTreeNodeAdding<Node extends TreeNode>
    
    Specified by:
    
    onTreeNodeAdding in interface TreeNodeNotifier<Node extends TreeNode>
    
    Overrides:
    
    onTreeNodeAdding in class PopupTreeNode<Node extends TreeNode>
    
    Parameters:
    
    index - индекс узла
    
    child - дочерний узел
  - onTreeNodeRemoved
```
public void onTreeNodeRemoved(Integer index,
                              Node child)
```
    Description copied from interface: OnTreeNodeRemoved
    
    Уведомление о удалении дочернего узла
    
    Specified by:
    
    onTreeNodeRemoved in interface OnTreeNodeRemoved<Node extends TreeNode>
    
    Specified by:
    
    onTreeNodeRemoved in interface TreeNodeDeepCounter<Node extends TreeNode>
    
    Specified by:
    
    onTreeNodeRemoved in interface TreeNodeNotifier<Node extends TreeNode>
    
    Overrides:
    
    onTreeNodeRemoved in class PopupTreeNode<Node extends TreeNode>
    
    Parameters:
    
    index - индекс узла
    
    child - дочерний узел
  - onTreeNodeRemoving
```
public void onTreeNodeRemoving(Integer index,
                               Node child)
```
    Description copied from interface: OnTreeNodeRemoving
    
    Уведомление перед началом удаления дочернего узла
    
    Specified by:
    
    onTreeNodeRemoving in interface OnTreeNodeRemoving<Node extends TreeNode>
    
    Specified by:
    
    onTreeNodeRemoving in interface TreeNodeNotifier<Node extends TreeNode>
    
    Overrides:
    
    onTreeNodeRemoving in class PopupTreeNode<Node extends TreeNode>
    
    Parameters:
    
    index - индекс узла
    
    child - дочерний узел

A (0)
B (1)		C (4)
D (2)	E (3)	F (5)			G (9)
		H (6)	I (7)	J (8)

Class IndexTreeNode<Node extends TreeNode>

Field Summary

Fields inherited from class xyz.cofe.collection.tree.BasicTreeNode

Fields inherited from class xyz.cofe.collection.tree.AbstractTreeNode

Constructor Summary

Method Summary

Methods inherited from class xyz.cofe.collection.tree.PopupTreeNode

Methods inherited from class xyz.cofe.collection.tree.BasicTreeNode

Methods inherited from class xyz.cofe.collection.tree.AbstractTreeNode

Methods inherited from class java.lang.Object

Methods inherited from interface xyz.cofe.collection.tree.TreeNodeListeners

Methods inherited from interface xyz.cofe.collection.tree.TreeNode

Field Detail

nodesCount

Constructor Detail

IndexTreeNode

Method Detail

getNodesCount

deepOffset

getRootOffset

resetNodesCount

setNodesCount

popup

onTreeNodeAdded

onTreeNodeAdding

onTreeNodeRemoved

onTreeNodeRemoving