com.hcl.domino.richtext

Interface RichTextWriter

All Superinterfaces:

AutoCloseable

public interface RichTextWriter
extends AutoCloseable

Writer to produce a new rich text item

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RichTextWriter.CaptionPosition Enum of available positions to place the caption of a file hotspot

Method Summary

Modifier and Type	Method and Description
RichTextWriter	addAttachmentIcon(Attachment att, String captionTxt)
RichTextWriter	addAttachmentIcon(Attachment att, String filenameToDisplay, String captionText, FontStyle captionStyle, RichTextWriter.CaptionPosition captionPos, int captionColorRed, int captionColorGreen, int captionColorBlue, int resizeToWidth, int resizeToHeight, Path imagePath)
RichTextWriter	addAttachmentIcon(String attachmentProgrammaticName, String captionTxt)
RichTextWriter	addAttachmentIcon(String attachmentProgrammaticName, String filenameToDisplay, String captionText, FontStyle captionStyle, RichTextWriter.CaptionPosition captionPos, int captionColorRed, int captionColorGreen, int captionColorBlue, int resizeToWidth, int resizeToHeight, InputStream imageData)
RichTextWriter	addCollectionLink(DominoCollection collection, String comment) This function inserts a DocLink for the specified DominoCollection.
RichTextWriter	addDatabaseLink(Database db, String comment) This function inserts a DocLink for the specified Database.
RichTextWriter	addDocLink(Document doc, String comment) This function inserts a DocLink for the specified Document.
RichTextWriter	addDocLink(String dbReplicaId, String viewUnid, String docUNID, String comment) This function inserts a DocLink using manual values.
RichTextWriter	addFileResource(InputStream is, long length) Adds the provided stream as a file resource into this rich text writer.
default RichTextWriter	addFileResource(Path file) Adds the provided file as a file resource into this rich text writer.
RichTextWriter	addImage(InputStream imageStream) Adds an image from an input stream.
RichTextWriter	addImage(InputStream imageStream, int resizeToWidth, int resizeToHeight) Adds an image from an input stream.
RichTextWriter	addImage(Path imagePath) Adds an image from disk.
RichTextWriter	addImage(Path imagePath, int resizeToWidth, int resizeToHeight) Adds an image from disk.
RichTextWriter	addImageResource(InputStream is, long length) Adds the provided stream as an image resource into this rich text writer.
default RichTextWriter	addImageResource(Path file) Adds the provided stream as an image resource into this rich text writer.
RichTextWriter	addJavaScriptLibraryData(String script) Adds the provided script as a JavaScript library block into this rich text writer.
RichTextWriter	addRichText(Document doc, String itemName) Appends a rich text item from another document
RichTextWriter	addRichText(RichTextWriter rt) Appends rich text created in another writer
<T extends RichTextRecord<?>> RichTextWriter	addRichTextRecord(Class<T> recordClass, Consumer<T> processor) Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.
<T extends RichTextRecord<?>> RichTextWriter	addRichTextRecord(Class<T> recordClass, int variableDataLength, Consumer<T> processor) Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.
<T extends RichTextRecord<?>> RichTextWriter	addRichTextRecord(RecordType recordType, Consumer<T> processor) Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.
<T extends RichTextRecord<?>> RichTextWriter	addRichTextRecord(RecordType recordType, int variableDataLength, Consumer<T> processor) Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.
RichTextWriter	addRichTextRecord(RichTextRecord<?> record) Adds a raw rich text record from an existing instance.
RichTextWriter	addText(String txt) Adds a text element
RichTextWriter	addText(String txt, TextStyle textStyle, FontStyle fontStyle) Adds a text element with the specified font style
RichTextWriter	addText(String txt, TextStyle textStyle, FontStyle fontStyle, boolean createParagraphOnLinebreak) Adds a text element with the specified font style
void	close() Closes this resource, relinquishing any underlying resources.
FontStyle	createFontStyle() Creates a new font style
<T extends MemoryStructure> T	createStructure(Class<T> structureClass, int variableDataLength) Creates a new MemoryStructure of the given class in memory, without appending it to the destination rich-text entity.
TextStyle	createTextStyle(String styleName) Creates a new text style
void	discard() Discard any changes in this writer and free all resources
String	getItemName() Returns the name of the rich text item
Document	getParentDocument() Returns the document that will contain the rich text data
boolean	isEmpty() Method to check if anything has been written into the writer

Method Detail

close

void close()

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Specified by:

close in interface AutoCloseable

getParentDocument

Document getParentDocument()

Returns the document that will contain the rich text data

Returns:

document

getItemName

String getItemName()

Returns the name of the rich text item

Returns:

item name

isEmpty

boolean isEmpty()

Method to check if anything has been written into the writer

Returns:

true if empty

addText

RichTextWriter addText(String txt)

Adds a text element

Parameters:

txt - text

Returns:

this writer

addText

RichTextWriter addText(String txt,
                       TextStyle textStyle,
                       FontStyle fontStyle)

