Module io.github.tonywasher.joceanus.metis
Package io.github.tonywasher.joceanus.metis.help

Class MetisHelpEntry

java.lang.Object
io.github.tonywasher.joceanus.metis.help.MetisHelpEntry
public class MetisHelpEntry extends Object
Help Entry class. This class provides structure to the help system, providing parent child relationships to implement chapters and also providing maps between the name of a help page and the file that holds the HTML for the page

  • Constructor Details

    • MetisHelpEntry

      public MetisHelpEntry(String pName, String pTitle, K pHelpId)
      Constructor for an HTML element.
      Type Parameters:
      K - the key type
      Parameters:
      pName - the name by which this entry is referenced
      pTitle - the title for this page in the table of contents
      pHelpId - the helpId representing the HTML for this entry

    • MetisHelpEntry

      public MetisHelpEntry(String pName, String pTitle)
      Constructor for a table of contents element.
      Parameters:
      pName - the name by which this entry is referenced
      pTitle - the title for this page in the table of contents

  • Method Details

    • addChildEntry

      public MetisHelpEntry addChildEntry(MetisHelpEntry pChild)
      Add child entry.
      Parameters:
      pChild - the child
      Returns:
      the HelpEntry

    • getTitle

      public String getTitle()
      Obtain the title.
      Returns:
      the title

    • getName

      public String getName()
      Obtain the name.
      Returns:
      the name

    • getHelpId

      public MetisHelpModule.MetisHelpId getHelpId()
      Obtain the helpId.
      Returns:
      the id

    • getChildren

      public List<MetisHelpEntry> getChildren()
      Obtain the children.
      Returns:
      the children

    • getHtml

      public String getHtml()
      Obtain the HTML.
      Returns:
      the HTML

    • setHtml

      protected void setHtml(String pHtml)
      Set the HTML.
      Parameters:
      pHtml - the HTML

    • toString

      public String toString()
      Overrides:
      toString in class Object