org.fit.layout.model

Interface Box

All Superinterfaces:

ContentRect, Rect

All Known Implementing Classes:

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

Modifier and Type	Method and Description
String	getAttribute(String name) Obtains a value of an additional attribute.
Map<String,String>	getAttributes() Obtains the names and values of all the box attributes.
Rectangular	getBounds() Returns the logical bounds of the box node.
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.
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.
int	getSourceNodeId() Obtains a unique identification of the box source (e.g. the source DOM node).
String	getTagName() When the box is generated by a DOM element, obtains the corresponding tag name.
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, getBorderStyle, 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, move

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 ArrayIndexOutOfBoundsException

Obtains the n-th child box.

Parameters:

index - the child index

Returns:

the child box at the given index

Throws:

ArrayIndexOutOfBoundsException

getChildCount

int getChildCount()

Returns the number of child boxes for this box.

Returns:

the number of child boxes

getColor

Color getColor()

Obtains the box text color.

Returns:

the text color

getFontFamily

String getFontFamily()

Obtains the font family name used by the box.

Returns:

The font family name.

getText

String getText()

Obtains the complete text contained in this box. For the leaf boxes, it returns the corresponding string. For non-leaft boxes, it returns the concatentaion of the leaf box strings.

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.

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

getSourceNodeId

int getSourceNodeId()

Obtains a unique identification of the box source (e.g. the source DOM node). This may be used for recognizing the boxes generated by the same DOM node.

getTagName

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

String getAttribute(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.

getAttributes

Map<String,String> getAttributes()

Obtains the names and values of all the box attributes. 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.

Returns:

A map assigning values to the individual attribute names. An empty map is returned when no attributes are defined.

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