com.hcl.domino.html

Interface EmbeddedImage

public interface EmbeddedImage

Interface gives access to referenced embedded images in the HTML conversion of rich text

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EmbeddedImage.HTMLImageReader Callback interface that receives data of embedded images

Method Summary

Modifier and Type	Method and Description
String	getFormat() Returns the image format, either "gif" or "jpg"
String	getImageSrcAttr() Returns img tag URL (src attribute value), can be used for string replacement if the image is stored locally on disk
int	getItemIndex() Returns the item index.
String	getItemName() Returns the name of the item that contains this image.
int	getItemOffset() Returns the item offset.
Collection<String>	getOptions() Use the HTML convert options used to render this embedded image.
void	readImage(EmbeddedImage.HTMLImageReader callback) Method to directly access the image data without storing it to disk
void	writeImage(OutputStream out) Convenience method to write the whole image to an output stream
void	writeImage(Path filePath) Convenience method to write the whole image to a file

Method Detail

getItemName

String getItemName()

Returns the name of the item that contains this image. Use the values of

• getItemName()
• getItemOffset()
• getItemIndex()
• getOptions()

to locate the data for this image in the document via RichTextHTMLConverter.readEmbeddedImage(com.hcl.domino.data.Document, java.lang.String, java.util.Collection<java.lang.String>, int, int, com.hcl.domino.html.EmbeddedImage.HTMLImageReader).

Returns:

item name

getItemOffset

int getItemOffset()

Returns the item offset. Use the values of

• getItemName()
• getItemOffset()
• getItemIndex()
• getOptions()

to locate the data for this image in the document.

Returns:

item offset

getItemIndex

int getItemIndex()

Returns the item index. Use the values of

• getItemName()
• getItemOffset()
• getItemIndex()
• getOptions()

to locate the data for this image in the document.

Returns:

item index

getOptions

Collection<String> getOptions()

Use the HTML convert options used to render this embedded image. Use the values of

• getItemName()
• getItemOffset()
• getItemIndex()
• getOptions()

to locate the data for this image in the document.

Returns:

convert options

getImageSrcAttr

String getImageSrcAttr()

Returns img tag URL (src attribute value), can be used for string replacement if the image is stored locally on disk

Returns:

relative image URL

readImage

void readImage(EmbeddedImage.HTMLImageReader callback)

Method to directly access the image data without storing it to disk

Parameters:

callback - callback to receive data

writeImage

void writeImage(Path filePath)
         throws IOException

Convenience method to write the whole image to a file

Parameters:

filePath - image filepath

Throws:

IOException - on case of I/O errors

writeImage

void writeImage(OutputStream out)
         throws IOException

Convenience method to write the whole image to an output stream

Parameters:

out - stream

Throws:

IOException - on case of I/O errors

getFormat

String getFormat()

Returns the image format, either "gif" or "jpg"

Returns:

format