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:

Area, AreaTreeNode<Area>, ContentRect, Rect, Taggable
```
public class AreaImpl
extends DefaultArea
implements 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(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(Rectangular r)` Creates an empty area of a given size
`AreaImpl(java.util.Vector<Box> boxList)` Creates an area from a a list of boxes.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addBox(Box box)` Adds a new box to the area and updates the area bounds.
`void`	`appendChild(Area child)` Appends a new child area to the list of child areas of this area.
`void`	`appendChildren(java.util.List<Area> list)` Appends a list of child areas to the list of child areas of this area.
`boolean`	`contains(int x, int y)`
`boolean`	`containsText()`
`void`	`createSeparators()` Creates a set of the horizontal and vertical separators
`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.
`boolean`	`encloses(AreaImpl other)`
`AreaImpl`	`findContentAbove(Separator sep)` Looks for the nearest text box area placed above the separator.
`java.lang.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.
`java.awt.Color`	`getEffectiveBackgroundColor()` Obtains the effective background color visible under the area.
`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
`java.util.Vector<AreaImpl>`	`getChildNodesInside(Rectangular r)` Returns the child areas whose absolute coordinates intersect with the specified rectangle.
`int`	`getLevel()`
`float`	`getLineThrough()` Obtains the amount of line-through text. 0 means no underlined text, 1 means all the text is underlined.
`ContentObject`	`getReplacedContent()`
`SeparatorSet`	`getSeparators()`
`AreaStyle`	`getStyle()` Obtains the overall style of the area.
`java.lang.String`	`getText()` Returns the complete text contained in this area and its sub area.
`int`	`getTextLength()` Returns the text string represented by a concatenation of all the boxes contained directly in this area.
`float`	`getUnderline()` Obtains the amount of underlined text. 0 means no underlined text, 1 means all the text is underlined.
`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(Box node)` Add the box node to the area if its bounds are inside of the area bounds.
`boolean`	`isAreaEmpty(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()` Checks whether this area is formed by replaced boxes.
`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, 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()` Removes all the child areas from their parent.
`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.
`java.lang.String`	`toString()`
`void`	`updateAverages(AreaImpl 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, getBoxes, getContentBounds, getGrid, getGridHeight, getGridPosition, getGridWidth, getGridX, getGridY, getChildArea, getChildAreas, getChildAtGridPos, getIndex, getMostSupportedTag, getName, getNextOnLine, getNextSibling, getParentArea, getPreviousOnLine, getPreviousSibling, getTags, getTagSupport, getText, getTopology, hasTag, hasTag, insertChild, isSeparator, removeAllTags, removeChild, removeTag, setGridPosition, setGridX, setGridY, SetHorizontalSeparator, setName, setNextOnLine, setPreviousOnLine, SetVerticalSeparator

Methods inherited from class org.fit.layout.impl.DefaultContentRect
getBackgroundColor, getBorderCount, getBottomBorder, getBounds, getHeight, getId, getLeftBorder, getPage, getRightBorder, getTopBorder, getWidth, getX1, getX2, getY1, getY2, hasBottomBorder, hasLeftBorder, hasRightBorder, hasTopBorder, isBackgroundSeparated, setBackgroundColor, setBackgroundSeparated, setBorders, setBottomBorder, setBounds, setFontSize, setFontStyle, setFontWeight, setId, setLeftBorder, setLineThrough, setPage, setRightBorder, setTopBorder, setUnderline

Methods inherited from class org.fit.layout.impl.GenericTreeNode
add, addAttribute, getAttribute, getDepth, getChildAt, getChildCount, getChildren, getIndex, getLeafCount, getNextSiblingNode, getParent, getPreviousSiblingNode, getRoot, insert, isLeaf, isRoot, remove, remove

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fit.layout.model.Area
getAllBoxes, getBoxes, getText, getTopology, isSeparator

Methods inherited from interface org.fit.layout.model.ContentRect
getBackgroundColor, getBorderCount, 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

Methods inherited from interface org.fit.layout.model.AreaTreeNode
addAttribute, getAttribute, getDepth, getChildArea, getChildAreas, getChildCount, getIndex, getLeafCount, getNextSibling, getParentArea, getPreviousSibling, insertChild, isLeaf, removeChild

Methods inherited from interface org.fit.layout.model.Taggable
addTag, getMostSupportedTag, 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(Rectangular r)
```
    Creates an empty area of a given size
  - AreaImpl
```
public AreaImpl(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(java.util.Vector<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(Area child)
```
    Description copied from interface: AreaTreeNode
    
    Appends a new child area to the list of child areas of this area.
    
    Specified by:
    
    appendChild in interface AreaTreeNode<Area>
    
    Overrides:
    
    appendChild in class DefaultArea
    
    Parameters:
    child - The new child to be appended
  - appendChildren
```
public void appendChildren(java.util.List<Area> list)
```
    Description copied from interface: AreaTreeNode
    
    Appends a list of child areas to the list of child areas of this area.
    
    Specified by:
    
    appendChildren in interface AreaTreeNode<Area>
    
    Overrides:
    
    appendChildren in class DefaultArea
    
    Parameters:
    list - The list of new children to be appended
  - removeAllChildren
```
public void removeAllChildren()
```
    Description copied from interface: AreaTreeNode
    
    Removes all the child areas from their parent.
    
    Specified by:
    
    removeAllChildren in interface AreaTreeNode<Area>
    
    Overrides:
    
    removeAllChildren in class GenericTreeNode
  - joinArea
```
public void joinArea(AreaImpl other,
            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 java.lang.String toString()
```
    Overrides:
    
    toString in class DefaultArea
  - chooseBox
```
public void chooseBox(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 java.awt.Color getEffectiveBackgroundColor()
```
    Description copied from interface: Area
    
    Obtains the effective background color visible under the area.
    
    Specified by:
    
    getEffectiveBackgroundColor in interface Area
    
    Overrides:
    
    getEffectiveBackgroundColor in class DefaultArea
    
    Returns:
    The background color.
  - containsText
```
public boolean containsText()
```
    Returns:
    true if the area contains any text
  - isReplaced
```
public boolean isReplaced()
```
    Description copied from interface: Area
    
    Checks whether this area is formed by replaced boxes.
    
    Specified by:
    
    isReplaced in interface Area
    
    Overrides:
    
    isReplaced in class DefaultArea
    
    Returns:
    true if the area contains replaced boxes only
  - getBoxText
```
public java.lang.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 DefaultArea
  - getTextLength
```
public int getTextLength()
```
    Returns the text string represented by a concatenation of all the boxes contained directly in this area.
  - getReplacedContent
```
public 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 Area
    
    Overrides:
    
    isHorizontalSeparator in class 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 Area
    
    Overrides:
    
    isVerticalSeparator in class DefaultArea
    
    Returns:
    true if the area can be used as a vertical separator
  - createSuperArea
```
public Area createSuperArea(Rectangular gp,
                   java.util.List<Area> selected,
                   java.lang.String name)
```
    Description copied from interface: Area
    
    Creates a new subarea from a specified region of the area and moves the selected child nodes to the new area.
    
    Specified by:
    
    createSuperArea in interface Area
    
    Overrides:
    
    createSuperArea in class DefaultArea
    
    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
  - 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 ContentRect
    
    Overrides:
    
    getFontSize in class 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 ContentRect
    
    Overrides:
    
    getFontWeight in class 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 ContentRect
    
    Overrides:
    
    getFontStyle in class DefaultContentRect
    
    Returns:
    the font style
  - getUnderline
```
public float getUnderline()
```
    Description copied from interface: ContentRect
    
    Obtains the amount of underlined text. 0 means no underlined text, 1 means all the text is underlined.
    
    Specified by:
    
    getUnderline in interface ContentRect
    
    Overrides:
    
    getUnderline in class DefaultContentRect
    
    Returns:
    a value in the range 0..1
  - getLineThrough
```
public float getLineThrough()
```
    Description copied from interface: ContentRect
    
    Obtains the amount of line-through text. 0 means no underlined text, 1 means all the text is underlined.
    
    Specified by:
    
    getLineThrough in interface ContentRect
    
    Overrides:
    
    getLineThrough in class DefaultContentRect
    
    Returns:
    a value in the range 0..1
  - getColorLuminosity
```
public float getColorLuminosity()
```
    Computes the average luminosity of the boxes in the area
    
    Returns:
    the font size
  - updateAverages
```
public void updateAverages(AreaImpl 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 java.lang.String getText()
```
    Description copied from interface: Area
    
    Returns the complete text contained in this area and its sub area.
    
    Specified by:
    
    getText in interface Area
    
    Overrides:
    
    getText in class DefaultArea
    
    Returns:
    A text string (possibly empty)
  - getChildNodesInside
```
public java.util.Vector<AreaImpl> getChildNodesInside(Rectangular r)
```
    Returns the child areas whose absolute coordinates intersect with the specified rectangle.
  - isAreaEmpty
```
public boolean isAreaEmpty(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
```
protected void addBox(Box box)
```
    Adds a new box to the area and updates the area bounds.
    
    Overrides:
    
    addBox in class 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

Class AreaImpl

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

Constructor Detail

AreaImpl

AreaImpl

AreaImpl

AreaImpl

AreaImpl

Method Detail

appendChild

appendChildren

removeAllChildren

joinArea

join

joinChild

getLevel

setLevel

toString

chooseBox

hasSameBackground

encloses

contains

hasContent

getEffectiveBackgroundColor

containsText

isReplaced

getBoxText

getTextLength

getReplacedContent

isHorizontalSeparator

isVerticalSeparator

createSuperArea

getDeclaredFontSize

getFontSize

getFontWeight

getFontStyle

getUnderline

getLineThrough

getColorLuminosity

updateAverages

resetAverages

getText

getChildNodesInside

isAreaEmpty

createSeparators

getSeparators

removeSimpleSeparators

findContentAbove

addBox

separatedDown

separatedUp

separatedLeft

separatedRight

isExplicitlySeparated

setSeparated

getStyle

hasSameStyle