BoxNode

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

All Implemented Interfaces:

Box, ContentRect, Rect
```
public class BoxNode
extends GenericTreeNode
implements 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
  Box.DisplayType, Box.Type

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`BoxNode(org.fit.cssbox.layout.Box box, 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(java.lang.Object obj)`
`void`	`expandToEnclose(BoxNode child)` Expands the box node in order to fully enclose another box
`protected java.lang.String`	`getAncestorAttribute(org.w3c.dom.Node node, java.lang.String elementName, java.lang.String attrName)`
`java.lang.String`	`getAttribute(java.lang.String name)` Obtains a value of an additional attribute.
`java.awt.Color`	`getBackgroundColor()` Returns the declared background color of the element or null when transparent.
`int`	`getBorderCount()` Obtains the number of defined borders for the box.
`Border`	`getBorderStyle(Border.Side side)` Obtains the properties of the box border at the given side.
`int`	`getBottomBorder()` Obtains the bottom border of the box
`Rectangular`	`getBounds()` Returns the logical bounds of the box node.
`org.fit.cssbox.layout.Box`	`getBox()`
`java.awt.Color`	`getColor()` Obtains the box text color.
`Rectangular`	`getContentBounds()` Returns the content bounds.
`ContentObject`	`getContentObject()` Obtains the content object contained in this box.
`Box.DisplayType`	`getDisplayType()` Obtains the display type of the element according to the CSS display: property.
`org.w3c.dom.Node`	`getDOMNode()`
`java.awt.Color`	`getEfficientBackground()`
`java.lang.String`	`getEfficientColor()` Get the effective text color.
`protected java.lang.String`	`getElementAttribute(org.w3c.dom.Node node, java.lang.String attrName)`
`java.lang.String`	`getFontFamily()` Obtains the font family name used by the box.
`float`	`getFontSize()` Obtains an average font size in the are in pixels.
`float`	`getFontStyle()` Obtains the average font style. 0 means no text in italics, 1 means all the text in italics.
`float`	`getFontWeight()` Obtains the average font style. 0 means no text is bold, 1 means all the text is bold
`int`	`getHeight()`
`BoxNode`	`getChildBox(int index)` Returns a specified child box.
`int`	`getId()` Obtains a unique ID of the area within the page.
`int`	`getLeftBorder()` Obtains the left border of the box
`float`	`getLineThrough()` Obtains the amount of line-through text. 0 means no underlined text, 1 means all the text is underlined.
`int`	`getOrder()`
`Page`	`getPage()` Obtains the page this block belongs to.
`BoxNode`	`getParentBox()` Obtains the parent box of this box.
`int`	`getRightBorder()` Obtains the right border of the box
`java.awt.Color`	`getStartColor()` Obtains the text color of the first box in the area.
`java.lang.String`	`getTagName()` When the box is generated by a DOM element, obtains the corresponding tag name.
`java.lang.String`	`getText()` Obtains the complete text contained in this box.
`int`	`getTopBorder()` Obtains the top border of the box
`Box.Type`	`getType()` Resurns the type of the box.
`float`	`getUnderline()` Obtains the amount of underlined text. 0 means no underlined text, 1 means all the text is underlined.
`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()` Checks whether the box has the bottom border defined.
`boolean`	`hasLeftBorder()` Checks whether the box has the left border defined.
`boolean`	`hasRightBorder()` Checks whether the box has right top border defined.
`boolean`	`hasTopBorder()` Checks whether the box has the top border defined.
`boolean`	`isBackgroundSeparated()` Checks whether the box is separated by background, i.e. its background color is not transparent and it is different from the ancestor background.
`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(java.util.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(java.awt.Color bgcolor)`
`void`	`setOrder(int order)`
`void`	`takeChildren(java.util.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.
`java.lang.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, addAttribute, getAttribute, getDepth, getChildAt, getChildCount, getChildren, getIndex, getLeafCount, 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 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 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 Rectangular content
```
    The total content bounds of the node.
  - visual
```
protected Rectangular visual
```
    Visual bounds of the node.
  - backgroundSeparated
```
protected boolean backgroundSeparated
```
    Is the box separated by background
  - efficientBackground
```
protected java.awt.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,
       Page page)
```
    Creates a new node containing a box.
    
    Parameters:
    box - the contained box
- Method Detail
  - getId
```
public int getId()
```
    Description copied from interface: ContentRect
    
    Obtains a unique ID of the area within the page.
    
    Specified by:
    
    getId in interface ContentRect
    
    Returns:
    the area ID
  - 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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - isBackgroundSeparated
```
public boolean isBackgroundSeparated()
```
    Description copied from interface: ContentRect
    
    Checks whether the box is separated by background, i.e. its background color is not transparent and it is different from the ancestor background.
    
    Specified by:
    
    isBackgroundSeparated in interface ContentRect
    
    Returns:
    true for background-separated boxes
  - setBackgroundSeparated
```
public void setBackgroundSeparated(boolean backgroundSeparated)
```
  - getEfficientBackground
```
public java.awt.Color getEfficientBackground()
```
    Returns:
    the efficient background color
  - setEfficientBackground
```
public void setEfficientBackground(java.awt.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 Rectangular getVisualBounds()
```
    Returns the bounds of the box as they visually appear to the user.
    
    Specified by:
    
    getVisualBounds in interface 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()
```
    Description copied from interface: ContentRect
    
    Obtains the number of defined borders for the box.
    
    Specified by:
    
    getBorderCount in interface ContentRect
    
    Returns:
    the number of defined borders for the box
  - hasTopBorder
```
public boolean hasTopBorder()
```
    Description copied from interface: ContentRect
    
    Checks whether the box has the top border defined.
    
    Specified by:
    
    hasTopBorder in interface 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 ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - hasBottomBorder
```
public boolean hasBottomBorder()
```
    Description copied from interface: ContentRect
    
    Checks whether the box has the bottom border defined.
    
    Specified by:
    
    hasBottomBorder in interface 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 ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - hasLeftBorder
```
public boolean hasLeftBorder()
```
    Description copied from interface: ContentRect
    
    Checks whether the box has the left border defined.
    
    Specified by:
    
    hasLeftBorder in interface 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 ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - hasRightBorder
```
public boolean hasRightBorder()
```
    Description copied from interface: ContentRect
    
    Checks whether the box has right top border defined.
    
    Specified by:
    
    hasRightBorder in interface 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 ContentRect
    
    Returns:
    the width of the border or 0 when there is no border
  - getBorderStyle
```
public Border getBorderStyle(Border.Side side)
```
    Description copied from interface: Box
    
    Obtains the properties of the box border at the given side.
    
    Specified by:
    
    getBorderStyle in interface Box
    
    Parameters:
    side - the border side.
    
    Returns:
    the corresponding border properties.
  - getEfficientColor
```
public java.lang.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 java.awt.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 Box
    
    Returns:
    true if the box is visible
  - getBackgroundColor
```
public java.awt.Color getBackgroundColor()
```
    Returns the declared background color of the element or null when transparent.
    
    Specified by:
    
    getBackgroundColor in interface ContentRect
    
    Returns:
    A color or null for transparent background
  - getBox
```
public org.fit.cssbox.layout.Box getBox()
```
    Returns:
    the contained box
  - getParentBox
```
public BoxNode getParentBox()
```
    Description copied from interface: Box
    
    Obtains the parent box of this box.
    
    Specified by:
    
    getParentBox in interface 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 Box
    
    Parameters:
    index - the child index
    
    Returns:
    the specified child box
  - getBounds
```
public Rectangular getBounds()
```
    Description copied from interface: Box
    
    Returns the logical 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
    
    Specified by:
    
    getBounds in interface Box
    
    Specified by:
    
    getBounds in interface ContentRect
    
    Returns:
    the total bounds of the node
  - getContentBounds
```
public Rectangular getContentBounds()
```
    Description copied from interface: Box
    
    Returns the content bounds. They correspond to the background bounds of the box; however, when a border is present, it is included in the contents. Moreover, the box is clipped by its clipping box.
    
    Specified by:
    
    getContentBounds in interface 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(java.util.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(java.util.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 java.lang.String getText()
```
    Description copied from interface: Box
    
    Obtains the complete text contained in this box.
    
    Specified by:
    
    getText in interface Box
    
    Returns:
    all the text contained in this box and its subboxes. Contents of the individual text boxes are separated by spaces.
  - getPage
```
public Page getPage()
```
    Description copied from interface: ContentRect
    
    Obtains the page this block belongs to.
    
    Specified by:
    
    getPage in interface ContentRect
    
    Returns:
    the page
  - 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
    
    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
    
    Returns:
    a value in the range 0..1
  - getFontSize
```
public float getFontSize()
```
    Description copied from interface: ContentRect
    
    Obtains an average font size in the are in pixels.
    
    Specified by:
    
    getFontSize in interface ContentRect
    
    Returns:
    the average font pixel size
  - getFontStyle
```
public float getFontStyle()
```
    Description copied from interface: ContentRect
    
    Obtains the average font style. 0 means no text in italics, 1 means all the text in italics.
    
    Specified by:
    
    getFontStyle in interface ContentRect
    
    Returns:
    a value in the range 0..1
  - getFontWeight
```
public float getFontWeight()
```
    Description copied from interface: ContentRect
    
    Obtains the average font style. 0 means no text is bold, 1 means all the text is bold
    
    Specified by:
    
    getFontWeight in interface ContentRect
    
    Returns:
    a value in the range 0..1
  - getX1
```
public int getX1()
```
    Specified by:
    
    getX1 in interface Rect
  - getY1
```
public int getY1()
```
    Specified by:
    
    getY1 in interface Rect
  - getX2
```
public int getX2()
```
    Specified by:
    
    getX2 in interface Rect
  - getY2
```
public int getY2()
```
    Specified by:
    
    getY2 in interface Rect
  - getWidth
```
public int getWidth()
```
    Specified by:
    
    getWidth in interface Rect
  - getHeight
```
public int getHeight()
```
    Specified by:
    
    getHeight in interface Rect
  - getColor
```
public java.awt.Color getColor()
```
    Description copied from interface: Box
    
    Obtains the box text color.
    
    Specified by:
    
    getColor in interface Box
    
    Returns:
    the text color
  - getFontFamily
```
public java.lang.String getFontFamily()
```
    Description copied from interface: Box
    
    Obtains the font family name used by the box.
    
    Specified by:
    
    getFontFamily in interface Box
    
    Returns:
    The font family name.
  - getContentObject
```
public ContentObject getContentObject()
```
    Description copied from interface: Box
    
    Obtains the content object contained in this box.
    
    Specified by:
    
    getContentObject in interface Box
    
    Returns:
    the content object or null when there is no object contained.
  - getType
```
public Box.Type getType()
```
    Description copied from interface: Box
    
    Resurns the type of the box.
    
    Specified by:
    
    getType in interface Box
    
    Returns:
    the box type
  - getDOMNode
```
public org.w3c.dom.Node getDOMNode()
```
  - getTagName
```
public java.lang.String getTagName()
```
    Description copied from interface: Box
    
    When the box is generated by a DOM element, obtains the corresponding tag name.
    
    Specified by:
    
    getTagName in interface Box
    
    Returns:
    the tag name or null for boxes that do not correspond to a DOM element.
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String name)
```
    Description copied from interface: Box
    
    Obtains a value of an additional attribute. The existing attribute names depend on the box implementation; they may correspond to HTML (DOM) attributes or they may be purely virtual. The typical attributes to be implemented are class or href.
    
    Specified by:
    
    getAttribute in interface Box
    
    Parameters:
    name - the attribute name
    
    Returns:
    the attribute value or null if the value is not specified.
  - getElementAttribute
```
protected java.lang.String getElementAttribute(org.w3c.dom.Node node,
                                   java.lang.String attrName)
```
  - getAncestorAttribute
```
protected java.lang.String getAncestorAttribute(org.w3c.dom.Node node,
                                    java.lang.String elementName,
                                    java.lang.String attrName)
```
  - getDisplayType
```
public Box.DisplayType getDisplayType()
```
    Description copied from interface: Box
    
    Obtains the display type of the element according to the CSS display: property.
    
    Specified by:
    
    getDisplayType in interface Box
    
    Returns:
    The display type of NULL if the box does not correspond to an element

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

getBorderStyle

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