org.fit.segm.grouping

Class AreaImpl

java.lang.Object

org.fit.layout.impl.GenericTreeNode

org.fit.layout.impl.DefaultContentRect

org.fit.layout.impl.DefaultArea

org.fit.segm.grouping.AreaImpl

All Implemented Interfaces:

org.fit.layout.model.Area, org.fit.layout.model.AreaTreeNode<org.fit.layout.model.Area>, org.fit.layout.model.ContentRect, org.fit.layout.model.Rect, org.fit.layout.model.Taggable

public class AreaImpl
extends org.fit.layout.impl.DefaultArea
implements org.fit.layout.model.Area

An area containing several visual boxes.

Author:

radek

Constructor Summary

Constructors

Constructor and Description
AreaImpl(AreaImpl src) Creates a copy of another area.
AreaImpl(org.fit.layout.model.Box box) Creates an area from a single box.
AreaImpl(int x1, int y1, int x2, int y2) Creates an empty area of a given size
AreaImpl(List<org.fit.layout.model.Box> boxList) Creates an area from a a list of boxes.
AreaImpl(org.fit.layout.model.Rectangular r) Creates an empty area of a given size

Method Summary

Modifier and Type	Method and Description
void	addBox(org.fit.layout.model.Box box) Adds a new box to the area and updates the area bounds.
void	appendChild(org.fit.layout.model.Area child)
void	appendChildren(List<org.fit.layout.model.Area> list)
boolean	contains(int x, int y)
boolean	containsText()
org.fit.layout.model.Area	copy()
void	createSeparators() Creates a set of the horizontal and vertical separators
org.fit.layout.model.Area	createSuperArea(org.fit.layout.model.Rectangular gp, List<org.fit.layout.model.Area> selected, String name)
boolean	encloses(AreaImpl other)
AreaImpl	findContentAbove(Separator sep) Looks for the nearest text box area placed above the separator.
String	getBoxText() Returns the text string represented by a concatenation of all the boxes contained directly in this area (no subareas)
float	getColorLuminosity() Computes the average luminosity of the boxes in the area
float	getDeclaredFontSize() Returns the font size declared for the first box.
Color	getEffectiveBackgroundColor()
float	getFontSize() Computes the average font size of the boxes in the area
float	getFontStyle() Computes the average font style of the boxes in the area
float	getFontWeight() Computes the average font weight of the boxes in the area
List<org.fit.layout.model.Area>	getChildNodesInside(org.fit.layout.model.Rectangular r) Returns the child areas whose absolute coordinates intersect with the specified rectangle.
int	getLevel()
float	getLineThrough()
org.fit.layout.model.ContentObject	getReplacedContent()
SeparatorSet	getSeparators()
AreaStyle	getStyle() Obtains the overall style of the area.
String	getText()
int	getTextLength() Returns the text string represented by a concatenation of all the boxes contained directly in this area.
float	getUnderline()
boolean	hasContent()
boolean	hasSameBackground(AreaImpl other) Checks if this area has the same background color as another area
boolean	hasSameStyle(AreaImpl other) Compares two areas and decides whether they have the same style.
void	chooseBox(org.fit.layout.model.Box node) Add the box node to the area if its bounds are inside of the area bounds.
boolean	isAreaEmpty(org.fit.layout.model.Rectangular r) Check if there are some children in the given subarea of the area.
boolean	isExplicitlySeparated() When set to true, the area is considered to be separated from other areas explicitly, i.e. independently on its real borders or background.
boolean	isHorizontalSeparator() Tries to guess if this area acts as a horizontal separator.
boolean	isReplaced()
boolean	isVerticalSeparator() Tries to guess if this area acts as a vertical separator.
void	join(AreaImpl other, boolean horizontal) Joins another area to this area.
void	joinArea(AreaImpl other, org.fit.layout.model.Rectangular pos, boolean horizontal) Joins this area with another area and updates the layout in the grid to the given values.
void	joinChild(AreaImpl other) Joins a child area to this area.
void	removeAllChildren()
void	removeSimpleSeparators() Removes simple separators from current separator set.
protected void	resetAverages() Resets the averages to the values obtained from the text boxes that belong to this area only.
boolean	separatedDown()
boolean	separatedLeft()
boolean	separatedRight()
boolean	separatedUp()
void	setLevel(int level)
void	setSeparated(boolean separated) When set to true, the area is considered to be separated from other areas explicitly, i.e. independently on its real borders or background.
String	toString()
void	updateAverages(org.fit.layout.model.Area other) Updates the average values when a new area is added or joined

