cytoscape.view
Class CyHelpBroker

java.lang.Object
  cytoscape.view.CyHelpBroker

public class CyHelpBroker
extends Object

This class creates the Cytoscape Help Broker for managing the JavaHelp system and help set access

Method Summary

static boolean	addHelpSet(javax.help.HelpSet newHelpSet)
static ActionListener	getHelpActionListener() Provides access to an ActionListener that pops up a help dialog.
static javax.help.HelpBroker	getHelpBroker() Returns the HelpBroker.
static javax.help.HelpSet	getHelpSet() Returns the HelpSet.
static boolean	removeHelpSet(javax.help.HelpSet hs) Removes a help set that was previously added with addHelpSet().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHelpBroker

public static javax.help.HelpBroker getHelpBroker()

Returns the HelpBroker.

Returns:

the HelpBroker.

getHelpSet

public static javax.help.HelpSet getHelpSet()

Returns the HelpSet.

Returns:

the HelpSet.

addHelpSet

public static boolean addHelpSet(javax.help.HelpSet newHelpSet)

Returns:

true if we successfully added the help set, else false

removeHelpSet

public static boolean removeHelpSet(javax.help.HelpSet hs)

Removes a help set that was previously added with addHelpSet().

Returns:

true if "hs" has been successfully removed, false otherwise

getHelpActionListener

public static ActionListener getHelpActionListener()

Provides access to an ActionListener that pops up a help dialog. To enable, for example, a help button, you would simple add the available action as a ActionListener to the button.

 JButton helpButton = new JButton("Help");
 helpButton.addActionListener( CyHelpBroker.getHelpActionListener() );