org.fit.layout.impl

Class DefaultContentRect

java.lang.Object

org.fit.layout.impl.GenericTreeNode

org.fit.layout.impl.DefaultContentRect

All Implemented Interfaces:

ContentRect, Rect

Direct Known Subclasses:

DefaultArea, DefaultBox

public class DefaultContentRect
extends GenericTreeNode
implements ContentRect

A default ContentRect implementation. This class is usually not used directly; the DefaultBox and DefaultArea subclasses should be used instead.

Author:

burgetr

Constructor Summary

Constructors

Constructor and Description
DefaultContentRect()
DefaultContentRect(DefaultContentRect src)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Color	getBackgroundColor() Obtains the background color of the area.
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 width.
Rectangular	getBounds() Obtains the pixel position within in the page.
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()
int	getId() Obtains a unique ID of the area within the page.
int	getLeftBorder() Obtains the left border width.
float	getLineThrough() Obtains the amount of line-through text. 0 means no underlined text, 1 means all the text is underlined.
Page	getPage() Obtains the page this block belongs to.
int	getRightBorder() Obtains the right border width.
int	getTopBorder() Obtains the top border width.
float	getUnderline() Obtains the amount of underlined text. 0 means no underlined text, 1 means all the text is underlined.
int	getWidth()
int	getX1()
int	getX2()
int	getY1()
int	getY2()
boolean	hasBottomBorder() Checks whether the box has the bottom border defined.
int	hashCode()
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.
void	move(int xofs, int yofs)
static void	resetId()
void	setBackgroundColor(Color backgroundColor)
void	setBackgroundSeparated(boolean backgroundSeparated)
void	setBorders(int top, int right, int bottom, int left) Sets all the border values.
void	setBorderStyle(Border.Side side, Border style)
void	setBottomBorder(int width)
void	setBounds(Rectangular bounds)
void	setFontSize(float fontSize)
void	setFontStyle(float fontStyle)
void	setFontWeight(float fontWeight)
void	setId(int id)
void	setLeftBorder(int width)
void	setLineThrough(float lineThrough)
void	setPage(Page page)
void	setRightBorder(int width)
void	setTopBorder(int width)
void	setUnderline(float underline)

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, toString, wait, wait, wait

Constructor Detail

DefaultContentRect

public DefaultContentRect()

DefaultContentRect

public DefaultContentRect(DefaultContentRect src)

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

setId

public void setId(int id)

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

setPage

public void setPage(Page page)

getBackgroundColor

public Color getBackgroundColor()

Description copied from interface: ContentRect

Obtains the background color of the area.

Specified by:

getBackgroundColor in interface ContentRect

Returns:

A color or null for transparent background

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

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)

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

setUnderline

public void setUnderline(float underline)

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

setLineThrough

public void setLineThrough(float lineThrough)

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

setFontSize

public void setFontSize(float fontSize)

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

setFontStyle

public void setFontStyle(float fontStyle)

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

setFontWeight

public void setFontWeight(float fontWeight)

getTopBorder

public int getTopBorder()

Description copied from interface: ContentRect

Obtains the top border width.

Specified by:

getTopBorder in interface ContentRect

Returns:

the width of the border or 0 when there is no border

setTopBorder

public void setTopBorder(int width)

getBottomBorder

public int getBottomBorder()

Description copied from interface: ContentRect

Obtains the bottom border width.

Specified by:

getBottomBorder in interface ContentRect

Returns:

the width of the border or 0 when there is no border

setBottomBorder

public void setBottomBorder(int width)

getLeftBorder

public int getLeftBorder()

Description copied from interface: ContentRect

Obtains the left border width.

Specified by:

getLeftBorder in interface ContentRect

Returns:

the width of the border or 0 when there is no border

setLeftBorder

public void setLeftBorder(int width)

getRightBorder

public int getRightBorder()

Description copied from interface: ContentRect

Obtains the right border width.

Specified by:

getRightBorder in interface ContentRect

Returns:

the width of the border or 0 when there is no border

setRightBorder

public void setRightBorder(int width)

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

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

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

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

setBorders

public void setBorders(int top,
                       int right,
                       int bottom,
                       int left)

Sets all the border values.

Parameters:

top -

right -

bottom -

left -

getBorderStyle

public Border getBorderStyle(Border.Side side)

Description copied from interface: ContentRect

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

Specified by:

getBorderStyle in interface ContentRect

Parameters:

side - the border side.

Returns:

the corresponding border properties.

setBorderStyle

public void setBorderStyle(Border.Side side,
                           Border style)

getBounds

public Rectangular getBounds()

Description copied from interface: ContentRect

Obtains the pixel position within in the page.

Specified by:

getBounds in interface ContentRect

Returns:

The rectangular pixel position.

setBounds

public void setBounds(Rectangular bounds)

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 (0..4)

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

move

public void move(int xofs,
                 int yofs)

Specified by:

move in interface Rect

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

resetId

public static void resetId()