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.

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

    • Field Detail

      • bookmark

        private java.lang.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:
        Constant Field Values
      • REPLACE_CHARACTER

        public static final char REPLACE_CHARACTER
        Word 2000 converts '.' in bookmarks to "_", thats why we control this replacement.
        See Also:
        Constant Field Values
    • Constructor Detail

      • RtfBookmark

        RtfBookmark​(RtfContainer parent,
                    java.io.Writer writer,
                    java.lang.String bookmark)
             throws java.io.IOException
        Constructor.
        Parameters:
        parent - a RtfBookmarkContainer value
        writer - a Writer value
        bookmark - Name of the bookmark
        Throws:
        java.io.IOException
    • Method Detail

      • writeRtfPrefix

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

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

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

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

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

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

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