Package adams.gui.flow.tree.annotations

Class Markdown

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.gui.flow.tree.annotations.AnnotationProcessor, Serializable
    public class Markdown
extends adams.gui.flow.tree.annotations.AbstractAnnotationProcessor
    Turns the markdown annotations into HTML.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.markdownj.MarkdownProcessor m_MarkdownProcessor  

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      Markdown()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.markdownj.MarkdownProcessor getProcessor()
      Returns the markdown processor to use.
      String globalInfo()
      Returns a string describing the object.
      String toHTML​(adams.gui.flow.tree.Node node)
      Turns the actor's annotations into HTML.

      • Methods inherited from class adams.gui.flow.tree.annotations.AbstractAnnotationProcessor

        insertLineBreaks

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_MarkdownProcessor

        protected transient org.markdownj.MarkdownProcessor m_MarkdownProcessor

    • Constructor Detail

      • Markdown

        public Markdown()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • getProcessor

        protected org.markdownj.MarkdownProcessor getProcessor()
        Returns the markdown processor to use.
        Returns:
        the processor

      • toHTML

        public String toHTML​(adams.gui.flow.tree.Node node)
        Turns the actor's annotations into HTML.
        Parameters:
        node - the node to process the annotations for
        Returns:
        the generated HTML