org.fit.layout.model

Interface LogicalArea

All Superinterfaces:

AreaTreeNode<LogicalArea>

All Known Implementing Classes:

DefaultLogicalArea

public interface LogicalArea
extends AreaTreeNode<LogicalArea>

Logical area represents a set of areas that form a single semantic entity. Logical areas are organized in a tree where the parent-child relationships have some semantic meaning instead of representing the actual layout.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
void	addArea(Area a)
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()
Tag	getMainTag()
String	getText()
void	setMainTag(Tag tag)
void	setText(String text)

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

addUserAttribute, appendChild, appendChildren, getDepth, getChildArea, getChildAreas, getChildCount, getIndex, getLeafCount, getNextSibling, getParentArea, getPreviousSibling, getUserAttribute, insertChild, isAncestorOf, isLeaf, removeAllChildren, removeChild

Method Detail

addArea

void addArea(Area a)

getAreas

List<Area> getAreas()

getFirstArea

Area getFirstArea()

getAreaCount

int getAreaCount()

setText

void setText(String text)

getText

String getText()

setMainTag

void setMainTag(Tag tag)

getMainTag

Tag getMainTag()

findArea

LogicalArea findArea(Area area)

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

Parameters:

area - the layout area to search for

Returns:

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