Methods inherited from class org.fit.layout.impl.DefaultArea

addTag, containsTag, createGrid, createTopology, getAllBoxes, getAreaTree, getBoxDescription, getBoxes, getContentBounds, getGrid, getGridHeight, getGridPosition, getGridWidth, getGridX, getGridY, getChildArea, getChildAreas, getChildAtGridPos, getIndex, getMostSupportedTag, getName, getNextOnLine, getNextSibling, getParentArea, getPreviousOnLine, getPreviousSibling, getSupportedTags, getTags, getTagSupport, getText, getTopology, hasTag, hasTag, insertChild, insertParent, isAncestorOf, isSeparator, move, removeAllTags, removeBox, removeBoxes, removeChild, removeTag, setAreaTree, setGridPosition, setGridX, setGridY, SetHorizontalSeparator, setName, setNextOnLine, setPreviousOnLine, SetVerticalSeparator, updateTopologies

Methods inherited from class org.fit.layout.impl.DefaultContentRect

equals, getBackgroundColor, getBorderCount, getBorderStyle, getBottomBorder, getBounds, getHeight, getId, getLeftBorder, getPage, getRightBorder, getTopBorder, getWidth, getX1, getX2, getY1, getY2, hasBottomBorder, hashCode, hasLeftBorder, hasRightBorder, hasTopBorder, isBackgroundSeparated, resetId, setBackgroundColor, setBackgroundSeparated, setBorders, setBorderStyle, setBottomBorder, setBounds, setFontSize, setFontStyle, setFontWeight, setId, setLeftBorder, setLineThrough, setPage, setRightBorder, setTopBorder, setUnderline

Methods inherited from class org.fit.layout.impl.GenericTreeNode

add, addUserAttribute, getDepth, getChildAt, getChildCount, getChildren, getIndex, getLeafCount, getNextSiblingNode, getParent, getPreviousSiblingNode, getRoot, getUserAttribute, insert, isLeaf, isRoot, remove, remove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getAllBoxes, getAreaTree, getBoxes, getName, getText, getTopology, insertParent, isSeparator, setName, updateTopologies

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

getBackgroundColor, getBorderCount, getBorderStyle, getBottomBorder, getBounds, getId, getLeftBorder, getPage, getRightBorder, getTopBorder, 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, getDepth, getChildArea, getChildAreas, getChildCount, getIndex, getLeafCount, getNextSibling, getParentArea, getPreviousSibling, getUserAttribute, insertChild, isAncestorOf, isLeaf, removeChild

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

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

Constructor Detail

AreaImpl

public AreaImpl(int x1,
                int y1,
                int x2,
                int y2)

Creates an empty area of a given size

AreaImpl

public AreaImpl(org.fit.layout.model.Rectangular r)

Creates an empty area of a given size

AreaImpl

public AreaImpl(org.fit.layout.model.Box box)

Creates an area from a single box. Update the area bounds and name accordingly.

Parameters:

box - The source box that will be contained in this area

AreaImpl

public AreaImpl(List<org.fit.layout.model.Box> boxList)

Creates an area from a a list of boxes. Update the area bounds and name accordingly.

Parameters:

boxList - The source boxes that will be contained in this area

AreaImpl

public AreaImpl(AreaImpl src)

Creates a copy of another area.

Parameters:

src - The source area

Method Detail

appendChild

public void appendChild(org.fit.layout.model.Area child)

Specified by:

appendChild in interface org.fit.layout.model.AreaTreeNode<org.fit.layout.model.Area>

Overrides:

appendChild in class org.fit.layout.impl.DefaultArea

appendChildren

public void appendChildren(List<org.fit.layout.model.Area> list)

Specified by:

appendChildren in interface org.fit.layout.model.AreaTreeNode<org.fit.layout.model.Area>

Overrides:

appendChildren in class org.fit.layout.impl.DefaultArea

