org.apache.fop.render.rtf.rtflib.rtfdoc

Class RtfBookmark


public class RtfBookmark
extends RtfElement

RTF Bookmark. Create an RTF bookmark as a child of given container with default attributes. This class belongs to the "id" attribute processing.
Author:
Andreas Putz

Field Summary

static int
MAX_BOOKMARK_LENGTH
Word 2000 supports a length of 40 characters only
static char
REPLACE_CHARACTER
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

Method Summary

boolean
isEmpty()
void
writeRtfContent()
Writes the RTF content to m_writer.
void
writeRtfPrefix()
Is called before writing the Rtf content.
void
writeRtfSuffix()
Is called after writing the Rtf content.

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

close, getRtfAttributes, isEmpty, newLine, okToWriteRtf, toString, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfContent, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS

Field Details

MAX_BOOKMARK_LENGTH

public static final int MAX_BOOKMARK_LENGTH
Word 2000 supports a length of 40 characters only
Field Value:
40

REPLACE_CHARACTER

public static final char REPLACE_CHARACTER
Word 2000 converts '.' in bookmarks to "_", thats why we control this replacement.
Field Value:
'_'

Method Details

isEmpty

public boolean isEmpty()
Overrides:
isEmpty in interface RtfElement
Returns:
true if this element would generate no "useful" RTF content

writeRtfContent

public void writeRtfContent()
            throws IOException
Writes the RTF content to m_writer.
Overrides:
writeRtfContent in interface RtfElement

writeRtfPrefix

public void writeRtfPrefix()
            throws IOException
Is called before writing the Rtf content.
Overrides:
writeRtfPrefix in interface RtfElement

writeRtfSuffix

public void writeRtfSuffix()
            throws IOException
Is called after writing the Rtf content.
Overrides:
writeRtfSuffix in interface RtfElement

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.