org.openimaj.web.layout

Class LayoutExtractor

java.lang.Object

org.openimaj.web.layout.LayoutExtractor

public class LayoutExtractor
extends Object

Class for extracting information on the layout of DOM elements in a web page.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
LayoutExtractor() Default constructor
LayoutExtractor(long timeout) Default constructor

Method Summary

Modifier and Type	Method and Description
com.trolltech.qt.webkit.QWebElement	getBody() Get the BODY element of the loaded page
List<ElementInfo>	getLayoutInfo() Get the layout info of the page
boolean	load(String url) Load a web page from a URL
boolean	load(URL url) Load a web page from a URL
boolean	loadHTML(String html) Load a web page from an HTML string
protected String	nodeToString(com.trolltech.qt.webkit.QWebElement n, boolean pretty)
MBFImage	render() Render the current page to an image
MBFImage	render(int maxwidth, int maxheight) Render the current page to an image of the given size or smaller
MBFImage	renderContentLayout(Float[] contentColour, Float[] nonContent, Float[] nonContentInside) Render the layout of the content.
MBFImage	renderContentLayout(MBFImage image, Float[] contentColour, Float[] nonContent, Float[] nonContentInside) Render the layout of the content.
MBFImage	renderLayoutInfo(Float[] color) Render ALL the content boxes to a new image in the given color
MBFImage	renderLayoutInfo(MBFImage image, Float[] colour) Render ALL the content boxes to the given image in the given color
void	waitForBrowser(long ms) Run the browser for ms milliseconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutExtractor

public LayoutExtractor()

Default constructor

LayoutExtractor

public LayoutExtractor(long timeout)

Default constructor

Parameters:

timeout -

Method Detail

load

public boolean load(String url)

Load a web page from a URL

Parameters:

url - the url

Returns:

true if successful; false otherwise

load

public boolean load(URL url)

Load a web page from a URL

Parameters:

url - the url

Returns:

true if successful; false otherwise

loadHTML

public boolean loadHTML(String html)

Load a web page from an HTML string

Parameters:

html - the HTML string

Returns:

true if successful; false otherwise

getLayoutInfo

public List<ElementInfo> getLayoutInfo()

Get the layout info of the page

Returns:

information about the page layout

renderLayoutInfo

public MBFImage renderLayoutInfo(Float[] color)

Render ALL the content boxes to a new image in the given color

Parameters:

color - Color

Returns:

new image illustrating ALL content boxes

renderLayoutInfo

public MBFImage renderLayoutInfo(MBFImage image,
                                 Float[] colour)

Render ALL the content boxes to the given image in the given color

Parameters:

image - Image to draw on top of

colour - Color

Returns:

the rendered image

getBody

public com.trolltech.qt.webkit.QWebElement getBody()

Get the BODY element of the loaded page

Returns:

body element or null if it doesn't exist

nodeToString

protected String nodeToString(com.trolltech.qt.webkit.QWebElement n,
                              boolean pretty)

renderContentLayout

public MBFImage renderContentLayout(Float[] contentColour,
                                    Float[] nonContent,
                                    Float[] nonContentInside)

Render the layout of the content.

Parameters:

contentColour - Colour for content

nonContent - Colour for non-content

nonContentInside - Colour for non-content inside content

Returns:

rendered image with boxes

renderContentLayout

public MBFImage renderContentLayout(MBFImage image,
                                    Float[] contentColour,
                                    Float[] nonContent,
                                    Float[] nonContentInside)

Render the layout of the content.

Parameters:

image - image to draw into

contentColour - Colour for content

nonContent - Colour for non-content

nonContentInside - Colour for non-content inside content

Returns:

rendered image with boxes

render

public MBFImage render()

Render the current page to an image

Returns:

an image of the current page, or null if there is no content

render

public MBFImage render(int maxwidth,
                       int maxheight)

Render the current page to an image of the given size or smaller

Parameters:

maxwidth -

maxheight -

Returns:

an image of the current page, or null if there is no content

waitForBrowser

public void waitForBrowser(long ms)

Run the browser for ms milliseconds. This allows it to update its content, etc.

Parameters:

ms - time to wait