Class GHelpSet

  • All Implemented Interfaces:

    public class GHelpSet
    Ghidra help set that creates a GhidraHelpBroker, installs some custom HTML handling code via the GHelpHTMLEditorKit, and most importantly, changes how the JavaHelp system works with regard to integrating Help Sets.

    The HelpSet class uses a object to locate HTML files by objects. This class has overridden that basic usage of the Map object to allow ID lookups to take place across GHelpSet objects. We need to do this due to how we merge help set content across modules. More specifically, in order to merge, we have to make all xml tags the same, including the target HTML file they may reference. Well, when a module uses a tag that references an HTML file not inside of it's module, then JavaHelp considers this an error and does not correctly merge the HelpSets that share the reference. Further, it does not properly locate the shared HTML file reference. This class allows lookups across modules by overridden the lookup functionality done by the map object. More specifically, we override getCombinedMap() and getLocalMap() to use a custom delegate map object that knows how do do this "cross-module" help lookup.

    See Also:
    GHelpHTMLEditorKit, Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class,
    • Field Summary

      • Fields inherited from class

        helpBrokerClass, helpBrokerLoader, implRegistry, kitLoaderRegistry, kitTypeRegistry, listenerList, publicIDString, publicIDString_V2
    • Constructor Summary

      Constructor Description
      GHelpSet​(java.lang.ClassLoader loader, helpset)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description createHelpBroker() getCombinedMap() getLocalMap()  
      • Methods inherited from class

        add, addHelpSetListener, addPresentation, addSubHelpSet, addView, contains, createHelpBroker, findHelpSet, findHelpSet, findHelpSet, fireHelpSetAdded, fireHelpSetRemoved, getDefaultPresentation, getHelpSets, getHelpSetURL, getHomeID, getKeyData, getLoader, getLocale, getNavigatorView, getNavigatorViews, getPresentation, getPresentations, getTitle, parse, parseInto, remove, removeHelpSetListener, setHomeID, setKeyData, setLocalMap, setTitle, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • GHelpSet

        public GHelpSet​(java.lang.ClassLoader loader,
    • Method Detail

      • createHelpBroker

        public createHelpBroker()
        createHelpBroker in class
      • getLocalMap

        public getLocalMap()
        getLocalMap in class
      • getCombinedMap

        public getCombinedMap()
        getCombinedMap in class