Package docking.help

Class GHelpBroker

  • All Implemented Interfaces:
    java.awt.event.KeyListener, java.util.EventListener, javax.help.HelpBroker

    public class GHelpBroker
    extends javax.help.DefaultHelpBroker
    Ghidra help broker that displays the help set; sets the Ghidra icon on the help frame and attempts to maintain the user window size.
    • Field Summary

      • Fields inherited from class javax.help.DefaultHelpBroker

        displayHelpFromFocus, displayHelpFromSource
    • Constructor Summary

      Constructors 
      Constructor Description
      GHelpBroker​(javax.help.HelpSet hs)
      Construct a new GhidraHelpBroker.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addCustomToolbarItems​(javax.help.JHelp jHelp)
      Create zoom in/out buttons on the default help window toolbar.
      void setActivationWindow​(java.awt.Window window)  
      void setCurrentURL​(java.net.URL URL)  
      void setDisplayed​(boolean b)  
      • Methods inherited from class javax.help.DefaultHelpBroker

        enableHelp, enableHelp, enableHelpKey, enableHelpKey, enableHelpOnButton, enableHelpOnButton, enableHelpOnButton, getCurrentID, getCurrentURL, getCurrentView, getDisplayHelpFromFocus, getDisplayHelpFromSource, getFont, getHelpSet, getLocale, getLocation, getScreen, getSize, getWindowPresentation, initPresentation, isDisplayed, isViewDisplayed, keyPressed, keyReleased, keyTyped, setActivationObject, setCurrentID, setCurrentID, setCurrentView, setFont, setHelpSet, setHelpSetPresentation, setLocale, setLocation, setScreen, setSize, setViewDisplayed, showID, showID
      • Methods inherited from class java.lang.Object

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

      • GHelpBroker

        public GHelpBroker​(javax.help.HelpSet hs)
        Construct a new GhidraHelpBroker.
        Parameters:
        hs - java help set associated with this help broker
    • Method Detail

      • setCurrentURL

        public void setCurrentURL​(java.net.URL URL)
        Specified by:
        setCurrentURL in interface javax.help.HelpBroker
        Overrides:
        setCurrentURL in class javax.help.DefaultHelpBroker
      • setDisplayed

        public void setDisplayed​(boolean b)
        Specified by:
        setDisplayed in interface javax.help.HelpBroker
        Overrides:
        setDisplayed in class javax.help.DefaultHelpBroker
      • addCustomToolbarItems

        protected void addCustomToolbarItems​(javax.help.JHelp jHelp)
        Create zoom in/out buttons on the default help window toolbar.
        Parameters:
        jHelp - the java help object used to retrieve the help components
      • setActivationWindow

        public void setActivationWindow​(java.awt.Window window)
        Overrides:
        setActivationWindow in class javax.help.DefaultHelpBroker