removeAllChildren

public void removeAllChildren()

Specified by:

removeAllChildren in interface org.fit.layout.model.AreaTreeNode<org.fit.layout.model.Area>

Overrides:

removeAllChildren in class org.fit.layout.impl.GenericTreeNode

joinArea

public void joinArea(AreaImpl other,
                     org.fit.layout.model.Rectangular pos,
                     boolean horizontal)

Joins this area with another area and updates the layout in the grid to the given values. Moves the children of the other areas to this area.

Parameters:

other - The area to be joined to this area

pos - The position of the result in the grid

horizontal - Horizontal or vertical join?

join

public void join(AreaImpl other,
                 boolean horizontal)

Joins another area to this area. Update the bounds and the name accordingly.

Parameters:

other - The area to be joined to this area.

horizontal - If true, the areas are joined horizontally. This influences the resulting area borders. If false, the areas are joined vertically.

joinChild

public void joinChild(AreaImpl other)

Joins a child area to this area. Updates the bounds and the name accordingly.

Parameters:

other - The child area to be joined to this area.

getLevel

public int getLevel()

setLevel

public void setLevel(int level)

toString

public String toString()

Overrides:

toString in class org.fit.layout.impl.DefaultArea

chooseBox

public void chooseBox(org.fit.layout.model.Box node)

Add the box node to the area if its bounds are inside of the area bounds.

Parameters:

node - The box node to be added

hasSameBackground

public boolean hasSameBackground(AreaImpl other)

Checks if this area has the same background color as another area

Parameters:

other - the other area

Returns:

true if the areas are both transparent or they have the same background color declared

encloses

public boolean encloses(AreaImpl other)

contains

public boolean contains(int x,
                        int y)

hasContent

public boolean hasContent()

getEffectiveBackgroundColor

public Color getEffectiveBackgroundColor()

Specified by:

getEffectiveBackgroundColor in interface org.fit.layout.model.Area

Overrides:

getEffectiveBackgroundColor in class org.fit.layout.impl.DefaultArea

containsText

public boolean containsText()

Returns:

true if the area contains any text

isReplaced

public boolean isReplaced()

Specified by:

isReplaced in interface org.fit.layout.model.Area

Overrides:

isReplaced in class org.fit.layout.impl.DefaultArea

Returns:

true if the area contains replaced boxes only

getBoxText

public String getBoxText()

Returns the text string represented by a concatenation of all the boxes contained directly in this area (no subareas)

Overrides:

getBoxText in class org.fit.layout.impl.DefaultArea

getTextLength

public int getTextLength()

Returns the text string represented by a concatenation of all the boxes contained directly in this area.

getReplacedContent

public org.fit.layout.model.ContentObject getReplacedContent()

Returns:

true if the area contains any text

isHorizontalSeparator

public boolean isHorizontalSeparator()

Tries to guess if this area acts as a horizontal separator. The criteria are:

• It doesn't contain any text
• It is visible
• It is low and wide

Specified by:

isHorizontalSeparator in interface org.fit.layout.model.Area

Overrides:

isHorizontalSeparator in class org.fit.layout.impl.DefaultArea

Returns:

true if the area can be used as a horizontal separator

isVerticalSeparator

public boolean isVerticalSeparator()

Tries to guess if this area acts as a vertical separator. The criteria are the same as for the horizontal one.

Specified by:

isVerticalSeparator in interface org.fit.layout.model.Area

Overrides:

isVerticalSeparator in class org.fit.layout.impl.DefaultArea

Returns:

true if the area can be used as a vertical separator

createSuperArea

public org.fit.layout.model.Area createSuperArea(org.fit.layout.model.Rectangular gp,
                                                 List<org.fit.layout.model.Area> selected,
                                                 String name)

Specified by:

createSuperArea in interface org.fit.layout.model.Area

Overrides:

createSuperArea in class org.fit.layout.impl.DefaultArea

copy

public org.fit.layout.model.Area copy()

Specified by:

copy in interface org.fit.layout.model.Area

Overrides:

copy in class org.fit.layout.impl.DefaultArea

getDeclaredFontSize

public float getDeclaredFontSize()

Returns the font size declared for the first box. If there are multiple boxes, the first one is used. If there are no boxes (an artificial area), 0 is returned.

