org.fit.layout.model

Interface Page

All Known Implementing Classes:

DefaultPage

public interface Page

This class represents the whole rendered (and segmented) page.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
Box	getBoxAt(int x, int y) Finds the deepest node in the tree that contains the given point.
Vector<Box>	getBoxesInRegion(Rectangular r) Finds the root boxes of subtrees that are fully contained in the given region based on their visual bounds.
int	getHeight() Obtains the page height.
Box	getRoot() Returns the root box of the page.
URL	getSourceURL() Obtains the source URL of the page.
String	getTitle() Obtains the page title specified using the <title> tag.
int	getWidth() Obtains the page width.

Method Detail

getSourceURL

URL getSourceURL()

Obtains the source URL of the page.

Returns:

the URL

getTitle

String getTitle()

Obtains the page title specified using the <title> tag.

Returns:

the page title or an empty string when not set

getWidth

int getWidth()

Obtains the page width.

Returns:

the width in pixels

getHeight

int getHeight()

Obtains the page height.

Returns:

the height in pixels

getRoot

Box getRoot()

Returns the root box of the page.

Returns:

the root box

getBoxAt

Box getBoxAt(int x,
             int y)

Finds the deepest node in the tree that contains the given point.

Parameters:

x - The point X coordinate

y - The point Y coordinate

Returns:

The deepest box at the given coordinates or null when there is no box in the tree placed at the given coordinates.

getBoxesInRegion

Vector<Box> getBoxesInRegion(Rectangular r)

Finds the root boxes of subtrees that are fully contained in the given region based on their visual bounds.

Parameters:

r - The region to be tested

Returns:

A vector of subtree root boxes (possibly empty)