harmonic.mz.manager
Class HelpManager

java.lang.Object
  |
  +--harmonic.mz.manager.HelpManager

public class HelpManager

extends java.lang.Object

Manages the documentation system

Constructor Summary

HelpManager()

Method Summary

java.lang.String	getHelpFile(FunctionStarter action) Return HTML help file name for function.
java.lang.String	helpRoot(Module mod) Returns the complete path to modules help directory, or if mod is null to the help entry point directory.
boolean	isWaitingForHelp() Returns wait for help flag, indicating whether user is expecting to get help on some item they click on or otherwise point to.
void	postHelpAt(java.lang.String loc) Post help for given URL.
void	postHelpFile(Documentable object)
void	postHelpFile(Documentable object, boolean bRequireVisible) Post help file for the documentable object.
void	postHelpIndex() Post top level help index.
void	waitForHelp(boolean b) Set the wait for help flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpManager

public HelpManager()

Method Detail

waitForHelp

public void waitForHelp(boolean b)

Set the wait for help flag.

isWaitingForHelp

public boolean isWaitingForHelp()

Returns wait for help flag, indicating whether user is expecting to get help on some item they click on or otherwise point to.

helpRoot

public java.lang.String helpRoot(Module mod)

Returns the complete path to modules help directory, or if mod is null to the help entry point directory.

postHelpIndex

public void postHelpIndex()

Post top level help index.

postHelpAt

public void postHelpAt(java.lang.String loc)

Post help for given URL.

postHelpFile

public void postHelpFile(Documentable object)

postHelpFile

public void postHelpFile(Documentable object,
                         boolean bRequireVisible)

Post help file for the documentable object.

getHelpFile

public java.lang.String getHelpFile(FunctionStarter action)

Return HTML help file name for function.