Returns:

the declared font size or 0 if there are no boxes

getFontSize

public float getFontSize()

Computes the average font size of the boxes in the area

Specified by:

getFontSize in interface org.fit.layout.model.ContentRect

Overrides:

getFontSize in class org.fit.layout.impl.DefaultContentRect

Returns:

the font size

getFontWeight

public float getFontWeight()

Computes the average font weight of the boxes in the area

Specified by:

getFontWeight in interface org.fit.layout.model.ContentRect

Overrides:

getFontWeight in class org.fit.layout.impl.DefaultContentRect

Returns:

the font size

getFontStyle

public float getFontStyle()

Computes the average font style of the boxes in the area

Specified by:

getFontStyle in interface org.fit.layout.model.ContentRect

Overrides:

getFontStyle in class org.fit.layout.impl.DefaultContentRect

Returns:

the font style

getUnderline

public float getUnderline()

Specified by:

getUnderline in interface org.fit.layout.model.ContentRect

Overrides:

getUnderline in class org.fit.layout.impl.DefaultContentRect

getLineThrough

public float getLineThrough()

Specified by:

getLineThrough in interface org.fit.layout.model.ContentRect

Overrides:

getLineThrough in class org.fit.layout.impl.DefaultContentRect

getColorLuminosity

public float getColorLuminosity()

Computes the average luminosity of the boxes in the area

Returns:

the font size

updateAverages

public void updateAverages(org.fit.layout.model.Area other)

Updates the average values when a new area is added or joined

Parameters:

other - the other area

resetAverages

protected void resetAverages()

Resets the averages to the values obtained from the text boxes that belong to this area only. No subareas are considered.

getText

public String getText()

Specified by:

getText in interface org.fit.layout.model.Area

Overrides:

getText in class org.fit.layout.impl.DefaultArea

getChildNodesInside

public List<org.fit.layout.model.Area> getChildNodesInside(org.fit.layout.model.Rectangular r)

Returns the child areas whose absolute coordinates intersect with the specified rectangle.

isAreaEmpty

public boolean isAreaEmpty(org.fit.layout.model.Rectangular r)

Check if there are some children in the given subarea of the area.

createSeparators

public void createSeparators()

Creates a set of the horizontal and vertical separators

getSeparators

public SeparatorSet getSeparators()

Returns:

the set of separators in this area

removeSimpleSeparators

public void removeSimpleSeparators()

Removes simple separators from current separator set. A simple separator has only one or zero visual areas at each side

findContentAbove

public AreaImpl findContentAbove(Separator sep)

Looks for the nearest text box area placed above the separator. If there are more such areas in the same distance, the leftmost one is returned.

Parameters:

sep - the separator

Returns:

the leaf area containing the box or null if there is nothing above the separator

addBox

public void addBox(org.fit.layout.model.Box box)

Adds a new box to the area and updates the area bounds.

Overrides:

addBox in class org.fit.layout.impl.DefaultArea

Parameters:

box - the new box to add

separatedDown

public boolean separatedDown()

Returns:

true if the area is separated from the areas below it

separatedUp

public boolean separatedUp()

Returns:

true if the area is separated from the areas above it

separatedLeft

public boolean separatedLeft()

Returns:

true if the area is separated from the areas on the left

separatedRight

public boolean separatedRight()

Returns:

true if the area is separated from the areas on the right

isExplicitlySeparated

public boolean isExplicitlySeparated()

When set to true, the area is considered to be separated from other areas explicitly, i.e. independently on its real borders or background. This is usually used for some new superareas.

Returns:

true, if the area is explicitly separated

setSeparated

public void setSeparated(boolean separated)

When set to true, the area is considered to be separated from other areas explicitly, i.e. independently on its real borders or background. This is usually used for some new superareas.

Parameters:

separated - true, if the area should be explicitly separated

getStyle

public AreaStyle getStyle()

Obtains the overall style of the area.

Returns:

the area style

hasSameStyle

public boolean hasSameStyle(AreaImpl other)

Compares two areas and decides whether they have the same style. The thresholds of the style are taken from the Config.

Parameters:

other - the other area to be compared

Returns:

true if the areas are considered to have the same style