Package cz.vutbr.fit.layout.model

Interface GenericTreeNode<T extends GenericTreeNode<T>>

All Known Subinterfaces:

Area, Box, LogicalArea

All Known Implementing Classes:

DefaultArea, DefaultBox, DefaultLogicalArea, DefaultTreeContentRect, DefaultTreeNode

public interface GenericTreeNode<T extends GenericTreeNode<T>>

A generic tree node interface.

Author:

burgetr

Method Summary

Modifier and Type	Method	Description
void	addUserAttribute(String name, Object value)	Sets a user-defined attribute for the tree node.
void	appendChild(T child)
void	appendChildren(List<T> children)
int	getDepth()
T	getChildAt(int index)
int	getChildCount()
List<T>	getChildren()
int	getIndex(T child)
int	getLeafCount()
T	getNextSibling()
T	getParent()
T	getPreviousSibling()
T	getRoot()
<P> P	getUserAttribute(String name, Class<P> clazz)	Obtains the user-defined attribute value assigned to the node.
void	childrenChanged()	Signals that some children have been added or removed or their state changed.
void	insertChild(T child, int index)
boolean	isLeaf()
boolean	isRoot()
void	removeAllChildren()
void	removeChild(int index)
void	removeChild(T child)
void	setParent(T parent)
void	setRoot(T root)

Method Detail

getParent

T getParent()

setParent

void setParent(T parent)

getRoot

T getRoot()

setRoot

void setRoot(T root)

isRoot

boolean isRoot()

getChildren

List<T> getChildren()

getChildCount

int getChildCount()

isLeaf

boolean isLeaf()

appendChild

void appendChild(T child)

appendChildren

void appendChildren(List<T> children)

insertChild

void insertChild(T child,
                 int index)
          throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

removeAllChildren

void removeAllChildren()

removeChild

void removeChild(int index)
          throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

removeChild

void removeChild(T child)
          throws IllegalArgumentException

Throws:

IllegalArgumentException

getChildAt

T getChildAt(int index)
      throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

getIndex

int getIndex(T child)

getPreviousSibling

T getPreviousSibling()

getNextSibling

T getNextSibling()

getDepth

int getDepth()

getLeafCount

int getLeafCount()

childrenChanged

void childrenChanged()

Signals that some children have been added or removed or their state changed.

addUserAttribute

void addUserAttribute(String name,
                      Object value)

Sets a user-defined attribute for the tree node. This allows to assign multiple attributes identified by their names.

Parameters:

name - the attribute name

value - the attribute value

getUserAttribute

<P> P getUserAttribute(String name,
                       Class<P> clazz)

Obtains the user-defined attribute value assigned to the node.

Parameters:

name - the attribute name

clazz - the class of the required attribute

Returns:

an object of the given class representing the value of the attribute (application-specific) or null when no such attribute is present.