org.fit.layout.model

Interface Area

All Superinterfaces:

AreaTreeNode<Area>, ContentRect, Rect, Taggable

All Known Implementing Classes:

DefaultArea

public interface Area
extends ContentRect, AreaTreeNode<Area>, Taggable

An area containing several visual boxes.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
Area	copy() Creates a copy of the area and makes it a next sibling of the source area.
Area	createSuperArea(Rectangular gp, List<Area> selected, String name) Creates a new subarea from a specified region of the area and moves the selected child nodes to the new area.
Vector<Box>	getAllBoxes() Obtains all the boxes from this area and all the child areas.
AreaTree	getAreaTree() Obtains the tree the node belongs to.
Vector<Box>	getBoxes() Returns the list of boxes that belong directly to this area.
Color	getEffectiveBackgroundColor() Obtains the effective background color visible under the area.
String	getName() Obtains the area name.
String	getText() Returns the complete text contained in this area and its sub area.
String	getText(String separator) Returns the complete text contained in this area and its sub area.
AreaTopology	getTopology() Returns the topology of this area.
void	insertParent(Area newParent, Area child) Inserts a new area as a new parent of the given child area.
boolean	isHorizontalSeparator() Checks whether the area can be interpreted as a horizontal separator.
boolean	isReplaced() Checks whether this area is formed by replaced boxes.
boolean	isSeparator() Checks whether the area can be interpreted as any kind of separator.
boolean	isVerticalSeparator() Checks whether the area can be interpreted as a vertical separator.
void	setName(String name) Sets the name of the area that may be later used for its identification using getName().
void	updateTopologies() Updates the topologies of the child areas.

Methods inherited from interface org.fit.layout.model.ContentRect

getBackgroundColor, getBorderCount, getBorderStyle, getBottomBorder, getBounds, getFontSize, getFontStyle, getFontWeight, getId, getLeftBorder, getLineThrough, getPage, getRightBorder, getTopBorder, getUnderline, hasBottomBorder, hasLeftBorder, hasRightBorder, hasTopBorder, isBackgroundSeparated

Methods inherited from interface org.fit.layout.model.Rect

getHeight, getWidth, getX1, getX2, getY1, getY2, move

Methods inherited from interface org.fit.layout.model.AreaTreeNode

addUserAttribute, appendChild, appendChildren, getDepth, getChildArea, getChildAreas, getChildCount, getIndex, getLeafCount, getNextSibling, getParentArea, getPreviousSibling, getUserAttribute, insertChild, isAncestorOf, isLeaf, removeAllChildren, removeChild

Methods inherited from interface org.fit.layout.model.Taggable

addTag, getMostSupportedTag, getSupportedTags, getTags, getTagSupport, hasTag, hasTag, removeTag

Method Detail

setName

void setName(String name)

Sets the name of the area that may be later used for its identification using getName().

Parameters:

name - the name to be set

getName

String getName()

Obtains the area name.

Returns:

the area name set previously using setName(String) or a default name when nothing has been previously set.

getAreaTree

AreaTree getAreaTree()

Obtains the tree the node belongs to.

Returns:

the tree or null when the node does not form part of any tree.

getBoxes

Vector<Box> getBoxes()

Returns the list of boxes that belong directly to this area.

Returns:

the list of boxes (possibly empty)

getAllBoxes

Vector<Box> getAllBoxes()

Obtains all the boxes from this area and all the child areas.

Returns:

The list of boxes

getText

String getText()

Returns the complete text contained in this area and its sub area.

Returns:

A text string (possibly empty)

getText

String getText(String separator)

Returns the complete text contained in this area and its sub area. The individual areas are separated by the given string separator.

Parameters:

separator - the string separating the individual areas

Returns:

A text string (possibly empty)

isReplaced

boolean isReplaced()

Checks whether this area is formed by replaced boxes.

Returns:

true if the area contains replaced boxes only

getTopology

AreaTopology getTopology()

Returns the topology of this area.

Returns:

The area topology.

updateTopologies

void updateTopologies()

Updates the topologies of the child areas. This should be called when some nodes have been inserted, removed or changed in this area.

getEffectiveBackgroundColor

Color getEffectiveBackgroundColor()

Obtains the effective background color visible under the area.

Returns:

The background color.

isHorizontalSeparator

boolean isHorizontalSeparator()

Checks whether the area can be interpreted as a horizontal separator.

Returns:

true when this area is a horizontal separator

isVerticalSeparator

boolean isVerticalSeparator()

Checks whether the area can be interpreted as a vertical separator.

Returns:

true when this area is a vertical separator

isSeparator

boolean isSeparator()

Checks whether the area can be interpreted as any kind of separator.

Returns:

true when this area is a separator

createSuperArea

Area createSuperArea(Rectangular gp,
                     List<Area> selected,
                     String name)

Creates a new subarea from a specified region of the area and moves the selected child nodes to the new area.

Parameters:

gp - the subarea bounds

selected - nodes to be moved to the new area

name - the name (identification) of the new area

Returns:

the new AreaNode created in the tree or null, if nothing was created

insertParent

void insertParent(Area newParent,
                  Area child)

Inserts a new area as a new parent of the given child area. The given area is replaced by the new parent and it becomes a child area of the parent.

Parameters:

newParent - the new parent area (replacement)

child - the child area that should be replaced

copy

Area copy()

Creates a copy of the area and makes it a next sibling of the source area.

Returns:

the new area