BoxNode (LayoutCSSBox 0.0.2 API)

java.lang.Object
- org.fit.layout.impl.GenericTreeNode
- - org.fit.layout.cssbox.BoxNode

All Implemented Interfaces:

org.fit.layout.model.Box, org.fit.layout.model.ContentRect, org.fit.layout.model.Rect
```
public class BoxNode
extends org.fit.layout.impl.GenericTreeNode
implements org.fit.layout.model.Box
```
A node of a tree of visual blocks.

Author:

burgetr

Nested Class Summary
- Nested classes/interfaces inherited from interface org.fit.layout.model.Box
  org.fit.layout.model.Box.DisplayType, org.fit.layout.model.Box.Type

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`backgroundSeparated` Is the box separated by background
`protected org.fit.layout.model.Rectangular`	`bounds` The total bounds of the box node.
`protected org.fit.cssbox.layout.Box`	`box` The CSSBox box that forms this node
`protected org.fit.layout.model.Rectangular`	`content` The total content bounds of the node.
`protected Color`	`efficientBackground` Efficient background color
`BoxNode`	`nearestParent` Potential nearest parent node in the box tree
`protected int`	`order` Order in the box tree.
`protected org.fit.layout.model.Page`	`page` The page this box belongs to.
`protected org.fit.layout.model.Rectangular`	`visual` Visual bounds of the node.

Constructor Summary

Constructors
Constructor and Description

BoxNode(org.fit.cssbox.layout.Box box, org.fit.layout.model.Page page)
Creates a new node containing a box.

Constructors
Constructor and Description
`BoxNode(org.fit.cssbox.layout.Box box, org.fit.layout.model.Page page)` Creates a new node containing a box.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`containsVisibleTextString()` Checks if the box text is visible (it does not contain spaces only).
`boolean`	`contentEncloses(BoxNode childNode)` Checks if another node is fully located inside the content bounds of this box.
`boolean`	`equals(Object obj)`
`void`	`expandToEnclose(BoxNode child)` Expands the box node in order to fully enclose another box
`protected String`	`getAncestorAttribute(Node node, String elementName, String attrName)`
`String`	`getAttribute(String name)`
`Color`	`getBackgroundColor()` Returns the declared background color of the element or null when transparent.
`int`	`getBorderCount()`
`int`	`getBottomBorder()` Obtains the bottom border of the box
`org.fit.layout.model.Rectangular`	`getBounds()`
`org.fit.cssbox.layout.Box`	`getBox()`
`Color`	`getColor()`
`org.fit.layout.model.Rectangular`	`getContentBounds()`
`org.fit.layout.model.ContentObject`	`getContentObject()`
`org.fit.layout.model.Box.DisplayType`	`getDisplayType()`
`Node`	`getDOMNode()`
`Color`	`getEfficientBackground()`
`String`	`getEfficientColor()` Get the effective text color.
`protected String`	`getElementAttribute(Node node, String attrName)`
`String`	`getFontFamily()`
`float`	`getFontSize()`
`float`	`getFontStyle()`
`float`	`getFontWeight()`
`int`	`getHeight()`
`BoxNode`	`getChildBox(int index)` Returns a specified child box.
`int`	`getId()`
`int`	`getLeftBorder()` Obtains the left border of the box
`float`	`getLineThrough()`
`int`	`getOrder()`
`org.fit.layout.model.Page`	`getPage()`
`BoxNode`	`getParentBox()`
`int`	`getRightBorder()` Obtains the right border of the box
`Color`	`getStartColor()` Obtains the text color of the first box in the area.
`String`	`getTagName()`
`String`	`getText()`
`int`	`getTopBorder()` Obtains the top border of the box
`org.fit.layout.model.Box.Type`	`getType()`
`float`	`getUnderline()`
`org.fit.layout.model.Rectangular`	`getVisualBounds()` Returns the bounds of the box as they visually appear to the user.
`int`	`getWidth()`
`int`	`getX1()`
`int`	`getX2()`
`int`	`getY1()`
`int`	`getY2()`
`boolean`	`hasBottomBorder()`
`boolean`	`hasLeftBorder()`
`boolean`	`hasRightBorder()`
`boolean`	`hasTopBorder()`
`boolean`	`isBackgroundSeparated()`
`boolean`	`isRootNode()`
`boolean`	`isVisible()` Checks whether the box is inside of the visible area and the text is visible and its color is different from the background
`boolean`	`isVisuallySeparated()`
`void`	`markNodesInside(Vector<BoxNode> list, boolean full)` Takes a list of nodes and selects the nodes that are located directly inside of this node's box.
`void`	`recomputeBounds()` Recomputes the total bounds of the whole subtree.
`void`	`recomputeVisualBounds()` Re-computes the visual bounds of the whole subtree.
`void`	`removeFromTree()` Removes the node from the tree.
`void`	`setBackgroundSeparated(boolean backgroundSeparated)`
`void`	`setEfficientBackground(Color bgcolor)`
`void`	`setOrder(int order)`
`void`	`takeChildren(Vector<BoxNode> list)` Goes through the parent's children, takes all the nodes that are inside of this node and makes them the children of this node.
`String`	`toString()`
`boolean`	`visuallyEncloses(BoxNode childNode)` Checks if another node is located inside the visual bounds of this box.
`boolean`	`visuallyEncloses1(BoxNode childNode)` Checks if another node is fully located inside the content bounds of this box.

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

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

