org.fit.layout.impl

Class AreaGrid

java.lang.Object

org.fit.layout.impl.AreaGrid

public class AreaGrid
extends Object

A grid of visual areas that contains all the child areas of a visual area node. The grid is used as the default area topology.

Author:

burgetr

Field Summary

Fields

Modifier and Type	Field and Description
static int	GRID_THRESHOLD The maximal difference between two lengths that are considered a "being the same"

Constructor Summary

Constructors

Constructor and Description
AreaGrid(DefaultArea area)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cellEmpty(int x, int y) Checks if the cell with the specified coordinates is empty.
int	findCellX(int x) Finds a grid cell that contains the specified point
int	findCellY(int y) Finds a grid cell that contains the specified point
DefaultArea	getAreaAt(int x, int y) Find an area at the specified position in the grid.
Rectangular	getAreaBoundsAbsolute(Rectangular area)
Rectangular	getCellBoundsAbsolute(int x, int y)
Rectangular	getCellBoundsRelative(int x, int y)
int	getColOfs(int col)
int[]	getCols()
int	getHeight()
int	getMaxIndent()
int	getMinIndent()
int	getRowOfs(int row)
int[]	getRows()
int	getWidth()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GRID_THRESHOLD

public static final int GRID_THRESHOLD

The maximal difference between two lengths that are considered a "being the same"

See Also:

Constant Field Values

Constructor Detail

AreaGrid

public AreaGrid(DefaultArea area)

Method Detail

getCols

public int[] getCols()

Returns:

Returns the cols.

getHeight

public int getHeight()

Returns:

Returns the height.

getRows

public int[] getRows()

Returns:

Returns the rows.

getWidth

public int getWidth()

Returns:

Returns the width.

getMinIndent

public int getMinIndent()

getMaxIndent

public int getMaxIndent()

toString

public String toString()

Overrides:

toString in class Object

getAreaAt

public DefaultArea getAreaAt(int x,
                    int y)

Find an area at the specified position in the grid.

Parameters:

x - the x coordinate of the grid cell

y - the y coordinate of the grid cell

Returns:

the node at the specified position or null if there is no node

cellEmpty

public boolean cellEmpty(int x,
                int y)

Checks if the cell with the specified coordinates is empty.

Parameters:

x - the x coordinate of the grid cell

y - the y coordinate of the grid cell

Returns:

true if the cell doesn't contain any subarea

getColOfs

public int getColOfs(int col)
              throws ArrayIndexOutOfBoundsException

Returns:

the offset of the specified column from the grid origin. Column 0 has always the offset 0

Throws:

ArrayIndexOutOfBoundsException

getRowOfs

public int getRowOfs(int row)
              throws ArrayIndexOutOfBoundsException

Returns:

the offset of the specified row from the grid origin. Row 0 has always the offset 0

Throws:

ArrayIndexOutOfBoundsException

getCellBoundsRelative

public Rectangular getCellBoundsRelative(int x,
                                int y)

Returns:

the coordinates of the specified grid cell relatively to the area

getCellBoundsAbsolute

public Rectangular getCellBoundsAbsolute(int x,
                                int y)

Returns:

the coordinates of the specified grid cell absolutely

getAreaBoundsAbsolute

public Rectangular getAreaBoundsAbsolute(Rectangular area)

Returns:

the coordinates of the specified area absolutely]

findCellX

public int findCellX(int x)

Finds a grid cell that contains the specified point

Parameters:

x - the x coordinate of the specified point

findCellY

public int findCellY(int y)

Finds a grid cell that contains the specified point

Parameters:

y - the y coordinate of the specified point