SearchableAreaContainer (FitLayout 2.0.3 API)

All Known Subinterfaces:

AreaTree

All Known Implementing Classes:

DefaultAreaTree, RDFAreaTree, SegmentationAreaTree
```
public interface SearchableAreaContainer
```
A basic container of areas with the possibility of searching the areas.

Author:

burgetr

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`List<Area>`	`getAreasAt(int x, int y)`	Finds all the area nodes present at the given coordinates in the area tree.

- Method Detail
  - getAreaAt
```
Area getAreaAt(int x,
               int y)
```
    Finds the bottom-most area node present at the given coordinates in the area tree.
    
    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.
  - getAreasAt
```
List<Area> getAreasAt(int x,
                      int y)
```
    Finds all the area nodes present at the given coordinates in the area tree.
    
    Parameters:
    
    x - the X coordinate
    
    y - the Y coordinate
    
    Returns:
    
    a list of the area nodes present at the given coordinates ordered from the topmost to the bottommost one.
  - getAreaByName
```
Area getAreaByName(String name)
```
    Finds an area by the given name.
    
    Parameters:
    
    name - the name of the area
    
    Returns:
    
    the area with the given name or null when nothing is found.