gui.help
Class JAPHelp

java.lang.Object
  extended by gui.help.JAPHelp
Direct Known Subclasses:
JAPExternalHelpViewer, JAPInternalHelpViewer.JAPInternalHelpDelegator

public abstract class JAPHelp
extends java.lang.Object


Nested Class Summary
(package private) static class JAPHelp.HelpContextActionListener
           
static interface JAPHelp.IExternalEMailCaller
          An instance of this interface is needed to open an E-Mail application with a given address.
static interface JAPHelp.IExternalURLCaller
          An instance of this interface is needed to open external URLs.
private static class JAPHelp.JAPHelpFactory
           
 
Field Summary
static java.lang.String IMG_HELP
           
static java.lang.String IMG_HOME
           
static java.lang.String IMG_NEXT
           
static java.lang.String IMG_PREVIOUS
           
static java.lang.String INDEX_CONTEXT
           
private  JAPHelpContext.IHelpContext m_helpContext
           
protected static JAPHelp ms_theJAPHelp
           
static java.lang.String MSG_CLOSE_BUTTON
           
static java.lang.String MSG_ERROR_EXT_URL
           
static java.lang.String MSG_HELP_BUTTON
           
static java.lang.String MSG_HELP_MENU_ITEM
           
static java.lang.String MSG_HELP_WINDOW
           
static java.lang.String MSG_LANGUAGE_CODE
           
 
Constructor Summary
JAPHelp()
           
 
Method Summary
static javax.swing.JButton createHelpButton(JAPHelpContext.IHelpContext a_helpContext)
          Creates a button that opens the help window with the given context.
static javax.swing.JMenuItem createHelpMenuItem(JAPHelpContext.IHelpContext a_helpContext)
          Creates a menu item that opens the help window with the given context.
 JAPHelpContext.IHelpContext getHelpContext()
          Returns the context object
static JAPDialog getHelpDialog()
           
static JAPHelp getInstance()
          Returns the current help instance.
protected  JAPDialog getOwnDialog()
           
static void init(java.awt.Frame a_parent, IHelpModel a_helpModel)
          Creates and initialises a new global help object with the given frame as parent frame.
abstract  void loadCurrentContext()
           
 void setContext(JAPHelpContext.IHelpContext context)
           
 void setContext(java.lang.String a_context, java.awt.Component a_parent)
           
abstract  void setVisible(boolean a_bVisible)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INDEX_CONTEXT

public static final java.lang.String INDEX_CONTEXT
See Also:
Constant Field Values

IMG_HELP

public static final java.lang.String IMG_HELP

MSG_HELP_BUTTON

public static final java.lang.String MSG_HELP_BUTTON

MSG_HELP_MENU_ITEM

public static final java.lang.String MSG_HELP_MENU_ITEM

MSG_CLOSE_BUTTON

public static final java.lang.String MSG_CLOSE_BUTTON

MSG_HELP_WINDOW

public static final java.lang.String MSG_HELP_WINDOW

MSG_LANGUAGE_CODE

public static final java.lang.String MSG_LANGUAGE_CODE

MSG_ERROR_EXT_URL

public static final java.lang.String MSG_ERROR_EXT_URL

IMG_HOME

public static final java.lang.String IMG_HOME

IMG_PREVIOUS

public static final java.lang.String IMG_PREVIOUS

IMG_NEXT

public static final java.lang.String IMG_NEXT

m_helpContext

private JAPHelpContext.IHelpContext m_helpContext

ms_theJAPHelp

protected static JAPHelp ms_theJAPHelp
Constructor Detail

JAPHelp

public JAPHelp()
Method Detail

init

public static void init(java.awt.Frame a_parent,
                        IHelpModel a_helpModel)
Creates and initialises a new global help object with the given frame as parent frame.

Parameters:
a_parent - the parent frame of the help object
a_helpModel - a help model; if set to null, only the internal help will be presented

getInstance

public static JAPHelp getInstance()
Returns the current help instance.

Returns:
the current help instance

createHelpButton

public static final javax.swing.JButton createHelpButton(JAPHelpContext.IHelpContext a_helpContext)
Creates a button that opens the help window with the given context.

Parameters:
a_helpContext - a help context
Returns:
a button that opens the help window with the given context

createHelpMenuItem

public static javax.swing.JMenuItem createHelpMenuItem(JAPHelpContext.IHelpContext a_helpContext)
Creates a menu item that opens the help window with the given context.

Parameters:
a_helpContext - a help context
Returns:
a menu item that opens the help window with the given context

loadCurrentContext

public abstract void loadCurrentContext()

setVisible

public abstract void setVisible(boolean a_bVisible)

setContext

public final void setContext(java.lang.String a_context,
                             java.awt.Component a_parent)

setContext

public final void setContext(JAPHelpContext.IHelpContext context)

getHelpContext

public final JAPHelpContext.IHelpContext getHelpContext()
Returns the context object

Returns:
JAPHelpContext

getOwnDialog

protected JAPDialog getOwnDialog()

getHelpDialog

public static final JAPDialog getHelpDialog()