AreaTree (FitLayout 2.0.3 API)

All Superinterfaces:

Artifact, SearchableAreaContainer

All Known Implementing Classes:

DefaultAreaTree, RDFAreaTree, SegmentationAreaTree
```
public interface AreaTree
extends Artifact, SearchableAreaContainer
```
A tree of visual areas created from a box tree.

Author:

burgetr

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Area`	`createArea(Area other)`	Creates a new area in the tree by copying another area.
`Area`	`createArea(Box box)`	Creates a new area in the tree from a box.
`Area`	`createArea(Rectangular r)`	Creates a new empty area in the tree.
`Area`	`createArea(List<Box> boxes)`	Creates a new area in the tree from a list of boxes.
`org.eclipse.rdf4j.model.IRI`	`getPageIri()`	Gets the IRI of the page the area tree was build from.
`Area`	`getRoot()`	Obtains the root node of the area tree.
`void`	`updateTopologies()`	Updates the topology structures (e.g. grids) for all the areas in the tree.

Methods inherited from interface cz.vutbr.fit.layout.model.Artifact
getArtifactType, getCreatedOn, getCreator, getCreatorParams, getIri, getLabel, getMetadata, getParentIri, setIri

Methods inherited from interface cz.vutbr.fit.layout.model.SearchableAreaContainer
getAreaAt, getAreaByName, getAreasAt

- Method Detail
  - getPageIri
```
org.eclipse.rdf4j.model.IRI getPageIri()
```
    Gets the IRI of the page the area tree was build from. This may be equal to the parent IRI when the tree was built from the page directly.
    
    Returns:
    
    the source page IRI
  - getRoot
```
Area getRoot()
```
    Obtains the root node of the area tree.
    
    Returns:
    
    the root node of the tree of areas
  - updateTopologies
```
void updateTopologies()
```
    Updates the topology structures (e.g. grids) for all the areas in the tree.
  - createArea
```
Area createArea(Rectangular r)
```
    Creates a new empty area in the tree.
    
    Parameters:
    
    r - the new area bounds.
    
    Returns:
    
    the new area
  - createArea
```
Area createArea(Box box)
```
    Creates a new area in the tree from a box.
    
    Parameters:
    
    box - source box
    
    Returns:
    
    the new area containing the box.
  - createArea
```
Area createArea(Area other)
```
    Creates a new area in the tree by copying another area.
    
    Parameters:
    
    other - the other area to copy
    
    Returns:
    
    the new area containing the box.
  - createArea
```
Area createArea(List<Box> boxes)
```
    Creates a new area in the tree from a list of boxes.
    
    Parameters:
    
    boxes - a list of boxes
    
    Returns:
    
    the new area containing all the boxes.