org.fit.layout.model

Interface Box

All Superinterfaces:

ContentRect, Rect

All Known Implementing Classes:

BoxNode, DefaultBox

public interface Box
extends ContentRect

This class represents a box in the rendered page tree. It may contain a text or a content object (e.g. an image).

Author:

burgetr

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Box.DisplayType CSS Display Type
static class	Box.Type The type of the box.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAttribute(java.lang.String name) Obtains a value of an additional attribute.
Border	getBorderStyle(Border.Side side) Obtains the properties of the box border at the given side.
Rectangular	getBounds() Returns the logical bounds of the box node.
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.
java.lang.String	getFontFamily() Obtains the font family name used by the box.
Box	getChildBox(int index) Obtains the n-th child box.
int	getChildCount() Returns the number of child boxes for this box.
Box	getParentBox() Obtains the parent box of this box.
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.
Box.Type	getType() Resurns the type of the box.
Rectangular	getVisualBounds() Returns the bounds of the box as they visually appear to the user.
boolean	isVisible() Checks whether the box is visible.

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

getBackgroundColor, getBorderCount, getBottomBorder, 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

Method Detail

getParentBox

Box getParentBox()

Obtains the parent box of this box.

Returns:

The parent box or null when this is the root box.

getChildBox

Box getChildBox(int index)
                throws java.lang.ArrayIndexOutOfBoundsException

Obtains the n-th child box.

Parameters:

index - the child index

Returns:

the child box at the given index

Throws:

java.lang.ArrayIndexOutOfBoundsException

getChildCount

int getChildCount()

Returns the number of child boxes for this box.

Returns:

the number of child boxes

getColor

java.awt.Color getColor()

Obtains the box text color.

Returns:

the text color

getFontFamily

java.lang.String getFontFamily()

Obtains the font family name used by the box.

Returns:

The font family name.

getText

java.lang.String getText()

Obtains the complete text contained in this box.

Returns:

a text string (possibly empty)

getContentObject

ContentObject getContentObject()

Obtains the content object contained in this box.

Returns:

the content object or null when there is no object contained.

getBorderStyle

Border getBorderStyle(Border.Side side)

Obtains the properties of the box border at the given side.

Parameters:

side - the border side.

Returns:

the corresponding border properties.

getBounds

Rectangular getBounds()

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 ContentRect

Returns:

the logical bounds of the box

getContentBounds

Rectangular getContentBounds()

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.

Returns:

the content bounds of the box

getVisualBounds

Rectangular getVisualBounds()

Returns the bounds of the box as they visually appear to the user.

Returns:

the visual bounds

isVisible

boolean isVisible()

Checks whether the box is visible.

Returns:

true when the box is visible

getType

Box.Type getType()

Resurns the type of the box.

Returns:

the box type

getTagName

java.lang.String getTagName()

When the box is generated by a DOM element, obtains the corresponding tag name.

Returns:

the tag name or null for boxes that do not correspond to a DOM element.

getAttribute

java.lang.String getAttribute(java.lang.String name)

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.

Parameters:

name - the attribute name

Returns:

the attribute value or null if the value is not specified.

getDisplayType

Box.DisplayType getDisplayType()

Obtains the display type of the element according to the CSS display: property.

Returns:

The display type of NULL if the box does not correspond to an element