Adds a text element with the specified font style

Parameters:

txt - text

textStyle - text style

fontStyle - font style

Returns:

this writer

addText

RichTextWriter addText(String txt,
                       TextStyle textStyle,
                       FontStyle fontStyle,
                       boolean createParagraphOnLinebreak)

Adds a text element with the specified font style

Parameters:

txt - text

textStyle - text style

fontStyle - font style

createParagraphOnLinebreak - true to create a paragraph for each linebreak found in the text

Returns:

this writer

addImage

RichTextWriter addImage(Path imagePath)

Adds an image from disk. We support BMP, JPG, GIF and PNG format.

Parameters:

imagePath - image filepath

Returns:

this writer

addImage

RichTextWriter addImage(Path imagePath,
                        int resizeToWidth,
                        int resizeToHeight)

Adds an image from disk. We support BMP, JPG, GIF and PNG format.

Parameters:

imagePath - image filepath

resizeToWidth - if not -1, resize the image to this width

resizeToHeight - if not -1, resize the image to this width

Returns:

this writer

addImage

RichTextWriter addImage(InputStream imageStream)

Adds an image from an input stream. We support BMP, JPG, GIF and PNG format.

Parameters:

imageStream - stream with image data

Returns:

this writer

addImage

RichTextWriter addImage(InputStream imageStream,
                        int resizeToWidth,
                        int resizeToHeight)

Adds an image from an input stream. We support BMP, JPG, GIF and PNG format.

Parameters:

imageStream - stream with image data

resizeToWidth - if not -1, resize the image to this width

resizeToHeight - if not -1, resize the image to this width

Returns:

this writer

addImageResource

default RichTextWriter addImageResource(Path file)
                                 throws IOException

Adds the provided stream as an image resource into this rich text writer.

Note: this uses the structure of image-resource design elements and differs significantly from how inline images are handled. Use addImage(Path) and the related methods to add images to a UI rich-text field.

Parameters:

file - the file to write to the rich text buffer

Returns:

this writer

Throws:

IOException - if there is a problem reading the file data

Since:

1.0.15

addImageResource

RichTextWriter addImageResource(InputStream is,
                                long length)
                         throws IOException

Adds the provided stream as an image resource into this rich text writer.

If the length of the content is unknown, pass -1 for the length parameter. This is inefficient, however, as it will cause the underlying implementation to read the entire stream at the start instead of as needed.

Note: this uses the structure of image-resource design elements and differs significantly from how inline images are handled. Use addImage(InputStream) and the related methods to add images to a UI rich-text field.

Parameters:

is - the InputStream to write to the rich text buffer

length - the length of the file, if known; -1 otherwise

Returns:

this writer

Throws:

IOException - if there is a problem reading the file data

Since:

1.0.15

addDocLink

RichTextWriter addDocLink(Document doc,
                          String comment)

This function inserts a DocLink for the specified Document.

Parameters:

doc - document to create the link

comment - This string appears when the DocLink is selected (clicked on).

Returns:

this writer

addDocLink

RichTextWriter addDocLink(String dbReplicaId,
                          String viewUnid,
                          String docUNID,
                          String comment)

This function inserts a DocLink using manual values.

Parameters:

dbReplicaId - Replica ID of the database that contains the document pointed to by the DocLink.

viewUnid - UNID of the DominoCollection that contains the document pointed to by the DocLink or null/empty string to create a database link

docUNID - UNID of the document pointed to by the DocLink or null/empty string to create a view/collection link

comment - This string appears when the DocLink is selected (clicked on).

Returns:

this writer

addDatabaseLink

RichTextWriter addDatabaseLink(Database db,
                               String comment)

This function inserts a DocLink for the specified Database.

Parameters:

db - database to create the link

comment - This string appears when the DocLink is selected (clicked on).

Returns:

this writer

addCollectionLink

RichTextWriter addCollectionLink(DominoCollection collection,
                                 String comment)

This function inserts a DocLink for the specified DominoCollection.

Parameters:

collection - collection to create the link

comment - This string appears when the DocLink is selected (clicked on).

Returns:

this writer

addAttachmentIcon

RichTextWriter addAttachmentIcon(Attachment att,
                                 String captionTxt)

addAttachmentIcon

RichTextWriter addAttachmentIcon(String attachmentProgrammaticName,
                                 String captionTxt)

addAttachmentIcon

RichTextWriter addAttachmentIcon(Attachment att,
                                 String filenameToDisplay,
                                 String captionText,
                                 FontStyle captionStyle,
                                 RichTextWriter.CaptionPosition captionPos,
                                 int captionColorRed,
                                 int captionColorGreen,
                                 int captionColorBlue,
                                 int resizeToWidth,
                                 int resizeToHeight,
                                 Path imagePath)

addAttachmentIcon

