com.levigo.jadice.document.render
Interface ThumbnailProvider

All Known Implementing Classes:

DefaultThumbnailProvider

public interface ThumbnailProvider

Classes implementing ThumbnailProvider interface are responsible to provide a thumbnail image for a specific page this ThumbnailProvider realization is associated to.

Field Summary

static int	DEFAULT_THUMB_HEIGHT Default thumbnail (the thumb and the contained page) height.
static int	DEFAULT_THUMB_WIDTH Default thumbnail (the thumb and the contained page) width.

Method Summary

RenderedImage

getThumbnail(Page page, TaskExecutor<Page> taskExecutor, RenderControls renderControls, boolean createIfNotCached) Returns a thumbnail image in given size of a page associated to.

Field Detail

DEFAULT_THUMB_WIDTH

static final int DEFAULT_THUMB_WIDTH

Default thumbnail (the thumb and the contained page) width.

See Also:

Constant Field Values

DEFAULT_THUMB_HEIGHT

static final int DEFAULT_THUMB_HEIGHT

Default thumbnail (the thumb and the contained page) height.

See Also:

Constant Field Values

Method Detail

getThumbnail

RenderedImage getThumbnail(Page page,
                           TaskExecutor<Page> taskExecutor,
                           RenderControls renderControls,
                           boolean createIfNotCached)

Returns a thumbnail image in given size of a page associated to.

Depending on the concrete realisation, the returned image may be the ready-made thumbnail image or for lazy creation null or a placeholder dummy image. If null or a dummy image is returned the given render observer gets informed to trigger an update render process on the caller of this method. If the parameterized render observer is null, the update process remains in the hands of the caller.

Parameters:

page - the of which a thumbnail is demanded

renderControls - the target size the thumbnail should have

createIfNotCached - TODO

Returns:

RenderedImage a thumbnail image