org.fit.layout.model

Interface AreaTreeNode<T>

All Known Subinterfaces:

Area, LogicalArea

All Known Implementing Classes:

DefaultArea, DefaultLogicalArea

public interface AreaTreeNode<T>

A typed node in the tree of areas.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
void	addUserAttribute(Object attribute) Sets a user-defined attribute for the tree node.
void	appendChild(T child) Appends a new child area to the list of child areas of this area.
void	appendChildren(List<T> list) Appends a list of child areas to the list of child areas of this area.
int	getDepth() Obtains the depth of the tree rooted at this area.
T	getChildArea(int index) Obtains the n-th child area.
List<T>	getChildAreas() Returns the list of all the child areas.
int	getChildCount() Returns the number of child areas for this area.
int	getIndex(T child) Returns the index of the specified child in this node's child array.
int	getLeafCount() Returns the total number of leaves that are descendants of this node.
T	getNextSibling() Obtains the next siblibg of this area.
T	getParentArea() Obtains the parent area of this area.
T	getPreviousSibling() Obtains the previous siblibg of this area.
<P> P	getUserAttribute(Class<P> clazz) Obtains the user-defined attributes of the node.
void	insertChild(T child, int index) Inserts a new child at the given position.
boolean	isAncestorOf(T other) Check whether this area is an ancestor of another area.
boolean	isLeaf() Checks whether this area is a leaf area
void	removeAllChildren() Removes all the child areas from their parent.
void	removeChild(T child) Removes a child area from its parent.

Method Detail

getParentArea

T getParentArea()

Obtains the parent area of this area.

Returns:

The parent area or null when this is the root area.

getPreviousSibling

T getPreviousSibling()

Obtains the previous siblibg of this area.

Returns:

The previous siblibg area or null when this is the first child.

getNextSibling

T getNextSibling()

Obtains the next siblibg of this area.

Returns:

The next siblibg area or null when this is the last child.

getChildArea

T getChildArea(int index)
        throws ArrayIndexOutOfBoundsException

Obtains the n-th child area.

Parameters:

index - the child index

Returns:

the child area at the given index

Throws:

ArrayIndexOutOfBoundsException

getChildCount

int getChildCount()

Returns the number of child areas for this area.

Returns:

the number of child areas

getChildAreas

List<T> getChildAreas()

Returns the list of all the child areas.

Returns:

a list containing all the child areas.

appendChild

void appendChild(T child)

Appends a new child area to the list of child areas of this area.

Parameters:

child - The new child to be appended

appendChildren

void appendChildren(List<T> list)

Appends a list of child areas to the list of child areas of this area.

Parameters:

list - The list of new children to be appended

insertChild

void insertChild(T child,
                 int index)

Inserts a new child at the given position.

Parameters:

child - the child to be inserted

index - the index of the new child

removeChild

void removeChild(T child)

Removes a child area from its parent.

Parameters:

child - The new child to be appended

removeAllChildren

void removeAllChildren()

Removes all the child areas from their parent.

getIndex

int getIndex(T child)

Returns the index of the specified child in this node's child array. If the specified node is not a child of this node, returns -1.

Parameters:

child - the child node to search

Returns:

the child index or -1 if not a child

isLeaf

boolean isLeaf()

Checks whether this area is a leaf area

Returns:

true when the area is a leaf area (it has no children)

isAncestorOf

boolean isAncestorOf(T other)

Check whether this area is an ancestor of another area.

Parameters:

other - the other area

Returns:

true when this area is an ancestor of the other area.

getDepth

int getDepth()

Obtains the depth of the tree rooted at this area.

Returns:

0 for leaf areas, more than 0 for other areas

getLeafCount

int getLeafCount()

Returns the total number of leaves that are descendants of this node. If this node is a leaf, returns 1.

Returns:

the number of leaves beneath this node

addUserAttribute

void addUserAttribute(Object attribute)

Sets a user-defined attribute for the tree node. This allows to assign multiple attributes with different classes. One object of each class is allowed.

Parameters:

attribute - an object representing the user attributes (application-specific)

getUserAttribute

<P> P getUserAttribute(Class<P> clazz)

Obtains the user-defined attributes of the node.

Parameters:

clazz - the class of the required attribute

Returns:

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