org.fit.layout.model

Interface AreaTopology

All Known Implementing Classes:

DefaultGridTopology

public interface AreaTopology

This is an abstraction of a topology that represents the mutual positions of areas in an abstract space (e.g. in a parent area).

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
void	drawLayout(OutputDisplay disp) Graphically displays the topology on a graphical output device.
int	getHeight() Deprecated. Use getPosition(Area).getHeight() instead.
int	getMaxIndent() Deprecated.
int	getMinIndent() Deprecated.
Area	getNextOnLine() Deprecated.
Rectangular	getPosition() Deprecated. Use getPosition(Area) instead.
Rectangular	getPosition(Area area) Obtains the position of the given area within this topology.
Area	getPreviousOnLine() Deprecated.
int	getTopologyHeight() Obtains the total height of the topology used for placing the child areas within this area.
Rectangular	getTopologyPosition() Obtains the absolute position of the whole topology within the page.
int	getTopologyWidth() Obtains the total width of the topology used for placing the child areas within this area.
int	getWidth() Deprecated. Use getPosition(Area).getWidth() instead.
void	setPosition(Area area, Rectangular gp) Sets the position of the given area in this topology.
void	update() Recomputes the topology.

Method Detail

getTopologyWidth

int getTopologyWidth()

Obtains the total width of the topology used for placing the child areas within this area.

Returns:

the topology width; the units depend on the used topology

getTopologyHeight

int getTopologyHeight()

Obtains the total height of the topology used for placing the child areas within this area.

Returns:

the topology height; the units depend on the topology

getTopologyPosition

Rectangular getTopologyPosition()

Obtains the absolute position of the whole topology within the page.

Returns:

the absolute position of this topology

getPosition

Rectangular getPosition(Area area)

Obtains the position of the given area within this topology.

Parameters:

area - The area whose position we want to obtain.

Returns:

The area position in this topology or null when the area position is not described by this topology.

setPosition

void setPosition(Area area,
                 Rectangular gp)

Sets the position of the given area in this topology.

Parameters:

area - The area whose position we want to set.

gp - The new position.

update

void update()

Recomputes the topology. This should be used when the underlying areas have changed (some areas have been added, removed or resized).

getWidth

int getWidth()

Deprecated. Use getPosition(Area).getWidth() instead.

Obtains the width the area occupies.

Returns:

the width of the area

getHeight

int getHeight()

Deprecated. Use getPosition(Area).getHeight() instead.

Obtains the height the area occupies.

Returns:

the height of the area

getPosition

Rectangular getPosition()

Deprecated. Use getPosition(Area) instead.

Obtains the position of the area in its parent area.

Returns:

the position of the area

getPreviousOnLine

Area getPreviousOnLine()

Deprecated.

getNextOnLine

Area getNextOnLine()

Deprecated.

getMinIndent

int getMinIndent()

Deprecated.

getMaxIndent

int getMaxIndent()

Deprecated.

drawLayout

void drawLayout(OutputDisplay disp)

Graphically displays the topology on a graphical output device.

Parameters:

disp - the ouptut display to be used