Methods inherited from interface org.fit.layout.model.Box
getChildCount

- Field Detail
  - box
```
protected org.fit.cssbox.layout.Box box
```
    The CSSBox box that forms this node
  - page
```
protected org.fit.layout.model.Page page
```
    The page this box belongs to.
  - order
```
protected int order
```
    Order in the box tree. It is assumed that the box tree obtained from the rendering engine is sorted so that the siblings in the bottom are before the siblings in front (i.e. in the drawing order). Usually, this corresponds to the order in the document code. The order value doesn't correspond to the order value of the source box because the box order values correspond to the box creation order and not to the drawing order.
  - bounds
```
protected org.fit.layout.model.Rectangular bounds
```
    The total bounds of the box node. Normally, the bounds are the same as the content bounds. However, the BoxNode may be extended in order to enclose all the overlapping boxes
  - content
```
protected org.fit.layout.model.Rectangular content
```
    The total content bounds of the node.
  - visual
```
protected org.fit.layout.model.Rectangular visual
```
    Visual bounds of the node.
  - backgroundSeparated
```
protected boolean backgroundSeparated
```
    Is the box separated by background
  - efficientBackground
```
protected Color efficientBackground
```
    Efficient background color
  - nearestParent
```
public BoxNode nearestParent
```
    Potential nearest parent node in the box tree
- Constructor Detail
  - BoxNode
```
public BoxNode(org.fit.cssbox.layout.Box box,
       org.fit.layout.model.Page page)
```
    Creates a new node containing a box.
    
    Parameters:
    box - the contained box
- Method Detail
  - getId
```
public int getId()
```
    Specified by:
    
    getId in interface org.fit.layout.model.ContentRect
  - getOrder
```
public int getOrder()
```
    Returns:
    the order in the display tree
  - setOrder
```
public void setOrder(int order)
```
    Parameters:
    order - the display tree order to set
  - isRootNode
