org.openimaj.web

Class ProgrammaticBrowser

java.lang.Object

org.openimaj.web.ProgrammaticBrowser

public class ProgrammaticBrowser
extends Object

An offscreen web-browser that can be accessed programmatically. Allows rendering to an MBFImage, etc.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ProgrammaticBrowser() Default constructor.
ProgrammaticBrowser(BrowserDelegate delegate) Construct with given delegate object.

Method Summary

Modifier and Type	Method and Description
com.trolltech.qt.webkit.QWebElementCollection	findAllElements(String selectorQuery) Get all DOM elements matching the given CSS selector
com.trolltech.qt.webkit.QWebElement	findFirstElement(String selectorQuery) Get the first DOM element corresponding to the given CSS selector
com.trolltech.qt.webkit.QWebElement	getBody() Get the BODY element of the loaded page
int	getHeight() Get the height of the browser.
String	getHTML() Get the HTML of the currently loaded page
String	getURL() Get the URL for the currently loaded page
int	getWidth() Get the width of the browser.
boolean	load(String url) Load the page with the given URL
boolean	load(String url, long timeout) Load the page with the given URL
boolean	load(URL url) Load the page with the given URL
boolean	load(URL url, long timeout) Load the page with the given URL
protected void	loadFinished(boolean successful)
boolean	loadHTML(String html) Load the given html string into the browser
protected void	loadStarted()
void	mainLoop(long timeout) Run the browsers main event loop for timeout milliseconds
MBFImage	renderToImage() Get a render of the page as an image
MBFImage	renderToImage(int width, int height) Get a render of the page as an image
protected boolean	waitForLoad()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgrammaticBrowser

public ProgrammaticBrowser()

Default constructor. Uses an DefaultBrowserDelegate, so you wont see any dialogs, etc.

ProgrammaticBrowser

public ProgrammaticBrowser(BrowserDelegate delegate)

Construct with given delegate object. Setting the delegate to null will enable default behavior - i.e. dialogs will be drawn on the screen!

Parameters:

delegate -

Method Detail

loadStarted

protected void loadStarted()

waitForLoad

protected boolean waitForLoad()

loadFinished

protected void loadFinished(boolean successful)

mainLoop

public void mainLoop(long timeout)

Run the browsers main event loop for timeout milliseconds

Parameters:

timeout - the running time

getHTML

public String getHTML()

Get the HTML of the currently loaded page

Returns:

the html as a string

getURL

public String getURL()

Get the URL for the currently loaded page

Returns:

the url

load

public boolean load(URL url)

Load the page with the given URL

Parameters:

url - the url to load.

Returns:

true if successful; false otherwise.

load

public boolean load(URL url,
                    long timeout)
             throws TimeoutException

Load the page with the given URL

Parameters:

url - the url to load.

timeout - the amount of time to wait for the page to load before failing

Returns:

true if successful; false otherwise.

Throws:

TimeoutException

load

public boolean load(String url,
                    long timeout)
             throws TimeoutException

Load the page with the given URL

Parameters:

url - the url to load.

timeout - the amount of time to wait for the page to load before failing

Returns:

true if successful; false otherwise.

Throws:

TimeoutException

load

public boolean load(String url)

Load the page with the given URL

Parameters:

url - the url to load.

Returns:

true if successful; false otherwise.

loadHTML

public boolean loadHTML(String html)

Load the given html string into the browser

Parameters:

html - the html string

Returns:

true if successful; false otherwise.

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

findAllElements

public com.trolltech.qt.webkit.QWebElementCollection findAllElements(String selectorQuery)

Get all DOM elements matching the given CSS selector

Parameters:

selectorQuery - the CSS selector

Returns:

collection of elements

findFirstElement

public com.trolltech.qt.webkit.QWebElement findFirstElement(String selectorQuery)

Get the first DOM element corresponding to the given CSS selector

Parameters:

selectorQuery - the CSS selector

Returns:

the first element, or null if no matching element is found

renderToImage

public MBFImage renderToImage()

Get a render of the page as an image

Returns:

Rendered page image

renderToImage

public MBFImage renderToImage(int width,
                              int height)

Get a render of the page as an image

Parameters:

width -

height -

Returns:

Rendered page image

getWidth

public int getWidth()

Get the width of the browser. The width is automatically adjusted to fit the content.

Returns:

the width in pixels

getHeight

public int getHeight()

Get the height of the browser. The height is automatically adjusted to fit the content.

Returns:

the height in pixels