net.sourceforge.rtf.document

Class RTFBookmark

java.lang.Object

net.sourceforge.rtf.document.RTFElement

net.sourceforge.rtf.document.RTFBookmark

Direct Known Subclasses:

RTFEndBookmark, RTFStartBookmark

public abstract class RTFBookmark
extends RTFElement

RTF Element Bookmark. This element contains one StringBuffer (see elementList of RTFElement) for the RTF code. eg : RTF code Bookmark with name MY_BOOKMARK : {\*\bkmkstart MY_BOOKMARK }{\*\bkmkend MY_BOOKMARK } After transformation (see RTFVelocityTransformer) Bookmark loop is replaced by #foreach ($item_myList in $myList) velocity. $item_myList is the velocity name list.

Version:

1.0.0

Author:

Angelo ZERR

See Also:

RTFVelocityTransformerImpl

Constructor Summary

Constructors

Constructor and Description
RTFBookmark(RTFBookmark bookmark)
RTFBookmark(String bkmkey)

Method Summary

Modifier and Type	Method and Description
String	getItemNameList() Return velocity name list (eg : $item_myList)
String	getName() Return name of Bookmark.
void	setItemNameList(String velocityNameList) Set velocity name list (eg : $item_myList)

Methods inherited from class net.sourceforge.rtf.document.RTFElement

addFirstRTFString, addLastRTFString, addRTFElement, addRTFString, flush, getElementList, getElementTextBetween, getFirstRTFString, getRTFContentOfSimpleElement, getRtfElementParent, getRTFFirstContentOfElement, removeCurrentRTFString, replaceElement, setRtfElementParent

Methods inherited from class java.lang.Object

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

Constructor Detail

RTFBookmark

public RTFBookmark(String bkmkey)

RTFBookmark

public RTFBookmark(RTFBookmark bookmark)

Method Detail

getName

public String getName()

Return name of Bookmark. eg : for RTF code bookmark {\*\bkmkstart MY_BOOKMARK }{\*\bkmkend MY_BOOKMARK } this getter return MY_BOOKMARK.

Returns:

the result.

getItemNameList

public String getItemNameList()

Return velocity name list (eg : $item_myList)

Returns:

velocity name list.

setItemNameList

public void setItemNameList(String velocityNameList)

Set velocity name list (eg : $item_myList)

Parameters:

velocityNameList - the velocity name list.