Package com.microstrategy.web.app.utils

Class HelpHelper

java.lang.Object

com.microstrategy.web.app.utils.HelpHelper

public class HelpHelper
extends java.lang.Object

This class attempts to ease the construction of help link in the application. All of the methods in this class are public(private) static so that it's not required to create an instance of this class.

The folder structure of help files are

• root folder Help (microstrategy.xml)
• admin or user folder WebUser/WebAdmin
• DHTML or 508 folder WebHelp/508
• Local folder Lang_localeId
• Main help pages MicroStrategy_Web_Help.htm/MicroStrategy_Web_Administrator_Help.htm

Using user help or admi help file will follow the above folder structure. If a user wants to customize a help link that points to a self-created help page, firstly the new help page needs to be created in the root Help folder and secondly they should use the HELP_TYPE_CUSTOM or TYPE_HELP_CUSTOM_TAG and specify the full path of the help file (relative to the root folder).

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	HELP_TYPE_ADMIN
static java.lang.String	HELP_TYPE_CUSTOM
static java.lang.String	HELP_TYPE_LIBRARY
static java.lang.String	HELP_TYPE_NONE	This group of constants are used by Editor to specify the set of help file to use HELP_TYPE_NONE no help file to use HELP_TYPE_USER user help file is used HELP_TYPE_ADMIN admin help file is used HELP_TYPE_CUSTOM custom specified help file path is used
static java.lang.String	HELP_TYPE_USER
static java.lang.String	TYPE_HELP_ADMIN_TAG
static java.lang.String	TYPE_HELP_CUSTOM_TAG	This group of constants are used by resource tag to specify the set of help file to use TYPE_HELP_CUSTOM_TAG custom specified help file path is used TYPE_HELP_USER_TAG user help file is used TYPE_HELP_ADMIN_TAG admin help file is used
static java.lang.String	TYPE_HELP_USER_TAG

Constructor Summary

Constructors

Constructor	Description
HelpHelper()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getHelpLink(boolean isCustom, boolean isUser, AppContext appContext, java.lang.String helpTopic)	Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic
static java.lang.String	getHelpLink(java.lang.String type, AppContext appContext, java.lang.String helpTopic)	Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic
static void	renderHelpButton(MarkupOutput out, java.lang.String helpType, java.lang.String helpTopic, AppContext appContext)	Deprecated. use renderHelpButton(MarkupOutput, String, String, String, WebComponent, AppContext)
static void	renderHelpButton(MarkupOutput out, java.lang.String helpType, java.lang.String helpTopic, Editor editor)
static void	renderHelpButton(MarkupOutput out, java.lang.String helpType, java.lang.String helpTopic, java.lang.String helpLabel, WebComponent webComponent, AppContext appContext)

Methods inherited from class java.lang.Object

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

Field Detail

HELP_TYPE_NONE

public static final java.lang.String HELP_TYPE_NONE

This group of constants are used by Editor to specify the set of help file to use HELP_TYPE_NONE no help file to use HELP_TYPE_USER user help file is used HELP_TYPE_ADMIN admin help file is used HELP_TYPE_CUSTOM custom specified help file path is used

See Also:

Constant Field Values

HELP_TYPE_USER

public static final java.lang.String HELP_TYPE_USER

See Also:

Constant Field Values

HELP_TYPE_ADMIN

public static final java.lang.String HELP_TYPE_ADMIN

See Also:

Constant Field Values

HELP_TYPE_CUSTOM

public static final java.lang.String HELP_TYPE_CUSTOM

See Also:

Constant Field Values

HELP_TYPE_LIBRARY

public static final java.lang.String HELP_TYPE_LIBRARY

See Also:

Constant Field Values

TYPE_HELP_CUSTOM_TAG

public static final java.lang.String TYPE_HELP_CUSTOM_TAG

This group of constants are used by resource tag to specify the set of help file to use TYPE_HELP_CUSTOM_TAG custom specified help file path is used TYPE_HELP_USER_TAG user help file is used TYPE_HELP_ADMIN_TAG admin help file is used

See Also:

Constant Field Values

TYPE_HELP_USER_TAG

public static final java.lang.String TYPE_HELP_USER_TAG

See Also:

Constant Field Values

TYPE_HELP_ADMIN_TAG

public static final java.lang.String TYPE_HELP_ADMIN_TAG

See Also:

Constant Field Values

Constructor Detail

HelpHelper

public HelpHelper()

Method Detail

getHelpLink

public static java.lang.String getHelpLink(java.lang.String type,
                                           AppContext appContext,
                                           java.lang.String helpTopic)

Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic

Parameters:

type - the type of help file to generate

appContext - the application context

helpTopic - the topic of the help file. For user and admin the link include the helpTopic as the last part of the url prefixed with #; for custom help file the root Help folder path is pre-appened to the helpTopic as the link to the help file

Returns:

String the url to the help file

getHelpLink

public static java.lang.String getHelpLink(boolean isCustom,
                                           boolean isUser,
                                           AppContext appContext,
                                           java.lang.String helpTopic)

Generate the help file link based on the Help folder structure for User and Admin help file link = root Help folder + admin/user folder + DHTML/508 folder + locale folder + main help page + "#"+helpTopic(if any) For custom help file, take the full path (relative to the root Help folder) link = root Help folder + helpTopic

Parameters:

isCustom - specify if the link is custom help or user/admin help

isUser - specify if the link is user help or admin help

appContext - the application context

helpTopic - the topic of the help file. For user and admin the link include the helpTopic as the last part of the url prefixed with #; for custom help file the root Help folder path is pre-appened to the helpTopic as the link to the help file

Returns:

String the url to the help file

renderHelpButton

public static void renderHelpButton(MarkupOutput out,
                                    java.lang.String helpType,
                                    java.lang.String helpTopic,
                                    AppContext appContext)

Deprecated.

use renderHelpButton(MarkupOutput, String, String, String, WebComponent, AppContext)

render help button using specified help type and topic.

renderHelpButton

public static void renderHelpButton(MarkupOutput out,
                                    java.lang.String helpType,
                                    java.lang.String helpTopic,
                                    Editor editor)

renderHelpButton

public static void renderHelpButton(MarkupOutput out,
                                    java.lang.String helpType,
                                    java.lang.String helpTopic,
                                    java.lang.String helpLabel,
                                    WebComponent webComponent,
                                    AppContext appContext)