org.fit.layout.impl

Class DefaultAreaTree

java.lang.Object

org.fit.layout.impl.DefaultAreaTree

All Implemented Interfaces:

AreaTree, SearchableAreaContainer

public class DefaultAreaTree
extends Object
implements AreaTree

Default Page implementation.

Author:

burgetr

Field Summary

Fields

Modifier and Type	Field and Description
protected Page	page

Constructor Summary

Constructors

Constructor and Description
DefaultAreaTree(AreaTree src)
DefaultAreaTree(Page page)

Method Summary

Modifier and Type	Method and Description
Area	createArea(Box box)
Area	createArea(List<Box> boxes)
Area	createArea(Rectangular r)
Area	getAreaAt(int x, int y) Finds the bottom-most area node present at the given coordinates in the area tree.
Area	getAreaByName(String name) Finds an area by the given name.
Page	getPage() Obtains the source page for this area tree.
Area	getRoot() Obtains the root node of the area tree.
void	setRoot(Area root)
void	updateTopologies() Updates the topology structures (e.g. grids) for all the areas in the tree.

Methods inherited from class java.lang.Object

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

Field Detail

page

protected Page page

Constructor Detail

DefaultAreaTree

public DefaultAreaTree(Page page)

DefaultAreaTree

public DefaultAreaTree(AreaTree src)

Method Detail

getPage

public Page getPage()

Description copied from interface: AreaTree

Obtains the source page for this area tree.

Specified by:

getPage in interface AreaTree

Returns:

The source page.

getRoot

public Area getRoot()

Description copied from interface: AreaTree

Obtains the root node of the area tree.

Specified by:

getRoot in interface AreaTree

Returns:

the root node of the tree of areas

setRoot

public void setRoot(Area root)

updateTopologies

public void updateTopologies()

Description copied from interface: AreaTree

Updates the topology structures (e.g. grids) for all the areas in the tree.

Specified by:

updateTopologies in interface AreaTree

getAreaAt

public Area getAreaAt(int x,
                      int y)

Description copied from interface: SearchableAreaContainer

Finds the bottom-most area node present at the given coordinates in the area tree.

Specified by:

getAreaAt in interface SearchableAreaContainer

Parameters:

x - the X coordinate

y - the Y coordinate

Returns:

the area node present at the given coordinates or null when no node is found.

getAreaByName

public Area getAreaByName(String name)

Description copied from interface: SearchableAreaContainer

Finds an area by the given name.

Specified by:

getAreaByName in interface SearchableAreaContainer

Parameters:

name - the name of the area

Returns:

the area with the given name or null when nothing is found.

createArea

public Area createArea(Rectangular r)

Specified by:

createArea in interface AreaTree

createArea

public Area createArea(Box box)

Specified by:

createArea in interface AreaTree

createArea

public Area createArea(List<Box> boxes)

Specified by:

createArea in interface AreaTree