org.autoplot.help.AutoplotHelpSystem
Encapsulates JavaHelp functionality for convenient access by components.
displayDefaultHelp
displayDefaultHelp( ) → void
Display the help window with default page displayed
Returns:
void (returns nothing)
[search for examples]
[view on GitHub]
[view on old javadoc]
displayHelpFromEvent
displayHelpFromEvent( java.awt.event.ActionEvent e ) → void
Parameters
e - an ActionEvent
Returns:
void (returns nothing)
[search for examples]
[view on GitHub]
[view on old javadoc]
displayHelpFromEvent( java.awt.event.ActionEvent e, Object focus ) → void
getHelpSystem
getHelpSystem( ) → org.autoplot.help.AutoplotHelpSystem
Returns a reference to the help system, or null if it hasn't been
initialized.
Returns:
the single instance
[search for examples]
[view on GitHub]
[view on old javadoc]
initialize
initialize( java.awt.Component uiBase ) → void
Parameters
uiBase - a Component
Returns:
void (returns nothing)
[search for examples]
[view on GitHub]
[view on old javadoc]
registerHelpID
registerHelpID( java.awt.Component c, String helpID ) → void
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.
Parameters
c - a Component
helpID - a String
Returns:
void (returns nothing)
[search for examples]
[view on GitHub]
[view on old javadoc]
unregisterHelpID
unregisterHelpID( java.awt.Component c, String helpID ) → void
remove the component.
Parameters
c - a Component
helpID - a String
Returns:
void (returns nothing)
[search for examples]
[view on GitHub]
[view on old javadoc]