```
public boolean isRootNode()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - isBackgroundSeparated
```
public boolean isBackgroundSeparated()
```
    Specified by:
    
    isBackgroundSeparated in interface org.fit.layout.model.ContentRect
  - setBackgroundSeparated
```
public void setBackgroundSeparated(boolean backgroundSeparated)
```
  - getEfficientBackground
```
public Color getEfficientBackground()
```
    Returns:
    the efficient background color
  - setEfficientBackground
```
public void setEfficientBackground(Color bgcolor)
```
    Parameters:
    bgcolor - the efficientBackground to set
  - isVisuallySeparated
```
public boolean isVisuallySeparated()
```
    Returns:
    true if the box is visually separated by a border or a different background color.
  - getVisualBounds
```
public org.fit.layout.model.Rectangular getVisualBounds()
```
    Returns the bounds of the box as they visually appear to the user.
    
    Specified by:
    
    getVisualBounds in interface org.fit.layout.model.Box
    
    Returns:
    the visual bounds
  - recomputeVisualBounds
```
public void recomputeVisualBounds()
```
    Re-computes the visual bounds of the whole subtree.
  - recomputeBounds
```
public void recomputeBounds()
```
    Recomputes the total bounds of the whole subtree. The bounds of each box will correspond to its visual bounds. If the child boxes exceed the parent box, the parent box bounds will be expanded accordingly.
  - getBorderCount
```
public int getBorderCount()
```
    Specified by:
    
    getBorderCount in interface org.fit.layout.model.ContentRect
    
    Returns:
    the number of defined borders for the box
  - hasTopBorder
```
public boolean hasTopBorder()
```
    Specified by:
    
    hasTopBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    true if the box has a top border
  - getTopBorder
```
public int getTopBorder()
```
    Obtains the top border of the box
    
    Specified by:
    
    getTopBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - hasBottomBorder
```
public boolean hasBottomBorder()
```
    Specified by:
    
    hasBottomBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    true if the box has a bottom border
  - getBottomBorder
```
public int getBottomBorder()
```
    Obtains the bottom border of the box
    
    Specified by:
    
    getBottomBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - hasLeftBorder
```
public boolean hasLeftBorder()
```
    Specified by:
    
    hasLeftBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    true if the box has a left border
  - getLeftBorder
```
public int getLeftBorder()
```
    Obtains the left border of the box
    
    Specified by:
    
    getLeftBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - hasRightBorder
```
public boolean hasRightBorder()
```
    Specified by:
    
    hasRightBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    true if the box has a right border
  - getRightBorder
```
public int getRightBorder()
```
    Obtains the right border of the box
    
    Specified by:
    
    getRightBorder in interface org.fit.layout.model.ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - getEfficientColor
```
public String getEfficientColor()
```
    Get the effective text color. If the text color is set, it is returned. When the color is not set, the parent boxes are considered.
    
    Returns:
    the background color string
  - getStartColor
```
public Color getStartColor()
```
    Obtains the text color of the first box in the area.
    
    Returns:
    The color.
  - containsVisibleTextString
```
public boolean containsVisibleTextString()
```
    Checks if the box text is visible (it does not contain spaces only). This is not equivalent to isWhitespace() because non-beraking spaces are not whitespace characters but they are not visible.
    
    Returns:
    if the box text consists of space characters only
  - isVisible
```
public boolean isVisible()
```
    Checks whether the box is inside of the visible area and the text is visible and its color is different from the background
    
    Specified by:
    
    isVisible in interface org.fit.layout.model.Box
    
    Returns:
    true if the box is visible
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Returns the declared background color of the element or null when transparent.
    
    Specified by:
    
    getBackgroundColor in interface org.fit.layout.model.ContentRect
  - getBox
```
public org.fit.cssbox.layout.Box getBox()
```
    Returns:
    the contained box
  - getParentBox
```
public BoxNode getParentBox()
```
    Specified by:
    
    getParentBox in interface org.fit.layout.model.Box
    
    Returns:
    the parent box of this box in the tree
  - getChildBox
```
public BoxNode getChildBox(int index)
```
    Returns a specified child box.
    
    Specified by:
    
    getChildBox in interface org.fit.layout.model.Box
    
    Parameters:
    index - the child index
    
    Returns:
    the specified child box
  - getBounds
```
public org.fit.layout.model.Rectangular getBounds()
```
    Specified by:
    
    getBounds in interface org.fit.layout.model.Box
    
    Specified by:
    
    getBounds in interface org.fit.layout.model.ContentRect
    
    Returns:
    the total bounds of the node
  - getContentBounds
```
public org.fit.layout.model.Rectangular getContentBounds()
```
    Specified by:
    
    getContentBounds in interface org.fit.layout.model.Box
    
    Returns:
    the content bounds of the node
  - visuallyEncloses
```
public boolean visuallyEncloses(BoxNode childNode)
```
    Checks if another node is located inside the visual bounds of this box.
    
    Parameters:
    childNode - the node to check
    
    Returns:
    true if the child node is completely inside this node, false otherwise
  - visuallyEncloses1
```
public boolean visuallyEncloses1(BoxNode childNode)
```
    Checks if another node is fully located inside the content bounds of this box.
    
    Parameters:
    childNode - the node to check
    
    Returns:
    true if the child node is completely inside this node, false otherwise
  - contentEncloses
```
public boolean contentEncloses(BoxNode childNode)
```
    Checks if another node is fully located inside the content bounds of this box.
    
    Parameters:
    childNode - the node to check
    
    Returns:
    true if the child node is completely inside this node, false otherwise
  - expandToEnclose
```
public void expandToEnclose(BoxNode child)
```
    Expands the box node in order to fully enclose another box
  - markNodesInside
```
public void markNodesInside(Vector<BoxNode> list,
                   boolean full)
