org.fit.layout.impl

Class DefaultLogicalArea

java.lang.Object

org.fit.layout.impl.GenericTreeNode

org.fit.layout.impl.DefaultLogicalArea

All Implemented Interfaces:

AreaTreeNode<LogicalArea>, LogicalArea

public class DefaultLogicalArea
extends GenericTreeNode
implements LogicalArea

Default LogicalArea implementation.

Author:

burgetr

Constructor Summary

Constructors

Constructor and Description
DefaultLogicalArea()
DefaultLogicalArea(Area src)
DefaultLogicalArea(Area src, String text)

Method Summary

Modifier and Type	Method and Description
void	addArea(Area a)
void	appendChild(LogicalArea child) Appends a new child area to the list of child areas of this area.
void	appendChildren(List<LogicalArea> children) Appends a list of child areas to the list of child areas of this area.
LogicalArea	findArea(Area area) Scans a logical area subtree rooted in this logical area for the given area.
int	getAreaCount()
List<Area>	getAreas()
Area	getFirstArea()
LogicalArea	getChildArea(int index) Obtains the n-th child area.
List<LogicalArea>	getChildAreas() Returns the list of all the child areas.
int	getIndex(LogicalArea child) Returns the index of the specified child in this node's child array.
Tag	getMainTag()
LogicalArea	getNextSibling() Obtains the next siblibg of this area.
LogicalArea	getParentArea() Obtains the parent area of this area.
LogicalArea	getPreviousSibling() Obtains the previous siblibg of this area.
String	getText()
void	insertChild(LogicalArea child, int index) Inserts a new child at the given position.
boolean	isAncestorOf(LogicalArea other) Check whether this area is an ancestor of another area.
void	removeChild(LogicalArea child) Removes a child area from its parent.
void	setMainTag(Tag mainTag)
void	setText(String text)
String	toString()

Methods inherited from class org.fit.layout.impl.GenericTreeNode

add, addUserAttribute, getDepth, getChildAt, getChildCount, getChildren, getIndex, getLeafCount, getNextSiblingNode, getParent, getPreviousSiblingNode, getRoot, getUserAttribute, insert, isLeaf, isRoot, remove, remove, removeAllChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fit.layout.model.AreaTreeNode

addUserAttribute, getDepth, getChildCount, getLeafCount, getUserAttribute, isLeaf, removeAllChildren

Constructor Detail

DefaultLogicalArea

public DefaultLogicalArea()

DefaultLogicalArea

public DefaultLogicalArea(Area src)

DefaultLogicalArea

public DefaultLogicalArea(Area src,
                          String text)

Method Detail

addArea

public void addArea(Area a)

Specified by:

addArea in interface LogicalArea

getAreas

public List<Area> getAreas()

Specified by:

getAreas in interface LogicalArea

getFirstArea

public Area getFirstArea()

Specified by:

getFirstArea in interface LogicalArea

getAreaCount

public int getAreaCount()

Specified by:

getAreaCount in interface LogicalArea

setText

public void setText(String text)

Specified by:

setText in interface LogicalArea

getText

public String getText()

Specified by:

getText in interface LogicalArea

setMainTag

public void setMainTag(Tag mainTag)

Specified by:

setMainTag in interface LogicalArea

getMainTag

public Tag getMainTag()

Specified by:

getMainTag in interface LogicalArea

toString

public String toString()

Overrides:

toString in class Object

getParentArea

public LogicalArea getParentArea()

Description copied from interface: AreaTreeNode

Obtains the parent area of this area.

Specified by:

getParentArea in interface AreaTreeNode<LogicalArea>

Returns:

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

getPreviousSibling

public LogicalArea getPreviousSibling()

Description copied from interface: AreaTreeNode

Obtains the previous siblibg of this area.

Specified by:

getPreviousSibling in interface AreaTreeNode<LogicalArea>

Returns:

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

getNextSibling

public LogicalArea getNextSibling()

Description copied from interface: AreaTreeNode

Obtains the next siblibg of this area.

Specified by:

getNextSibling in interface AreaTreeNode<LogicalArea>

Returns:

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

getChildArea

public LogicalArea getChildArea(int index)
                         throws ArrayIndexOutOfBoundsException

Description copied from interface: AreaTreeNode

Obtains the n-th child area.

Specified by:

getChildArea in interface AreaTreeNode<LogicalArea>

Parameters:

index - the child index

Returns:

the child area at the given index

Throws:

ArrayIndexOutOfBoundsException

getChildAreas

public List<LogicalArea> getChildAreas()

Description copied from interface: AreaTreeNode

Returns the list of all the child areas.

Specified by:

getChildAreas in interface AreaTreeNode<LogicalArea>

Returns:

a list containing all the child areas.

appendChild

public void appendChild(LogicalArea child)

Description copied from interface: AreaTreeNode

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

Specified by:

appendChild in interface AreaTreeNode<LogicalArea>

Parameters:

child - The new child to be appended

appendChildren

public void appendChildren(List<LogicalArea> children)

Description copied from interface: AreaTreeNode

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

Specified by:

appendChildren in interface AreaTreeNode<LogicalArea>

Parameters:

children - The list of new children to be appended

insertChild

public void insertChild(LogicalArea child,
                        int index)

Description copied from interface: AreaTreeNode

Inserts a new child at the given position.

Specified by:

insertChild in interface AreaTreeNode<LogicalArea>

Parameters:

child - the child to be inserted

index - the index of the new child

removeChild

public void removeChild(LogicalArea child)

Description copied from interface: AreaTreeNode

Removes a child area from its parent.

Specified by:

removeChild in interface AreaTreeNode<LogicalArea>

Parameters:

child - The new child to be appended

getIndex

public int getIndex(LogicalArea child)

Description copied from interface: AreaTreeNode

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.

Specified by:

getIndex in interface AreaTreeNode<LogicalArea>

Parameters:

child - the child node to search

Returns:

the child index or -1 if not a child

findArea

public LogicalArea findArea(Area area)

Description copied from interface: LogicalArea

Scans a logical area subtree rooted in this logical area for the given area.

Specified by:

findArea in interface LogicalArea

Parameters:

area - the layout area to search for

Returns:

the logical area that contains the given area or null when the given area is not present in the given subtree

isAncestorOf

public boolean isAncestorOf(LogicalArea other)

Description copied from interface: AreaTreeNode

Check whether this area is an ancestor of another area.

Specified by:

isAncestorOf in interface AreaTreeNode<LogicalArea>

Parameters:

other - the other area

Returns:

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