Package com.github.rjeschke.txtmark

Interface Decorator

  • All Known Implementing Classes:
    DefaultDecorator
    public interface Decorator
    Decorator interface.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void closeBlockquote​(java.lang.StringBuilder out)
      Called when a blockquote is closed.
      void closeCodeBlock​(java.lang.StringBuilder out)
      Called when a code block is closed.
      void closeCodeSpan​(java.lang.StringBuilder out)
      Called when a code span is closed.
      void closeEmphasis​(java.lang.StringBuilder out)
      Called when an emphasis span is closed.
      void closeHeadline​(java.lang.StringBuilder out, int level)
      Called when a headline is closed.
      void closeImage​(java.lang.StringBuilder out)
      Called when an image is closed.
      void closeLink​(java.lang.StringBuilder out)
      Called when a link is closed
      void closeListItem​(java.lang.StringBuilder out)
      Called when a list item is closed.
      void closeOrderedList​(java.lang.StringBuilder out)
      Called when an ordered list is closed.
      void closeParagraph​(java.lang.StringBuilder out)
      Called when a paragraph is closed.
      void closeStrong​(java.lang.StringBuilder out)
      Called when a strong span is closed.
      void closeSuper​(java.lang.StringBuilder out)
      Called when a superscript span is closed.
      void closeUnorderedList​(java.lang.StringBuilder out)
      Called when an unordered list is closed.
      void horizontalRuler​(java.lang.StringBuilder out)
      Called when a horizontal ruler is encountered.
      void openBlockquote​(java.lang.StringBuilder out)
      Called when a blockquote is opened.
      void openCodeBlock​(java.lang.StringBuilder out)
      Called when a code block is opened.
      void openCodeSpan​(java.lang.StringBuilder out)
      Called when a code span is opened.
      void openEmphasis​(java.lang.StringBuilder out)
      Called when an emphasis span is opened.
      void openHeadline​(java.lang.StringBuilder out, int level)
      Called when a headline is opened.
      void openImage​(java.lang.StringBuilder out)
      Called when an image is opened.
      void openLink​(java.lang.StringBuilder out)
      Called when a link is opened.
      void openListItem​(java.lang.StringBuilder out)
      Called when a list item is opened.
      void openOrderedList​(java.lang.StringBuilder out)
      Called when an ordered list is opened.
      void openParagraph​(java.lang.StringBuilder out)
      Called when a paragraph is opened.
      void openStrong​(java.lang.StringBuilder out)
      Called when a strong span is opened.
      void openSuper​(java.lang.StringBuilder out)
      Called when a superscript span is opened.
      void openUnorderedList​(java.lang.StringBuilder out)
      Called when an unordered list is opened.

    • Method Detail

      • openParagraph

        void openParagraph​(java.lang.StringBuilder out)
        Called when a paragraph is opened.

        Default implementation is: 

         out.append("<p>");
        Parameters:
        out - The StringBuilder to write to.

      • closeParagraph

        void closeParagraph​(java.lang.StringBuilder out)
        Called when a paragraph is closed.

        Default implementation is: 

         out.append("</p>\n");
        Parameters:
        out - The StringBuilder to write to.

      • openBlockquote

        void openBlockquote​(java.lang.StringBuilder out)
        Called when a blockquote is opened. Default implementation is: 
         out.append("<blockquote>");
        Parameters:
        out - The StringBuilder to write to.

      • closeBlockquote

        void closeBlockquote​(java.lang.StringBuilder out)
        Called when a blockquote is closed.

        Default implementation is: 

         out.append("</blockquote>\n");
        Parameters:
        out - The StringBuilder to write to.

      • openCodeBlock

        void openCodeBlock​(java.lang.StringBuilder out)
        Called when a code block is opened.

        Default implementation is: 

         out.append("<pre><code>");
        Parameters:
        out - The StringBuilder to write to.

      • closeCodeBlock

        void closeCodeBlock​(java.lang.StringBuilder out)
        Called when a code block is closed.

        Default implementation is: 

         out.append("</code></pre>\n");
        Parameters:
        out - The StringBuilder to write to.

      • openCodeSpan

        void openCodeSpan​(java.lang.StringBuilder out)
        Called when a code span is opened.

        Default implementation is: 

         out.append("<code>");
        Parameters:
        out - The StringBuilder to write to.

      • closeCodeSpan

        void closeCodeSpan​(java.lang.StringBuilder out)
        Called when a code span is closed.

        Default implementation is: 

         out.append("</code>");
        Parameters:
        out - The StringBuilder to write to.

      • openHeadline

        void openHeadline​(java.lang.StringBuilder out,
                  int level)
        Called when a headline is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

          out.append("<h");
 out.append(level);
        Parameters:
        out - The StringBuilder to write to.
        level - The level to use.

      • closeHeadline

        void closeHeadline​(java.lang.StringBuilder out,
                   int level)
        Called when a headline is closed.

        Default implementation is: 

          out.append("</h");
 out.append(level);
 out.append(">\n");
        Parameters:
        out - The StringBuilder to write to.
        level - The level to use.

      • openStrong

        void openStrong​(java.lang.StringBuilder out)
        Called when a strong span is opened.

        Default implementation is: 

         out.append("<strong>");
        Parameters:
        out - The StringBuilder to write to.

      • closeStrong

        void closeStrong​(java.lang.StringBuilder out)
        Called when a strong span is closed.

        Default implementation is: 

         out.append("</strong>");
        Parameters:
        out - The StringBuilder to write to.

      • openEmphasis

        void openEmphasis​(java.lang.StringBuilder out)
        Called when an emphasis span is opened.

        Default implementation is: 

         out.append("<em>");
        Parameters:
        out - The StringBuilder to write to.

      • closeEmphasis

        void closeEmphasis​(java.lang.StringBuilder out)
        Called when an emphasis span is closed.

        Default implementation is: 

         out.append("</em>");
        Parameters:
        out - The StringBuilder to write to.

      • openSuper

        void openSuper​(java.lang.StringBuilder out)
        Called when a superscript span is opened.

        Default implementation is: 

         out.append("<sup>");
        Parameters:
        out - The StringBuilder to write to.

      • closeSuper

        void closeSuper​(java.lang.StringBuilder out)
        Called when a superscript span is closed.

        Default implementation is: 

         out.append("</sup>");
        Parameters:
        out - The StringBuilder to write to.

      • openOrderedList

        void openOrderedList​(java.lang.StringBuilder out)
        Called when an ordered list is opened.

        Default implementation is: 

         out.append("<ol>\n");
        Parameters:
        out - The StringBuilder to write to.

      • closeOrderedList

        void closeOrderedList​(java.lang.StringBuilder out)
        Called when an ordered list is closed.

        Default implementation is: 

         out.append("</ol>\n");
        Parameters:
        out - The StringBuilder to write to.

      • openUnorderedList

        void openUnorderedList​(java.lang.StringBuilder out)
        Called when an unordered list is opened.

        Default implementation is: 

         out.append("<ul>\n");
        Parameters:
        out - The StringBuilder to write to.

      • closeUnorderedList

        void closeUnorderedList​(java.lang.StringBuilder out)
        Called when an unordered list is closed.

        Default implementation is: 

         out.append("</ul>\n");
        Parameters:
        out - The StringBuilder to write to.

      • openListItem

        void openListItem​(java.lang.StringBuilder out)
        Called when a list item is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

         out.append("<li");
        Parameters:
        out - The StringBuilder to write to.

      • closeListItem

        void closeListItem​(java.lang.StringBuilder out)
        Called when a list item is closed.

        Default implementation is: 

         out.append("</li>\n");
        Parameters:
        out - The StringBuilder to write to.

      • horizontalRuler

        void horizontalRuler​(java.lang.StringBuilder out)
        Called when a horizontal ruler is encountered.

        Default implementation is: 

         out.append("<hr />\n");
        Parameters:
        out - The StringBuilder to write to.

      • openLink

        void openLink​(java.lang.StringBuilder out)
        Called when a link is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

         out.append("<a");
        Parameters:
        out - The StringBuilder to write to.

      • closeLink

        void closeLink​(java.lang.StringBuilder out)
        Called when a link is closed

        Default implementation is: 

         out.append("</a>");
        Parameters:
        out - The StringBuilder to write to.

      • openImage

        void openImage​(java.lang.StringBuilder out)
        Called when an image is opened.

        Note: Don't close the HTML tag!

        Default implementation is: 

         out.append("<img");
        Parameters:
        out - The StringBuilder to write to.

      • closeImage

        void closeImage​(java.lang.StringBuilder out)
        Called when an image is closed.

        Default implementation is: 

         out.append(" />");
        Parameters:
        out - The StringBuilder to write to.