```
    Takes a list of nodes and selects the nodes that are located directly inside of this node's box. The nearestParent of the selected boxes is set to this box.
    
    Parameters:
    list - the list of nodes to test
    full - when set to true, all the nodes within the box content bounds are considered. Otherwise, only the boxes within the visual bounds are considered.
  - takeChildren
```
public void takeChildren(Vector<BoxNode> list)
```
    Goes through the parent's children, takes all the nodes that are inside of this node and makes them the children of this node. Then, recursively calls the children to take their nodes.
  - removeFromTree
```
public void removeFromTree()
```
    Removes the node from the tree. Clears the parent and removes all the child node.
  - getText
```
public String getText()
```
    Specified by:
    
    getText in interface org.fit.layout.model.Box
    
    Returns:
    all the text contained in this box and its subboxes. Contents of the individual text boxes are separated by spaces.
  - getPage
```
public org.fit.layout.model.Page getPage()
```
    Specified by:
    
    getPage in interface org.fit.layout.model.ContentRect
  - getUnderline
```
public float getUnderline()
```
    Specified by:
    
    getUnderline in interface org.fit.layout.model.ContentRect
  - getLineThrough
```
public float getLineThrough()
```
    Specified by:
    
    getLineThrough in interface org.fit.layout.model.ContentRect
  - getFontSize
```
public float getFontSize()
```
    Specified by:
    
    getFontSize in interface org.fit.layout.model.ContentRect
  - getFontStyle
```
public float getFontStyle()
```
    Specified by:
    
    getFontStyle in interface org.fit.layout.model.ContentRect
  - getFontWeight
```
public float getFontWeight()
```
    Specified by:
    
    getFontWeight in interface org.fit.layout.model.ContentRect
  - getX1
```
public int getX1()
```
    Specified by:
    
    getX1 in interface org.fit.layout.model.Rect
  - getY1
```
public int getY1()
```
    Specified by:
    
    getY1 in interface org.fit.layout.model.Rect
  - getX2
```
public int getX2()
```
    Specified by:
    
    getX2 in interface org.fit.layout.model.Rect
  - getY2
```
public int getY2()
```
    Specified by:
    
    getY2 in interface org.fit.layout.model.Rect
  - getWidth
```
public int getWidth()
```
    Specified by:
    
    getWidth in interface org.fit.layout.model.Rect
  - getHeight
```
public int getHeight()
```
    Specified by:
    
    getHeight in interface org.fit.layout.model.Rect
  - getColor
```
public Color getColor()
```
    Specified by:
    
    getColor in interface org.fit.layout.model.Box
  - getFontFamily
```
public String getFontFamily()
```
    Specified by:
    
    getFontFamily in interface org.fit.layout.model.Box
  - getContentObject
```
public org.fit.layout.model.ContentObject getContentObject()
```
    Specified by:
    
    getContentObject in interface org.fit.layout.model.Box
  - getType
```
public org.fit.layout.model.Box.Type getType()
```
    Specified by:
    
    getType in interface org.fit.layout.model.Box
  - getDOMNode
```
public Node getDOMNode()
```
  - getTagName
```
public String getTagName()
```
    Specified by:
    
    getTagName in interface org.fit.layout.model.Box
  - getAttribute
```
public String getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface org.fit.layout.model.Box
  - getElementAttribute
```
protected String getElementAttribute(Node node,
                         String attrName)
```
  - getAncestorAttribute
```
protected String getAncestorAttribute(Node node,
                          String elementName,
                          String attrName)
```
  - getDisplayType
```
public org.fit.layout.model.Box.DisplayType getDisplayType()
```
    Specified by:
    
    getDisplayType in interface org.fit.layout.model.Box

Class BoxNode

Nested Class Summary

Nested classes/interfaces inherited from interface org.fit.layout.model.Box

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

box

page

order

bounds

content

visual

backgroundSeparated

efficientBackground

nearestParent

Constructor Detail

BoxNode

Method Detail

getId

getOrder

setOrder

isRootNode

toString

equals

isBackgroundSeparated

setBackgroundSeparated

getEfficientBackground

setEfficientBackground

isVisuallySeparated

getVisualBounds

recomputeVisualBounds

recomputeBounds

getBorderCount

hasTopBorder

getTopBorder

hasBottomBorder

getBottomBorder

hasLeftBorder

getLeftBorder

hasRightBorder

getRightBorder

getEfficientColor

getStartColor

containsVisibleTextString

isVisible

getBackgroundColor

getBox

getParentBox

getChildBox

getBounds

getContentBounds

visuallyEncloses

visuallyEncloses1

contentEncloses

expandToEnclose

markNodesInside

takeChildren

removeFromTree

getText

getPage

getUnderline

getLineThrough

getFontSize

getFontStyle

getFontWeight

getX1

getY1

getX2

getY2

getWidth

getHeight

getColor

getFontFamily

getContentObject

getType

getDOMNode