org.fit.layout.impl

Class DefaultBox

java.lang.Object

org.fit.layout.impl.GenericTreeNode

org.fit.layout.impl.DefaultContentRect

org.fit.layout.impl.DefaultBox

All Implemented Interfaces:

Box, ContentRect, Rect

public class DefaultBox
extends DefaultContentRect
implements Box

Default generic box implementation.

Author:

burgetr

Nested Class Summary

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

Box.DisplayType, Box.Type

Constructor Summary

Constructors

Constructor and Description
DefaultBox()
DefaultBox(DefaultBox src)

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.
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.
int	getHeight()
Box	getChildBox(int index) Obtains the n-th child 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.
int	getWidth()
int	getX1()
int	getX2()
int	getY1()
int	getY2()
boolean	isVisible() Checks whether the box is visible.
void	move(int xofs, int yofs)
void	removeAttribute(String name)
void	setAttribute(String name, String value)
void	setColor(Color color)
void	setContentBounds(Rectangular contentBounds)
void	setContentObject(ContentObject contentObject)
void	setDisplayType(Box.DisplayType displayType)
void	setFontFamily(String fontFamily)
void	setSourceNodeId(int sourceNodeId)
void	setTagName(String tagName)
void	setText(String text)
void	setType(Box.Type type)
void	setVisible(boolean visible)
void	setVisualBounds(Rectangular visualBounds)
String	toString()

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

equals, getBackgroundColor, getBorderCount, getBorderStyle, getBottomBorder, getBounds, getFontSize, getFontStyle, getFontWeight, getId, getLeftBorder, getLineThrough, getPage, getRightBorder, getTopBorder, getUnderline, hasBottomBorder, hashCode, hasLeftBorder, hasRightBorder, hasTopBorder, isBackgroundSeparated, resetId, setBackgroundColor, setBackgroundSeparated, setBorders, setBorderStyle, setBottomBorder, setBounds, setFontSize, setFontStyle, setFontWeight, setId, setLeftBorder, setLineThrough, setPage, setRightBorder, setTopBorder, setUnderline

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

add, addUserAttribute, getDepth, getChildAt, getChildCount, getChildren, getIndex, getLeafCount, getNextSiblingNode, getParent, getPreviousSiblingNode, getRoot, getUserAttribute, insert, isLeaf, isRoot, remove, remove, removeAllChildren

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getBounds, getChildCount

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

Constructor Detail

DefaultBox

public DefaultBox()

DefaultBox

public DefaultBox(DefaultBox src)

Method Detail

getChildBox

public Box getChildBox(int index)

Description copied from interface: Box

Obtains the n-th child box.

Specified by:

getChildBox in interface Box

Parameters:

index - the child index

Returns:

the child box at the given index

getParentBox

public Box getParentBox()

Description copied from interface: Box

Obtains the parent box of this box.

Specified by:

getParentBox in interface Box

Returns:

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

isVisible

public boolean isVisible()

Description copied from interface: Box

Checks whether the box is visible.

Specified by:

isVisible in interface Box

Returns:

true when the box is visible

setVisible

public void setVisible(boolean visible)

getColor

public Color getColor()

Description copied from interface: Box

Obtains the box text color.

Specified by:

getColor in interface Box

Returns:

the text color

setColor

public void setColor(Color color)

getFontFamily

public 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.

setFontFamily

public void setFontFamily(String fontFamily)

getText

public String getText()

Description copied from interface: Box

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.

Specified by:

getText in interface Box

Returns:

a text string (possibly empty)

setText

public void setText(String text)

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.

setContentObject

public void setContentObject(ContentObject contentObject)

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 box

setContentBounds

public void setContentBounds(Rectangular contentBounds)

getVisualBounds

public Rectangular getVisualBounds()

Description copied from interface: Box

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

Specified by:

getVisualBounds in interface Box

Returns:

the visual bounds

setVisualBounds

public void setVisualBounds(Rectangular visualBounds)

getSourceNodeId

public int getSourceNodeId()

Description copied from interface: Box

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.

Specified by:

getSourceNodeId in interface Box

setSourceNodeId

public void setSourceNodeId(int sourceNodeId)

getTagName

public 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.

setTagName

public void setTagName(String tagName)

getAttribute

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

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: Box

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.

Specified by:

getAttributes in interface Box

Returns:

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

setAttribute

public void setAttribute(String name,
                         String value)

removeAttribute

public void removeAttribute(String name)

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

setType

public void setType(Box.Type type)

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

setDisplayType

public void setDisplayType(Box.DisplayType displayType)

getX1

public int getX1()

Specified by:

getX1 in interface Rect

Overrides:

getX1 in class DefaultContentRect

getY1

public int getY1()

Specified by:

getY1 in interface Rect

Overrides:

getY1 in class DefaultContentRect

getX2

public int getX2()

Specified by:

getX2 in interface Rect

Overrides:

getX2 in class DefaultContentRect

getY2

public int getY2()

Specified by:

getY2 in interface Rect

Overrides:

getY2 in class DefaultContentRect

getWidth

public int getWidth()

Specified by:

getWidth in interface Rect

Overrides:

getWidth in class DefaultContentRect

getHeight

public int getHeight()

Specified by:

getHeight in interface Rect

Overrides:

getHeight in class DefaultContentRect

move

public void move(int xofs,
                 int yofs)

Specified by:

move in interface Rect

Overrides:

move in class DefaultContentRect

toString

public String toString()

Overrides:

toString in class Object