Class RtfBookmark
java.lang.Object
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfBookmark
RTF Bookmark. Create an RTF bookmark as a child of given container with default attributes. This class belongs to the "id" attribute processing.
This work was authored by Andreas Putz (a.putz@skynamics.com).
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Name of the bokkmarkstatic final int
Word 2000 supports a length of 40 characters onlystatic final char
Word 2000 converts '.' in bookmarks to "_", thats why we control this replacement.Fields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
attrib, parent, writer
-
Constructor Summary
ConstructorsConstructorDescriptionRtfBookmark
(RtfContainer parent, Writer writer, String bookmark) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Writes RTF content to close the bookmark.boolean
isEmpty()
private void
Writes RTF content to begin the bookmark.private void
writeRtfBookmark
(String tag) Writes the rtf bookmark.void
Writes the RTF content to m_writer.void
Is called before writing the Rtf content.void
Is called after writing the Rtf content.Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
close, dump, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, newLine, okToWriteRtf, toString, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeStarControlWord, writeStarControlWordNS
-
Field Details
-
bookmark
Name of the bokkmark -
MAX_BOOKMARK_LENGTH
public static final int MAX_BOOKMARK_LENGTHWord 2000 supports a length of 40 characters only- See Also:
-
REPLACE_CHARACTER
public static final char REPLACE_CHARACTERWord 2000 converts '.' in bookmarks to "_", thats why we control this replacement.- See Also:
-
-
Constructor Details
-
RtfBookmark
RtfBookmark(RtfContainer parent, Writer writer, String bookmark) throws IOException Constructor.- Parameters:
parent
- aRtfBookmarkContainer
valuewriter
- aWriter
valuebookmark
- Name of the bookmark- Throws:
IOException
-
-
Method Details
-
writeRtfPrefix
Is called before writing the Rtf content.- Overrides:
writeRtfPrefix
in classRtfElement
- Throws:
IOException
- On Error
-
writeRtfContent
Writes the RTF content to m_writer.- Specified by:
writeRtfContent
in classRtfElement
- Throws:
IOException
- On error
-
writeRtfSuffix
Is called after writing the Rtf content.- Overrides:
writeRtfSuffix
in classRtfElement
- Throws:
IOException
- On Error
-
startBookmark
Writes RTF content to begin the bookmark.- Throws:
IOException
- On error
-
endBookmark
Writes RTF content to close the bookmark.- Throws:
IOException
- On error
-
writeRtfBookmark
Writes the rtf bookmark.- Parameters:
tag
- Begin or close tag- Throws:
IOException
- On error
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in classRtfElement
- Returns:
- true if this element would generate no "useful" RTF content
-