Class RtfBookmark

java.lang.Object
org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement
org.apache.fop.render.rtf.rtflib.rtfdoc.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.

This work was authored by Andreas Putz (a.putz@skynamics.com).

  • Field Details

    • bookmark

      private String bookmark
      Name of the bokkmark
    • MAX_BOOKMARK_LENGTH

      public static final int MAX_BOOKMARK_LENGTH
      Word 2000 supports a length of 40 characters only
      See Also:
    • REPLACE_CHARACTER

      public static final char REPLACE_CHARACTER
      Word 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 - a RtfBookmarkContainer value
      writer - a Writer value
      bookmark - Name of the bookmark
      Throws:
      IOException
  • Method Details

    • writeRtfPrefix

      public void writeRtfPrefix() throws IOException
      Is called before writing the Rtf content.
      Overrides:
      writeRtfPrefix in class RtfElement
      Throws:
      IOException - On Error
    • writeRtfContent

      public void writeRtfContent() throws IOException
      Writes the RTF content to m_writer.
      Specified by:
      writeRtfContent in class RtfElement
      Throws:
      IOException - On error
    • writeRtfSuffix

      public void writeRtfSuffix() throws IOException
      Is called after writing the Rtf content.
      Overrides:
      writeRtfSuffix in class RtfElement
      Throws:
      IOException - On Error
    • startBookmark

      private void startBookmark() throws IOException
      Writes RTF content to begin the bookmark.
      Throws:
      IOException - On error
    • endBookmark

      private void endBookmark() throws IOException
      Writes RTF content to close the bookmark.
      Throws:
      IOException - On error
    • writeRtfBookmark

      private void writeRtfBookmark(String tag) throws IOException
      Writes the rtf bookmark.
      Parameters:
      tag - Begin or close tag
      Throws:
      IOException - On error
    • isEmpty

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