intradoc.common
Class Help

java.lang.Object
  |
  +--intradoc.common.Help

public class Help

extends java.lang.Object

Field Summary

protected static java.lang.String	m_helpDir
protected static java.net.URL	m_helpURL
protected static boolean	m_systemHelpIsLocalized
protected static java.util.Vector	m_validHelpLangs

Constructor Summary

Help()

Method Summary

static java.lang.String	computeLangHelpDirSuffix(ExecutionContext ctxt)
static void	display(java.lang.String page)
static void	display(java.lang.String page, ExecutionContext ctxt) Display help files in the user's language, else the system language, else the default language.
protected static void	display(java.lang.String page, java.lang.String helpDir)
static java.lang.String	getHelpDir()
static boolean	getIsSystemHelpLocalized()
static boolean	isValidHelpLangId(java.lang.String languageId) Check if a languageId is valid
static void	setHelpUrlBase(java.net.URL helpURL)
static void	setIsSystemHelpLocalized(boolean systemHelpIsLocalized)
static void	setPaths(java.lang.String helpDir)
static void	setValidHelpLangs(java.util.Vector validHelpLangs)

Methods inherited from class java.lang.Object

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

Field Detail

m_helpURL

protected static java.net.URL m_helpURL

m_helpDir

protected static java.lang.String m_helpDir

m_validHelpLangs

protected static java.util.Vector m_validHelpLangs

m_systemHelpIsLocalized

protected static boolean m_systemHelpIsLocalized

Constructor Detail

Help

public Help()

Method Detail

setPaths

public static void setPaths(java.lang.String helpDir)

getHelpDir

public static java.lang.String getHelpDir()

setHelpUrlBase

public static void setHelpUrlBase(java.net.URL helpURL)

getIsSystemHelpLocalized

public static boolean getIsSystemHelpLocalized()

setIsSystemHelpLocalized

public static void setIsSystemHelpLocalized(boolean systemHelpIsLocalized)

display

public static void display(java.lang.String page)
                    throws ServiceException

ServiceException

display

protected static void display(java.lang.String page,
                              java.lang.String helpDir)
                       throws ServiceException

ServiceException

display

public static void display(java.lang.String page,
                           ExecutionContext ctxt)
                    throws ServiceException

Display help files in the user's language, else the system language, else the default language.

ServiceException

computeLangHelpDirSuffix

public static java.lang.String computeLangHelpDirSuffix(ExecutionContext ctxt)

setValidHelpLangs

public static void setValidHelpLangs(java.util.Vector validHelpLangs)

isValidHelpLangId

public static boolean isValidHelpLangId(java.lang.String languageId)

Check if a languageId is valid