<h2>org.autoplot.help.AutoplotHelpSystem</h2><p>Encapsulates JavaHelp functionality for convenient access by components.</p> <hr> <a name="displayDefaultHelp"></a> <h2>displayDefaultHelp</h2> displayDefaultHelp( ) → void <p>Display the help window with default page displayed</p> <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=displayDefaultHelp&unscoped_q=displayDefaultHelp">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/help/AutoplotHelpSystem.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/help/AutoplotHelpSystem.html#displayDefaultHelp">[view on old javadoc]</a> <br> <br> <hr> <a name="displayHelpFromEvent"></a> <h2>displayHelpFromEvent</h2> displayHelpFromEvent( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html'>java.awt.event.ActionEvent</a> e ) → void <p></p> <h3>Parameters</h3> e - an ActionEvent <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=displayHelpFromEvent&unscoped_q=displayHelpFromEvent">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/help/AutoplotHelpSystem.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/help/AutoplotHelpSystem.html#displayHelpFromEvent">[view on old javadoc]</a> <br> <br> displayHelpFromEvent( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/event/ActionEvent.html'>java.awt.event.ActionEvent</a> e, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a> focus ) → void<br> <hr> <a name="getHelpSystem"></a> <h2>getHelpSystem</h2> getHelpSystem( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/autoplot/help/AutoplotHelpSystem.html'>org.autoplot.help.AutoplotHelpSystem</a> <p>Returns a reference to the help system, or <code>null</code> if it hasn't been initialized.</p> <h3>Returns:</h3> the single instance <br><br> <a href="https://github.com/autoplot/dev/search?q=getHelpSystem&unscoped_q=getHelpSystem">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/help/AutoplotHelpSystem.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/help/AutoplotHelpSystem.html#getHelpSystem">[view on old javadoc]</a> <br> <br> <hr> <a name="initialize"></a> <h2>initialize</h2> initialize( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html'>java.awt.Component</a> uiBase ) → void <p></p> <h3>Parameters</h3> uiBase - a Component <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=initialize&unscoped_q=initialize">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/help/AutoplotHelpSystem.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/help/AutoplotHelpSystem.html#initialize">[view on old javadoc]</a> <br> <br> <hr> <a name="registerHelpID"></a> <h2>registerHelpID</h2> registerHelpID( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html'>java.awt.Component</a> c, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> helpID ) → void <p>Components can call this method to register a help ID string. The JavaHelp system will use this ID string as a hash key to find the correct HTML file to display for context-sensitive help. TitledBorder panels and children that are TitledBorders will have their title behave like a link into the documentation.</p> <h3>Parameters</h3> c - a Component <br> helpID - a String <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=registerHelpID&unscoped_q=registerHelpID">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/help/AutoplotHelpSystem.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/help/AutoplotHelpSystem.html#registerHelpID">[view on old javadoc]</a> <br> <br> <hr> <a name="unregisterHelpID"></a> <h2>unregisterHelpID</h2> unregisterHelpID( <a href='https://docs.oracle.com/javase/8/docs/api/java/awt/Component.html'>java.awt.Component</a> c, <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> helpID ) → void <p>remove the component.</p> <h3>Parameters</h3> c - a Component <br> helpID - a String <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=unregisterHelpID&unscoped_q=unregisterHelpID">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/autoplot/help/AutoplotHelpSystem.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/autoplot/help/AutoplotHelpSystem.html#unregisterHelpID">[view on old javadoc]</a> <br> <br>