Overview  Package   Class  Tree  Index 

be.lassi.util
Class Help

java.lang.Object
  extended by be.lassi.util.Help

public class Help
extends java.lang.Object

Helper class to simplify the integration of context sensitive help in the application.


Constructor Summary
Help()
          Constructs a new instance.
 
Method Summary
static javax.swing.JButton createHelpButton()
          Creates and help button for context sensitive help.
static void enable(javax.swing.JComponent component, java.lang.String id)
          Enables context sensitive help on given component by setting the help ID to given ID string.
static void enable(javax.swing.JDialog dialog, java.lang.String id)
           
static void enable(javax.swing.JFrame frame, java.lang.String id)
          Enables context sensitive help on given frame.
static void setDisplayed(boolean displayed)
          Makes the help window visible or not.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Help

public Help()
Constructs a new instance.

Method Detail

createHelpButton

public static javax.swing.JButton createHelpButton()
Creates and help button for context sensitive help.

Returns:
the help button

enable

public static void enable(javax.swing.JComponent component,
                          java.lang.String id)
Enables context sensitive help on given component by setting the help ID to given ID string.

Parameters:
component - the component on which to enable context sensitive help
id - the help ID string

enable

public static void enable(javax.swing.JDialog dialog,
                          java.lang.String id)

enable

public static void enable(javax.swing.JFrame frame,
                          java.lang.String id)
Enables context sensitive help on given frame.

Parameters:
frame - the frame to be help enabled
id - the help ID string

setDisplayed

public static void setDisplayed(boolean displayed)
Makes the help window visible or not.

Parameters:
displayed - true if visible

Overview  Package   Class  Tree  Index 
Lighting Assistant 1.2