com.scroogexhtml.pictures

Interface PictureAdapter

All Known Implementing Classes:

MemoryPictureAdapter, MemoryPictureAdapterBase64

public interface PictureAdapter

Picture interface.

Method Summary

Modifier and Type	Method and Description
void	addPicture() The converter will call this method every time when it encounters an embedded picture in the RTF code.
void	beforeConvert() The converter will call this method before it starts to convert the RTF.
EmbeddedPicture	finalizePicture() The converter will call this method every time when it reaches the end of an embedded picture.
EmbeddedPicture	getCurrentPicture() For internal use only.
Map<String,EmbeddedPicture>	getPictures() Return the map of the pictures in the current document.
void	setBase(String base) Set the base URL of the image link.

Method Detail

beforeConvert

void beforeConvert()

The converter will call this method before it starts to convert the RTF. code. It can be used for initialization of the PictureAdapter implementation.

addPicture

void addPicture()

The converter will call this method every time when it encounters an embedded picture in the RTF code.

getCurrentPicture

EmbeddedPicture getCurrentPicture()

For internal use only.

Returns:

current picture during conversion.

finalizePicture

EmbeddedPicture finalizePicture()

The converter will call this method every time when it reaches the end of an embedded picture.

Returns:

finalized picture.

getPictures

Map<String,EmbeddedPicture> getPictures()

Return the map of the pictures in the current document.

Returns:

map of the pictures in the current document.

setBase

void setBase(String base)

Set the base URL of the image link. Implementing classes can use this image base if they construct the link URL, which will be provided by getPictureHTML().

Parameters:

base - root path of the image