Class AnchorDefinition


  • public class AnchorDefinition
    extends java.lang.Object
    A representation of a help location, which can be a file or a file with an anchor inside of that file.

    This class is used to generate target information for TOC files and to generate link information for the help map files.


    Warning: The ID generated by this class is specific to the JavaHelp system. It is of the format:

    TopicName_anchorName

    or

    TopicName_Filename

    • Constructor Summary

      Constructors 
      Constructor Description
      AnchorDefinition​(java.nio.file.Path file, java.lang.String anchorName, int lineNum)  
    • Constructor Detail

      • AnchorDefinition

        public AnchorDefinition​(java.nio.file.Path file,
                                java.lang.String anchorName,
                                int lineNum)
    • Method Detail

      • getAnchorName

        public java.lang.String getAnchorName()
      • getSrcFile

        public java.nio.file.Path getSrcFile()
      • getId

        public java.lang.String getId()
      • getLineNumber

        public int getLineNumber()
      • getHelpPath

        public java.lang.String getHelpPath()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object