org.fit.layout.model

Interface Area

All Superinterfaces:

AreaTreeNode<Area>, ContentRect, Rect, Taggable

All Known Implementing Classes:

AreaImpl, 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
Area	createSuperArea(Rectangular gp, java.util.List<Area> selected, java.lang.String name) Creates a new subarea from a specified region of the area and moves the selected child nodes to the new area.
java.util.Vector<Box>	getAllBoxes() Obtains all the boxes from this area and all the child areas.
java.util.Vector<Box>	getBoxes() Returns the list of boxes that belong directly to this area.
java.awt.Color	getEffectiveBackgroundColor() Obtains the effective background color visible under the area.
java.lang.String	getText() Returns the complete text contained in this area and its sub area.
java.lang.String	getText(java.lang.String separator) Returns the complete text contained in this area and its sub area.
AreaTopology	getTopology() Returns the topology of this 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.

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

addAttribute, appendChild, appendChildren, getAttribute, getDepth, getChildArea, getChildAreas, getChildCount, getIndex, getLeafCount, getNextSibling, getParentArea, getPreviousSibling, insertChild, isLeaf, removeAllChildren, removeChild

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

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

Method Detail

getBoxes

java.util.Vector<Box> getBoxes()

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

Returns:

the list of boxes (possibly empty)

getAllBoxes

java.util.Vector<Box> getAllBoxes()

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

Returns:

The list of boxes

getText

java.lang.String getText()

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

Returns:

A text string (possibly empty)

getText

java.lang.String getText(java.lang.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

java.awt.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,
                   java.util.List<Area> selected,
                   java.lang.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