org.fit.layout.model

Interface ContentRect

All Superinterfaces:

Rect

All Known Subinterfaces:

Area, Box

All Known Implementing Classes:

DefaultArea, DefaultBox, DefaultContentRect

public interface ContentRect
extends Rect

A generic rectangular content within a page

Author:

burgetr

Method Summary

Methods

Modifier and Type	Method and Description
Color	getBackgroundColor() Obtains the background color of the area.
int	getBorderCount() Obtains the number of defined borders for the box.
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	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.
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.

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

getHeight, getWidth, getX1, getX2, getY1, getY2

Method Detail

getId

int getId()

Obtains a unique ID of the area within the page.

Returns:

the area ID

getPage

Page getPage()

Obtains the page this block belongs to.

Returns:

the page

getBounds

Rectangular getBounds()

Obtains the pixel position within in the page.

Returns:

The rectangular pixel position.

getBackgroundColor

Color getBackgroundColor()

Obtains the background color of the area.

Returns:

A color or null for transparent background

getUnderline

float getUnderline()

Obtains the amount of underlined text. 0 means no underlined text, 1 means all the text is underlined.

Returns:

a value in the range 0..1

getLineThrough

float getLineThrough()

Obtains the amount of line-through text. 0 means no underlined text, 1 means all the text is underlined.

Returns:

a value in the range 0..1

getFontSize

float getFontSize()

Obtains an average font size in the are in pixels.

Returns:

the average font pixel size

getFontStyle

float getFontStyle()

Obtains the average font style. 0 means no text in italics, 1 means all the text in italics.

Returns:

a value in the range 0..1

getFontWeight

float getFontWeight()

Obtains the average font style. 0 means no text is bold, 1 means all the text is bold

Returns:

a value in the range 0..1

getBorderCount

int getBorderCount()

Obtains the number of defined borders for the box.

Returns:

the number of defined borders (0..4)

hasTopBorder

boolean hasTopBorder()

Checks whether the box has the top border defined.

Returns:

true if the box has a top border

getTopBorder

int getTopBorder()

Obtains the top border width.

Returns:

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

hasBottomBorder

boolean hasBottomBorder()

Checks whether the box has the bottom border defined.

Returns:

true if the box has a bottom border

getBottomBorder

int getBottomBorder()

Obtains the bottom border width.

Returns:

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

hasLeftBorder

boolean hasLeftBorder()

Checks whether the box has the left border defined.

Returns:

true if the box has a left border

getLeftBorder

int getLeftBorder()

Obtains the left border width.

Returns:

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

hasRightBorder

boolean hasRightBorder()

Checks whether the box has right top border defined.

Returns:

true if the box has a right border

getRightBorder

int getRightBorder()

Obtains the right border width.

Returns:

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

isBackgroundSeparated

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.

Returns:

true for background-separated boxes