Package com.openhtmltopdf.swing

Class DelegatingUserAgent

java.lang.Object

com.openhtmltopdf.swing.NaiveUserAgent

com.openhtmltopdf.swing.DelegatingUserAgent

All Implemented Interfaces:

DocumentListener, UserAgentCallback

public class DelegatingUserAgent
extends NaiveUserAgent

Nested Class Summary

Nested classes/interfaces inherited from class com.openhtmltopdf.swing.NaiveUserAgent

NaiveUserAgent.DefaultHttpStream, NaiveUserAgent.DefaultHttpStreamFactory, NaiveUserAgent.DefaultUriResolver

Field Summary

Fields inherited from class com.openhtmltopdf.swing.NaiveUserAgent

_baseUri, _imageCache, _protocolsStreamFactory, _resolver, DEFAULT_URI_RESOLVER

Constructor Summary

Constructors

Constructor	Description
DelegatingUserAgent()	Creates a new instance of NaiveUserAgent with a max image cache of 16 images.

Method Summary

Modifier and Type	Method	Description
void	clearImageCache()	Empties the image cache entirely.
void	documentLoaded()	Indicates document layout has complete, e.g.
void	documentStarted()	Indicates document has been requested (e.g.
String	getBaseURL()	Returns the current baseUrl for this class.
ImageResource	getImageResource(String uri)	Retrieves the image located at the given URI.
void	onLayoutException(Throwable t)	Called when document layout failed with an exception.
void	onRenderException(Throwable t)	Called when document render failed with an exception.
String	resolveURI(String uri)	Resolves the URI; if absolute, leaves as is, if relative, returns an absolute URI based on the baseUrl for the agent.
void	setBaseURL(String uri)	URL relative to which URIs are resolved.
void	setImageResourceLoader(ImageResourceLoader loader)
void	setRepaintListener(RepaintListener listener)
void	shrinkImageCache()	If the image cache has more items than the limit specified for this class, the least-recently used will be dropped from cache until it reaches the desired size.

Methods inherited from class com.openhtmltopdf.swing.NaiveUserAgent

getBinaryResource, getCSSResource, getDefaultUriResolver, getProtocolFactory, getXMLResource, hasProtocolFactory, isVisited, openReader, openStream, readAll, resolveUri, setProtocolsStreamFactory, setUriResolver

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingUserAgent

public DelegatingUserAgent()

Creates a new instance of NaiveUserAgent with a max image cache of 16 images.

Method Details

setImageResourceLoader

public void setImageResourceLoader(ImageResourceLoader loader)

shrinkImageCache

public void shrinkImageCache()

If the image cache has more items than the limit specified for this class, the least-recently used will be dropped from cache until it reaches the desired size.

clearImageCache

public void clearImageCache()

Empties the image cache entirely.

Overrides:

clearImageCache in class NaiveUserAgent

getImageResource

public ImageResource getImageResource(String uri)

Retrieves the image located at the given URI. It's assumed the URI does point to an image--the URI will be accessed (using java.io or java.net), opened, read and then passed into the JDK image-parsing routines. The result is packed up into an ImageResource for later consumption.

Specified by:

getImageResource in interface UserAgentCallback

Overrides:

getImageResource in class NaiveUserAgent

Parameters:

uri - Location of the image source.

Returns:

An ImageResource containing the image.

setBaseURL

public void setBaseURL(String uri)

URL relative to which URIs are resolved.

Specified by:

setBaseURL in interface UserAgentCallback

Overrides:

setBaseURL in class NaiveUserAgent

Parameters:

uri - A URI which anchors other, possibly relative URIs.

resolveURI

public String resolveURI(String uri)

Resolves the URI; if absolute, leaves as is, if relative, returns an absolute URI based on the baseUrl for the agent.

Specified by:

resolveURI in interface UserAgentCallback

Overrides:

resolveURI in class NaiveUserAgent

Parameters:

uri - A URI, possibly relative.

Returns:

A URI as String, resolved, or null if there was an exception (for example if the URI is malformed).

getBaseURL

public String getBaseURL()

Returns the current baseUrl for this class.

Specified by:

getBaseURL in interface UserAgentCallback

Overrides:

getBaseURL in class NaiveUserAgent

Returns:

the base uri, possibly in the implementations private uri-space

documentStarted

public void documentStarted()

Description copied from interface: DocumentListener

Indicates document has been requested (e.g. a new document is going to be loaded). This will be called before any activity takes place for the document.

Specified by:

documentStarted in interface DocumentListener

Overrides:

documentStarted in class NaiveUserAgent

documentLoaded

public void documentLoaded()

Description copied from interface: DocumentListener

Indicates document layout has complete, e.g. document is fully "loaded" for display; this is not a callback for the document source (e.g. XML) being loaded. This method will be called on every layout run (including, for example, after panel resizes).

Specified by:

documentLoaded in interface DocumentListener

Overrides:

documentLoaded in class NaiveUserAgent

onLayoutException

public void onLayoutException(Throwable t)

Description copied from interface: DocumentListener

Called when document layout failed with an exception. All Throwable objects thrown (except for ThreadDeath) during layout and not otherwise handled will be provided to this method. If a DocumentListener has been defined an XHTML panel, the listener is entirely responsible for handling the exception. No other action will be taken.

Specified by:

onLayoutException in interface DocumentListener

Overrides:

onLayoutException in class NaiveUserAgent

onRenderException

public void onRenderException(Throwable t)

Description copied from interface: DocumentListener

Called when document render failed with an exception. All Throwable objects thrown (except for ThreadDeath) during render and not otherwise handled will be provided to this method. If a DocumentListener has been defined an XHTML panel, the listener is entirely responsible for handling the exception. No other action will be taken.

Specified by:

onRenderException in interface DocumentListener

Overrides:

onRenderException in class NaiveUserAgent

setRepaintListener

public void setRepaintListener(RepaintListener listener)