de.bea.domingo.proxy
Class RichTextItemProxy

java.lang.Object
  de.bea.domingo.monitor.AbstractMonitorEnabled
      de.bea.domingo.proxy.BaseProxy
          de.bea.domingo.proxy.BaseItemProxy
              de.bea.domingo.proxy.RichTextItemProxy

All Implemented Interfaces:

DBase, DBaseItem, DRichTextItem, MonitorEnabled, java.io.Serializable

public final class RichTextItemProxy
extends BaseItemProxy
implements DRichTextItem

This class represents the Domino-Class RichTextItem.

Author:

Kurt Riede

See Also:

Serialized Form

Nested Class Summary

protected static class

RichTextItemProxy.EmbeddedObjectsIterator A EmbeddedObjectsIterator allows iteration over a set of lotus.domino.EmbeddedObject.

Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseProxy

BaseProxy.DocumentCollectionIterator

Field Summary

Fields inherited from class de.bea.domingo.proxy.BaseProxy

DATETIME_STRING_LENGTH, EMPTY_STRING, MAX_DATETIME_LENGTH, NUM_DATETIME_VALUES, RESOURCES

Constructor Summary

protected

RichTextItemProxy(NotesProxyFactory theFactory, DBase parent, lotus.domino.RichTextItem theRichTextItem, DNotesMonitor monitor) Constructor for DRichTextItemImpl.

Method Summary

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(java.lang.String text) Appends text to the end of a rich text item.
DEmbeddedObject	embedAttachment(java.lang.String path) Embeds an object or an attachment.
DEmbeddedObject	getEmbeddedAttachment(java.lang.String fileName) Given the name of a file attachment in a rich-text item, returns the corresponding EmbeddedObject.
java.util.Iterator	getEmbeddedObjects() All the embedded objects, object links, and file attachments contained in a rich text item.
java.lang.String	getUnformattedText() Returns the text of the item without any formatting.

Methods inherited from class de.bea.domingo.proxy.BaseItemProxy

getInstance, getItem, getName, remove, toString

Methods inherited from class de.bea.domingo.proxy.BaseProxy

checkSession, clearNotesObject, convertCalendarsToNotesDateTime, convertListToVector, convertNotesDateTimesToCalendar, convertVectorToList, createCalendar, createDateRange, createDateTime, decrementDateTimeCounter, finalize, getCountDateTime, getDSession, getFactory, getNotesObject, getParent, incrementDateTimeCounter, newException, newException, newException, newRuntimeException, newRuntimeException, newRuntimeException, recycleDateTimeList, refereceHashCode, toStringGeneric, toStringIntern

Methods inherited from class de.bea.domingo.monitor.AbstractMonitorEnabled

getMonitor, setMonitor

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.bea.domingo.DBaseItem

getName, remove

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode, toString

Constructor Detail

RichTextItemProxy

protected RichTextItemProxy(NotesProxyFactory theFactory,
                            DBase parent,
                            lotus.domino.RichTextItem theRichTextItem,
                            DNotesMonitor monitor)

Constructor for DRichTextItemImpl.

Parameters:

theFactory - the controlling factory

parent - the parent object

theRichTextItem - the Notes TichTextItem

monitor - the monitor

Method Detail

embedAttachment

public DEmbeddedObject embedAttachment(java.lang.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, "")

Specified by:

embedAttachment in interface DRichTextItem

Parameters:

path - source name of the object

Returns:

DEmbeddedObject

See Also:

DRichTextItem.embedAttachment(java.lang.String)

getEmbeddedAttachment

public DEmbeddedObject getEmbeddedAttachment(java.lang.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.

Specified by:

getEmbeddedAttachment in interface DRichTextItem

Parameters:

fileName - the embedded attachments filename

Returns:

the embedded object

See Also:

DRichTextItem.getEmbeddedAttachment(java.lang.String)

getEmbeddedObjects

public java.util.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.

Specified by:

getEmbeddedObjects in interface DRichTextItem

Returns:

Iterator an iterator supplying all embedded objects

See Also:

DRichTextItem.getEmbeddedObjects()

appendText

public void appendText(java.lang.String text)

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

Specified by:

appendText in interface DRichTextItem

Parameters:

text - The text to append.

See Also:

DRichTextItem.appendText(java.lang.String)

addNewLine

public void addNewLine()

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

Specified by:

addNewLine in interface DRichTextItem

See Also:

DRichTextItem.addNewLine()

addNewLine

public void addNewLine(int n)

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

Specified by:

addNewLine in interface DRichTextItem

Parameters:

n - The number of new lines to append.

See Also:

DRichTextItem.addNewLine(int)

addNewLine

public void addNewLine(int n,
                       boolean newparagraph)

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

Specified by:

addNewLine in interface DRichTextItem

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.

See Also:

DRichTextItem.addNewLine(int, boolean)

addTab

public void addTab()

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

Specified by:

addTab in interface DRichTextItem

See Also:

DRichTextItem.addTab()

addTab

public void addTab(int count)

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

Specified by:

addTab in interface DRichTextItem

Parameters:

count - The number of tabs to append.

See Also:

DRichTextItem.addTab(int)

getUnformattedText

public java.lang.String getUnformattedText()

Returns the text of the item without any formatting.

Specified by:

getUnformattedText in interface DRichTextItem

Returns:

String

See Also:

DRichTextItem.getUnformattedText()