Top Description Constructors Methods
com.openhtmltopdf.event

public Class DefaultDocumentListener

extends Object
implements DocumentListener
Class Inheritance
All Implemented Interfaces
com.openhtmltopdf.event.DocumentListener
Default, do-nothing implementation of a DocumentListener; implements all methods in DocumentListener but the methods do nothing. Subclass this class and override whichever methods you need to trap.

Constructor Summary

AccessConstructor and Description
public
DefaultDocumentListener()

Method Summary

Modifier and TypeMethod and Description
public void
documentLoaded()

Implements com.openhtmltopdf.event.DocumentListener.documentLoaded.

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.

public void
documentStarted()

Implements com.openhtmltopdf.event.DocumentListener.documentStarted.

Indicates document has been requested (e.g. a new document is going to be loaded).

public void
onLayoutException(Throwable t)

Implements com.openhtmltopdf.event.DocumentListener.onLayoutException.

Called when document layout failed with an exception.

public void
onRenderException(Throwable t)

Implements com.openhtmltopdf.event.DocumentListener.onRenderException.

Called when document render failed with an exception.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DefaultDocumentListenerback to summary
public DefaultDocumentListener()

Method Detail

documentLoadedback to summary
public void documentLoaded()

Implements com.openhtmltopdf.event.DocumentListener.documentLoaded.

Doc from com.openhtmltopdf.event.DocumentListener.documentLoaded.

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).

documentStartedback to summary
public void documentStarted()

Implements com.openhtmltopdf.event.DocumentListener.documentStarted.

Doc from com.openhtmltopdf.event.DocumentListener.documentStarted.

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.

onLayoutExceptionback to summary
public void onLayoutException(Throwable t)

Implements com.openhtmltopdf.event.DocumentListener.onLayoutException.

Doc from com.openhtmltopdf.event.DocumentListener.onLayoutException.

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.

onRenderExceptionback to summary
public void onRenderException(Throwable t)

Implements com.openhtmltopdf.event.DocumentListener.onRenderException.

Doc from com.openhtmltopdf.event.DocumentListener.onRenderException.

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.