Package jexer.help

Class Topic

  • All Implemented Interfaces:
    java.lang.Comparable<Topic>
    public class Topic
extends java.lang.Object
implements java.lang.Comparable<Topic>
    A Topic is a page of help text with a title and possibly links to other Topics.

    • Constructor Summary

      Constructors 
      Constructor Description
      Topic​(java.lang.String title, java.lang.String text)
      Public constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(Topic that)
      Comparison operator.
      java.util.Set<java.lang.String> getIndexKeys()
      Get the index keys.
      java.util.List<Link> getLinks()
      Get the links.
      java.lang.String getText()
      Get the topic text.
      java.lang.String getTitle()
      Get the topic title.
      java.lang.String toString()
      Generate a human-readable string for this widget.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Topic

        public Topic​(java.lang.String title,
             java.lang.String text)
        Public constructor.
        Parameters:
        title - the topic title
        text - the topic text

    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Get the topic title.
        Returns:
        the title

      • getText

        public java.lang.String getText()
        Get the topic text.
        Returns:
        the text

      • getIndexKeys

        public java.util.Set<java.lang.String> getIndexKeys()
        Get the index keys.
        Returns:
        the keys

      • getLinks

        public java.util.List<Link> getLinks()
        Get the links.
        Returns:
        the links

      • compareTo

        public int compareTo​(Topic that)
        Comparison operator.
        Specified by:
        compareTo in interface java.lang.Comparable<Topic>
        Parameters:
        that - another Topic instance
        Returns:
        comparison by topic title

      • toString

        public java.lang.String toString()
        Generate a human-readable string for this widget.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a human-readable string