de.unihalle.informatik.Alida.gui
Class OnlineHelpDisplayer

java.lang.Object
  extended by de.unihalle.informatik.Alida.gui.OnlineHelpDisplayer

public class OnlineHelpDisplayer
extends Object

Convenience class for context-sensitive online help.

Author:
moeller

Constructor Summary
OnlineHelpDisplayer()
           
 
Method Summary
static ActionListener getHelpActionListener(Component c, String l, JFrame topFrame)
          Get an ActionListener linked to the Alida online help system.
static void initHelpset(String prefix)
          Explicitly init the helpset, i.e. set helpset prefix.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OnlineHelpDisplayer

public OnlineHelpDisplayer()
Method Detail

initHelpset

public static void initHelpset(String prefix)
Explicitly init the helpset, i.e. set helpset prefix.

By default the prefix is set to 'alida', but to access MiToBo's helpset pages, it needs to be set to 'mitobo' prior to the first call to any helpset page. This routine reinitializes the helpset.

Parameters:
prefix - Prefix of the target helpset, i.e. 'alida' or 'mitobo'.

getHelpActionListener

public static ActionListener getHelpActionListener(Component c,
                                                   String l,
                                                   JFrame topFrame)
Get an ActionListener linked to the Alida online help system.

Parameters:
c - Component to which to attach the listener (buttons, menu items).
l - Label of the page in the helpset to be displayed.
topFrame - Top-level frame using online help.
Returns:
Listener for the component.


Copyright © 2010–2014 Martin Luther University Halle-Wittenberg, Institute of Computer Science, Pattern Recognition and Bioinformatics. All rights reserved.