Package nl.siegmann.epublib.viewer

Class HTMLDocumentFactory

java.lang.Object

nl.siegmann.epublib.viewer.HTMLDocumentFactory

All Implemented Interfaces:

NavigationEventListener

public class HTMLDocumentFactory
extends Object
implements NavigationEventListener

Creates swing HTML documents from resources. Between books the init(Book) function needs to be called in order for images to appear correctly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	HTMLDocumentFactory.DocumentIndexer

Field Summary

Fields

Modifier and Type	Field	Description
private ReentrantReadWriteLock	cacheLock
private Lock	cacheReadLock
private Lock	cacheWriteLock
static final int	DOCUMENT_CACHE_INDEXER_WAIT_TIME
private Map<String,HTMLDocument>	documentCache
private MyHtmlEditorKit	editorKit
private ImageLoaderCache	imageLoaderCache
private static final org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
HTMLDocumentFactory(Navigator navigator, EditorKit editorKit)

Method Summary

Modifier and Type	Method	Description
private HTMLDocument	createDocument(Resource resource)	Creates a swing HTMLDocument from the given resource.
HTMLDocument	getDocument(Resource resource)	Get the HTMLDocument representation of the resource.
void	init(Book book)
private void	initDocumentCache(Book book)
void	navigationPerformed(NavigationEvent navigationEvent)	Called whenever the user navigates to another position in the book.
private void	putDocument(Resource resource, HTMLDocument document)
private static String	removeControlTags(String input)	Quick and dirty stripper of all <?...> and <!...> tags as these confuse the html viewer.
private String	stripHtml(String input)

Methods inherited from class java.lang.Object

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

Field Details

log

private static final org.slf4j.Logger log

DOCUMENT_CACHE_INDEXER_WAIT_TIME

public static final int DOCUMENT_CACHE_INDEXER_WAIT_TIME

See Also:

• Constant Field Values

imageLoaderCache

private ImageLoaderCache imageLoaderCache

cacheLock

private ReentrantReadWriteLock cacheLock

cacheReadLock

private Lock cacheReadLock

cacheWriteLock

private Lock cacheWriteLock

documentCache

private Map<String,HTMLDocument> documentCache

editorKit

private MyHtmlEditorKit editorKit

Constructor Details

HTMLDocumentFactory

public HTMLDocumentFactory(Navigator navigator,
 EditorKit editorKit)

Method Details

init

public void init(Book book)

putDocument

private void putDocument(Resource resource,
 HTMLDocument document)

getDocument

public HTMLDocument getDocument(Resource resource)

Get the HTMLDocument representation of the resource. If the resource is not an XHTML resource then it returns null. It first tries to get the document from the cache. If the document is not in the cache it creates a document from the resource and adds it to the cache.

Parameters:

resource -

Returns:

the HTMLDocument representation of the resource.

stripHtml

private String stripHtml(String input)

removeControlTags

private static String removeControlTags(String input)

Quick and dirty stripper of all <?...> and <!...> tags as these confuse the html viewer.

Parameters:

input -

Returns:

the input stripped of control characters

createDocument

private HTMLDocument createDocument(Resource resource)

Creates a swing HTMLDocument from the given resource. If the resources is not of type XHTML then null is returned.

Parameters:

resource -

Returns:

a swing HTMLDocument created from the given resource.

initDocumentCache

private void initDocumentCache(Book book)

navigationPerformed

public void navigationPerformed(NavigationEvent navigationEvent)

Description copied from interface: NavigationEventListener

Called whenever the user navigates to another position in the book.

Specified by:

navigationPerformed in interface NavigationEventListener

Parameters:

navigationEvent -