com.hcl.domino.html

Interface RichTextHTMLConverter

public interface RichTextHTMLConverter

Utility class to convert between rich text and HTML

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RichTextHTMLConverter.Builder

Method Summary

Modifier and Type	Method and Description
void	readEmbeddedImage(Document doc, String itemName, Collection<String> options, int itemIndex, int itemOffset, EmbeddedImage.HTMLImageReader callback) Method to access images embedded in HTML conversion result.
RichTextHTMLConverter.Builder	render(Database database) Renders a database as HTML, which displays its web landing page.
RichTextHTMLConverter.Builder	render(Document doc) Renders a document as HTML (including its form) and gives access to embedded images.
RichTextHTMLConverter.Builder	renderItem(Document doc, String itemName) Renders a rich text item as HTML and gives access to embedded images

Method Detail

renderItem

RichTextHTMLConverter.Builder renderItem(Document doc,
                                         String itemName)

Renders a rich text item as HTML and gives access to embedded images

Parameters:

doc - the document containing the item to convert

itemName - the name of the item to convert

Returns:

conversion result

render

RichTextHTMLConverter.Builder render(Document doc)

Renders a document as HTML (including its form) and gives access to embedded images.

Parameters:

doc - the document or design note to convert

Returns:

conversion result

render

RichTextHTMLConverter.Builder render(Database database)

Renders a database as HTML, which displays its web landing page.

Parameters:

database - the database to convert

Returns:

conversion result

readEmbeddedImage

void readEmbeddedImage(Document doc,
                       String itemName,
                       Collection<String> options,
                       int itemIndex,
                       int itemOffset,
                       EmbeddedImage.HTMLImageReader callback)

Method to access images embedded in HTML conversion result. Compute index and offset parameters from the img tag path like this: 1.3E => index=1, offset=63

Parameters:

doc - document

itemName - rich text field which is being converted

options - conversion options in "key=value" format

itemIndex - the relative item index -- if there is more than one, Item with the same pszItemName, then this indicates which one (zero relative)

itemOffset - byte offset in the Item where the element starts

callback - callback to receive the data