de.jakop.lotus.domingo

Interface DRichTextItem

All Superinterfaces:

DBase, DBaseItem, Serializable

All Known Implementing Classes:

RichTextItemProxy

public interface DRichTextItem
extends DBaseItem

Represents an item of type rich text.

Author:

Kurt Riede

Method Summary

Modifier and Type	Method and Description
void	addNewLine() Appends one or more new lines (carriage returns) to the end of a rich-text item.
void	addNewLine(int n) Appends one or more new lines (carriage returns) to the end of a rich-text item.
void	addNewLine(int n, boolean newparagraph) Appends one or more new lines (carriage returns) to the end of a rich-text item.
void	addTab() Appends one or more tabs to the end of a rich-text item.
void	addTab(int count) Appends one or more tabs to the end of a rich-text item.
void	appendText(String text) Appends text to the end of a rich text item.
DEmbeddedObject	embedAttachment(String path) Embeds an object or an attachment.
DEmbeddedObject	getEmbeddedAttachment(String fileName) Given the name of a file attachment in a rich-text item, returns the corresponding EmbeddedObject.
Iterator	getEmbeddedObjects() All the embedded objects, object links, and file attachments contained in a rich text item.
String	getUnformattedText() Returns the text of the item without any formatting.

Methods inherited from interface de.jakop.lotus.domingo.DBaseItem

getName, remove

Methods inherited from interface de.jakop.lotus.domingo.DBase

equals, hashCode, toString

Method Detail

embedAttachment

DEmbeddedObject embedAttachment(String path)

Embeds an object or an attachment. It can be retrieved later by use of the pure filename (without path) of the attached file. Calls the notes method embedObject(EmbeddedObject.EMBED_ATTACHMENT, "", source, "")

Parameters:

path - source name of the object

Returns:

DEmbeddedObject

getEmbeddedAttachment

DEmbeddedObject getEmbeddedAttachment(String fileName)

Given the name of a file attachment in a rich-text item, returns the corresponding EmbeddedObject.

Note getEmbeddedObject is not supported under OS/2, under UNIX, and on the Macintosh.

Parameters:

fileName - the embedded attachments filename

Returns:

the embedded object

getEmbeddedObjects

Iterator getEmbeddedObjects()

All the embedded objects, object links, and file attachments contained in a rich text item. If you need access to OLE/2 embedded objects that exist in a document but are not part of a rich text item (for example, because the object was originally created on the document's form), use the EmbeddedObjects property in Document.

Note Embedded objects and object links are not supported for OS/2, UNIX, and the Macintosh. File attachments are.

Returns:

Iterator an iterator supplying all embedded objects

appendText

void appendText(String text)

Appends text to the end of a rich text item. The text is rendered in the current style of the item.

Parameters:

text - The text to append.

addNewLine

void addNewLine()

Appends one or more new lines (carriage returns) to the end of a rich-text item.

addNewLine

void addNewLine(int n)

Appends one or more new lines (carriage returns) to the end of a rich-text item.

Parameters:

n - The number of new lines to append.

addNewLine

void addNewLine(int n,
                boolean newparagraph)

Appends one or more new lines (carriage returns) to the end of a rich-text item.

Parameters:

n - The number of new lines to append.

newparagraph - If true (default), forces the new line to be a paragraph separator. If false, the new line is added, but does not force a new paragraph.

addTab

void addTab()

Appends one or more tabs to the end of a rich-text item.

addTab

void addTab(int count)

Appends one or more tabs to the end of a rich-text item.

Parameters:

count - The number of tabs to append.

getUnformattedText

String getUnformattedText()

Returns the text of the item without any formatting.

Returns:

String