Package jexer.help

Class HelpFile

  • public class HelpFile
extends java.lang.Object
    A HelpFile is a collection of Topics with a table of contents and index of relevant terms.

    • Constructor Summary

      Constructors 
      Constructor Description
      HelpFile()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Topic getIndex()
      Get the special "index" topic.
      Topic getSearchResults​(java.lang.String searchString)
      Get the special "search results" topic.
      Topic getTableOfContents()
      Get the special "table of contents" topic.
      Topic getTopic​(java.lang.String title)
      Get a topic by title.
      void load​(java.io.InputStream input)
      Load a help file from an input stream.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • HelpFile

        public HelpFile()

    • Method Detail

      • load

        public void load​(java.io.InputStream input)
          throws java.io.IOException,
                 javax.xml.parsers.ParserConfigurationException,
                 org.xml.sax.SAXException
        Load a help file from an input stream.
        Parameters:
        input - the input strem
        Throws:
        java.io.IOException - if an I/O error occurs
        javax.xml.parsers.ParserConfigurationException - if no XML parser is available
        org.xml.sax.SAXException - if XML parsing fails

      • getTopic

        public Topic getTopic​(java.lang.String title)
        Get a topic by title.
        Parameters:
        title - the title for the topic
        Returns:
        the topic, or the "not found" topic if title is not found

      • getSearchResults

        public Topic getSearchResults​(java.lang.String searchString)
        Get the special "search results" topic.
        Parameters:
        searchString - a regular expression search string
        Returns:
        an index topic containing topics with text that matches the search string

      • getTableOfContents

        public Topic getTableOfContents()
        Get the special "table of contents" topic.
        Returns:
        the table of contents topic

      • getIndex

        public Topic getIndex()
        Get the special "index" topic.
        Returns:
        the index topic