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

Methods

Modifier and Type	Method and Description
Vector<Box>	getAllBoxes() Obtains all the boxes from this area and all the child areas.
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	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.
boolean	isReplaced() Checks whether this area is formed by replaced boxes.

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

getBackgroundColor, getBorderCount, 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

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

appendChild, getDepth, getChildArea, getChildAreas, getChildCount, getIndex, getNextSibling, getParentArea, getPreviousSibling, insertChild, isLeaf, removeChild

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

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

Method Detail

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.

getEffectiveBackgroundColor

Color getEffectiveBackgroundColor()

Obtains the effective background color visible under the area.

Returns:

The background color.