RichTextWriter addAttachmentIcon(String attachmentProgrammaticName,
                                 String filenameToDisplay,
                                 String captionText,
                                 FontStyle captionStyle,
                                 RichTextWriter.CaptionPosition captionPos,
                                 int captionColorRed,
                                 int captionColorGreen,
                                 int captionColorBlue,
                                 int resizeToWidth,
                                 int resizeToHeight,
                                 InputStream imageData)
                          throws IOException

Throws:

IOException

addFileResource

default RichTextWriter addFileResource(Path file)
                                throws IOException

Adds the provided file as a file resource into this rich text writer.

Note: this uses the structure of file-resource design elements and differs significantly from how attachments are handled. Use addAttachmentIcon(Attachment, String) and the related methods to add attachments.

Parameters:

file - the file to write to the rich text buffer

Returns:

this writer

Throws:

IOException - if there is a problem reading the file data

Since:

1.0.15

addFileResource

RichTextWriter addFileResource(InputStream is,
                               long length)
                        throws IOException

Adds the provided stream as a file resource into this rich text writer.

If the length of the content is unknown, pass -1 for the length parameter. This is inefficient, however, as it will cause the underlying implementation to read the entire stream at the start instead of as needed.

Note: this uses the structure of file-resource design elements and differs significantly from how attachments are handled. Use addAttachmentIcon(Attachment, String) and the related methods to add attachments to a rich-text field.

Parameters:

is - the InputStream to write to the rich text buffer

length - the length of the file, if known; -1 otherwise

Returns:

this writer

Throws:

IOException - if there is a problem reading the file data

Since:

1.0.15

addJavaScriptLibraryData

RichTextWriter addJavaScriptLibraryData(String script)

Adds the provided script as a JavaScript library block into this rich text writer.

Note: this users the structure of script-library design elements and is not likely to be useful in UI rich text.

Parameters:

script - the content of the script to write

Returns:

this writer

Since:

1.0.15

addRichText

RichTextWriter addRichText(Document doc,
                           String itemName)

Appends a rich text item from another document

Parameters:

doc - document

itemName - rich text item name

Returns:

this writer

addRichText

RichTextWriter addRichText(RichTextWriter rt)

Appends rich text created in another writer

Parameters:

rt - writer

Returns:

this writer

addRichTextRecord

RichTextWriter addRichTextRecord(RichTextRecord<?> record)

Adds a raw rich text record from an existing instance.

Parameters:

record - raw record

Returns:

this writer

addRichTextRecord

<T extends RichTextRecord<?>> RichTextWriter addRichTextRecord(Class<T> recordClass,
                                                               Consumer<T> processor)

Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.

Type Parameters:

T - the type of record to add

Parameters:

recordClass - a Class record representing <T>

processor - a Consumer to configure the record

Returns:

this writer

addRichTextRecord

<T extends RichTextRecord<?>> RichTextWriter addRichTextRecord(RecordType recordType,
                                                               Consumer<T> processor)

Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.

Type Parameters:

T - the type of record that corresponds to recordType

Parameters:

recordType - a RecordType record type representing the record to create

processor - a Consumer to configure the record

Returns:

this writer

addRichTextRecord

<T extends RichTextRecord<?>> RichTextWriter addRichTextRecord(Class<T> recordClass,
                                                               int variableDataLength,
                                                               Consumer<T> processor)

Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.

This method allows you to specify an additional amount of space to allocate for the structure's variable data, which will be accessible just after the final part of the structure.

Type Parameters:

T - the type of record to add

Parameters:

recordClass - a Class record representing <T>

variableDataLength - the amount of additional space, in bytes, to allocate after the structure

processor - a Consumer to configure the record

Returns:

this writer

addRichTextRecord

<T extends RichTextRecord<?>> RichTextWriter addRichTextRecord(RecordType recordType,
                                                               int variableDataLength,
                                                               Consumer<T> processor)

Creates a new rich-text record of the given type and processes it through the provided function before appending it to the record stream.

This method allows you to specify an additional amount of space to allocate for the structure's variable data, which will be accessible just after the final part of the structure.

Type Parameters:

T - the type of record that corresponds to recordType

Parameters:

recordType - a RecordType record type representing the record to create

variableDataLength - the amount of additional space, in bytes, to allocate after the structure

processor - a Consumer to configure the record

Returns:

this writer

createStructure

<T extends MemoryStructure> T createStructure(Class<T> structureClass,
                                              int variableDataLength)

Creates a new MemoryStructure of the given class in memory, without appending it to the destination rich-text entity. This is useful in specific situations where variable data consists of structured values.

Type Parameters:

T - the type of structure to create

Parameters:

structureClass - a Class representing <T>

variableDataLength - the amount of additional space, in bytes, to allocate after the structure

Returns:

the newly-constructed structure

createFontStyle

FontStyle createFontStyle()

Creates a new font style

Returns:

style

createTextStyle

TextStyle createTextStyle(String styleName)

Creates a new text style

Parameters:

styleName - style name

Returns:

style

discard

void discard()

Discard any changes in this writer and free all resources