SegmentationAreaTree (FitLayout 2.0.3 API)

java.lang.Object
- cz.vutbr.fit.layout.impl.BaseArtifact
- - cz.vutbr.fit.layout.impl.DefaultAreaTree
  - - cz.vutbr.fit.layout.segm.SegmentationAreaTree

All Implemented Interfaces:

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

Author:

burgetr

Constructor Summary

Constructors
Constructor Description

SegmentationAreaTree(Page srcPage, boolean preserveAuxAreas)
Create a new tree of areas by the analysis of a box tree

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`createGrids(Area root)`	Goes through all the areas in the tree and creates the grids in these areas
`Area`	`findBasicAreas()`	Creates the area tree skeleton - selects the visible boxes and converts them to areas
`Set<Tag>`	`getUsedTags()`	Obtains all the tags that are really used in the tree.
`protected boolean`	`isVisuallySeparated(Box box)`
`void`	`updateTopologies()`	Updates the topology structures (e.g. grids) for all the areas in the tree.

Methods inherited from class cz.vutbr.fit.layout.impl.DefaultAreaTree
createArea, createArea, createArea, createArea, getAreaAt, getAreaByName, getAreasAt, getArtifactType, getMaxAreaId, getNextAreaId, getPageIri, getRoot, setNextAreaId, setPageIri, setRoot, toString, updateNextAreaId

Methods inherited from class cz.vutbr.fit.layout.impl.BaseArtifact
equals, getCreatedOn, getCreator, getCreatorParams, getIri, getLabel, getMetadata, getParentIri, hashCode, setCreatedOn, setCreator, setCreatorParams, setIri, setLabel, setMetadata, setParentIri

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Constructor Detail
  - SegmentationAreaTree
```
public SegmentationAreaTree(Page srcPage,
                            boolean preserveAuxAreas)
```
    Create a new tree of areas by the analysis of a box tree
    
    Parameters:
    
    srcPage - the source box tree
    
    preserveAuxAreas - preserve the auxiliary areas that are not visually separated but they are used as containers containing other ares.
- Method Detail
  - findBasicAreas
```
public Area findBasicAreas()
```
    Creates the area tree skeleton - selects the visible boxes and converts them to areas
  - 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
    
    Overrides:
    
    updateTopologies in class DefaultAreaTree
  - createGrids
```
protected void createGrids(Area root)
```
    Goes through all the areas in the tree and creates the grids in these areas
    
    Parameters:
    
    root - the root node of the tree of areas
  - isVisuallySeparated
```
protected boolean isVisuallySeparated(Box box)
```
  - getUsedTags
```
public Set<Tag> getUsedTags()
```
    Obtains all the tags that are really used in the tree.
    
    Returns:
    
    A set of used tags.